savon 0.9.5 → 0.9.6

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 0.9.6 (2011-07-07)
+
+* Improvement/Fix: Updated Savon to use the latest version of [Wasabi](http://rubygems.org/gems/wasabi).
+  This should fix [issue 155](https://github.com/rubiii/savon/issues/155) - Savon can automatically add namespaces
+  to SOAP requests based on the WSDL. Users shouldn't need to do anything differently or even notice whether their WSDL
+  hits this case; the intention is that this will "Just Work" and follow the WSDL. The SOAP details are that if
+  elementFormDefault is specified as qualified, Savon will automatically prepend the correct XML namespaces to the
+  elements in a SOAP request.
+
+  Thanks to [jkingdon](https://github.com/jkingdon) for this.
+
+* Fix: [issue 143](https://github.com/rubiii/savon/issues/143) - Updating Wasabi should solve this issue.
+
 ## 0.9.5 (2011-07-03)
 
 * Refactoring: Extracted WSSE authentication out into the [akami](http://rubygems.org/gems/akami) gem.

data/Rakefile

@@ -1,4 +1,6 @@
-require "rake"
+require "bundler"
+Bundler::GemHelper.install_tasks
+
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new do |t|

data/lib/savon/client.rb

@@ -104,30 +104,38 @@ module Savon
       [namespace, input, attributes]
     end
 
-    # Expects and Array of +options+ and preconfigures the system.
-    def preconfigure(options)
+    # Expects an Array of +args+ to preconfigure the system.
+    def preconfigure(args)
       soap.endpoint = wsdl.endpoint
-      soap.namespace_identifier = options[0]
+      soap.namespace_identifier = args[0]
       soap.namespace = wsdl.namespace
       soap.element_form_default = wsdl.element_form_default if wsdl.document?
-      soap.body = options[2].delete(:body)
+      soap.body = args[2].delete(:body)
 
-      set_soap_action options[1]
-      set_soap_input *options
+      wsdl.type_namespaces.each do |path, uri|
+        soap.use_namespace(path, uri)
+      end
+
+      wsdl.type_definitions.each do |path, type|
+        soap.types[path] = type
+      end
+
+      set_soap_action args[1]
+      set_soap_input *args
     end
 
     # Expects an +input+ and sets the +SOAPAction+ HTTP headers.
-    def set_soap_action(input)
-      soap_action = wsdl.soap_action(input.to_sym) if wsdl.document?
-      soap_action ||= Gyoku::XMLKey.create(input).to_sym
+    def set_soap_action(input_tag)
+      soap_action = wsdl.soap_action(input_tag.to_sym) if wsdl.document?
+      soap_action ||= Gyoku::XMLKey.create(input_tag).to_sym
       http.headers["SOAPAction"] = %{"#{soap_action}"}
     end
 
     # Expects a +namespace+, +input+ and +attributes+ and sets the SOAP input.
     def set_soap_input(namespace, input, attributes)
-      new_input = wsdl.soap_input(input.to_sym) if wsdl.document?
-      new_input ||= Gyoku::XMLKey.create(input)
-      soap.input = [namespace, new_input.to_sym, attributes].compact
+      new_input_tag = wsdl.soap_input(input.to_sym) if wsdl.document?
+      new_input_tag ||= Gyoku::XMLKey.create(input)
+      soap.input = [namespace, new_input_tag.to_sym, attributes]
     end
 
     # Processes a given +block+. Yields objects if the block expects any arguments.

data/lib/savon/soap/xml.rb

@@ -75,6 +75,33 @@ module Savon
         end
       end
 
+      def namespace_by_uri(uri)
+        namespaces.each do |candidate_identifier, candidate_uri|
+          return candidate_identifier.gsub(/^xmlns:/, '') if candidate_uri == uri
+        end
+        nil
+      end
+
+      def used_namespaces
+        @used_namespaces ||= {}
+      end
+
+      def use_namespace(path, uri)
+        @internal_namespace_count ||= 0
+
+        unless identifier = namespace_by_uri(uri)
+          identifier = "ins#{@internal_namespace_count}"
+          namespaces["xmlns:#{identifier}"] = uri
+          @internal_namespace_count += 1
+        end
+
+        used_namespaces[path] = identifier
+      end
+
+      def types
+        @types ||= {}
+      end
+
       # Sets the default namespace identifier.
       attr_writer :namespace_identifier
 
@@ -114,7 +141,12 @@ module Savon
       def to_xml
         @xml ||= tag(builder, :Envelope, complete_namespaces) do |xml|
           tag(xml, :Header) { xml << header_for_xml } unless header_for_xml.empty?
-          input.nil? ? tag(xml, :Body) : tag(xml, :Body) { xml.tag!(*input) { xml << body_to_xml } }
+
+          if input.nil?
+            tag(xml, :Body)
+          else
+            tag(xml, :Body) { xml.tag!(*add_namespace_to_input) { xml << body_to_xml } }
+          end
         end
       end
 
@@ -154,7 +186,31 @@ module Savon
       # Returns the SOAP body as an XML String.
       def body_to_xml
         return body.to_s unless body.kind_of? Hash
-        Gyoku.xml body, :element_form_default => element_form_default, :namespace => namespace_identifier
+        Gyoku.xml add_namespaces_to_body(body), :element_form_default => element_form_default, :namespace => namespace_identifier
+      end
+
+      def add_namespaces_to_body(hash, path = [input[1].to_s])
+        return unless hash
+        return hash.to_s unless hash.kind_of? Hash
+
+        hash.inject({}) do |newhash, (key, value)|
+          camelcased_key = Gyoku::XMLKey.create(key)
+          newpath = path + [camelcased_key]
+
+          if used_namespaces[newpath]
+            newhash.merge(
+              "#{used_namespaces[newpath]}:#{camelcased_key}" =>
+                add_namespaces_to_body(value, types[newpath] ? [types[newpath]] : newpath)
+            )
+          else
+            newhash.merge(key => value)
+          end
+        end
+      end
+
+      def add_namespace_to_input
+        return input.compact unless used_namespaces[[input[1].to_s]]
+        [used_namespaces[[input[1].to_s]], input[1], input[2]]
       end
 
     end

data/lib/savon/version.rb

@@ -1,5 +1,5 @@
 module Savon
 
-  Version = "0.9.5"
+  Version = "0.9.6"
 
 end

data/savon.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |s|
   s.add_dependency "builder",  ">= 2.1.2"
   s.add_dependency "nori",     "~> 1.0"
   s.add_dependency "httpi",    "~> 0.9"
-  s.add_dependency "wasabi",   "~> 1.0"
+  s.add_dependency "wasabi",   "~> 2.0"
   s.add_dependency "akami",    "~> 1.0"
   s.add_dependency "gyoku",    ">= 0.4.0"
   s.add_dependency "nokogiri", ">= 1.4.0"

data/spec/fixtures/wsdl/lower_camel.xml

@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions
+  xmlns="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
+  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:s="http://www.w3.org/2001/XMLSchema"
+  xmlns:actions="http://example.com/actions"
+  targetNamespace="http://example.com/topLevelNamespace">
+    <types>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/actions">
+            <s:element name="Save">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="lowerCamel" type="s:string"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+        </s:schema>
+    </types>
+    <message name="SaveSoapIn">
+        <part name="parameters" element="actions:Save"/>
+    </message>
+    <message name="SaveSoapOut">
+        <part name="parameters" element="actions:SaveResponse"/>
+    </message>
+    <portType name="ArticleSoap">
+        <operation name="Save">
+            <input message="actions:SaveSoapIn"/>
+            <output message="actions:SaveSoapOut"/>
+        </operation>
+    </portType>
+    <binding name="ArticleSoap" type="actions:ArticleSoap">
+        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
+        <operation name="Save">
+            <soap:operation soapAction="http://example.com/actions.Save" style="document"/>
+            <input>
+                <soap:body use="literal"/>
+            </input>
+            <output>
+                <soap:body use="literal"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="StudyMDL">
+        <port name="StudyMDLSoap" binding="actions:StudyMDLSoap">
+            <soap:address location="http://example.com:1234/soap"/>
+        </port>
+    </service>
+</definitions>

data/spec/fixtures/wsdl/multiple_namespaces.xml

@@ -0,0 +1,61 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions
+  xmlns="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
+  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:s="http://www.w3.org/2001/XMLSchema"
+  xmlns:article="http://example.com/article"
+  xmlns:actions="http://example.com/actions"
+  targetNamespace="http://example.com/actions">
+    <types>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/actions">
+            <s:element name="Save">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="article" type="article:Article"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+        </s:schema>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/article">
+            <s:complexType name="Article">
+                <s:sequence>
+                    <s:element minOccurs="0" name="Author" type="s:string"/>
+                    <s:element minOccurs="0" name="Title" type="s:string"/>
+                </s:sequence>
+            </s:complexType>
+        </s:schema>
+    </types>
+    <message name="SaveSoapIn">
+        <part name="parameters" element="actions:Save"/>
+    </message>
+    <message name="SaveSoapOut">
+        <part name="parameters" element="actions:SaveResponse"/>
+    </message>
+    <portType name="ArticleSoap">
+        <operation name="Save">
+            <input message="actions:SaveSoapIn"/>
+            <output message="actions:SaveSoapOut"/>
+        </operation>
+    </portType>
+    <binding name="ArticleSoap" type="actions:ArticleSoap">
+        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
+        <operation name="Save">
+            <soap:operation soapAction="http://example.com/actions.Save" style="document"/>
+            <input>
+                <soap:body use="literal"/>
+            </input>
+            <output>
+                <soap:body use="literal"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="StudyMDL">
+        <port name="StudyMDLSoap" binding="actions:StudyMDLSoap">
+            <soap:address location="http://example.com:1234/soap"/>
+        </port>
+    </service>
+</definitions>

data/spec/fixtures/wsdl/multiple_types.xml

@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<definitions
+  xmlns="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/"
+  xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/"
+  xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/"
+  xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xmlns:s="http://www.w3.org/2001/XMLSchema"
+  xmlns:article="http://example.com/article"
+  xmlns:actions="http://example.com/actions"
+  targetNamespace="http://example.com/actions">
+    <types>
+        <s:schema elementFormDefault="qualified" targetNamespace="http://example.com/actions">
+            <s:element name="Save">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="article" type="s:string"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+            <s:element name="Get">
+                <s:complexType>
+                    <s:sequence>
+                        <s:element name="articleId" type="s:long"/>
+                    </s:sequence>
+                </s:complexType>
+            </s:element>
+        </s:schema>
+    </types>
+    <message name="SaveSoapIn">
+        <part name="parameters" element="actions:Save"/>
+    </message>
+    <message name="SaveSoapOut">
+        <part name="parameters" element="actions:SaveResponse"/>
+    </message>
+    <portType name="ArticleSoap">
+        <operation name="Save">
+            <input message="actions:SaveSoapIn"/>
+            <output message="actions:SaveSoapOut"/>
+        </operation>
+    </portType>
+    <binding name="ArticleSoap" type="actions:ArticleSoap">
+        <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
+        <operation name="Save">
+            <soap:operation soapAction="http://example.com/actions.Save" style="document"/>
+            <input>
+                <soap:body use="literal"/>
+            </input>
+            <output>
+                <soap:body use="literal"/>
+            </output>
+        </operation>
+    </binding>
+    <service name="StudyMDL">
+        <port name="StudyMDLSoap" binding="actions:StudyMDLSoap">
+            <soap:address location="http://example.com:1234/soap"/>
+        </port>
+    </service>
+</definitions>

data/spec/savon/client_spec.rb

@@ -84,7 +84,7 @@ describe Savon::Client do
 
     context "with a single argument (Symbol)" do
       it "should set the input tag to result in <getUser>" do
-        client.request(:get_user) { soap.input.should == [:getUser, {}] }
+        client.request(:get_user) { soap.input.should == [nil, :getUser, {}] }
       end
 
       it "should set the target namespace with the default identifier" do
@@ -95,7 +95,7 @@ describe Savon::Client do
       end
 
       it "should not set the target namespace if soap.namespace was set to nil" do
-        namespace = "http://v1_0.ws.auth.order.example.com/"
+        namespace = 'wsdl="http://v1_0.ws.auth.order.example.com/"'
         HTTPI::Request.any_instance.expects(:body=).with { |value| !value.include?(namespace) }
 
         client.request(:get_user) { soap.namespace = nil }
@@ -104,13 +104,13 @@ describe Savon::Client do
 
     context "with a single argument (String)" do
       it "should set the input tag to result in <get_user>" do
-        client.request("get_user") { soap.input.should == [:get_user, {}] }
+        client.request("get_user") { soap.input.should == [nil, :get_user, {}] }
       end
     end
 
     context "with a Symbol and a Hash" do
       it "should set the input tag to result in <getUser active='true'>" do
-        client.request(:get_user, :active => true) { soap.input.should == [:getUser, { :active => true }] }
+        client.request(:get_user, :active => true) { soap.input.should == [nil, :getUser, { :active => true }] }
       end
     end
 
@@ -127,7 +127,7 @@ describe Savon::Client do
       end
 
       it "should not set the target namespace if soap.namespace was set to nil" do
-        namespace = "http://v1_0.ws.auth.order.example.com/"
+        namespace = 'xmlns:v1="http://v1_0.ws.auth.order.example.com/"'
         HTTPI::Request.any_instance.expects(:body=).with { |value| !value.include?(namespace) }
 
         client.request(:v1, :get_user) { soap.namespace = nil }
@@ -261,6 +261,107 @@ describe Savon::Client do
     end
   end
 
+  context "when the WSDL specifies multiple namespaces" do
+    before do
+      HTTPI.stubs(:get).returns(new_response(:body => Fixture.wsdl(:multiple_namespaces)))
+      HTTPI.stubs(:post).returns(new_response)
+    end
+
+    it "qualifies each element with the appropriate namespace" do
+      HTTPI::Request.any_instance.expects(:body=).with do |value|
+        xml = Nokogiri::XML(value)
+
+        title = xml.at_xpath(
+          ".//actions:Save/actions:article/article:Title/text()",
+          "article" => "http://example.com/article",
+          "actions" => "http://example.com/actions").to_s
+        author = xml.at_xpath(
+          ".//actions:Save/actions:article/article:Author/text()",
+          "article" => "http://example.com/article",
+          "actions" => "http://example.com/actions").to_s
+
+        title == "Hamlet" && author == "Shakespeare"
+      end
+
+      client.request :save do
+        soap.body = { :article => { "Title" => "Hamlet", "Author" => "Shakespeare" } }
+      end
+    end
+
+    it "still sends nil as xsi:nil as in the non-namespaced case" do
+      HTTPI::Request.any_instance.expects(:body=).with do |value|
+        xml = Nokogiri::XML(value)
+
+        attribute = xml.at_xpath(".//article:Title/@xsi:nil",
+          "xsi" => "http://www.w3.org/2001/XMLSchema-instance",
+          "article" => "http://example.com/article").to_s
+
+        attribute == "true"
+      end
+
+      client.request(:save) { soap.body = { :article => { "Title" => nil } } }
+    end
+
+    it "translates between symbol :save and string 'Save'" do
+      HTTPI::Request.any_instance.expects(:body=).with do |value|
+        xml = Nokogiri::XML(value)
+        !!xml.at_xpath(".//actions:Save", "actions" => "http://example.com/actions")
+      end
+
+      client.request :save do
+        soap.body = { :article => { :title => "Hamlet", :author => "Shakespeare" } }
+      end
+    end
+
+    it "qualifies Save with the appropriate namespace" do
+      HTTPI::Request.any_instance.expects(:body=).with do |value|
+        xml = Nokogiri::XML(value)
+        !!xml.at_xpath(".//actions:Save", "actions" => "http://example.com/actions")
+      end
+
+      client.request "Save" do
+        soap.body = { :article => { :title => "Hamlet", :author => "Shakespeare" } }
+      end
+    end
+  end
+
+  context "when the WSDL has a lowerCamel name" do
+    before do
+      HTTPI.stubs(:get).returns(new_response(:body => Fixture.wsdl(:lower_camel)))
+      HTTPI.stubs(:post).returns(new_response)
+    end
+
+    it "appends namespace when name is specified explicitly" do
+      HTTPI::Request.any_instance.expects(:body=).with do |value|
+        xml = Nokogiri::XML(value)
+        !!xml.at_xpath(".//actions:Save/actions:lowerCamel", "actions" => "http://example.com/actions")
+      end
+
+      client.request("Save") { soap.body = { 'lowerCamel' => 'theValue' } }
+    end
+
+    it "still appends namespace when converting from symbol" do
+      HTTPI::Request.any_instance.expects(:body=).with do |value|
+        xml = Nokogiri::XML(value)
+        !!xml.at_xpath(".//actions:Save/actions:lowerCamel", "actions" => "http://example.com/actions")
+      end
+
+      client.request("Save") { soap.body = { :lower_camel => 'theValue' } }
+    end
+  end
+
+  context "with multiple types" do
+    before do
+      HTTPI.stubs(:get).returns(new_response(:body => Fixture.wsdl(:multiple_types)))
+      HTTPI.stubs(:post).returns(new_response)
+    end
+
+    it "does not blow up" do
+      HTTPI::Request.any_instance.expects(:body=).with { |value| value.include?("Save") }
+      client.request(:save) { soap.body = {} }
+    end
+  end
+
   context "without a WSDL document" do
     let(:client) do
       Savon::Client.new do

data/spec/savon/soap/request_spec.rb

@@ -2,7 +2,7 @@ require "spec_helper"
 
 describe Savon::SOAP::Request do
   let(:request) { Savon::SOAP::Request.new HTTPI::Request.new, soap }
-  let(:soap) { Savon::SOAP::XML.new Endpoint.soap, :get_user, :id => 1 }
+  let(:soap) { Savon::SOAP::XML.new Endpoint.soap, [nil, :get_user, {}], :id => 1 }
 
   it "contains the content type for each supported SOAP version" do
     content_type = Savon::SOAP::Request::ContentType

data/spec/savon/soap/xml_spec.rb

@@ -1,14 +1,14 @@
 require "spec_helper"
 
 describe Savon::SOAP::XML do
-  let(:xml) { Savon::SOAP::XML.new Endpoint.soap, :authenticate, :id => 1 }
+  let(:xml) { Savon::SOAP::XML.new Endpoint.soap, [nil, :authenticate, {}], :id => 1 }
 
   describe ".new" do
     it "should accept an endpoint, an input tag and a SOAP body" do
-      xml = Savon::SOAP::XML.new Endpoint.soap, :authentication, :id => 1
+      xml = Savon::SOAP::XML.new Endpoint.soap, [nil, :authentication, {}], :id => 1
 
       xml.endpoint.should == Endpoint.soap
-      xml.input.should == :authentication
+      xml.input.should == [nil, :authentication, {}]
       xml.body.should == { :id => 1 }
     end
   end
@@ -218,7 +218,7 @@ describe Savon::SOAP::XML do
 
     context "with :element_form_default set to :qualified and a :namespace" do
       let :xml do
-        Savon::SOAP::XML.new Endpoint.soap, :authenticate, :user => { :id => 1, ":noNamespace" => true }
+        Savon::SOAP::XML.new Endpoint.soap, [nil, :authenticate, {}], :user => { :id => 1, ":noNamespace" => true }
       end
 
       it "should namespace the default elements" do
@@ -246,28 +246,28 @@ describe Savon::SOAP::XML do
 
     context "with a simple input tag (Symbol)" do
       it "should just add the input tag" do
-        xml.input = :simple
+        xml.input = [nil, :simple, {}]
         xml.to_xml.should include('<simple><id>1</id></simple>')
       end
     end
 
     context "with a simple input tag (Array)" do
       it "should just add the input tag" do
-        xml.input = :simple
+        xml.input = [nil, :simple, {}]
         xml.to_xml.should include('<simple><id>1</id></simple>')
       end
     end
 
     context "with an input tag and a namespace Hash (Array)" do
       it "should contain the input tag with namespaces" do
-        xml.input = [:getUser, { "active" => true }]
+        xml.input = [nil, :getUser, { "active" => true }]
         xml.to_xml.should include('<getUser active="true"><id>1</id></getUser>')
       end
     end
 
     context "with a prefixed input tag (Array)" do
       it "should contain a prefixed input tag" do
-        xml.input = [:wsdl, :getUser]
+        xml.input = [:wsdl, :getUser, {}]
         xml.to_xml.should include('<wsdl:getUser><id>1</id></wsdl:getUser>')
       end
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: savon
 version: !ruby/object:Gem::Version 
-  hash: 49
+  hash: 55
   prerelease: 
   segments: 
   - 0
   - 9
-  - 5
-  version: 0.9.5
+  - 6
+  version: 0.9.6
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-03 00:00:00 Z
+date: 2011-07-07 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: builder
@@ -71,11 +71,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 3
         segments: 
-        - 1
+        - 2
         - 0
-        version: "1.0"
+        version: "2.0"
   type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
@@ -245,6 +245,9 @@ files:
 - spec/fixtures/response/soap_fault.xml
 - spec/fixtures/response/soap_fault12.xml
 - spec/fixtures/wsdl/authentication.xml
+- spec/fixtures/wsdl/lower_camel.xml
+- spec/fixtures/wsdl/multiple_namespaces.xml
+- spec/fixtures/wsdl/multiple_types.xml
 - spec/savon/client_spec.rb
 - spec/savon/core_ext/object_spec.rb
 - spec/savon/core_ext/string_spec.rb