savon_with_adapter 2.4.1

data/lib/savon/options.rb

@@ -0,0 +1,336 @@
+require "logger"
+require "httpi"
+
+module Savon
+  class Options
+
+    def initialize(options = {})
+      @options = {}
+      assign options
+    end
+
+    attr_reader :option_type
+
+    def [](option)
+      @options[option]
+    end
+
+    def []=(option, value)
+      value = [value].flatten
+      self.send(option, *value)
+    end
+
+    def include?(option)
+      @options.key? option
+    end
+
+    private
+
+    def assign(options)
+      options.each do |option, value|
+        self.send(option, value)
+      end
+    end
+
+    def method_missing(option, _)
+      raise UnknownOptionError, "Unknown #{option_type} option: #{option.inspect}"
+    end
+
+  end
+
+  class GlobalOptions < Options
+
+    def initialize(options = {})
+      @option_type = :global
+
+      defaults = {
+        :encoding                  => "UTF-8",
+        :soap_version              => 1,
+        :namespaces                => {},
+        :logger                    => Logger.new($stdout),
+        :log                       => false,
+        :filters                   => [],
+        :pretty_print_xml          => false,
+        :raise_errors              => true,
+        :strip_namespaces          => true,
+        :convert_response_tags_to  => lambda { |tag| tag.snakecase.to_sym},
+        :multipart                 => false,
+        :adapter                   => nil,
+      }
+
+      options = defaults.merge(options)
+
+      # this option is a shortcut on the logger which needs to be set
+      # before it can be modified to set the option.
+      delayed_level = options.delete(:log_level)
+
+      super(options)
+
+      log_level(delayed_level) unless delayed_level.nil?
+    end
+
+    # Location of the local or remote WSDL document.
+    def wsdl(wsdl_address)
+      @options[:wsdl] = wsdl_address
+    end
+
+    # SOAP endpoint.
+    def endpoint(endpoint)
+      @options[:endpoint] = endpoint
+    end
+
+    # Target namespace.
+    def namespace(namespace)
+      @options[:namespace] = namespace
+    end
+
+    # The namespace identifer.
+    def namespace_identifier(identifier)
+      @options[:namespace_identifier] = identifier
+    end
+
+    # Namespaces for the SOAP envelope.
+    def namespaces(namespaces)
+      @options[:namespaces] = namespaces
+    end
+
+    # Proxy server to use for all requests.
+    def proxy(proxy)
+      @options[:proxy] = proxy
+    end
+
+    # A Hash of HTTP headers.
+    def headers(headers)
+      @options[:headers] = headers
+    end
+
+    # Open timeout in seconds.
+    def open_timeout(open_timeout)
+      @options[:open_timeout] = open_timeout
+    end
+
+    # Read timeout in seconds.
+    def read_timeout(read_timeout)
+      @options[:read_timeout] = read_timeout
+    end
+
+    # The encoding to use. Defaults to "UTF-8".
+    def encoding(encoding)
+      @options[:encoding] = encoding
+    end
+
+    # The global SOAP header. Expected to be a Hash or responding to #to_s.
+    def soap_header(header)
+      @options[:soap_header] = header
+    end
+
+    # Sets whether elements should be :qualified or unqualified.
+    # If you need to use this option, please open an issue and make
+    # sure to add your WSDL document for debugging.
+    def element_form_default(element_form_default)
+      @options[:element_form_default] = element_form_default
+    end
+
+    # Can be used to change the SOAP envelope namespace identifier.
+    # If you need to use this option, please open an issue and make
+    # sure to add your WSDL document for debugging.
+    def env_namespace(env_namespace)
+      @options[:env_namespace] = env_namespace
+    end
+
+    # Changes the SOAP version to 1 or 2.
+    def soap_version(soap_version)
+      @options[:soap_version] = soap_version
+    end
+
+    # Whether or not to raise SOAP fault and HTTP errors.
+    def raise_errors(raise_errors)
+      @options[:raise_errors] = raise_errors
+    end
+
+    # Whether or not to log.
+    def log(log)
+      HTTPI.log = log
+      @options[:log] = log
+    end
+
+    # The logger to use. Defaults to a Savon::Logger instance.
+    def logger(logger)
+      @options[:logger] = logger
+    end
+
+    # Changes the Logger's log level.
+    def log_level(level)
+      levels = { :debug => 0, :info => 1, :warn => 2, :error => 3, :fatal => 4 }
+
+      unless levels.include? level
+        raise ArgumentError, "Invalid log level: #{level.inspect}\n" \
+                             "Expected one of: #{levels.keys.inspect}"
+      end
+
+      @options[:logger].level = levels[level]
+    end
+
+    # A list of XML tags to filter from logged SOAP messages.
+    def filters(*filters)
+      @options[:filters] = filters.flatten
+    end
+
+    # Whether to pretty print request and response XML log messages.
+    def pretty_print_xml(pretty_print_xml)
+      @options[:pretty_print_xml] = pretty_print_xml
+    end
+
+    # Specifies the SSL version to use.
+    def ssl_version(version)
+      @options[:ssl_version] = version
+    end
+
+    # Whether and how to to verify the connection.
+    def ssl_verify_mode(verify_mode)
+      @options[:ssl_verify_mode] = verify_mode
+    end
+
+    # Sets the cert key file to use.
+    def ssl_cert_key_file(file)
+      @options[:ssl_cert_key_file] = file
+    end
+
+    # Sets the cert key password to use.
+    def ssl_cert_key_password(password)
+      @options[:ssl_cert_key_password] = password
+    end
+
+    # Sets the cert file to use.
+    def ssl_cert_file(file)
+      @options[:ssl_cert_file] = file
+    end
+
+    # Sets the ca cert file to use.
+    def ssl_ca_cert_file(file)
+      @options[:ssl_ca_cert_file] = file
+    end
+
+    # HTTP basic auth credentials.
+    def basic_auth(*credentials)
+      @options[:basic_auth] = credentials.flatten
+    end
+
+    # HTTP digest auth credentials.
+    def digest_auth(*credentials)
+      @options[:digest_auth] = credentials.flatten
+    end
+
+    # NTLM auth credentials.
+    def ntlm(*credentials)
+      @options[:ntlm] = credentials.flatten
+    end
+
+    # WSSE auth credentials for Akami.
+    def wsse_auth(*credentials)
+      @options[:wsse_auth] = credentials.flatten
+    end
+
+    # Instruct Akami to enable wsu:Timestamp headers.
+    def wsse_timestamp(*timestamp)
+      @options[:wsse_timestamp] = timestamp.flatten
+    end
+
+    # Instruct Nori whether to strip namespaces from XML nodes.
+    def strip_namespaces(strip_namespaces)
+      @options[:strip_namespaces] = strip_namespaces
+    end
+
+    # Tell Gyoku how to convert Hash key Symbols to XML tags.
+    # Accepts one of :lower_camelcase, :camelcase, :upcase, or :none.
+    def convert_request_keys_to(converter)
+      @options[:convert_request_keys_to] = converter
+    end
+
+    # Tell Nori how to convert XML tags from the SOAP response into Hash keys.
+    # Accepts a lambda or a block which receives an XML tag and returns a Hash key.
+    # Defaults to convert tags to snakecase Symbols.
+    def convert_response_tags_to(converter = nil, &block)
+      @options[:convert_response_tags_to] = block || converter
+    end
+
+    # Instruct Savon to create a multipart response if available.
+    def multipart(multipart)
+      @options[:multipart] = multipart
+    end
+
+    # Instruct Savon what HTTPI adapter it should use instead of default
+    def adapter(adapter)
+      @options[:adapter] = adapter
+    end
+  end
+
+  class LocalOptions < Options
+
+    def initialize(options = {})
+      @option_type = :local
+
+      defaults = {
+        :advanced_typecasting => true,
+        :response_parser      => :nokogiri,
+        :multipart            => false
+      }
+
+      super defaults.merge(options)
+    end
+
+    # The local SOAP header. Expected to be a Hash or respond to #to_s.
+    # Will be merged with the global SOAP header if both are Hashes.
+    # Otherwise the local option will be prefered.
+    def soap_header(header)
+      @options[:soap_header] = header
+    end
+
+    # The SOAP message to send. Expected to be a Hash or a String.
+    def message(message)
+      @options[:message] = message
+    end
+
+    # SOAP message tag (formerly known as SOAP input tag). If it's not set, Savon retrieves the name from
+    # the WSDL document (if available). Otherwise, Gyoku converts the operation name into an XML element.
+    def message_tag(message_tag)
+      @options[:message_tag] = message_tag
+    end
+
+    # Attributes for the SOAP message tag.
+    def attributes(attributes)
+      @options[:attributes] = attributes
+    end
+
+    # Value of the SOAPAction HTTP header.
+    def soap_action(soap_action)
+      @options[:soap_action] = soap_action
+    end
+
+    # Cookies to be used for the next request.
+    def cookies(cookies)
+      @options[:cookies] = cookies
+    end
+
+    # The SOAP request XML to send. Expected to be a String.
+    def xml(xml)
+      @options[:xml] = xml
+    end
+
+    # Instruct Nori to use advanced typecasting.
+    def advanced_typecasting(advanced)
+      @options[:advanced_typecasting] = advanced
+    end
+
+    # Instruct Nori to use :rexml or :nokogiri to parse the response.
+    def response_parser(parser)
+      @options[:response_parser] = parser
+    end
+
+    # Instruct Savon to create a multipart response if available.
+    def multipart(multipart)
+      @options[:multipart] = multipart
+    end
+
+  end
+end

