smacks-savon 0.1.2 → 0.1.3

data/lib/savon/response.rb

@@ -4,9 +4,73 @@ require "apricoteatsgorilla"
 
 module Savon
 
-  # Savon::Response validates and represents the HTTP/SOAP response.
+  # Savon::HTTPResponse containes methods exclusive to a Net::HTTPResponse
+  # to be included in Savon::Response.
+  module HTTPResponse
+
+    # Returns the error code.
+    attr_reader :error_code
+
+    # Returns the error message.
+    attr_reader :error_message
+
+    # Returns +true+ in case the request was successful, +false+ otherwise
+    # or +nil+ in case there was no request at all.
+    def success?
+      return nil unless @response
+      @error_code.nil?
+    end
+
+    # Returns +false+ in case the request was not successful, +true+ otherwise
+    # or +nil+ in case there was no request at all.
+    def error?
+      return nil unless @response
+      !@error_code.nil?
+    end
+
+  private
+
+    # Validates the response against HTTP errors and SOAP faults and sets the
+    # +error_code+ and +error_message+ in case the request was not successful.
+    def validate_response
+      if @response.code.to_i >= 300
+        @error_message = @response.message
+        @error_code = @response.code
+      else
+        soap_fault = ApricotEatsGorilla[@response.body, "//soap:Fault"]
+        unless soap_fault.nil? || soap_fault.empty?
+          @error_message = soap_fault[:faultstring]
+          @error_code = soap_fault[:faultcode]
+        end
+      end
+    end
+
+    # Translates the response body into a Hash. Takes an optional +root_node+
+    # argument to start parsing the response body at a custom root node.
+    def response_to_hash(root_node = nil)
+      ApricotEatsGorilla[@response.body, root_node]
+    end
+
+  end
+
+  # Savon::Response represents the HTTP/SOAP response.
   class Response
 
+    include Savon::HTTPResponse
+
+    # The default root node to start parsing the SOAP response at.
+    @@default_root_node = "//return"
+
+    # Returns the default root node.
+    def self.default_root_node
+      @@default_root_node
+    end
+
+    # Sets the default root node.
+    def self.default_root_node=(root_node)
+      @@default_root_node = root_node if root_node.kind_of? String
+    end
+
     # The core (inherited) methods to shadow.
     @@core_methods_to_shadow = [:id]
 
@@ -20,12 +84,6 @@ module Savon
       @@core_methods_to_shadow = methods if methods.kind_of? Array
     end
 
-    # Returns the error code.
-    attr_reader :error_code
-
-    # Returns the error message.
-    attr_reader :error_message
-
     # Initializer expects the +source+ to initialize from. Sets up the instance
     # from a given Net::HTTPResponse or a Hash depending on the given +source+.
     # May be called with a custom +root_node+ to start parsing the response at
@@ -43,23 +101,11 @@ module Savon
       value_from_hash(key)
     end
 
-    # Returns +true+ in case the request was successful, +false+ otherwise
-    # or +nil+ in case there's no request at all.
-    def success?
-      return nil unless @response
-      @error_code.nil?
-    end
-
-    # Returns +false+ in case the request was not successful, +false+ otherwise
-    # or +nil+ in case there's no request at all.
-    def error?
-      return nil unless @response
-      !@error_code.nil?
-    end
-
-    # Returns the response Hash.
-    def to_hash
-      @hash
+    # Returns the response Hash. Takes an optional +root_node+ to start parsing
+    # the SOAP response at instead of the +@@default_root_node+.
+    def to_hash(root_node = nil)
+      return @hash if root_node.nil?
+      response_to_hash(root_node)
     end
 
     # Returns the response body in case there is any, +nil+ otherwise.
@@ -73,9 +119,9 @@ module Savon
     # Returns a new Savon::Response instance containing the value or returns
     # the actual value in case it is not a Hash.
     def method_missing(method, *args)
-      value = value_from_hash method
+      value = value_from_hash(method)
       return value unless value.kind_of? Hash
-      Savon::Response.new value
+      Savon::Response.new(value)
     end
 
   private
