pelle-actionwebservice 2.3.3

data/lib/action_web_service/scaffolding.rb

@@ -0,0 +1,281 @@
+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.map do |desc, name|
+          content_tag("li", link_to(desc, :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/struct.rb

@@ -0,0 +1,64 @@
+module ActionWebService
+  # To send structured types across the wire, derive from ActionWebService::Struct,
+  # and use +member+ to declare structure members.
+  #
+  # ActionWebService::Struct should be used in method signatures when you want to accept or return
+  # structured types that have no Active Record model class representations, or you don't
+  # want to expose your entire Active Record model to remote callers.
+  #
+  # === Example
+  #
+  #   class Person < ActionWebService::Struct
+  #     member :id,         :int
+  #     member :firstnames, [:string]
+  #     member :lastname,   :string
+  #     member :email,      :string
+  #   end
+  #   person = Person.new(:id => 5, :firstname => 'john', :lastname => 'doe')
+  #
+  # Active Record model classes are already implicitly supported in method
+  # signatures.
+  class Struct
+    # If a Hash is given as argument to an ActionWebService::Struct constructor,
+    # it can contain initial values for the structure member.
+    def initialize(values={})
+      if values.is_a?(Hash)
+        values.map{|k,v| __send__('%s=' % k.to_s, v)}
+      end
+    end
+
+    # The member with the given name
+    def [](name)
+      send(name.to_s)
+    end
+
+    # Iterates through each member
+    def each_pair(&block)
+      self.class.members.each do |name, type|
+        yield name, self.__send__(name)
+      end
+    end
+
+    class << self
+      # Creates a structure member with the specified +name+ and +type+. Generates
+      # accessor methods for reading and writing the member value.
+      def member(name, type)
+        name = name.to_sym
+        type = ActionWebService::SignatureTypes.canonical_signature_entry({ name => type }, 0)
+        write_inheritable_hash("struct_members", name => type)
+        class_eval <<-END
+          def #{name}; @#{name}; end
+          def #{name}=(value); @#{name} = value; end
+        END
+      end
+  
+      def members # :nodoc:
+        read_inheritable_attribute("struct_members") || {}
+      end
+
+      def member_type(name) # :nodoc:
+        members[name.to_sym]
+      end
+    end
+  end
+end

data/lib/action_web_service/support/class_inheritable_options.rb

@@ -0,0 +1,26 @@
+class Class # :nodoc:
+  def class_inheritable_option(sym, default_value=nil)
+    write_inheritable_attribute sym, default_value
+    class_eval <<-EOS
+      def self.#{sym}(value=nil)
+        if !value.nil?
+          write_inheritable_attribute(:#{sym}, value)
+        else
+          read_inheritable_attribute(:#{sym})
+        end
+      end
+      
+      def self.#{sym}=(value)
+        write_inheritable_attribute(:#{sym}, value)
+      end
+
+      def #{sym}
+        self.class.#{sym}
+      end
+
+      def #{sym}=(value)
+        self.class.#{sym} = value
+      end
+    EOS
+  end
+end

data/lib/action_web_service/support/signature_types.rb

@@ -0,0 +1,226 @@
+module ActionWebService # :nodoc:
+  # Action Web Service supports the following base types in a signature:
+  #
+  # [<tt>:int</tt>]      Represents an integer value, will be cast to an integer using <tt>Integer(value)</tt>
+  # [<tt>:string</tt>]   Represents a string value, will be cast to an string using the <tt>to_s</tt> method on an object
+  # [<tt>:base64</tt>]   Represents a Base 64 value, will contain the binary bytes of a Base 64 value sent by the caller
+  # [<tt>:bool</tt>]     Represents a boolean value, whatever is passed will be cast to boolean (<tt>true</tt>, '1', 'true', 'y', 'yes' are taken to represent true; <tt>false</tt>, '0', 'false', 'n', 'no' and <tt>nil</tt> represent false)
+  # [<tt>:float</tt>]    Represents a floating point value, will be cast to a float using <tt>Float(value)</tt>
+  # [<tt>:time</tt>]     Represents a timestamp, will be cast to a <tt>Time</tt> object
+  # [<tt>:datetime</tt>] Represents a timestamp, will be cast to a <tt>DateTime</tt> object
+  # [<tt>:date</tt>]     Represents a date, will be cast to a <tt>Date</tt> object
+  #
+  # For structured types, you'll need to pass in the Class objects of
+  # ActionWebService::Struct and ActiveRecord::Base derivatives.
+  module SignatureTypes
+    def canonical_signature(signature) # :nodoc:
+      return nil if signature.nil?
+      unless signature.is_a?(Array)
+        raise(ActionWebServiceError, "Expected signature to be an Array")
+      end
+      i = -1
+      signature.map{ |spec| canonical_signature_entry(spec, i += 1) }
+    end
+
+    def canonical_signature_entry(spec, i) # :nodoc:
+      orig_spec = spec
+      name = "param#{i}"
+      if spec.is_a?(Hash)
+        name, spec = spec.keys.first, spec.values.first
+      end
+      type = spec
+      if spec.is_a?(Array)
+        ArrayType.new(orig_spec, canonical_signature_entry(spec[0], 0), name)
+      else
+        type = canonical_type(type)
+        if type.is_a?(Symbol)
+          BaseType.new(orig_spec, type, name)
+        else
+          StructuredType.new(orig_spec, type, name)
+        end
+      end
+    end
+
+    def canonical_type(type) # :nodoc:
+      type_name = symbol_name(type) || class_to_type_name(type)
+      type = type_name || type
+      return canonical_type_name(type) if type.is_a?(Symbol)
+      type
+    end
+
+    def canonical_type_name(name) # :nodoc:
+      name = name.to_sym
+      case name
+        when :int, :integer, :fixnum, :bignum
+          :int
+        when :string, :text
+          :string
+        when :base64, :binary
+          :base64
+        when :bool, :boolean
+          :bool
+        when :float, :double
+          :float
+        when :decimal
+          :decimal
+        when :time, :timestamp
+          :time
+        when :datetime
+          :datetime
+        when :date
+          :date
+        else
+          raise(TypeError, "#{name} is not a valid base type")
+      end
+    end
+
+    def canonical_type_class(type) # :nodoc:
+      type = canonical_type(type)
+      type.is_a?(Symbol) ? type_name_to_class(type) : type
+    end
+
+    def symbol_name(name) # :nodoc:
+      return name.to_sym if name.is_a?(Symbol) || name.is_a?(String)
+      nil
+    end
+
+    def class_to_type_name(klass) # :nodoc:
+      klass = klass.class unless klass.is_a?(Class)
+      if derived_from?(Integer, klass) || derived_from?(Fixnum, klass) || derived_from?(Bignum, klass)
+        :int
+      elsif klass == String
+        :string
+      elsif klass == Base64
+        :base64
+      elsif klass == TrueClass || klass == FalseClass
+        :bool
+      elsif derived_from?(Float, klass) || derived_from?(Precision, klass) || derived_from?(Numeric, klass)
+        :float
+      elsif klass == Time
+        :time
+      elsif klass == DateTime
+        :datetime
+      elsif klass == Date
+        :date
+      else
+        nil
+      end
+    end
+
+    def type_name_to_class(name) # :nodoc:
+      case canonical_type_name(name)
+      when :int
+        Integer
+      when :string
+        String
+      when :base64
+        Base64
+      when :bool
+        TrueClass
+      when :float
+        Float
+      when :decimal
+        BigDecimal
+      when :time
+        Time
+      when :date
+        Date
+      when :datetime
+        DateTime
+      else
+        nil
+      end
+    end
+
+    def derived_from?(ancestor, child) # :nodoc:
+      child.ancestors.include?(ancestor)
+    end
+
+    module_function :type_name_to_class
+    module_function :class_to_type_name
+    module_function :symbol_name
+    module_function :canonical_type_class
+    module_function :canonical_type_name
+    module_function :canonical_type
+    module_function :canonical_signature_entry
+    module_function :canonical_signature
+    module_function :derived_from?
+  end
+
+  class BaseType # :nodoc:
+    include SignatureTypes
+
+    attr :spec
+    attr :type
+    attr :type_class
+    attr :name
+
+    def initialize(spec, type, name)
+      @spec = spec
+      @type = canonical_type(type)
+      @type_class = canonical_type_class(@type)
+      @name = name
+    end
+
+    def custom?
+      false
+    end
+
+    def array?
+      false
+    end
+
+    def structured?
+      false
+    end
+
+    def human_name(show_name=true)
+      type_type = array? ? element_type.type.to_s : self.type.to_s
+      str = array? ? (type_type + '[]') : type_type
+      show_name ? (str + " " + name.to_s) : str
+    end
+  end
+
+  class ArrayType < BaseType # :nodoc:
+    attr :element_type
+
+    def initialize(spec, element_type, name)
+      super(spec, Array, name)
+      @element_type = element_type
+    end
+
+    def custom?
+      true
+    end
+
+    def array?
+      true
+    end
+  end
+
+  class StructuredType < BaseType # :nodoc:
+    def each_member
+      if @type_class.respond_to?(:members)
+        @type_class.members.each do |name, type|
+          yield name, type
+        end
+      elsif @type_class.respond_to?(:columns)
+        i = -1
+        @type_class.columns.each do |column|
+          yield column.name, canonical_signature_entry(column.type, i += 1)
+        end
+      end
+    end
+
+    def custom?
+      true
+    end
+
+    def structured?
+      true
+    end
+  end
+
+  class Base64 < String # :nodoc:
+  end
+end

data/lib/action_web_service/templates/scaffolds/layout.html.erb

@@ -0,0 +1,65 @@
+<html>
+<head>
+  <title><%= @scaffold_class.wsdl_service_name %> Web Service</title>
+  <style>
+    body { background-color: #fff; color: #333; }
+
+    body, p, ol, ul, td {
+      font-family: verdana, arial, helvetica, sans-serif;
+      font-size:   13px;
+      line-height: 18px;
+    }
+
+    pre {
+      background-color: #eee;
+      padding: 10px;
+      font-size: 11px;
+    }
+
+    a { color: #000; }
+    a:visited { color: #666; }
+    a:hover { color: #fff; background-color:#000; }
+
+    .fieldWithErrors {
+      padding: 2px;
+      background-color: red;
+      display: table;
+    }
+
+    #errorExplanation {
+      width: 400px;
+      border: 2px solid red;
+      padding: 7px;
+      padding-bottom: 12px;
+      margin-bottom: 20px;
+      background-color: #f0f0f0;
+    }
+
+    #errorExplanation h2 {
+      text-align: left;
+      font-weight: bold;
+      padding: 5px 5px 5px 15px;
+      font-size: 12px;
+      margin: -7px;
+      background-color: #c00;
+      color: #fff;
+    }
+
+    #errorExplanation p {
+      color: #333;
+      margin-bottom: 0;
+      padding: 5px;
+    }
+
+    #errorExplanation ul li {
+      font-size: 12px;
+      list-style: square;
+    }
+  </style>
+</head>
+<body>
+
+<%= @content_for_layout %>
+
+</body>
+</html>

data/lib/action_web_service/templates/scaffolds/methods.html.erb

@@ -0,0 +1,6 @@
+<% @scaffold_container.services.each do |service| %>
+
+  <h4>API Methods for <%= service %></h4>
+  <%= service_method_list(service) %>
+
+<% end %>

data/lib/action_web_service/templates/scaffolds/parameters.html.erb

@@ -0,0 +1,29 @@
+<h4>Method Invocation Details for <em><%= @scaffold_service %>#<%= @scaffold_method.public_name %></em></h4>
+
+<% form_tag(:action => @scaffold_action_name + '_submit') do  -%>
+<%= hidden_field_tag "service", @scaffold_service.name %>
+<%= hidden_field_tag "method", @scaffold_method.public_name %>
+
+<p>
+<label for="protocol">Protocol:</label><br />
+<%= select_tag 'protocol', options_for_select([['SOAP', 'soap'], ['XML-RPC', 'xmlrpc']], params['protocol']) %>
+</p>
+
+<% if @scaffold_method.expects %>
+
+<strong>Method Parameters:</strong><br />
+<% @scaffold_method.expects.each_with_index do |type, i| %>
+  <p>
+  <label for="method_params[<%= i %>]"><%= method_parameter_label(type.name, type) %> </label><br />
+  <%= method_parameter_input_fields(@scaffold_method, type, "method_params", i) %>
+  </p>
+<% end %>
+
+<% end %>
+
+<%= submit_tag "Invoke" %>
+<% end -%>
+
+<p>
+<%= link_to "Back", :action => @scaffold_action_name %>
+</p>