savon 0.6.8 → 0.7.0

data/lib/savon/soap.rb

@@ -76,6 +76,11 @@ module Savon
       @namespaces ||= { "xmlns:env" => SOAPNamespace[version] }
     end
 
+    # Convenience method for setting the "xmlns:wsdl" namespace.
+    def namespace=(namespace)
+      namespaces["xmlns:wsdl"] = namespace
+    end
+
     # Sets the SOAP version.
     def version=(version)
       @version = version if Savon::SOAPVersions.include? version

data/lib/savon/wsdl.rb

@@ -10,6 +10,14 @@ module Savon
       @request = request
     end
 
+    # Sets whether to use the WSDL.
+    attr_writer :enabled
+
+    # Returns whether to use the WSDL. Defaults to +true+.
+    def enabled?
+      @enabled.nil? ? true : @enabled
+    end
+
     # Returns the namespace URI of the WSDL.
     def namespace_uri
       @namespace_uri ||= stream.namespace_uri

data/spec/basic_spec_helper.rb

@@ -0,0 +1,12 @@
+require "rubygems"
+require "rake"
+require "spec"
+require "mocha"
+require "fakeweb"
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+require "savon"
+Savon::Request.log = false

data/spec/fixtures/response/response_fixture.rb

@@ -23,10 +23,14 @@ class ResponseFixture
     @@soap_fault12 ||= load_fixture :soap_fault12
   end
 
+  def self.multi_ref
+    @@multi_ref ||= load_fixture :multi_ref
+  end
+
 private
 
   def self.load_fixture(fixture)
-    File.read(File.dirname(__FILE__) + "/xml/#{fixture}.xml")
+    File.read File.dirname(__FILE__) + "/xml/#{fixture}.xml"
   end
 
 end

data/spec/fixtures/response/xml/multi_ref.xml

@@ -0,0 +1,39 @@
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+   <soapenv:Body>
+      <ns1:listResponse soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:ns1="http://ws.example.com">
+         <listReturn soapenc:arrayType="ns2:HistoryEntry[3]" xsi:type="soapenc:Array" xmlns:ns2="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+            <listReturn href="#id0"/>
+            <listReturn href="#id1"/>
+            <listReturn href="#id2"/>
+         </listReturn>
+      </ns1:listResponse>
+      <multiRef id="id1" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns5:HistoryEntry" xmlns:ns5="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+         <date xsi:type="xsd:dateTime">2009-09-22T13:47:23.000Z</date>
+         <location xsi:type="soapenc:string">Archive</location>
+         <mailId href="#id9"/>
+         <referenceId href="#id8"/>
+         <state xsi:type="soapenc:string">Original</state>
+         <subject xsi:type="soapenc:string">Mail from 09-22-2009: Misc</subject>
+      </multiRef>
+      <multiRef id="id0" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns6:HistoryEntry" xmlns:ns6="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+         <date xsi:type="xsd:dateTime">2009-04-30T06:38:34.000Z</date>
+         <location xsi:type="soapenc:string">Archive</location>
+         <mailId href="#id10"/>
+         <referenceId href="#id8"/>
+         <state xsi:type="soapenc:string">Original</state>
+         <subject xsi:type="soapenc:string">Mail from 04-29-2009: Technical support</subject>
+      </multiRef>
+      <multiRef id="id2" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns7:HistoryEntry" xmlns:ns7="http://ws.example.com/ws/history" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
+         <date xsi:type="xsd:dateTime">2009-12-18T15:43:21.000Z</date>
+         <location xsi:type="soapenc:string">Archive</location>
+         <mailId href="#id11"/>
+         <referenceId href="#id8"/>
+         <state xsi:type="soapenc:string">Original</state>
+         <subject xsi:type="soapenc:string">Mail from 12-17-2009: Misc</subject>
+      </multiRef>
+      <multiRef id="id11" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">972219</multiRef>
+      <multiRef id="id10" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">708021</multiRef>
+      <multiRef id="id8" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">0</multiRef>
+      <multiRef id="id9" soapenc:root="0" soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="soapenc:int" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">855763</multiRef>
+   </soapenv:Body>
+</soapenv:Envelope>

data/spec/fixtures/response/xml/soap_fault12.xml

@@ -1,18 +1,18 @@
 <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:m="http://www.example.org/timeouts">
