faraday 1.8.0 → 2.1.0

data/spec/faraday/connection_spec.rb

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
+class CustomEncoder
+  def encode(params)
+    params.map { |k, v| "#{k.upcase}-#{v.to_s.upcase}" }.join(',')
+  end
+
+  def decode(params)
+    params.split(',').map { |pair| pair.split('-') }.to_h
+  end
+end
+
 shared_examples 'initializer with url' do
   context 'with simple url' do
     let(:address) { 'http://sushi.com' }
@@ -103,6 +113,12 @@ RSpec.describe Faraday::Connection do
       it { expect(subject.params).to eq('a' => 3, 'b' => '2') }
     end
 
+    context 'with basic_auth in url' do
+      let(:url) { 'http://Aladdin:open%20sesame@sushi.com/fish' }
+
+      it { expect(subject.headers['Authorization']).to eq('Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==') }
+    end
+
     context 'with custom headers' do
       let(:options) { { headers: { user_agent: 'Faraday' } } }
 
@@ -124,7 +140,7 @@ RSpec.describe Faraday::Connection do
     context 'with block' do
       let(:conn) do
         Faraday::Connection.new(params: { 'a' => '1' }) do |faraday|
-          faraday.adapter :net_http
+          faraday.adapter :test
           faraday.url_prefix = 'http://sushi.com/omnom'
         end
       end
@@ -135,34 +151,15 @@ RSpec.describe Faraday::Connection do
   end
 
   describe '#close' do
+    before { Faraday.default_adapter = :test }
+    after { Faraday.default_adapter = nil }
+
     it 'can close underlying app' do
       expect(conn.app).to receive(:close)
       conn.close
     end
   end
 
-  describe 'basic_auth' do
-    subject { conn }
-
-    context 'calling the #basic_auth method' do
-      before { subject.basic_auth 'Aladdin', 'open sesame' }
-
-      it { expect(subject.headers['Authorization']).to eq('Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==') }
-    end
-
-    context 'adding basic auth info to url' do
-      let(:url) { 'http://Aladdin:open%20sesame@sushi.com/fish' }
-
-      it { expect(subject.headers['Authorization']).to eq('Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==') }
-    end
-  end
-
-  describe '#token_auth' do
-    before { subject.token_auth('abcdef', nonce: 'abc') }
-
-    it { expect(subject.headers['Authorization']).to eq('Token nonce="abc", token="abcdef"') }
-  end
-
   describe '#build_exclusive_url' do
     context 'with relative path' do
       subject { conn.build_exclusive_url('sake.html') }
@@ -556,26 +553,32 @@ RSpec.describe Faraday::Connection do
     end
 
     context 'performing a request' do
-      before { stub_request(:get, 'http://example.com') }
+      let(:url) { 'http://example.com' }
+      let(:conn) do
+        Faraday.new do |f|
+          f.adapter :test do |stubs|
+            stubs.get(url) do
+              [200, {}, 'ok']
+            end
+          end
+        end
+      end
 
       it 'dynamically checks proxy' do
         with_env 'http_proxy' => 'http://proxy.com:80' do
-          conn = Faraday.new
           expect(conn.proxy.uri.host).to eq('proxy.com')
 
-          conn.get('http://example.com') do |req|
+          conn.get(url) do |req|
             expect(req.options.proxy.uri.host).to eq('proxy.com')
           end
         end
 
-        conn.get('http://example.com')
+        conn.get(url)
         expect(conn.instance_variable_get('@temp_proxy')).to be_nil
       end
 
       it 'dynamically check no proxy' do
         with_env 'http_proxy' => 'http://proxy.com', 'no_proxy' => 'example.com' do
-          conn = Faraday.new
-
           expect(conn.proxy.uri.host).to eq('proxy.com')
 
           conn.get('http://example.com') do |req|
@@ -605,7 +608,6 @@ RSpec.describe Faraday::Connection do
 
     context 'after manual changes' do
       before do
-        subject.basic_auth('', '')
         subject.headers['content-length'] = 12
         subject.params['b'] = '2'
         subject.options[:open_timeout] = 10
