faraday 1.7.1 → 2.2.0

data/spec/faraday/request/multipart_spec.rb

@@ -1,302 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Faraday::Request::Multipart do
-  let(:options) { {} }
-  let(:conn) do
-    Faraday.new do |b|
-      b.request :multipart, options
-      b.request :url_encoded
-      b.adapter :test do |stub|
-        stub.post('/echo') do |env|
-          posted_as = env[:request_headers]['Content-Type']
-          expect(env[:body]).to be_a_kind_of(Faraday::CompositeReadIO)
-          [200, { 'Content-Type' => posted_as }, env[:body].read]
-        end
-      end
-    end
-  end
-
-  shared_examples 'a multipart request' do
-    it 'generates a unique boundary for each request' do
-      response1 = conn.post('/echo', payload)
-      response2 = conn.post('/echo', payload)
-
-      b1 = parse_multipart_boundary(response1.headers['Content-Type'])
-      b2 = parse_multipart_boundary(response2.headers['Content-Type'])
-      expect(b1).to_not eq(b2)
-    end
-  end
-
-  context 'FilePart: when multipart objects in param' do
-    let(:payload) do
-      {
-        a: 1,
-        b: {
-          c: Faraday::FilePart.new(__FILE__, 'text/x-ruby', nil,
-                                   'Content-Disposition' => 'form-data; foo=1'),
-          d: 2
-        }
-      }
-    end
-    it_behaves_like 'a multipart request'
-
-    it 'forms a multipart request' do
-      response = conn.post('/echo', payload)
-
-      boundary = parse_multipart_boundary(response.headers['Content-Type'])
-      result = parse_multipart(boundary, response.body)
-      expect(result[:errors]).to be_empty
-
-      part_a, body_a = result.part('a')
-      expect(part_a).to_not be_nil
-      expect(part_a.filename).to be_nil
-      expect(body_a).to eq('1')
-
-      part_bc, body_bc = result.part('b[c]')
-      expect(part_bc).to_not be_nil
-      expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition'])
-        .to eq(
-          'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
-        )
-      expect(part_bc.headers['content-type']).to eq('text/x-ruby')
-      expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
-      expect(body_bc).to eq(File.read(__FILE__))
-
-      part_bd, body_bd = result.part('b[d]')
-      expect(part_bd).to_not be_nil
-      expect(part_bd.filename).to be_nil
-      expect(body_bd).to eq('2')
-    end
-  end
-
-  context 'FilePart: when providing json and IO content in the same payload' do
-    let(:io) { StringIO.new('io-content') }
-    let(:json) do
-      {
-        b: 1,
-        c: 2
-      }.to_json
-    end
-
-    let(:payload) do
-      {
-        json: Faraday::ParamPart.new(json, 'application/json'),
-        io: Faraday::FilePart.new(io, 'application/pdf')
-      }
-    end
-
-    it_behaves_like 'a multipart request'
-
-    it 'forms a multipart request' do
-      response = conn.post('/echo', payload)
-
-      boundary = parse_multipart_boundary(response.headers['Content-Type'])
-      result = parse_multipart(boundary, response.body)
-      expect(result[:errors]).to be_empty
-
-      part_json, body_json = result.part('json')
-      expect(part_json).to_not be_nil
-      expect(part_json.mime).to eq('application/json')
-      expect(part_json.filename).to be_nil
-      expect(body_json).to eq(json)
-
-      part_io, body_io = result.part('io')
-      expect(part_io).to_not be_nil
-      expect(part_io.mime).to eq('application/pdf')
-      expect(part_io.filename).to eq('local.path')
-      expect(body_io).to eq(io.string)
-    end
-  end
-
-  context 'FilePart: when multipart objects in array param' do
-    let(:payload) do
-      {
-        a: 1,
-        b: [{
-          c: Faraday::FilePart.new(__FILE__, 'text/x-ruby'),
-          d: 2
-        }]
-      }
-    end
-
-    it_behaves_like 'a multipart request'
-
-    it 'forms a multipart request' do
-      response = conn.post('/echo', payload)
-
-      boundary = parse_multipart_boundary(response.headers['Content-Type'])
-      result = parse_multipart(boundary, response.body)
-      expect(result[:errors]).to be_empty
-
-      part_a, body_a = result.part('a')
-      expect(part_a).to_not be_nil
-      expect(part_a.filename).to be_nil
-      expect(body_a).to eq('1')
-
-      part_bc, body_bc = result.part('b[][c]')
-      expect(part_bc).to_not be_nil
-      expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition'])
-        .to eq(
-          'form-data; name="b[][c]"; filename="multipart_spec.rb"'
-        )
-      expect(part_bc.headers['content-type']).to eq('text/x-ruby')
-      expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
-      expect(body_bc).to eq(File.read(__FILE__))
-
-      part_bd, body_bd = result.part('b[][d]')
-      expect(part_bd).to_not be_nil
-      expect(part_bd.filename).to be_nil
-      expect(body_bd).to eq('2')
-    end
-  end
-
-  context 'UploadIO: when multipart objects in param' do
-    let(:payload) do
-      {
-        a: 1,
-        b: {
-          c: Faraday::UploadIO.new(__FILE__, 'text/x-ruby', nil,
-                                   'Content-Disposition' => 'form-data; foo=1'),
-          d: 2
-        }
-      }
-    end
-    it_behaves_like 'a multipart request'
-
-    it 'forms a multipart request' do
-      response = conn.post('/echo', payload)
-
-      boundary = parse_multipart_boundary(response.headers['Content-Type'])
-      result = parse_multipart(boundary, response.body)
-      expect(result[:errors]).to be_empty
-
-      part_a, body_a = result.part('a')
-      expect(part_a).to_not be_nil
-      expect(part_a.filename).to be_nil
-      expect(body_a).to eq('1')
-
-      part_bc, body_bc = result.part('b[c]')
-      expect(part_bc).to_not be_nil
-      expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition'])
-        .to eq(
-          'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
-        )
-      expect(part_bc.headers['content-type']).to eq('text/x-ruby')
-      expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
-      expect(body_bc).to eq(File.read(__FILE__))
-
-      part_bd, body_bd = result.part('b[d]')
-      expect(part_bd).to_not be_nil
-      expect(part_bd.filename).to be_nil
-      expect(body_bd).to eq('2')
-    end
-  end
-
-  context 'UploadIO: when providing json and IO content in the same payload' do
-    let(:io) { StringIO.new('io-content') }
-    let(:json) do
-      {
-        b: 1,
-        c: 2
-      }.to_json
-    end
-
-    let(:payload) do
-      {
-        json: Faraday::ParamPart.new(json, 'application/json'),
-        io: Faraday::UploadIO.new(io, 'application/pdf')
-      }
-    end
-
-    it_behaves_like 'a multipart request'
-
-    it 'forms a multipart request' do
-      response = conn.post('/echo', payload)
-
-      boundary = parse_multipart_boundary(response.headers['Content-Type'])
-      result = parse_multipart(boundary, response.body)
-      expect(result[:errors]).to be_empty
-
-      part_json, body_json = result.part('json')
-      expect(part_json).to_not be_nil
-      expect(part_json.mime).to eq('application/json')
-      expect(part_json.filename).to be_nil
-      expect(body_json).to eq(json)
-
-      part_io, body_io = result.part('io')
-      expect(part_io).to_not be_nil
-      expect(part_io.mime).to eq('application/pdf')
-      expect(part_io.filename).to eq('local.path')
-      expect(body_io).to eq(io.string)
-    end
-  end
-
-  context 'UploadIO: when multipart objects in array param' do
-    let(:payload) do
-      {
-        a: 1,
-        b: [{
-          c: Faraday::UploadIO.new(__FILE__, 'text/x-ruby'),
-          d: 2
-        }]
-      }
-    end
-
-    it_behaves_like 'a multipart request'
-
-    it 'forms a multipart request' do
-      response = conn.post('/echo', payload)
-
-      boundary = parse_multipart_boundary(response.headers['Content-Type'])
-      result = parse_multipart(boundary, response.body)
-      expect(result[:errors]).to be_empty
-
-      part_a, body_a = result.part('a')
-      expect(part_a).to_not be_nil
-      expect(part_a.filename).to be_nil
-      expect(body_a).to eq('1')
-
-      part_bc, body_bc = result.part('b[][c]')
-      expect(part_bc).to_not be_nil
-      expect(part_bc.filename).to eq('multipart_spec.rb')
-      expect(part_bc.headers['content-disposition'])
-        .to eq(
-          'form-data; name="b[][c]"; filename="multipart_spec.rb"'
-        )
-      expect(part_bc.headers['content-type']).to eq('text/x-ruby')
-      expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
-      expect(body_bc).to eq(File.read(__FILE__))
-
-      part_bd, body_bd = result.part('b[][d]')
-      expect(part_bd).to_not be_nil
-      expect(part_bd.filename).to be_nil
-      expect(body_bd).to eq('2')
-    end
-  end
-
-  context 'when passing flat_encode=true option' do
-    let(:options) { { flat_encode: true } }
-    let(:io) { StringIO.new('io-content') }
-    let(:payload) do
-      {
-        a: 1,
-        b: [
-          Faraday::UploadIO.new(io, 'application/pdf'),
-          Faraday::UploadIO.new(io, 'application/pdf')
-        ]
-      }
-    end
-
-    it_behaves_like 'a multipart request'
-
-    it 'encode params using flat encoder' do
-      response = conn.post('/echo', payload)
-
-      expect(response.body).to include('name="b"')
-      expect(response.body).not_to include('name="b[]"')
-    end
-  end
-end

