axtro-actionwebservice 2.3.5.1.20101118142125

data/lib/action_web_service/protocol/xmlrpc_protocol.rb

@@ -0,0 +1,124 @@
+# encoding: UTF-8
+require 'xmlrpc/marshal'
+require 'action_web_service/client/xmlrpc_client'
+
+module XMLRPC # :nodoc:
+  class FaultException # :nodoc:
+    alias :message :faultString
+  end
+  
+  class Create
+    def wrong_type(value)
+      if BigDecimal === value
+        [true, value.to_f]
+      else
+        false
+      end
+    end
+  end
+end
+
+module ActionWebService # :nodoc:
+  module API # :nodoc: 
+    class Base # :nodoc:
+      def self.xmlrpc_client(endpoint_uri, options={})
+        ActionWebService::Client::XmlRpc.new self, endpoint_uri, options
+      end
+    end
+  end
+
+  module Protocol # :nodoc:
+    module XmlRpc # :nodoc:
+      def self.included(base)
+        base.register_protocol(XmlRpcProtocol)
+      end
+      
+      class XmlRpcProtocol < AbstractProtocol # :nodoc:
+        def self.create(controller)
+          XmlRpcProtocol.new
+        end
+
+        def decode_action_pack_request(action_pack_request)
+          service_name = action_pack_request.parameters['action']
+          decode_request(action_pack_request.raw_post, service_name)
+        end
+
+        def decode_request(raw_request, service_name)
+          method_name, params = XMLRPC::Marshal.load_call(raw_request)
+          Request.new(self, method_name, params, service_name)
+        rescue
+          return nil
+        end
+
+        def encode_request(method_name, params, param_types)
+          if param_types
+            params = params.dup
+            param_types.each_with_index{ |type, i| params[i] = value_to_xmlrpc_wire_format(params[i], type) }
+          end
+          XMLRPC::Marshal.dump_call(method_name, *params)
+        end
+
+        def decode_response(raw_response)
+          [nil, XMLRPC::Marshal.load_response(raw_response)]
+        end
+
+        def encode_response(method_name, return_value, return_type, protocol_options={})
+          if return_value && return_type
+            return_value = value_to_xmlrpc_wire_format(return_value, return_type)
+          end
+          return_value = false if return_value.nil?
+          raw_response = XMLRPC::Marshal.dump_response(return_value)
+          Response.new(raw_response, 'text/xml', return_value)
+        end
+
+        def encode_multicall_response(responses, protocol_options={})
+          result = responses.map do |return_value, return_type|
+            if return_value && return_type
+              return_value = value_to_xmlrpc_wire_format(return_value, return_type) 
+              return_value = [return_value] unless return_value.nil?
+            end
+            return_value = false if return_value.nil?
+            return_value
+          end
+          raw_response = XMLRPC::Marshal.dump_response(result)
+          Response.new(raw_response, 'text/xml', result)
+        end
+
+        def protocol_client(api, protocol_name, endpoint_uri, options={})
+          return nil unless protocol_name == :xmlrpc
+          ActionWebService::Client::XmlRpc.new(api, endpoint_uri, options)
+        end
+
+        def value_to_xmlrpc_wire_format(value, value_type)
+          if value_type.array?
+            value.map{ |val| value_to_xmlrpc_wire_format(val, value_type.element_type) }
+          else
+            if value.is_a?(ActionWebService::Struct)
+              struct = {}
+              value.class.members.each do |name, type_options|
+                type, options = type_options
+                member_value = value[name]
+                next if member_value.nil?
+                struct[name.to_s] = value_to_xmlrpc_wire_format(member_value, type)
+              end
+              struct
+            elsif value.is_a?(ActiveRecord::Base)
+              struct = {}
+              value.attributes.each do |key, member_value|
+                next if member_value.nil?
+                struct[key.to_s] = member_value
+              end
+              struct
+            elsif value.is_a?(ActionWebService::Base64)
+              XMLRPC::Base64.new(value)
+            elsif value.is_a?(Exception) && !value.is_a?(XMLRPC::FaultException)
+              XMLRPC::FaultException.new(2, value.message)
+            else
+              value
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_web_service/scaffolding.rb

