troelskn-handsoap 0.3.1 → 0.3.2

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :minor: 3
-:patch: 1
+:patch: 2
 :major: 0

data/lib/handsoap/service.rb

@@ -104,26 +104,9 @@ module Handsoap
     def self.request_content_type
       @protocol_version == 1 ? "text/xml" : "application/soap+xml"
     end
-    def self.map_method(mapping)
-      if @mapping.nil?
-        @mapping = {}
-      end
-      @mapping.merge! mapping
-    end
-    def self.on_create_document(&block)
-      @create_document_callback = block
-    end
-    def self.fire_on_create_document(doc)
-      if @create_document_callback
-        @create_document_callback.call doc
-      end
-    end
     def self.uri
       @uri
     end
-    def self.get_mapping(name)
-      @mapping[name] if @mapping
-    end
     @@instance = {}
     def self.instance
       @@instance[self.to_s] ||= self.new
@@ -135,14 +118,6 @@ module Handsoap
         super
       end
     end
-    def method_missing(method, *args)
-      action = self.class.get_mapping(method)
-      if action
-        invoke(action, *args)
-      else
-        super
-      end
-    end
     # Creates an XML document and sends it over HTTP.
     #
     # +action+ is the QName of the rootnode of the envelope.
@@ -173,60 +148,38 @@ module Handsoap
         dispatch(doc, options[:soap_action])
       end
     end
+    # Hook that is called when a new request document is created.
+    #
+    # You can override this to add namespaces and other elements that are common to all requests (Such as authentication).
+    def on_create_document(doc)
+    end
     # Hook that is called before the message is dispatched.
     #
     # You can override this to provide filtering and logging.
     def on_before_dispatch
     end
-    # Hook that is called if the dispatch returns a +Fault+.
+    # Hook that is called when there is a response.
     #
-    # Default behaviour is to raise the Fault, but you can override this to provide logging and more fine-grained handling faults.
-    def on_fault(fault)
-      raise fault
+    # You can override this to register common namespaces, useful for parsing the document.
+    def on_response_document(doc)
     end
-    private
-    # Helper to serialize a node into a ruby string
+    # Hook that is called if there is a HTTP level error.
     #
-    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_s
-    def xml_to_str(node, xquery = nil)
-      n = xquery ? node.xpath(xquery, ns).first : node
-      return if n.nil?
-      n.to_utf8
+    # Default behaviour is to raise an error.
+    def on_http_error(status, content)
+      raise "HTTP error #{status}"
     end
-    alias_method :xml_to_s, :xml_to_str
-    # Helper to serialize a node into a ruby integer
-    #
-    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_i
-    def xml_to_int(node, xquery = nil)
-      n = xquery ? node.xpath(xquery, ns).first : node
-      return if n.nil?
-      n.to_s.to_i
-    end
-    alias_method :xml_to_i, :xml_to_int
-    # Helper to serialize a node into a ruby float
-    #
-    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_f
-    def xml_to_float(node, xquery = nil)
-      n = xquery ? node.xpath(xquery, ns).first : node
-      return if n.nil?
-      n.to_s.to_f
-    end
-    alias_method :xml_to_f, :xml_to_float
-    # Helper to serialize a node into a ruby boolean
+    # Hook that is called if the dispatch returns a +Fault+.
     #
-    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_boolean
-    def xml_to_bool(node, xquery = nil)
-      n = xquery ? node.xpath(xquery, ns).first : node
-      return if n.nil?
-      n.to_s == "true"
+    # Default behaviour is to raise the Fault, but you can override this to provide logging and more fine-grained handling faults.
+    def on_fault(fault)
+      raise fault
     end
-    # Helper to serialize a node into a ruby Time object
+    # Hook that is called if the response does not contain a valid SOAP enevlope.
     #
-    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_date
-    def xml_to_date(node, xquery = nil)
-      n = xquery ? node.xpath(xquery, ns).first : node
-      return if n.nil?
-      Time.iso8601(n.to_s)
+    # Default behaviour is to raise an error
+    def on_missing_document(soap_response)
+      raise "The response is not a valid SOAP envelope"
     end
     def debug(message = nil) #:nodoc:
       if @@logger
@@ -238,7 +191,21 @@ module Handsoap
         end
       end
     end
