s-savon 0.8.6

data/spec/savon/soap/response_spec.rb

@@ -0,0 +1,174 @@
+require "spec_helper"
+
+describe Savon::SOAP::Response do
+
+  describe ".new" do
+    it "should raise a Savon::SOAP::Fault in case of a SOAP fault" do
+      lambda { soap_fault_response }.should raise_error(Savon::SOAP::Fault)
+    end
+
+    it "should not raise a Savon::SOAP::Fault in case the default is turned off" do
+      Savon.raise_errors = false
+      lambda { soap_fault_response }.should_not raise_error(Savon::SOAP::Fault)
+      Savon.raise_errors = true
+    end
+
+    it "should raise a Savon::HTTP::Error in case of an HTTP error" do
+      lambda { soap_response :code => 500 }.should raise_error(Savon::HTTP::Error)
+    end
+
+    it "should not raise a Savon::HTTP::Error in case the default is turned off" do
+      Savon.raise_errors = false
+      soap_response :code => 500
+      Savon.raise_errors = true
+    end
+  end
+
+  describe "#success?" do
+    around do |example|
+      Savon.raise_errors = false
+      example.run
+      Savon.raise_errors = true
+    end
+
+    it "should return true if the request was successful" do
+      soap_response.should be_a_success
+    end
+
+    it "should return false if there was a SOAP fault" do
+      soap_fault_response.should_not be_a_success
+    end
+
+    it "should return false if there was an HTTP error" do
+      http_error_response.should_not be_a_success
+    end
+  end
+
+  describe "#soap_fault?" do
+    around do |example|
+      Savon.raise_errors = false
+      example.run
+      Savon.raise_errors = true
+    end
+
+    it "should not return true in case the response seems to be ok" do
+      soap_response.soap_fault?.should be_false
+    end
+
+    it "should return true in case of a SOAP fault" do
+      soap_fault_response.soap_fault?.should be_true
+    end
+  end
+
+  describe "#soap_fault" do
+    around do |example|
+      Savon.raise_errors = false
+      example.run
+      Savon.raise_errors = true
+    end
+
+    it "should return a Savon::SOAP::Fault" do
+      soap_fault_response.soap_fault.should be_a(Savon::SOAP::Fault)
+    end
+
+    it "should return a Savon::SOAP::Fault containing the HTTPI::Response" do
+      soap_fault_response.soap_fault.http.should be_an(HTTPI::Response)
+    end
+
+    it "should return a Savon::SOAP::Fault even if the SOAP response seems to be ok" do
+      soap_response.soap_fault.should be_a(Savon::SOAP::Fault)
+    end
+  end
+
+  describe "#http_error?" do
+    around do |example|
+      Savon.raise_errors = false
+      example.run
+      Savon.raise_errors = true
+    end
+
+    it "should not return true in case the response seems to be ok" do
+      soap_response.http_error?.should_not be_true
+    end
+
+    it "should return true in case of an HTTP error" do
+      soap_response(:code => 500).http_error?.should be_true
+    end
+  end
+
+  describe "#http_error" do
+    around do |example|
+      Savon.raise_errors = false
+      example.run
+      Savon.raise_errors = true
+    end
+
+    it "should return a Savon::HTTP::Error" do
+      http_error_response.http_error.should be_a(Savon::HTTP::Error)
+    end
+
+    it "should return a Savon::HTTP::Error containing the HTTPI::Response" do
+      http_error_response.http_error.http.should be_an(HTTPI::Response)
+    end
+
+    it "should return a Savon::HTTP::Error even if the HTTP response seems to be ok" do
+      soap_response.http_error.should be_a(Savon::HTTP::Error)
+    end
+  end
+
+  describe "#header" do
+    it "should return the SOAP response header as a Hash" do
+      response = soap_response :body => Fixture.response(:header)
+      response.header.should include(:session_number => "ABCD1234")
+    end
+  end
+
+  describe "#to_hash" do
+    it "should return the SOAP response body as a Hash" do
+      soap_response.to_hash[:authenticate_response][:return].should ==
+        Fixture.response_hash(:authentication)[:authenticate_response][:return]
+    end
+  end
+
+  describe "#to_array" do
+    it "should delegate to Savon::SOAP::XML.to_array" do
+      Savon::SOAP::XML.expects(:to_array).with(soap_response.to_hash, :authenticate_response, :return)
+      soap_response.to_array :authenticate_response, :return
+    end
+  end
+
+  describe "#basic_hash" do
+    it "should return the complete SOAP response XML as a Hash" do
+      response = soap_response :body => Fixture.response(:header)
+      response.basic_hash["soap:Envelope"]["soap:Header"]["SessionNumber"].should == "ABCD1234"
+    end
+  end
+
+  describe "#to_xml" do
+    it "should return the raw SOAP response body" do
+      soap_response.to_xml.should == Fixture.response(:authentication)
+    end
+  end
+
+  describe "#http" do
+    it "should return the HTTPI::Response" do
+      soap_response.http.should be_an(HTTPI::Response)
+    end
+  end
+
+  def soap_response(options = {})
+    defaults = { :code => 200, :headers => {}, :body => Fixture.response(:authentication) }
+    response = defaults.merge options
+
+    Savon::SOAP::Response.new HTTPI::Response.new(response[:code], response[:headers], response[:body])
+  end
+
+  def soap_fault_response
+    soap_response :code => 500, :body => Fixture.response(:soap_fault)
+  end
+
+  def http_error_response
+    soap_response :code => 404, :body => "Not found"
+  end
+
+end