data/spec/faraday/request/retry_spec.rb

@@ -1,242 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Faraday::Request::Retry do
-  let(:calls) { [] }
-  let(:times_called) { calls.size }
-  let(:options) { [] }
-  let(:conn) do
-    Faraday.new do |b|
-      b.request :retry, *options
-
-      b.adapter :test do |stub|
-        %w[get post].each do |method|
-          stub.send(method, '/unstable') do |env|
-            calls << env.dup
-            env[:body] = nil # simulate blanking out response body
-            callback.call
-          end
-        end
-      end
-    end
-  end
-
-  context 'when an unexpected error happens' do
-    let(:callback) { -> { raise 'boom!' } }
-
-    before { expect { conn.get('/unstable') }.to raise_error(RuntimeError) }
-
-    it { expect(times_called).to eq(1) }
-
-    context 'and this is passed as a custom exception' do
-      let(:options) { [{ exceptions: StandardError }] }
-
-      it { expect(times_called).to eq(3) }
-    end
-  end
-
-  context 'when an expected error happens' do
-    let(:callback) { -> { raise Errno::ETIMEDOUT } }
-
-    before do
-      @started = Time.now
-      expect { conn.get('/unstable') }.to raise_error(Errno::ETIMEDOUT)
-    end
-
-    it { expect(times_called).to eq(3) }
-
-    context 'and legacy max_retry set to 1' do
-      let(:options) { [1] }
-
-      it { expect(times_called).to eq(2) }
-    end
-
-    context 'and legacy max_retry set to -9' do
-      let(:options) { [-9] }
-
-      it { expect(times_called).to eq(1) }
-    end
-
-    context 'and new max_retry set to 3' do
-      let(:options) { [{ max: 3 }] }
-
-      it { expect(times_called).to eq(4) }
-    end
-
-    context 'and new max_retry set to -9' do
-      let(:options) { [{ max: -9 }] }
-
-      it { expect(times_called).to eq(1) }
-    end
-
-    context 'and both max_retry and interval are set' do
-      let(:options) { [{ max: 2, interval: 0.1 }] }
-
-      it { expect(Time.now - @started).to be_within(0.04).of(0.2) }
-    end
-  end
-
-  context 'when no exception raised' do
-    let(:options) { [{ max: 1, retry_statuses: 429 }] }
-
-    before { conn.get('/unstable') }
-
-    context 'and response code is in retry_statuses' do
-      let(:callback) { -> { [429, {}, ''] } }
-
-      it { expect(times_called).to eq(2) }
-    end
-
-    context 'and response code is not in retry_statuses' do
-      let(:callback) { -> { [503, {}, ''] } }
-
-      it { expect(times_called).to eq(1) }
-    end
-  end
-
-  describe '#calculate_retry_interval' do
-    context 'with exponential backoff' do
-      let(:options) { { max: 5, interval: 0.1, backoff_factor: 2 } }
-      let(:middleware) { Faraday::Request::Retry.new(nil, options) }
-
-      it { expect(middleware.send(:calculate_retry_interval, 5)).to eq(0.1) }
-      it { expect(middleware.send(:calculate_retry_interval, 4)).to eq(0.2) }
-      it { expect(middleware.send(:calculate_retry_interval, 3)).to eq(0.4) }
-    end
-
-    context 'with exponential backoff and max_interval' do
-      let(:options) { { max: 5, interval: 0.1, backoff_factor: 2, max_interval: 0.3 } }
-      let(:middleware) { Faraday::Request::Retry.new(nil, options) }
-
-      it { expect(middleware.send(:calculate_retry_interval, 5)).to eq(0.1) }
-      it { expect(middleware.send(:calculate_retry_interval, 4)).to eq(0.2) }
-      it { expect(middleware.send(:calculate_retry_interval, 3)).to eq(0.3) }
-      it { expect(middleware.send(:calculate_retry_interval, 2)).to eq(0.3) }
-    end
-
-    context 'with exponential backoff and interval_randomness' do
-      let(:options) { { max: 2, interval: 0.1, interval_randomness: 0.05 } }
-      let(:middleware) { Faraday::Request::Retry.new(nil, options) }
-
-      it { expect(middleware.send(:calculate_retry_interval, 2)).to be_between(0.1, 0.105) }
-    end
-  end
-
-  context 'when method is not idempotent' do
-    let(:callback) { -> { raise Errno::ETIMEDOUT } }
-
-    before { expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT) }
-
-    it { expect(times_called).to eq(1) }
-  end
-
-  describe 'retry_if option' do
-    let(:callback) { -> { raise Errno::ETIMEDOUT } }
-    let(:options) { [{ retry_if: @check }] }
-
-    it 'retries if retry_if block always returns true' do
-      body = { foo: :bar }
-      @check = ->(_, _) { true }
-      expect { conn.post('/unstable', body) }.to raise_error(Errno::ETIMEDOUT)
-      expect(times_called).to eq(3)
-      expect(calls.all? { |env| env[:body] == body }).to be_truthy
-    end
-
-    it 'does not retry if retry_if block returns false checking env' do
-      @check = ->(env, _) { env[:method] != :post }
-      expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
-      expect(times_called).to eq(1)
-    end
-
-    it 'does not retry if retry_if block returns false checking exception' do
-      @check = ->(_, exception) { !exception.is_a?(Errno::ETIMEDOUT) }
-      expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
-      expect(times_called).to eq(1)
-    end
-
-    it 'FilePart: should rewind files on retry' do
-      io = StringIO.new('Test data')
-      filepart = Faraday::FilePart.new(io, 'application/octet/stream')
-
-      rewound = 0
-      rewind = -> { rewound += 1 }
-
-      @check = ->(_, _) { true }
-      allow(filepart).to receive(:rewind, &rewind)
-      expect { conn.post('/unstable', file: filepart) }.to raise_error(Errno::ETIMEDOUT)
-      expect(times_called).to eq(3)
-      expect(rewound).to eq(2)
-    end
-
-    it 'UploadIO: should rewind files on retry' do
-      io = StringIO.new('Test data')
-      upload_io = Faraday::UploadIO.new(io, 'application/octet/stream')
-
-      rewound = 0
-      rewind = -> { rewound += 1 }
-
-      @check = ->(_, _) { true }
-      allow(upload_io).to receive(:rewind, &rewind)
-      expect { conn.post('/unstable', file: upload_io) }.to raise_error(Errno::ETIMEDOUT)
-      expect(times_called).to eq(3)
-      expect(rewound).to eq(2)
-    end
-
-    context 'when explicitly specifying methods to retry' do
-      let(:options) { [{ retry_if: @check, methods: [:post] }] }
-
-      it 'does not call retry_if for specified methods' do
-        @check = ->(_, _) { raise 'this should have never been called' }
-        expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
-        expect(times_called).to eq(3)
-      end
-    end
-
-    context 'with empty list of methods to retry' do
-      let(:options) { [{ retry_if: @check, methods: [] }] }
-
-      it 'calls retry_if for all methods' do
-        @check = ->(_, _) { calls.size < 2 }
-        expect { conn.get('/unstable') }.to raise_error(Errno::ETIMEDOUT)
-        expect(times_called).to eq(2)
-      end
-    end
-  end
-
-  describe 'retry_after header support' do
-    let(:callback) { -> { [504, headers, ''] } }
-    let(:elapsed) { Time.now - @started }
-
-    before do
-      @started = Time.now
-      conn.get('/unstable')
-    end
-
-    context 'when retry_after bigger than interval' do
-      let(:headers) { { 'Retry-After' => '0.5' } }
-      let(:options) { [{ max: 1, interval: 0.1, retry_statuses: 504 }] }
-
-      it { expect(elapsed).to be > 0.5 }
-    end
-
-    context 'when retry_after smaller than interval' do
-      let(:headers) { { 'Retry-After' => '0.1' } }
-      let(:options) { [{ max: 1, interval: 0.2, retry_statuses: 504 }] }
-
-      it { expect(elapsed).to be > 0.2 }
-    end
-
-    context 'when retry_after is a timestamp' do
-      let(:headers) { { 'Retry-After' => (Time.now.utc + 2).strftime('%a, %d %b %Y %H:%M:%S GMT') } }
-      let(:options) { [{ max: 1, interval: 0.1, retry_statuses: 504 }] }
-
-      it { expect(elapsed).to be > 1 }
-    end
-
-    context 'when retry_after is bigger than max_interval' do
-      let(:headers) { { 'Retry-After' => (Time.now.utc + 20).strftime('%a, %d %b %Y %H:%M:%S GMT') } }
-      let(:options) { [{ max: 2, interval: 0.1, max_interval: 5, retry_statuses: 504 }] }
-
-      it { expect(times_called).to eq(1) }
-    end
-  end
-end

