savon 2.12.1 → 2.13.1

data/lib/savon/response.rb

@@ -1,14 +1,20 @@
+# frozen_string_literal: true
 require "nori"
 require "savon/soap_fault"
 require "savon/http_error"
 
 module Savon
   class Response
+    CRLF = /\r\n/
+    WSP  = /[#{%Q|\x9\x20|}]/
 
     def initialize(http, globals, locals)
       @http    = http
       @globals = globals
       @locals  = locals
+      @attachments = []
+      @xml     = ''
+      @has_parsed_body = false
 
       build_soap_and_http_errors!
       raise_soap_and_http_errors! if @globals[:raise_errors]
@@ -53,7 +59,12 @@ module Savon
     end
 
     def xml
-      @http.body
+      if multipart?
+        parse_body unless @has_parsed_body
+        @xml
+      else
+        @http.body
+      end
     end
 
     alias_method :to_xml, :xml
@@ -74,8 +85,44 @@ module Savon
       nori.find(envelope, *path)
     end
 
+    def attachments
+      if multipart?
+        parse_body unless @has_parsed_body
+        @attachments
+      else
+        []
+      end
+    end
+
+    def multipart?
+      !(http.headers['content-type'] =~ /^multipart/im).nil?
+    end
+
     private
 
+    def boundary
+      return unless multipart?
+      Mail::Field.new('content-type', http.headers['content-type']).parameters['boundary']
+    end
+
+    def parse_body
+      http.body.force_encoding Encoding::ASCII_8BIT
+      parts = http.body.split(/(?:\A|\r\n)--#{Regexp.escape(boundary)}(?=(?:--)?\s*$)/)
+      parts[1..-1].to_a.each_with_index do |part, index|
+        header_part, body_part = part.lstrip.split(/#{CRLF}#{CRLF}|#{CRLF}#{WSP}*#{CRLF}(?!#{WSP})/m, 2)
+        section = Mail::Part.new(
+          body: body_part
+        )
+        section.header = header_part
+        if index == 0
+          @xml = section.body.to_s
+        else
+          @attachments << section
+        end
+      end
+      @has_parsed_body = true
+    end
+
     def build_soap_and_http_errors!
       @soap_fault = SOAPFault.new(@http, nori, xml) if soap_fault?
       @http_error = HTTPError.new(@http) if http_error?

data/lib/savon/soap_fault.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
   class SOAPFault < Error
 

data/lib/savon/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
-  VERSION = '2.12.1'
+  VERSION = '2.13.1'
 end

data/lib/savon.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Savon
 
   Error                 = Class.new(RuntimeError)

data/savon.gemspec

@@ -12,29 +12,30 @@ Gem::Specification.new do |s|
   s.homepage    = "http://savonrb.com"
   s.summary     = "Heavy metal SOAP client"
   s.description = s.summary
-  s.required_ruby_version = '>= 1.9.2'
+  s.required_ruby_version = '>= 2.7.0'
 
-  s.rubyforge_project = s.name
   s.license = 'MIT'
 
   s.add_dependency "nori",     "~> 2.4"
-  s.add_dependency "httpi",    "~> 2.3"
+  s.add_dependency "httpi",    ">= 2.4.5"
   s.add_dependency "wasabi",   "~> 3.4"
   s.add_dependency "akami",    "~> 1.2"
   s.add_dependency "gyoku",    "~> 1.2"
   s.add_dependency "builder",  ">= 2.1.2"
   s.add_dependency "nokogiri", ">= 1.8.1"
+  s.add_dependency "mail",     "~> 2.5"
 
   s.add_development_dependency "rack"
-  s.add_development_dependency "puma",  "~> 3.0"
+  s.add_development_dependency "puma",  ">= 4.3.8"
 
-  s.add_development_dependency "rake",  "~> 10.1"
-  s.add_development_dependency "rspec", "~> 2.14"
+  s.add_development_dependency "byebug"
+  s.add_development_dependency "rake",  ">= 12.3.3"
+  s.add_development_dependency "rspec", "~> 3.9"
   s.add_development_dependency "mocha", "~> 0.14"
-  s.add_development_dependency "json",  "~> 1.7"
+  s.add_development_dependency "json",  ">= 2.3.0"
 
   ignores  = File.readlines(".gitignore").grep(/\S+/).map(&:chomp)
-  dotfiles = %w[.gitignore .travis.yml .yardopts]
+  dotfiles = %w[.gitignore .yardopts]
 
   all_files_without_ignores = Dir["**/*"].reject { |f|
     File.directory?(f) || ignores.any? { |i| File.fnmatch(i, f) }

data/spec/integration/support/application.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "rack"
 require "json"
 
@@ -6,7 +7,7 @@ class IntegrationServer
   def self.respond_with(options = {})
     code = options.fetch(:code, 200)
     body = options.fetch(:body, "")
-    headers = { "Content-Type" => "text/plain", "Content-Length" => body.size.to_s }
+    headers = { "Content-Type" => "text/plain", "Content-Length" => body.size.to_s }.merge options.fetch(:headers, {})
 
     [code, headers, [body]]
   end
@@ -78,5 +79,36 @@ class IntegrationServer
       run app
     end
 
+    map "/multipart" do
+      run lambda { |env|
+        boundary = 'mimepart_boundary'
+        message = Mail.new
+        xml_part = Mail::Part.new do
+          content_type 'text/xml'
+          body %{<?xml version='1.0' encoding='UTF-8'?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
+  <soapenv:Header>response header</soapenv:Header>
+  <soapenv:Body>response body</soapenv:Body>
+</soapenv:Envelope>}
+          # in Content-Type the start parameter is recommended (RFC 2387)
+          content_id '<soap-request-body@soap>'
+        end
+        message.add_part xml_part
+
+        message.add_file File.expand_path("../../../fixtures/gzip/message.gz", __FILE__)
+        message.parts.last.content_location = 'message.gz'
+        message.parts.last.content_id = 'attachment1'
+
+        message.ready_to_send!
+        message.body.set_sort_order [ "text/xml" ]
+        message.body.encoded(message.content_transfer_encoding)
+
+        IntegrationServer.respond_with({
+          headers: { "Content-Type" => "multipart/related; boundary=\"#{message.body.boundary}\"; type=\"text/xml\"; start=\"#{xml_part.content_id}\"" },
+          body: message.body.encoded(message.content_transfer_encoding)
+        })
+      }
+    end
+
   end
 end

data/spec/integration/support/server.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require "puma"
 require "puma/minissl"
 

data/spec/integration/zipcode_example_spec.rb

@@ -1,18 +1,16 @@
- require "spec_helper"
-
-describe "ZIP code example" do
+# frozen_string_literal: true
+require "spec_helper"
 
+RSpec.describe "ZIP code example" do
   it "supports threads making requests simultaneously" do
     client = Savon.client(
-      # The WSDL document provided by the service.
       :wsdl => "http://www.thomas-bayer.com/axis2/services/BLZService?wsdl",
 
       # Lower timeouts so these specs don't take forever when the service is not available.
       :open_timeout => 10,
       :read_timeout => 10,
 
-      # Disable logging for cleaner spec output.
-      :log => false
+      :log => false # Disable logging for cleaner spec output.
     )
 
     mutex = Mutex.new
@@ -22,7 +20,7 @@ describe "ZIP code example" do
 
     threads = request_data.map do |blz|
       thread = Thread.new do
-        response = call_and_fail_gracefully client, :get_bank, :message => { :blz => blz }
+        response = call_and_fail_gracefully(client, :get_bank, :message => { :blz => blz })
         Thread.current[:value] = response.body[:get_bank_response][:details]
         mutex.synchronize { threads_waiting -= 1 }
       end
@@ -38,5 +36,4 @@ describe "ZIP code example" do
 
     expect(values.uniq.size).to eq(values.size)
   end
-
 end

data/spec/savon/builder_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require "spec_helper"
 
-describe Savon::Builder do
+RSpec.describe Savon::Builder do
 
   subject(:builder) { Savon::Builder.new(:authenticate, wsdl, globals, locals) }
 

data/spec/savon/client_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require "spec_helper"
 require "integration/support/server"
 
-describe Savon::Client do
+RSpec.describe Savon::Client do
 
   before :all do
     @server = IntegrationServer.run
@@ -231,15 +232,15 @@ describe Savon::Client do
     end
 
     it "raises when the operation name is not a symbol" do
-      expect { new_client.build_request("not a symbol") }.to raise_error
+      expect { new_client.build_request("not a symbol") }.to raise_error ArgumentError
     end
 
     it "raises when given an unknown option via the Hash syntax" do
-      expect { new_client.build_request(:authenticate, :invalid_local_option => true) }.to raise_error
+      expect { new_client.build_request(:authenticate, :invalid_local_option => true) }.to raise_error Savon::UnknownOptionError
     end
 
     it "raises when given an unknown option via the block syntax" do
-      expect { new_client.build_request(:authenticate) { another_invalid_local_option true } }.to raise_error
+      expect { new_client.build_request(:authenticate) { another_invalid_local_option true } }.to raise_error Savon::UnknownOptionError
     end
   end
 

data/spec/savon/core_ext/string_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require "spec_helper"
 
-describe String do
+RSpec.describe String do
 
   describe "snakecase" do
     it "lowercases one word CamelCase" do

data/spec/savon/features/message_tag_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
-describe Savon do
+RSpec.describe Savon do
 
   it 'knows the message tag for :authentication' do
     message_tag = message_tag_for(:authentication, :authenticate)

data/spec/savon/http_error_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
 require "spec_helper"
 
-describe Savon::HTTPError do
+RSpec.describe Savon::HTTPError do
   let(:http_error) { Savon::HTTPError.new new_response(:code => 404, :body => "Not Found") }
+  let(:http_error_with_empty_body) { Savon::HTTPError.new new_response(:code => 404, :body => "") }
   let(:no_error) { Savon::HTTPError.new new_response }
 
   it "inherits from Savon::Error" do
@@ -30,6 +32,12 @@ describe Savon::HTTPError do
       it "returns the HTTP error message" do
         expect(http_error.send method).to eq("HTTP error (404): Not Found")
       end
+
+      context "when the body is empty" do
+        it "returns the HTTP error without the body message" do
+          expect(http_error_with_empty_body.send method).to eq("HTTP error (404)")
+        end
+      end
     end
   end
 

data/spec/savon/log_message_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require "spec_helper"
 
-describe Savon::LogMessage do
+RSpec.describe Savon::LogMessage do
 
   it "returns the message if it's not XML" do
     message = log_message("hello", [:password], :pretty_print).to_s

data/spec/savon/message_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require "spec_helper"
 require "integration/support/server"
 
-describe Savon::Message do
+RSpec.describe Savon::Message do
 
   before do
     @server = IntegrationServer.run
@@ -55,16 +56,6 @@ describe Savon::Message do
         end
       end
     end
-
-    context 'wsa:MessageID' do
-      let(:message_id_tag) {
-        '<wsa:MessageID xmlns:wsa="http://schemas.xmlsoap.org/ws/2004/08/addressing">'
-      }
-      it 'should include xmlns:wsa attribute' do
-        response = client.call(:something, message: {})
-        expect(response.xml).to include(message_id_tag)
-      end
-    end
   end
 
 end

data/spec/savon/mock_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require "spec_helper"
 require "savon/mock/spec_helper"
 
-describe "Savon's mock interface" do
+RSpec.describe "Savon's mock interface" do
   include Savon::SpecHelper
 
   before :all do

data/spec/savon/model_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require "spec_helper"
 require "integration/support/server"
 
-describe Savon::Model do
+RSpec.describe Savon::Model do
 
   before :all do
     @server = IntegrationServer.run

data/spec/savon/multipart_request_spec.rb

@@ -0,0 +1,46 @@
+require "spec_helper"
+
+RSpec.describe Savon::Builder do
+
+  let(:globals)     { Savon::GlobalOptions.new({ :endpoint => "http://example.co", :namespace => "http://v1.example.com" }) }
+  let(:no_wsdl)     { Wasabi::Document.new }
+
+  it "building multipart request from inline content" do
+    locals = {
+      attachments: [
+        { filename: 'x1.xml', content: '<xml>abc1</xml>'},
+        { filename: 'x2.xml', content: '<xml>abc2</xml>'},
+      ]
+    }
+    builder = Savon::Builder.new(:operation1, no_wsdl, globals, Savon::LocalOptions.new(locals))
+    request_body = builder.to_s
+
+    expect(request_body).to include('Content-Type')
+    expect(request_body).to match(/<[a-z]+:operation1>/)
+
+    locals[:attachments].each do |attachment|
+      expect(request_body).to match(/^Content-Location: #{attachment[:filename]}\s$/)
+      expect(request_body).to include(Base64.encode64(attachment[:content]).strip)
+    end
+
+  end
+
+  it "building multipart request from file" do
+    locals = {
+      attachments: {
+        'file.gz' => File.expand_path("../../fixtures/gzip/message.gz", __FILE__)
+      }
+    }
+    builder = Savon::Builder.new(:operation1, no_wsdl, globals, Savon::LocalOptions.new(locals))
+    request_body = builder.to_s
+
+    expect(request_body).to include('Content-Type')
+    expect(request_body).to match(/<[a-z]+:operation1>/)
+
+    locals[:attachments].each do |id, file|
+      expect(request_body).to match(/^Content-Location: #{id}\s$/)
+      expect(request_body.gsub("\r", "")).to include(Base64.encode64(File.read(file)).strip)
+    end
+
+  end
+end

data/spec/savon/observers_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require "spec_helper"
 require "integration/support/server"
 
-describe Savon do
+RSpec.describe Savon do
 
   before :all do
     @server = IntegrationServer.run

data/spec/savon/operation_spec.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require "spec_helper"
 require "integration/support/server"
 require "json"
 require "ostruct"
 
-describe Savon::Operation do
+RSpec.describe Savon::Operation do
 
   let(:globals) { Savon::GlobalOptions.new(:endpoint => @server.url(:repeat), :log => false) }
   let(:wsdl)    { Wasabi::Document.new Fixture.wsdl(:taxcloud) }
@@ -108,7 +109,7 @@ describe Savon::Operation do
     it "sets the Content-Length header" do
       # XXX: probably the worst spec ever written. refactor! [dh, 2013-01-05]
       http_request = HTTPI::Request.new
-      http_request.headers.expects(:[]=).with("Content-Length", "312")
+      http_request.headers.expects(:[]=).with("Content-Length", "723")
       Savon::SOAPRequest.any_instance.expects(:build).returns(http_request)
 
       new_operation(:verify_address, wsdl, globals).call
@@ -165,40 +166,28 @@ describe Savon::Operation do
       expect(actual_soap_action).to eq(%("authenticate"))
     end
 
-    it "returns a Savon::Multipart::Response if available and requested globally" do
-      globals.multipart true
-
-      with_multipart_mocked do
-        operation = new_operation(:authenticate, no_wsdl, globals)
-        response = operation.call
-
-        expect(response).to be_a(Savon::Multipart::Response)
+    it "handle multipart response" do
+      globals.endpoint @server.url(:multipart)
+      operation = new_operation(:example, no_wsdl, globals)
+      response = operation.call do
+        attachments [
+          { filename: 'x1.xml', content: '<xml>abc</xml>'},
+          { filename: 'x2.xml', content: '<xml>cde</xml>'},
+        ]
       end
-    end
-
-    it "returns a Savon::Multipart::Response if available and requested locally" do
-      with_multipart_mocked do
-        operation = new_operation(:authenticate, no_wsdl, globals)
-        response = operation.call(:multipart => true)
 
-        expect(response).to be_a(Savon::Multipart::Response)
-      end
+      expect(response.multipart?).to be true
+      expect(response.header).to eq 'response header'
+      expect(response.body).to eq 'response body'
+      expect(response.attachments.first.content_id).to eq 'attachment1'
     end
 
-    it "raises if savon-multipart is not available and it was requested globally" do
-      globals.multipart true
-
-      operation = new_operation(:authenticate, no_wsdl, globals)
+    it "simple request is not multipart" do
+      operation = new_operation(:example, no_wsdl, globals)
+      response = operation.call
 
-      expect { operation.call }.
-        to raise_error RuntimeError, /Unable to find Savon::Multipart/
-    end
-
-    it "raises if savon-multipart is not available and it was requested locally" do
-      operation = new_operation(:authenticate, no_wsdl, globals)
-
-      expect { operation.call(:multipart => true) }.
-        to raise_error RuntimeError, /Unable to find Savon::Multipart/
+      expect(response.multipart?).to be false
+      expect(response.attachments).to be_empty
     end
   end
 
@@ -211,18 +200,6 @@ describe Savon::Operation do
     end
   end
 
-  def with_multipart_mocked
-    multipart_response = Class.new { def initialize(*args); end }
-    multipart_mock = Module.new
-    multipart_mock.const_set('Response', multipart_response)
-
-    Savon.const_set('Multipart', multipart_mock)
-
-    yield
-  ensure
-    Savon.send(:remove_const, :Multipart) if Savon.const_defined? :Multipart
-  end
-
   def inspect_request(response)
     hash = JSON.parse(response.http.body)
     OpenStruct.new(hash)

data/spec/savon/options_spec.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
 require "spec_helper"
 require "integration/support/server"
 require "json"
 require "ostruct"
 require "logger"
 
-describe "Options" do
+RSpec.describe "Options" do
 
   before :all do
     @server = IntegrationServer.run
@@ -398,6 +399,26 @@ describe "Options" do
     end
   end
 
+  context "global :log_headers" do
+    it "instructs Savon to log SOAP requests and responses headers" do
+      stdout = mock_stdout {
+        client = new_client(:endpoint => @server.url, :log => true)
+        client.call(:authenticate)
+      }
+      soap_header = stdout.string.include? "Content-Type"
+      expect(soap_header).to be true
+    end
+
+    it "stops Savon from logging SOAP requests and responses headers" do
+      stdout = mock_stdout {
+        client = new_client(:endpoint => @server.url, :log => true, :log_headers => false)
+        client.call(:authenticate)
+      }
+      soap_header = stdout.string.include? "Content-Type"
+      expect(soap_header).to be false
+    end
+  end
+
   context "global :ssl_version" do
     it "sets the SSL version to use" do
       HTTPI::Auth::SSL.any_instance.expects(:ssl_version=).with(:TLSv1).twice
@@ -407,6 +428,24 @@ describe "Options" do
     end
   end
 
+  context "global :ssl_min_version" do
+    it "sets the SSL min_version to use" do
+      HTTPI::Auth::SSL.any_instance.expects(:min_version=).with(:TLS1_2).twice
+
+      client = new_client(:endpoint => @server.url, :ssl_min_version => :TLS1_2)
+      client.call(:authenticate)
+    end
+  end
+
+  context "global :ssl_max_version" do
+    it "sets the SSL max_version to use" do
+      HTTPI::Auth::SSL.any_instance.expects(:max_version=).with(:TLS1_2).twice
+
+      client = new_client(:endpoint => @server.url, :ssl_max_version => :TLS1_2)
+      client.call(:authenticate)
+    end
+  end
+
   context "global :ssl_verify_mode" do
     it "sets the verify mode to use" do
       HTTPI::Auth::SSL.any_instance.expects(:verify_mode=).with(:peer).twice

data/spec/savon/qualified_message_spec.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
 require "spec_helper"
 
 module Savon
-  describe QualifiedMessage, "#to_hash" do
+  RSpec.describe QualifiedMessage, "#to_hash" do
 
     context "if a key ends with !" do
       let(:used_namespaces) { {} }

data/spec/savon/request_logger_spec.rb

@@ -1,6 +1,7 @@
+# frozen_string_literal: true
 require "spec_helper"
 
-describe Savon::RequestLogger do
+RSpec.describe Savon::RequestLogger do
 
   subject            { described_class.new(globals) }
   let(:globals)      { Savon::GlobalOptions.new(:log => true, :pretty_print_xml => true) }