faraday 0.17.3 → 1.0.0

data/spec/faraday/rack_builder_spec.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::RackBuilder do
+  # mock handler classes
+  (Handler = Struct.new(:app)).class_eval do
+    def call(env)
+      env[:request_headers]['X-Middleware'] ||= ''
+      env[:request_headers]['X-Middleware'] += ":#{self.class.name.split('::').last}"
+      app.call(env)
+    end
+  end
+
+  class Apple < Handler
+  end
+  class Orange < Handler
+  end
+  class Banana < Handler
+  end
+
+  class Broken < Faraday::Middleware
+    dependency 'zomg/i_dont/exist'
+  end
+
+  subject { conn.builder }
+
+  context 'with default stack' do
+    let(:conn) { Faraday::Connection.new }
+
+    it { expect(subject[0]).to eq(Faraday::Request.lookup_middleware(:url_encoded)) }
+    it { expect(subject.adapter).to eq(Faraday::Adapter.lookup_middleware(Faraday.default_adapter)) }
+  end
+
+  context 'with custom empty block' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    it { expect(subject[0]).to be_nil }
+    it { expect(subject.adapter).to eq(Faraday::Adapter.lookup_middleware(Faraday.default_adapter)) }
+  end
+
+  context 'with custom adapter only' do
+    let(:conn) do
+      Faraday::Connection.new do |builder|
+        builder.adapter :test do |stub|
+          stub.get('/') { |_| [200, {}, ''] }
+        end
+      end
+    end
+
+    it { expect(subject[0]).to be_nil }
+    it { expect(subject.adapter).to eq(Faraday::Adapter.lookup_middleware(:test)) }
+  end
+
+  context 'with custom handler and adapter' do
+    let(:conn) do
+      Faraday::Connection.new do |builder|
+        builder.use Apple
+        builder.adapter :test do |stub|
+          stub.get('/') { |_| [200, {}, ''] }
+        end
+      end
+    end
+
+    it 'locks the stack after making a request' do
+      expect(subject.locked?).to be_falsey
+      conn.get('/')
+      expect(subject.locked?).to be_truthy
+      expect { subject.use(Orange) }.to raise_error(Faraday::RackBuilder::StackLocked)
+    end
+
+    it 'dup stack is unlocked' do
+      expect(subject.locked?).to be_falsey
+      subject.lock!
+      expect(subject.locked?).to be_truthy
+      dup = subject.dup
+      expect(dup).to eq(subject)
+      expect(dup.locked?).to be_falsey
+    end
+
+    it 'allows to compare handlers' do
+      expect(subject.handlers.first).to eq(Faraday::RackBuilder::Handler.new(Apple))
+    end
+  end
+
+  context 'when having a single handler' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    before { subject.use(Apple) }
+
+    it { expect(subject.handlers).to eq([Apple]) }
+
+    it 'allows rebuilding' do
+      subject.build do |builder|
+        builder.use(Orange)
+      end
+      expect(subject.handlers).to eq([Orange])
+    end
+
+    it 'allows use' do
+      subject.use(Orange)
+      expect(subject.handlers).to eq([Apple, Orange])
+    end
+
+    it 'allows insert_before' do
+      subject.insert_before(Apple, Orange)
+      expect(subject.handlers).to eq([Orange, Apple])
+    end
+
+    it 'allows insert_after' do
+      subject.insert_after(Apple, Orange)
+      expect(subject.handlers).to eq([Apple, Orange])
+    end
+
+    it 'raises an error trying to use an unregistered symbol' do
+      expect { subject.use(:apple) }.to raise_error(Faraday::Error) do |err|
+        expect(err.message).to eq(':apple is not registered on Faraday::Middleware')
+      end
+    end
+  end
+
+  context 'with custom registered middleware' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    after { Faraday::Middleware.unregister_middleware(:apple) }
+
+    it 'allows to register with constant' do
+      Faraday::Middleware.register_middleware(apple: Apple)
+      subject.use(:apple)
+      expect(subject.handlers).to eq([Apple])
+    end
+
+    it 'allows to register with symbol' do
+      Faraday::Middleware.register_middleware(apple: :Apple)
+      subject.use(:apple)
+      expect(subject.handlers).to eq([Apple])
+    end
+
+    it 'allows to register with string' do
+      Faraday::Middleware.register_middleware(apple: 'Apple')
+      subject.use(:apple)
+      expect(subject.handlers).to eq([Apple])
+    end
+
+    it 'allows to register with Proc' do
+      Faraday::Middleware.register_middleware(apple: -> { Apple })
+      subject.use(:apple)
+      expect(subject.handlers).to eq([Apple])
+    end
+  end
+
+  context 'when having two handlers' do
+    let(:conn) { Faraday::Connection.new {} }
+
+    before do
+      subject.use(Apple)
+      subject.use(Orange)
+    end
+
+    it 'allows insert_before' do
+      subject.insert_before(Orange, Banana)
+      expect(subject.handlers).to eq([Apple, Banana, Orange])
+    end
+
+    it 'allows insert_after' do
+      subject.insert_after(Apple, Banana)
+      expect(subject.handlers).to eq([Apple, Banana, Orange])
+    end
+
+    it 'allows to swap handlers' do
+      subject.swap(Apple, Banana)
+      expect(subject.handlers).to eq([Banana, Orange])
+    end
+
+    it 'allows to delete a handler' do
+      subject.delete(Apple)
+      expect(subject.handlers).to eq([Orange])
+    end
+  end
+
+  context 'when having a handler with broken dependency' do
+    let(:conn) do
+      Faraday::Connection.new do |builder|
+        builder.adapter :test do |stub|
+          stub.get('/') { |_| [200, {}, ''] }
+        end
+      end
+    end
+
+    before { subject.use(Broken) }
+
+    it 'raises an error while making a request' do
+      expect { conn.get('/') }.to raise_error(RuntimeError) do |err|
+        expect(err.message).to eq('missing dependency for Broken: cannot load such file -- zomg/i_dont/exist')
+      end
+    end
+  end
+end

