response.rb in smacks-savon-0.1.3

- old
+ new

@@ -2,13 +2,77 @@
 require "hpricot"
 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]
 
     # Returns the core methods to shadow.
     def self.core_methods_to_shadow
@@ -18,16 +82,10 @@
     # Sets the core +methods+ to shadow.
     def self.core_methods_to_shadow=(methods)
       @@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
     # in case the given +source+ is a Net::HTTPResponse.
     def initialize(source, root_node = nil)
@@ -41,29 +99,17 @@
     # Returns the value from a given +key+ from the response Hash.
     def [](key)
       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?
+    # 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 +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
-    end
-
     # Returns the response body in case there is any, +nil+ otherwise.
     def to_s
       return nil unless @response
       @response.body
     end
@@ -71,13 +117,13 @@
     # Intercepts calls to missing methods and returns values from the response
     # Hash in case the name of the missing +method+ matches one of its key.
     # 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
 
     # Initializes the instance from a Net::HTTPResponse. Validates the +response+
@@ -88,37 +134,22 @@
     def initialize_from_response(response, root_node = nil)
       @response = response
       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
 
     # Initializes the instance from a given +hash+.
     def initialize_from_hash(hash)
       @hash = hash
       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.
     def shadow_core_methods
       @@core_methods_to_shadow.each do |method|
@@ -129,10 +160,11 @@
     end
 
     # 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
\ No newline at end of file