require 'benchmark' require 'pathname' module ActionWebService module Scaffolding # :nodoc: class ScaffoldingError < ActionWebServiceError # :nodoc: end def self.append_features(base) super 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": # # * action_name/methods.rhtml # * action_name/parameters.rhtml # * action_name/result.rhtml # * action_name/layout.rhtml # # Where action_name is the name of the action you gave to ClassMethods#web_service_scaffold. # # You can use the default views in RAILS_DIR/lib/action_web_service/templates/scaffolds 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__ 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 @invocation_cgi = request.respond_to?(:cgi) ? request.cgi : nil bm = Benchmark.measure do @protocol.register_api(@scaffold_service.api) post_params = params['method_params'] ? params['method_params'].dup : nil params = [] if @scaffold_method.expects @scaffold_method.expects.length.times do |i| params << post_params[i.to_s] end end 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) @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 add_instance_variables_to_assigns 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 add_instance_variables_to_assigns end def render_invocation_scaffold(action) customized_template = "\#{self.class.controller_path}/#{action_name}/\#{action}" default_template = scaffold_path(action) if template_exists?(customized_template) content = @template.render_file(customized_template) else content = @template.render_file(default_template, false) 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, "200 OK", true) end end def scaffold_path(template_name) File.dirname(__FILE__) + "/templates/scaffolds/" + template_name + ".rhtml" end def reset_invocation_response template = response.template if @invocation_cgi @response = ::ActionController::CgiResponse.new(@invocation_cgi) else @response = ::ActionController::TestResponse.new end response.template = template @performed_render = false 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) if type.array? return content_tag('em', "Typed array input fields not supported yet (#{type.name})") end if type.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 + '[' + member_name.to_s + ']') 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 case type.type when :int text_field_tag field_name_base when :string text_field_tag field_name_base 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 select_datetime Time.now, 'name' => field_name_base when :date select_date Date.today, 'name' => field_name_base 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