-    # Takes care of the HTTP level dispatch.
+    # Does the actual HTTP level interaction.
+    def send_http_request(uri, post_body, headers)
+      if Handsoap.http_driver == :curb
+        http_client = Curl::Easy.new(uri)
+        http_client.headers = headers
+        http_client.http_post post_body
+        return { :status => http_client.response_code, :body => http_client.body_str, :content_type => response.contenttype }
+      elsif Handsoap.http_driver == :httpclient
+        response = HTTPClient.new.post(uri, post_body, headers)
+        return { :status => response.status, :body => response.content, :content_type => response.content_type }
+      else
+        raise "Unknown http driver #{Handsoap.http_driver}"
+      end
+    end
+    # Send document and parses the response into a +Response+
     def dispatch(doc, action)
       on_before_dispatch
       headers = {
@@ -254,34 +221,25 @@ module Handsoap
         logger.puts "---"
         logger.puts body
       end
-      if Handsoap.http_driver == :curb
-        http_client = Curl::Easy.new(self.class.uri)
-        http_client.headers = headers
-        http_client.http_post body
-        debug do |logger|
-          logger.puts "--- Response ---"
-          logger.puts "HTTP Status: %s" % [http_client.response_code]
-          logger.puts "Content-Type: %s" % [http_client.content_type]
-          logger.puts "---"
-          logger.puts Handsoap.pretty_format_envelope(http_client.body_str)
-        end
-        soap_response = Response.new(http_client.body_str, self.class.envelope_namespace)
-      elsif Handsoap.http_driver == :httpclient
-        response = HTTPClient.new.post(self.class.uri, body, headers)
-        debug do |logger|
-          logger.puts "--- Response ---"
-          logger.puts "HTTP Status: %s" % [response.status]
-          logger.puts "Content-Type: %s" % [response.contenttype]
-          logger.puts "---"
-          logger.puts Handsoap.pretty_format_envelope(response.content)
-        end
-        soap_response = Response.new(response.content, self.class.envelope_namespace)
-      else
-        raise "Unknown http driver #{Handsoap.http_driver}"
+      response = send_http_request(self.class.uri, body, headers)
+      debug do |logger|
+        logger.puts "--- Response ---"
+        logger.puts "HTTP Status: %s" % [response[:status]]
+        logger.puts "Content-Type: %s" % [response[:content_type]]
+        logger.puts "---"
+        logger.puts Handsoap.pretty_format_envelope(response[:body])
+      end
+      if response[:status] >= 300
+        return on_http_error(response[:status], response[:body])
       end
+      soap_response = Response.new(response[:body], self.class.envelope_namespace)
       if soap_response.fault?
-        return self.on_fault(soap_response.fault)
+        return on_fault(soap_response.fault)
       end
+      unless soap_response.document?
+        return on_missing_document(soap_response)
+      end
+      on_response_document(soap_response.document)
       return soap_response
     end
     # Creates a standard SOAP envelope and yields the +Body+ element.
@@ -293,7 +251,8 @@ module Handsoap
           env.add "*:Body"
         end
       end
-      self.class.fire_on_create_document doc
+      self.class.fire_on_create_document doc # deprecated .. use instance method
+      on_create_document(doc)
       if block_given?
         yield doc.find("Body")
       end
@@ -315,3 +274,84 @@ module Handsoap
   end
 
 end
+
+# Legacy/CS code here. This shouldn't be used in new applications.
+module Handsoap
+  class Service
+    # Registers a simple method mapping without any arguments and no parsing of response.
+    #
+    # This is deprecated
+    def self.map_method(mapping)
+      if @mapping.nil?
+        @mapping = {}
+      end
+      @mapping.merge! mapping
+    end
+    def self.get_mapping(name)
+      @mapping[name] if @mapping
+    end
+    def method_missing(method, *args)
+      action = self.class.get_mapping(method)
+      if action
+        invoke(action, *args)
+      else
+        super
+      end
+    end
+    # Registers a block to call when a request document is created.
+    #
+    # This is deprecated, in favour of #on_create_document
+    def self.on_create_document(&block)
+      @create_document_callback = block
+    end
+    def self.fire_on_create_document(doc)
+      if @create_document_callback
+        @create_document_callback.call doc
+      end
+    end
+    private
+    # Helper to serialize a node into a ruby string
+    #
+    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_s
+    def xml_to_str(node, xquery = nil)
+      n = xquery ? node.xpath(xquery, ns).first : node
+      return if n.nil?
+      n.to_s
+    end
+    alias_method :xml_to_s, :xml_to_str
+    # Helper to serialize a node into a ruby integer
+    #
+    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_i
+    def xml_to_int(node, xquery = nil)
+      n = xquery ? node.xpath(xquery, ns).first : node
+      return if n.nil?
+      n.to_s.to_i
+    end
+    alias_method :xml_to_i, :xml_to_int
+    # Helper to serialize a node into a ruby float
+    #
+    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_f
+    def xml_to_float(node, xquery = nil)
+      n = xquery ? node.xpath(xquery, ns).first : node
+      return if n.nil?
+      n.to_s.to_f
+    end
+    alias_method :xml_to_f, :xml_to_float
+    # Helper to serialize a node into a ruby boolean
+    #
+    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_boolean
+    def xml_to_bool(node, xquery = nil)
+      n = xquery ? node.xpath(xquery, ns).first : node
+      return if n.nil?
+      n.to_s == "true"
+    end
+    # Helper to serialize a node into a ruby Time object
+    #
+    # *deprecated*. Use Handsoap::XmlQueryFront::BaseDriver#to_date
+    def xml_to_date(node, xquery = nil)
+      n = xquery ? node.xpath(xquery, ns).first : node
+      return if n.nil?
+      Time.iso8601(n.to_s)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: troelskn-handsoap
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Troels Knak-Nielsen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-23 00:00:00 -07:00
+date: 2009-06-24 00:00:00 -07:00
 default_executable: 
 dependencies: []