savon 2.11.1 → 2.15.1

data/lib/savon/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "logger"
 require "httpi"
 
@@ -73,24 +74,26 @@ module Savon
       @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},
-        :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
+        :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)
@@ -136,7 +139,7 @@ module Savon
 
     # Proxy server to use for all requests.
     def proxy(proxy)
-      @options[:proxy] = proxy
+      @options[:proxy] = proxy unless proxy.nil?
     end
 
     # A Hash of HTTP headers.
@@ -154,6 +157,11 @@ module Savon
       @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
@@ -212,6 +220,11 @@ module Savon
       @options[:logger].level = levels[level]
     end
 
+    # To log headers or not.
+    def log_headers(log_headers)
+      @options[:log_headers] = log_headers
+    end
+
     # A list of XML tags to filter from logged SOAP messages.
     def filters(*filters)
       @options[:filters] = filters.flatten
@@ -227,6 +240,16 @@ module Savon
       @options[:ssl_version] = version
     end
 
+    # Specifies the SSL version to use.
+    def ssl_min_version(version)
+      @options[:ssl_min_version] = version
+    end
+
+    # Specifies the SSL version to use.
+    def ssl_max_version(version)
+      @options[:ssl_max_version] = version
+    end
+
     # Whether and how to to verify the connection.
     def ssl_verify_mode(verify_mode)
       @options[:ssl_verify_mode] = verify_mode
@@ -267,6 +290,19 @@ module Savon
       @options[:ssl_ca_cert] = cert
     end
 
+    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)
@@ -288,6 +324,11 @@ module Savon
       @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.
     # Accepts one of :lower_camelcase, :camelcase, :upcase, or :none.
     def convert_request_keys_to(converter)
@@ -377,6 +418,40 @@ module Savon
       @options[:attributes] = attributes
     end
 
+    # Attachments for the SOAP message (https://www.w3.org/TR/SOAP-attachments)
+    #
+    # should pass an Array or a Hash; items should be path strings or
+    #  { filename: 'file.name', content: 'content' } objects
+    # The Content-ID in multipart message sections will be the filename or the key if Hash is given
+    #
+    # usage examples:
+    #
+    #    response = client.call :operation1 do
+    #      message param1: 'value'
+    #      attachments [
+    #        { filename: 'x1.xml', content: '<xml>abc</xml>'},
+    #        { filename: 'x2.xml', content: '<xml>abc</xml>'}
+    #      ]
+    #    end
+    #    # Content-ID will be x1.xml and x2.xml
+    #
+    #    response = client.call :operation1 do
+    #      message param1: 'value'
+    #      attachments 'x1.xml' => '/tmp/1281ab7d7d.xml', 'x2.xml' => '/tmp/4c5v8e833a.xml'
+    #    end
+    #    # Content-ID will be x1.xml and x2.xml
+    #
+    #    response = client.call :operation1 do
+    #      message param1: 'value'
+    #      attachments [ '/tmp/1281ab7d7d.xml', '/tmp/4c5v8e833a.xml']
+    #    end
+    #    # Content-ID will be 1281ab7d7d.xml and 4c5v8e833a.xml
+    #
+    # The Content-ID is important if you want to refer to the attachments from the SOAP request
+    def attachments(attachments)
+      @options[:attachments] = attachments
+    end
+
     # Value of the SOAPAction HTTP header.
     def soap_action(soap_action)
       @options[:soap_action] = soap_action
@@ -406,5 +481,9 @@ module Savon
     def multipart(multipart)
       @options[:multipart] = multipart
     end
+
+    def headers(headers)
+      @options[:headers] = headers
+    end
   end
 end

data/lib/savon/qualified_message.rb

@@ -1,50 +1,52 @@
+# frozen_string_literal: true
 require "gyoku"
 
 module Savon
   class QualifiedMessage
-
     def initialize(types, used_namespaces, key_converter)