data/lib/savon/qualified_message.rb

@@ -0,0 +1,49 @@
+require "gyoku"
+
+module Savon
+  class QualifiedMessage
+
+    def initialize(types, used_namespaces, key_converter)
+      @types = types
+      @used_namespaces = used_namespaces
+      @key_converter = key_converter
+    end
+
+    def to_hash(hash, path)
+      return unless hash
+      return hash.map { |value| to_hash(value, path) } if hash.kind_of?(Array)
+      return hash.to_s unless hash.kind_of? Hash
+
+      hash.inject({}) do |newhash, (key, value)|
+        if key == :order!
+          add_namespaces_to_values(value, path)
+          newhash.merge(key => value)
+        else
+          translated_key = Gyoku.xml_tag(key, :key_converter => @key_converter).to_s
+          newpath = path + [translated_key]
+
+          if @used_namespaces[newpath]
+            newhash.merge(
+              "#{@used_namespaces[newpath]}:#{translated_key}" =>
+                to_hash(value, @types[newpath] ? [@types[newpath]] : newpath)
+            )
+          else
+            newhash.merge(translated_key => value)
+          end
+        end
+      end
+    end
+
+    private
+
+    def add_namespaces_to_values(values, path)
+      values.collect! { |value|
+        camelcased_value = Gyoku.xml_tag(value, :key_converter => @key_converter)
+        namespace_path = path + [camelcased_value.to_s]
+        namespace = @used_namespaces[namespace_path]
+        "#{namespace.blank? ? '' : namespace + ":"}#{camelcased_value}"
+      }
+    end
+
+  end
+end

