savon 0.5.3 → 0.6.0

data/VERSION

@@ -1 +1 @@
-0.5.3
+0.6.0

data/lib/savon.rb

@@ -1,8 +1,5 @@
 module Savon
 
-  # Current version.
-  VERSION = "0.5.0"
-
   # Supported SOAP versions.
   SOAPVersions = [1, 2]
 
@@ -20,24 +17,17 @@ module Savon
 
 end
 
-# stdlib
-require "logger"
-require "net/http"
-require "net/https"
-require "uri"
-require "base64"
-require "digest/sha1"
-require "rexml/document"
+# standard libs
+%w(logger net/http net/https uri base64 digest/sha1 rexml/document).each do |lib|
+  require lib
+end
 
 # gems
-require "builder"
-require "crack/xml"
-
-# savon
-require "savon/core_ext"
-require "savon/validation"
-require "savon/wsse"
-require "savon/soap"
-require "savon/request"
-require "savon/wsdl"
-require "savon/client"
+%w(builder crack/xml).each do |gem|
+  require gem
+end
+
+# core files
+%w(core_ext wsse soap request response wsdl client).each do |file|
+  require "savon/#{file}"
+end

data/lib/savon/client.rb

@@ -5,41 +5,6 @@ module Savon
   # Heavy metal Ruby SOAP client library. Minimizes the overhead of working
   # with SOAP services and XML.
   class Client
-    include Validation
-
-    # Default behavior for processing the SOAP response. Expects an instance
-    # of Net::HTTPResponse and returns the SOAP response body as a Hash.
-    @response_process = lambda do |response|
-      body = Crack::XML.parse response.body
-      body = body.find_regexp [/.+:Envelope/, /.+:Body/]
-      error_handling.call response, body
-
-      body = body.find_regexp /.+/
-      (body["return"] || body).map_soap_response
-    end
-
-    # Default error handling. Expects an instance of Net::HTTPResponse and
-    # a SOAP response body Hash. Raises a Savon::SOAPFault in case of a SOAP
-    # fault or a Savon::HTTPError in case of an HTTP error.
-    @error_handling = lambda do |response, body|
-      soap_fault = body.find_regexp [/.+:Fault/]
-      soap_fault_message = soap_fault.to_soap_fault_message
-      raise Savon::SOAPFault, soap_fault_message if soap_fault_message
-
-      http_error = "#{response.message} (#{response.code})"
-      http_error += ": #{response.body}" unless response.body.empty?
-      raise Savon::HTTPError, http_error if response.code.to_i >= 300
-    end
-
-    class << self
-
-      # Accessor for the default response block.
-      attr_accessor :response_process
-
-      # Accessor for the default error handling.
-      attr_accessor :error_handling
-
-    end
 
     # Expects a SOAP +endpoint+ String.
     def initialize(endpoint)
@@ -50,48 +15,46 @@ module Savon
     # Returns the Savon::WSDL.
     attr_reader :wsdl
 
-    # Returns the Net::HTTPResponse of the last SOAP request.
-    attr_reader :response
-
-    # Behaves as usual, but also returns +true+ for available SOAP actions.
+    # Returns +true+ for available methods and SOAP actions.
     def respond_to?(method)
-      return true if @wsdl.soap_actions.include? method
+      return true if @wsdl.respond_to? method
       super
     end
 
   private
 
-    # Behaves as usual, but dispatches SOAP requests to SOAP actions matching
-    # the given +method+ name.
+    # Dispatches requests to SOAP actions matching a given +method+ name.
     def method_missing(method, *args, &block) #:doc:
-      soap_action = @wsdl.mapped_soap_actions[method]
-      super unless soap_action
-      #soap_action = "User.GetApiKey"
+      super unless @wsdl.respond_to? method
 
-      soap_body, options = args[0] || {}, args[1] || {}
-      validate_arguments! soap_body, options, block
-      dispatch soap_action, soap_body, options, block
+      setup method, &block
+      dispatch method
     end
 
