savon 2.17.2 → 3.0.0.rc1

data/lib/savon/options.rb

@@ -1,19 +1,18 @@
 # frozen_string_literal: true
-
 require "logger"
-require "httpi"
-require "savon/faraday_migration_hint"
 
 module Savon
-  # Base class for GlobalOptions and LocalOptions.
-  # Stores options in a hash, dispatches setter calls by method name,
-  # raises UnknownOptionError for anything not defined on the subclass.
   class Options
+
     def initialize(options = {})
       @options = {}
       assign options
     end
 
+    def deprecate(option)
+      raise DeprecatedOptionError.new(option)
+    end
+
     attr_reader :option_type
 
     def [](option)
@@ -22,7 +21,7 @@ module Savon
 
     def []=(option, value)
       value = [value].flatten
-      send(option, *value)
+      self.send(option, *value)
     end
 
     def include?(option)
@@ -33,7 +32,7 @@ module Savon
 
     def assign(options)
       options.each do |option, value|
-        send(option, value)
+        self.send(option, value)
       end
     end
 
@@ -42,8 +41,6 @@ module Savon
     end
   end
 
-  # Options available in both GlobalOptions and LocalOptions.
-  # Currently covers WSSE authentication and timestamp headers.
   module SharedOptions
     # WSSE auth credentials for Akami.
     # Local will override the global wsse_auth value, e.g.
@@ -52,12 +49,11 @@ module Savon
     #   global == [user, pass] && local == nil   => [user, pass]
     def wsse_auth(*credentials)
       credentials.flatten!
-      @options[:wsse_auth] =
-        if credentials.size == 1
-          credentials.first
-        else
-          credentials
-        end
+      if credentials.size == 1
+        @options[:wsse_auth] = credentials.first
+      else
+        @options[:wsse_auth] = credentials
+      end
     end
 
     # Instruct Akami to enable wsu:Timestamp headers.
@@ -74,186 +70,35 @@ module Savon
     end
   end
 
-  # Options that belong to HTTPI's transport layer.
-  #
-  # They still work with the default HTTPI transport. With `transport: :faraday`,
-  # Savon does not translate them because Faraday exposes its own setup API for
-  # proxy, timeout, TLS, auth, redirects, and adapter choices.
-  module HTTPITransportOptions
-    TRANSPORT_DEFAULTS = {
-      adapter: nil,
-      follow_redirects: false
-    }.freeze
-
-    # These are rejected for `transport: :faraday` once the caller has set a
-    # non-default value. The error points to the matching Faraday setup.
-    FARADAY_INCOMPATIBLE_GLOBALS = FaradayMigrationHint::OPTIONS
-
-    # Runs after all global options have been assigned, including options set in
-    # the client block. Reports every HTTPI-only option in one error so callers
-    # can move their transport setup to Faraday in one pass.
-    def validate_transport!
-      return unless self[:transport] == :faraday
-
-      unless faraday_loaded?
-        raise InitializationError,
-              "transport: :faraday requires the faraday gem.\n" \
-              "Add to your Gemfile: gem 'faraday'"
-      end
-
-      violations = FARADAY_INCOMPATIBLE_GLOBALS.filter_map { |option|
-        next unless include?(option)
-        next if default_transport_option?(option)
-
-        FaradayMigrationHint.new(option, self[option]).message
-      }
-
-      return if violations.empty?
-
-      raise InitializationError,
-            "The following options are not supported with transport: :faraday:\n#{violations.join("\n")}"
-    end
-
-    # Proxy server to use for all requests.
-    def proxy(proxy)
-      @options[:proxy] = proxy unless proxy.nil?
-    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
-
-    # Write timeout in seconds.
-    def write_timeout(write_timeout)
-      @options[:write_timeout] = write_timeout
-    end
-
-    # Specifies the SSL version to use.
-    def ssl_version(version)
-      @options[:ssl_version] = version
-    end
-
-    # Specifies the minimum SSL version to use.
-    def ssl_min_version(version)
-      @options[:ssl_min_version] = version
-    end
-
-    # Specifies the maximum SSL version to use.
-    def ssl_max_version(version)
-      @options[:ssl_max_version] = version
-    end
-
-    # Whether and how to verify the SSL 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 to use.
-    def ssl_cert_key(key)
-      @options[:ssl_cert_key] = key
-    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 cert to use.
-    def ssl_cert(cert)
-      @options[:ssl_cert] = cert
-    end
-
-    # Sets the CA cert file to use.
-    def ssl_ca_cert_file(file)
-      @options[:ssl_ca_cert_file] = file
-    end
-
-    # Sets the CA cert to use.
-    def ssl_ca_cert(cert)
-      @options[:ssl_ca_cert] = cert
-    end
-
-    # Sets the SSL ciphers to use.
-    def ssl_ciphers(ciphers)
-      @options[:ssl_ciphers] = ciphers
-    end
-
-    # Sets the CA cert path.
-    def ssl_ca_cert_path(path)
-      @options[:ssl_ca_cert_path] = path
-    end
-
-    # Sets the SSL cert store.
-    def ssl_cert_store(store)
-      @options[:ssl_cert_store] = store
-    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
-
-    # Instruct requests to follow HTTP redirects.
-    def follow_redirects(follow_redirects)
-      @options[:follow_redirects] = follow_redirects
-    end
-
-    # Instruct Savon which HTTPI adapter to use instead of the default.
-    def adapter(adapter)
-      @options[:adapter] = adapter
-    end
-
-    private
-
-    def default_transport_option?(option)
-      TRANSPORT_DEFAULTS.key?(option) && self[option] == TRANSPORT_DEFAULTS[option]
-    end
-
-    # Attempts to load faraday. Returns true if available, false on LoadError.
-    def faraday_loaded?
-      require "faraday"
-      true
-    rescue LoadError
-      false
-    end
-  end
-
-  # Client-level options applied to every request made by a Savon::Client instance.
-  # Covers service location, SOAP configuration, logging, response parsing,
-  # and transport selection. HTTPI-specific options (proxy, timeouts, SSL, auth)
-  # come from HTTPITransportOptions.
   class GlobalOptions < Options
     include SharedOptions