@@ -640,14 +642,42 @@ RSpec.describe Faraday::Connection do
 
       it_behaves_like 'default connection options'
     end
+
+    context 'preserving a user_agent assigned via default_conncetion_options' do
+      around do |example|
+        old = Faraday.default_connection_options
+        Faraday.default_connection_options = { headers: { user_agent: 'My Agent 1.2' } }
+        example.run
+        Faraday.default_connection_options = old
+      end
+
+      context 'when url is a Hash' do
+        let(:conn) { Faraday.new(url: 'http://example.co', headers: { 'CustomHeader' => 'CustomValue' }) }
+
+        it { expect(conn.headers).to eq('CustomHeader' => 'CustomValue', 'User-Agent' => 'My Agent 1.2') }
+      end
+
+      context 'when url is a String' do
+        let(:conn) { Faraday.new('http://example.co', headers: { 'CustomHeader' => 'CustomValue' }) }
+
+        it { expect(conn.headers).to eq('CustomHeader' => 'CustomValue', 'User-Agent' => 'My Agent 1.2') }
+      end
+    end
   end
 
   describe 'request params' do
     context 'with simple url' do
       let(:url) { 'http://example.com' }
-      let!(:stubbed) { stub_request(:get, 'http://example.com?a=a&p=3') }
+      let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+
+      before do
+        conn.adapter(:test, stubs)
+        stubs.get('http://example.com?a=a&p=3') do
+          [200, {}, 'ok']
+        end
+      end
 
-      after { expect(stubbed).to have_been_made.once }
+      after { stubs.verify_stubbed_calls }
 
       it 'test_overrides_request_params' do
         conn.get('?p=2&a=a', p: 3)
@@ -669,15 +699,22 @@ RSpec.describe Faraday::Connection do
     context 'with url and extra params' do
       let(:url) { 'http://example.com?a=1&b=2' }
       let(:options) { { params: { c: 3 } } }
+      let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+
+      before do
+        conn.adapter(:test, stubs)
+      end
 
       it 'merges connection and request params' do
-        stubbed = stub_request(:get, 'http://example.com?a=1&b=2&c=3&limit=5&page=1')
+        expected = 'http://example.com?a=1&b=2&c=3&limit=5&page=1'
+        stubs.get(expected) { [200, {}, 'ok'] }
         conn.get('?page=1', limit: 5)
-        expect(stubbed).to have_been_made.once
+        stubs.verify_stubbed_calls
       end
 
       it 'allows to override all params' do
-        stubbed = stub_request(:get, 'http://example.com?b=b')
+        expected = 'http://example.com?b=b'
+        stubs.get(expected) { [200, {}, 'ok'] }
         conn.get('?p=1&a=a', p: 2) do |req|
           expect(req.params[:a]).to eq('a')
           expect(req.params['c']).to eq(3)
@@ -685,47 +722,61 @@ RSpec.describe Faraday::Connection do
           req.params = { b: 'b' }
           expect(req.params['b']).to eq('b')
         end
-        expect(stubbed).to have_been_made.once
+        stubs.verify_stubbed_calls
       end
 
       it 'allows to set params_encoder for single request' do
-        encoder = Object.new
-        def encoder.encode(params)
-          params.map { |k, v| "#{k.upcase}-#{v.to_s.upcase}" }.join(',')
-        end
-        stubbed = stub_request(:get, 'http://example.com/?A-1,B-2,C-3,FEELING-BLUE')
+        encoder = CustomEncoder.new
+        expected = 'http://example.com/?A-1,B-2,C-3,FEELING-BLUE'
+        stubs.get(expected) { [200, {}, 'ok'] }
 
-        conn.get('/', feeling: 'blue') do |req|
+        conn.get('/', a: 1, b: 2, c: 3, feeling: 'blue') do |req|
           req.options.params_encoder = encoder
         end
-        expect(stubbed).to have_been_made.once
+        stubs.verify_stubbed_calls
       end
     end
 
     context 'with default params encoder' do
