savon 0.7.5 → 0.7.6

data/lib/savon/wsdl_stream.rb

@@ -1,8 +1,8 @@
 module Savon
 
-  # Savon::WSDLStream
+  # = Savon::WSDLStream
   #
-  # Stream listener for parsing the WSDL document.
+  # Savon::WSDLStream serves as a stream listener for parsing the WSDL document.
   class WSDLStream
 
     # The main sections of a WSDL document.

data/lib/savon/wsse.rb

@@ -1,8 +1,39 @@
 module Savon
 
-  # Savon::WSSE
+  # = Savon::WSSE
   #
-  # Represents parameters for WSSE authentication.
+  # Savon::WSSE represents WSSE authentication. Pass a block to your SOAP call and the WSSE object
+  # is passed to it as the second argument. The object allows setting the WSSE username, password
+  # and whether to use digest authentication.
+  #
+  # == Credentials
+  #
+  # By default, Savon does not use WSSE authentication. Simply specify a username and password to
+  # change this.
+  #
+  #   response = client.get_all_users do |soap, wsse|
+  #     wsse.username = "eve"
+  #     wsse.password = "secret"
+  #   end
+  #
+  # == Digest
+  #
+  # To use WSSE digest authentication, just use the digest method and set it to +true+.
+  #
+  #   response = client.get_all_users do |soap, wsse|
+  #     wsse.username = "eve"
+  #     wsse.password = "secret"
+  #     wsse.digest = true
+  #   end
+  #
+  # == Default to WSSE
+  #
+  # In case all you're services require WSSE authentication, you can set your credentials and whether
+  # to use WSSE digest for every request:
+  #
+  #   Savon::WSSE.username = "eve"
+  #   Savon::WSSE.password = "secret"
+  #   Savon::WSSE.digest = true
   class WSSE
 
     # Base address for WSSE docs.
@@ -82,13 +113,13 @@ module Savon
     # Sets whether to use WSSE digest per request.
     attr_writer :digest
 
-    # Returns whether to use WSSE digest. Defaults to the global setting. 
+    # Returns whether to use WSSE digest. Defaults to the global setting.
     def digest?
       @digest || self.class.digest?
     end
 
-    # Returns the XML for a WSSE header or an empty String unless both
-    # username and password were specified.
+    # Returns the XML for a WSSE header or an empty String unless both username and password
+    # were specified.
     def header
       return "" unless username && password
 

data/spec/savon/client_spec.rb

@@ -70,8 +70,12 @@ describe Savon::Client do
     end
   end
 
+  it "should have a call method that forwards to method_missing for SOAP actions named after existing methods" do
+    @client.call(:authenticate) { |soap| soap.should be_a(Savon::SOAP) }
+  end
+
   it "should raise a NoMethodError when the method does not match an available SOAP action or method" do
     lambda { @client.some_undefined_method }.should raise_error(NoMethodError)
   end
 
-end
+end

data/spec/savon/core_ext/hash_spec.rb

@@ -73,7 +73,6 @@ describe Hash do
 
     it "should call to_s on Strings even if they respond to to_datetime" do
       object = "gorilla"
-      object.expects(:to_s).returns object
       object.expects(:to_datetime).never
 
       hash, result = { :name => object }, "<name>gorilla</name>"
@@ -113,6 +112,16 @@ describe Hash do
       soap_xml = hash.to_soap_xml
       soap_xml.should include('id="666"', 'city="Hamburg"')
     end
+
+    it "should add attributes to duplicate Hash keys specified through :attributes!" do
+      hash = { :find_user => { :person => ["Lucy", "Anna"], :attributes! => { :person => { :id => [1, 3] } } } }
+      result = '<findUser><person id="1">Lucy</person><person id="3">Anna</person></findUser>'
+      hash.to_soap_xml.should == result
+      
+      hash = { :find_user => { :person => ["Lucy", "Anna"], :attributes! => { :person => { :active => "true" } } } }
+      result = '<findUser><person active="true">Lucy</person><person active="true">Anna</person></findUser>'
+      hash.to_soap_xml.should == result
+    end
   end
 
   describe "map_soap_response" do

data/spec/savon/core_ext/string_spec.rb