-   <soap:Body>
-     <soap:Fault>
-       <Code>
-         <Value>soap:Sender</Value>
-         <Subcode>
-           <Value>m:MessageTimeout</Value>
-         </Subcode>
-       </Code>
-       <Reason>
-         <Text xml:lang="en">Sender Timeout</Text>
-       </Reason>
-       <Detail>
-         <m:MaxTime>P5M</m:MaxTime>
-       </Detail>
-     </soap:Fault>
-   </soap:Body>
-</soap:Envelope>
+  <soap:Body>
+    <soap:Fault>
+      <Code>
+        <Value>soap:Sender</Value>
+        <Subcode>
+          <Value>m:MessageTimeout</Value>
+        </Subcode>
+      </Code>
+      <Reason>
+        <Text xml:lang="en">Sender Timeout</Text>
+      </Reason>
+      <Detail>
+        <m:MaxTime>P5M</m:MaxTime>
+      </Detail>
+    </soap:Fault>
+  </soap:Body>
+</soap:Envelope>

data/spec/fixtures/wsdl/wsdl_fixture.rb

@@ -20,7 +20,7 @@ private
   def self.expectations
     return @@expectations if @@expectations
 
-    file = File.read(File.dirname(__FILE__) + "/wsdl_fixture.yml")
+    file = File.read File.dirname(__FILE__) + "/wsdl_fixture.yml"
     @@expectations = YAML.load ERB.new(file).result
   end
 
@@ -30,7 +30,7 @@ private
   def self.wsdl(wsdl)
     return @@wsdl[wsdl] if @@wsdl[wsdl]
 
-    file = File.read(File.dirname(__FILE__) + "/xml/#{wsdl}.xml")
+    file = File.read File.dirname(__FILE__) + "/xml/#{wsdl}.xml"
     @@wsdl[wsdl] = file
   end
 

data/spec/integration/http_basic_auth_spec.rb

@@ -0,0 +1,12 @@
+require "basic_spec_helper"
+
+describe Savon do
+  before { @endpoint = "http://localhost:8080/http-basic-auth" }
+
+  it "should be able to handle HTTP basic authentication" do
+    client = Savon::Client.new @endpoint
+    client.request.basic_auth "user", "password"
+    response = client.do_something!
+    response.to_hash[:authenticate_response][:return][:success].should == true
+  end
+end

data/spec/integration/server.rb

@@ -0,0 +1,51 @@
+require "webrick"
+
+include WEBrick
+
+# Run WEBrick. Yields the server to a given block.
+def run_webrick(config = {})
+  config.update :Port => 8080
+  server = HTTPServer.new config
+  yield server if block_given?
+  ["INT", "TERM"].each { |signal| trap(signal) { server.shutdown } }
+  server.start
+end
+
+# Returns the SOAP response fixture for a given +file+.
+def respond_with(file)
+  response_path = File.dirname(__FILE__) + "/../fixtures/response/xml"
+  File.read "#{response_path}/#{file}.xml"
+end
+
+# Returns HTML links for a given Hash of link URI's and names.
+def link_to(links)
+  links.map { |link| "<a href='#{link[:uri]}'>#{link[:name]}</a>" }.join("<br>")
+end
+
+run_webrick do |server|
+  user, password, realm = "user", "password", "realm"
+
+  htdigest = HTTPAuth::Htdigest.new "/tmp/webrick-htdigest"
+  htdigest.set_passwd realm, user, password
+  authenticator = HTTPAuth::DigestAuth.new :UserDB => htdigest, :Realm => realm
+
+  # Homepage including links to subpages.
+  server.mount_proc("/") do |request, response|
+    response.body = link_to [
+      { :uri => "http-basic-auth", :name => "HTTP basic auth" },
+      { :uri => "http-digest-auth", :name => "HTTP digest auth" }
+    ]
+  end
+
+  # HTTP basic authentication.
+  server.mount_proc("/http-basic-auth") do |request, response|
+    HTTPAuth.basic_auth(request, response, realm) { |u, p| u == user && p == password }
+    response.body = respond_with :authentication
+  end
+
+  # HTTP digest authentication.
+  server.mount_proc("/http-digest-auth") do |request, response|
+    authenticator.authenticate request, response
+    response.body = "HTTP digest authentication successfull"
+  end
+end

data/spec/savon/client_spec.rb

@@ -3,32 +3,26 @@ require "spec_helper"
 describe Savon::Client do
   before { @client = Savon::Client.new EndpointHelper.wsdl_endpoint }
 
-  it "is initialized with a SOAP endpoint String" do
-    Savon::Client.new EndpointHelper.wsdl_endpoint
+  it "should be initialized with an endpoint String" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint
+    client.request.http.proxy?.should be_false
   end
 
-  it "accepts a proxy URI passed in via options" do
-    Savon::Client.new EndpointHelper.wsdl_endpoint, :proxy => 'http://proxy'
+  it "should accept a proxy URI via an optional Hash of options" do
+    client = Savon::Client.new EndpointHelper.wsdl_endpoint, :proxy => "http://proxy"
+    client.request.http.proxy?.should be_true
+    client.request.http.proxy_address == "http://proxy"
   end
 
