savon 0.8.0.beta.1 → 0.8.0.beta.2

data/lib/savon/global.rb

@@ -61,6 +61,14 @@ module Savon
     # Sets whether to strip namespaces in a SOAP response Hash.
     attr_writer :strip_namespaces
 
+    # Returns the response pattern to apply.
+    def response_pattern
+      @response_pattern ||= []
+    end
+
+    # Sets the response pattern (an Array of Regexps or Symbols).
+    attr_writer :response_pattern
+
     # Reset to default configuration.
     def reset_config!
       self.log = true
@@ -69,6 +77,7 @@ module Savon
       self.raise_errors = true
       self.soap_version = SOAP::DefaultVersion
       self.strip_namespaces = true
+      self.response_pattern = []
     end
 
   end

data/lib/savon/soap/response.rb

@@ -44,8 +44,22 @@ module Savon
       end
 
       # Returns the SOAP response body as a Hash.
+      def original_hash
+        @original_hash ||= Savon::SOAP::XML.to_hash to_xml
+      end
+
+      # Returns the SOAP response body as a Hash and applies
+      # the <tt>Savon.response_pattern</tt> if defined.
       def to_hash
-        @hash ||= Savon::SOAP::XML.to_hash to_xml
+        @hash ||= apply_response_pattern original_hash
+      end
+
+      # Returns the SOAP response Hash as an Array.
+      def to_array
+        @array ||= begin
+          array = to_hash.kind_of?(Array) ? to_hash : [to_hash]
+          array.compact
+        end
       end
 
       # Returns the SOAP response XML.
@@ -60,6 +74,20 @@ module Savon
         raise http_error if http_error?
       end
 
+      def apply_response_pattern(hash)
+        return hash if Savon.response_pattern.blank?
+        
+        Savon.response_pattern.inject(hash) do |memo, pattern|
+          key = case pattern
+            when Regexp then memo.keys.find { |key| key.to_s =~ pattern }
+            else             memo.keys.find { |key| key.to_s == pattern.to_s }
+          end
+          
+          return hash unless key
+          memo[key]
+        end
+      end
+
     end
   end
 end

data/lib/savon/version.rb

@@ -1,5 +1,5 @@
 module Savon
 
-  Version = "0.8.0.beta.1"
+  Version = "0.8.0.beta.2"
 
 end

data/spec/savon/savon_spec.rb

@@ -7,6 +7,7 @@ describe Savon do
       Savon.reset_config!
       example.run
       Savon.reset_config!
+      Savon.log = false  # disable logging
     end
 
     describe "log" do
@@ -51,8 +52,6 @@ describe Savon do
       it "should not raise errors when disabled" do
         Savon.raise_errors = false
         Savon.raise_errors?.should be_false
-
-        Savon.raise_errors = true  # reset to default
       end
     end
 
@@ -64,8 +63,6 @@ describe Savon do
       it "should return 2 if set to SOAP 1.2" do
         Savon.soap_version = 2
         Savon.soap_version.should == 2
-
-        Savon.soap_version = 1  # reset to default
       end
 
       it "should raise an ArgumentError in case of an invalid version" do
@@ -81,10 +78,21 @@ describe Savon do
       it "should not strip namespaces when set to false" do
         Savon.strip_namespaces = false
         Savon.strip_namespaces?.should == false
-        
-        Savon.strip_namespaces = true  # reset to default
       end
     end
 
+    describe "response_pattern" do
+      it "should default to an empty Array" do
+        Savon.response_pattern.should == []
+      end
+
+      it "should return the response pattern to apply" do
+        pattern = [/.+_response/, :return]
+        Savon.configure { |config| config.response_pattern = pattern }
+        
+        Savon.response_pattern.should == pattern
+      end
+    end
   end
+
 end

data/spec/savon/soap/response_spec.rb

@@ -116,13 +116,72 @@ describe Savon::SOAP::Response do
     end
   end
 
-  describe "#to_hash" do
+  describe "#original_hash" do
     it "should return the SOAP response body as a Hash" do
-      soap_response.to_hash[:authenticate_response][:return].should ==
+      soap_response.original_hash[:authenticate_response][:return].should ==
         ResponseFixture.authentication(:to_hash)
     end
   end
 
