pelle-actionwebservice 2.3.3

data/lib/action_web_service/dispatcher/action_controller_dispatcher.rb

@@ -0,0 +1,379 @@
+require 'benchmark'
+require 'builder/xmlmarkup'
+
+module ActionWebService # :nodoc:
+  module Dispatcher # :nodoc:
+    module ActionController # :nodoc:
+      def self.included(base) # :nodoc:
+        class << base
+          include ClassMethods
+          alias_method_chain :inherited, :action_controller
+        end
+        base.class_eval do
+          alias_method :web_service_direct_invoke_without_controller, :web_service_direct_invoke
+        end
+        base.add_web_service_api_callback do |klass, api|
+          if klass.web_service_dispatching_mode == :direct
+            klass.class_eval 'def api; dispatch_web_service_request; end'
+          end
+        end
+        base.add_web_service_definition_callback do |klass, name, info|
+          if klass.web_service_dispatching_mode == :delegated
+            klass.class_eval "def #{name}; dispatch_web_service_request; end"
+          elsif klass.web_service_dispatching_mode == :layered
+            klass.class_eval 'def api; dispatch_web_service_request; end'
+          end
+        end
+        base.send(:include, ActionWebService::Dispatcher::ActionController::InstanceMethods)
+      end
+
+      module ClassMethods # :nodoc:
+        def inherited_with_action_controller(child)
+          inherited_without_action_controller(child)
+          child.send(:include, ActionWebService::Dispatcher::ActionController::WsdlAction)
+        end
+      end
+
+      module InstanceMethods # :nodoc:
+        private
+          def dispatch_web_service_request
+            method = request.method.to_s.upcase
+            allowed_methods = self.class.web_service_api ? (self.class.web_service_api.allowed_http_methods || []) : [ :post ]
+            allowed_methods = allowed_methods.map{|m| m.to_s.upcase }
+            if !allowed_methods.include?(method)
+              render :text => "#{method} not supported", :status=>500
+              return
+            end
+            exception = nil
+            begin
+              ws_request = discover_web_service_request(request)
+            rescue Exception => e
+              exception = e
+            end
+            if ws_request
+              ws_response = nil
+              exception = nil
+              bm = Benchmark.measure do
+                begin
+                  ws_response = invoke_web_service_request(ws_request)
+                rescue Exception => e
+                  exception = e
+                end
+              end
+              log_request(ws_request, request.raw_post)
+              if exception
+                log_error(exception) unless logger.nil?
+                send_web_service_error_response(ws_request, exception)
+              else
+                send_web_service_response(ws_response, bm.real)
+              end
+            else
+              exception ||= DispatcherError.new("Malformed SOAP or XML-RPC protocol message")
+              log_error(exception) unless logger.nil?
+              send_web_service_error_response(ws_request, exception)
+            end
+          rescue Exception => e
+            log_error(e) unless logger.nil?
+            send_web_service_error_response(ws_request, e)
+          end
+
+          def send_web_service_response(ws_response, elapsed=nil)
+            log_response(ws_response, elapsed)
+            options = { :type => ws_response.content_type, :disposition => 'inline' }
+            send_data(ws_response.body, options)
+          end
+
+          def send_web_service_error_response(ws_request, exception)
+            if ws_request
+              unless self.class.web_service_exception_reporting
+                exception = DispatcherError.new("Internal server error (exception raised)")
+              end
+              api_method = ws_request.api_method
+              public_method_name = api_method ? api_method.public_name : ws_request.method_name
+              return_type = ActionWebService::SignatureTypes.canonical_signature_entry(Exception, 0)
+              ws_response = ws_request.protocol.encode_response(public_method_name + 'Response', exception, return_type, ws_request.protocol_options)
+              send_web_service_response(ws_response)
+            else
+              if self.class.web_service_exception_reporting
+                message = exception.message
+                backtrace = "\nBacktrace:\n#{exception.backtrace.join("\n")}"
+              else
+                message = "Exception raised"
+                backtrace = ""
+              end
+              render :status => 500, :text => "Internal protocol error: #{message}#{backtrace}"
+            end
+          end
+
+          def web_service_direct_invoke(invocation)
+            invocation.method_named_params.each do |name, value|
+              params[name] = value
+            end
+            web_service_direct_invoke_without_controller(invocation)
+          end
+
+          def log_request(ws_request, body)
+            unless logger.nil?
+              name = ws_request.method_name
+              api_method = ws_request.api_method
+              params = ws_request.method_params
+              if api_method && api_method.expects
+                params = api_method.expects.zip(params).map{ |type, param| "#{type.name}=>#{param.inspect}" }
+              else
+                params = params.map{ |param| param.inspect }
+              end
+              service = ws_request.service_name
+              logger.debug("\nWeb Service Request: #{name}(#{params.join(", ")}) Entrypoint: #{service}")
+              logger.debug(indent(body))
+            end
+          end
+
+          def log_response(ws_response, elapsed=nil)
+            unless logger.nil?
+              elapsed = (elapsed ? " (%f):" % elapsed : ":")
+              logger.debug("\nWeb Service Response" + elapsed + " => #{ws_response.return_value.inspect}")
+              logger.debug(indent(ws_response.body))
+            end
+          end
+
+          def indent(body)
+            body.split(/\n/).map{|x| "  #{x}"}.join("\n")
+          end
+      end
+
+      module WsdlAction # :nodoc:
+        XsdNs             = 'http://www.w3.org/2001/XMLSchema'
+        WsdlNs            = 'http://schemas.xmlsoap.org/wsdl/'
+        SoapNs            = 'http://schemas.xmlsoap.org/wsdl/soap/'
+        SoapEncodingNs    = 'http://schemas.xmlsoap.org/soap/encoding/'
+        SoapHttpTransport = 'http://schemas.xmlsoap.org/soap/http'
+
+        def wsdl
+          case request.method
+          when :get
+            begin
+              options = { :type => 'text/xml', :disposition => 'inline' }
+              send_data(to_wsdl, options)
+            rescue Exception => e
+              log_error(e) unless logger.nil?
+            end
+          when :post
+            render :status => 500, :text => 'POST not supported'
+          end
+        end
+
+        private
+          def base_uri
+            host = request.host_with_port
+            relative_url_root = ::ActionController::Base.relative_url_root
+            scheme = request.ssl? ? 'https' : 'http'
+            '%s://%s%s/%s/' % [scheme, host, relative_url_root, self.class.controller_path]
+          end
+
+          def to_wsdl
+            xml = ''
+            dispatching_mode = web_service_dispatching_mode
+            global_service_name = wsdl_service_name
+            namespace = wsdl_namespace || 'urn:ActionWebService'
+            soap_action_base = "/#{controller_name}"
+
+            marshaler = ActionWebService::Protocol::Soap::SoapMarshaler.new(namespace)
+            apis = {}
+            case dispatching_mode
+            when :direct
+              api = self.class.web_service_api
+              web_service_name = controller_class_name.sub(/Controller$/, '').underscore
+              apis[web_service_name] = [api, register_api(api, marshaler)]
+            when :delegated, :layered
+              self.class.web_services.each do |web_service_name, info|
+                service = web_service_object(web_service_name)
+                api = service.class.web_service_api
+                apis[web_service_name] = [api, register_api(api, marshaler)]
+              end
+            end
+            custom_types = []
+            apis.values.each do |api, bindings|
+              bindings.each do |b|
+                custom_types << b unless custom_types.include?(b)
+              end
+            end
+
+            xm = Builder::XmlMarkup.new(:target => xml, :indent => 2)
+            xm.instruct!
+            xm.definitions('name'            => wsdl_service_name,
+                           'targetNamespace' => namespace,
+                           'xmlns:typens'    => namespace,
+                           'xmlns:xsd'       => XsdNs,
+                           'xmlns:soap'      => SoapNs,
+                           'xmlns:soapenc'   => SoapEncodingNs,
+                           'xmlns:wsdl'      => WsdlNs,
+                           'xmlns'           => WsdlNs) do
+              # Generate XSD
+              if custom_types.size > 0
+                xm.types do
+                  xm.xsd(:schema, 'xmlns' => XsdNs, 'targetNamespace' => namespace) do
+                    custom_types.each do |binding|
+                      case
+                      when binding.type.array?
+                        xm.xsd(:complexType, 'name' => binding.type_name) do
+                          xm.xsd(:complexContent) do
+                            xm.xsd(:restriction, 'base' => 'soapenc:Array') do
+                              xm.xsd(:attribute, 'ref' => 'soapenc:arrayType',
+                                                 'wsdl:arrayType' => binding.element_binding.qualified_type_name('typens') + '[]')
+                            end
+                          end
+                        end
+                      when binding.type.structured?
+                        xm.xsd(:complexType, 'name' => binding.type_name) do
+                          xm.xsd(:all) do
+                            binding.type.each_member do |name, type|
+                              b = marshaler.register_type(type)
+                              xm.xsd(:element, 'name' => name, 'type' => b.qualified_type_name('typens'))
+                            end
+                          end
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+
+              # APIs
+              apis.each do |api_name, values|
+                api = values[0]
+                api.api_methods.each do |name, method|
+                  gen = lambda do |msg_name, direction|
+                    xm.message('name' => message_name_for(api_name, msg_name)) do
+                      sym = nil
+                      if direction == :out
+                        returns = method.returns
+                        if returns
+                          binding = marshaler.register_type(returns[0])
+                          xm.part('name' => 'return', 'type' => binding.qualified_type_name('typens'))
+                        end
+                      else
+                        expects = method.expects
+                        expects.each do |type|
+                          binding = marshaler.register_type(type)
+                          xm.part('name' => type.name, 'type' => binding.qualified_type_name('typens'))
+                        end if expects
+                      end
+                    end
+                  end
+                  public_name = method.public_name
+                  gen.call(public_name, :in)
+                  gen.call("#{public_name}Response", :out)
+                end
+
+                # Port
+                port_name = port_name_for(global_service_name, api_name)
+                xm.portType('name' => port_name) do
+                  api.api_methods.each do |name, method|
+                    xm.operation('name' => method.public_name) do
+                      xm.input('message' => "typens:" + message_name_for(api_name, method.public_name))
+                      xm.output('message' => "typens:" + message_name_for(api_name, "#{method.public_name}Response"))
+                    end
+                  end
+                end
+
+                # Bind it
+                binding_name = binding_name_for(global_service_name, api_name)
+                xm.binding('name' => binding_name, 'type' => "typens:#{port_name}") do
+                  xm.soap(:binding, 'style' => 'rpc', 'transport' => SoapHttpTransport)
+                  api.api_methods.each do |name, method|
+                    xm.operation('name' => method.public_name) do
+                      case web_service_dispatching_mode
+                      when :direct
+                        soap_action = soap_action_base + "/api/" + method.public_name
+                      when :delegated, :layered
+                        soap_action = soap_action_base \
+                                    + "/" + api_name.to_s \
+                                    + "/" + method.public_name
+                      end
+                      xm.soap(:operation, 'soapAction' => soap_action)
+                      xm.input do
+                        xm.soap(:body,
+                                'use'           => 'encoded',
+                                'namespace'     => namespace,
+                                'encodingStyle' => SoapEncodingNs)
+                      end
+                      xm.output do
+                        xm.soap(:body,
+                                'use'           => 'encoded',
+                                'namespace'     => namespace,
+                                'encodingStyle' => SoapEncodingNs)
+                      end
+                    end
+                  end
+                end
+              end
+
+              # Define it
+              xm.service('name' => "#{global_service_name}Service") do
+                apis.each do |api_name, values|
+                  port_name = port_name_for(global_service_name, api_name)
+                  binding_name = binding_name_for(global_service_name,  api_name)
+                  case web_service_dispatching_mode
+                  when :direct, :layered
+                    binding_target = 'api'
+                  when :delegated
+                    binding_target = api_name.to_s
+                  end
+                  xm.port('name' => port_name, 'binding' => "typens:#{binding_name}") do
+                    xm.soap(:address, 'location' => "#{base_uri}#{binding_target}")
+                  end
+                end
+              end
+            end
+          end
+
+          def port_name_for(global_service, service)
+            "#{global_service}#{service.to_s.camelize}Port"
+          end
+
+          def binding_name_for(global_service, service)
+            "#{global_service}#{service.to_s.camelize}Binding"
+          end
+
+          def message_name_for(api_name, message_name)
+            mode = web_service_dispatching_mode
+            if mode == :layered || mode == :delegated
+              api_name.to_s + '-' + message_name
+            else
+              message_name
+            end
+          end
+
+          def register_api(api, marshaler)
+            bindings = {}
+            traverse_custom_types(api, marshaler, bindings) do |binding|
+              bindings[binding] = nil unless bindings.has_key?(binding)
+              element_binding = binding.element_binding
+              bindings[element_binding] = nil if element_binding && !bindings.has_key?(element_binding)
+            end
+            bindings.keys
+          end
+
+          def traverse_custom_types(api, marshaler, bindings, &block)
+            api.api_methods.each do |name, method|
+              expects, returns = method.expects, method.returns
+              expects.each{ |type| traverse_type(marshaler, type, bindings, &block) if type.custom? } if expects
+              returns.each{ |type| traverse_type(marshaler, type, bindings, &block) if type.custom? } if returns
+            end
+          end
+
+          def traverse_type(marshaler, type, bindings, &block)
+            binding = marshaler.register_type(type)
+            return if bindings.has_key?(binding)
+            bindings[binding] = nil
+            yield binding
+            if type.array?
+              yield marshaler.register_type(type.element_type)
+              type = type.element_type
+            end
+            type.each_member{ |name, type| traverse_type(marshaler, type, bindings, &block) } if type.structured?
+          end
+       end
+    end
+  end
+end

