Interface for savon-multipart for Savon2

CHANGELOG.md

@@ -1,5 +1,7 @@
 ### master
 
+* Feature: [#424](https://github.com/savonrb/savon/issues/424) After releasing Savon version 2, support for multipart SOAP messages was dropped. You can now specify `:multipart => true` for either your client constructor or `#call` method to indicate that you would like to use savon-multipart.
+
 * Feature: [#416](https://github.com/savonrb/savon/pull/416) The global `namespace_identifier`
   option can now be set to `nil` to not add a namespace identifier to the message tag.
 

lib/savon/operation.rb

@@ -50,11 +50,31 @@ def call(locals = {}, &block)
 
       raise_expected_httpi_response! unless response.kind_of?(HTTPI::Response)
 
-      Response.new(response, @globals, @locals)
+      create_response(response)
     end
 
     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) && Savon::Multipart.const_defined?(:Response)
+        return true
+      else
+        raise RuntimeError.new('Could not find Savon::Multipart. Perhaps you did not require multipart-savon?')
+      end
+
+      return false
+    end
+
     def set_locals(locals, block)
       locals = LocalOptions.new(locals)
       BlockInterface.new(locals).evaluate(block) if block

lib/savon/options.rb

@@ -53,7 +53,8 @@ def initialize(options = {})
         :pretty_print_xml          => false,
         :raise_errors              => true,
         :strip_namespaces          => true,
-        :convert_response_tags_to  => lambda { |tag| tag.snakecase.to_sym }
+        :convert_response_tags_to  => lambda { |tag| tag.snakecase.to_sym},
+        :multipart                 => false,
       }
 
       options = defaults.merge(options)
@@ -246,6 +247,10 @@ def convert_request_keys_to(converter)
     def convert_response_tags_to(converter = nil, &block)
       @options[:convert_response_tags_to] = block || converter
     end
+
+    def multipart(is_multipart)
+      @options[:multipart] = is_multipart
+    end
   end
 
   class LocalOptions < Options
@@ -255,7 +260,8 @@ def initialize(options = {})
 
       defaults = {
         :advanced_typecasting => true,
-        :response_parser      => :nokogiri
+        :response_parser      => :nokogiri,
+        :multipart            => false
       }
 
       super defaults.merge(options)
@@ -302,5 +308,10 @@ def response_parser(parser)
       @options[:response_parser] = parser
     end
 
+    # Instruction Savon to create a Savon::Multipart::Response if available
+    def multipart(bool)
+      @options[:multipart] = bool
+    end
+
   end
 end

spec/savon/operation_spec.rb

@@ -154,11 +154,58 @@ def new_operation(operation_name, wsdl, globals)
       actual_soap_action = inspect_request(response).soap_action
       expect(actual_soap_action).to eq(%("authenticate"))
     end
+
+    it "returns a Savon::Multipart::Response if available and requested globally" do
+      begin
+        module Savon::Multipart
+          class Response
+            def initialize(*args); end
+          end
+        end
+
+        globals_with_multipart = Savon::GlobalOptions.new(:multipart => true)
+        operation = new_operation(:authenticate, no_wsdl, globals_with_multipart)
+        response = operation.call
+        expect(response.is_a? Savon::Multipart::Response)
+      ensure
+        Savon.send(:remove_const, :Multipart) if Savon.const_defined?(:Multipart)
+      end
+    end
+
+    it "returns a Savon::Multipart::Response if available and requested locally" do
+      begin
+        module Savon::Multipart
+          class Response
+            def initialize(*args); end
+          end
+        end
+
+        operation = new_operation(:authenticate, no_wsdl, globals)
+        response = operation.call(:multipart => true)
+        expect(response.is_a? Savon::Multipart::Response)
+      ensure
+        Savon.send(:remove_const, :Multipart) if Savon.const_defined?(:Multipart)
+      end
+    end
+
+    it "raises a RuntimeError if savon-multipart is not available and it was requested globally" do
+      expect do
+        globals_with_multipart = Savon::GlobalOptions.new(:multipart => true)
+        operation = new_operation(:authenticate, no_wsdl, globals_with_multipart)
+        operation.call
+      end.to raise_error RuntimeError, /Could not find Savon::Multipart/
+    end
+
+    it "raises a RuntimeError if savon-multipart is not available and it was requested locally" do
+      expect do
+        operation = new_operation(:authenticate, no_wsdl, globals)
+        operation.call(:multipart => true)
+      end.to raise_error RuntimeError, /Could not find Savon::Multipart/
+    end
   end
 
   def inspect_request(response)
     hash = JSON.parse(response.http.body)
     OpenStruct.new(hash)
   end
-
 end