-    include HTTPITransportOptions
 
     def initialize(options = {})
       @option_type = :global
+
+      defaults = {
+        :encoding                    => "UTF-8",
+        :soap_version                => 1,
+        :namespaces                  => {},
+        :logger                      => Logger.new($stdout),
+        :log                         => false,
+        :log_headers                 => true,
+        :filters                     => [],
+        :pretty_print_xml            => false,
+        :raise_errors                => true,
+        :strip_namespaces            => true,
+        :delete_namespace_attributes => false,
+        :convert_response_tags_to    => lambda { |tag| StringUtils.snakecase(tag).to_sym},
+        :convert_attributes_to       => lambda { |k,v| [k,v] },
+        :multipart                   => false,
+        :adapter                     => nil,
+        :use_wsa_headers             => false,
+        :no_message_tag              => false,
+        :follow_redirects            => false,
+        :unwrap                      => false,
+        :host                        => nil
+      }
+
       options = defaults.merge(options)
 
       # this option is a shortcut on the logger which needs to be set
@@ -270,7 +115,7 @@ module Savon
       @options[:wsdl] = wsdl_address
     end
 
-    # Set a different host for actions in the WSDL.
+    # set different host for actions in WSDL
     def host(host)
       @options[:host] = host
     end
@@ -295,11 +140,31 @@ module Savon
       @options[:namespaces] = namespaces
     end
 
-    # A Hash of HTTP headers sent with every request.
+    # Proxy server to use for all requests.
+    def proxy(proxy)
+      @options[:proxy] = proxy unless proxy.nil?
+    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
+
+    # Write timeout in seconds.
+    def write_timeout(write_timeout)
+      @options[:write_timeout] = write_timeout
+    end
+
     # The encoding to use. Defaults to "UTF-8".
     def encoding(encoding)
       @options[:encoding] = encoding
@@ -336,19 +201,17 @@ module Savon
 
     # 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)
-      HTTPI.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 }
+      levels = { :debug => 0, :info => 1, :warn => 2, :error => 3, :fatal => 4 }
 
       unless levels.include? level
         raise ArgumentError, "Invalid log level: #{level.inspect}\n" \
@@ -358,7 +221,7 @@ module Savon
       @options[:logger].level = levels[level]
     end
 
-    # Whether to log headers.
+    # To log headers or not.
     def log_headers(log_headers)
       @options[:log_headers] = log_headers
     end
@@ -373,34 +236,104 @@ module Savon
       @options[:pretty_print_xml] = pretty_print_xml
     end
 
-    # Instruct Nori whether to strip namespaces from XML nodes.
-    def strip_namespaces(strip_namespaces)
-      @options[:strip_namespaces] = strip_namespaces
+    # Specifies the SSL version to use.
+    def ssl_version(version)
+      @options[:ssl_version] = version
     end
 
