savon 2.12.0 → 2.15.1

data/README.md

@@ -2,18 +2,18 @@
 
 Heavy metal SOAP client
 
-[Documentation](http://savonrb.com) | [RDoc](http://rubydoc.info/gems/savon) |
+[Documentation](https://www.rubydoc.info/gems/savon/) | [Support](https://stackoverflow.com/questions/tagged/savon) |
 [Mailing list](https://groups.google.com/forum/#!forum/savonrb) | [Twitter](http://twitter.com/savonrb)
 
-[![Build Status](https://secure.travis-ci.org/savonrb/savon.svg?branch=master)](http://travis-ci.org/savonrb/savon)
+[![Ruby](https://github.com/savonrb/savon/actions/workflows/ci.yml/badge.svg)](https://github.com/savonrb/savon/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/savon.svg)](http://badge.fury.io/rb/savon)
 [![Code Climate](https://codeclimate.com/github/savonrb/savon.svg)](https://codeclimate.com/github/savonrb/savon)
-[![Coverage Status](https://coveralls.io/repos/savonrb/savon/badge.svg?branch=version2)](https://coveralls.io/r/savonrb/savon)
+[![Coverage Status](https://coveralls.io/repos/savonrb/savon/badge.svg)](https://coveralls.io/r/savonrb/savon)
 
 
-## Version 2
+## Installation
 
-Savon version 2 is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
+Savon is available through [Rubygems](http://rubygems.org/gems/savon) and can be installed via:
 
 ```
 $ gem install savon
@@ -22,7 +22,7 @@ $ gem install savon
 or add it to your Gemfile like this:
 
 ```
-gem 'savon', '~> 2.12.0'
+gem 'savon', '~> 2.15.0'
 ```
 
 ## Usage example
@@ -33,6 +33,12 @@ require 'savon'
 # create a client for the service
 client = Savon.client(wsdl: 'http://service.example.com?wsdl')
 
+# or: create a client with a wsdl provided as a string
+client = Savon.client do |config|
+  wsdl_content = File.read("/path/to/wsdl")
+  config.wsdl wsdl_content
+end
+
 client.operations
 # => [:find_user, :list_users]
 
@@ -47,10 +53,18 @@ For more examples, you should check out the
 [integration tests](https://github.com/savonrb/savon/tree/version2/spec/integration).
 
 ## Ruby version support
-* 2.12.x - MRI 2.2, 2.3, 2.4
+
+Every savon release is tested with contemporary supported versions of ruby. Historical compatibility information:
+
+* `main` - same support as Ruby
+* 2.15.x - MRI 3.0, 3.1, 3.2, 3.3
+* 2.13.x, 2.14.x - MRI 2.7, 3.0, 3.1
+* 2.12.x - MRI 2.2, 2.3, 2.4, 2.5
 * 2.11.x - MRI 2.0, 2.1, 2.2, and 2.3
 
-If you are running MRI 1.8.7, try the 2.6.x branch.
+If you are running MRI 1.8.7, try a 2.6.x release.
+
+Most changes are not backported to older versions of savon, or unsupported ruby versions.
 
 ## Running tests
 
@@ -64,19 +78,7 @@ $ bundle exec rspec
 * URI::InvalidURIError -- if you see this error, then it is likely that the http client you are using cannot parse the URI for your WSDL. Try `gem install httpclient` or add it to your `Gemfile`.
   - See https://github.com/savonrb/savon/issues/488 for more info
 
-## Give back
-
-If you're using Savon and you or your company is making money from it, then please consider
-donating via [Gittip](https://www.gittip.com/tjarratt/) so that I can continue to improve it.
-
-[![donate](donate.png)](https://www.gittip.com/tjarratt/)
-
 
 ## Documentation
 
-Please make sure to [read the documentation](http://savonrb.com/version2/).
-
-And if you find any problems with it or if you think something's missing,
-feel free to [help out and improve the documentation](https://github.com/savonrb/savonrb.com).
-
-Donate icon from the [Noun Project](http://thenounproject.com/noun/donate/#icon-No285).
+Please be sure to [read the documentation](https://www.rubydoc.info/github/savonrb/savon/).

data/lib/savon/block_interface.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
   class BlockInterface
 

data/lib/savon/builder.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "savon/header"
 require "savon/message"
 require "nokogiri"
@@ -6,6 +7,7 @@ require "gyoku"
 
 module Savon
   class Builder
+    attr_reader :multipart
 
     SCHEMA_TYPES = {
       "xmlns:xsd" => "http://www.w3.org/2001/XMLSchema",
@@ -36,14 +38,7 @@ module Savon
     end
 
     def build_document
-      xml_result = tag(builder, :Envelope, namespaces_with_globals) do |xml|
-        tag(xml, :Header, header_attributes) { xml << header.to_s } unless header.empty?
-        if @globals[:no_message_tag]
-          tag(xml, :Body, body_attributes) { xml << message.to_s }
-        else
-          tag(xml, :Body, body_attributes) { xml.tag!(*namespaced_message_tag) { xml << body_message } }
-        end
-      end
+      xml_result = build_xml
 
       # if we have a signature sign the document
       if @signature
@@ -51,20 +46,19 @@ module Savon
 
         2.times do
           @header = nil
-          @signature.document = tag(builder, :Envelope, namespaces_with_globals) do |xml|
-            tag(xml, :Header, header_attributes) { xml << header.to_s } unless header.empty?
-            if @globals[:no_message_tag]
-              tag(xml, :Body, body_attributes) { xml << message.to_s }
-            else
-              tag(xml, :Body, body_attributes) { xml.tag!(*namespaced_message_tag) { xml << message.to_s } }
-            end
-          end
+          @signature.document = build_xml
         end
 
         xml_result = @signature.document
       end
 
-      xml_result
+      # if there are attachments for the request, we should build a multipart message according to
+      # https://www.w3.org/TR/SOAP-attachments
+      if @locals[:attachments]
+        build_multipart_message(xml_result)
+      else
+        xml_result
+      end
     end
 
     def header_attributes
@@ -117,15 +111,25 @@ module Savon
       @namespaces ||= begin
         namespaces = SCHEMA_TYPES.dup
 
-        if namespace_identifier == nil
-          namespaces["xmlns"] = @globals[:namespace] || @wsdl.namespace
-        else
-          namespaces["xmlns:#{namespace_identifier}"] = @globals[:namespace] || @wsdl.namespace
-        end
+        # check namespace_identifier
+        namespaces["xmlns#{namespace_identifier.nil? ? '' : ":#{namespace_identifier}"}"] =
+          @globals[:namespace] || @wsdl.namespace
+
+        # check env_namespace
+        namespaces["xmlns#{env_namespace && env_namespace != "" ? ":#{env_namespace}" : ''}"] =
+          SOAP_NAMESPACE[@globals[:soap_version]]
+
+        if @wsdl&.document
+          @wsdl.parser.namespaces.each do |identifier, path|
+            next if identifier == 'xmlns' # Do not include xmlns namespace as this causes issues for some servers (https://github.com/savonrb/savon/issues/986)
 
-        key = ["xmlns"]
-        key << env_namespace if env_namespace && env_namespace != ""
-        namespaces[key.join(":")] = SOAP_NAMESPACE[@globals[:soap_version]]
+            prefixed_identifier = "xmlns:#{identifier}"
+
+            next if namespaces.key?(prefixed_identifier)
+
+            namespaces[prefixed_identifier] = path
+          end
+        end
 
         namespaces
       end
@@ -160,20 +164,22 @@ module Savon
       message_tag = serialized_message_tag[1]
       @wsdl.soap_input(@operation_name.to_sym)[message_tag].each_pair do |message, type|
         break if @locals[:message].nil?
-        message_locals = @locals[:message][message.snakecase.to_sym]
+        message_locals = @locals[:message][StringUtils.snakecase(message).to_sym]
         message_content = Message.new(message_tag, namespace_identifier, @types, @used_namespaces, message_locals, :unqualified, @globals[:convert_request_keys_to], @globals[:unwrap]).to_s
-        messages << "<#{message} xsi:type=\"#{type.join(':')}\">#{message_content}</#{message}>"
+        messages += "<#{message} xsi:type=\"#{type.join(':')}\">#{message_content}</#{message}>"
       end
       messages
     end
 
     def message_tag
-      message_tag = @wsdl.soap_input(@operation_name.to_sym).keys.first if @wsdl.document? and @wsdl.soap_input(@operation_name.to_sym).is_a?(Hash)
+      wsdl_tag_name = @wsdl.document? && @wsdl.soap_input(@operation_name.to_sym)
+
+      message_tag = wsdl_tag_name.keys.first if wsdl_tag_name.is_a?(Hash)
       message_tag ||= @locals[:message_tag]
-      message_tag ||= @wsdl.soap_input(@operation_name.to_sym) if @wsdl.document?
+      message_tag ||= wsdl_tag_name
       message_tag ||= Gyoku.xml_tag(@operation_name, :key_converter => @globals[:convert_request_keys_to])
 
-      @message_tag = message_tag.to_sym
+      message_tag.to_sym
     end
 
     def message_attributes
@@ -227,5 +233,69 @@ module Savon
       end
     end
 
+    def build_xml
+      tag(builder, :Envelope, namespaces_with_globals) do |xml|
+        tag(xml, :Header, header_attributes) { xml << header.to_s } unless header.empty?
+        tag(xml, :Body, body_attributes) do
+          if @globals[:no_message_tag]
+            xml << message.to_s
+          else
+            xml.tag!(*namespaced_message_tag) { xml << body_message }
+          end
+        end
+      end
+    end
+
+    def build_multipart_message(message_xml)
+      multipart_message = init_multipart_message(message_xml)
+      add_attachments_to_multipart_message(multipart_message)
+
+      multipart_message.ready_to_send!
+
+      # the mail.body.encoded algorithm reorders the parts, default order is [ "text/plain", "text/enriched", "text/html" ]
+      # should redefine the sort order, because the soap request xml should be the first
+      multipart_message.body.set_sort_order [ "text/xml" ]
+
+      multipart_message.body.encoded(multipart_message.content_transfer_encoding)
+    end
+
+    def init_multipart_message(message_xml)
+      multipart_message = Mail.new
+      xml_part = Mail::Part.new do
+        content_type 'text/xml'
+        body message_xml
+        # in Content-Type the start parameter is recommended (RFC 2387)
+        content_id '<soap-request-body@soap>'
+      end
+      multipart_message.add_part xml_part
+
+      #request.headers["Content-Type"] = "multipart/related; boundary=\"#{multipart_message.body.boundary}\"; type=\"text/xml\"; start=\"#{xml_part.content_id}\""
+      @multipart = {
+        multipart_boundary: multipart_message.body.boundary,
+        start: xml_part.content_id,
+      }
+
+      multipart_message
+    end
+
+    def add_attachments_to_multipart_message(multipart_message)
+      if @locals[:attachments].is_a? Hash
+        # hash example: { 'att1' => '/path/to/att1', 'att2' => '/path/to/att2' }
+        @locals[:attachments].each do |identifier, attachment|
+          add_attachment_to_multipart_message(multipart_message, attachment, identifier)
+        end
+      elsif @locals[:attachments].is_a? Array
+        # array example: [ '/path/to/att1', '/path/to/att2' ]
+        # array example: [ { filename: 'att1.xml', content: '<x/>' }, { filename: 'att2.xml', content: '<y/>' } ]
+        @locals[:attachments].each do |attachment|
+          add_attachment_to_multipart_message(multipart_message, attachment, attachment.is_a?(String) ? File.basename(attachment) : attachment[:filename])
+        end
+      end
+    end
+
+    def add_attachment_to_multipart_message(multipart_message, attachment, identifier)
+      multipart_message.add_file attachment.clone
+      multipart_message.parts.last.content_id = multipart_message.parts.last.content_location = identifier.to_s
+    end
   end
 end

data/lib/savon/client.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "savon/operation"
 require "savon/request"
 require "savon/options"

data/lib/savon/header.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "akami"
 require "gyoku"
 require "securerandom"
@@ -61,12 +62,7 @@ module Savon
        convert_to_xml({
          'wsa:Action' => @locals[:soap_action],
          'wsa:To' => @globals[:endpoint],
-         'wsa:MessageID' => "urn:uuid:#{SecureRandom.uuid}",
-         attributes!: {
-          'wsa:MessageID' => {
-            "xmlns:wsa" => "http://schemas.xmlsoap.org/ws/2004/08/addressing"
-          }
-         }
+         'wsa:MessageID' => "urn:uuid:#{SecureRandom.uuid}"
        })
     end
 

data/lib/savon/http_error.rb

@@ -1,4 +1,4 @@
-require "savon"
+# frozen_string_literal: true
 
 module Savon
   class HTTPError < Error
@@ -14,9 +14,9 @@ module Savon
     attr_reader :http
 
     def to_s
-      message = "HTTP error (#{@http.code})"
-      message << ": #{@http.body}" unless @http.body.empty?
-      message
+      String.new("HTTP error (#{@http.code})").tap do |str_error|
+        str_error << ": #{@http.body}" unless @http.body.empty?
+      end
     end
 
     def to_hash

data/lib/savon/log_message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "nokogiri"
 
 module Savon

data/lib/savon/message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "savon/qualified_message"
 require "gyoku"
 

data/lib/savon/mock/expectation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "httpi"
 
 module Savon

data/lib/savon/mock/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "savon/mock"
 
 module Savon

data/lib/savon/mock.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
   class ExpectationError < StandardError; end
 end

data/lib/savon/model.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
   module Model
 
@@ -28,7 +29,7 @@ module Savon
     # Defines a class-level SOAP operation.
     def define_class_operation(operation)
       class_operation_module.module_eval %{
-        def #{operation.to_s.snakecase}(locals = {})
+        def #{StringUtils.snakecase(operation.to_s)}(locals = {})
           client.call #{operation.inspect}, locals
         end
       }
@@ -37,8 +38,8 @@ module Savon
     # Defines an instance-level SOAP operation.
     def define_instance_operation(operation)
       instance_operation_module.module_eval %{
-        def #{operation.to_s.snakecase}(locals = {})
-          self.class.#{operation.to_s.snakecase} locals
+        def #{StringUtils.snakecase(operation.to_s)}(locals = {})
+          self.class.#{StringUtils.snakecase(operation.to_s)} locals
         end
       }
     end

data/lib/savon/operation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "savon/options"
 require "savon/block_interface"
 require "savon/request"
@@ -5,10 +6,16 @@ require "savon/builder"
 require "savon/response"
 require "savon/request_logger"
 require "savon/http_error"
+require "mail"
 
 module Savon
   class Operation
 
+    SOAP_REQUEST_TYPE = {
+      1 => "text/xml",
+      2 => "application/soap+xml"
+    }
+
     def self.create(operation_name, wsdl, globals)
       if wsdl.document?
         ensure_name_is_symbol! operation_name
@@ -66,21 +73,7 @@ module Savon
     private
 
     def create_response(response)
-      if multipart_supported?
-        Multipart::Response.new(response, @globals, @locals)
-      else
-        Response.new(response, @globals, @locals)
-      end
-    end
-
-    def multipart_supported?
-      return false unless @globals[:multipart] || @locals[:multipart]
-
-      if Savon.const_defined? :Multipart
-        true
-      else
-        raise 'Unable to find Savon::Multipart. Make sure the savon-multipart gem is installed and loaded.'
-      end
+      Response.new(response, @globals, @locals)
     end
 
     def set_locals(locals, block)
@@ -107,6 +100,15 @@ module Savon
       request.url = endpoint
       request.body = builder.to_s
 
+      if builder.multipart
+        request.gzip
+        request.headers["Content-Type"] = ["multipart/related",
+                                           "type=\"#{SOAP_REQUEST_TYPE[@globals[:soap_version]]}\"",
+                                           "start=\"#{builder.multipart[:start]}\"",
+                                           "boundary=\"#{builder.multipart[:multipart_boundary]}\""].join("; ")
+        request.headers["MIME-Version"] = "1.0"
+      end
+
       # TODO: could HTTPI do this automatically in case the header
       #       was not specified manually? [dh, 2013-01-04]
       request.headers["Content-Length"] = request.body.bytesize.to_s
@@ -119,11 +121,11 @@ module Savon
       return if @locals.include?(:soap_action) && !@locals[:soap_action]
 
       # get the soap_action from local options
-      soap_action = @locals[:soap_action]
+      @locals[:soap_action] ||
       # with no local option, but a wsdl, ask it for the soap_action
-      soap_action ||= @wsdl.soap_action(@name.to_sym) if @wsdl.document?
+      @wsdl.document? && @wsdl.soap_action(@name.to_sym) ||
       # if there is no soap_action up to this point, fallback to a simple default
-      soap_action ||= Gyoku.xml_tag(@name, :key_converter => @globals[:convert_request_keys_to])
+      Gyoku.xml_tag(@name, :key_converter => @globals[:convert_request_keys_to])
     end
 
     def endpoint

data/lib/savon/options.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "logger"
 require "httpi"
 
@@ -78,12 +79,13 @@ module Savon
         :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| tag.snakecase.to_sym},
+        :convert_response_tags_to    => lambda { |tag| StringUtils.snakecase(tag).to_sym},
         :convert_attributes_to       => lambda { |k,v| [k,v] },
         :multipart                   => false,
         :adapter                     => nil,
@@ -155,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
@@ -213,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
@@ -228,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
@@ -396,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

data/lib/savon/qualified_message.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "gyoku"
 
 module Savon
@@ -26,7 +27,7 @@ module Savon
             translated_key  = translate_tag(key)
             newkey          = add_namespaces_to_values(key, path).first
             newpath         = path + [translated_key]
-            newhash[newkey] = to_hash(value, newpath)
+            newhash[newkey] = to_hash(value, @types[newpath] ? [@types[newpath]] : newpath)
           end
         end
         newhash
@@ -43,8 +44,8 @@ module Savon
       Array(values).collect do |value|
         translated_value = translate_tag(value)
         namespace_path   = path + [translated_value]
-        namespace        = @used_namespaces[namespace_path]
-        namespace.blank? ? value : "#{namespace}:#{translated_value}"
+        namespace        = @used_namespaces[namespace_path] || ''
+        namespace.empty? ? value : "#{namespace}:#{translated_value}"
       end
     end
   end

data/lib/savon/request.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "httpi"
 
 module Savon
@@ -21,10 +22,14 @@ 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
 

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)