faraday 1.0.0 → 2.0.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' }
@@ -18,6 +28,13 @@ shared_examples 'initializer with url' do
     it { expect(subject.path_prefix).to eq('/fish') }
     it { expect(subject.params).to eq('a' => '1') }
   end
+
+  context 'with IPv6 address' do
+    let(:address) { 'http://[::1]:85/' }
+
+    it { expect(subject.host).to eq('[::1]') }
+    it { expect(subject.port).to eq(85) }
+  end
 end
 
 shared_examples 'default connection options' do
@@ -96,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' } } }
 
@@ -117,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
@@ -128,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') }
@@ -246,6 +250,13 @@ RSpec.describe Faraday::Connection do
       expect(uri.path).to eq('/sake.html')
     end
 
+    it 'always returns new URI instance' do
+      conn.url_prefix = 'http://sushi.com'
+      uri1 = conn.build_exclusive_url(nil)
+      uri2 = conn.build_exclusive_url(nil)
+      expect(uri1).not_to equal(uri2)
+    end
+
     context 'with url_prefixed connection' do
       let(:url) { 'http://sushi.com/sushi/' }
 
@@ -270,6 +281,29 @@ RSpec.describe Faraday::Connection do
         expect(uri.to_s).to eq('http://sushi.com/sake/')
       end
     end
+
+    context 'with colon in path' do
+      let(:url) { 'http://service.com' }
+
+      it 'joins url to base when used absolute path' do
+        conn = Faraday.new(url: url)
+        uri = conn.build_exclusive_url('/service:search?limit=400')
+        expect(uri.to_s).to eq('http://service.com/service:search?limit=400')
+      end
+
+      it 'joins url to base when used relative path' do
+        conn = Faraday.new(url: url)
+        uri = conn.build_exclusive_url('service:search?limit=400')
+        expect(uri.to_s).to eq('http://service.com/service%3Asearch?limit=400')
+      end
+
+      it 'joins url to base when used with path prefix' do
+        conn = Faraday.new(url: url)
+        conn.path_prefix = '/api'
+        uri = conn.build_exclusive_url('service:search?limit=400')
+        expect(uri.to_s).to eq('http://service.com/api/service%3Asearch?limit=400')
+      end
+    end
   end
 
   describe '#build_url' do
@@ -412,6 +446,14 @@ RSpec.describe Faraday::Connection do
       end
     end
 
+    it 'allows when url in no proxy list with url_prefix' do
+      with_env 'http_proxy' => 'http://proxy.com', 'no_proxy' => 'example.com' do
+        conn = Faraday::Connection.new
+        conn.url_prefix = 'http://example.com'
+        expect(conn.proxy).to be_nil
+      end
+    end
+
     it 'allows when prefixed url is not in no proxy list' do
       with_env 'http_proxy' => 'http://proxy.com', 'no_proxy' => 'example.com' do
         conn = Faraday::Connection.new('http://prefixedexample.com')
@@ -511,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|
@@ -560,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
@@ -595,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)
@@ -624,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)
@@ -640,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/error_spec.rb

@@ -13,6 +13,7 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.message).to eq(exception.message) }
       it { expect(subject.backtrace).to eq(exception.backtrace) }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError wrapped=#<RuntimeError: test>>') }
+      it { expect(subject.response_status).to be_nil }
     end
 
     context 'with response hash' do
@@ -22,6 +23,7 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.response).to eq(exception) }
       it { expect(subject.message).to eq('the server responded with status 400') }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError response={:status=>400}>') }
+      it { expect(subject.response_status).to eq(400) }
     end
 
     context 'with string' do
@@ -31,6 +33,7 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.response).to be_nil }
       it { expect(subject.message).to eq('custom message') }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: custom message>>') }
+      it { expect(subject.response_status).to be_nil }
     end
 
     context 'with anything else #to_s' do
@@ -40,6 +43,18 @@ RSpec.describe Faraday::ClientError do
       it { expect(subject.response).to be_nil }
       it { expect(subject.message).to eq('["error1", "error2"]') }
       it { expect(subject.inspect).to eq('#<Faraday::ClientError #<Faraday::ClientError: ["error1", "error2"]>>') }