data/spec/faraday/response/middleware_spec.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Faraday::Response::Middleware do
-  let(:conn) do
-    Faraday.new do |b|
-      b.use custom_middleware
-      b.adapter :test do |stub|
-        stub.get('ok') { [200, { 'Content-Type' => 'text/html' }, '<body></body>'] }
-        stub.get('not_modified') { [304, nil, nil] }
-        stub.get('no_content') { [204, nil, nil] }
-      end
-    end
-  end
-
-  context 'with a custom ResponseMiddleware' do
-    let(:custom_middleware) do
-      Class.new(Faraday::Response::Middleware) do
-        def parse(body)
-          body.upcase
-        end
-      end
-    end
-
-    it 'parses the response' do
-      expect(conn.get('ok').body).to eq('<BODY></BODY>')
-    end
-  end
-
-  context 'with a custom ResponseMiddleware and private parse' do
-    let(:custom_middleware) do
-      Class.new(Faraday::Response::Middleware) do
-        private
-
-        def parse(body)
-          body.upcase
-        end
-      end
-    end
-
-    it 'parses the response' do
-      expect(conn.get('ok').body).to eq('<BODY></BODY>')
-    end
-  end
-
-  context 'with a custom ResponseMiddleware but empty response' do
-    let(:custom_middleware) do
-      Class.new(Faraday::Response::Middleware) do
-        def parse(_body)
-          raise 'this should not be called'
-        end
-      end
-    end
-
-    it 'raises exception for 200 responses' do
-      expect { conn.get('ok') }.to raise_error(StandardError)
-    end
-
-    it 'doesn\'t call the middleware for 204 responses' do
-      expect_any_instance_of(custom_middleware).not_to receive(:parse)
-      expect(conn.get('no_content').body).to be_nil
-    end
-
-    it 'doesn\'t call the middleware for 304 responses' do
-      expect_any_instance_of(custom_middleware).not_to receive(:parse)
-      expect(conn.get('not_modified').body).to be_nil
-    end
-  end
-end

