wash_out 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3071f45f7db5e92c1268fa07d37d9360e8d7de1d
-  data.tar.gz: 3f41b6bb8e62a70f706f1d741a6dce76d3056c14
+  metadata.gz: 19fe1a666c510fa52e22b9c31a93a38424d2aa32
+  data.tar.gz: 1c01364f646262f102e61b6aa810fcf94fdf4f6a
 SHA512:
-  metadata.gz: b943c09e30288f5e2f667dcd91f0d395e7764ac30c7402a6351660bd2abd394e7b406f4d7be2304c6565ba0c6032f04315012cbbe0f71911243ab23bff722d76
-  data.tar.gz: b0d9054e3443979843838603f557451e57f7915d81f7a25611a9c8a5323efbf4b03f7b1ddc3fab3cea147a76c8431ac8a54a96a56cc31dcb0704c1373945b4c5
+  metadata.gz: 13d6e1f2e7d3bc7a9dd6ce4733b54ae7a676fc92c301e88c6dd5744a7fe989f7c980e5b84702eee31adc119914fbbb1aa9feb0b178f85a43c67c93edd045d70e
+  data.tar.gz: 1ba235561f6101acddeb623aa5e0750911ed24310532802f74ecc9597e5d845ab32775348888b934c0088b8b333dc7ed4ecfe3dd8970988ed4cfc6b4d556066c

data/.gitignore

@@ -1,6 +1,9 @@
 .rbx/
 .bundle/
+*.gem
 .idea/
