savon 0.7.9 → 0.8.0.beta.1

data/lib/savon/core_ext/object.rb

@@ -1,16 +1,24 @@
-class Object
+require "savon/core_ext/datetime"
 
-  # Returns +true+ if the Object is nil, false or empty. Implementation from ActiveSupport.
-  def blank?
-    respond_to?(:empty?) ? empty? : !self
-  end unless defined? blank?
+module Savon
+  module CoreExt
+    module Object
 
-  # Returns the Object as a SOAP request compliant value.
-  def to_soap_value
-    return to_s unless respond_to? :to_datetime
-    to_datetime.to_soap_value
-  end
+      # Returns +true+ if the Object is nil, false or empty. Implementation from ActiveSupport.
+      def blank?
+        respond_to?(:empty?) ? empty? : !self
+      end unless defined? blank?
+
+      # Returns the Object as a SOAP request compliant value.
+      def to_soap_value
+        return to_s unless respond_to? :to_datetime
+        to_datetime.to_soap_value
+      end
 
-  alias_method :to_soap_value!, :to_soap_value
+      alias_method :to_soap_value!, :to_soap_value
 
+    end
+  end
 end
+
+Object.send :include, Savon::CoreExt::Object

data/lib/savon/core_ext/string.rb

@@ -1,69 +1,74 @@
-class String
+require "cgi"
 
-  # Returns a random String of a given +length+.
-  def self.random(length = 100)
-    (0...length).map { ("a".."z").to_a[rand(26)] }.join
-  end
+require "savon/soap"
 
-  # Returns the String in snake_case.
-  def snakecase
-    str = dup
-    str.gsub! /::/, '/'
-    str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
-    str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
-    str.tr! ".", "_"
-    str.tr! "-", "_"
-    str.downcase!
-    str
-  end
+module Savon
+  module CoreExt
+    module String
 
-  # Returns the String in lowerCamelCase.
-  def lower_camelcase
-    str = dup
-    str.gsub!(/\/(.?)/) { "::#{$1.upcase}" }
-    str.gsub!(/(?:_+|-+)([a-z])/) { $1.upcase }
-    str.gsub!(/(\A|\s)([A-Z])/) { $1 + $2.downcase }
-    str
-  end
+      # Returns the String in snake_case.
+      def snakecase
+        str = dup
+        str.gsub! /::/, '/'
+        str.gsub! /([A-Z]+)([A-Z][a-z])/, '\1_\2'
+        str.gsub! /([a-z\d])([A-Z])/, '\1_\2'
+        str.tr! ".", "_"
+        str.tr! "-", "_"
+        str.downcase!
+        str
+      end
 
-  # Returns whether the String starts with a given +prefix+.
-  def starts_with?(prefix)
-    prefix = prefix.to_s
-    self[0, prefix.length] == prefix
-  end unless defined? starts_with?
+      # Returns the String in lowerCamelCase.
+      def lower_camelcase
+        str = dup
+        str.gsub!(/\/(.?)/) { "::#{$1.upcase}" }
+        str.gsub!(/(?:_+|-+)([a-z])/) { $1.upcase }
+        str.gsub!(/(\A|\s)([A-Z])/) { $1 + $2.downcase }
+        str
+      end
 
-  # Returns whether the String ends with a given +suffix+.
-  def ends_with?(suffix)
-    suffix = suffix.to_s
-    self[-suffix.length, suffix.length] == suffix
-  end unless defined? ends_with?
+      # Returns whether the String starts with a given +prefix+.
+      def starts_with?(prefix)
+        prefix = prefix.to_s
+        self[0, prefix.length] == prefix
+      end unless defined? starts_with?
 
-  # Returns the String without namespace.
-  def strip_namespace
-    split(":").last
-  end
+      # Returns whether the String ends with a given +suffix+.
+      def ends_with?(suffix)
+        suffix = suffix.to_s
+        self[-suffix.length, suffix.length] == suffix
+      end unless defined? ends_with?
 
-  # Translates SOAP response values to Ruby Objects.
-  def map_soap_response
-    return DateTime.parse(self) if Savon::SOAP::DateTimeRegexp === self
-    return true if self.strip.downcase == "true"
-    return false if self.strip.downcase == "false"
-    self
-  end
+      # Returns the String without namespace.
+      def strip_namespace
+        split(":").last
+      end
 
-  # Returns the Object as a SOAP request compliant key.
-  def to_soap_key
-    self[-1, 1] == "!" ? chop : self
-  end
+      # Translates SOAP response values to Ruby Objects.
+      def map_soap_response
+        return ::DateTime.parse(self) if Savon::SOAP::DateTimeRegexp === self
+        return true if self.strip.downcase == "true"
+        return false if self.strip.downcase == "false"
+        self
+      end
 