@@ -0,0 +1,282 @@
+# encoding: UTF-8
+require 'benchmark'
+require 'pathname'
+
+module ActionWebService
+  module Scaffolding # :nodoc:
+    class ScaffoldingError < ActionWebServiceError # :nodoc:
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # Web service invocation scaffolding provides a way to quickly invoke web service methods in a controller. The
+    # generated scaffold actions have default views to let you enter the method parameters and view the
+    # results.
+    #
+    # Example:
+    #
+    #   class ApiController < ActionController
+    #     web_service_scaffold :invoke
+    #   end
+    #
+    # This example generates an +invoke+ action in the +ApiController+ that you can navigate to from
+    # your browser, select the API method, enter its parameters, and perform the invocation.
+    #
+    # If you want to customize the default views, create the following views in "app/views":
+    #
+    # * <tt>action_name/methods.html.erb</tt>
+    # * <tt>action_name/parameters.html.erb</tt>
+    # * <tt>action_name/result.html.erb</tt>
+    # * <tt>action_name/layout.html.erb</tt>
+    #
+    # Where <tt>action_name</tt> is the name of the action you gave to ClassMethods#web_service_scaffold.
+    #
+    # You can use the default views in <tt>RAILS_DIR/lib/action_web_service/templates/scaffolds</tt> as
+    # a guide.
+    module ClassMethods
+      # Generates web service invocation scaffolding for the current controller. The given action name
+      # can then be used as the entry point for invoking API methods from a web browser.
+      def web_service_scaffold(action_name)
+        add_template_helper(Helpers)
+        module_eval <<-"end_eval", __FILE__, __LINE__ + 1
+          def #{action_name}
+            if request.method == :get
+              setup_invocation_assigns
+              render_invocation_scaffold 'methods'
+            end
+          end
+
+          def #{action_name}_method_params
+            if request.method == :get
+              setup_invocation_assigns
+              render_invocation_scaffold 'parameters'
+            end
+          end
+
+          def #{action_name}_submit
+            if request.method == :post
+              setup_invocation_assigns
+              protocol_name = params['protocol'] ? params['protocol'].to_sym : :soap
+              case protocol_name
+              when :soap
+                @protocol = Protocol::Soap::SoapProtocol.create(self)
+              when :xmlrpc
+                @protocol = Protocol::XmlRpc::XmlRpcProtocol.create(self)
+              end
+              bm = Benchmark.measure do
+                @protocol.register_api(@scaffold_service.api)
+                post_params = params['method_params'] ? params['method_params'].dup : nil
+                params = []
+                @scaffold_method.expects.each_with_index do |spec, i|
+                  params << post_params[i.to_s]
+                end if @scaffold_method.expects
+                params = @scaffold_method.cast_expects(params)
+                method_name = public_method_name(@scaffold_service.name, @scaffold_method.public_name)
+                @method_request_xml = @protocol.encode_request(method_name, params, @scaffold_method.expects)
+                new_request = @protocol.encode_action_pack_request(@scaffold_service.name, @scaffold_method.public_name, @method_request_xml)
+                prepare_request(new_request, @scaffold_service.name, @scaffold_method.public_name)
+                self.request = new_request
+                if @scaffold_container.dispatching_mode != :direct
+                  request.parameters['action'] = @scaffold_service.name
+                end
+                dispatch_web_service_request
+                @method_response_xml = response.body
+                method_name, obj = @protocol.decode_response(@method_response_xml)
+                return if handle_invocation_exception(obj)
+                @method_return_value = @scaffold_method.cast_returns(obj)
+              end
+              @method_elapsed = bm.real
+              reset_invocation_response
+              render_invocation_scaffold 'result'
+            end
+          end
+
+          private
+            def setup_invocation_assigns
+              @scaffold_class = self.class
+              @scaffold_action_name = "#{action_name}"
+              @scaffold_container = WebServiceModel::Container.new(self)
+              if params['service'] && params['method']
+                @scaffold_service = @scaffold_container.services.find{ |x| x.name == params['service'] }
+                @scaffold_method = @scaffold_service.api_methods[params['method']]
+              end
+            end
+
+            def render_invocation_scaffold(action)
+              customized_template = "\#{self.class.controller_path}/#{action_name}/\#{action}"
+              default_template = scaffold_path(action)
+              begin
+                content = @template.render(:file => customized_template)
+              rescue ActionView::MissingTemplate
+                content = @template.render(:file => default_template)
+              end
+              @template.instance_variable_set("@content_for_layout", content)
+              if self.active_layout.nil?
+                render :file => scaffold_path("layout")
+              else
+                render :file => self.active_layout, :use_full_path => true
+              end
+            end
+
+            def scaffold_path(template_name)
+              File.dirname(__FILE__) + "/templates/scaffolds/" + template_name + ".html.erb"
+            end
+
+            def reset_invocation_response
+              erase_render_results
+              response.instance_variable_set :@header, Rack::Utils::HeaderHash.new(::ActionController::Response::DEFAULT_HEADERS.merge("cookie" => []))
+            end
+
+            def public_method_name(service_name, method_name)
+              if web_service_dispatching_mode == :layered && @protocol.is_a?(ActionWebService::Protocol::XmlRpc::XmlRpcProtocol)
+                service_name + '.' + method_name
+              else
+                method_name
+              end
+            end
+
+            def prepare_request(new_request, service_name, method_name)
+              new_request.parameters.update(request.parameters)
+              request.env.each{ |k, v| new_request.env[k] = v unless new_request.env.has_key?(k) }
+              if web_service_dispatching_mode == :layered && @protocol.is_a?(ActionWebService::Protocol::Soap::SoapProtocol)
+                new_request.env['HTTP_SOAPACTION'] = "/\#{controller_name()}/\#{service_name}/\#{method_name}"
+              end
+            end
+
+            def handle_invocation_exception(obj)
+              exception = nil
+              if obj.respond_to?(:detail) && obj.detail.respond_to?(:cause) && obj.detail.cause.is_a?(Exception)
+                exception = obj.detail.cause
+              elsif obj.is_a?(XMLRPC::FaultException)
+                exception = obj
+              end
+              return unless exception
+              reset_invocation_response
+              rescue_action(exception)
+              true
+            end
+        end_eval
+      end
+    end
+
+    module Helpers # :nodoc:
+      def method_parameter_input_fields(method, type, field_name_base, idx, was_structured=false)
+        if type.array?
+          return content_tag('em', "Typed array input fields not supported yet (#{type.name})")
+        end
+        if type.structured?
+          return content_tag('em', "Nested structural types not supported yet (#{type.name})") if was_structured
+          parameters = ""
+          type.each_member do |member_name, member_type|
+            label = method_parameter_label(member_name, member_type)
+            nested_content = method_parameter_input_fields(
+              method,
+              member_type,
+              "#{field_name_base}[#{idx}][#{member_name}]",
+              idx,
+              true)
+            if member_type.custom?
+              parameters << content_tag('li', label)
+              parameters << content_tag('ul', nested_content)
+            else
+              parameters << content_tag('li', label + ' ' + nested_content)
+            end
+          end
+          content_tag('ul', parameters)
+        else
+          # If the data source was structured previously we already have the index set          
+          field_name_base = "#{field_name_base}[#{idx}]" unless was_structured
+          
+          case type.type
+          when :int
+            text_field_tag "#{field_name_base}"
+          when :string
+            text_field_tag "#{field_name_base}"
+          when :base64
+            text_area_tag "#{field_name_base}", nil, :size => "40x5"
+          when :bool
+            radio_button_tag("#{field_name_base}", "true") + " True" +
+            radio_button_tag("#{field_name_base}", "false") + "False"
+          when :float
+            text_field_tag "#{field_name_base}"
+          when :time, :datetime
+            time = Time.now
+            i = 0
+            %w|year month day hour minute second|.map do |name|
+              i += 1
+              send("select_#{name}", time, :prefix => "#{field_name_base}[#{i}]", :discard_type => true)
+            end.join
+          when :date
+            date = Date.today
+            i = 0
+            %w|year month day|.map do |name|
+              i += 1
+              send("select_#{name}", date, :prefix => "#{field_name_base}[#{i}]", :discard_type => true)
+            end.join
+          end
+        end
+      end
+
+      def method_parameter_label(name, type)
+        name.to_s.capitalize + ' (' + type.human_name(false) + ')'
+      end
+
+      def service_method_list(service)
+        action = @scaffold_action_name + '_method_params'
+        methods = service.api_methods_full.sort {|a, b| a[1] <=> b[1]}.map do |desc, name|
+          content_tag("li", link_to(name, :action => action, :service => service.name, :method => name))
+        end
+        content_tag("ul", methods.join("\n"))
+      end
+    end
+
+    module WebServiceModel # :nodoc:
+      class Container # :nodoc:
+        attr :services
+        attr :dispatching_mode
+
+        def initialize(real_container)
+          @real_container = real_container
+          @dispatching_mode = @real_container.class.web_service_dispatching_mode
+          @services = []
+          if @dispatching_mode == :direct
+            @services << Service.new(@real_container.controller_name, @real_container)
+          else
+            @real_container.class.web_services.each do |name, obj|
+              @services << Service.new(name, @real_container.instance_eval{ web_service_object(name) })
+            end
+          end
+        end
+      end
+
+      class Service # :nodoc:
+        attr :name
+        attr :object
+        attr :api
+        attr :api_methods
+        attr :api_methods_full
+
+        def initialize(name, real_service)
+          @name = name.to_s
+          @object = real_service
+          @api = @object.class.web_service_api
+          if @api.nil?
+            raise ScaffoldingError, "No web service API attached to #{object.class}"
+          end
+          @api_methods = {}
+          @api_methods_full = []
+          @api.api_methods.each do |name, method|
+            @api_methods[method.public_name.to_s] = method
+            @api_methods_full << [method.to_s, method.public_name.to_s]
+          end
+        end
+
+        def to_s
+          self.name.camelize
+        end
+      end
+    end
+  end
+end

