johnreitano-savon 0.7.2.1

data/lib/savon/core_ext/string.rb

@@ -0,0 +1,47 @@
+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
+    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 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 without namespace.
+  def strip_namespace
+    gsub /(.+:)(.+)/, '\2'
+  end
+
+  # Translates SOAP response values to more convenient Ruby Objects.
+  def map_soap_response
+    return DateTime.parse( self ) if Savon::SOAPDateTimeRegexp === self
+    return true if self.strip.downcase == "true"
+    return false if self.strip.downcase == "false"
+    self
+  end
+
+  # Returns the String as a SOAP request compliant value.
+  def to_soap_value
+    to_s
+  end
+
+end

data/lib/savon/core_ext/symbol.rb

@@ -0,0 +1,8 @@
+class Symbol
+
+  # Returns the Symbol as a lowerCamelCase String.
+  def to_soap_key
+    to_s.lower_camelcase
+  end
+
+end

data/lib/savon/core_ext/uri.rb

@@ -0,0 +1,10 @@
+module URI
+  class HTTP
+
+    # Returns whether the URI hints to SSL.
+    def ssl?
+      /^https/ === @scheme
+    end
+
+  end
+end

data/lib/savon/core_ext.rb

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

data/lib/savon/request.rb

@@ -0,0 +1,149 @@
+module Savon
+
+  # == Savon::Request
+  #
+  # Handles both WSDL and SOAP HTTP requests.
+  class Request
+
+    # Content-Types by SOAP version.
+    ContentType = { 1 => "text/xml", 2 => "application/soap+xml" }
+
+    # Whether to log HTTP requests.
+    @@log = true
+
+    # The default logger.
+    @@logger = Logger.new STDOUT
+
+    # The default log level.
+    @@log_level = :debug
+
+    # Sets whether to log HTTP requests.
+    def self.log=(log)
+      @@log = log
+    end
+
+    # Returns whether to log HTTP requests.
+    def self.log?
+      @@log
+    end
+
+    # Sets the logger.
+    def self.logger=(logger)
+      @@logger = logger
+    end
+
+    # Returns the logger.
+    def self.logger
+      @@logger
+    end
+
+    # Sets the log level.
+    def self.log_level=(log_level)
+      @@log_level = log_level
+    end
+
+    # Returns the log level.
+    def self.log_level
+      @@log_level
+    end
+
+    # Expects a SOAP +endpoint+ String. Also accepts an optional Hash
+    # of +options+ for specifying a proxy server.
+    def initialize(endpoint, options = {})
+      @endpoint = URI endpoint
+      @proxy = options[:proxy] ? URI(options[:proxy]) : URI("")
+    end
+
+    # Returns the endpoint URI.
+    attr_reader :endpoint
+
+    # Returns the proxy URI.
+    attr_reader :proxy
+
+    # Returns the HTTP headers for a SOAP request.
+    def headers
+      @headers ||= {}
+    end
+
+    # Sets the HTTP headers for a SOAP request.
+    def headers=(headers)
+      @headers = headers if headers.kind_of? Hash
+    end
+
+    # Sets the +username+ and +password+ for HTTP basic authentication.
+    def basic_auth(username, password)
+      @basic_auth = [username, password]
+    end
+
+    # Retrieves WSDL document and returns the Net::HTTP response.
+    def wsdl
+      log "Retrieving WSDL from: #{@endpoint}"
+      http.endpoint @endpoint.host, @endpoint.port
+      http.use_ssl = @endpoint.ssl?
+      http.start { |h| h.request request(:wsdl) }
+    end
+
+    # Executes a SOAP request using a given Savon::SOAP instance and
+    # returns the Net::HTTP response.
+    def soap(soap)
+      @soap = soap
+      http.endpoint @soap.endpoint.host, @soap.endpoint.port
+      http.use_ssl = @soap.endpoint.ssl?
+
+      log_request
+      @response = http.start do |h|
+        h.request request(:soap) { |request| request.body = @soap.to_xml }
+      end
+      log_response
+      @response
+    end
+
+    # Returns the Net::HTTP object.
+    def http
+      @http ||= Net::HTTP::Proxy(@proxy.host, @proxy.port).new @endpoint.host, @endpoint.port
+    end
+
+  private
+
+    # Logs the SOAP request.
+    def log_request
+      log "SOAP request: #{@soap.endpoint}"
+      log headers.merge(soap_headers).map { |key, value| "#{key}: #{value}" }.join(", ")
+      log @soap.to_xml
+    end
+
+    # Logs the SOAP response.
+    def log_response
+      log "SOAP response (status #{@response.code}):"
+      log @response.body
+    end
+
+    # Returns a Net::HTTP request for a given +type+. Yields the request
+    # to an optional block.
+    def request(type)
+      request = case type
+        when :wsdl then Net::HTTP::Get.new @endpoint.to_s
+        when :soap then Net::HTTP::Post.new @soap.endpoint.to_s, headers.merge(soap_headers)
+      end
+      request.basic_auth *@basic_auth if @basic_auth
+      yield request if block_given?
+      request
+    end
+
+    # Returns a Hash containing the SOAP headers for an HTTP request.
+    def soap_headers
+      { "Content-Type" => ContentType[@soap.version], "SOAPAction" => @soap.action }
+    end
+
+    # Logs a given +message+.
+    def log(message)
+      self.class.logger.send self.class.log_level, message if log?
+    end
+
+    # Returns whether to log.
+    def log?
+      self.class.log? && self.class.logger.respond_to?(self.class.log_level)
+    end
+
+  end
+end