-  # Returns the String as a SOAP value. Escapes special characters for XML.
-  def to_soap_value
-    CGI.escapeHTML self
-  end
+      # Returns the Object as a SOAP request compliant key.
+      def to_soap_key
+        self[-1, 1] == "!" ? chop : self
+      end
 
-  # Convert the String into a SOAP value without escaping special characters.
-  def to_soap_value!
-    self
-  end
+      # Returns the String as a SOAP value. Escapes special characters for XML.
+      def to_soap_value
+        CGI.escapeHTML self
+      end
+
+      # Convert the String into a SOAP value without escaping special characters.
+      def to_soap_value!
+        self
+      end
 
+    end
+  end
 end
+
+String.send :include, Savon::CoreExt::String

data/lib/savon/core_ext/symbol.rb

@@ -1,8 +1,16 @@
-class Symbol
+require "savon/core_ext/string"
 
-  # Returns the Symbol as a lowerCamelCase String.
-  def to_soap_key
-    to_s.to_soap_key.lower_camelcase
+module Savon
+  module CoreExt
+    module Symbol
+
+      # Returns the Symbol as a lowerCamelCase String.
+      def to_soap_key
+        to_s.to_soap_key.lower_camelcase
+      end
+
+    end
   end
+end
 
-end
+Symbol.send :include, Savon::CoreExt::Symbol

data/lib/savon/error.rb

@@ -0,0 +1,6 @@
+module Savon
+
+  # Base class for Savon errors.
+  class Error < RuntimeError; end
+
+end

data/lib/savon/global.rb

@@ -0,0 +1,75 @@
+require "logger"
+require "savon/soap"
+
+module Savon
+  module Global
+
+    # Sets whether to log HTTP requests.
+    attr_writer :log
+
+    # Returns whether to log HTTP requests. Defaults to +true+.
+    def log?
+      @log != false
+    end
+
+    # Sets the logger to use.
+    attr_writer :logger
+
+    # Returns the logger. Defaults to an instance of +Logger+ writing to STDOUT.
+    def logger
+      @logger ||= ::Logger.new STDOUT
+    end
+
+    # Sets the log level.
+    attr_writer :log_level
+
+    # Returns the log level. Defaults to :debug.
+    def log_level
+      @log_level ||= :debug
+    end
+
+    # Logs a given +message+.
+    def log(message)
+      logger.send log_level, message if log?
+    end
+
+    # Sets whether to raise HTTP errors and SOAP faults.
+    attr_writer :raise_errors
+
+    # Returns whether to raise errors. Defaults to +true+.
+    def raise_errors?
+      @raise_errors != false
+    end
+
+    # Sets the global SOAP version.
+    def soap_version=(version)
+      raise ArgumentError, "Invalid SOAP version: #{version}" unless SOAP::Versions.include? version
+      @version = version
+    end
+
+    # Returns SOAP version. Defaults to +DefaultVersion+.
+    def soap_version
+      @version ||= SOAP::DefaultVersion
+    end
+
+    # Returns whether to strip namespaces in a SOAP response Hash.
+    # Defaults to +true+.
+    def strip_namespaces?
+      @strip_namespaces != false
+    end
+
+    # Sets whether to strip namespaces in a SOAP response Hash.
+    attr_writer :strip_namespaces
+
+    # Reset to default configuration.
+    def reset_config!
+      self.log = true
+      self.logger = ::Logger.new STDOUT
+      self.log_level = :debug
+      self.raise_errors = true
+      self.soap_version = SOAP::DefaultVersion
+      self.strip_namespaces = true
+    end
+
+  end
+end

data/lib/savon/http/error.rb

@@ -0,0 +1,42 @@
+require "savon/error"
+require "savon/soap/xml"
+
+module Savon
+  module HTTP
+
+    # = Savon::HTTP::Error
+    #
+    # Represents an HTTP error. Contains the original <tt>HTTPI::Response</tt>.
+    class Error < Error
+
+      # Expects an <tt>HTTPI::Response</tt>.
+      def initialize(http)
+        self.http = http
+      end
+
+      # Accessor for the <tt>HTTPI::Response</tt>.
+      attr_accessor :http
+
+      # Returns whether an HTTP error is present.
+      def present?
+        http.error?
+      end
+
+      # Returns the HTTP error message.
+      def to_s
+        return "" unless present?
+        
+        @message ||= begin
+          message = "HTTP error (#{http.code})"
+          message << ": #{http.body}" unless http.body.empty?
+        end
+      end
+
+      # Returns the HTTP response as a Hash.
+      def to_hash
+        @hash = { :code => http.code, :headers => http.headers, :body => http.body }
+      end
+
+    end
+  end
+end