@@ -90,8 +136,8 @@ module Savon
       validate_response
 
       if success?
-        root_node ||= "//return"
-        hash = ApricotEatsGorilla[@response.body, root_node]
+        root_node ||= @@default_root_node
+        hash = response_to_hash(root_node)
         initialize_from_hash hash
       end
     end
@@ -102,21 +148,6 @@ module Savon
       shadow_core_methods
     end
 
-    # Validates the response against HTTP errors and SOAP faults and sets the
-    # +error_code+ and +error_message+ in case the request was not successful.
-    def validate_response
-      if @response.code.to_i >= 300
-        @error_message = @response.message
-        @error_code = @response.code
-      else
-        soap_fault = ApricotEatsGorilla[@response.body, "//soap:Fault"]
-        unless soap_fault.nil?
-          @error_message = soap_fault[:faultstring]
-          @error_code = soap_fault[:faultcode]
-        end
-      end
-    end
-
     # Dynamically defines methods from the Array of +@@core_methods_to_shadow+
     # to "shadow" inherited methods. Returns a value from the response Hash in
     # case a matching public method and a key from the Hash could be found.
@@ -131,8 +162,9 @@ module Savon
     # Returns a value from the response Hash. Tries to convert the given +key+
     # into a Symbol or a String to find the value to return.
     def value_from_hash(key)
+      return nil unless @hash
       @hash[key.to_sym] || @hash[key.to_s]
     end
-
   end
+
 end

data/lib/savon/service.rb

@@ -5,7 +5,7 @@ require "apricoteatsgorilla"
 
 module Savon
 
-  # Ruby SOAP client library to enjoy.
+  # Savon - Ruby SOAP client library to enjoy.
   #
   # Communicating with a SOAP webservice can be done in two lines of code.
   # Instantiate a new Savon::Service passing in the URI to the WSDL of the

data/lib/savon/wsdl.rb

@@ -4,7 +4,7 @@ require "hpricot"
 
 module Savon
 
-  # Savon::Wsdl gets, parses and represents the WSDL.
+  # Savon::Wsdl represents the WSDL.
   class Wsdl
 
     # The namespace URI.

data/test/fixtures/soap_response_fixture.rb

@@ -36,13 +36,13 @@ module SoapResponseFixture
        '<soap:Body>' <<
           '<soap:Fault>' <<
              '<faultcode>' << soap_fault_code << '</faultcode>' <<
-             '<faultstring>' << soap_fault << '</faultstring>' <<
+             '<faultstring>' << soap_fault_message << '</faultstring>' <<
           '</soap:Fault>' <<
        '</soap:Body>' <<
     '</soap:Envelope>'
   end
 
-  def soap_fault
+  def soap_fault_message
     "Failed to authenticate client."
   end
 

data/test/helper.rb

@@ -35,7 +35,7 @@ module TestHelper
     build_response_mock("200", "OK", response_body)
   end
 
-  def response_fault_mock
+  def response_error_mock
     build_response_mock("404", "NotFound")
   end
 

data/test/savon/{response_test.rb → test_response.rb}

@@ -1,18 +1,18 @@
 require File.join(File.dirname(__FILE__), "..", "helper")
 
-class SavonResponseTest < Test::Unit::TestCase
+class TestSavonResponse < Test::Unit::TestCase
 
   include TestHelper
   include SoapResponseFixture
 
   context "A Savon::Response instance" do
+    setup do
+      ApricotEatsGorilla.sort_keys = true
+      Savon::Response.core_methods_to_shadow = [:id] # set to default
+    end
 
     context "initialized with a Net::HTTPResponse containing a successful SOAP response" do
-      setup do
-        ApricotEatsGorilla.sort_keys = true
-        Savon::Response.core_methods_to_shadow = [:id] # set to default
-        @response = Savon::Response.new response_mock(some_soap_response)
-      end
+      setup { @response = Savon::Response.new response_mock(some_soap_response) }
 
       should "return that the request was successful" do
         assert_equal true, @response.success?