@@ -75,8 +75,12 @@ describe String do
   end
 
   describe "to_soap_value" do
-    it "calls to_s, bypassing Rails to_datetime extension for Strings" do
-      "string".to_soap_value.should == "string".to_s
+    it "should return the string value and escape special characters" do
+      "string".to_soap_value.should == "string"
+      "<tag>".to_soap_value.should == "&lt;tag&gt;"
+      "at&t".to_soap_value.should == "at&amp;t"
+      '"quotes"'.to_soap_value.should == "&quot;quotes&quot;"
+      "'apos'".to_soap_value.should == "&apos;apos&apos;"
     end
   end
 

data/spec/savon/core_ext/uri_spec.rb

@@ -10,6 +10,10 @@ describe URI::HTTP do
     it "returns false for non-https URI's" do
       URI("http://example.com").ssl?.should be_false
     end
+
+    it "returns nil for invalid URI's without a scheme" do
+      URI("example").ssl?.should be_nil
+    end
   end
 
 end

data/spec/savon/request_spec.rb

@@ -22,8 +22,8 @@ describe Savon::Request do
   end
 
   it "has both getter and setter for the logger to use (global setting)" do
-    Savon::Request.logger = nil
-    Savon::Request.logger.should be_nil
+    Savon::Request.logger = {}
+    Savon::Request.logger.should be_a(Hash)
     Savon::Request.logger = Logger.new STDOUT
   end
 
@@ -76,8 +76,9 @@ describe Savon::Request do
   end
 
   it "executes a SOAP request and returns the Net::HTTP response" do
-    some_operation = WSDLFixture.authentication(:operations)[:authenticate]
-    soap = Savon::SOAP.new some_operation, EndpointHelper.soap_endpoint
+    operation = WSDLFixture.authentication(:operations)[:authenticate]
+    action, input = operation[:action], operation[:input]
+    soap = Savon::SOAP.new action, input, EndpointHelper.soap_endpoint
     soap_response = @request.soap soap
 
     soap_response.should be_a(Net::HTTPResponse)

data/spec/savon/soap_spec.rb

@@ -2,30 +2,31 @@ require "spec_helper"
 
 describe Savon::SOAP do
   before do
-    @authenticate_operation = WSDLFixture.authentication(:operations)[:authenticate]
-    @soap = Savon::SOAP.new @authenticate_operation, EndpointHelper.soap_endpoint
+    @operation = WSDLFixture.authentication(:operations)[:authenticate]
+    @action, @input = @operation[:action], @operation[:input]
+    @soap = Savon::SOAP.new @action, @input, EndpointHelper.soap_endpoint
   end
 
-  it "contains the SOAP namespace for each supported SOAP version" do
+  it "should contain the SOAP namespace for each supported SOAP version" do
     Savon::SOAP::Versions.each do |soap_version|
       Savon::SOAP::Namespace[soap_version].should be_a(String)
       Savon::SOAP::Namespace[soap_version].should_not be_empty
     end
   end
 
-  it "contains the Content-Types for each supported SOAP version" do
+  it "should contain the Content-Types for each supported SOAP version" do
     Savon::SOAP::Versions.each do |soap_version|
       Savon::SOAP::ContentType[soap_version].should be_a(String)
       Savon::SOAP::ContentType[soap_version].should_not be_empty
     end
   end
 
-  it "contains an Array of supported SOAP versions" do
+  it "should contain an Array of supported SOAP versions" do
     Savon::SOAP::Versions.should be_an(Array)
     Savon::SOAP::Versions.should_not be_empty
   end
 
-  it "contains the xs:dateTime format" do
+  it "should contain the xs:dateTime format" do
     Savon::SOAP::DateTimeFormat.should be_a(String)
     Savon::SOAP::DateTimeFormat.should_not be_empty
 
@@ -33,175 +34,168 @@ describe Savon::SOAP do
       should == "2012-03-22T16:22:33Z"
   end
 
-  it "contains a Regexp matching the xs:dateTime format" do
+  it "should contain a Regexp matching the xs:dateTime format" do
     Savon::SOAP::DateTimeRegexp.should be_a(Regexp)
     (Savon::SOAP::DateTimeRegexp === "2012-03-22T16:22:33").should be_true
   end
 