-      let!(:stubbed) { stub_request(:get, 'http://example.com?color%5B%5D=red&color%5B%5D=blue') }
-      after { expect(stubbed).to have_been_made.once }
+      let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+
+      before do
+        conn.adapter(:test, stubs)
+        stubs.get('http://example.com?color%5B%5D=blue&color%5B%5D=red') do
+          [200, {}, 'ok']
+        end
+      end
+
+      after { stubs.verify_stubbed_calls }
 
       it 'supports array params in url' do
-        conn.get('http://example.com?color[]=red&color[]=blue')
+        conn.get('http://example.com?color[]=blue&color[]=red')
       end
 
       it 'supports array params in params' do
-        conn.get('http://example.com', color: %w[red blue])
+        conn.get('http://example.com', color: %w[blue red])
       end
     end
 
     context 'with flat params encoder' do
       let(:options) { { request: { params_encoder: Faraday::FlatParamsEncoder } } }
-      let!(:stubbed) { stub_request(:get, 'http://example.com?color=blue') }
-      after { expect(stubbed).to have_been_made.once }
+      let(:stubs) { Faraday::Adapter::Test::Stubs.new }
+
+      before do
+        conn.adapter(:test, stubs)
+        stubs.get('http://example.com?color=blue&color=red') do
+          [200, {}, 'ok']
+        end
+      end
+
+      after { stubs.verify_stubbed_calls }
 
       it 'supports array params in params' do
-        conn.get('http://example.com', color: %w[red blue])
+        conn.get('http://example.com', color: %w[blue red])
       end
 
       context 'with array param in url' do
-        let(:url) { 'http://example.com?color[]=red&color[]=blue' }
+        let(:url) { 'http://example.com?color[]=blue&color[]=red' }
 
         it do
           conn.get('/')

data/spec/faraday/options/env_spec.rb

@@ -29,12 +29,12 @@ RSpec.describe Faraday::Env do
 
   it 'retains custom members' do
     env[:foo] = 'custom 1'
-    env[:bar] = :custom_2
+    env[:bar] = :custom2
     env2 = Faraday::Env.from(env)
     env2[:baz] = 'custom 3'
 
     expect(env2[:foo]).to eq('custom 1')
-    expect(env2[:bar]).to eq(:custom_2)
+    expect(env2[:bar]).to eq(:custom2)
     expect(env[:baz]).to be_nil
   end
 

data/spec/faraday/rack_builder_spec.rb

@@ -12,16 +12,16 @@ RSpec.describe Faraday::RackBuilder do
 
   class Apple < Handler
   end
+
   class Orange < Handler
   end
-  class Banana < Handler
-  end
 
-  class Broken < Faraday::Middleware
-    dependency 'zomg/i_dont/exist'
+  class Banana < Handler
   end
 
   subject { conn.builder }
+  before { Faraday.default_adapter = :test }
+  after { Faraday.default_adapter = nil }
 
   context 'with default stack' do
     let(:conn) { Faraday::Connection.new }
@@ -88,13 +88,6 @@ RSpec.describe Faraday::RackBuilder do
 
     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])
@@ -127,24 +120,6 @@ RSpec.describe Faraday::RackBuilder do
       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
@@ -176,21 +151,30 @@ RSpec.describe Faraday::RackBuilder do
     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, {}, ''] }
+  context 'when adapter is added with named options' do
+    after { Faraday.default_adapter_options = {} }
+    let(:conn) { Faraday::Connection.new {} }
+
+    let(:cat_adapter) do
+      Class.new(Faraday::Adapter) do
+        attr_accessor :name
+
+        def initialize(app, name:)
+          super(app)
+          @name = name
         end
       end
     end
 
-    before { subject.use(Broken) }
+    let(:cat) { subject.adapter.build }
 
-    it 'raises an error while making a request' do
-      expect { conn.get('/') }.to raise_error(RuntimeError) do |err|
-        expect(err.message).to match(%r{missing dependency for Broken: .+ -- zomg/i_dont/exist})
-      end
+    it 'adds a handler to construct adapter with named options' do
+      Faraday.default_adapter = cat_adapter
+      Faraday.default_adapter_options = { name: 'Chloe' }
+      expect { cat }.to_not output(
+        /warning: Using the last argument as keyword parameters is deprecated/
+      ).to_stderr
+      expect(cat.name).to eq 'Chloe'
     end
   end
 
