Add global option to set connection middlewares. (#1026)

Co-authored-by: Peter Cai <[email protected]>

Author: amartinfraguas

lib/savon/options.rb

@@ -92,6 +92,7 @@ def initialize(options = {})
         :convert_attributes_to       => lambda { |k,v| [k,v] },
         :multipart                   => false,
         :adapter                     => nil,
+        :middlewares                 => [],
         :use_wsa_headers             => false,
         :no_message_tag              => false,
         :follow_redirects            => false,
@@ -384,6 +385,25 @@ def no_message_tag(bool)
     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

lib/savon/request.rb

@@ -80,6 +80,12 @@ def configure_logging
       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
@@ -98,6 +104,7 @@ def build
       configure_ssl
       configure_auth
       configure_adapter
+      configure_middlewares
       configure_logging
       configure_headers
       configure_gzip
@@ -126,6 +133,7 @@ def build(options = {})
       configure_headers(options[:soap_action], options[:headers])
       configure_cookies(options[:cookies])
       configure_adapter
+      configure_middlewares
       configure_logging
       configure_redirect_handling
       configure_gzip

spec/savon/options_spec.rb

@@ -947,6 +947,19 @@ def to_s
     end
   end
 
+  context "global :middlewares" do
+    let(:middlewares) { [[1],[2],[3]] }
+
+    it "adds middlewares to the connection" do
+      middleware_setup = sequence('middleware_setup')
+      Faraday::Connection.any_instance.expects(:use).with(1).in_sequence(middleware_setup)
+      Faraday::Connection.any_instance.expects(:use).with(2).in_sequence(middleware_setup)
+      Faraday::Connection.any_instance.expects(:use).with(3).in_sequence(middleware_setup)
+
+      client = new_client(:endpoint => @server.url, :middlewares => middlewares)
+    end
+  end
+
   context "global and request :soap_header" do
     it "merges the headers if both were provided as Hashes" do
       global_soap_header = {

spec/savon/request_spec.rb

@@ -178,8 +178,25 @@ def new_wsdl_request
         new_wsdl_request.build
       end
     end
-  end
 
+    describe "middlewares" do
+      it "are set when specified" do
+        globals.middlewares([[1], [2, "two", { two: 2 }], [3]])
+
+        middleware_setup = sequence('middleware_setup')
+        http_connection.expects(:use).with(1).in_sequence(middleware_setup)
+        http_connection.expects(:use).with(2, "two", two: 2).in_sequence(middleware_setup)
+        http_connection.expects(:use).with(3).in_sequence(middleware_setup)
+
+        new_wsdl_request.build
+      end
+
+      it "are not set otherwise" do
+        http_connection.expects(:use).never
+        new_wsdl_request.build
+      end
+    end
+  end
 end
 
 RSpec.describe Savon::SOAPRequest do
@@ -398,6 +415,23 @@ def new_soap_request
         new_soap_request.build
       end
     end
-  end
 
+    describe "middlewares" do
+      it "are set when specified" do
+        globals.middlewares([[1], [2, "two", { two: 2 }], [3]])
+
+        middleware_setup = sequence('middleware_setup')
+        http_connection.expects(:use).with(1).in_sequence(middleware_setup)
+        http_connection.expects(:use).with(2, "two", two: 2).in_sequence(middleware_setup)
+        http_connection.expects(:use).with(3).in_sequence(middleware_setup)
+
+        new_soap_request.build
+      end
+
+      it "are not set otherwise" do
+        http_connection.expects(:use).never
+        new_soap_request.build
+      end
+    end
+  end
 end