+  describe "#to_hash" do
+    let(:response) { soap_response }
+
+    it "should memoize the result" do
+      response.to_hash.should equal(response.to_hash)
+    end
+
+    context "without response pattern" do
+      it "should return the original Hash" do
+        response.to_hash[:authenticate_response].should be_a(Hash)
+      end
+    end
+
+    context "with response pattern" do
+      it "should apply the response pattern" do
+        Savon.response_pattern = [/.+_response/, :return]
+        response.to_hash[:success].should be_true
+        
+        Savon.response_pattern = nil  # reset to default
+      end
+    end
+
+    context "with unmatched response pattern" do
+      it "should return the original Hash" do
+        Savon.response_pattern = [:unmatched, :pattern]
+        response.to_hash.should == response.original_hash
+        
+        Savon.response_pattern = nil  # reset to default
+      end
+    end
+  end
+
+  describe "#to_array" do
+    let(:response) { soap_response }
+
+    around do |example|
+      Savon.response_pattern = [/.+_response/, :return]
+      example.run
+      Savon.response_pattern = nil  # reset to default
+    end
+
+    it "should memoize the result" do
+      response.to_array.should equal(response.to_array)
+    end
+
+    it "should return an Array for a single response element" do
+      response.to_array.should be_an(Array)
+      response.to_array.first[:success].should be_true
+    end
+
+    it "should return an Array for multiple response element" do
+      Savon.response_pattern = [/.+_response/, :history, :case]
+      list_response = soap_response :body => ResponseFixture.list
+      
+      list_response.to_array.should be_an(Array)
+      list_response.to_array.should have(2).items
+    end
+  end
+
   describe "#to_xml" do
     it "should return the raw SOAP response body" do
       soap_response.to_xml.should == ResponseFixture.authentication

data/spec/savon/wsdl/document_spec.rb

@@ -2,143 +2,110 @@ require "spec_helper"
 
 describe Savon::WSDL::Document do
 
-  context "with a remote document" do
-    let(:wsdl) { Savon::WSDL::Document.new HTTPI::Request.new, Endpoint.wsdl }
-    before { HTTPI.stubs(:get).returns(new_response) }
-
+  shared_examples_for "a WSDL document" do
     it "should be present" do
       wsdl.should be_present
     end
 
     describe "#namespace" do
       it "should return the namespace URI" do
-        wsdl.namespace.should == WSDLFixture.authentication(:namespace)
+        wsdl.namespace.should == "http://v1_0.ws.auth.order.example.com/"
       end
     end
 
     describe "#soap_actions" do
       it "should return an Array of available SOAP actions" do
-        wsdl.soap_actions.should include(*WSDLFixture.authentication(:operations).keys)
+        wsdl.soap_actions.should == [:authenticate]
       end
     end
-  end
-
-  context "with a local document" do
-    let(:wsdl) do
-      wsdl = "spec/fixtures/wsdl/xml/authentication.xml"
-      Savon::WSDL::Document.new HTTPI::Request.new, wsdl
-    end
 
-    before { HTTPI.expects(:get).never }
+    describe "#soap_action" do
+      it "should return the SOAP action for a given key" do
+        wsdl.soap_action(:authenticate).should == "authenticate"
+      end
 
-    it "should be present" do
-      wsdl.should be_present
+      it "should return nil if no SOAP action could be found" do
+        wsdl.soap_action(:unknown).should be_nil
+      end
     end
 
-    describe "#namespace" do
-      it "should return the namespace URI" do
-        wsdl.namespace.should == WSDLFixture.authentication(:namespace)
+    describe "#soap_input" do
+      it "should return the SOAP input tag for a given key" do
+        wsdl.soap_input(:authenticate).should == :authenticate
       end
-    end
 
-    describe "#soap_actions" do
-      it "should return an Array of available SOAP actions" do
-        wsdl.soap_actions.should include(*WSDLFixture.authentication(:operations).keys)
+      it "should return nil if no SOAP input tag could be found" do
+        wsdl.soap_input(:unknown).should be_nil
       end
     end
-  end
 
