savon 0.9.10 → 0.9.11

data/CHANGELOG.md

@@ -1,3 +1,37 @@
+## 0.9.11 (2012-06-06)
+
+* Feature: [#264](https://github.com/rubiii/savon/pull/264) - Thanks to @hoverlover, Savon and Akami now support
+  signed messages through WSSE.
+
+* Fix: [#275](https://github.com/rubiii/savon/pull/275) - Add namespaces to keys in both the SOAP body hash as well
+  as any keys specified in a :order! Array instead of having to define them manually.
+
+* Fix: [#257](https://github.com/rubiii/savon/issues/257) - Add ability to accept and send multiple cookies.
+
+* Improvement: [#277](https://github.com/rubiii/savon/pull/277) automatically namespace the SOAP input tag.
+  Here's an example from the pull request:
+
+    ``` ruby
+    client.request :authenticate
+    ```
+
+    Note the automatic namespace identifier on the authenticate element, as well as the proper namespace inclusion
+    in the document:
+
+    ``` xml
+    <env:Envelope 
+        xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
+        xmlns:tns="http://v1_0.ws.auth.order.example.com/" 
+        xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
+
+        <tns:authenticate>
+            <tns:user>username</tns:user>
+            <tns:password>password</tns:password>
+        </tns:authenticate>
+    </env:Envelope>
+    ```
+
 ## 0.9.10 (2012-06-06)
 
 * Feature: [#289](https://github.com/rubiii/savon/pull/289) - Allow the SOAP envelope header to be set as a String.

data/README.md

@@ -22,7 +22,7 @@ Introduction
 require "savon"
 
 # create a client for your SOAP service
-client = Savon::Client.new("http://service.example.com?wsdl")
+client = Savon.client("http://service.example.com?wsdl")
 
 client.wsdl.soap_actions
 # => [:create_user, :get_user, :get_all_users]

data/lib/savon/client.rb

@@ -83,6 +83,11 @@ module Savon
 
       response = SOAP::Request.new(config, http, soap).response
       set_cookie response.http.headers
+
+      if wsse.verify_response
+        WSSE::VerifySignature.new(response.http.body).verify!
+      end
+
       response
     end
 
@@ -96,7 +101,19 @@ module Savon
 
     # Passes a cookie from the last request +headers+ to the next one.
     def set_cookie(headers)
-      http.headers["Cookie"] = headers["Set-Cookie"] if headers["Set-Cookie"]
+      if headers["Set-Cookie"]
+        @cookies ||= {}
+        #handle single or multiple Set-Cookie Headers as returned by Rack::Utils::HeaderHash in HTTPI
+        set_cookies = [headers["Set-Cookie"]].flatten
+        set_cookies.each do |set_cookie|
+          # use the cookie name as the key to the hash to allow for cookie updates and seperation
+          # set the value to name=value (for easy joining), stopping when we hit the Cookie options
+          @cookies[set_cookie.split('=').first] = set_cookie.split(';').first
+        end
+
+        http.headers["Cookie"] = @cookies.values.join(';')
+      end
+
     end
 
     # Expects an Array of +args+ and returns an Array containing the namespace (might be +nil+),
@@ -112,8 +129,6 @@ module Savon
     # Expects an Array of +args+ to preconfigure the system.
     def preconfigure(args)
       soap.endpoint = wsdl.endpoint
-      soap.namespace_identifier = args[0]
-      soap.namespace = wsdl.namespace
       soap.element_form_default = wsdl.element_form_default
 
       body = args[2].delete(:body)
@@ -129,6 +144,18 @@ module Savon
 
       soap_action = args[2].delete(:soap_action) || args[1]
       set_soap_action soap_action
+
+      if wsdl.document? && (operation = wsdl.operations[args[1]]) && operation[:namespace_identifier]
+        soap.namespace_identifier = operation[:namespace_identifier].to_sym
+        soap.namespace = wsdl.parser.namespaces[soap.namespace_identifier.to_s]
+
+        # Override nil namespace with one specified in WSDL
+        args[0] = soap.namespace_identifier unless args[0]
+      else
+        soap.namespace_identifier = args[0]
+        soap.namespace = wsdl.namespace
+      end
+
       set_soap_input *args
     end
 

data/lib/savon/soap/request.rb

@@ -41,7 +41,20 @@ module Savon
       # Configures a given +http+ from the +soap+ object.
       def configure(http)
         http.url = soap.endpoint
-        http.body = soap.to_xml
+
+        if soap.signature?
+          # First generate the document so that Signature can digest sections
+          soap.wsse.signature.document = soap.to_xml(true)
+
+          # Then re-generate the document so that Signature can sign the digest
+          soap.wsse.signature.document = soap.to_xml(true)
+
+          # The third time we generate the document, we should have a signature
+          http.body = soap.to_xml(true)
+        else
+          http.body = soap.to_xml
+        end
+
         http.headers["Content-Type"] = ContentType[soap.version]
         http.headers["Content-Length"] = soap.to_xml.bytesize.to_s
         http

data/lib/savon/soap/xml.rb

@@ -1,5 +1,6 @@
 require "builder"
 require "gyoku"
+require "rexml/document"
 require "nori"
 
 require "savon/soap"
@@ -24,12 +25,9 @@ module Savon
         "xmlns:xsi" => "http://www.w3.org/2001/XMLSchema-instance"
       }
 
-      # Accepts an +endpoint+, an +input+ tag and a SOAP +body+.
-      def initialize(config, endpoint = nil, input = nil, body = nil)
+      # Expects a +config+ object.
+      def initialize(config)
         self.config = config
-        self.endpoint = endpoint if endpoint
-        self.input = input if input
-        self.body = body if body
       end
 
       attr_accessor :config
@@ -123,6 +121,10 @@ module Savon
       # Accessor for the <tt>Savon::WSSE</tt> object.
       attr_accessor :wsse
 
+      def signature?
+        wsse.respond_to?(:signature?) && wsse.signature?
+      end
+
       # Returns the SOAP request encoding. Defaults to "UTF-8".
       def encoding
         @encoding ||= "UTF-8"
@@ -152,14 +154,23 @@ module Savon
       attr_writer :xml
 
       # Returns the XML for a SOAP request.
-      def to_xml
+      def to_xml(clear_cache = false)
+        if clear_cache
+          @xml = nil
+          @header_for_xml = nil
+        end
+
         @xml ||= tag(builder, :Envelope, complete_namespaces) do |xml|
           tag(xml, :Header) { xml << header_for_xml } unless header_for_xml.empty?
 
+          # TODO: Maybe there should be some sort of plugin architecture where
+          #       classes like WSSE::Signature can hook into this process.
+          body_attributes = (signature? ? wsse.signature.body_attributes : {})
+
           if input.nil?
-            tag(xml, :Body)
+            tag(xml, :Body, body_attributes)
           else
-            tag(xml, :Body) { xml.tag!(*add_namespace_to_input) { xml << body_to_xml } }
+            tag(xml, :Body, body_attributes) { xml.tag!(*add_namespace_to_input) { xml << body_to_xml } }
           end
         end
       end
@@ -203,7 +214,8 @@ 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 add_namespaces_to_body(body), :element_form_default => element_form_default, :namespace => namespace_identifier
+        body_to_xml = element_form_default == :qualified ? add_namespaces_to_body(body) : body
+        Gyoku.xml body_to_xml, :element_form_default => element_form_default, :namespace => namespace_identifier
       end
 
       def add_namespaces_to_body(hash, path = [input[1].to_s])
@@ -221,6 +233,7 @@ module Savon
                 add_namespaces_to_body(value, types[newpath] ? [types[newpath]] : newpath)
             )
           else
+            add_namespaces_to_values(value, path) if key == :order!
             newhash.merge(key => value)
           end
         end
@@ -231,6 +244,14 @@ module Savon
         [used_namespaces[[input[1].to_s]], input[1], input[2]]
       end
 
+      def add_namespaces_to_values(values, path)
+        values.collect! { |value|
+          camelcased_value = Gyoku::XMLKey.create(value)
+          namespace_path = path + [camelcased_value.to_s]
+          namespace = used_namespaces[namespace_path]
+          "#{namespace.blank? ? '' : namespace + ":"}#{camelcased_value}"
+        }
+      end
     end
   end
 end

data/lib/savon/version.rb

@@ -1,5 +1,5 @@
 module Savon
 
-  Version = "0.9.10"
+  Version = "0.9.11"
 
 end

data/savon.gemspec

@@ -18,8 +18,8 @@ Gem::Specification.new do |s|
   s.add_dependency "builder",  ">= 2.1.2"
   s.add_dependency "nori",     "~> 1.1"
   s.add_dependency "httpi",    "~> 0.9"
-  s.add_dependency "wasabi",   "~> 2.1"
-  s.add_dependency "akami",    "~> 1.0"
+  s.add_dependency "wasabi",   "~> 2.2"
+  s.add_dependency "akami",    "~> 1.1"
   s.add_dependency "gyoku",    ">= 0.4.0"
   s.add_dependency "nokogiri", ">= 1.4.0"
 

data/spec/savon/client_spec.rb

@@ -100,6 +100,24 @@ describe Savon::Client do
 
         client.request(:get_user) { soap.namespace = nil }
       end
+
+      context "when the wsdl's operation namespace identifier matches a document identifier" do
+        before do
+          client.wsdl.operations[:authenticate][:namespace_identifier] = "tns"
+        end
+
+        it "sets the soap's namespace identifier to the matching operation's namespace identifier" do
+          client.request(:authenticate) { soap.namespace_identifier.should == :tns }
+        end
+
+        it "sets the soap's namespace to the namspace matching the identifier" do
+          client.request(:authenticate) { soap.namespace.should == "http://v1_0.ws.auth.order.example.com/" }
+        end
+
+        it "sets the input tag to result in <tns:authenticate>" do
+          client.request(:authenticate) { soap.input.should == [:tns, :authenticate, {}] }
+        end
+      end
     end
 
     context "with a single argument (String)" do
@@ -206,7 +224,7 @@ describe Savon::Client do
       client.http.headers.expects(:[]=).with("Cookie", anything).never
       client.http.headers.stubs(:[]=).with("SOAPAction", '"authenticate"')
       client.http.headers.stubs(:[]=).with("Content-Type", "text/xml;charset=UTF-8")
-      client.http.headers.stubs(:[]=).with("Content-Length", "384")
+      client.http.headers.stubs(:[]=).with("Content-Length", "383")
 
       client.request :authenticate
     end
@@ -215,17 +233,22 @@ describe Savon::Client do
   context "#request with a Set-Cookie response header" do
     before do
       HTTPI.stubs(:get).returns(new_response(:body => Fixture.wsdl(:authentication)))
-      HTTPI.stubs(:post).returns(new_response(:headers => { "Set-Cookie" => "some-cookie" }))
+      HTTPI.stubs(:post).returns(new_response(:headers => { "Set-Cookie" => "some-cookie=choc-chip; Path=/; HttpOnly" }))
     end
 
     it "should set the Cookie header for the next request" do
-      client.http.headers.expects(:[]=).with("Cookie", "some-cookie")
-      client.http.headers.stubs(:[]=).with("SOAPAction", '"authenticate"')
-      client.http.headers.stubs(:[]=).with("Content-Type", "text/xml;charset=UTF-8")
-      client.http.headers.stubs(:[]=).with("Content-Length", "384")
+      client.request :authenticate
+      client.http.headers["Cookie"].should == "some-cookie=choc-chip"
+    end
 
+    it "should set additional cookies when new cookies are found in subsequent requests" do
       client.request :authenticate
+      HTTPI.stubs(:post).returns(new_response(:headers => { "Set-Cookie" => "second-cookie=oatmeal; Path=/; HttpOnly" }))
+      client.request :nibble
+
+      client.http.headers["Cookie"].should == "some-cookie=choc-chip;second-cookie=oatmeal"
     end
+
   end
 
   context "with a remote WSDL document" do
@@ -382,7 +405,7 @@ describe Savon::Client do
 
     it "should namespaces each Array item as expected" do
       HTTPI::Request.any_instance.expects(:body=).with do |value|
-        value.include?("<ins0:cartItems><ins0:CartItem>") && value.include?("<wsdl:ItemID>SKU-TEST</wsdl:ItemID>")
+        value.include?("<ins0:cartItems><ins0:CartItem>") && value.include?("<tns:ItemID>SKU-TEST</tns:ItemID>")
       end
 
       address = { "Address1" => "888 6th Ave", "Address2" => nil, "City" => "New York", "State" => "NY", "Zip5" => "10001", "Zip4" => nil }

data/spec/savon/soap/request_spec.rb

@@ -1,11 +1,23 @@
 require "spec_helper"
 
 describe Savon::SOAP::Request do
-  let(:soap_request) { Savon::SOAP::Request.new(config, http_request, soap) }
+
+  let(:soap_request) { Savon::SOAP::Request.new(config, http_request, soap_xml) }
   let(:http_request) { HTTPI::Request.new }
-  let(:soap)         { Savon::SOAP::XML.new config, Endpoint.soap, [nil, :get_user, {}], :id => 1 }
   let(:config)       { Savon::Config.default }
 
+  def soap_xml(*args)
+    @soap_xml ||= soap_xml!(*args)
+  end
+
+  def soap_xml!(endpoint = nil, input = nil, body = nil)
+    soap = Savon::SOAP::XML.new(config)
+    soap.endpoint = endpoint || Endpoint.soap
+    soap.input    = input    || [nil, :get_user, {}]
+    soap.body     = body     || { :id => 1 }
+    soap
+  end
+
   it "contains the content type for each supported SOAP version" do
     content_type = Savon::SOAP::Request::ContentType
     content_type[1].should == "text/xml;charset=UTF-8"
@@ -15,18 +27,18 @@ describe Savon::SOAP::Request do
   describe ".execute" do
     it "executes a SOAP request and returns the response" do
       HTTPI.expects(:post).returns(HTTPI::Response.new 200, {}, Fixture.response(:authentication))
-      response = Savon::SOAP::Request.execute config, http_request, soap
+      response = Savon::SOAP::Request.execute config, http_request, soap_xml
       response.should be_a(Savon::SOAP::Response)
     end
   end
 
   describe ".new" do
     it "uses the SOAP endpoint for the request" do
-      soap_request.http.url.should == URI(soap.endpoint)
+      soap_request.http.url.should == URI(soap_xml.endpoint)
     end
 
     it "sets the SOAP body for the request" do
-      soap_request.http.body.should == soap.to_xml
+      soap_request.http.body.should == soap_xml.to_xml
     end
 
     it "sets the Content-Type header for SOAP 1.1" do
@@ -34,21 +46,21 @@ describe Savon::SOAP::Request do
     end
 
     it "sets the Content-Type header for SOAP 1.2" do
-      soap.version = 2
+      soap_xml.version = 2
       soap_request.http.headers["Content-Type"].should == Savon::SOAP::Request::ContentType[2]
     end
 
     it "sets the Content-Length header" do
-      soap_request.http.headers["Content-Length"].should == soap.to_xml.length.to_s
+      soap_request.http.headers["Content-Length"].should == soap_xml.to_xml.length.to_s
     end
 
     it "sets the Content-Length header for every request" do
       http = HTTPI::Request.new
-      soap_request = Savon::SOAP::Request.new(config, http, soap)
+      soap_request = Savon::SOAP::Request.new(config, http, soap_xml)
       http.headers.should include("Content-Length" => "272")
 
-      soap = Savon::SOAP::XML.new config, Endpoint.soap, [nil, :create_user, {}], :id => 123
-      soap_request = Savon::SOAP::Request.new(config, http, soap)
+      soap_xml = soap_xml!(Endpoint.soap, [nil, :create_user, {}], :id => 123)
+      soap_request = Savon::SOAP::Request.new(config, http, soap_xml)
       http.headers.should include("Content-Length" => "280")
     end
   end

data/spec/savon/soap/xml_spec.rb

@@ -1,19 +1,19 @@
 require "spec_helper"
 
 describe Savon::SOAP::XML do
-  let(:xml) { Savon::SOAP::XML.new(config, Endpoint.soap, [nil, :authenticate, {}], :id => 1) }
-  let(:config) { Savon::Config.default }
-
-  describe ".new" do
-    it "should accept an endpoint, an input tag and a SOAP body" do
-      xml = Savon::SOAP::XML.new(config, Endpoint.soap, [nil, :authentication, {}], :id => 1)
 
-      xml.endpoint.should == Endpoint.soap
-      xml.input.should == [nil, :authentication, {}]
-      xml.body.should == { :id => 1 }
+  def xml(endpoint = nil, input = nil, body = nil)
+    @xml ||= begin
+      xml = Savon::SOAP::XML.new(config)
+      xml.endpoint = endpoint || Endpoint.soap
+      xml.input    = input    || [nil, :authenticate, {}]
+      xml.body     = body     || { :id => 1 }
+      xml
     end
   end
 
+  let(:config) { Savon::Config.default }
+
   describe "#input" do
     it "should set the input tag" do
       xml.input = :test
@@ -260,19 +260,22 @@ describe Savon::SOAP::XML do
     end
 
     context "with :element_form_default set to :qualified and a :namespace" do
-      let :xml do
-        Savon::SOAP::XML.new(config, Endpoint.soap, [nil, :authenticate, {}], :user => { :id => 1, ":noNamespace" => true })
+      it "should namespace the default elements" do
+        xml = xml(Endpoint.soap, [nil, :authenticate, {}], :user => { :id => 1, ":noNamespace" => true })
+        xml.element_form_default = :qualified
+        xml.namespace_identifier = :wsdl
+
+        xml.to_xml.should include("<wsdl:user>", "<wsdl:id>1</wsdl:id>", "<noNamespace>true</noNamespace>")
       end
+    end
 
+    context "with :element_form_default set to :unqualified and a :namespace" do
       it "should namespace the default elements" do
-        xml.element_form_default = :qualified
+        xml = xml(Endpoint.soap, [nil, :authenticate, {}], :user => { :id => 1, ":noNamespace" => true })
+        xml.element_form_default = :unqualified
         xml.namespace_identifier = :wsdl
 
-        xml.to_xml.should include(
-          "<wsdl:user>",
-          "<wsdl:id>1</wsdl:id>",
-          "<noNamespace>true</noNamespace>"
-        )
+        xml.to_xml.should include("<user>", "<id>1</id>", "<noNamespace>true</noNamespace>")
       end
     end
 
@@ -323,5 +326,32 @@ describe Savon::SOAP::XML do
     end
   end
 
+  describe "#add_namespaces_to_body" do
+    before :each do
+      xml.used_namespaces.merge!({
+        ["authenticate", "id"] =>"ns0",
+        ["authenticate", "name"] =>"ns1",
+        ["authenticate", "name", "firstName"] =>"ns2"
+      })
+    end
+
+    it "adds namespaces" do
+      body = {:id => 1, :name => {:first_name => 'Bob'}}
+      xml.send(:add_namespaces_to_body, body).should == {"ns0:id" => "1", "ns1:name" => {"ns2:firstName" => "Bob"}}
+    end
+
+    it "adds namespaces to order! list" do
+      body = {:id => 1, :name => {:first_name => 'Bob', :order! => [:first_name]}, :order! => [:id, :name]}
+      xml.send(:add_namespaces_to_body, body).should == {
+        "ns0:id" => "1",
+        "ns1:name" => {
+          "ns2:firstName" => "Bob",
+          :order! => ["ns2:firstName"]
+        },
+        :order! => ["ns0:id", "ns1:name"]
+      }
+    end
+  end
+
 end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: savon
 version: !ruby/object:Gem::Version 
-  hash: 47
+  hash: 45
   prerelease: 
   segments: 
   - 0
   - 9
-  - 10
-  version: 0.9.10
+  - 11
+  version: 0.9.11
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -69,11 +69,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 1
+        hash: 7
         segments: 
         - 2
-        - 1
-        version: "2.1"
+        - 2
+        version: "2.2"
   name: wasabi
   type: :runtime
   prerelease: false
@@ -84,11 +84,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
+        hash: 13
         segments: 
         - 1
-        - 0
-        version: "1.0"
+        - 1
+        version: "1.1"
   name: akami
   type: :runtime
   prerelease: false