savon-ng-1.6 2.4.0

data/spec/savon/response_spec.rb

@@ -0,0 +1,258 @@
+require "spec_helper"
+
+describe Savon::Response do
+
+  let(:globals) { Savon::GlobalOptions.new }
+  let(:locals)  { Savon::LocalOptions.new }
+
+  describe ".new" do
+    it "should raise a Savon::Fault in case of a SOAP fault" do
+      lambda { soap_fault_response }.should raise_error(Savon::SOAPFault)
+    end
+
+    it "should not raise a Savon::Fault in case the default is turned off" do
+      globals[:raise_errors] = false
+      lambda { soap_fault_response }.should_not raise_error
+    end
+
+    it "should raise a Savon::HTTP::Error in case of an HTTP error" do
+      lambda { soap_response :code => 500 }.should raise_error(Savon::HTTPError)
+    end
+
+    it "should not raise a Savon::HTTP::Error in case the default is turned off" do
+      globals[:raise_errors] = false
+      soap_response :code => 500
+    end
+  end
+
+  describe "#success?" do
+    before { globals[:raise_errors] = false }
+
+    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
+    before { globals[:raise_errors] = false }
+
+    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
+    before { globals[:raise_errors] = false }
+
+    it "should return nil in case the response seems to be ok" do
+      soap_response.soap_fault.should be_nil
+    end
+
+    it "should return a SOAPFault in case of a SOAP fault" do
+      soap_fault_response.soap_fault.should be_a(Savon::SOAPFault)
+    end
+  end
+
+  describe "#http_error?" do
+    before { globals[:raise_errors] = false }
+
+    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
+    before { globals[:raise_errors] = false }
+
+    it "should return nil in case the response seems to be ok" do
+      soap_response.http_error.should be_nil
+    end
+
+    it "should return a HTTPError in case of an HTTP error" do
+      soap_response(:code => 500).http_error.should be_a(Savon::HTTPError)
+    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
+
+    it 'respects the global :strip_namespaces option' do
+      globals[:strip_namespaces] = false
+
+      response_with_header = soap_response(:body => Fixture.response(:header))
+      header = response_with_header.header
+
+      expect(header).to be_a(Hash)
+
+      # notice: :session_number is a snake_case Symbol without namespaces,
+      # but the Envelope and Header elements are qualified.
+      expect(header.keys).to include(:session_number)
+    end
+
+    it 'respects the global :convert_response_tags_to option' do
+      globals[:convert_response_tags_to] = lambda { |key| key.upcase }
+
+      response_with_header = soap_response(:body => Fixture.response(:header))
+      header = response_with_header.header
+
+      expect(header).to be_a(Hash)
+      expect(header.keys).to include('SESSIONNUMBER')
+    end
+
+    it "should throw an exception when the response header isn't parsable" do
+      lambda { invalid_soap_response.header }.should raise_error Savon::InvalidResponseError
+    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
+
+      it 'respects the global :strip_namespaces option' do
+        globals[:strip_namespaces] = false
+
+        body = soap_response.body
+
+        expect(body).to be_a(Hash)
+        expect(body.keys).to include(:"ns2:authenticate_response")
+      end
+
+      it 'respects the global :convert_response_tags_to option' do
+        globals[:convert_response_tags_to] = lambda { |key| key.upcase }
+
+        body = soap_response.body
+
+        expect(body).to be_a(Hash)
+        expect(body.keys).to include('AUTHENTICATERESPONSE')
+      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
+
+      it "should properly return FalseClass values [#327]" do
+        body = Gyoku.xml(:envelope => { :body => { :return => { :success => false } } })
+        soap_response(:body => body).to_array(:return, :success).should == [false]
+      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 '#find' do
+    it 'delegates to Nori#find to find child elements inside the Envelope' do
+      result = soap_response.find('Body', 'authenticateResponse', 'return')
+
+      expect(result).to be_a(Hash)
+      expect(result.keys).to include(:authentication_value)
+    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
+    http_response = HTTPI::Response.new(response[:code], response[:headers], response[:body])
+
+    Savon::Response.new(http_response, globals, locals)
+  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
+
+  def invalid_soap_response(options = {})
+    defaults = { :code => 200, :headers => {}, :body => "I'm not SOAP" }
+    response = defaults.merge options
+    http_response = HTTPI::Response.new(response[:code], response[:headers], response[:body])
+
+    Savon::Response.new(http_response, globals, locals)
+  end
+
+end