data/lib/action_web_service/dispatcher.rb

@@ -0,0 +1,2 @@
+require 'action_web_service/dispatcher/abstract'
+require 'action_web_service/dispatcher/action_controller_dispatcher'

data/lib/action_web_service/invocation.rb

@@ -0,0 +1,202 @@
+module ActionWebService # :nodoc:
+  module Invocation # :nodoc:
+    class InvocationError < ActionWebService::ActionWebServiceError # :nodoc:
+    end
+
+    def self.included(base) # :nodoc:
+      base.extend(ClassMethods)
+      base.send(:include, ActionWebService::Invocation::InstanceMethods)
+    end
+
+    # 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 <tt>[false, "cancel reason"]</tt> 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:
+    # [<tt>:except</tt>]  A list of methods for which the interceptor will NOT be called
+    # [<tt>:only</tt>]    A list of methods for which the interceptor WILL be called
+    module ClassMethods
+      # Appends the given +interceptors+ to be called
+      # _before_ method invocation.
+      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
+
+      # Prepends the given +interceptors+ to be called
+      # _before_ method invocation.
+      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
+
+      alias :before_invocation :append_before_invocation
+
+      # Appends the given +interceptors+ to be called
+      # _after_ method invocation.
+      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
+
+      # Prepends the given +interceptors+ to be called
+      # _after_ method invocation.
+      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
+
+      alias :after_invocation :append_after_invocation
+
+      def before_invocation_interceptors # :nodoc:
+        read_inheritable_attribute("before_invocation_interceptors")
+      end
+
+      def after_invocation_interceptors # :nodoc:
+        read_inheritable_attribute("after_invocation_interceptors")
+      end
+
+      def included_intercepted_methods # :nodoc:
+        read_inheritable_attribute("included_intercepted_methods") || {}
+      end
+      
+      def excluded_intercepted_methods # :nodoc:
+        read_inheritable_attribute("excluded_intercepted_methods") || {}
+      end
+
+      private
+        def append_interceptors_to_chain(condition, interceptors)
+          write_inheritable_array("#{condition}_invocation_interceptors", interceptors)
+        end
+
+        def prepend_interceptors_to_chain(condition, interceptors)
+          interceptors = interceptors + read_inheritable_attribute("#{condition}_invocation_interceptors")
+          write_inheritable_attribute("#{condition}_invocation_interceptors", interceptors)
+        end
+
+        def extract_conditions!(interceptors)
+          return nil unless interceptors.last.is_a? Hash
+          interceptors.pop
+        end
+
+        def add_interception_conditions(interceptors, conditions)
+          return unless conditions
+          included, excluded = conditions[:only], conditions[:except]
+          write_inheritable_hash("included_intercepted_methods", condition_hash(interceptors, included)) && return if included
+          write_inheritable_hash("excluded_intercepted_methods", condition_hash(interceptors, excluded)) if excluded
+        end
+
+        def condition_hash(interceptors, *methods)
+          interceptors.inject({}) {|hash, interceptor| hash.merge(interceptor => methods.flatten.map {|method| method.to_s})}
+        end
+    end
+
+    module InstanceMethods # :nodoc:
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :perform_invocation, :interception
+        end
+      end
+
+      def perform_invocation_with_interception(method_name, params, &block)
+        return if before_invocation(method_name, params, &block) == false
+        return_value = perform_invocation_without_interception(method_name, params)
+        after_invocation(method_name, params, return_value)
+        return_value
+      end
+
+      def perform_invocation(method_name, params)
+        send(method_name, *params)
+      end
+
+      def before_invocation(name, args, &block)
+        call_interceptors(self.class.before_invocation_interceptors, [name, args], &block)
+      end
+
+      def after_invocation(name, args, result)
+        call_interceptors(self.class.after_invocation_interceptors, [name, args, result])
+      end
+
+      private
+
+        def call_interceptors(interceptors, interceptor_args, &block)
+          if interceptors and not interceptors.empty?
+            interceptors.each do |interceptor|
+              next if method_exempted?(interceptor, interceptor_args[0].to_s)
+              result = case
+                when interceptor.is_a?(Symbol)
+                  self.send(interceptor, *interceptor_args)
+                when interceptor_block?(interceptor)
+                  interceptor.call(self, *interceptor_args)
+                when interceptor_class?(interceptor)
+                  interceptor.intercept(self, *interceptor_args)
+                else
+                  raise(
+                    InvocationError,
+                    "Interceptors need to be either a symbol, proc/method, or a class implementing a static intercept method"
+                  )
+              end
+              reason = nil
+              if result.is_a?(Array)
+                reason = result[1] if result[1]
+                result = result[0]
+              end
+              if result == false
+                block.call(reason) if block && reason
+                return false
+              end
+            end
+          end
+        end
+
+        def interceptor_block?(interceptor)
+          interceptor.respond_to?("call") && (interceptor.arity == 3 || interceptor.arity == -1)
+        end
+        
+        def interceptor_class?(interceptor)
+          interceptor.respond_to?("intercept")
+        end
+
+        def method_exempted?(interceptor, method_name)
+          case
+            when self.class.included_intercepted_methods[interceptor]
+              !self.class.included_intercepted_methods[interceptor].include?(method_name)
+            when self.class.excluded_intercepted_methods[interceptor] 
+              self.class.excluded_intercepted_methods[interceptor].include?(method_name)
+          end
+        end
+    end
+  end
+end