data/lib/savon/request.rb

@@ -0,0 +1,89 @@
+require "httpi"
+
+module Savon
+  class HTTPRequest
+
+    def initialize(globals, http_request = nil)
+      @globals = globals
+      @http_request = http_request || HTTPI::Request.new
+    end
+
+    def build
+      @http_request
+    end
+
+    private
+
+    def configure_proxy
+      @http_request.proxy = @globals[:proxy] if @globals.include? :proxy
+    end
+
+    def configure_timeouts
+      @http_request.open_timeout = @globals[:open_timeout] if @globals.include? :open_timeout
+      @http_request.read_timeout = @globals[:read_timeout] if @globals.include? :read_timeout
+    end
+
+    def configure_ssl
+      @http_request.auth.ssl.ssl_version   = @globals[:ssl_version]       if @globals.include? :ssl_version
+      @http_request.auth.ssl.verify_mode   = @globals[:ssl_verify_mode]   if @globals.include? :ssl_verify_mode
+
+      @http_request.auth.ssl.cert_key_file = @globals[:ssl_cert_key_file] if @globals.include? :ssl_cert_key_file
+      @http_request.auth.ssl.cert_file     = @globals[:ssl_cert_file]     if @globals.include? :ssl_cert_file
+      @http_request.auth.ssl.ca_cert_file  = @globals[:ssl_ca_cert_file]  if @globals.include? :ssl_ca_cert_file
+
+      @http_request.auth.ssl.cert_key_password = @globals[:ssl_cert_key_password] if @globals.include? :ssl_cert_key_password
+    end
+
+    def configure_auth
+      @http_request.auth.basic(*@globals[:basic_auth])   if @globals.include? :basic_auth
+      @http_request.auth.digest(*@globals[:digest_auth]) if @globals.include? :digest_auth
+      @http_request.auth.ntlm(*@globals[:ntlm])          if @globals.include? :ntlm
+    end
+
+  end
+
+  class WSDLRequest < HTTPRequest
+
+    def build
+      configure_proxy
+      configure_timeouts
+      configure_ssl
+      configure_auth
+
+      @http_request
+    end
+
+  end
+
+  class SOAPRequest < HTTPRequest
+
+    CONTENT_TYPE = {
+      1 => "text/xml;charset=%s",
+      2 => "application/soap+xml;charset=%s"
+    }
+
+    def build(options = {})
+      configure_proxy
+      configure_cookies options[:cookies]
+      configure_timeouts
+      configure_headers options[:soap_action]
+      configure_ssl
+      configure_auth
+
+      @http_request
+    end
+
+    private
+
+    def configure_cookies(cookies)
+      @http_request.set_cookies(cookies) if cookies
+    end
+
+    def configure_headers(soap_action)
+      @http_request.headers = @globals[:headers] if @globals.include? :headers
+      @http_request.headers["SOAPAction"]   ||= %{"#{soap_action}"} if soap_action
+      @http_request.headers["Content-Type"] ||= CONTENT_TYPE[@globals[:soap_version]] % @globals[:encoding]
+    end
+
+  end
+end