data/spec/savon/soap_fault_spec.rb

@@ -0,0 +1,126 @@
+require "spec_helper"
+
+describe Savon::SOAPFault do
+  let(:soap_fault) { Savon::SOAPFault.new new_response(:body => Fixture.response(:soap_fault)), nori }
+  let(:soap_fault2) { Savon::SOAPFault.new new_response(:body => Fixture.response(:soap_fault12)), nori }
+  let(:soap_fault_nc) { Savon::SOAPFault.new new_response(:body => Fixture.response(:soap_fault)), nori_no_convert }
+  let(:soap_fault_nc2) { Savon::SOAPFault.new new_response(:body => Fixture.response(:soap_fault12)), nori_no_convert }
+  let(:another_soap_fault) { Savon::SOAPFault.new new_response(:body => Fixture.response(:another_soap_fault)), nori }
+  let(:no_fault) { Savon::SOAPFault.new new_response, nori }
+
+  let(:nori) { Nori.new(:strip_namespaces => true, :convert_tags_to => lambda { |tag| tag.snakecase.to_sym }) }
+  let(:nori_no_convert) { Nori.new(:strip_namespaces => true, :convert_tags_to => nil) }
+
+  it "inherits from Savon::Error" do
+    expect(Savon::SOAPFault.ancestors).to include(Savon::Error)
+  end
+
+  describe "#http" do
+    it "returns the HTTPI::Response" do
+      expect(soap_fault.http).to be_an(HTTPI::Response)
+    end
+  end
+
+  describe ".present?" do
+    it "returns true if the HTTP response contains a SOAP 1.1 fault" do
+      http = new_response(:body => Fixture.response(:soap_fault))
+      expect(Savon::SOAPFault.present? http).to be_true
+    end
+
+    it "returns true if the HTTP response contains a SOAP 1.2 fault" do
+      http = new_response(:body => Fixture.response(:soap_fault12))
+      expect(Savon::SOAPFault.present? http).to be_true
+    end
+
+    it "returns true if the HTTP response contains a SOAP fault with different namespaces" do
+      http = new_response(:body => Fixture.response(:another_soap_fault))
+      expect(Savon::SOAPFault.present? http).to be_true
+    end
+
+    it "returns false unless the HTTP response contains a SOAP fault" do
+      expect(Savon::SOAPFault.present? new_response).to be_false
+    end
+  end
+
+  [:message, :to_s].each do |method|
+    describe "##{method}" do
+      it "returns a SOAP 1.1 fault message" do
+        expect(soap_fault.send method).to eq("(soap:Server) Fault occurred while processing.")
+      end
+
+      it "returns a SOAP 1.2 fault message" do
+        expect(soap_fault2.send method).to eq("(soap:Sender) Sender Timeout")
+      end
+
+      it "returns a SOAP fault message (with different namespaces)" do
+        expect(another_soap_fault.send method).to eq("(ERR_NO_SESSION) Wrong session message")
+      end
+
+      it "works even if the keys are different in a SOAP 1.1 fault message" do
+        expect(soap_fault_nc.send method).to eq("(soap:Server) Fault occurred while processing.")
+      end
+
+      it "works even if the keys are different in a SOAP 1.2 fault message" do
+        expect(soap_fault_nc2.send method).to eq("(soap:Sender) Sender Timeout")
+      end
+    end
+  end
+
+  describe "#to_hash" do
+    it "returns the SOAP response as a Hash unless a SOAP fault is present" do
+      expect(no_fault.to_hash[:authenticate_response][:return][:success]).to be_true
+    end
+
+    it "returns a SOAP 1.1 fault as a Hash" do
+      expected = {
+        :fault => {
+          :faultstring => "Fault occurred while processing.",
+          :faultcode   => "soap:Server"
+        }
+      }
+
+      expect(soap_fault.to_hash).to eq(expected)
+    end
+
+    it "returns a SOAP 1.2 fault as a Hash" do
+      expected = {
+        :fault => {
+          :detail => { :max_time => "P5M" },
+          :reason => { :text => "Sender Timeout" },
+          :code   => { :value => "soap:Sender", :subcode => { :value => "m:MessageTimeout" } }
+        }
+      }
+
+      expect(soap_fault2.to_hash).to eq(expected)
+    end
+
+    it "works even if the keys are different" do
+      expected = {
+        "Fault" => {
+          "Code" => {
+            "Value"  => "soap:Sender",
+            "Subcode"=> {
+              "Value" => "m:MessageTimeout"
+            }
+          },
+          "Reason" => {
+            "Text" => "Sender Timeout"
+          },
+          "Detail" => {
+            "MaxTime" => "P5M"
+          }
+        }
+      }
+
+      expect(soap_fault_nc2.to_hash).to eq(expected)
+    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/spec_helper.rb