-  it "defaults to SOAP 1.1" do
+  it "should default to SOAP 1.1" do
     Savon::SOAP.version.should == 1
   end
 
-  it "has both getter and setter for the SOAP version to use (global setting)" do
-    [2, 1].each do |soap_version|
-      Savon::SOAP.version = soap_version
-      Savon::SOAP.version.should == soap_version
+  describe "xml returned via to_xml" do
+    before do
+      @xml_declaration = '<?xml version="1.0" encoding="UTF-8"?>'
+      @namespace = { "xmlns:ns" => "http://example.com" }
+      @namespace_string = 'xmlns:ns="http://example.com"'
+      @namespaces = { "xmlns:ns" => "http://ns.example.com", "xmlns:ns2" => "http://ns2.example.com" }
+      
+      # reset to defaults
+      Savon::SOAP.version = 1
+      Savon::SOAP.header = {}
+      Savon::SOAP.namespaces = {}
     end
-  end
-
-  it "has a setter for the Savon::WSSE" do
-    @soap.wsse = Savon::WSSE.new
-  end
-
-  it "has both getter and setter for the SOAP action" do
-    @soap.action.should == @authenticate_operation[:action]
-
-    @soap.action = "someAction"
-    @soap.action.should == "someAction"
-  end
-
-  it "has both getter and setter for the SOAP input" do
-    @soap.input.should == @authenticate_operation[:input]
-
-    @soap.input = "whatever"
-    @soap.input.should == "whatever"
-
-    args = "FindUserRequest", { "username" => "auser", "anotherAttr" => "someVal" }
-    @soap.input = *args
-    @soap.input.should == [*args]
-  end
-
-  it "has both getter and setter for global SOAP headers" do
-    header = { "some" => "header" }
-    Savon::SOAP.header = header
-    Savon::SOAP.header.should == header
 
-    Savon::SOAP.header = {}
-  end
-
-  it "has both getter and setter for the SOAP header" do
-    @soap.header.should be_a(Hash)
-    @soap.header.should be_empty
-
-    @soap.header = { "specialAuthKey" => "secret" }
-    @soap.header.should == { "specialAuthKey" => "secret" }
-  end
+    it "should contain an xml declaration" do
+      @soap.to_xml.should include(@xml_declaration)
+    end
 
-  it "has a getter for the SOAP body, expecting a Hash or an XML String" do
-    @soap.body = { :id => 666 }
-    @soap.body = "<id>666</id>"
-  end
+    # namespaces
 
-  it "has a setter for specifying a Hash of namespaces" do
-    namespaces = { "xmlns:env" => "http://example.com" }
-    @soap.namespaces = namespaces
-    @soap.namespaces.should == namespaces
-  end
+    it "should contain the namespace for SOAP 1.1" do
+      @soap.to_xml.should include('xmlns:env="' + Savon::SOAP::Namespace[1] + '"')
+    end
 
-  describe "has a getter for namespaces" do
-    it "which defaults to include the SOAP 1.1 namespace" do
-      @soap.namespaces.should == { "xmlns:env" => Savon::SOAP::Namespace[1] }
+    it "should contain the namespace for SOAP 1.2 when defined globally" do
+      Savon::SOAP.version = 2
+      @soap.to_xml.should include('xmlns:env="' + Savon::SOAP::Namespace[2] + '"')
     end
 
-    it "which contains the SOAP 1.2 namespace if specified" do
+    it "should contain the namespace for SOAP 1.2 when defined per request" do
       @soap.version = 2
-      @soap.namespaces.should == { "xmlns:env" => Savon::SOAP::Namespace[2] }
+      @soap.to_xml.should include('xmlns:env="' + Savon::SOAP::Namespace[2] + '"')
     end
-  end
 
-  it "has both getter and setter for global namespaces" do
-    namespaces = { "some" => "namespace" }
-    Savon::SOAP.namespaces = namespaces
-    Savon::SOAP.namespaces.should == namespaces
+    it "should containg a xmlns:wsdl namespace defined via the :namespace shortcut method" do
+      @soap.namespace = "http://wsdl.example.com"
+      @soap.to_xml.should include('xmlns:wsdl="http://wsdl.example.com"')
+    end
 