-      @types = types
+      @types           = types
       @used_namespaces = used_namespaces
-      @key_converter = key_converter
+      @key_converter   = key_converter
     end
 
     def to_hash(hash, path)
       return hash 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)
+      return hash.map { |value| to_hash(value, path) } if hash.is_a?(Array)
+      return hash.to_s unless hash.is_a?(Hash)
+
+      hash.each_with_object({}) do |(key, value), newhash|
+        case key
+        when :order!
+          newhash[key] = add_namespaces_to_values(value, path)
+        when :attributes!, :content!
+          newhash[key] = to_hash(value, path)
         else
-          translated_key = Gyoku.xml_tag(key, :key_converter => @key_converter).to_s
-          translated_key << "!" if key[-1] == "!"
-          newpath = path + [translated_key]
-
-          if @used_namespaces[newpath]
-            newhash.merge(
-              "#{@used_namespaces[newpath]}:#{translated_key}" =>
-                to_hash(value, @types[newpath] ? [@types[newpath]] : newpath)
-            )
+          if key.to_s =~ /!$/
+            newhash[key] = value
           else
-            newhash.merge(translated_key => value)
+            translated_key  = translate_tag(key)
+            newkey          = add_namespaces_to_values(key, path).first
+            newpath         = path + [translated_key]
+            newhash[newkey] = to_hash(value, @types[newpath] ? [@types[newpath]] : newpath)
           end
         end
+        newhash
       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}"
-      }
+    def translate_tag(key)
+      Gyoku.xml_tag(key, :key_converter => @key_converter).to_s
     end
 
+    def add_namespaces_to_values(values, path)
+      Array(values).collect do |value|
+        translated_value = translate_tag(value)
+        namespace_path   = path + [translated_value]
+        namespace        = @used_namespaces[namespace_path] || ''
+        namespace.empty? ? value : "#{namespace}:#{translated_value}"
+      end
+    end
   end
 end

data/lib/savon/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "httpi"
 
 module Savon
@@ -21,18 +22,25 @@ module Savon
     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
+      @http_request.write_timeout = @globals[:write_timeout] if @globals.include? :write_timeout
     end
 
     def configure_ssl
       @http_request.auth.ssl.ssl_version   = @globals[:ssl_version]       if @globals.include? :ssl_version
+      @http_request.auth.ssl.min_version   = @globals[:ssl_min_version]   if @globals.include? :ssl_min_version
+      @http_request.auth.ssl.max_version   = @globals[:ssl_max_version]   if @globals.include? :ssl_max_version
+
       @http_request.auth.ssl.verify_mode   = @globals[:ssl_verify_mode]   if @globals.include? :ssl_verify_mode
+      @http_request.auth.ssl.ciphers       = @globals[:ssl_ciphers]       if @globals.include? :ssl_ciphers
 
       @http_request.auth.ssl.cert_key_file = @globals[:ssl_cert_key_file] if @globals.include? :ssl_cert_key_file
-      @http_request.auth.ssl.cert_key      = @globals[:ssl_cert_key] if @globals.include? :ssl_cert_key
+      @http_request.auth.ssl.cert_key      = @globals[:ssl_cert_key]      if @globals.include? :ssl_cert_key
       @http_request.auth.ssl.cert_file     = @globals[:ssl_cert_file]     if @globals.include? :ssl_cert_file
-      @http_request.auth.ssl.cert          = @globals[:ssl_cert]     if @globals.include? :ssl_cert
+      @http_request.auth.ssl.cert          = @globals[:ssl_cert]          if @globals.include? :ssl_cert
       @http_request.auth.ssl.ca_cert_file  = @globals[:ssl_ca_cert_file]  if @globals.include? :ssl_ca_cert_file