-  it "accepts settings for SSL client authentication via options" do
-    Savon::Client.new EndpointHelper.wsdl_endpoint, :ssl => {
-      :client_cert => "client cert",
-      :client_key => "client key",
-      :ca_file => "ca file",
-      :verify => OpenSSL::SSL::VERIFY_PEER
-    }
+  it "should have a method that returns the Savon::WSDL" do
+    @client.wsdl.should be_a(Savon::WSDL)
   end
 
-  it "has a getter for accessing the Savon::WSDL" do
-    @client.wsdl.should be_a Savon::WSDL
+  it "should have a method that returns the Savon::Request" do
+    @client.request.should be_a(Savon::Request)
   end
 
-  it "has a getter for accessing the Savon::Request" do
-    @client.request.should be_a Savon::Request
-  end
-
-  it "responds to SOAP actions while still behaving as usual otherwise" do
+  it "should respond to available SOAP actions while behaving as expected otherwise" do
     WSDLFixture.authentication(:operations).keys.each do |soap_action|
       @client.respond_to?(soap_action).should be_true
     end
@@ -37,61 +31,47 @@ describe Savon::Client do
     @client.respond_to?(:some_undefined_method).should be_false
   end
 
-  it "dispatches SOAP calls via method_missing and returns the Savon::Response" do
-    @client.authenticate.should be_a Savon::Response
+  it "should dispatch available SOAP calls via method_missing and return the Savon::Response" do
+    @client.authenticate.should be_a(Savon::Response)
   end
 
-  describe "disabling retrieving and parsing the WSDL document" do
-    it "can be done globally for every instance of Savon::Client" do
-      @client.wsdl?.should be_true
-      Savon::Client.wsdl = false
-
-      expect_the_wsdl_to_be_disabled
-      @client.authenticate.should be_a Savon::Response
-
-      Savon::Client.wsdl = true
-    end
-
-    it "can be done per request" do
-      @client.wsdl = false
-
-      expect_the_wsdl_to_be_disabled
-      @client.authenticate.should be_a Savon::Response
+  it "should disable the Savon::WSDL when passed a method with an exclamation mark" do
+    @client.wsdl.enabled?.should be_true
+    [:respond_to?, :operations, :namespace_uri, :soap_endpoint].each do |method|
+      Savon::WSDL.any_instance.expects(method).never
     end
 
-    def expect_the_wsdl_to_be_disabled
-      @client.wsdl?.should be_false
-      [:respond_to?, :operations, :namespace_uri, :soap_endpoint].each do |method|
-        Savon::WSDL.any_instance.expects(method).never
-      end
+    response = @client.authenticate! do |soap|
+      soap.input.should == "authenticate"
+      soap.input.should == "authenticate"
     end
+    response.should be_a(Savon::Response)
+    @client.wsdl.enabled?.should be_false
   end
 
-  it "raises a Savon::SOAPFault in case of a SOAP fault" do
+  it "should raise a Savon::SOAPFault in case of a SOAP fault" do
     client = Savon::Client.new EndpointHelper.wsdl_endpoint(:soap_fault)
-    client.wsdl = false
-    lambda { client.authenticate }.should raise_error Savon::SOAPFault
+    lambda { client.authenticate! }.should raise_error(Savon::SOAPFault)
   end
 
-  it "raises a Savon::HTTPError in case of an HTTP error" do
+  it "should raise a Savon::HTTPError in case of an HTTP error" do
     client = Savon::Client.new EndpointHelper.wsdl_endpoint(:http_error)
-    client.wsdl = false
-    lambda { client.authenticate }.should raise_error Savon::HTTPError
+    lambda { client.authenticate! }.should raise_error(Savon::HTTPError)
   end
 
-  it "yields the SOAP object to a block when it expects one argument" do
-    @client.authenticate { |soap| soap.should be_a Savon::SOAP }
+  it "should yield an instance of Savon::SOAP to a given block expecting one argument" do
+    @client.authenticate { |soap| soap.should be_a(Savon::SOAP) }
   end
 
-  it "yields the SOAP and WSSE object to a block when it expects two argument" do
+  it "should yield an instance of Savon::SOAP and Savon::WSSE to a gven block expecting two arguments" do
     @client.authenticate do |soap, wsse|
-      soap.should be_a Savon::SOAP
-      wsse.should be_a Savon::WSSE
+      soap.should be_a(Savon::SOAP)
+      wsse.should be_a(Savon::WSSE)
     end
   end
 