-    # Dispatches a given +soap_action+ with a given +soap_body+, +options+
-    # and a +block+.
-    def dispatch(soap_action, soap_body, options, block = nil)
-      @soap = SOAP.new soap_action, soap_body, options, @wsdl.namespace_uri
-      @response = @request.soap @soap
-      response_process(block).call @response
+    # Expects a SOAP action and sets up Savon::SOAP and Savon::WSSE.
+    # Yields them to a given +block+ in case one was given.
+    def setup(soap_action, &block)
+      @soap = SOAP.new @wsdl.soap_actions[soap_action]
+      @wsse = WSSE.new
+
+      yield_parameters &block if block
+
+      @soap.namespaces["xmlns:wsdl"] = @wsdl.namespace_uri
+      @soap.wsse = @wsse
     end
 
-    # Returns the response process to use.
-    def response_process(block)
-      block || self.class.response_process
+    # Yields Savon::SOAP and Savon::WSSE to a given +block+.
+    def yield_parameters(&block)
+      case block.arity
+        when 1 then yield @soap
+        when 2 then yield @soap, @wsse
+      end
     end
 
-    # Validates the given +soap_body+, +options+ and +response_process+.
-    def validate_arguments!(soap_body, options = {}, response_process = nil)
-      validate! :soap_body, soap_body if soap_body
-      validate! :response_process, response_process if response_process
-      validate! :soap_version, options[:soap_version] if options[:soap_version]
-      validate! :wsse_credentials, options[:wsse] if options[:wsse].kind_of? Hash
+    # Dispatches a given +soap_action+ and returns a Savon::Response instance.
+    def dispatch(soap_action)
+      response = @request.soap @soap
+      Response.new response
     end
 
   end

data/lib/savon/core_ext.rb

@@ -1,6 +1,3 @@
-require "savon/core_ext/object"
-require "savon/core_ext/string"
-require "savon/core_ext/symbol"
-require "savon/core_ext/datetime"
-require "savon/core_ext/hash"
-require "savon/core_ext/uri"
+%w(object string symbol datetime hash uri).each do |file|
+  require "savon/core_ext/#{file}"
+end

data/lib/savon/core_ext/hash.rb

@@ -27,18 +27,6 @@ class Hash
     @soap_xml.target!
   end
 
-  # Tries to generate a SOAP fault message from the Hash. Returns nil in
-  # case no SOAP fault could be found or generated.
-  def to_soap_fault_message
-    if keys.include? "faultcode"
-      "(#{self['faultcode']}) #{self['faultstring']}"
-    elsif keys.include? "code"
-      "(#{self['code']['value']}) #{self['reason']['text']}"
-    else
-      nil
-    end
-  end
-
   # Maps keys and values of a Hash created from SOAP response XML to
   # more convenient Ruby Objects.
   def map_soap_response

data/lib/savon/core_ext/string.rb

@@ -1,5 +1,10 @@
 class String
 
+  # Returns a random String of a given +length+.
+  def self.random(length = 100)
+    (0...length).map { ("a".."z").to_a[rand(26)] }.join
+  end
+
   # Returns the String in snake_case.
   def snakecase
     str = dup

data/lib/savon/request.rb

@@ -1,6 +1,9 @@
 module Savon
+
+  # == Savon::Request
+  #
+  # Handles both WSDL and SOAP HTTP requests.
   class Request
-    include Validation
 
     # Content-Types by SOAP version.
     ContentType = { 1 => "text/xml", 2 => "application/soap+xml" }
@@ -30,9 +33,12 @@ module Savon
       attr_accessor :log_level
     end
 
-    # Expects an endpoint String.
+    # Expects an endpoint String. Raises an exception in case the given
+    # +endpoint+ does not seem to be valid.
     def initialize(endpoint)
-      validate! :endpoint, endpoint
+      raise ArgumentError, "Invalid endpoint: #{endpoint}" unless
+        /^(http|https):\/\// === endpoint
+
       @endpoint = URI endpoint
     end
 
@@ -45,11 +51,15 @@ module Savon
       http.get @endpoint.to_s
     end
 
-    # Executes a SOAP request using a given Savon::SOAP (+soap+) instance
-    # and returns the Net::HTTPResponse.
+    # Executes a SOAP request using a given Savon::SOAP instance and
+    # returns the Net::HTTPResponse.
     def soap(soap)
       @soap = soap