-    Savon::SOAP.namespaces = {}
-  end
+    it "should accept custom namespaces when defined globally" do
+      Savon::SOAP.namespaces = @namespace
+      @soap.to_xml.should include("<env:Envelope " + @namespace_string)
+    end
 
-  it "has a convenience method for setting the 'xmlns:wsdl' namespace" do
-    @soap.namespaces.should == { "xmlns:env" => "http://schemas.xmlsoap.org/soap/envelope/" }
+    it "should accept custom namespaces when defined per request" do
+      @soap.namespaces = @namespace
+      @soap.to_xml.should include("<env:Envelope " + @namespace_string)
+    end
 
-    @soap.namespace = "http://example.com"
-    @soap.namespaces.should include("xmlns:env" => "http://schemas.xmlsoap.org/soap/envelope/")
-    @soap.namespaces.should include("xmlns:wsdl" => "http://example.com")
-  end
+    it "should merge global and per request namespaces" do
+      Savon::SOAP.namespaces = @namespaces
+      @soap.namespaces = @namespace
+      @soap.to_xml.should include(
+        'xmlns:ns="http://example.com"',
+        'xmlns:ns2="http://ns2.example.com"'
+      )
+    end
 
-  it "has both getter and setter for the SOAP endpoint" do
-    soap_endpoint = URI EndpointHelper.soap_endpoint
+    # header
 
-    @soap.endpoint = soap_endpoint
-    @soap.endpoint.should == soap_endpoint
-  end
+    it "should not contain a header tag unless specified" do
+      @soap.to_xml.should_not include("<env:Header>")
+    end
 
-  it "has a getter for the SOAP version to use which defaults to SOAP 1.1" do
-    @soap.version.should == Savon::SOAP.version
-  end
+    it "should accept a custom (String) header defined globally" do
+      Savon::SOAP.header = "<key>value</key>"
+      @soap.to_xml.should include("<env:Header><key>value</key></env:Header>")
+    end
 
-  it "has a setter for specifying the SOAP version to use" do
-    @soap.version = 2
-    @soap.version.should == 2
-  end
+    it "should accept a custom (Hash) header defined globally" do
+      Savon::SOAP.header[:key] = "value"
+      @soap.to_xml.should include("<env:Header><key>value</key></env:Header>")
+    end
 
-  describe "to_xml" do
-    after { Savon::SOAP.version = 1 }
+    it "should accept a custom (String) header defined per request" do
+      @soap.header = "<key>value</key>"
+      @soap.to_xml.should include("<env:Header><key>value</key></env:Header>")
+    end
 
-    it "returns the XML for a SOAP request" do
-      @soap.namespaces["xmlns:wsdl"] = "http://v1_0.ws.auth.order.example.com/"
-      @soap.body = { :id => 666 }
+    it "should accept a custom (Hash) header defined per request" do
+      @soap.header[:key] = "value"
+      @soap.to_xml.should include("<env:Header><key>value</key></env:Header>")
+    end
 
-      xml = @soap.to_xml
-      xml.should include('xmlns:wsdl="http://v1_0.ws.auth.order.example.com/"')
-      xml.should include('xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"')
-      xml.should include('<wsdl:authenticate><id>666</id></wsdl:authenticate>')
+    it "should merge global and per request headers defined as Strings" do
+      Savon::SOAP.header = "<key2>other value</key2>"
+      @soap.header = "<key>value</key>"
+      @soap.to_xml.should include(
+        "<env:Header><key2>other value</key2><key>value</key></env:Header>"
+      )
     end
 
-    it "does not include an empty header tag" do
-      @soap.to_xml.should_not include('env:Header')
+    it "should merge global and per request headers defined as Hashes" do
+      Savon::SOAP.header = { :key => "value", :key2 => "global value" }
+      @soap.header[:key2] = "request value"
+      @soap.to_xml.should include(
+        "<env:Header><key>value</key><key2>request value</key2></env:Header>"
+      )
     end
