Module: ActionWebService::Invocation::ClassMethods

Defined in:
lib/action_web_service/invocation.rb

Overview

Invocation interceptors provide a means to execute custom code before and after method invocations on ActionWebService::Base objects.

When running in Direct dispatching mode, ActionController filters should be used for this functionality instead.

The semantics of invocation interceptors are the same as ActionController filters, and accept the same parameters and options.

A before interceptor can also cancel execution by returning false, or returning a [false, "cancel reason"] array if it wishes to supply a reason for canceling the request.

Example

class CustomService < ActionWebService::Base
  before_invocation :intercept_add, :only => [:add]

  def add(a, b)
    a + b
  end

  private
    def intercept_add
      return [false, "permission denied"] # cancel it
    end
end

Options:

:except

A list of methods for which the interceptor will NOT be called

:only

A list of methods for which the interceptor WILL be called

Instance Method Summary collapse

Instance Method Details

#after_invocation_interceptors ⇒ Object

:nodoc:



88
89
90
 
# File 'lib/action_web_service/invocation.rb', line 88

def after_invocation_interceptors # :nodoc:
  read_inheritable_attribute("after_invocation_interceptors")
end

#append_after_invocation(*interceptors, &block) ⇒ Object Also known as: after_invocation

Appends the given interceptors to be called after method invocation.



66
67
68
69
70
71
 
# File 'lib/action_web_service/invocation.rb', line 66

def append_after_invocation(*interceptors, &block)
  conditions = extract_conditions!(interceptors)
  interceptors << block if block_given?
  add_interception_conditions(interceptors, conditions)
  append_interceptors_to_chain("after", interceptors)
end

#append_before_invocation(*interceptors, &block) ⇒ Object Also known as: before_invocation

Appends the given interceptors to be called before method invocation.



46
47
48
49
50
51
 
# File 'lib/action_web_service/invocation.rb', line 46

def append_before_invocation(*interceptors, &block)
  conditions = extract_conditions!(interceptors)
  interceptors << block if block_given?
  add_interception_conditions(interceptors, conditions)
  append_interceptors_to_chain("before", interceptors)
end

#before_invocation_interceptors ⇒ Object

:nodoc:



84
85
86
 
# File 'lib/action_web_service/invocation.rb', line 84

def before_invocation_interceptors # :nodoc:
  read_inheritable_attribute("before_invocation_interceptors")
end

#excluded_intercepted_methods ⇒ Object

:nodoc:



96
97
98
 
# File 'lib/action_web_service/invocation.rb', line 96

def excluded_intercepted_methods # :nodoc:
  read_inheritable_attribute("excluded_intercepted_methods") || {}
end

#included_intercepted_methods ⇒ Object

:nodoc:



92
93
94
 
# File 'lib/action_web_service/invocation.rb', line 92

def included_intercepted_methods # :nodoc:
  read_inheritable_attribute("included_intercepted_methods") || {}
end

#prepend_after_invocation(*interceptors, &block) ⇒ Object

Prepends the given interceptors to be called after method invocation.



75
76
77
78
79
80
 
# File 'lib/action_web_service/invocation.rb', line 75

def prepend_after_invocation(*interceptors, &block)
  conditions = extract_conditions!(interceptors)
  interceptors << block if block_given?
  add_interception_conditions(interceptors, conditions)
  prepend_interceptors_to_chain("after", interceptors)
end

#prepend_before_invocation(*interceptors, &block) ⇒ Object

Prepends the given interceptors to be called before method invocation.



55
56
57
58
59
60
 
# File 'lib/action_web_service/invocation.rb', line 55

def prepend_before_invocation(*interceptors, &block)
  conditions = extract_conditions!(interceptors)
  interceptors << block if block_given?
  add_interception_conditions(interceptors, conditions)
  prepend_interceptors_to_chain("before", interceptors)
end