data/lib/action_web_service/protocol/abstract.rb

@@ -0,0 +1,112 @@
+module ActionWebService # :nodoc:
+  module Protocol # :nodoc:
+    class ProtocolError < ActionWebServiceError # :nodoc:
+    end
+
+    class AbstractProtocol # :nodoc:
+      def setup(controller)
+      end
+
+      def decode_action_pack_request(action_pack_request)
+      end
+
+      def encode_action_pack_request(service_name, public_method_name, raw_body, options={})
+        klass = options[:request_class] || SimpleActionPackRequest
+        request = klass.new({})
+        request.request_parameters['action'] = service_name.to_s
+        request.env['RAW_POST_DATA'] = raw_body
+        request.env['REQUEST_METHOD'] = 'POST'
+        request.env['HTTP_CONTENT_TYPE'] = 'text/xml'
+        request
+      end
+
+      def decode_request(raw_request, service_name, protocol_options={})
+      end
+
+      def encode_request(method_name, params, param_types)
+      end
+
+      def decode_response(raw_response)
+      end
+
+      def encode_response(method_name, return_value, return_type, protocol_options={})
+      end
+
+      def protocol_client(api, protocol_name, endpoint_uri, options)
+      end
+
+      def register_api(api)
+      end
+    end
+
+    class Request # :nodoc:
+      attr :protocol
+      attr_accessor :method_name
+      attr_accessor :method_params
+      attr :service_name
+      attr_accessor :api
+      attr_accessor :api_method
+      attr :protocol_options
+
+      def initialize(protocol, method_name, method_params, service_name, api=nil, api_method=nil, protocol_options=nil)
+        @protocol = protocol
+        @method_name = method_name
+        @method_params = method_params
+        @service_name = service_name
+        @api = api
+        @api_method = api_method
+        @protocol_options = protocol_options || {}
+      end
+    end
+
+    class Response # :nodoc:
+      attr :body
+      attr :content_type
+      attr :return_value
+
+      def initialize(body, content_type, return_value)
+        @body = body
+        @content_type = content_type
+        @return_value = return_value
+      end
+    end
+
+    class SimpleActionPackRequest < ActionController::Request # :nodoc:
+      def initialize(env = {})
+        @env = env
+        @qparams = {}
+        @rparams = {}
+        @cookies = {}
+        reset_session
+      end
+
+      def query_parameters
+        @qparams
+      end
+
+      def request_parameters
+        @rparams
+      end
+
+      def env
+        @env
+      end
+
+      def host
+        ''
+      end
+
+      def cookies
+        @cookies
+      end
+
+      def session
+        @session
+      end
+
+      def reset_session
+        @session = {}
+      end
+    end
+  end
+end