savon 3.0.0.rc1 → 3.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3f58a5268715a082369bc199231506447defea5f760fae67cb51507a9011836c
-  data.tar.gz: d349d7d546fb236e45f433047bd575dd6f6ec206254707094f02420ec58dfc07
+  metadata.gz: 217170b4a884638cf811c1b5334c9acbbfa7e5b88b1554f29c3e043557be5195
+  data.tar.gz: c36c7221ec92faa8df1064d4776c21269885d8db5d8d047db69dc3f598f05220
 SHA512:
-  metadata.gz: 91d6cd948edbb82b643fa5aaeef265dcfeef5037459478f0815f01bdacbe04cb159165301a9f0ebc75fd897470ff2a0b51de1fa256123843698a14925f5ebf43
-  data.tar.gz: 3a9fe95352e4f85e9e88f7eaffba5fb04df58085380ed7c62e8c0f31c0b110b5127c494125f373e97489c789991b6c1271e68df000606c3e1a3311a17edc951a
+  metadata.gz: 8da94da891a4d4db8e6a8ee2fbf08d2d230e2fcd7ea709f474649c4a06161c301a989a2174e58b73d27ca05a7141d8f1690e86526555e9f17d78665cca54e645
+  data.tar.gz: 1cb489bdd51b813057ad4b5b6c9f81739b89fa08276cc5ddca096271daf530b5c63307723d78b2202970a1f8f23270d71acf9f11daea5f43ca25c523067f7bbc

data/CHANGELOG.md

@@ -3,6 +3,17 @@
 ## Unreleased
 * Add your PR changelog line here
 
+## 3.0.0.rc2 (2025-08-12)
+* MTOM support with tests by @pcai in https://github.com/savonrb/savon/pull/1012
+* Upgrade notes on ssl_verify_mode by @ehutzelman in https://github.com/savonrb/savon/pull/1013
+* Pass the provided Savon/custom logger to Faraday by @larskanis in https://github.com/savonrb/savon/pull/1017
+* Add ruby 3.4 to CI by @doconnor-clintel in https://github.com/savonrb/savon/pull/1024
+* Restore support for SSL Ciphers by @doconnor-clintel in https://github.com/savonrb/savon/pull/1020
+* Drop ruby 3.0 from CI by @doconnor-clintel in https://github.com/savonrb/savon/pull/1025
+* Don't block minor updates to faraday by @larskanis in https://github.com/savonrb/savon/pull/1028
+* Add gzip middleware when Accept-Encoding includes gzip by @kjeldahl in https://github.com/savonrb/savon/pull/1030
+* Add option to provide connection middlewares. by @amartinfraguas in https://github.com/savonrb/savon/pull/1026
+
 ## 3.0.0.rc1 (2024-07-15)
 
 * Use Faraday instead of HTTPI

data/lib/savon/builder.rb

@@ -38,18 +38,23 @@ module Savon
     end
 
     def build_document
-      xml_result = build_xml
+      # check if xml was already provided
+      if @locals.include? :xml
+        xml_result = @locals[:xml]
+      else
+        xml_result = build_xml
 
-      # if we have a signature sign the document
-      if @signature
-        @signature.document = xml_result
+        # if we have a signature sign the document
+        if @signature
+          @signature.document = xml_result
 
-        2.times do
-          @header = nil
-          @signature.document = build_xml
-        end
+          2.times do
+            @header             = nil
+            @signature.document = build_xml
+          end
 
-        xml_result = @signature.document
+          xml_result = @signature.document
+        end
       end
 
       # if there are attachments for the request, we should build a multipart message according to
@@ -70,7 +75,6 @@ module Savon
     end
 
     def to_s
-      return @locals[:xml] if @locals.include? :xml
       build_document
     end
 
@@ -254,15 +258,28 @@ module Savon
 
       # 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.set_sort_order ['application/xop+xml', 'text/xml']
 
       multipart_message.body.encoded(multipart_message.content_transfer_encoding)
     end
 
     def init_multipart_message(message_xml)
       multipart_message = Mail.new
+
+      # MTOM differs from general SOAP attachments:
+      # 1. binary encoding
+      # 2. application/xop+xml mime type
+      if @locals[:mtom]
+        type = "application/xop+xml; charset=#{@globals[:encoding]}; type=\"text/xml\""
+
+        multipart_message.transport_encoding = 'binary'
+        message_xml.force_encoding('BINARY')
+      else
+        type = 'text/xml'
+      end
+
       xml_part = Mail::Part.new do