data/lib/action_web_service/simple.rb

@@ -0,0 +1,54 @@
+# encoding: UTF-8
+module ActionWebService
+  # To send simple types across the wire, derive from ActionWebService::Simple,
+  # and use +base+ to declare the base type for it restriction and,
+  # use +restriction+ to declare valid W3C restriction element for SimpleType.
+  #
+  # ActionWebService::Simple should be used when you want to declare valid custom simple type
+  # to be used inside expects, returns and structured types
+  #
+  #
+  # There plenty documentation available at W3C Archives
+  # http://www.w3.org/TR/xmlschema-2/
+  #
+  # === Example
+  #
+  #   class Gender < ActionWebService::Simple
+  #     base :string
+  #     restriction :enumeration, "male|female"
+  #   end
+  #
+  #
+  class Simple
+
+    def initialize(value)
+      @value = value
+    end
+    
+    class << self
+      def base(type)
+        type = type.to_s.camelize(:lower)
+        write_inheritable_attribute("xml_base", type)
+        class_eval <<-END
+          def xml_base; "#{type}"; end
+        END
+      end
+      
+      def restriction_base
+        read_inheritable_attribute("xml_base") || ""
+      end
+      
+      def restriction(type, value)
+        type = type.to_s.camelize(:lower)
+        write_inheritable_hash("simple_restrictions", type => value)
+      end
+      
+      def restrictions
+        read_inheritable_attribute("simple_restrictions") || {}
+      end
+      
+    end
+
+  end
+
+end