@@ -220,7 +204,7 @@ RSpec.describe Faraday::RackBuilder do
     end
   end
 
-  context 'when a request adapter is added with named arguments' do
+  context 'when a middleware is added with named arguments' do
     let(:conn) { Faraday::Connection.new {} }
 
     let(:cat_request) do
@@ -247,11 +231,11 @@ RSpec.describe Faraday::RackBuilder do
     end
   end
 
-  context 'when a response adapter is added with named arguments' do
+  context 'when a middleware is added with named arguments' do
     let(:conn) { Faraday::Connection.new {} }
 
     let(:fish_response) do
-      Class.new(Faraday::Response::Middleware) do
+      Class.new(Faraday::Middleware) do
         attr_accessor :name
 
         def initialize(app, name:)

data/spec/faraday/request/authorization_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe Faraday::Request::Authorization do
   let(:conn) do
     Faraday.new do |b|
-      b.request auth_type, *auth_config
+      b.request :authorization, auth_type, *auth_config
       b.adapter :test do |stub|
         stub.get('/auth-echo') do |env|
           [200, {}, env[:request_headers]['Authorization']]
@@ -14,10 +14,10 @@ RSpec.describe Faraday::Request::Authorization do
 
   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"') }
+      let(:response) { conn.get('/auth-echo', nil, authorization: 'OAuth oauth_token') }
 
       it 'does not interfere with existing authorization' do
-        expect(response.body).to eq('Token token="bar"')
+        expect(response.body).to eq('OAuth oauth_token')
       end
     end
   end
@@ -25,7 +25,7 @@ RSpec.describe Faraday::Request::Authorization do
   let(:response) { conn.get('/auth-echo') }
 
   describe 'basic_auth' do
-    let(:auth_type) { :basic_auth }
+    let(:auth_type) { :basic }
 
     context 'when passed correct params' do
       let(:auth_config) { %w[aladdin opensesame] }
@@ -44,51 +44,38 @@ RSpec.describe Faraday::Request::Authorization do
     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
+  describe 'authorization' do
+    let(:auth_type) { :Bearer }
 
-    context 'when other values are provided' do
-      let(:auth_config) { ['baz', { foo: 42 }] }
+    context 'when passed a string' do
+      let(:auth_config) { ['custom'] }
 
-      it { expect(response.body).to match(/^Token /) }
-      it { expect(response.body).to match(/token="baz"/) }
-      it { expect(response.body).to match(/foo="42"/) }
+      it { expect(response.body).to eq('Bearer custom') }
 
       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'] }
+    context 'when passed a proc' do
+      let(:auth_config) { [-> { 'custom_from_proc' }] }
 
-      it { expect(response.body).to eq('custom abc def') }
+      it { expect(response.body).to eq('Bearer custom_from_proc') }
 
       include_examples 'does not interfere with existing authentication'
     end
 
-    context 'when passed a string and a hash' do
-      let(:auth_config) { ['baz', { foo: 42 }] }
+    context 'when passed a callable' do
+      let(:callable) { double('Callable Authorizer', call: 'custom_from_callable') }
+      let(:auth_config) { [callable] }
 
-      it { expect(response.body).to eq('baz foo="42"') }
+      it { expect(response.body).to eq('Bearer custom_from_callable') }
 
       include_examples 'does not interfere with existing authentication'
     end
 
-    context 'when passed a string and a proc' do
-      let(:auth_config) { ['Bearer', -> { 'custom_from_proc' }] }
+    context 'when passed too many arguments' do
+      let(:auth_config) { %w[baz foo] }
 
-      it { expect(response.body).to eq('Bearer custom_from_proc') }
+      it { expect { response }.to raise_error(ArgumentError) }
 
       include_examples 'does not interfere with existing authentication'
     end

data/spec/faraday/request/instrumentation_spec.rb

@@ -30,13 +30,11 @@ RSpec.describe Faraday::Request::Instrumentation do
 
   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