data/spec/support/webmock_rack_app.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-# Rack app used to test the Rack adapter.
-# Uses Webmock to check if requests are registered, in which case it returns
-# the registered response.
-class WebmockRackApp
-  def call(env)
-    req_signature = WebMock::RequestSignature.new(
-      req_method(env),
-      req_uri(env),
-      body: req_body(env),
-      headers: req_headers(env)
-    )
-
-    WebMock::RequestRegistry
-      .instance
-      .requested_signatures
-      .put(req_signature)
-
-    process_response(req_signature)
-  end
-
-  def req_method(env)
-    env['REQUEST_METHOD'].downcase.to_sym
-  end
-
-  def req_uri(env)
-    scheme = env['rack.url_scheme']
-    host = env['SERVER_NAME']
-    port = env['SERVER_PORT']
-    path = env['PATH_INFO']
-    query = env['QUERY_STRING']
-
-    url = +"#{scheme}://#{host}:#{port}#{path}"
-    url += "?#{query}" if query
-
-    uri = WebMock::Util::URI.heuristic_parse(url)
-    uri.path = uri.normalized_path.gsub('[^:]//', '/')
-    uri
-  end
-
-  def req_headers(env)
-    http_headers = env.select { |k, _| k.start_with?('HTTP_') }
-                      .map { |k, v| [k[5..-1], v] }
-                      .to_h
-
-    special_headers = Faraday::Adapter::Rack::SPECIAL_HEADERS
-    http_headers.merge(env.select { |k, _| special_headers.include?(k) })
-  end
-
-  def req_body(env)
-    env['rack.input'].read
-  end
-
-  def process_response(req_signature)
-    res = WebMock::StubRegistry.instance.response_for_request(req_signature)
-
-    if res.nil? && req_signature.uri.host == 'localhost'
-      raise Faraday::ConnectionFailed, 'Trying to connect to localhost'
-    end
-
-    raise WebMock::NetConnectNotAllowedError, req_signature unless res
-
-    raise Faraday::TimeoutError if res.should_timeout
-
-    [res.status[0], res.headers || {}, [res.body || '']]
-  end
-end