module Apipie::DSL::Controller
Public Instance Methods
_apipie_concern_subst()
click to toggle source
# File lib/apipie/dsl_definition.rb, line 530 def _apipie_concern_subst @_apipie_concern_subst ||= {:controller_path => self.controller_path, :resource_id => Apipie.get_resource_name(self)} end
_apipie_perform_concern_subst(string)
click to toggle source
# File lib/apipie/dsl_definition.rb, line 535 def _apipie_perform_concern_subst(string) return _apipie_concern_subst.reduce(string) do |ret, (key, val)| ret.gsub(":#{key}", val) end end
_apipie_update_meta(method_desc, dsl_data)
click to toggle source
# File lib/apipie/dsl_definition.rb, line 509 def _apipie_update_meta(method_desc, dsl_data) return unless dsl_data[:meta] && dsl_data[:meta].is_a?(Hash) method_desc.metadata ||= {} method_desc.metadata.merge!(dsl_data[:meta]) end
_apipie_update_params(method_desc, dsl_data)
click to toggle source
Allows to update existing params after definition was made (usually needed when extending the API form plugins).
UsersController.apipie_update_params([:create, :update]) do param :user, Hash do param :oauth, String end end
The block is evaluated in scope of the controller. Ohe can pass some additional objects via additional arguments like this:
UsersController.apipie_update_params([:create, :update], [:name, :secret]) do |param_names| param :user, Hash do param_names.each { |p| param p, String } end end
# File lib/apipie/dsl_definition.rb, line 502 def _apipie_update_params(method_desc, dsl_data) params_ordered = dsl_data[:params].map do |args| Apipie::ParamDescription.from_dsl_data(method_desc, args) end ParamDescription.merge(method_desc.params_ordered_self, params_ordered) end
apipie_concern?()
click to toggle source
# File lib/apipie/dsl_definition.rb, line 541 def apipie_concern? false end
apipie_concern_subst(subst_hash)
click to toggle source
defines the substitutions to be made in the API paths deifned in concerns included. For example:
There is this method defined in concern:
api GET ':controller_path/:id' def show # ... end
If you include the concern into some controller, you can specify the value for :controller_path like this:
apipie_concern_subst(:controller_path => '/users') include ::Concerns::SampleController
The resulting path will be ‘/users/:id’.
It has to be specified before the concern is included.
If not specified, the default predefined substitions are
{:conroller_path => controller.controller_path, :resource_id => `resource_id_from_apipie` }
# File lib/apipie/dsl_definition.rb, line 481 def apipie_concern_subst(subst_hash) _apipie_concern_subst.merge!(subst_hash) end
apipie_update_methods(methods, *args, &block)
click to toggle source
# File lib/apipie/dsl_definition.rb, line 516 def apipie_update_methods(methods, *args, &block) methods.each do |method| method_desc = Apipie.get_method_description(self, method) unless method_desc raise "Could not find method description for #{self}##{method}. Was the method defined?" end dsl_data = _apipie_eval_dsl(*args, &block) _apipie_update_params(method_desc, dsl_data) _apipie_update_meta(method_desc, dsl_data) end end
Also aliased as: apipie_update_params
apipie_update_params(methods, *args, &block)
backwards compatibility
Alias for: apipie_update_methods
method_added(method_name)
click to toggle source
create method api and redefine newly added method
Calls superclass method
# File lib/apipie/dsl_definition.rb, line 546 def method_added(method_name) #:doc: super return if !Apipie.active_dsl? || !_apipie_dsl_data[:api] return if _apipie_dsl_data[:api_args].blank? && _apipie_dsl_data[:api_from_routes].blank? # remove method description if exists and create new one Apipie.remove_method_description(self, _apipie_dsl_data[:api_versions], method_name) description = Apipie.define_method_description(self, method_name, _apipie_dsl_data) _apipie_dsl_data_clear _apipie_define_validators(description) ensure _apipie_dsl_data_clear end