data/spec/savon/soap/xml_spec.rb

@@ -0,0 +1,335 @@
+require "spec_helper"
+
+describe Savon::SOAP::XML do
+  let(:xml) { Savon::SOAP::XML.new Endpoint.soap, :authenticate, :id => 1 }
+
+  describe ".to_hash" do
+    it "should return a given SOAP response body as a Hash" do
+      hash = Savon::SOAP::XML.to_hash Fixture.response(:authentication)
+      hash[:authenticate_response][:return].should == {
+        :success => true,
+        :authentication_value => {
+          :token_hash => "AAAJxA;cIedoT;mY10ExZwG6JuKgp2OYKxow==",
+          :token => "a68d1d6379b62ff339a0e0c69ed4d9cf",
+          :client => "radclient"
+        }
+      }
+    end
+
+    it "should return a Hash for a SOAP multiRef response" do
+      hash = Savon::SOAP::XML.to_hash Fixture.response(:multi_ref)
+
+      hash[:list_response].should be_a(Hash)
+      hash[:multi_ref].should be_an(Array)
+    end
+
+    it "should add existing namespaced elements as an array" do
+      hash = Savon::SOAP::XML.to_hash Fixture.response(:list)
+
+      hash[:multi_namespaced_entry_response][:history].should be_a(Hash)
+      hash[:multi_namespaced_entry_response][:history][:case].should be_an(Array)
+    end
+  end
+
+  describe ".parse" do
+    it "should convert the given XML into a Hash" do
+      hash = Savon::SOAP::XML.parse Fixture.response(:list)
+      hash["soapenv:Envelope"]["soapenv:Body"].should be_a(Hash)
+    end
+  end
+
+  describe ".to_array" do
+    let(:response_hash) { Fixture.response_hash :authentication }
+
+    context "when the given path exists" do
+      it "should return an Array containing the path value" do
+        Savon::SOAP::XML.to_array(response_hash, :authenticate_response, :return).should ==
+          [response_hash[:authenticate_response][:return]]
+      end
+    end
+
+    context "when the given path returns nil" do
+      it "should return an empty Array" do
+        Savon::SOAP::XML.to_array(response_hash, :authenticate_response, :undefined).should == []
+      end
+    end
+
+    context "when the given path does not exist at all" do
+      it "should return an empty Array" do
+        Savon::SOAP::XML.to_array(response_hash, :authenticate_response, :some, :wrong, :path).should == []
+      end
+    end
+  end
+
+  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.endpoint.should == Endpoint.soap
+      xml.input.should == :authentication
+      xml.body.should == { :id => 1 }
+    end
+  end
+
+  describe "#input" do
+    it "should set the input tag" do
+      xml.input = :test
+      xml.input.should == :test
+    end
+  end
+
+  describe "#endpoint" do
+    it "should set the endpoint to use" do
+      xml.endpoint = "http://test.com"
+      xml.endpoint.should == "http://test.com"
+    end
+  end
+
+  describe "#version" do
+    it "should default to SOAP 1.1" do
+      xml.version.should == 1
+    end
+
+    it "should default to the global default" do
+      Savon.soap_version = 2
+      xml.version.should == 2
+
+      reset_soap_version
+    end
+
+    it "should set the SOAP version to use" do
+      xml.version = 2
+      xml.version.should == 2
+    end
+
+    it "should raise an ArgumentError in case of an invalid version" do
+      lambda { xml.version = 3 }.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "#header" do
+    it "should default to an empty Hash" do
+      xml.header.should == {}
+    end
+
+    it "should set the SOAP header" do
+      xml.header = { "MySecret" => "abc" }
+      xml.header.should == { "MySecret" => "abc" }
+    end
+  end
+
+  describe "#env_namespace" do
+    it "should default to :env" do
+      xml.env_namespace.should == :env
+    end
+
+    it "should set the SOAP envelope namespace" do
+      xml.env_namespace = :soapenv
+      xml.env_namespace.should == :soapenv
+    end
+  end
+
+  describe "#namespaces" do
+    it "should default to a Hash containing the namespace for SOAP 1.1" do
+      xml.namespaces.should == { "xmlns:env" => "http://schemas.xmlsoap.org/soap/envelope/" }
+    end
+
+    it "should default to a Hash containing the namespace for SOAP 1.2 if that's the current version" do
+      xml.version = 2
+      xml.namespaces.should == { "xmlns:env" => "http://www.w3.org/2003/05/soap-envelope" }
+    end
+
+    it "should set the SOAP header" do
+      xml.namespaces = { "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema" }
+      xml.namespaces.should == { "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema" }
+    end
+  end
+
+  describe "#wsse" do
+    it "should set the Savon::WSSE object" do
+      xml.wsse = Savon::WSSE.new
+      xml.wsse.should be_a(Savon::WSSE)
+    end
+  end
+
+  describe "#body" do
+    it "should set the SOAP body Hash" do
+      xml.body = { :id => 1 }
+      xml.to_xml.should include("<id>1</id>")
+    end
+
+    it "should also accepts an XML String" do
+      xml.body = "<id>1</id>"
+      xml.to_xml.should include("<id>1</id>")
+    end
+  end
+
+  describe "#xml" do
+    it "lets you specify a completely custom XML String" do
+      xml.xml = "<custom>xml</custom>"
+      xml.to_xml.should == "<custom>xml</custom>"
+    end
+
+    it "yields a Builder::XmlMarkup object to a given block" do
+      xml.xml { |xml| xml.using("Builder") }
+      xml.to_xml.should == '<?xml version="1.0" encoding="UTF-8"?><using>Builder</using>'
+    end
+  end
+
+  describe "#to_xml" do
+    after { reset_soap_version }
+
+    context "by default" do
+      it "should start with an XML declaration" do
+        xml.to_xml.should match(/^<\?xml version="1.0" encoding="UTF-8"\?>/)
+      end
+
+      it "should use default SOAP envelope namespace" do
+        xml.to_xml.should include("<env:Envelope", "<env:Body")
+      end
+
+      it "should add the xsd namespace" do
+        uri = "http://www.w3.org/2001/XMLSchema"
+        xml.to_xml.should match(/<env:Envelope (.*)xmlns:xsd="#{uri}"(.*)>/)
+      end
+
+      it "should add the xsi namespace" do
+        uri = "http://www.w3.org/2001/XMLSchema-instance"
+        xml.to_xml.should match(/<env:Envelope (.*)xmlns:xsi="#{uri}"(.*)>/)
+      end
+
+      it "should have a SOAP envelope tag with a SOAP 1.1 namespace" do
+        uri = "http://schemas.xmlsoap.org/soap/envelope/"
+        xml.to_xml.should match(/<env:Envelope (.*)xmlns:env="#{uri}"(.*)>/)
+      end
+
+      it "should have a SOAP body containing the SOAP input tag and body Hash" do
+        xml.to_xml.should include('<env:Body><authenticate><id>1</id></authenticate></env:Body>')
+      end
+
+      it "should accept a SOAP body as an XML String" do
+        xml.body = "<someId>1</someId>"
+        xml.to_xml.should include('<env:Body><authenticate><someId>1</someId></authenticate></env:Body>')
+      end
+
+      it "should not contain a SOAP header" do
+        xml.to_xml.should_not include('<env:Header')
+      end
+    end
+
+    context "with a SOAP header" do
+      it "should contain the given header" do
+        xml.header = {
+          :token => "secret",
+          :attributes! => { :token => { :xmlns => "http://example.com" } }
+        }
+        
+        xml.to_xml.should include('<env:Header><token xmlns="http://example.com">secret</token></env:Header>')
+      end
+    end
+
+    context "with the global SOAP version set to 1.2" do
+      it "should contain the namespace for SOAP 1.2" do
+        Savon.soap_version = 2
+
+        uri = "http://www.w3.org/2003/05/soap-envelope"
+        xml.to_xml.should match(/<env:Envelope (.*)xmlns:env="#{uri}"(.*)>/)
+        reset_soap_version
+      end
+    end
+
+    context "with a global and request SOAP version" do
+      it "should contain the namespace for the request SOAP version" do
+        Savon.soap_version = 2
+        xml.version = 1
+
+        uri = "http://schemas.xmlsoap.org/soap/envelope/"
+        xml.to_xml.should match(/<env:Envelope (.*)xmlns:env="#{uri}"(.*)>/)
+        reset_soap_version
+      end
+    end
+
+    context "with the SOAP envelope namespace set to an empty String" do
+      it "should not add a namespace to SOAP envelope tags" do
+        xml.env_namespace = ""
+        xml.to_xml.should include("<Envelope", "<Body")
+      end
+    end
+
+    context "using the #namespace and #namespace_identifier" do
+      it "should contain the specified namespace" do
+        xml.namespace_identifier = :wsdl
+        xml.namespace = "http://example.com"
+        xml.to_xml.should include('xmlns:wsdl="http://example.com"')
+      end
+    end
+
+    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 }
+      end
+
+      it "should namespace the default elements" do
+        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 WSSE authentication" do
+      it "should containg a SOAP header with WSSE authentication details" do
+        xml.wsse = Savon::WSSE.new
+        xml.wsse.credentials "username", "password"
+
+        xml.to_xml.should include("<env:Header><wsse:Security")
+        xml.to_xml.should include("<wsse:Username>username</wsse:Username>")
+        xml.to_xml.should include("password</wsse:Password>")
+      end
+    end
+
+    context "with a simple input tag (Symbol)" do
+      it "should just add the input tag" do
+        xml.input = :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.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.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.to_xml.should include('<wsdl:getUser><id>1</id></wsdl:getUser>')
+      end
+    end
+
+    context "with a prefixed input tag and a namespace Hash (Array)" do
+      it "should contain a prefixed input tag with namespaces" do
+        xml.input = [:wsdl, :getUser, { :only_active => false }]
+        xml.to_xml.should include('<wsdl:getUser only_active="false"><id>1</id></wsdl:getUser>')
+      end
+    end
+  end
+
+  def reset_soap_version
+    Savon.soap_version = Savon::SOAP::DefaultVersion
+  end
+
+end