-    # Instruct Nori whether to delete namespace attributes from XML nodes.
-    def delete_namespace_attributes(delete_namespace_attributes)
-      @options[:delete_namespace_attributes] = delete_namespace_attributes
+    # Specifies the SSL version to use.
+    def ssl_min_version(version)
+      @options[:ssl_min_version] = version
     end
 
-    # The value Nori assigns to empty XML tags in the SOAP response.
-    # Defaults to nil, matching Nori's default; set to "" to map empty tags
-    # to an empty String instead.
-    def empty_tag_value(value)
-      @options[:empty_tag_value] = value
+    # Specifies the SSL version to use.
+    def ssl_max_version(version)
+      @options[:ssl_max_version] = version
     end
 
-    # Instruct Nori whether to convert dashes in response tag names to
-    # underscores before they become Hash keys. Defaults to true.
-    def convert_dashes_to_underscores(convert)
-      @options[:convert_dashes_to_underscores] = convert
+    # Whether and how to to verify the connection.
+    def ssl_verify_mode(verify_mode)
+      @options[:ssl_verify_mode] = verify_mode
     end
 
-    # Instruct Nori whether to scrub invalid byte sequences from the response
-    # body before parsing it. Defaults to true, which lets responses containing
-    # invalid characters still be parsed.
-    def scrub_xml(scrub)
-      @options[:scrub_xml] = scrub
+    # Sets the cert key file to use.
+    def ssl_cert_key_file(file)
+      deprecate('ssl_cert_key_file')
+      @options[:ssl_cert_key_file] = file
+    end
+
+    # Sets the cert key to use.
+    def ssl_cert_key(key)
+      @options[:ssl_cert_key] = key
+    end
+
+    # Sets the cert key password to use.
+    def ssl_cert_key_password(password)
+      deprecate('ssl_cert_key_password')
+      @options[:ssl_cert_key_password] = password
+    end
+
+    # Sets the cert file to use.
+    def ssl_cert_file(file)
+      deprecate('ssl_cert_file')
+      @options[:ssl_cert_file] = file
+    end
+
+    # Sets the cert to use.
+    def ssl_cert(cert)
+      @options[:ssl_cert] = cert
+    end
+
+    # Sets the ca cert file to use.
+    def ssl_ca_cert_file(file)
+      @options[:ssl_ca_cert_file] = file
+    end
+
+    # Sets the ca cert to use.
+    def ssl_ca_cert(cert)
+      deprecate('ssl_ca_cert')
+      @options[:ssl_ca_cert] = cert
+    end
+
+    def ssl_ciphers(ciphers)
+      deprecate('ssl_ciphers')
+      @options[:ssl_ciphers] = ciphers
+    end
+
+    # Sets the ca cert path.
+    def ssl_ca_cert_path(path)
+      @options[:ssl_ca_cert_path] = path
+    end
+
+    # Sets the ssl cert store.
+    def ssl_cert_store(store)
+      @options[:ssl_cert_store] = store
+    end
+
+    # HTTP basic auth credentials.
+    def basic_auth(*credentials)
+      @options[:basic_auth] = credentials.flatten
+    end
+
+    # HTTP digest auth credentials.
+    def digest_auth(*credentials)
+      deprecate('digest_auth')
+      @options[:digest_auth] = credentials.flatten
+    end
+
+    # NTLM auth credentials.
+    def ntlm(*credentials)
+      @options[:ntlm] = credentials.flatten
+    end
+
+    # Instruct Nori whether to strip namespaces from XML nodes.
+    def strip_namespaces(strip_namespaces)
+      @options[:strip_namespaces] = strip_namespaces
+    end
+
+    # Instruct Nori whether to delete namespace attributes from XML nodes.
+    def delete_namespace_attributes(delete_namespace_attributes)
+      @options[:delete_namespace_attributes] = delete_namespace_attributes
     end
 
     # Tell Gyoku how to convert Hash key Symbols to XML tags.
@@ -409,87 +342,51 @@ module Savon
       @options[:convert_request_keys_to] = converter
     end
 
-    # Tell Gyoku to unwrap Array of Hashes.
-    # Accepts a boolean, defaults to false.
+    # Tell Gyoku to unwrap Array of Hashes
+    # Accepts a boolean, default to false
     def unwrap(unwrap)
       @options[:unwrap] = unwrap
     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 converting tags to snakecase Symbols.
+    # Defaults to convert tags to snakecase Symbols.
     def convert_response_tags_to(converter = nil, &block)
       @options[:convert_response_tags_to] = block || converter
     end
 
     # Tell Nori how to convert XML attributes on 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 doing nothing.