data/lib/savon/response.rb

@@ -0,0 +1,99 @@
+module Savon
+
+  # == Savon::Response
+  #
+  # Represents the HTTP and SOAP response.
+  class Response
+
+    # The global setting of whether to raise errors.
+    @@raise_errors = true
+
+    # Sets the global setting of whether to raise errors.
+    def self.raise_errors=(raise_errors)
+      @@raise_errors = raise_errors
+    end
+
+    # Returns the global setting of whether to raise errors.
+    def self.raise_errors?
+      @@raise_errors
+    end
+
+    # Expects a Net::HTTPResponse and handles errors.
+    def initialize(http)
+      @http = http
+
+      handle_soap_fault
+      handle_http_error
+    end
+
+    # Returns whether there was a SOAP fault.
+    def soap_fault?
+      @soap_fault ? true : false
+    end
+
+    # Returns the SOAP fault message.
+    attr_reader :soap_fault
+
+    # Returns whether there was an HTTP error.
+    def http_error?
+      @http_error ? true : false
+    end
+
+    # Returns the HTTP error message.
+    attr_reader :http_error
+
+    # Returns the SOAP response body as a Hash.
+    def to_hash
+      @body ||= (Crack::XML.parse(@http.body) rescue {}).find_soap_body
+    end
+
+    # Returns the SOAP response XML.
+    def to_xml
+      @http.body
+    end
+
+    # Returns the HTTP response object.
+    attr_reader :http
+	
+    alias :to_s :to_xml
+
+  private
+
+    # 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 if self.class.raise_errors?
+      end
+    end
+
+    # Returns a SOAP fault message in case a SOAP fault was found.
+    def soap_fault_message
+      @soap_fault_message ||= soap_fault_message_by_version to_hash[:fault]
+    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)
+      return unless 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 @http.code.to_i >= 300
+        @http_error = "#{@http.message} (#{@http.code})"
+        @http_error << ": #{@http.body}" unless @http.body.empty?
+        raise Savon::HTTPError, http_error if self.class.raise_errors?
+      end
+    end
+
+  end
+end

data/lib/savon/soap.rb

@@ -0,0 +1,176 @@
+module Savon
+
+  # == Savon::SOAP
+  #
+  # Represents the SOAP parameters and envelope.
+  class SOAP
+
+    # SOAP namespaces by SOAP version.
+    SOAPNamespace = {
+      1 => "http://schemas.xmlsoap.org/soap/envelope/",
+      2 => "http://www.w3.org/2003/05/soap-envelope"
+    }
+
+    # Content-Types by SOAP version.
+    ContentType = { 1 => "text/xml", 2 => "application/soap+xml" }
+
+    # 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 Savon::SOAPVersions.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.
+    def initialize
+      @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
+
+    # 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
+
+    # 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 Savon::SOAPVersions.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_body
+        @xml_body = @builder.env :Envelope, all_namespaces do |xml|
+          xml_header xml
+          xml_body xml
+        end
+      end
+      @xml_body
+    end
+
+  private
+
+    # Adds a SOAP XML header to a given +xml+ Object.
+    def xml_header(xml)
+      xml.env(:Header) do
+        xml << all_header + wsse_header
+      end
+    end
+
+    # Returns a String containing the global and per request header.
+    def all_header
+      if self.class.header.kind_of?(Hash) && header.kind_of?(Hash)
+        self.class.header.merge(header).to_soap_xml
+      else
+        self.class.header.to_s + header.to_s
+      end
+    end
+
+    # Adds a SOAP XML body to a given +xml+ Object.
+    def xml_body(xml)
+      xml.env(:Body) do
+        xml.tag!(:wsdl, *input_array) do
+          xml << (@body.to_soap_xml rescue @body.to_s)
+        end
+      end
+    end
+
+    # Returns a Hash containing the global and per request namespaces.
+    def all_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 and may be an empty Array
+    # in case the specified SOAP input seems invalid.
+    def input_array
+      return [input.to_sym] unless input.blank?
+      return [action.to_sym] unless action.blank?
+      []
+    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
+
+  end
+end