they-savon 0.9.7

data/spec/savon/savon_spec.rb

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+describe Savon do
+
+  describe ".configure" do
+    around do |example|
+      Savon.reset_config!
+      example.run
+      Savon.reset_config!
+      Savon.log = false  # disable logging
+    end
+
+    describe "log" do
+      it "should default to true" do
+        Savon.log?.should be_true
+      end
+
+      it "should set whether to log HTTP requests" do
+        Savon.configure { |config| config.log = false }
+        Savon.log?.should be_false
+      end
+    end
+
+    describe "logger" do
+      it "should set the logger to use" do
+        MyLogger = Class.new
+        Savon.configure { |config| config.logger = MyLogger }
+        Savon.logger.should == MyLogger
+      end
+
+      it "should default to Logger writing to STDOUT" do
+        Savon.logger.should be_a(Logger)
+      end
+    end
+
+    describe "log filter" do
+
+      context "without a log filter set" do
+        it "should not filter XML messages" do
+          filtered_message = Savon.filtered(Fixture.response(:authentication))
+          filtered_message.should == Fixture.response(:authentication)
+        end
+
+        it "should not filter non-XML messages" do
+          filtered_message = Savon.filtered('This is an information message.')
+          filtered_message.should == 'This is an information message.'
+        end
+      end
+
+      context "with a log filter set" do
+        before(:each) do
+          Savon.configure { |config| config.log_filter = ['tokenHash'] }
+        end
+
+        it "should set log filter" do
+          Savon.log_filter.should == ['tokenHash']
+        end
+
+        it "should filter element values" do
+          filtered_value = "AAAJxA;cIedoT;mY10ExZwG6JuKgp2OYKxow=="
+          filtered_message = Savon.filtered(Fixture.response(:authentication))
+          filtered_message.should_not include(filtered_value)
+          filtered_message.should include('***FILTERED***')
+        end
+
+        it "should not filter non-XML messages" do
+          filtered_message = Savon.filtered('This is an information message.')
+          filtered_message.should == 'This is an information message.'
+        end
+      end
+
+      context "with multiple log filters set" do
+        before(:each) do
+          Savon.configure { |config| config.log_filter = ['logType','logTime'] }
+        end
+
+        it "should filter element values" do
+          filtered_values = /Notes Log|2010-09-21T18:22:01|2010-09-21T18:22:07/
+          filtered_message = Savon.filtered(Fixture.response(:list))
+
+          filtered_message.should_not =~ filtered_values
+          filtered_message.should include('<ns10:logTime>***FILTERED***</ns10:logTime>')
+          filtered_message.should include('<ns10:logType>***FILTERED***</ns10:logType>')
+          filtered_message.should include('<ns11:logTime>***FILTERED***</ns11:logTime>')
+          filtered_message.should include('<ns11:logType>***FILTERED***</ns11:logType>')
+        end
+
+        it "should not filter non-XML messages" do
+          filtered_message = Savon.filtered('This is an information message.')
+
+          filtered_message.should == 'This is an information message.'
+        end
+      end
+
+    end
+
+    describe "log_level" do
+      it "should default to :debug" do
+        Savon.log_level.should == :debug
+      end
+
+      it "should set the log level to use" do
+        Savon.configure { |config| config.log_level = :info }
+        Savon.log_level.should == :info
+      end
+    end
+
+    describe "raise_errors" do
+      it "should default to true" do
+        Savon.raise_errors?.should be_true
+      end
+
+      it "should not raise errors when disabled" do
+        Savon.raise_errors = false
+        Savon.raise_errors?.should be_false
+      end
+    end
+
+    describe "soap_version" do
+      it "should default to SOAP 1.1" do
+        Savon.soap_version.should == 1
+      end
+
+      it "should return 2 if set to SOAP 1.2" do
+        Savon.soap_version = 2
+        Savon.soap_version.should == 2
+      end
+
+      it "should raise an ArgumentError in case of an invalid version" do
+        lambda { Savon.soap_version = 3 }.should raise_error(ArgumentError)
+      end
+    end
+
+    describe "strip_namespaces" do
+      it "should default to true" do
+        Savon.strip_namespaces?.should == true
+      end
+
+      it "should not strip namespaces when set to false" do
+        Savon.strip_namespaces = false
+        Savon.strip_namespaces?.should == false
+      end
+    end
+  end
+
+end