-      soap_request
+
+      log_request
+      @response = http.request_post @endpoint.path, @soap.to_xml, http_header
+      log_response
+      @response
     end
 
   private
@@ -58,15 +68,7 @@ module Savon
     def log_request
       log "SOAP request: #{@endpoint}"
       log http_header.map { |key, value| "#{key}: #{value}" }.join ", "
-      log @soap.body
-    end
-
-    # Executes a SOAP request and returns the Net::HTTPResponse.
-    def soap_request
-      log_request
-      @response = http.request_post @endpoint.path, @soap.body, http_header
-      log_response
-      @response
+      log @soap.to_xml
     end
 
     # Logs the SOAP response.

data/lib/savon/response.rb

@@ -0,0 +1,109 @@
+module Savon
+
+  # == Savon::Response
+  #
+  # Represents the HTTP and SOAP response.
+  class Response
+
+    # The default of whether to raise errors.
+    @raise_errors = true
+
+    class << self
+
+      # Sets the default of whether to raise errors.
+      attr_writer :raise_errors
+
+      # Returns the default of whether to raise errors.
+      def raise_errors?
+        @raise_errors
+      end
+
+    end
+
+    # Expects a Net::HTTPResponse and handles errors.
+    def initialize(response)
+      @response = response
+
+      handle_soap_fault
+      handle_http_error
+    end
+
+    # Returns whether there was a SOAP fault.
+    def soap_fault?
+      @soap_fault
+    end
+
+    # Returns the SOAP fault message.
+    attr_reader :soap_fault
+
+    # Returns whether there was an HTTP error.
+    def http_error?
+      @http_error
+    end
+
+    # Returns the HTTP error message.
+    attr_reader :http_error
+
+    # Returns the SOAP response as a Hash.
+    def to_hash
+      @body.find_regexp(/.+/).map_soap_response
+    end
+
+    # Returns the SOAP response XML.
+    def to_xml
+      @response.body
+    end
+
+    alias :to_s  :to_xml
+
+  private
+
+    # Returns the SOAP response body as a Hash.
+    def body
+      unless @body
+        body = Crack::XML.parse @response.body
+        @body = body.find_regexp [/.+:Envelope/, /.+:Body/]
+      end
+      @body
+    end
+
+    # Handles SOAP faults. Raises a Savon::SOAPFault unless the default
+    # behavior of raising errors was turned off.
+    def handle_soap_fault
+      if soap_fault_message
+        @soap_fault = soap_fault_message
+        raise Savon::SOAPFault, soap_fault_message if self.class.raise_errors?
+      end
+    end
+
+    # Returns a SOAP fault message in case a SOAP fault was found.
+    def soap_fault_message
+      unless @soap_fault_message
+        soap_fault = body.find_regexp [/.+:Fault/]
+        @soap_fault_message = soap_fault_message_by_version(soap_fault)
+      end
+      @soap_fault_message
+    end
+
+    # Expects a Hash that might contain information about a SOAP fault.
+    # Returns the SOAP fault message in case one was found.
+    def soap_fault_message_by_version(soap_fault)
+      if soap_fault.keys.include? "faultcode"
+        "(#{soap_fault['faultcode']}) #{soap_fault['faultstring']}"
+      elsif soap_fault.keys.include? "code"
+        "(#{soap_fault['code']['value']}) #{soap_fault['reason']['text']}"
+      end
+    end
+
+    # Handles HTTP errors. Raises a Savon::HTTPError unless the default
+    # behavior of raising errors was turned off.
+    def handle_http_error
+      if @response.code.to_i >= 300
+        @http_error = "#{@response.message} (#{@response.code})"
+        @http_error += ": #{@response.body}" unless @response.body.empty?
+        raise Savon::HTTPError, http_error if self.class.raise_errors?
+      end
+    end
+
+  end
+end

data/lib/savon/soap.rb

@@ -1,6 +1,9 @@
 module Savon
+
+  # == Savon::SOAP
+  #
+  # Represents the SOAP parameters and envelope.
   class SOAP