-    
-    it "returns the appropriate XML for a SOAP Body's root node when parameters are present" do
-      @soap.input = "authenticate", { "protocol" => "tls", "version" => "1.2" }
-      @soap.body = { :id => 666 }
 
-      @soap.to_xml.should include('<wsdl:authenticate protocol="tls" version="1.2"><id>666</id></wsdl:authenticate>')
+    it "should use the :header method from a given WSSE object to include a WSSE header" do
+      wsse = "some compliant object"
+      wsse.stubs(:header).returns("<wsse>authentication</wsse>")
+      
+      @soap.wsse = wsse
+      @soap.to_xml.should include("<env:Header><wsse>authentication</wsse></env:Header>")
     end
 
-    it "caches the XML, returning the same Object every time" do
-      @soap.to_xml.object_id.should == @soap.to_xml.object_id
+    # input tag
+
+    it "should contain a :wsdl namespaced input tag matching the :input property on instantiation" do
+      @soap = Savon::SOAP.new "someAction", "someInput", EndpointHelper.soap_endpoint
+      @soap.to_xml.should include('<wsdl:someInput>')
     end
 
-    it "uses the SOAP namespace for the specified SOAP version" do
-      @soap.version = 2
-      @soap.to_xml.should include(Savon::SOAP::Namespace[2])
+    it "should fall back to using the :action property whem :input is blank" do
+      @soap = Savon::SOAP.new "someAction", "", EndpointHelper.soap_endpoint
+      @soap.to_xml.should include('<wsdl:someAction>')
     end
 
-    it "uses the SOAP namespace for the default SOAP version otherwise" do
-      Savon::SOAP.version = 2
-      @soap.to_xml.should include(Savon::SOAP::Namespace[2])
+    it "should containg namespaces defined via an input tag Array containing the tag name and a Hash of namespaces" do
+      input = ["someInput", { "otherNs" => "http://otherns.example.com" }]
+      @soap = Savon::SOAP.new "someAction", input, EndpointHelper.soap_endpoint
+      @soap.to_xml.should include('<wsdl:someInput otherNs="http://otherns.example.com">')
     end
 
-    it "merges global and per request headers defined as Hashes" do
-      Savon::SOAP.header = { "API-KEY" => "secret", "SOME-KEY" => "something" }
-      @soap.header["SOME-KEY"] = "somethingelse"
+    # xml body
 
-      @soap.to_xml.should include("<API-KEY>secret</API-KEY>")
-      @soap.to_xml.should include("<SOME-KEY>somethingelse</SOME-KEY>")
+    it "should contain the SOAP body defined as a Hash" do
+      @soap.body = { :someTag => "some value" }
+      @soap.to_xml.should include("<someTag>some value</someTag>")
     end
 
-    it "joins global and per request headers defined as Strings" do
-      Savon::SOAP.header = "<API-KEY>secret</API-KEY>"
-      @soap.header = "<SOME-KEY>somethingelse</SOME-KEY>"
+    it "should contain the SOAP body defined as an Object responding to :to_s" do
+      @soap.body = "<someTag>some value</someTag>"
+      @soap.to_xml.should include(@soap.body)
+    end
 
-      @soap.to_xml.should include("<API-KEY>secret</API-KEY>")
-      @soap.to_xml.should include("<SOME-KEY>somethingelse</SOME-KEY>")
+    # xml
+
+    it "should be a completely custom XML when specified" do
+      @soap.xml = "custom SOAP body"
+      @soap.to_xml.should == @soap.xml
     end
 
-    it "merges the global and per request namespaces" do
-      Savon::SOAP.namespaces = { "xmlns:wsdl" => "namespace", "xmlns:v1" => "v1namespace" }
-      @soap.namespaces["xmlns:v1"] = "newV1namespace"
+    # safety check
 
-      @soap.to_xml.should include('xmlns:wsdl="namespace"')
-      @soap.to_xml.should include('xmlns:v1="newV1namespace"')
+    it "should be a valid SOAP request" do
+      @soap.to_xml.should include(
+        @xml_declaration +
+        '<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">' <<
+          '<env:Body><wsdl:authenticate></wsdl:authenticate></env:Body>' <<
+        '</env:Envelope>'
+      ) 
     end
   end
-
-end
+end