data/spec/savon/soap/fault_spec.rb

@@ -0,0 +1,89 @@
+require "spec_helper"
+
+describe Savon::SOAP::Fault do
+  let(:soap_fault) { Savon::SOAP::Fault.new new_response(:body => Fixture.response(:soap_fault)) }
+  let(:soap_fault2) { Savon::SOAP::Fault.new new_response(:body => Fixture.response(:soap_fault12)) }
+  let(:another_soap_fault) { Savon::SOAP::Fault.new new_response(:body => Fixture.response(:another_soap_fault)) }
+  let(:no_fault) { Savon::SOAP::Fault.new new_response }
+
+  it "should be a Savon::Error" do
+    Savon::SOAP::Fault.should < Savon::Error
+  end
+
+  describe "#http" do
+    it "should return the HTTPI::Response" do
+      soap_fault.http.should be_an(HTTPI::Response)
+    end
+  end
+
+  describe "#present?" do
+    it "should return true if the HTTP response contains a SOAP 1.1 fault" do
+      soap_fault.should be_present
+    end
+
+    it "should return true if the HTTP response contains a SOAP 1.2 fault" do
+      soap_fault2.should be_present
+    end
+
+    it "should return true if the HTTP response contains a SOAP fault with different namespaces" do
+      another_soap_fault.should be_present
+    end
+
+    it "should return false unless the HTTP response contains a SOAP fault" do
+      no_fault.should_not be_present
+    end
+  end
+
+  [:message, :to_s].each do |method|
+    describe "##{method}" do
+      it "should return an empty String unless a SOAP fault is present" do
+        no_fault.send(method).should == ""
+      end
+
+      it "should return a SOAP 1.1 fault message" do
+        soap_fault.send(method).should == "(soap:Server) Fault occurred while processing."
+      end
+
+      it "should return a SOAP 1.2 fault message" do
+        soap_fault2.send(method).should == "(soap:Sender) Sender Timeout"
+      end
+
+      it "should return a SOAP fault message (with different namespaces)" do
+        another_soap_fault.send(method).should == "(ERR_NO_SESSION) Wrong session message"
+      end
+    end
+  end
+
+  describe "#to_hash" do
+    it "should return the SOAP response as a Hash unless a SOAP fault is present" do
+      no_fault.to_hash[:authenticate_response][:return][:success].should be_true
+    end
+
+    it "should return a SOAP 1.1 fault as a Hash" do
+      soap_fault.to_hash.should == {
+        :fault => {
+          :faultstring => "Fault occurred while processing.",
+          :faultcode   => "soap:Server"
+        }
+      }
+    end
+
+    it "should return a SOAP 1.2 fault as a Hash" do
+      soap_fault2.to_hash.should == {
+        :fault => {
+          :detail => { :max_time => "P5M" },
+          :reason => { :text => "Sender Timeout" },
+          :code   => { :value => "soap:Sender", :subcode => { :value => "m:MessageTimeout" } }
+        }
+      }
+    end
+  end
+
+  def new_response(options = {})
+    defaults = { :code => 500, :headers => {}, :body => Fixture.response(:authentication) }
+    response = defaults.merge options
+    
+    HTTPI::Response.new response[:code], response[:headers], response[:body]
+  end
+
+end

data/spec/savon/soap/request_spec.rb