-    include WSSE
 
     # SOAP namespaces by SOAP version.
     SOAPNamespace = {
@@ -16,55 +19,86 @@ module Savon
 
     class << self
 
-      # Accessor for the default SOAP version.
-      attr_accessor :version
+      # Returns the default SOAP version.
+      attr_reader :version
+
+      # Sets the default SOAP version.
+      def version=(version)
+        @version = version if Savon::SOAPVersions.include? version
+      end
 
     end
 
-    # Expects a SOAP +action+, +body+, +options+ and the +namespace_uri+.
-    def initialize(action, body, options, namespace_uri)
-      @action, @body = action, body
-      @options, @namespace_uri = options, namespace_uri
+    # Expects an +action_map+ containing the name of the SOAP action and input.
+    def initialize(action_map)
+      @action = action_map[:name]
+      @input = action_map[:input]
     end
 
-    # Returns the SOAP action.
-    attr_reader :action
+    # Sets the WSSE options.
+    attr_writer :wsse
 
-    # Returns the SOAP options.
-    attr_reader :options
+    # Accessor for the SOAP action.
+    attr_accessor :action
 
-    # Returns the XML for a SOAP request.
-    def body
-      builder = Builder::XmlMarkup.new
+    # Sets the SOAP header. Expected to be a Hash that can be translated
+    # to XML via Hash.to_soap_xml or any other Object responding to to_s.
+    attr_writer :header
 
-      @xml_body ||= builder.env :Envelope, envelope_namespaces do |xml|
-        xml.env(:Header) { envelope_header xml }
-        xml.env(:Body) { envelope_body xml }
-      end
+    # Returns the SOAP header. Defaults to an empty Hash.
+    def header
+      @header ||= {}
     end
 
-    # Returns the SOAP version to use.
-    def version
-      @options[:soap_version] || self.class.version
+    # Sets the SOAP body. Expected to be a Hash that can be translated to
+    # XML via Hash.to_soap_xml or any other Object responding to to_s.
+    attr_writer :body
+
+    # Sets the namespaces. Expected to be a Hash containing the namespaces
+    # (keys) and the corresponding URI's (values).
+    attr_writer :namespaces
+
+    # Returns the namespaces. A Hash containing the namespaces (keys) and
+    # the corresponding URI's (values).
+    def namespaces
+      @namespaces ||= { "xmlns:env" => SOAPNamespace[version] }
     end
 
-  private
+    # Sets the SOAP version.
+    def version=(version)
+      @version = version if Savon::SOAPVersions.include? version
+    end
 
-    # Returns a Hash of namespaces for the SOAP envelope.
-    def envelope_namespaces
-      { "xmlns:env" => SOAPNamespace[version], "xmlns:wsdl" => @namespace_uri }
+    # Returns the SOAP version. Defaults to the global default.
+    def version
+      @version ||= self.class.version
     end
 
-    # Expects an instance of Builder::XmlMarkup and returns the XML for the
-    # SOAP envelope header.
-    def envelope_header(xml)
-      wsse_header xml if wsse?
+    # Returns the SOAP envelope XML.
+    def to_xml
+      unless @xml_body
+        builder = Builder::XmlMarkup.new
+
+        @xml_body = builder.env :Envelope, namespaces do |xml|
+          xml.env(:Header) do
+            xml << (header.to_soap_xml rescue header.to_s) + wsse_header
+          end
+          xml.env(:Body) do
+            xml.wsdl(@input.to_sym) do
+              xml << (@body.to_soap_xml rescue @body.to_s)
+            end
+          end
+        end
+      end
+      @xml_body
     end
 
-    # Expects an instance of Builder::XmlMarkup and returns the XML for the
-    # SOAP envelope body.
-    def envelope_body(xml)
-      xml.wsdl(@action.to_sym) { xml << (@body.to_soap_xml rescue @body.to_s) }
+  private
+
+    # Returns the WSSE header or an empty String in case WSSE was not set.
+    def wsse_header
+      return "" unless @wsse.respond_to? :header
+      @wsse.header
     end
 
   end