@@ -0,0 +1,30 @@
+require "bundler"
+Bundler.setup(:default, :development)
+
+unless RUBY_PLATFORM =~ /java/
+  require "simplecov"
+  require "coveralls"
+
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start do
+      add_filter "spec"
+  end
+end
+
+require "savon"
+require "rspec"
+
+# don't have HTTPI lazy-load HTTPClient, because then
+# it can't actually be refered to inside the specs.
+require "httpclient"
+
+support_files = File.expand_path("spec/support/**/*.rb")
+Dir[support_files].each { |file| require file }
+
+RSpec.configure do |config|
+  config.include SpecSupport
+  config.mock_with :mocha
+  config.order = "random"
+end
+
+HTTPI.log = false

data/spec/support/endpoint.rb

@@ -0,0 +1,25 @@
+class Endpoint
+  class << self
+
+    # Returns the WSDL endpoint for a given +type+ of request.
+    def wsdl(type = nil)
+      case type
+        when :no_namespace       then "http://nons.example.com/Service?wsdl"
+        when :namespaced_actions then "http://nsactions.example.com/Service?wsdl"
+        when :geotrust           then "https://test-api.geotrust.com/webtrust/query.jws?WSDL"
+        else                          soap(type)
+      end
+    end
+
+    # Returns the SOAP endpoint for a given +type+ of request.
+    def soap(type = nil)
+      case type
+        when :soap_fault then "http://soapfault.example.com/Service?wsdl"
+        when :http_error then "http://httperror.example.com/Service?wsdl"
+        when :invalid    then "http://invalid.example.com/Service?wsdl"
+        else                  "http://example.com/validation/1.0/AuthenticationService"
+      end
+    end
+
+  end
+end

data/spec/support/fixture.rb

@@ -0,0 +1,39 @@
+class Fixture
+
+  TYPES = { :gzip => "gz", :response => "xml", :wsdl => "xml" }
+
+  class << self
+
+    def [](type, fixture)
+      fixtures(type)[fixture] ||= read_file type, fixture
+    end
+
+    def response_hash(fixture)
+      @response_hash ||= {}
+      @response_hash[fixture] ||= nori.parse(response(fixture))[:envelope][:body]
+    end
+
+    TYPES.each do |type, ext|
+      define_method(type) { |fixture| self[type, fixture] }
+    end
+
+  private
+
+    def nori
+      Nori.new(:strip_namespaces => true, :convert_tags_to => lambda { |tag| tag.snakecase.to_sym })
+    end
+
+    def fixtures(type)
+      @fixtures ||= {}
+      @fixtures[type] ||= {}
+    end
+
+    def read_file(type, fixture)
+      path = File.expand_path "../../fixtures/#{type}/#{fixture}.#{TYPES[type]}", __FILE__
+      raise ArgumentError, "Unable to load: #{path}" unless File.exist? path
+
+      File.read path
+    end
+
+  end
+end

data/spec/support/integration.rb

@@ -0,0 +1,9 @@
+module SpecSupport
+
+  def call_and_fail_gracefully(client, *args, &block)
+    client.call(*args, &block)
+  rescue Savon::SOAPFault => e
+    pending e.message
+  end
+
+end

data/spec/support/stdout.rb

@@ -0,0 +1,25 @@
+module SpecSupport
+
+  def mock_stdout
+    original_stdout = $stdout
+
+    stdout = StringIO.new
+    $stdout = stdout
+
+    yield
+
+    $stdout = original_stdout
+    stdout
+  end
+
+  def silence_stdout
+    original_stdout = $stdout
+    $stdout = StringIO.new
+
+    result = yield
+
+    $stdout = original_stdout
+    result
+  end
+
+end