data/spec/faraday/request/authorization_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Request::Authorization do
+  let(:conn) do
+    Faraday.new do |b|
+      b.request auth_type, *auth_config
+      b.adapter :test do |stub|
+        stub.get('/auth-echo') do |env|
+          [200, {}, env[:request_headers]['Authorization']]
+        end
+      end
+    end
+  end
+
+  shared_examples 'does not interfere with existing authentication' do
+    context 'and request already has an authentication header' do
+      let(:response) { conn.get('/auth-echo', nil, authorization: 'Token token="bar"') }
+
+      it 'does not interfere with existing authorization' do
+        expect(response.body).to eq('Token token="bar"')
+      end
+    end
+  end
+
+  let(:response) { conn.get('/auth-echo') }
+
+  describe 'basic_auth' do
+    let(:auth_type) { :basic_auth }
+
+    context 'when passed correct params' do
+      let(:auth_config) { %w[aladdin opensesame] }
+
+      it { expect(response.body).to eq('Basic YWxhZGRpbjpvcGVuc2VzYW1l') }
+
+      include_examples 'does not interfere with existing authentication'
+    end
+
+    context 'when passed very long values' do
+      let(:auth_config) { ['A' * 255, ''] }
+
+      it { expect(response.body).to eq("Basic #{'QUFB' * 85}Og==") }
+
+      include_examples 'does not interfere with existing authentication'
+    end
+  end
+
+  describe 'token_auth' do
+    let(:auth_type) { :token_auth }
+
+    context 'when passed correct params' do
+      let(:auth_config) { 'quux' }
+
+      it { expect(response.body).to eq('Token token="quux"') }
+
+      include_examples 'does not interfere with existing authentication'
+    end
+
+    context 'when other values are provided' do
+      let(:auth_config) { ['baz', foo: 42] }
+
+      it { expect(response.body).to match(/^Token /) }
+      it { expect(response.body).to match(/token="baz"/) }
+      it { expect(response.body).to match(/foo="42"/) }
+
+      include_examples 'does not interfere with existing authentication'
+    end
+  end
+
+  describe 'authorization' do
+    let(:auth_type) { :authorization }
+
+    context 'when passed two strings' do
+      let(:auth_config) { ['custom', 'abc def'] }
+
+      it { expect(response.body).to eq('custom abc def') }
+
+      include_examples 'does not interfere with existing authentication'
+    end
+
+    context 'when passed a string and a hash' do
+      let(:auth_config) { ['baz', foo: 42] }
+
+      it { expect(response.body).to eq('baz foo="42"') }
+
+      include_examples 'does not interfere with existing authentication'
+    end
+  end
+end

data/spec/faraday/request/instrumentation_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Request::Instrumentation do
+  class FakeInstrumenter
+    attr_reader :instrumentations
+
+    def initialize
+      @instrumentations = []
+    end
+
+    def instrument(name, env)
+      @instrumentations << [name, env]
+      yield
+    end
+  end
+
+  let(:config) { {} }
+  let(:options) { Faraday::Request::Instrumentation::Options.from config }
+  let(:instrumenter) { FakeInstrumenter.new }
+  let(:conn) do
+    Faraday.new do |f|
+      f.request :instrumentation, config.merge(instrumenter: instrumenter)
+      f.adapter :test do |stub|
+        stub.get '/' do
+          [200, {}, 'ok']
+        end
+      end
+    end
+  end
+
+  it { expect(options.name).to eq('request.faraday') }
+  it 'defaults to ActiveSupport::Notifications' do
+    begin
+      res = options.instrumenter
+    rescue NameError => e
+      expect(e.to_s).to match('ActiveSupport')
+    else
+      expect(res).to eq(ActiveSupport::Notifications)
+    end
+  end
+
+  it 'instruments with default name' do
+    expect(instrumenter.instrumentations.size).to eq(0)
+
+    res = conn.get '/'
+    expect(res.body).to eq('ok')
+    expect(instrumenter.instrumentations.size).to eq(1)
+
+    name, env = instrumenter.instrumentations.first
+    expect(name).to eq('request.faraday')
+    expect(env[:url].path).to eq('/')
+  end
+
+  context 'with custom name' do
+    let(:config) { { name: 'custom' } }
+
+    it { expect(options.name).to eq('custom') }
+    it 'instruments with custom name' do
+      expect(instrumenter.instrumentations.size).to eq(0)
+
+      res = conn.get '/'
+      expect(res.body).to eq('ok')
+      expect(instrumenter.instrumentations.size).to eq(1)
+
+      name, env = instrumenter.instrumentations.first
+      expect(name).to eq('custom')
+      expect(env[:url].path).to eq('/')
+    end
+  end
+
+  context 'with custom instrumenter' do
+    let(:config) { { instrumenter: :custom } }
+
+    it { expect(options.instrumenter).to eq(:custom) }
+  end
+end

data/spec/faraday/request/multipart_spec.rb

@@ -0,0 +1,274 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Request::Multipart do
+  let(:conn) do
+    Faraday.new do |b|
+      b.request :multipart
+      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
+end