@@ -0,0 +1,57 @@
+require "spec_helper"
+
+describe Savon::SOAP::Request do
+  let(:soap_request) { Savon::SOAP::Request.new HTTPI::Request.new, soap }
+  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
+    content_type[1].should == "text/xml;charset=UTF-8"
+    content_type[2].should == "application/soap+xml;charset=UTF-8"
+  end
+
+  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 HTTPI::Request.new, soap
+      response.should be_a(Savon::SOAP::Response)
+    end
+  end
+
+  describe ".new" do
+    it "uses the SOAP endpoint for the request" do
+      soap_request.request.url.should == URI(soap.endpoint)
+    end
+
+    it "sets the SOAP body for the request" do
+      soap_request.request.body.should == soap.to_xml
+    end
+
+    it "sets the Content-Type header for SOAP 1.1" do
+      soap_request.request.headers["Content-Type"].should == Savon::SOAP::Request::ContentType[1]
+    end
+
+    it "sets the Content-Type header for SOAP 1.2" do
+      soap.version = 2
+      soap_request.request.headers["Content-Type"].should == Savon::SOAP::Request::ContentType[2]
+    end
+
+    it "does not set the Content-Type header if it's already specified" do
+      headers = { "Content-Type" => "text/plain" }
+      soap_request = Savon::SOAP::Request.new HTTPI::Request.new(:headers => headers), soap
+      soap_request.request.headers["Content-Type"].should == headers["Content-Type"]
+    end
+
+    it "sets the Content-Length header" do
+      soap_request.request.headers["Content-Length"].should == soap.to_xml.length.to_s
+    end
+  end
+
+  describe "#response" do
+    it "executes an HTTP POST request and returns a Savon::SOAP::Response" do
+      HTTPI.expects(:post).returns(HTTPI::Response.new 200, {}, Fixture.response(:authentication))
+      soap_request.response.should be_a(Savon::SOAP::Response)
+    end
+  end
+
+end

data/spec/savon/soap/response_spec.rb

@@ -0,0 +1,224 @@
+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 "#[]" do
+    it "should return the SOAP response body as a Hash" do
+      soap_response[:authenticate_response][:return].should ==
+        Fixture.response_hash(:authentication)[:authenticate_response][:return]
+    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
+
+  %w(body to_hash).each do |method|
+    describe "##{method}" do
+      it "should return the SOAP response body as a Hash" do
+        soap_response.send(method)[:authenticate_response][:return].should ==
+          Fixture.response_hash(:authentication)[:authenticate_response][:return]
+      end
+
+      it "should return a Hash for a SOAP multiRef response" do
+        hash = soap_response(:body => Fixture.response(:multi_ref)).send(method)
+
+        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 = soap_response(:body => Fixture.response(:list)).send(method)
+
+        hash[:multi_namespaced_entry_response][:history].should be_a(Hash)
+        hash[:multi_namespaced_entry_response][:history][:case].should be_an(Array)
+      end
+    end
+  end
+
+  describe "#to_array" do
+    context "when the given path exists" do
+      it "should return an Array containing the path value" do
+        soap_response.to_array(:authenticate_response, :return).should ==
+          [Fixture.response_hash(:authentication)[:authenticate_response][:return]]
+      end
+    end
+
+    context "when the given path returns nil" do
+      it "should return an empty Array" do
+        soap_response.to_array(:authenticate_response, :undefined).should == []
+      end
+    end
+
+    context "when the given path does not exist at all" do
+      it "should return an empty Array" do
+        soap_response.to_array(:authenticate_response, :some, :undefined, :path).should == []
+      end
+    end
+  end
+
+  describe "#hash" do
+    it "should return the complete SOAP response XML as a Hash" do
+      response = soap_response :body => Fixture.response(:header)
+      response.hash[:envelope][:header][:session_number].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 "#doc" do
+    it "returns a Nokogiri::XML::Document for the SOAP response XML" do
+      soap_response.doc.should be_a(Nokogiri::XML::Document)
+    end
+  end
+
+  describe "#xpath" do
+    it "permits XPath access to elements in the request" do
+      soap_response.xpath("//client").first.inner_text.should == "radclient"
+      soap_response.xpath("//ns2:authenticateResponse/return/success").first.inner_text.should == "true"
+    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