savon 2.11.1 → 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.png?branch=master)](http://travis-ci.org/savonrb/savon)
-[![Gem Version](https://badge.fury.io/rb/savon.png)](http://badge.fury.io/rb/savon)
-[![Code Climate](https://codeclimate.com/github/savonrb/savon.png)](https://codeclimate.com/github/savonrb/savon)
-[![Coverage Status](https://coveralls.io/repos/savonrb/savon/badge.png?branch=version2)](https://coveralls.io/r/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)](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.10.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]
 
@@ -46,24 +52,33 @@ response.body
 For more examples, you should check out the
 [integration tests](https://github.com/savonrb/savon/tree/version2/spec/integration).
 
-## FAQ
+## Ruby version support
 
-* 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
+Every savon release is tested with contemporary supported versions of ruby. Historical compatibility information:
 
-## Give back
+* `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'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.
+If you are running MRI 1.8.7, try a 2.6.x release.
 
-[![donate](donate.png)](https://www.gittip.com/tjarratt/)
+Most changes are not backported to older versions of savon, or unsupported ruby versions.
 
+## Running tests
 
-## Documentation
+```bash
+$ bundle install
+$ bundle exec rspec
+```
+
+## FAQ
+
+* 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
 
-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).
+## Documentation
 
-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,35 +38,27 @@ module Savon
     end
 
     def build_document
-      xml = 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
+      xml_result = build_xml
 
       # if we have a signature sign the document
       if @signature
-        @signature.document = xml
+        @signature.document = xml_result
 
         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 = @signature.document
+        xml_result = @signature.document
       end
 
-      xml
+      # 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
@@ -141,6 +145,7 @@ module Savon
 
     def namespaced_message_tag
       tag_name = message_tag
+      return [tag_name] if @wsdl.document? and @wsdl.soap_input(@operation_name.to_sym).is_a?(Hash)
       if namespace_identifier == nil
         [tag_name, message_attributes]
       elsif @used_namespaces[[tag_name.to_s]]
@@ -150,18 +155,45 @@ module Savon
       end
     end
 
+    def serialized_message_tag
+      [:wsdl, @wsdl.soap_input(@operation_name.to_sym).keys.first, {}]
+    end
+
+    def serialized_messages
+      messages = ""
+      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][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}>"
+      end
+      messages
+    end
+
     def message_tag
-      message_tag = @locals[:message_tag]
-      message_tag ||= @wsdl.soap_input(@operation_name.to_sym) if @wsdl.document?
+      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_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
       @locals[:attributes] || {}
     end
 
+    def body_message
+      if @wsdl.document? and @wsdl.soap_input(@operation_name.to_sym).is_a?(Hash)
+        serialized_messages
+      else
+        message.to_s
+      end
+    end
+
     def message
       element_form_default = @globals[:element_form_default] || @wsdl.element_form_default
       # TODO: clean this up! [dh, 2012-12-17]
@@ -201,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"
@@ -21,7 +22,7 @@ module Savon
       build_wsdl_document
     end
 
-    attr_reader :globals
+    attr_reader :globals, :wsdl
 
     def operations
       raise_missing_wsdl_error! unless @wsdl.document?
@@ -60,7 +61,6 @@ module Savon
       @wsdl.document    = @globals[:wsdl]        if @globals.include? :wsdl
       @wsdl.endpoint    = @globals[:endpoint]    if @globals.include? :endpoint
       @wsdl.namespace   = @globals[:namespace]   if @globals.include? :namespace
-      @wsdl.servicename = @globals[:servicename] if @globals.include? :servicename
       @wsdl.adapter     = @globals[:adapter]     if @globals.include? :adapter
 
       @wsdl.request = WSDLRequest.new(@globals).build

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
@@ -45,7 +46,7 @@ module Savon
     end
 
     def nokogiri_options
-      @pretty_print ? { :indent => 2 } : {}
+      @pretty_print ? { :indent => 2 } : { :save_with => Nokogiri::XML::Node::SaveOptions::AS_XML }
     end
 
   end

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)
@@ -100,12 +93,22 @@ module Savon
 
       request = SOAPRequest.new(@globals).build(
         :soap_action => soap_action,
-        :cookies     => @locals[:cookies]
+        :cookies     => @locals[:cookies],
+        :headers     => @locals[:headers]
       )
 
       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
@@ -118,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