-  it "still raises a NoMethodError for undefined methods" do
-    lambda { @client.some_undefined_method }.should raise_error NoMethodError
+  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

data/spec/savon/core_ext/hash_spec.rb

@@ -2,26 +2,13 @@ require "spec_helper"
 
 describe Hash do
 
-  describe "find_regexp" do
-    before do
-      @soap_fault_hash = { "soap:Envelope" => { "soap:Body" => { "soap:Fault" => {
-        "faultcode" => "soap:Server", "faultstring" => "Fault occurred while processing."
-      } } } }
+  describe "find_soap_body" do
+    it "returns the content from the 'soap:Body' element" do
+      { "soap:Envelope" => { "soap:Body" => "content" } }.find_soap_body.should == "content"
     end
 
-    it "returns an empty Hash in case it did not find the specified value" do
-      result = @soap_fault_hash.find_regexp "soap:Fault"
-
-      result.should be_a Hash
-      result.should be_empty
-    end
-
-    it "returns the value of the last Regexp filter found in the Hash" do
-      @soap_fault_hash.find_regexp([".+:Envelope", ".+:Body"]).
-        should == @soap_fault_hash["soap:Envelope"]["soap:Body"]
-
-      @soap_fault_hash.find_regexp([/.+:Envelope/, /.+:Body/, /.+Fault/]).
-        should == @soap_fault_hash["soap:Envelope"]["soap:Body"]["soap:Fault"]
+    it "returns an empty Hash in case the 'soap:Body' element could not be found" do
+      { "some_hash" => "content" }.find_soap_body.should == {}
     end
   end
 
@@ -39,8 +26,8 @@ describe Hash do
       it "for a Hash with multiple keys" do
         soap_xml = { :all => "users", :before => "whatever" }.to_soap_xml
 
-        soap_xml.should include "<all>users</all>"
-        soap_xml.should include "<before>whatever</before>"
+        soap_xml.should include("<all>users</all>")
+        soap_xml.should include("<before>whatever</before>")
       end
 
       it "for a Hash containing an Array" do
@@ -92,6 +79,23 @@ describe Hash do
         { :some => object }.to_soap_xml.should == "<some>#{object}</some>"
       end
     end
+
+    it "preserves the order of Hash keys and values specified through :@inorder" do
+      { :find_user => { :name => "Lucy", :id => 666, :@inorder => [:id, :name] } }.to_soap_xml.
+        should == "<findUser><id>666</id><name>Lucy</name></findUser>"
+
+      { :find_user => { :by_name => { :mname => "in the", :lname => "Sky", :fname => "Lucy",
+        :@inorder => [:fname, :mname, :lname] } } }.to_soap_xml. should ==
+        "<findUser><byName><fname>Lucy</fname><mname>in the</mname><lname>Sky</lname></byName></findUser>"
+    end
+
+    it "raises an error if the :@inorder Array does not match the Hash keys" do
+      lambda { { :name => "Lucy", :id => 666, :@inorder => [:name] }.to_soap_xml }.
+        should raise_error(RuntimeError)
+
+      lambda { { :by_name => { :name => "Lucy", :lname => "Sky", :@inorder => [:mname, :name] } }.to_soap_xml }.
+        should raise_error(RuntimeError)
+    end
   end
 
   describe "map_soap_response" do

data/spec/savon/core_ext/net_http_spec.rb

@@ -0,0 +1,38 @@
+require "spec_helper"
+
+describe Net::HTTP do
+  before do
+    @some_uri = URI "http://example.com"
+    @another_uri = URI "http://example.org"
+    @http = Net::HTTP.new @some_uri.host, @some_uri.port
+  end
+
+  describe "endpoint" do
+    it "changes the address and port of a Net::HTTP object" do
+      @http.address.should == @some_uri.host
+      @http.port.should == @some_uri.port
+
+      @http.endpoint @another_uri.host, @another_uri.port
+      @http.address.should == @another_uri.host
+      @http.port.should == @another_uri.port
+    end
+  end
+
+  describe "ssl_client_auth" do
+    it "accepts a Hash of options for SSL client authentication" do
+      @http.cert.should be_nil
+      @http.key.should be_nil
+      @http.ca_file.should be_nil
+      @http.verify_mode.should be_nil
+
+      @http.ssl_client_auth :cert => "cert", :key => "key",
+        :ca_file => "ca_file", :verify_mode => OpenSSL::SSL::VERIFY_PEER
+
+      @http.cert.should == "cert"
+      @http.key.should == "key"
+      @http.ca_file.should == "ca_file"
+      @http.verify_mode.should == OpenSSL::SSL::VERIFY_PEER
+    end
+  end
+
+end