Module: Apipie::DSL::Controller

Includes:
Action, Base, Common, Param
Defined in:
lib/apipie/dsl_definition.rb

Instance Attribute Summary

Attributes included from Base

#api_params, #apipie_resource_descriptions

Instance Method Summary collapse

Methods included from Param

#_default_param_group_scope, #param, #param_group

Methods included from Action

#api, #api!, #def_param_group, #example, #resource_description, #see, #show

Methods included from Common

#_apipie_define_validators, #_apipie_get_method_params, #_apipie_save_method_params, #api_versions, #desc, #document, #error, #formats, #header, #meta

Methods included from Base

#_apipie_eval_dsl

Instance Method Details

#_apipie_concern_subst ⇒ Object 



429
430
431
432
 
# File 'lib/apipie/dsl_definition.rb', line 429

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) ⇒ Object 



434
435
436
437
438
 
# File 'lib/apipie/dsl_definition.rb', line 434

def _apipie_perform_concern_subst(string)
  return _apipie_concern_subst.reduce(string) do |ret, (key, val)|
    ret.gsub(":#{key}", val)
  end
end

#apipie_concern? ⇒ Boolean

Returns:

  • (Boolean) 


440
441
442
 
# File 'lib/apipie/dsl_definition.rb', line 440

def apipie_concern?
  false
end

#apipie_concern_subst(subst_hash) ⇒ Object

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` }



394
395
396
 
# File 'lib/apipie/dsl_definition.rb', line 394

def apipie_concern_subst(subst_hash)
  _apipie_concern_subst.merge!(subst_hash)
end

#apipie_update_params(methods, *args, &block) ⇒ Object

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



415
416
417
418
419
420
421
422
423
424
425
426
427
 
# File 'lib/apipie/dsl_definition.rb', line 415

def apipie_update_params(methods, *args, &block)
  methods.each do |method|
    method_description = Apipie.get_method_description(self, method)
    unless method_description
      raise "Could not find method description for #{self}##{method}. Was the method defined?"
    end
    dsl_data = _apipie_eval_dsl(*args, &block)
    params_ordered = dsl_data[:params].map do |args|
      Apipie::ParamDescription.from_dsl_data(method_description, args)
    end
    ParamDescription.unify(method_description.params_ordered_self + params_ordered)
  end
end

#method_added(method_name) ⇒ Object

create method api and redefine newly added method



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
 
# File 'lib/apipie/dsl_definition.rb', line 445

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