wash_out 0.2.0 → 0.2.1

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    wash_out (0.1)
+    wash_out (0.2.1)
+      nori
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -6,7 +6,9 @@ Wash Out is a gem that greatly simplifies creation of SOAP service providers.
 Installation
 ------------
 
-    $ gem install wash_out
+In your Gemfile, add this line:
+
+    gem 'wash_out'
 
 Usage
 -----
@@ -16,7 +18,7 @@ action corresponds to a certain controller method; this mapping, as well as the
 by [soap_action][] method. Check the method documentation for complete info; here,
 only a few examples will be demonstrated.
 
-  [soap_action]: #
+  [soap_action]: http://rubydoc.info/gems/wash_out/0.2.1/WashOut/SOAP/ClassMethods#soap_action-instance_method
 
 ```ruby
 # app/controllers/api_controller.rb
@@ -26,15 +28,15 @@ class ApiController < ApplicationController
   soap_action "integer_to_string",
               :args   => :integer,
               :return => :string
-  def integer_to_string(value)
-    render :soap => value.to_s
+  def integer_to_string
+    render :soap => params[:value].to_s
   end
 
   soap_action "concat",
-              :args   => { :a => :string, :b => :string }
+              :args   => { :a => :string, :b => :string },
               :return => :string
-  def concat(a, b)
-    render :soap => (a + b)
+  def concat
+    render :soap => (params[:a] + params[:b])
   end
 
   soap_action "AddCircle",
@@ -43,7 +45,9 @@ class ApiController < ApplicationController
                                         :radius => :float } },
               :return => [],
               :to     => :add_circle
-  def add_circle(circle)
+  def add_circle
+    circle = params[:circle]
+
     raise SOAPError, "radius is too small" if circle[:radius] < 3.0
 
     Circle.new(circle[:center][:x], circle[:center][:y], circle[:radius])
@@ -60,6 +64,19 @@ HelloWorld::Application.routes.draw do
 end
 ```
 
+In such a setup, the generated WSDL may be queried at path `/api/wsdl`. So, with a
+gem like Savon, a request can be done using this path:
+
+```ruby
+require 'savon'
+
+client = Savon::Client.new("http://localhost:3000/api/wsdl")
+client.wsdl.soap_actions # => [:integer_to_string, :concat]
+client.request(:concat) do
+  soap.body = { :a => "123", :b => "abc" }
+end[:value] # => "123abc"
+```
+
 License
 -------
 

data/lib/wash_out/dispatcher.rb

@@ -1,3 +1,5 @@
+require 'nori'
+
 module WashOut
   # The WashOut::Dispatcher module should be included in a controller acting
   # as a SOAP endpoint. It includes actions for generating WSDL and handling
@@ -21,19 +23,20 @@ module WashOut
     def _action
       map       = self.class.soap_actions
       method    = request.env['HTTP_SOAPACTION'].gsub(/^\"(.*)\"$/, '\1')
-      @_current = map[method]
+      @_current = map[method.force_encoding('UTF-8')]
 
-      raise SoapError, "Method #{method} does not exists" unless @_current
+      raise SOAPError, "Method #{method} does not exists" unless @_current
 
-      xml_data = params['Envelope']['Body'][method]
+      params = Nori.parse(request.body)
+      xml_data = params[:envelope][:body][method.downcase.to_sym]
 
-      params = (xml_data || {}).map do |opt, value|
-        opt = opt.underscore
-        param = @_current[:in].find { |param| param.name == opt }
+      @_params = HashWithIndifferentAccess.new
+      (xml_data || {}).map do |opt, value|
+        param = @_current[:in].find { |param| param.name.underscore.to_sym == opt }
         raise SOAPError, "unknown parameter #{opt}" unless param
-        [ opt, param.load(value) ]
+
+        @_params[param.name] = param.load(value)
       end
-      @_params.merge!(Hash[*params.flatten])
 
       send(@_current[:to])
     end
@@ -49,15 +52,23 @@ module WashOut
              :locals => { :result => result }
     end
 
+    # Render a SOAP error response.
+    #
+    # Rails do not support sequental rescue_from handling, that is, rescuing an
+    # exception from a rescue_from handler. Hence this function is a public API.
+    def render_soap_error(message)
+      render :template => 'wash_with_soap/error', :status => 500,
+             :locals => { :error_message => message }
+    end
+
     private
 
     def self.included(controller)
-      controller.send :rescue_from, SOAPError, :with => :_render_soap_error
+      controller.send :rescue_from, SOAPError, :with => :_render_soap_exception
     end
 
-    def _render_soap_error(error)
-      render :template => 'wash_with_soap/error', :status => 500,
-             :locals => { :error_message => error.message }
+    def _render_soap_exception(error)
+      render_soap_error(error.message)
     end
   end
 end

data/lib/wash_out/version.rb

@@ -1,3 +1,3 @@
 module WashOut
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/wash_out_spec.rb

@@ -1,3 +1,5 @@
+#encoding:utf-8
+
 require 'spec_helper'
 
 describe WashOut do
@@ -95,4 +97,27 @@ describe WashOut do
       end
     }.should raise_exception(Savon::SOAP::Fault)
   end
+
+  it "should report a SOAP error if method does not exists" do
+    mock_controller{}.use!
+
+    client = savon_instance
+    lambda {
+      client.request(:nonexistent)
+    }.should raise_exception(Savon::SOAP::Fault)
+  end
+
+  it "should be possible to explicitly render a SOAP error" do
+    mock_controller do
+      soap_action "error", :args => [], :return => []
+      def error
+        render_soap_error "a message"
+      end
+    end.use!
+
+    client = savon_instance
+    lambda {
+      client.request(:error)
+    }.should raise_exception(Savon::SOAP::Fault)
+  end
 end

data/wash_out.gemspec

@@ -13,6 +13,7 @@ Gem::Specification.new do |s|
   s.files         = `git ls-files`.split("\n")
   s.require_paths = ["lib"]
 
+  s.add_dependency("nori")
   s.add_development_dependency("rspec-rails")
   s.add_development_dependency("appraisal")
   s.add_development_dependency("tzinfo")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wash_out
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-23 00:00:00.000000000 Z
+date: 2011-12-09 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: &70328753506960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70328753506960
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &70156242369620 !ruby/object:Gem::Requirement
+  requirement: &70328753506480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156242369620
+  version_requirements: *70328753506480
 - !ruby/object:Gem::Dependency
   name: appraisal
-  requirement: &70156242369200 !ruby/object:Gem::Requirement
+  requirement: &70328753506040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156242369200
+  version_requirements: *70328753506040
 - !ruby/object:Gem::Dependency
   name: tzinfo
-  requirement: &70156242368780 !ruby/object:Gem::Requirement
+  requirement: &70328753505480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156242368780
+  version_requirements: *70328753505480
 - !ruby/object:Gem::Dependency
   name: savon
-  requirement: &70156242368360 !ruby/object:Gem::Requirement
+  requirement: &70328753504960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +66,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70156242368360
+  version_requirements: *70328753504960
 description: Dead simple Rails 3 SOAP server library
 email: boris@roundlake.ru
 executables: []