+.rvmrc
+*.swp
 log/*.log
 pkg/
 spec/dummy/db/*.sqlite3
@@ -8,3 +11,5 @@ spec/dummy/log/*.log
 spec/dummy/tmp/
 gemfiles/rails-3.1.0.gemfile.lock b/gemfiles/rails-3.1.0.gemfile.lock
 gemfiles/rails-3.1.0.gemfile.lock b/gemfiles/rails-3.0.10.gemfile.lock
+coverage
+tags

data/.travis.yml

@@ -3,5 +3,4 @@ before_install:
 rvm:
   - 1.9.3
   - jruby-19mode
-  - rbx-19mode
   - 2.0.0

data/CHANGELOG.md

@@ -1,9 +1,13 @@
 # Changelog
 
+## 0.7.0
+
+* WSDL Document mode support [@gorism][]
+
 ## 0.6.0
 
-* Switched to Savon2 family
-* Main spec refactored greatly
+* Switched to Savon2 family [@inossidabile][]
+* Main spec refactored greatly [@inossidabile][]
 
 ## 0.5.4
 
@@ -82,7 +86,8 @@
 * SOAP response format improved. All results are now wrapped into tns:messages instead of soap:Body.
 * Arrays (minOccurs/maxOccurs) are now supported with `:foo => [:integer]` syntax.
 
-[@inossidabile]: https://twitter.com/#!/_inossidabile
+[@inossidabile]: http://staal.io
 [@rngtng]: https://github.com/rngtng
 [@dhinus]: https://github.com/dhinus
-[@ebeigarts]: https://github.com/ebeigarts
+[@ebeigarts]: https://github.com/ebeigarts
+[@gorism]: https://github.com/gorism

data/Gemfile.lock

@@ -8,7 +8,7 @@ GIT
 PATH
   remote: .
   specs:
-    wash_out (0.6.1)
+    wash_out (0.7.0)
       nori (~> 2.0.0)
 
 GEM
@@ -86,7 +86,7 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    rake (10.0.3)
+    rake (10.0.4)
     rb-fsevent (0.9.2)
     rdoc (3.12)
       json (~> 1.4)

data/README.md

@@ -9,10 +9,12 @@ But if you have a chance, please [http://stopsoap.com/](http://stopsoap.com/).
 
 ## Compatibility
 
-Rails >3.0 only. MRI 1.9, 2.0, JRuby (--1.9), Rubinius (--1.9).
+Rails >3.0 only. MRI 1.9, 2.0, JRuby (--1.9).
 
 Ruby 1.8 is not officially supported since 0.5.3. We will accept further compatibilty pull-requests but no upcoming versions will be tested against it.
 
+Rubinius support temporarily dropped since 0.6.2 due to Rails 4 incompatibility.
+
 ## Installation
 
 In your Gemfile, add this line:
@@ -140,6 +142,7 @@ Use `config.wash_out...` inside your environment configuration to setup WashOut.
 
 Available properties are:
 
+* **style**: sets WSDL style. Supported values are: 'document' and 'rpc'.
 * **catch_xml_errors**: intercept Rails parsing exceptions to return correct XML response for corrupt XML input. Default is `false`.
 * **namespace**: SOAP namespace to use. Default is `urn:WashOut`.
 * **snakecase**: *(DEPRECATED SINCE 0.4.0)* Determines if WashOut should modify parameters keys to snakecase. Default is `false`.
@@ -157,7 +160,7 @@ soap_action "foo" # this will be passed as is
 
 ## Credits
 
-* Boris Staal ([@_inossidabile](http://twitter.com/#!/_inossidabile)) [![endorse](http://api.coderwall.com/inossidabile/endorsecount.png)](http://coderwall.com/inossidabile)
+* Boris Staal ([@inossidabile](http://staal.io)) [![endorse](http://api.coderwall.com/inossidabile/endorsecount.png)](http://coderwall.com/inossidabile)
 * Peter Zotov ([@whitequark](http://twitter.com/#!/whitequark)) [![endorse](http://api.coderwall.com/whitequark/endorsecount.png)](http://coderwall.com/inossidabile)
 
 ## Contributors
@@ -167,6 +170,7 @@ soap_action "foo" # this will be passed as is
 * Francesco Negri ([@dhinus](https://github.com/dhinus))
 * Edgars Beigarts ([@ebeigarts](https://github.com/ebeigarts))
 * [Exad](https://github.com/exad) ([@wknechtel](https://github.com/wknechtel) and [@☈king](https://github.com/rking))
+* Mark Goris ([@gorism](https://github.com/gorism))
 
 ## LICENSE
 

data/app/helpers/wash_out_helper.rb

@@ -1,25 +1,36 @@
 module WashOutHelper
+
+  def wsdl_data_options(param)
+    case WashOut::Engine.style
+    when 'rpc'
+      { :"xsi:type" => param.namespaced_type }
+    when 'document'
+      { }
+    end
+  end
+
   def wsdl_data(xml, params)
     params.each do |param|
       tag_name = param.name
+      param_options = wsdl_data_options(param)
 
       if !param.struct?
         if !param.multiplied
-          xml.tag! tag_name, param.value, "xsi:type" => param.namespaced_type
+          xml.tag! tag_name, param.value, param_options
         else
           param.value = [] unless param.value.is_a?(Array)
           param.value.each do |v|
-            xml.tag! tag_name, v, "xsi:type" => param.namespaced_type
+            xml.tag! tag_name, v, param_options
           end
         end
       else
         if !param.multiplied
-          xml.tag! tag_name, "xsi:type" => param.namespaced_type do
+          xml.tag! tag_name,  param_options do
             wsdl_data(xml, param.map)
           end
         else
           param.map.each do |p|
-            xml.tag! tag_name, "xsi:type" => param.namespaced_type do
+            xml.tag! tag_name, param_options do
               wsdl_data(xml, p.map)
             end
           end

data/app/views/wash_with_soap/document/error.builder

@@ -0,0 +1,9 @@
+xml.instruct!
+xml.tag! "soap:Envelope", "xmlns:soap" => 'http://schemas.xmlsoap.org/soap/envelope/' do
+  xml.tag! "soap:Body" do
+    xml.tag! "soap:Fault" do
+      xml.faultcode "soap:Server"
+      xml.faultstring error_message
+    end
+  end
+end

data/app/views/wash_with_soap/document/response.builder

@@ -0,0 +1,12 @@
+xml.instruct!
+xml.tag! "soap:Envelope", "xmlns:soap" => 'http://schemas.xmlsoap.org/soap/envelope/',
+                          "xmlns:xsd" => 'http://www.w3.org/2001/XMLSchema',
+                          "xmlns:tns" => @namespace do
+  xml.tag! "soap:Body" do
+    key = "tns:#{@operation}#{WashOut::Engine.camelize_wsdl ? 'Response' : '_response'}"
+
+    xml.tag! @action_spec[:response_tag] do
+      wsdl_data xml, result
+    end
+  end
+end

data/app/views/wash_with_soap/document/wsdl.builder

@@ -0,0 +1,68 @@
+xml.instruct!
+xml.definitions 'xmlns' => 'http://schemas.xmlsoap.org/wsdl/',
+                'xmlns:tns' => @namespace,
+                'xmlns:soap' => 'http://schemas.xmlsoap.org/wsdl/soap/',
+                'xmlns:xsd' => 'http://www.w3.org/2001/XMLSchema',
+                'xmlns:soap-enc' => 'http://schemas.xmlsoap.org/soap/encoding/',
+                'xmlns:wsdl' => 'http://schemas.xmlsoap.org/wsdl/',
+                'name' => @name,
+                'targetNamespace' => @namespace do
+
+  xml.types do
+    xml.tag! "schema", :targetNamespace => @namespace, :xmlns => 'http://www.w3.org/2001/XMLSchema' do
+      defined = []
+      @map.each do |operation, formats|
+        (formats[:in] + formats[:out]).each do |p|
+          wsdl_type xml, p, defined
+        end
+      end
+    end
+  end
+
+  xml.portType :name => "#{@name}_port" do
+    @map.keys.each do |operation|
+      xml.operation :name => operation do
+        xml.input :message => "tns:#{operation}"
+        xml.output :message => "tns:#{operation}#{WashOut::Engine.camelize_wsdl ? 'Response' : '_response'}"
+      end
+    end
+  end
+
+  xml.binding :name => "#{@name}_binding", :type => "tns:#{@name}_port" do
+    xml.tag! "soap:binding", :style => 'document', :transport => 'http://schemas.xmlsoap.org/soap/http'
+    @map.keys.each do |operation|
+      xml.operation :name => operation do
+        xml.tag! "soap:operation", :soapAction => operation
+        xml.input do
+          xml.tag! "soap:body",
+            :use => "literal",
+            :namespace => @namespace
+        end
+        xml.output do
+          xml.tag! "soap:body",
+            :use => "literal",
+            :namespace => @namespace
+        end
+      end
+    end
+  end
+
+  xml.service :name => "service" do
+    xml.port :name => "#{@name}_port", :binding => "tns:#{@name}_binding" do
+      xml.tag! "soap:address", :location => url_for(:action => '_action', :only_path => false)
+    end
+  end
+
+  @map.each do |operation, formats|
+    xml.message :name => "#{operation}" do
+      formats[:in].each do |p|
+        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
+      end
+    end
+    xml.message :name => "#{operation}#{WashOut::Engine.camelize_wsdl ? 'Response' : '_response'}" do
+      formats[:out].each do |p|
+        xml.part wsdl_occurence(p, false, :name => p.name, :type => p.namespaced_type)
+      end
+    end
+  end
+end

data/lib/wash_out/dispatcher.rb

@@ -15,11 +15,8 @@ module WashOut
       parser = Nori.new(
         :strip_namespaces => true,
         :advanced_typecasting => true,
-        :convert_tags_to => (
-          WashOut::Engine.snakecase_input ? lambda { |tag| tag.snakecase.to_sym }
-                                          : lambda { |tag| tag.to_sym }
-        )
-      )
+        :convert_tags_to => ( WashOut::Engine.snakecase_input ? lambda { |tag| tag.snakecase.to_sym } \
+                                : lambda { |tag| tag.to_sym } ))
 
       @_params = parser.parse(request.body.read)
       references = WashOut::Dispatcher.deep_select(@_params){|k,v| v.is_a?(Hash) && v.has_key?(:@id)}
@@ -70,14 +67,19 @@ module WashOut
         hash
       }
       xml_data = strip_empty_nodes.call(xml_data)
-      @_params = HashWithIndifferentAccess.new
+      @_params = _load_params(action_spec[:in], xml_data)
+    end
 
-      action_spec[:in].each do |param|
+    # Creates the final parameter hash based on the request spec and xml_data from the request
+    def _load_params(spec, xml_data)
+      params = HashWithIndifferentAccess.new
+      spec.each do |param|
         key = param.raw_name.to_sym
         if xml_data.has_key? key
-          @_params[param.raw_name] = param.load(xml_data, key)
+          params[param.raw_name] = param.load(xml_data, key)
         end
       end
+      params
     end
 
     # This action generates the WSDL for defined SOAP methods.
@@ -86,7 +88,7 @@ module WashOut
       @namespace = WashOut::Engine.namespace
       @name      = controller_path.gsub('/', '_')
 
-      render :template => 'wash_with_soap/wsdl', :layout => false
+      render :template => "wash_with_soap/#{WashOut::Engine.style}/wsdl", :layout => false
     end
 
     # Render a SOAP response.
@@ -136,7 +138,7 @@ module WashOut
         return result_spec
       }
 
-      render :template => 'wash_with_soap/response',
+      render :template => "wash_with_soap/#{WashOut::Engine.style}/response",
              :layout => false,
              :locals => { :result => inject.call(result, @action_spec[:out]) },
              :content_type => 'text/xml'
@@ -156,7 +158,7 @@ module WashOut
     # 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 => 422,
+      render :template => "wash_with_soap/#{WashOut::Engine.style}/error", :status => 500,
              :layout => false,
              :locals => { :error_message => message },
              :content_type => 'text/xml'

data/lib/wash_out/engine.rb

@@ -2,6 +2,7 @@ module WashOut
   class Engine < ::Rails::Engine
     class << self
       attr_accessor :namespace
+      attr_accessor :style
       attr_accessor :snakecase, :camelize_output
       attr_accessor :snakecase_input, :camelize_wsdl
       attr_accessor :wsse_username, :wsse_password
@@ -9,6 +10,7 @@ module WashOut
     end
 
     self.namespace = 'urn:WashOut'
+    self.style     = 'rpc'
     self.snakecase = nil
 
     self.snakecase_input = false
@@ -34,9 +36,14 @@ module WashOut
         raise "Usage of wash_out.camelize_output is deprecated. You should use wash_out.camelize_wsdl option instead"
       end
 
+      unless ['rpc','document'].include? self.class.style
+        raise "Invalid binding.  Style must be one of #{['rpc','document'].join(',')}"
+      end
+
       if self.class.catch_xml_errors
         app.config.middleware.insert_after 'ActionDispatch::ShowExceptions', WashOut::Middleware
       end
     end
+
   end
 end

data/lib/wash_out/param.rb

@@ -47,6 +47,7 @@ module WashOut
       data = [data] if @multiplied && !data.is_a?(Array)
 
       if struct?
+        data ||= {}
         if @multiplied
           data.map do |x|
             map_struct x do |param, data, elem|
@@ -63,7 +64,7 @@ module WashOut
           when 'string';    :to_s
           when 'integer';   :to_i
           when 'double';    :to_f
-          when 'boolean';   nil
+          when 'boolean';   lambda{|data| data === "0" ? false : !!data}
           when 'date';      :to_date
           when 'datetime';  :to_datetime
           when 'time';      :to_time
@@ -71,10 +72,11 @@ module WashOut
         end
 
         begin
-          if operation.nil? || data.nil?
+          if data.nil?
             data
           elsif @multiplied
-            data.map{|x| x.send(operation)}
+            return data.map{|x| x.send(operation)} if operation.is_a?(Symbol)
+            return data.map{|x| operation.call(x)} if operation.is_a?(Proc)
           elsif operation.is_a? Symbol
             data.send(operation)
           else

data/lib/wash_out/type.rb

@@ -21,8 +21,8 @@ module WashOut
       elsif WashOut::Engine.camelize_wsdl
         @param_type_name = @param_type_name.camelize
       end
-      
+
       @param_type_name
     end
   end
-end
+end

data/lib/wash_out/version.rb

@@ -1,3 +1,3 @@
 module WashOut
-  VERSION = "0.6.1"
+  VERSION = "0.7.0"
 end

data/spec/lib/wash_out/dispatcher_spec.rb

@@ -58,4 +58,33 @@ describe WashOut::Dispatcher do
     }
   end
 
+  describe "#_load_params" do
+    let(:dispatcher) { Dispatcher.new }
+
+    it "should load params for an array" do
+      spec = WashOut::Param.parse_def( {:my_array => [:integer] } )
+      xml_data = {:my_array => [1, 2, 3]}
+      dispatcher._load_params(spec, xml_data).should == {"my_array" => [1, 2, 3]}
+    end
+
+    it "should load params for an empty array" do
+      spec = WashOut::Param.parse_def( {:my_array => [:integer] } )
+      xml_data = {}
+      dispatcher._load_params(spec, xml_data).should == {}
+    end
+
+    it "should load params for a nested array" do
+      spec = WashOut::Param.parse_def( {:nested => {:my_array => [:integer]}} )
+      xml_data = {:nested => {:my_array => [1, 2, 3]}}
+      dispatcher._load_params(spec, xml_data).should == {"nested" => {"my_array" => [1, 2, 3]}}
+    end
+
+    it "should load params for an empty nested array" do
+      spec = WashOut::Param.parse_def( {:nested => {:empty => [:integer] }} )
+      xml_data = {:nested => nil}
+      dispatcher._load_params(spec, xml_data).should == {"nested" => {}}
+    end
+
+  end
+
 end

data/spec/lib/wash_out/param_spec.rb

@@ -4,34 +4,56 @@ require 'spec_helper'
 
 describe WashOut::Param do
 
-  class Abraka1 < WashOut::Type
-    map(
-      :test => :string
-    )
+  context "custom types" do
+    class Abraka1 < WashOut::Type
+      map(
+        :test => :string
+      )
+    end
+    class Abraka2 < WashOut::Type
+      type_name 'test'
+      map :foo => Abraka1
+    end
+
+    it "loads custom_types" do
+      map = WashOut::Param.parse_def Abraka2
+
+      map.should be_a_kind_of(Array)
+      map[0].name.should == 'value'
+      map[0].map[0].name.should == 'foo'
+      map[0].map[0].map[0].name.should == 'test'
+    end
+
+    it "respects camelization setting" do
+      WashOut::Engine.camelize_wsdl = true
+
+      map = WashOut::Param.parse_def Abraka2
+
+      map.should be_a_kind_of(Array)
+      map[0].name.should == 'Value'
+      map[0].map[0].name.should == 'Foo'
+      map[0].map[0].map[0].name.should == 'Test'
+    end
   end
-  class Abraka2 < WashOut::Type
-    type_name 'test'
-    map :foo => Abraka1
-  end
-
-  it "loads custom_types" do
-    map = WashOut::Param.parse_def Abraka2
 
-    map.should be_a_kind_of(Array)
-    map[0].name.should == 'value'
-    map[0].map[0].name.should == 'foo'
-    map[0].map[0].map[0].name.should == 'test'
+  it "should accept nested empty arrays" do
+    map = WashOut::Param.parse_def( {:nested => {:some_attr => :string, :empty => [:integer] }} )
+    map[0].load( {:nested => nil}, :nested).should == {}
   end
 
-  it "respects camelization setting" do
-    WashOut::Engine.camelize_wsdl = true
+  describe "booleans" do
+    # following http://www.w3.org/TR/xmlschema-2/#boolean, only true, false, 0 and 1 are allowed.
+    # Nori maps the strings true and false to TrueClass and FalseClass, but not 0 and 1.
+    let(:map) { WashOut::Param.parse_def(:value => :boolean) }
 
-    map = WashOut::Param.parse_def Abraka2
+    it "should accept 'true' and '1'" do
+      map[0].load({:value => true}, :value).should be_true
+      map[0].load({:value => "1"}, :value).should be_true
+    end
 
-    map.should be_a_kind_of(Array)
-    map[0].name.should == 'Value'
-    map[0].map[0].name.should == 'Foo'
-    map[0].map[0].map[0].name.should == 'Test'
+    it "should accept 'false' and '0'" do
+      map[0].load({:value => false}, :value).should be_false
+      map[0].load({:value => "0"}, :value).should be_false
+    end
   end
-
-end
+end

data/spec/lib/wash_out_spec.rb

@@ -185,6 +185,36 @@ describe WashOut do
         savon(:rumba, :rumbas => [1, 2, 3])
       end
 
+      it "accept empty arrays" do
+        mock_controller do
+          soap_action "rumba",
+                      :args   => {
+                        :my_array => [:integer]
+                      },
+                      :return => nil
+          def rumba
+            params.should == {}
+            render :soap => nil
+          end
+        end
+        savon(:rumba, :empty => [])
+      end
+
+      it "accept nested empty arrays" do
+        mock_controller do
+          soap_action "rumba",
+                      :args   => {
+                        :nested => {:my_array => [:integer] }
+                      },
+                      :return => nil
+          def rumba
+            params.should == {"nested" => {}}
+            render :soap => nil
+          end
+        end
+        savon(:rumba, :nested => {:my_array => []})
+      end
+
       it "accept nested structures inside arrays" do
         mock_controller do
           soap_action "rumba",
@@ -357,8 +387,10 @@ describe WashOut do
           end
         end
 
-        savon(:true, :value => true)
-        savon(:false, :value => false)
+        savon(:true, :value => "true")
+        savon(:true, :value => "1")
+        savon(:false, :value => "false")
+        savon(:false, :value => "0")
       end
 
       it "recognize dates" do

data/spec/spec_helper.rb

@@ -1,6 +1,13 @@
 # Configure Rails Envinronment
 ENV["RAILS_ENV"] = "test"
 
+require "simplecov"
+SimpleCov.start do
+  add_filter 'spec'
+  add_group 'Library', 'lib'
+  add_group 'App', 'app'
+end
+
 require File.expand_path("../dummy/config/environment.rb",  __FILE__)
 require "rails/test_help"
 require "rspec/rails"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wash_out
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Boris Staal
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-07 00:00:00.000000000 Z
+date: 2013-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nori
@@ -43,9 +43,12 @@ files:
 - README.md
 - Rakefile
 - app/helpers/wash_out_helper.rb
-- app/views/wash_with_soap/error.builder
-- app/views/wash_with_soap/response.builder
-- app/views/wash_with_soap/wsdl.builder
+- app/views/wash_with_soap/document/error.builder
+- app/views/wash_with_soap/document/response.builder
+- app/views/wash_with_soap/document/wsdl.builder
+- app/views/wash_with_soap/rpc/error.builder
+- app/views/wash_with_soap/rpc/response.builder
+- app/views/wash_with_soap/rpc/wsdl.builder
 - gemfiles/rails_3.1.3.gemfile
 - gemfiles/rails_3.1.3.gemfile.lock
 - gemfiles/rails_3.2.12.gemfile