data/lib/savon/soap.rb

@@ -2,121 +2,14 @@ module Savon
 
   # = Savon::SOAP
   #
-  # Savon::SOAP represents the SOAP request. Pass a block to your SOAP call and the SOAP object is
-  # passed to it as the first argument. The object allows setting the SOAP version, header, body
-  # and namespaces per request.
-  #
-  # == Body
-  #
-  # The body method lets you specify parameters to be received by the SOAP action.
-  #
-  # You can either pass in a hash (which will be translated to XML via Hash.to_soap_xml):
-  #
-  #   response = client.get_user_by_id do |soap|
-  #     soap.body = { :id => 123 }
-  #   end
-  #
-  # Or a string containing the raw XML:
-  #
-  #   response = client.get_user_by_id do |soap|
-  #     soap.body = "<id>123</id>"
-  #   end
-  #
-  # Request output:
-  #
-  #   <env:Envelope
-  #       xmlns:wsdl="http://example.com/user/1.0/UserService"
-  #       xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
-  #     <env:Body>
-  #       <wsdl:getUserById><id>123</id></wsdl:getUserById>
-  #     </env:Body>
-  #   </env:Envelope>
-  #
-  # Please look at the documentation of Hash.to_soap_xml for some more information.
-  #
-  # == Version
-  #
-  # Savon defaults to SOAP 1.1. In case your service uses SOAP 1.2, you can use the version method
-  # to change the default per request.
-  #
-  #   response = client.get_all_users do |soap|
-  #     soap.version = 2
-  #   end
-  #
-  # You can also change the default to SOAP 1.2 for all request:
-  #
-  #   Savon::SOAP.version = 2
-  #
-  # == Header
-  #
-  # If you need to add custom XML into the SOAP header, you can use the header method.
-  #
-  # The value is expected to be a hash (which will be translated to XML via Hash.to_soap_xml):
-  #
-  #   response = client.get_all_users do |soap|
-  #     soap.header["specialApiKey"] = "secret"
-  #   end
-  #
-  # Or a string containing the raw XML:
-  #
-  #   response = client.get_all_users do |soap|
-  #     soap.header = "<specialApiKey>secret</specialApiKey>"
-  #   end
-  #
-  # Request output:
-  #
-  #   <env:Envelope
-  #       xmlns:wsdl="http://example.com/user/1.0/UserService"
-  #       xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
-  #     <env:Header>
-  #       <specialApiKey>secret</specialApiKey>
-  #     </env:Header>
-  #     <env:Body>
-  #       <wsdl:getAllUsers></wsdl:getAllUsers>
-  #     </env:Body>
-  #   </env:Envelope>
-  #
-  # == Namespaces
-  #
-  # The namespaces method contains a hash of attributes for the SOAP envelope. You can overwrite it
-  # or add additional attributes.
-  #
-  #   response = client.get_all_users do |soap|
-  #     soap.namespaces["xmlns:domains"] = "http://domains.example.com"
-  #   end
-  #
-  # Request output:
-  #
-  #   <env:Envelope
-  #       xmlns:wsdl="http://example.com/user/1.0/UserService"
-  #       xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
-  #       xmlns:domains="http://domains.example.com">
-  #     <env:Body>
-  #       <wsdl:getAllUsers></wsdl:getAllUsers>
-  #     </env:Body>
-  #   </env:Envelope>
-  #
-  # == Input
-  #
-  # You can change the name of the SOAP input tag in case you need to.
-  #
-  #   response = client.get_all_users do |soap|
-  #     soap.input = "GetAllUsersRequest"
-  #   end
-  #
-  # Request output:
-  #
-  #   <env:Envelope
-  #       xmlns:wsdl="http://example.com/user/1.0/UserService"
-  #       xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
-  #     <env:Body>
-  #       <wsdl:GetAllUsersRequest></wsdl:GetAllUsersRequest>
-  #     </env:Body>
-  #   </env:Envelope>
-  class SOAP
+  # Contains various SOAP details.
+  module SOAP
+
+    # Default SOAP version.
+    DefaultVersion = 1
 
     # Supported SOAP versions.
-    Versions = [1, 2]
+    Versions = 1..2
 
     # SOAP namespaces by SOAP version.
     Namespace = {
@@ -124,179 +17,11 @@ module Savon
       2 => "http://www.w3.org/2003/05/soap-envelope"
     }
 
-    # Content-Types by SOAP version.
-    ContentType = { 1 => "text/xml", 2 => "application/soap+xml" }
-
     # SOAP xs:dateTime format.
     DateTimeFormat = "%Y-%m-%dT%H:%M:%S%Z"
 
     # SOAP xs:dateTime Regexp.