+    # Defaults to doing nothing
     def convert_attributes_to(converter = nil, &block)
       @options[:convert_attributes_to] = block || converter
     end
 
     # Instruct Savon to create a multipart response if available.
     def multipart(multipart)
-      if multipart
-        warn "The global :multipart option has been a no-op since v2.13.0. " \
-          "Savon detects whether the response is multipart by checking if the " \
-          "response Content-Type header contains 'multipart'. You can remove" \
-          "this option from your code to make this warning disappear.", uplevel: 1
-      end
       @options[:multipart] = multipart
     end
 
+    # Instruct Savon what Faraday adapter it should use instead of default
+    def adapter(adapter)
+      @options[:adapter] = adapter
+    end
+
     # Enable inclusion of WS-Addressing headers.
     def use_wsa_headers(use)
       @options[:use_wsa_headers] = use
     end
 
-    # Suppress the message tag wrapper around the SOAP body.
     def no_message_tag(bool)
       @options[:no_message_tag] = bool
     end
 
-    # HTTP transport to use. Accepts :httpi (default) or :faraday.
-    # With :faraday, set proxy, timeout, TLS, auth, redirect, and adapter
-    # details on `client.faraday`; the HTTPI transport options are not copied.
-    def transport(transport)
-      @options[:transport] = transport
-    end
-
-    private
-
-    # The default value for every global option.
-    def defaults
-      HTTPITransportOptions::TRANSPORT_DEFAULTS.merge(
-        encoding: "UTF-8",
-        soap_version: 1,
-        namespaces: {},
-        logger: Logger.new($stdout),
-        log: false,
-        log_headers: true,
-        filters: [],
-        pretty_print_xml: false,
-        raise_errors: true,
-        strip_namespaces: true,
-        delete_namespace_attributes: false,
-        empty_tag_value: nil,
-        convert_dashes_to_underscores: true,
-        scrub_xml: true,
-        convert_response_tags_to: ->(tag) { StringUtils.snakecase(tag).to_sym },
-        convert_attributes_to: ->(k, v) { [k, v] },
-        multipart: false,
-        use_wsa_headers: false,
-        no_message_tag: false,
-        unwrap: false,
-        host: nil,
-        transport: :httpi
-      )
+    # Instruct requests to follow HTTP redirects.
+    def follow_redirects(follow_redirects)
+      @options[:follow_redirects] = follow_redirects
     end
   end
 
-  # Per-request options passed to client.call.
-  # Overrides or extends the matching GlobalOptions for a single SOAP operation.
   class LocalOptions < Options
     include SharedOptions
 
@@ -497,9 +394,10 @@ module Savon
       @option_type = :local
 
       defaults = {
-        advanced_typecasting: true,
-        response_parser: :nokogiri,
-        multipart: false
+        :advanced_typecasting => true,
+        :response_parser      => :nokogiri,
+        :multipart            => false,
+        :body                 => false
       }
 
       super defaults.merge(options)
@@ -567,7 +465,11 @@ module Savon
       @options[:soap_action] = soap_action
     end
 
-    # Cookies to be used for the next request.
+    # Cookies to be used for the next request
+    # @param [Hash] cookies cookies associated to nil will be appended as array cookies, if you need a cookie equal to
+    # and empty string, set it to ""
+    # @example cookies({accept: 'application/json', some-cookie: 'foo', "empty-cookie": "", HttpOnly: nil})
+    # # => "accept=application/json; some-cookie=foo; empty-cookie=; HttpOnly"
     def cookies(cookies)
       @options[:cookies] = cookies
     end
@@ -589,18 +491,15 @@ module Savon
 
     # Instruct Savon to create a multipart response if available.
     def multipart(multipart)
-      if multipart
-        warn "The local :multipart option has been a no-op since v2.13.0. " \
-            "Savon detects whether the response is multipart by checking if the " \
-            "response Content-Type header contains 'multipart'. You can remove" \
-            "this option from your code to make this warning disappear.", uplevel: 1
-      end
       @options[:multipart] = multipart
     end
 
-    # Per-request HTTP headers. Merged with global headers for each request.
     def headers(headers)
       @options[:headers] = headers
     end
+
+    def body(body)
+      @options[:body] = body
+    end
   end
 end

data/lib/savon/qualified_message.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 require "gyoku"
 
 module Savon
@@ -38,7 +37,7 @@ module Savon
     private
 
     def translate_tag(key)
-      Gyoku.xml_tag(key, key_converter: @key_converter).to_s
+      Gyoku.xml_tag(key, :key_converter => @key_converter).to_s
     end
 
     def add_namespaces_to_values(values, path)