@@ -74,11 +74,7 @@ class SavonResponseTest < Test::Unit::TestCase
     end
 
     context "initialized with a Hash" do
-      setup do
-        ApricotEatsGorilla.sort_keys = true
-        Savon::Response.core_methods_to_shadow = [:id] # set to default
-        @response = Savon::Response.new some_response_hash
-      end
+      setup { @response = Savon::Response.new some_response_hash }
 
       should "return nil for HTTP::Response-specific methods" do
         assert_nil @response.success?
@@ -130,6 +126,66 @@ class SavonResponseTest < Test::Unit::TestCase
       end
     end
 
+    context "initialized with a Net::HTTPResponse containing a SOAP fault" do
+      setup { @response = Savon::Response.new response_mock(soap_fault_response) }
+
+      should "return that the request was not successful" do
+        assert_equal false, @response.success?
+        assert_equal true, @response.error?
+      end
+
+      should "return the error_code and error_message" do
+        assert_equal soap_fault_code, @response.error_code
+        assert_equal soap_fault_message, @response.error_message
+      end
+
+      should "return the SOAP response XML when calling to_s" do
+        assert_equal soap_fault_response, @response.to_s
+      end
+
+      should "return nil when calling to_hash" do
+        assert_nil @response.to_hash
+      end
+
+      should "return nil when trying to access Hash values through []" do
+        assert_nil @response[:some_key]
+      end
+
+      should "return nil when trying to access Hash values through method_missing" do
+        assert_nil @response.some_key
+      end
+    end
+
+    context "initialized with a Net::HTTPResponse error" do
+      setup { @response = Savon::Response.new response_error_mock }
+
+      should "return that the request was not successful" do
+        assert_equal false, @response.success?
+        assert_equal true, @response.error?
+      end
+
+      should "return the error_code and error_message" do
+        assert_equal "404", @response.error_code
+        assert_equal "NotFound", @response.error_message
+      end
+
+      should "return nil when calling to_s" do
+        assert_nil @response.to_s
+      end
+
+      should "return nil when calling to_hash" do
+        assert_nil @response.to_hash
+      end
+
+      should "return nil when trying to access Hash values through []" do
+        assert_nil @response[:some_key]
+      end
+
+      should "return nil when trying to access Hash values through method_missing" do
+        assert_nil @response.some_key
+      end
+    end
+
   end
 
 end

data/test/savon/{service_test.rb → test_service.rb}

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), "..", "helper")
 
-class SavonServiceTest < Test::Unit::TestCase
+class TestSavonService < Test::Unit::TestCase
 
   include TestHelper
   include SoapResponseFixture

data/test/savon/{wsdl_test.rb → test_wsdl.rb}

@@ -1,6 +1,6 @@
 require File.join(File.dirname(__FILE__), "..", "helper")
 
-class SavonWsdlTest < Test::Unit::TestCase
+class TestSavonWsdl < Test::Unit::TestCase
 
   include TestHelper
 

data/test/test_savon.rb

@@ -0,0 +1,4 @@
+$:.unshift(File.join(File.dirname(__FILE__), "savon"))
+require "test_service"
+require "test_wsdl"
+require "test_response"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: smacks-savon
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Daniel Harrington
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.3
+        version: 0.4.5
     version: 
 description: Ruby SOAP client library to enjoy.
 email: 
@@ -74,10 +74,10 @@ signing_key:
 specification_version: 2
 summary: Ruby SOAP client library to enjoy.
 test_files: 
-- test/savon_test.rb
+- test/test_savon.rb
 - test/helper.rb
 - test/factories/wsdl.rb
 - test/fixtures/soap_response_fixture.rb
-- test/savon/service_test.rb
-- test/savon/response_test.rb
-- test/savon/wsdl_test.rb
+- test/savon/test_service.rb
+- test/savon/test_response.rb
+- test/savon/test_wsdl.rb

data/test/savon_test.rb

@@ -1,4 +0,0 @@
-$:.unshift(File.join(File.dirname(__FILE__), "savon"))
-require "service_test"
-require "wsdl_test"
-require "response_test"