-        content_type 'text/xml'
+        content_type type
         body message_xml
         # in Content-Type the start parameter is recommended (RFC 2387)
         content_id '<soap-request-body@soap>'

data/lib/savon/operation.rb

@@ -17,6 +17,7 @@ module Savon
       1 => "text/xml",
       2 => "application/soap+xml"
     }
+    SOAP_REQUEST_TYPE_MTOM = "application/xop+xml"
 
     def self.create(operation_name, wsdl, globals)
       if wsdl.document?
@@ -118,18 +119,21 @@ module Savon
         :headers     => @locals[:headers]
       ) do |connection|
         if builder.multipart
-          connection.request :gzip
-          connection.headers["Content-Type"] = %W[multipart/related
-                                                  type="#{SOAP_REQUEST_TYPE[@globals[:soap_version]]}",
-                                                  start="#{builder.multipart[:start]}",
-                                                  boundary="#{builder.multipart[:multipart_boundary]}"].join("; ")
+          ctype_headers = ["multipart/related"]
+          if @locals[:mtom]
+            ctype_headers << "type=\"#{SOAP_REQUEST_TYPE_MTOM}\""
+            ctype_headers << "start-info=\"text/xml\""
+          else
+            ctype_headers << "type=\"#{SOAP_REQUEST_TYPE[@globals[:soap_version]]}\""
+            connection.request :gzip
+          end
+          connection.headers["Content-Type"] = (ctype_headers + ["start=\"#{builder.multipart[:start]}\"",
+                                                  "boundary=\"#{builder.multipart[:multipart_boundary]}\""]).join("; ")
           connection.headers["MIME-Version"] = "1.0"
         end
 
         connection.headers["Content-Length"] = @locals[:body].bytesize.to_s
       end
-
-
     end
 
     def soap_action

data/lib/savon/options.rb

@@ -92,6 +92,7 @@ module Savon
         :convert_attributes_to       => lambda { |k,v| [k,v] },
         :multipart                   => false,
         :adapter                     => nil,
+        :middlewares                 => [],
         :use_wsa_headers             => false,
         :no_message_tag              => false,
         :follow_redirects            => false,
@@ -296,7 +297,6 @@ module Savon
     end
 
     def ssl_ciphers(ciphers)
-      deprecate('ssl_ciphers')
       @options[:ssl_ciphers] = ciphers
     end
 
@@ -385,6 +385,25 @@ module Savon
     def follow_redirects(follow_redirects)
       @options[:follow_redirects] = follow_redirects
     end
+
+    # Provide middlewares for Faraday connections.
+    # The argument is an array, with each element being another array
+    # that contains the middleware class and its arguments, in the same way
+    # as a normal call to Faraday::RackBuilder#use
+    #
+    # See https://lostisland.github.io/faraday/#/middleware/index?id=using-middleware
+    # For example:
+    #
+    # client = Savon.client(
+    #   middlewares: [
+    #     [Faraday::Request::UrlEncoded],
+    #     [Faraday::Response::Logger, { bodies: true }],
+    #     [Faraday::Adapter::NetHttp]
+    #   ]
+    # )
+    def middlewares(middlewares)
+      @options[:middlewares] = middlewares
+    end
   end
 
   class LocalOptions < Options
@@ -397,7 +416,8 @@ module Savon
         :advanced_typecasting => true,
         :response_parser      => :nokogiri,
         :multipart            => false,
-        :body                 => false
+        :body                 => false,
+        :mtom                 => false
       }
 
       super defaults.merge(options)
@@ -460,6 +480,11 @@ module Savon
       @options[:attachments] = attachments
     end
 
+    # Instruct Savon to send attachments using MTOM https://www.w3.org/TR/soap12-mtom/
+    def mtom(mtom)
+      @options[:mtom] = mtom
+    end
+
     # Value of the SOAPAction HTTP header.
     def soap_action(soap_action)
       @options[:soap_action] = soap_action
@@ -489,6 +514,11 @@ module Savon
       @options[:response_parser] = parser
     end
 
+    # Pass already configured Nori instance.
+    def nori(nori)
+      @options[:nori] = nori
+    end
+
     # Instruct Savon to create a multipart response if available.
     def multipart(multipart)
       @options[:multipart] = multipart

data/lib/savon/request.rb