-  def new_response(options = {})
-    defaults = { :code => 200, :headers => {}, :body => WSDLFixture.load }
-    response = defaults.merge options
-    
-    HTTPI::Response.new(response[:code], response[:headers], response[:body])
-  end
-
-end
-__END__
-
-    it "has a getter for the namespace URI" do
-      @wsdl.namespace.should == WSDLFixture.authentication(:namespace_uri)
+    describe "#operations" do
+      it "should return a Hash of SOAP operations" do
+        wsdl.operations.should == {
+          :authenticate => {
+            :input => "authenticate", :action => "authenticate"
+          }
+        }
+      end
     end
 
-    it "has a getter for returning an Array of available SOAP actions" do
-      WSDLFixture.authentication(:operations).keys.each do |soap_action|
-        @wsdl.soap_actions.should include(soap_action)
+    describe "#document" do
+      it "should return the raw WSDL document" do
+        wsdl.document.should == WSDLFixture.load
       end
-    end
 
-    it "has a getter for returning a Hash of available SOAP operations" do
-      @wsdl.operations.should == WSDLFixture.authentication(:operations)
+      it "should be memoized" do
+        wsdl.document.should equal(wsdl.document)
+      end
     end
+  end
 
-    it "responds to SOAP actions while still behaving as usual otherwise" do
-      WSDLFixture.authentication(:operations).keys.each do |soap_action|
-        @wsdl.respond_to?(soap_action).should be_true
-      end
+  context "with a remote document" do
+    let(:wsdl) { Savon::WSDL::Document.new HTTPI::Request.new, Endpoint.wsdl }
 
-      @wsdl.respond_to?(:object_id).should be_true
-      @wsdl.respond_to?(:some_undefined_method).should be_false
+    before do
+      response = HTTPI::Response.new(200, {}, WSDLFixture.load)
+      HTTPI.stubs(:get).returns(response)
     end
 
-    it "returns the raw WSDL document for to_xml" do
-      @wsdl.to_xml.should == WSDLFixture.authentication
-    end
+    it_should_behave_like "a WSDL document"
   end
 
-  describe "a WSDL document having core sections without a namespace" do
-    before { @wsdl = new_wsdl :no_namespace }
-
-    it "returns the namespace URI" do
-      @wsdl.namespace_uri.should == WSDLFixture.no_namespace(:namespace_uri)
+  context "with a local document" do
+    let(:wsdl) do
+      wsdl = "spec/fixtures/wsdl/xml/authentication.xml"
+      Savon::WSDL::Document.new HTTPI::Request.new, wsdl
     end
 
-    it "returns an Array of available SOAP actions" do
-      WSDLFixture.no_namespace(:operations).keys.each do |soap_action|
-        @wsdl.soap_actions.should include(soap_action)
-      end
-    end
+    before { HTTPI.expects(:get).never }
 
-    it "returns a Hash of SOAP operations" do
-      @wsdl.operations.should == WSDLFixture.no_namespace(:operations)
-    end
+    it_should_behave_like "a WSDL document"
   end
 
-  describe "a WSDL document with namespaced SOAP actions" do
-    before { @wsdl = new_wsdl :namespaced_actions }
+  context "without a WSDL document" do
+    let(:wsdl) { Savon::WSDL::Document.new HTTPI::Request.new }
 
-    it "returns the namespace URI" do
-      @wsdl.namespace_uri.should == WSDLFixture.namespaced_actions(:namespace_uri)
+    it "should not be present" do
+      wsdl.should_not be_present
     end
 
-    it "returns an Array of available SOAP actions" do
-      WSDLFixture.namespaced_actions(:operations).keys.each do |soap_action|
-        @wsdl.soap_actions.should include(soap_action)
+    describe "#soap_action" do
+      it "should return nil" do
+        wsdl.soap_action(:authenticate).should be_nil
       end
     end
 
-    it "returns a Hash of SOAP operations" do
-      @wsdl.operations.should == WSDLFixture.namespaced_actions(:operations)
+    describe "#soap_input" do
+      it "should return nil" do
+        wsdl.soap_input(:authenticate).should be_nil
+      end
     end
-  end
 