-    DateTimeRegexp = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
-
-    # The global SOAP version.
-    @@version = 1
-
-    # Returns the global SOAP version.
-    def self.version
-      @@version
-    end
-
-    # Sets the global SOAP version.
-    def self.version=(version)
-      @@version = version if Versions.include? version
-    end
-
-    # Sets the global 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.
-    def self.header=(header)
-      @@header = header
-    end
-
-    # Returns the global SOAP header. Defaults to an empty Hash.
-    def self.header
-      @@header ||= {}
-    end
-
-    # Sets the global namespaces. Expected to be a Hash containing the namespaces (keys) and the
-    # corresponding URI's (values).
-    def self.namespaces=(namespaces)
-      @@namespaces = namespaces if namespaces.kind_of? Hash
-    end
-
-    # Returns the global namespaces. A Hash containing the namespaces (keys) and the corresponding
-    # URI's (values).
-    def self.namespaces
-      @@namespaces ||= {}
-    end
-
-    # Initialzes the SOAP object. Expects a SOAP +operation+ Hash along with an +endpoint+.
-    def initialize(action, input, endpoint)
-      @action, @input = action, input
-      @endpoint = endpoint.kind_of?(URI) ? endpoint : URI(endpoint)
-      @builder = Builder::XmlMarkup.new
-    end
-
-    # Sets the WSSE options.
-    attr_writer :wsse
-
-    # Sets the SOAP action.
-    attr_writer :action
-
-    # Returns the SOAP action.
-    def action
-      @action ||= ""
-    end
-
-    # Sets the SOAP input.
-    attr_writer :input
-
-    # Returns the SOAP input.
-    def input
-      @input ||= ""
-    end
-
-    # Accessor for the SOAP endpoint.
-    attr_accessor :endpoint
-
-    # 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
-
-    # Returns the SOAP header. Defaults to an empty Hash.
-    def header
-      @header ||= {}
-    end
-
-    # Accessor for 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_accessor :body
-
-    # Accessor for overwriting the default SOAP request. Let's you specify completely custom XML.
-    attr_accessor :xml
-
-    # 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). Defaults to a Hash containing an +xmlns:env+ key and the namespace for the current
-    # SOAP version.
-    def namespaces
-      @namespaces ||= { "xmlns:env" => Namespace[version] }
-    end
-
-    # Convenience method for setting the +xmlns:wsdl+ namespace.
-    def namespace=(namespace)
-      namespaces["xmlns:wsdl"] = namespace
-    end
-
-    # Sets the SOAP version.
-    def version=(version)
-      @version = version if Versions.include? version
-    end
-
-    # Returns the SOAP version. Defaults to the global default.
-    def version
-      @version ||= self.class.version
-    end
-
-    # Returns the SOAP envelope XML.
-    def to_xml
-      unless @xml
-        @builder.instruct!
-        @xml = @builder.env :Envelope, merged_namespaces do |xml|
-          xml.env(:Header) { xml << merged_header } unless merged_header.empty?
-          xml_body xml
-        end
-      end
-      @xml
-    end
-
-  private
-
-    # Returns a String containing the global and per request header.
-    def merged_header
-      if self.class.header.kind_of?(Hash) && header.kind_of?(Hash)
-        merged_header = self.class.header.merge(header).to_soap_xml
-      else
-        global_header = self.class.header.to_soap_xml rescue self.class.header.to_s
-        request_header = header.to_soap_xml rescue header.to_s
-        merged_header = global_header + request_header
-      end
-      merged_header + wsse_header
-    end
-
-    # Returns the WSSE header or an empty String in case WSSE was not set.
-    def wsse_header
-      @wsse.respond_to?(:header) ? @wsse.header : ""
-    end
-
-    # Adds a SOAP XML body to a given +xml+ Object.
-    def xml_body(xml)
-      xml.env(:Body) do
-        xml.tag!(:wsdl, *input_array) { xml << (@body.to_soap_xml rescue @body.to_s) }
-      end
-    end
-
-    # Returns a Hash containing the global and per request namespaces.
-    def merged_namespaces
-      self.class.namespaces.merge namespaces
-    end
-
-    # Returns an Array of SOAP input names to append to the wsdl namespace. Defaults to use the
-    # name of the SOAP action. May return an empty Array in case the specified SOAP input seems
-    # to be invalid.
-    def input_array
-      if input.kind_of?(Array) && !input.blank?
-        [input[0].to_sym, input[1]]
-      elsif !input.blank?
-        [input.to_sym]
-      elsif !action.blank?
-        [action.to_sym]
-      else
-        []
-      end
-    end
+    DateTimeRegexp = /\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/
 
   end
-end
+end