@@ -36,12 +36,12 @@ module Savon
       connection.ssl.version         = @globals[:ssl_version]       if @globals.include? :ssl_version
       connection.ssl.min_version     = @globals[:ssl_min_version]   if @globals.include? :ssl_min_version
       connection.ssl.max_version     = @globals[:ssl_max_version]   if @globals.include? :ssl_max_version
+      connection.ssl.ciphers         = @globals[:ssl_ciphers]       if @globals.include? :ssl_ciphers
 
       # No Faraday Equivalent out of box, see: https://lostisland.github.io/faraday/#/customization/ssl-options
       # connection.ssl.cert_file       = @globals[:ssl_cert_file]     if @globals.include? :ssl_cert_file
       # connection.ssl.cert_key_file   = @globals[:ssl_cert_key_file] if @globals.include? :ssl_cert_key_file
       # connection.ssl.ca_cert         = @globals[:ssl_ca_cert]       if @globals.include? :ssl_ca_cert
-      # connection.ssl.ciphers         = @globals[:ssl_ciphers]       if @globals.include? :ssl_ciphers
       # connection.ssl.cert_key_password = @globals[:ssl_cert_key_password] if @globals.include? :ssl_cert_key_password
 
     end
@@ -77,7 +77,19 @@ module Savon
     end
 
     def configure_logging
-      connection.response(:logger, nil, headers: @globals[:log_headers], level: @globals[:logger].level) if @globals[:log]
+      connection.response(:logger, @globals[:logger], headers: @globals[:log_headers]) if @globals[:log]
+    end
+
+    def configure_middlewares
+      @globals[:middlewares].each do |middleware_args|
+        connection.use(*middleware_args)
+      end
+    end
+    
+    def configure_gzip
+      if connection.headers['Accept-Encoding'] && connection.headers['Accept-Encoding'].include?('gzip')
+        connection.request :gzip
+      end
     end
 
     protected
@@ -92,8 +104,10 @@ module Savon
       configure_ssl
       configure_auth
       configure_adapter
+      configure_middlewares
       configure_logging
       configure_headers
+      configure_gzip
       connection
     end
 
@@ -119,8 +133,10 @@ module Savon
       configure_headers(options[:soap_action], options[:headers])
       configure_cookies(options[:cookies])
       configure_adapter
+      configure_middlewares
       configure_logging
       configure_redirect_handling
+      configure_gzip
       yield(connection) if block_given?
       connection
     end

data/lib/savon/request_logger.rb

@@ -50,7 +50,7 @@ module Savon
     end
 
     def body_to_log(body)
-      LogMessage.new(body, @globals[:filters], @globals[:pretty_print_xml]).to_s
+      LogMessage.new(body, @globals[:filters], @globals[:pretty_print_xml]).to_s.force_encoding(@globals[:encoding])
     end
 
   end

data/lib/savon/response.rb

@@ -142,20 +142,16 @@ module Savon
     end
 
     def nori
-      return @nori if @nori
+      return @locals[:nori] if @locals[:nori]
 
-      nori_options = {
-        :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? }
-      @nori = Nori.new(non_nil_nori_options)
+      @nori ||= Nori.new({
+                           :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]
+                         }.reject { |_, value| value.nil? })
     end
-
   end
 end

data/lib/savon/soap_fault.rb

@@ -3,7 +3,14 @@ module Savon
   class SOAPFault < Error
 
     def self.present?(http, xml = nil)
-      xml ||= http.body
+      xml_orig ||= http.body
+      if xml_orig.valid_encoding?
+        xml = xml_orig
+      else
+        xml = xml_orig.encode(
+          'UTF-8', "ISO-8859-1", invalid: :replace, undef: :replace, replace: ''
+        )
+      end
       fault_node  = xml.include?("Fault>")
       soap1_fault = xml.match(/faultcode\/?>/) && xml.match(/faultstring\/?>/)
       soap2_fault = xml.include?("Code>") && xml.include?("Reason>")

data/lib/savon/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Savon
-  VERSION = '3.0.0.rc1'
+  VERSION = '3.0.0.rc2'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: savon
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc1
+  version: 3.0.0.rc2
 platform: ruby
 authors:
 - Daniel Harrington
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nori
@@ -30,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.8'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: faraday-gzip
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +239,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -346,7 +359,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -361,8 +373,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Heavy metal SOAP client
 test_files: []