-  describe "a WSDL document from geotrust" do
-    before { @wsdl = new_wsdl :geotrust }
-    
-    it "returns the namespace URI" do
-      @wsdl.namespace_uri.should == WSDLFixture.geotrust(:namespace_uri)
-    end
-    
-    it "returns an Array of available SOAP actions" do
-      WSDLFixture.geotrust(:operations).keys.each do |soap_action|
-        @wsdl.soap_actions.should include(soap_action)
+    describe "#document" do
+      it "should raise an ArgumentError" do
+        lambda { wsdl.document }.should raise_error(ArgumentError)
       end
     end
-    
-    it "returns a Hash of SOAP operations" do
-      @wsdl.operations.should == WSDLFixture.geotrust(:operations)
-    end
   end
 
-
 end

data/spec/savon/wsdl/parser_spec.rb

@@ -0,0 +1,78 @@
+require "spec_helper"
+
+describe Savon::WSDL::Parser do
+
+  context "with namespaced_actions.xml" do
+    let(:parser) { new_parser :namespaced_actions }
+
+    it "should know the target namespace" do
+      parser.namespace.should == "http://api.example.com/api/"
+    end
+
+    it "should know the SOAP endpoint" do
+      parser.endpoint.should == URI("https://api.example.com/api/api.asmx")
+    end
+
+    it "should know the available SOAP operations" do
+      parser.operations.should match_operations(
+        :get_api_key => { :input => "GetApiKey", :action => "http://api.example.com/api/User.GetApiKey" },
+        :delete_client => { :input => "DeleteClient", :action => "http://api.example.com/api/Client.Delete" },
+        :get_clients => { :input => "GetClients", :action => "http://api.example.com/api/User.GetClients" }
+      )
+    end
+  end
+
+  context "with no_namespace.xml" do
+    let(:parser) { new_parser :no_namespace }
+
+    it "should know the target namespace" do
+      parser.namespace.should == "urn:ActionWebService"
+    end
+
+    it "should know the SOAP endpoint" do
+      parser.endpoint.should == URI("http://example.com/api/api")
+    end
+
+    it "should know the available SOAP operations" do
+      parser.operations.should match_operations(
+        :search_user => { :input => "SearchUser", :action => "/api/api/SearchUser" },
+        :get_user_login_by_id => { :input => "GetUserLoginById", :action => "/api/api/GetUserLoginById" },
+        :get_all_contacts => { :input => "GetAllContacts", :action => "/api/api/GetAllContacts" }
+      )
+    end
+  end
+
+  context "with geotrust.xml" do
+    let(:parser) { new_parser :geotrust }
+
+    it "should know the target namespace" do
+      parser.namespace.should == "http://api.geotrust.com/webtrust/query"
+    end
+
+    it "should know the SOAP endpoint" do
+      parser.endpoint.should == URI("https://test-api.geotrust.com/webtrust/query.jws")
+    end
+
+    it "should know the available SOAP operations" do
+      parser.operations.should match_operations(
+        :get_quick_approver_list => { :input => "GetQuickApproverList", :action => "GetQuickApproverList" },
+        :hello => { :input => "hello", :action => "hello" }
+      )
+    end
+  end
+
+  RSpec::Matchers.define :match_operations do |expected|
+    match do |actual|
+      actual.should have(expected.keys.size).items
+      actual.keys.should include(*expected.keys)
+      actual.each { |key, value| value.should == expected[key] }
+    end
+  end
+
+  def new_parser(fixture)
+    parser = Savon::WSDL::Parser.new
+    REXML::Document.parse_stream WSDLFixture.load(fixture), parser
+    parser
+  end
+
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: savon
 version: !ruby/object:Gem::Version 
-  hash: 62196257
+  hash: 62196263
   prerelease: true
   segments: 
   - 0
   - 8
   - 0
   - beta
-  - 1
-  version: 0.8.0.beta.1
+  - 2
+  version: 0.8.0.beta.2
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-29 00:00:00 +02:00
+date: 2010-11-05 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -169,6 +169,7 @@ files:
 - spec/savon/soap/xml_spec.rb
 - spec/savon/soap_spec.rb
 - spec/savon/wsdl/document_spec.rb
+- spec/savon/wsdl/parser_spec.rb
 - spec/savon/wsdl/request_spec.rb
 - spec/savon/wsse_spec.rb
 - spec/spec_helper.rb