Module: Jsapi::Controller::Methods::Callbacks::ClassMethods

Defined in:
lib/jsapi/controller/methods/callbacks/class_methods.rb

Instance Method Summary collapse

Instance Method Details

#_api_add_callback(kind, method_or_proc = nil, **options, &block) ⇒ Object

:nodoc:

Raises:

  • (ArgumentError) 


43
44
45
46
47
48
49
50
 
# File 'lib/jsapi/controller/methods/callbacks/class_methods.rb', line 43

def _api_add_callback(kind, method_or_proc = nil, **options, &block) # :nodoc:
  method_or_proc ||= block
  raise ArgumentError, 'either a method or a block must be ' \
                        'specified' unless method_or_proc

  ((@_api_callbacks ||= {})[kind] ||= []) <<
    Callback.new(method_or_proc, **options)
end

#_api_callbacks(kind) ⇒ Object

:nodoc:



52
53
54
55
56
57
 
# File 'lib/jsapi/controller/methods/callbacks/class_methods.rb', line 52

def _api_callbacks(kind) # :nodoc:
  callbacks = @_api_callbacks&.fetch(kind, nil) || []
  return callbacks unless superclass.respond_to?(:_api_callbacks)

  superclass._api_callbacks(kind) + callbacks
end

#api_after_validation(method_or_proc = nil, **options, &block) ⇒ Object

:call-seq:

api_after_validation(method_or_proc, **options)
api_after_validation(**options, &block)

Registers a callback that is triggered by api_operation! after the parameters have been validated successfully.

api_after_validation do |api_params|
  # ...
end

When calling an api_after_validation callback, the parameters are passed.



21
22
23
 
# File 'lib/jsapi/controller/methods/callbacks/class_methods.rb', line 21

def api_after_validation(method_or_proc = nil, **options, &block)
  _api_add_callback(:after_validation, method_or_proc, **options, &block)
end

#api_before_rendering(method_or_proc = nil, **options, &block) ⇒ Object

:call-seq:

api_before_rendering(method_or_proc, **options)
api_before_rendering(**options, &block)

Registers a callback that is triggered by api_operation and api_operation! before the response body is rendered.

api_before_rendering do |result, api_params|
  { request_id: api_params.request_id, payload: result }
end

When calling an api_before_rendering callback, the result and parameters are passed. The value returned by the callback replaces the result to be rendered.



39
40
41
 
# File 'lib/jsapi/controller/methods/callbacks/class_methods.rb', line 39

def api_before_rendering(method_or_proc = nil, **options, &block)
  _api_add_callback(:before_rendering, method_or_proc, **options, &block)
end