faraday 1.0.0 → 2.9.0

data/spec/faraday/response/raise_error_spec.rb

@@ -11,8 +11,10 @@ RSpec.describe Faraday::Response::RaiseError do
         stub.get('forbidden') { [403, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('not-found') { [404, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('proxy-error') { [407, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('request-timeout') { [408, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('conflict') { [409, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('unprocessable-entity') { [422, { 'X-Reason' => 'because' }, 'keep looking'] }
+        stub.get('too-many-requests') { [429, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('4xx') { [499, { 'X-Reason' => 'because' }, 'keep looking'] }
         stub.get('nil-status') { [nil, { 'X-Reason' => 'nil' }, 'fail'] }
         stub.get('server-error') { [500, { 'X-Error' => 'bailout' }, 'fail'] }
@@ -29,6 +31,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 400')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(400)
+      expect(ex.response_status).to eq(400)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -37,6 +42,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 401')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(401)
+      expect(ex.response_status).to eq(401)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -45,6 +53,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 403')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(403)
+      expect(ex.response_status).to eq(403)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -53,6 +64,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 404')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(404)
+      expect(ex.response_status).to eq(404)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -61,6 +75,20 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('407 "Proxy Authentication Required"')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(407)
+      expect(ex.response_status).to eq(407)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+
+  it 'raises Faraday::RequestTimeoutError for 408 responses' do
+    expect { conn.get('request-timeout') }.to raise_error(Faraday::RequestTimeoutError) do |ex|
+      expect(ex.message).to eq('the server responded with status 408')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(408)
+      expect(ex.response_status).to eq(408)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -69,6 +97,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 409')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(409)
+      expect(ex.response_status).to eq(409)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -77,6 +108,20 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 422')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(422)
+      expect(ex.response_status).to eq(422)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
+    end
+  end
+
+  it 'raises Faraday::TooManyRequestsError for 429 responses' do
+    expect { conn.get('too-many-requests') }.to raise_error(Faraday::TooManyRequestsError) do |ex|
+      expect(ex.message).to eq('the server responded with status 429')
+      expect(ex.response[:headers]['X-Reason']).to eq('because')
+      expect(ex.response[:status]).to eq(429)
+      expect(ex.response_status).to eq(429)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -85,6 +130,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('http status could not be derived from the server response')
       expect(ex.response[:headers]['X-Reason']).to eq('nil')
       expect(ex.response[:status]).to be_nil
+      expect(ex.response_status).to be_nil
+      expect(ex.response_body).to eq('fail')
+      expect(ex.response_headers['X-Reason']).to eq('nil')
     end
   end
 
@@ -93,6 +141,9 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 499')
       expect(ex.response[:headers]['X-Reason']).to eq('because')
       expect(ex.response[:status]).to eq(499)
+      expect(ex.response_status).to eq(499)
+      expect(ex.response_body).to eq('keep looking')
+      expect(ex.response_headers['X-Reason']).to eq('because')
     end
   end
 
@@ -101,6 +152,60 @@ RSpec.describe Faraday::Response::RaiseError do
       expect(ex.message).to eq('the server responded with status 500')
       expect(ex.response[:headers]['X-Error']).to eq('bailout')
       expect(ex.response[:status]).to eq(500)
+      expect(ex.response_status).to eq(500)
+      expect(ex.response_body).to eq('fail')
+      expect(ex.response_headers['X-Error']).to eq('bailout')
+    end
+  end
+
+  describe 'request info' do
+    let(:conn) do
+      Faraday.new do |b|
+        b.response :raise_error, **middleware_options
+        b.adapter :test do |stub|
+          stub.post(url, request_body, request_headers) do
+            [400, { 'X-Reason' => 'because' }, 'keep looking']
+          end
+        end
+      end
+    end
+    let(:middleware_options) { {} }
+    let(:request_body) { JSON.generate({ 'item' => 'sth' }) }
+    let(:request_headers) { { 'Authorization' => 'Basic 123' } }
+    let(:url_path) { 'request' }
+    let(:query_params) { 'full=true' }
+    let(:url) { "#{url_path}?#{query_params}" }
+
+    subject(:perform_request) do
+      conn.post url do |req|
+        req.headers['Authorization'] = 'Basic 123'
+        req.body = request_body
+      end
+    end
+
+    it 'returns the request info in the exception' do
+      expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
+        expect(ex.response[:request][:method]).to eq(:post)
+        expect(ex.response[:request][:url]).to eq(URI("http:/#{url}"))
+        expect(ex.response[:request][:url_path]).to eq("/#{url_path}")
+        expect(ex.response[:request][:params]).to eq({ 'full' => 'true' })
+        expect(ex.response[:request][:headers]).to match(a_hash_including(request_headers))
+        expect(ex.response[:request][:body]).to eq(request_body)
+      end
+    end
+
+    context 'when the include_request option is set to false' do
+      let(:middleware_options) { { include_request: false } }
+
+      it 'does not include request info in the exception' do
+        expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
+          expect(ex.response.keys).to contain_exactly(
+            :status,
+            :headers,
+            :body
+          )
+        end
+      end
     end
   end
 end

data/spec/faraday/response_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Faraday::Response do
   subject { Faraday::Response.new(env) }
 
   let(:env) do
-    Faraday::Env.from(status: 404, body: 'yikes',
+    Faraday::Env.from(status: 404, body: 'yikes', url: Faraday::Utils.URI('https://lostisland.github.io/faraday'),
                       response_headers: { 'Content-Type' => 'text/plain' })
   end
 
@@ -30,6 +30,7 @@ RSpec.describe Faraday::Response do
     it { expect(hash[:status]).to eq(subject.status) }
     it { expect(hash[:response_headers]).to eq(subject.headers) }
     it { expect(hash[:body]).to eq(subject.body) }
+    it { expect(hash[:url]).to eq(subject.env.url) }
   end
 
   describe 'marshal serialization support' do
@@ -45,6 +46,7 @@ RSpec.describe Faraday::Response do
     it { expect(loaded.env[:body]).to eq(env[:body]) }
     it { expect(loaded.env[:response_headers]).to eq(env[:response_headers]) }
     it { expect(loaded.env[:status]).to eq(env[:status]) }
+    it { expect(loaded.env[:url]).to eq(env[:url]) }
   end
 
   describe '#on_complete' do

data/spec/faraday/utils/headers_spec.rb

@@ -57,26 +57,44 @@ RSpec.describe Faraday::Utils::Headers do
   end
 
   describe '#parse' do
-    before { subject.parse(headers) }
-
     context 'when response headers leave http status line out' do
       let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n" }
 
+      before { subject.parse(headers) }
+
       it { expect(subject.keys).to eq(%w[Content-Type]) }
       it { expect(subject['Content-Type']).to eq('text/html') }
       it { expect(subject['content-type']).to eq('text/html') }
     end
 
     context 'when response headers values include a colon' do
-      let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://sushi.com/\r\n\r\n" }
+      let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://httpbingo.org/\r\n\r\n" }
 
-      it { expect(subject['location']).to eq('http://sushi.com/') }
+      before { subject.parse(headers) }
+
+      it { expect(subject['location']).to eq('http://httpbingo.org/') }
     end
 
     context 'when response headers include a blank line' do
       let(:headers) { "HTTP/1.1 200 OK\r\n\r\nContent-Type: text/html\r\n\r\n" }
 
+      before { subject.parse(headers) }
+
       it { expect(subject['content-type']).to eq('text/html') }
     end
+
+    context 'when response headers include already stored keys' do
+      let(:headers) { "HTTP/1.1 200 OK\r\nX-Numbers: 123\r\n\r\n" }
+
+      before do
+        h = subject
+        h[:x_numbers] = 8
+        h.parse(headers)
+      end
+
+      it do
+        expect(subject[:x_numbers]).to eq('8, 123')
+      end
+    end
   end
 end

data/spec/faraday/utils_spec.rb

@@ -4,7 +4,7 @@ RSpec.describe Faraday::Utils do
   describe 'headers parsing' do
     let(:multi_response_headers) do
       "HTTP/1.x 500 OK\r\nContent-Type: text/html; charset=UTF-8\r\n" \
-      "HTTP/1.x 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n"
+        "HTTP/1.x 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n"
     end
 
     it 'parse headers for aggregated responses' do
@@ -53,4 +53,66 @@ RSpec.describe Faraday::Utils do
       expect(headers).not_to have_key('authorization')
     end
   end
+
+  describe '.deep_merge!' do
+    let(:connection_options) { Faraday::ConnectionOptions.new }
+    let(:url) do
+      {
+        url: 'http://example.com/abc',
+        headers: { 'Mime-Version' => '1.0' },
+        request: { oauth: { consumer_key: 'anonymous' } },
+        ssl: { version: '2' }
+      }
+    end
+
+    it 'recursively merges the headers' do
+      connection_options.headers = { user_agent: 'My Agent 1.0' }
+      deep_merge = Faraday::Utils.deep_merge!(connection_options, url)
+
+      expect(deep_merge.headers).to eq('Mime-Version' => '1.0', user_agent: 'My Agent 1.0')
+    end
+
+    context 'when a target hash has an Options Struct value' do
+      let(:request) do
+        {
+          params_encoder: nil,
+          proxy: nil,
+          bind: nil,
+          timeout: nil,
+          open_timeout: nil,
+          read_timeout: nil,
+          write_timeout: nil,
+          boundary: nil,
+          oauth: { consumer_key: 'anonymous' },
+          context: nil,
+          on_data: nil
+        }
+      end
+      let(:ssl) do
+        {
+          verify: nil,
+          ca_file: nil,
+          ca_path: nil,
+          verify_mode: nil,
+          cert_store: nil,
+          client_cert: nil,
+          client_key: nil,
+          certificate: nil,
+          private_key: nil,
+          verify_depth: nil,
+          version: '2',
+          min_version: nil,
+          max_version: nil,
+          verify_hostname: nil
+        }
+      end
+
+      it 'does not overwrite an Options Struct value' do
+        deep_merge = Faraday::Utils.deep_merge!(connection_options, url)
+
+        expect(deep_merge.request.to_h).to eq(request)
+        expect(deep_merge.ssl.to_h).to eq(ssl)
+      end
+    end
+  end
 end

data/spec/faraday_spec.rb

@@ -18,10 +18,14 @@ RSpec.describe Faraday do
     end
 
     it 'uses method_missing on Faraday if there is no proxyable method' do
-      expect { Faraday.this_method_does_not_exist }.to raise_error(
-        NoMethodError,
-        "undefined method `this_method_does_not_exist' for Faraday:Module"
-      )
+      expected_message =
+        if RUBY_VERSION >= '3.3'
+          "undefined method `this_method_does_not_exist' for module Faraday"
+        else
+          "undefined method `this_method_does_not_exist' for Faraday:Module"
+        end
+
+      expect { Faraday.this_method_does_not_exist }.to raise_error(NoMethodError, expected_message)
     end
 
     it 'proxied methods can be accessed' do

data/spec/spec_helper.rb

@@ -29,14 +29,15 @@ SimpleCov.start do
   minimum_coverage_by_file 26
 end
 
-# Ensure all /lib files are loaded
-# so they will be included in the test coverage report.
-Dir['./lib/**/*.rb'].sort.each { |file| require file }
-
 require 'faraday'
 require 'pry'
 
-Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
+# Ensure all /lib files are loaded
+# so they will be included in the test coverage report.
+Dir['./lib/**/*.rb'].each { |file| require file }
+
+# Load all Rspec support files
+Dir['./spec/support/**/*.rb'].each { |file| require file }
 
 RSpec.configure do |config|
   # rspec-expectations config goes here. You can use an alternate

data/spec/support/fake_safe_buffer.rb

@@ -8,7 +8,7 @@ FakeSafeBuffer = Struct.new(:string) do
 
   def gsub(regex)
     string.gsub(regex) do
-      match, = $&, '' =~ /a/
+      match, = Regexp.last_match(0), '' =~ /a/ # rubocop:disable Performance/StringInclude
       yield(match)
     end
   end

data/spec/support/helper_methods.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'multipart_parser/reader'
-
 module Faraday
   module HelperMethods
     def self.included(base)
@@ -86,41 +84,6 @@ module Faraday
       end
     end
 
-    def multipart_file
-      Faraday::FilePart.new(__FILE__, 'text/x-ruby')
-    end
-
-    # parse boundary out of a Content-Type header like:
-    #   Content-Type: multipart/form-data; boundary=gc0p4Jq0M2Yt08jU534c0p
-    def parse_multipart_boundary(ctype)
-      MultipartParser::Reader.extract_boundary_value(ctype)
-    end
-
-    # parse a multipart MIME message, returning a hash of any multipart errors
-    def parse_multipart(boundary, body)
-      reader = MultipartParser::Reader.new(boundary)
-      result = { errors: [], parts: [] }
-      def result.part(name)
-        hash = self[:parts].detect { |h| h[:part].name == name }
-        [hash[:part], hash[:body].join]
-      end
-
-      reader.on_part do |part|
-        result[:parts] << thispart = {
-          part: part,
-          body: []
-        }
-        part.on_data do |chunk|
-          thispart[:body] << chunk
-        end
-      end
-      reader.on_error do |msg|
-        result[:errors] << msg
-      end
-      reader.write(body)
-      result
-    end
-
     def method_with_body?(method)
       self.class.method_with_body?(method)
     end

data/spec/support/shared_examples/adapter.rb

@@ -33,20 +33,21 @@ shared_examples 'adapter examples' do |**options|
 
   let(:protocol) { ssl_mode? ? 'https' : 'http' }
   let(:remote) { "#{protocol}://example.com" }
+  let(:stub_remote) { remote }
 
   let(:conn) do
     conn_options[:ssl] ||= {}
-    conn_options[:ssl][:ca_file] ||= ENV['SSL_FILE']
+    conn_options[:ssl][:ca_file] ||= ENV.fetch('SSL_FILE', nil)
+    conn_options[:ssl][:verify_hostname] ||= ENV['SSL_VERIFY_HOSTNAME'] == 'yes'
 
     Faraday.new(remote, conn_options) do |conn|
-      conn.request :multipart
       conn.request :url_encoded
       conn.response :raise_error
       conn.adapter described_class, *adapter_options
     end
   end
 
-  let!(:request_stub) { stub_request(http_method, remote) }
+  let!(:request_stub) { stub_request(http_method, stub_remote) }
 
   after do
     expect(request_stub).to have_been_requested unless request_stub.disabled?

data/spec/support/shared_examples/request_method.rb

@@ -1,5 +1,19 @@
 # frozen_string_literal: true
 
+shared_examples 'proxy examples' do
+  it 'handles requests with proxy' do
+    res = conn.public_send(http_method, '/')
+
+    expect(res.status).to eq(200)
+  end
+
+  it 'handles proxy failures' do
+    request_stub.to_return(status: 407)
+
+    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+  end
+end
+
 shared_examples 'a request method' do |http_method|
   let(:query_or_body) { method_with_body?(http_method) ? :body : :query }
   let(:response) { conn.public_send(http_method, '/') }
@@ -13,8 +27,8 @@ shared_examples 'a request method' do |http_method|
   end
 
   it 'handles headers with multiple values' do
-    request_stub.to_return(headers: { 'Set-Cookie' => 'one, two' })
-    expect(response.headers['set-cookie']).to eq('one, two')
+    request_stub.to_return(headers: { 'Set-Cookie' => 'name=value' })
+    expect(response.headers['set-cookie']).to eq('name=value')
   end
 
   it 'retrieves the response headers' do
@@ -65,7 +79,7 @@ shared_examples 'a request method' do |http_method|
 
   on_feature :request_body_on_query_methods do
     it 'sends request body' do
-      request_stub.with(Hash[:body, 'test'])
+      request_stub.with({ body: 'test' })
       res = if query_or_body == :body
               conn.public_send(http_method, '/', 'test')
             else
@@ -79,7 +93,7 @@ shared_examples 'a request method' do |http_method|
 
   it 'sends url encoded parameters' do
     payload = { name: 'zack' }
-    request_stub.with(Hash[query_or_body, payload])
+    request_stub.with({ query_or_body => payload })
     res = conn.public_send(http_method, '/', payload)
     if query_or_body == :query
       expect(res.env.request_body).to be_nil
@@ -90,7 +104,7 @@ shared_examples 'a request method' do |http_method|
 
   it 'sends url encoded nested parameters' do
     payload = { name: { first: 'zack' } }
-    request_stub.with(Hash[query_or_body, payload])
+    request_stub.with({ query_or_body => payload })
     conn.public_send(http_method, '/', payload)
   end
 
@@ -112,19 +126,6 @@ shared_examples 'a request method' do |http_method|
     expect { conn.public_send(http_method, '/') }.to raise_error(exc)
   end
 
-  # Can't send files on get, head and delete methods
-  if method_with_body?(http_method)
-    it 'sends files' do
-      payload = { uploaded_file: multipart_file }
-      request_stub.with(headers: { 'Content-Type' => %r{\Amultipart/form-data} }) do |request|
-        # WebMock does not support matching body for multipart/form-data requests yet :(
-        # https://github.com/bblimke/webmock/issues/623
-        request.body =~ /RubyMultipartPost/
-      end
-      conn.public_send(http_method, '/', payload)
-    end
-  end
-
   on_feature :reason_phrase_parse do
     it 'parses the reason phrase' do
       request_stub.to_return(status: [200, 'OK'])
@@ -152,12 +153,19 @@ shared_examples 'a request method' do |http_method|
       let(:streamed) { [] }
 
       context 'when response is empty' do
-        it do
+        it 'handles streaming' do
+          env = nil
           conn.public_send(http_method, '/') do |req|
-            req.options.on_data = proc { |*args| streamed << args }
+            req.options.on_data = proc do |chunk, size, block_env|
+              streamed << [chunk, size]
+              env ||= block_env
+            end
           end
 
           expect(streamed).to eq([['', 0]])
+          # TODO: enable this after updating all existing adapters to the new streaming API
+          # expect(env).to be_a(Faraday::Env)
+          # expect(env.status).to eq(200)
         end
       end
 
@@ -165,12 +173,19 @@ shared_examples 'a request method' do |http_method|
         before { request_stub.to_return(body: big_string) }
 
         it 'handles streaming' do
+          env = nil
           response = conn.public_send(http_method, '/') do |req|
-            req.options.on_data = proc { |*args| streamed << args }
+            req.options.on_data = proc do |chunk, size, block_env|
+              streamed << [chunk, size]
+              env ||= block_env
+            end
           end
 
           expect(response.body).to eq('')
           check_streaming_response(streamed, chunk_size: 16 * 1024)
+          # TODO: enable this after updating all existing adapters to the new streaming API
+          # expect(env).to be_a(Faraday::Env)
+          # expect(env.status).to eq(200)
         end
       end
     end
@@ -185,11 +200,11 @@ shared_examples 'a request method' do |http_method|
         @payload2 = { b: '2' }
 
         request_stub
-          .with(Hash[query_or_body, @payload1])
+          .with({ query_or_body => @payload1 })
           .to_return(body: @payload1.to_json)
 
         stub_request(http_method, remote)
-          .with(Hash[query_or_body, @payload2])
+          .with({ query_or_body => @payload2 })
           .to_return(body: @payload2.to_json)
 
         conn.in_parallel do
@@ -218,17 +233,31 @@ shared_examples 'a request method' do |http_method|
     end
   end
 
-  it 'handles requests with proxy' do
-    conn_options[:proxy] = 'http://google.co.uk'
+  context 'when a proxy is provided as option' do
+    before do
+      conn_options[:proxy] = 'http://env-proxy.com:80'
+    end
 
-    res = conn.public_send(http_method, '/')
-    expect(res.status).to eq(200)
+    include_examples 'proxy examples'
   end
 
-  it 'handles proxy failures' do
-    conn_options[:proxy] = 'http://google.co.uk'
-    request_stub.to_return(status: 407)
+  context 'when http_proxy env variable is set' do
+    let(:proxy_url) { 'http://env-proxy.com:80' }
 
-    expect { conn.public_send(http_method, '/') }.to raise_error(Faraday::ProxyAuthError)
+    around do |example|
+      with_env 'http_proxy' => proxy_url do
+        example.run
+      end
+    end
+
+    include_examples 'proxy examples'
+
+    context 'when the env proxy is ignored' do
+      around do |example|
+        with_env_proxy_disabled(&example)
+      end
+
+      include_examples 'proxy examples'
+    end
   end
 end