+    res = options.instrumenter
+  rescue NameError => e
+    expect(e.to_s).to match('ActiveSupport')
+  else
+    expect(res).to eq(ActiveSupport::Notifications)
   end
 
   it 'instruments with default name' do

data/spec/faraday/request/json_spec.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+RSpec.describe Faraday::Request::Json do
+  let(:middleware) { described_class.new(->(env) { Faraday::Response.new(env) }) }
+
+  def process(body, content_type = nil)
+    env = { body: body, request_headers: Faraday::Utils::Headers.new }
+    env[:request_headers]['content-type'] = content_type if content_type
+    middleware.call(Faraday::Env.from(env)).env
+  end
+
+  def result_body
+    result[:body]
+  end
+
+  def result_type
+    result[:request_headers]['content-type']
+  end
+
+  context 'no body' do
+    let(:result) { process(nil) }
+
+    it "doesn't change body" do
+      expect(result_body).to be_nil
+    end
+
+    it "doesn't add content type" do
+      expect(result_type).to be_nil
+    end
+  end
+
+  context 'empty body' do
+    let(:result) { process('') }
+
+    it "doesn't change body" do
+      expect(result_body).to be_empty
+    end
+
+    it "doesn't add content type" do
+      expect(result_type).to be_nil
+    end
+  end
+
+  context 'string body' do
+    let(:result) { process('{"a":1}') }
+
+    it "doesn't change body" do
+      expect(result_body).to eq('{"a":1}')
+    end
+
+    it 'adds content type' do
+      expect(result_type).to eq('application/json')
+    end
+  end
+
+  context 'object body' do
+    let(:result) { process(a: 1) }
+
+    it 'encodes body' do
+      expect(result_body).to eq('{"a":1}')
+    end
+
+    it 'adds content type' do
+      expect(result_type).to eq('application/json')
+    end
+  end
+
+  context 'empty object body' do
+    let(:result) { process({}) }
+
+    it 'encodes body' do
+      expect(result_body).to eq('{}')
+    end
+  end
+
+  context 'object body with json type' do
+    let(:result) { process({ a: 1 }, 'application/json; charset=utf-8') }
+
+    it 'encodes body' do
+      expect(result_body).to eq('{"a":1}')
+    end
+
+    it "doesn't change content type" do
+      expect(result_type).to eq('application/json; charset=utf-8')
+    end
+  end
+
+  context 'object body with vendor json type' do
+    let(:result) { process({ a: 1 }, 'application/vnd.myapp.v1+json; charset=utf-8') }
+
+    it 'encodes body' do
+      expect(result_body).to eq('{"a":1}')
+    end
+
+    it "doesn't change content type" do
+      expect(result_type).to eq('application/vnd.myapp.v1+json; charset=utf-8')
+    end
+  end
+
+  context 'object body with incompatible type' do
+    let(:result) { process({ a: 1 }, 'application/xml; charset=utf-8') }
+
+    it "doesn't change body" do
+      expect(result_body).to eq(a: 1)
+    end
+
+    it "doesn't change content type" do
+      expect(result_type).to eq('application/xml; charset=utf-8')
+    end
+  end
+end

data/spec/faraday/request/url_encoded_spec.rb

@@ -3,7 +3,6 @@
 RSpec.describe Faraday::Request::UrlEncoded 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|

data/spec/faraday/request_spec.rb

@@ -22,17 +22,6 @@ RSpec.describe Faraday::Request do
     it { expect(subject.http_method).to eq(:post) }
   end
 
-  describe 'deprecate method for HTTP method' do
-    let(:http_method) { :post }
-    let(:expected_warning) do
-      %r{WARNING: `Faraday::Request#method` is deprecated; use `#http_method` instead. It will be removed in or after version 2.0.\n`Faraday::Request#method` called from .+/spec/faraday/request_spec.rb:\d+.}
-    end
-
-    it { expect(subject.method).to eq(:post) }
-
-    it { expect { subject.method }.to output(expected_warning).to_stderr }
-  end
-
   context 'when setting the url on setup with a URI' do
     let(:block) { proc { |req| req.url URI.parse('foo.json?a=1') } }