-      @http_request.auth.ssl.ca_cert       = @globals[:ssl_ca_cert]  if @globals.include? :ssl_ca_cert
+      @http_request.auth.ssl.ca_cert_path  = @globals[:ssl_ca_cert_path]  if @globals.include? :ssl_ca_cert_path
+      @http_request.auth.ssl.ca_cert       = @globals[:ssl_ca_cert]       if @globals.include? :ssl_ca_cert
+      @http_request.auth.ssl.cert_store    = @globals[:ssl_cert_store]    if @globals.include? :ssl_cert_store
 
       @http_request.auth.ssl.cert_key_password = @globals[:ssl_cert_key_password] if @globals.include? :ssl_cert_key_password
     end
@@ -55,12 +63,19 @@ module Savon
     def build
       configure_proxy
       configure_timeouts
+      configure_headers
       configure_ssl
       configure_auth
       configure_redirect_handling
 
       @http_request
     end
+
+    private
+
+    def configure_headers
+      @http_request.headers = @globals[:headers] if @globals.include? :headers
+    end
   end
 
   class SOAPRequest < HTTPRequest
@@ -72,9 +87,9 @@ module Savon
 
     def build(options = {})
       configure_proxy
-      configure_cookies options[:cookies]
       configure_timeouts
-      configure_headers options[:soap_action]
+      configure_headers options[:soap_action], options[:headers]
+      configure_cookies options[:cookies]
       configure_ssl
       configure_auth
       configure_redirect_handling
@@ -88,8 +103,9 @@ module Savon
       @http_request.set_cookies(cookies) if cookies
     end
 
-    def configure_headers(soap_action)
+    def configure_headers(soap_action, headers)
       @http_request.headers = @globals[:headers] if @globals.include? :headers
+      @http_request.headers.merge!(headers) if headers
       @http_request.headers["SOAPAction"]   ||= %{"#{soap_action}"} if soap_action
       @http_request.headers["Content-Type"] ||= CONTENT_TYPE[@globals[:soap_version]] % @globals[:encoding]
     end

data/lib/savon/request_logger.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "savon/log_message"
 
 module Savon
@@ -23,21 +24,26 @@ module Savon
       @globals[:log]
     end
 
+    def log_headers?
+      @globals[:log_headers]
+    end
+
     private
 
     def log_request(request)
       logger.info  { "SOAP request: #{request.url}" }
-      logger.info  { headers_to_log(request.headers) }
+      logger.info  { headers_to_log(request.headers) } if log_headers?
       logger.debug { body_to_log(request.body) }
     end
 
     def log_response(response)
       logger.info  { "SOAP response (status #{response.code})" }
+      logger.debug { headers_to_log(response.headers) } if log_headers?
       logger.debug { body_to_log(response.body) }
     end
 
     def headers_to_log(headers)
-      headers.map { |key, value| "#{key}: #{value}" }.join(", ")
+      headers.map { |key, value| "#{key}: #{value}" }.join("\n")
     end
 
     def body_to_log(body)

data/lib/savon/response.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
 require "nori"
 require "savon/soap_fault"
 require "savon/http_error"
 
 module Savon
   class Response