+      it { expect(subject.response_status).to be_nil }
+    end
+
+    context 'with exception string and response hash' do
+      let(:exception) { 'custom message' }
+      let(:response) { { status: 400 } }
+
+      it { expect(subject.wrapped_exception).to be_nil }
+      it { expect(subject.response).to eq(response) }
+      it { expect(subject.message).to eq('custom message') }
+      it { expect(subject.inspect).to eq('#<Faraday::ClientError response={:status=>400}>') }
+      it { expect(subject.response_status).to eq(400) }
     end
   end
 end

data/spec/faraday/middleware_spec.rb

@@ -2,23 +2,49 @@
 
 RSpec.describe Faraday::Middleware do
   subject { described_class.new(app) }
+  let(:app) { double }
+
+  describe 'options' do
+    context 'when options are passed to the middleware' do
+      subject { described_class.new(app, options) }
+      let(:options) { { field: 'value' } }
+
+      it 'accepts options when initialized' do
+        expect(subject.options[:field]).to eq('value')
+      end
+    end
+  end
+
+  describe '#on_request' do
+    subject do
+      Class.new(described_class) do
+        def on_request(env)
+          # do nothing
+        end
+      end.new(app)
+    end
+
+    it 'is called by #call' do
+      expect(app).to receive(:call).and_return(app)
+      expect(app).to receive(:on_complete)
+      is_expected.to receive(:call).and_call_original
+      is_expected.to receive(:on_request)
+      subject.call(double)
+    end
+  end
 
   describe '#close' do
     context "with app that doesn't support \#close" do
-      let(:app) { double }
-
       it 'should issue warning' do
-        expect(subject).to receive(:warn)
+        is_expected.to receive(:warn)
         subject.close
       end
     end
 
     context "with app that supports \#close" do
-      let(:app) { double }
-
       it 'should issue warning' do
         expect(app).to receive(:close)
-        expect(subject).to_not receive(:warn)
+        is_expected.to_not receive(:warn)
         subject.close
       end
     end

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/options/proxy_options_spec.rb

@@ -14,6 +14,13 @@ RSpec.describe Faraday::ProxyOptions do
       expect(options.inspect).to match('#<Faraday::ProxyOptions uri=')
     end
 
+    it 'defaults to http' do
+      options = Faraday::ProxyOptions.from 'example.org'
+      expect(options.port).to eq(80)
+      expect(options.host).to eq('example.org')
+      expect(options.scheme).to eq('http')
+    end
+
     it 'works with nil' do
       options = Faraday::ProxyOptions.from nil
       expect(options).to be_a_kind_of(Faraday::ProxyOptions)

data/spec/faraday/params_encoders/flat_spec.rb

@@ -31,4 +31,12 @@ RSpec.describe Faraday::FlatParamsEncoder do
     params = { a: [] }
     expect(subject.encode(params)).to eq('a=')
   end
+
+  it 'encodes unsorted when asked' do
+    params = { b: false, a: true }
+    expect(subject.encode(params)).to eq('a=true&b=false')
+    Faraday::FlatParamsEncoder.sort_params = false
+    expect(subject.encode(params)).to eq('b=false&a=true')
+    Faraday::FlatParamsEncoder.sort_params = true
+  end
 end

data/spec/faraday/params_encoders/nested_spec.rb

@@ -94,6 +94,14 @@ RSpec.describe Faraday::NestedParamsEncoder do
     expect(subject.encode(params)).to eq('a%5B%5D=true&a%5B%5D=false')
   end
 
+  it 'encodes unsorted when asked' do
+    params = { b: false, a: true }
+    expect(subject.encode(params)).to eq('a=true&b=false')
+    Faraday::NestedParamsEncoder.sort_params = false
+    expect(subject.encode(params)).to eq('b=false&a=true')
+    Faraday::NestedParamsEncoder.sort_params = true
+  end
+
   shared_examples 'a wrong decoding' do
     it do
       expect { subject.decode(query) }.to raise_error(TypeError) do |e|