+    CRLF = /\r\n/
+    WSP  = /[#{%Q|\x9\x20|}]/
 
     def initialize(http, globals, locals)
       @http    = http
       @globals = globals
       @locals  = locals
+      @attachments = []
+      @xml     = ''
+      @has_parsed_body = false
 
       build_soap_and_http_errors!
       raise_soap_and_http_errors! if @globals[:raise_errors]
@@ -48,12 +54,17 @@ module Savon
       result.kind_of?(Array) ? result.compact : [result].compact
     end
 
-    def hash
-      @hash ||= nori.parse(xml)
+    def full_hash
+      @full_hash ||= nori.parse(xml)
     end
 
     def xml
-      @http.body
+      if multipart?
+        parse_body unless @has_parsed_body
+        @xml
+      else
+        @http.body
+      end
     end
 
     alias_method :to_xml, :xml
@@ -68,14 +79,50 @@ module Savon
     end
 
     def find(*path)
-      envelope = nori.find(hash, 'Envelope')
-      raise_invalid_response_error! unless envelope
+      envelope = nori.find(full_hash, 'Envelope')
+      raise_invalid_response_error! unless envelope.is_a?(Hash)
 
       nori.find(envelope, *path)
     end
 
+    def attachments
+      if multipart?
+        parse_body unless @has_parsed_body
+        @attachments
+      else
+        []
+      end
+    end
+
+    def multipart?
+      !(http.headers['content-type'] =~ /^multipart/im).nil?
+    end
+
     private
 
+    def boundary
+      return unless multipart?
+      Mail::Field.new('content-type', http.headers['content-type']).parameters['boundary']
+    end
+
+    def parse_body
+      http.body.force_encoding Encoding::ASCII_8BIT
+      parts = http.body.split(/(?:\A|\r\n)--#{Regexp.escape(boundary)}(?=(?:--)?\s*$)/)
+      parts[1..-1].to_a.each_with_index do |part, index|
+        header_part, body_part = part.lstrip.split(/#{CRLF}#{CRLF}|#{CRLF}#{WSP}*#{CRLF}(?!#{WSP})/m, 2)
+        section = Mail::Part.new(
+          body: body_part
+        )
+        section.header = header_part
+        if index == 0
+          @xml = section.body.to_s
+        else
+          @attachments << section
+        end
+      end
+      @has_parsed_body = true
+    end
+
     def build_soap_and_http_errors!
       @soap_fault = SOAPFault.new(@http, nori, xml) if soap_fault?
       @http_error = HTTPError.new(@http) if http_error?
@@ -98,11 +145,12 @@ module Savon
       return @nori if @nori
 
       nori_options = {
-        :strip_namespaces      => @globals[:strip_namespaces],
-        :convert_tags_to       => @globals[:convert_response_tags_to],
-        :convert_attributes_to => @globals[:convert_attributes_to],
-        :advanced_typecasting  => @locals[:advanced_typecasting],
-        :parser                => @locals[:response_parser]
+        :delete_namespace_attributes => @globals[:delete_namespace_attributes],
+        :strip_namespaces            => @globals[:strip_namespaces],
+        :convert_tags_to             => @globals[:convert_response_tags_to],
+        :convert_attributes_to       => @globals[:convert_attributes_to],
+        :advanced_typecasting        => @locals[:advanced_typecasting],
+        :parser                      => @locals[:response_parser]
       }
 
       non_nil_nori_options = nori_options.reject { |_, value| value.nil? }

data/lib/savon/soap_fault.rb

@@ -1,12 +1,11 @@
-require "savon"
-
+# frozen_string_literal: true
 module Savon
   class SOAPFault < Error
 
     def self.present?(http, xml = nil)
       xml ||= http.body
       fault_node  = xml.include?("Fault>")
-      soap1_fault = xml.include?("faultcode>") && xml.include?("faultstring>")
+      soap1_fault = xml.match(/faultcode\/?\>/) && xml.match(/faultstring\/?\>/)
       soap2_fault = xml.include?("Code>") && xml.include?("Reason>")
 
       fault_node && (soap1_fault || soap2_fault)
@@ -27,7 +26,7 @@ module Savon
 
     def to_hash
       parsed = nori.parse(xml || http.body)
-      nori.find(parsed, 'Envelope', 'Body')
+      nori.find(parsed, 'Envelope', 'Body') || {}
     end
 
     private

data/lib/savon/string_utils.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Savon
+  module StringUtils
+    def self.snakecase(inputstring)
+      str = inputstring.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
+  end
+end
+

data/lib/savon/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
-  VERSION = '2.11.1'
+  VERSION = '2.15.1'
 end

data/lib/savon.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
 
   Error                 = Class.new(RuntimeError)
@@ -25,3 +26,4 @@ end
 require "savon/version"
 require "savon/client"
 require "savon/model"
+require "savon/string_utils"