faraday 1.0.0 → 2.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +299 -1
- data/LICENSE.md +1 -1
- data/README.md +35 -23
- data/Rakefile +3 -1
- data/examples/client_spec.rb +68 -14
- data/examples/client_test.rb +80 -15
- data/lib/faraday/adapter/test.rb +117 -52
- data/lib/faraday/adapter.rb +6 -20
- data/lib/faraday/adapter_registry.rb +3 -1
- data/lib/faraday/connection.rb +73 -132
- data/lib/faraday/encoders/flat_params_encoder.rb +9 -2
- data/lib/faraday/encoders/nested_params_encoder.rb +20 -8
- data/lib/faraday/error.rb +37 -8
- data/lib/faraday/logging/formatter.rb +28 -15
- data/lib/faraday/methods.rb +6 -0
- data/lib/faraday/middleware.rb +17 -5
- data/lib/faraday/middleware_registry.rb +17 -63
- data/lib/faraday/options/connection_options.rb +7 -6
- data/lib/faraday/options/env.rb +85 -62
- data/lib/faraday/options/proxy_options.rb +11 -3
- data/lib/faraday/options/request_options.rb +7 -6
- data/lib/faraday/options/ssl_options.rb +56 -45
- data/lib/faraday/options.rb +11 -14
- data/lib/faraday/rack_builder.rb +35 -32
- data/lib/faraday/request/authorization.rb +37 -36
- data/lib/faraday/request/instrumentation.rb +5 -1
- data/lib/faraday/request/json.rb +70 -0
- data/lib/faraday/request/url_encoded.rb +8 -2
- data/lib/faraday/request.rb +22 -29
- data/lib/faraday/response/json.rb +73 -0
- data/lib/faraday/response/logger.rb +8 -4
- data/lib/faraday/response/raise_error.rb +41 -3
- data/lib/faraday/response.rb +10 -23
- data/lib/faraday/utils/headers.rb +9 -4
- data/lib/faraday/utils.rb +22 -10
- data/lib/faraday/version.rb +5 -0
- data/lib/faraday.rb +49 -58
- data/spec/faraday/adapter/test_spec.rb +442 -0
- data/spec/faraday/connection_spec.rb +207 -90
- data/spec/faraday/error_spec.rb +45 -5
- data/spec/faraday/middleware_registry_spec.rb +31 -0
- data/spec/faraday/middleware_spec.rb +50 -6
- data/spec/faraday/options/env_spec.rb +8 -2
- data/spec/faraday/options/options_spec.rb +1 -1
- data/spec/faraday/options/proxy_options_spec.rb +15 -0
- data/spec/faraday/params_encoders/flat_spec.rb +8 -0
- data/spec/faraday/params_encoders/nested_spec.rb +16 -0
- data/spec/faraday/rack_builder_spec.rb +171 -50
- data/spec/faraday/request/authorization_spec.rb +54 -24
- data/spec/faraday/request/instrumentation_spec.rb +5 -7
- data/spec/faraday/request/json_spec.rb +199 -0
- data/spec/faraday/request/url_encoded_spec.rb +25 -2
- data/spec/faraday/request_spec.rb +11 -10
- data/spec/faraday/response/json_spec.rb +189 -0
- data/spec/faraday/response/logger_spec.rb +38 -0
- data/spec/faraday/response/raise_error_spec.rb +105 -0
- data/spec/faraday/response_spec.rb +3 -1
- data/spec/faraday/utils/headers_spec.rb +22 -4
- data/spec/faraday/utils_spec.rb +63 -1
- data/spec/faraday_spec.rb +8 -4
- data/spec/spec_helper.rb +6 -5
- data/spec/support/fake_safe_buffer.rb +1 -1
- data/spec/support/helper_methods.rb +0 -37
- data/spec/support/shared_examples/adapter.rb +4 -3
- data/spec/support/shared_examples/request_method.rb +60 -31
- metadata +19 -44
- data/UPGRADING.md +0 -55
- data/lib/faraday/adapter/em_http.rb +0 -285
- data/lib/faraday/adapter/em_http_ssl_patch.rb +0 -62
- data/lib/faraday/adapter/em_synchrony/parallel_manager.rb +0 -69
- data/lib/faraday/adapter/em_synchrony.rb +0 -150
- data/lib/faraday/adapter/excon.rb +0 -124
- data/lib/faraday/adapter/httpclient.rb +0 -151
- data/lib/faraday/adapter/net_http.rb +0 -209
- data/lib/faraday/adapter/net_http_persistent.rb +0 -91
- data/lib/faraday/adapter/patron.rb +0 -132
- data/lib/faraday/adapter/rack.rb +0 -75
- data/lib/faraday/adapter/typhoeus.rb +0 -15
- data/lib/faraday/autoload.rb +0 -95
- data/lib/faraday/dependency_loader.rb +0 -37
- data/lib/faraday/file_part.rb +0 -128
- data/lib/faraday/param_part.rb +0 -53
- data/lib/faraday/request/basic_authentication.rb +0 -20
- data/lib/faraday/request/multipart.rb +0 -99
- data/lib/faraday/request/retry.rb +0 -239
- data/lib/faraday/request/token_authentication.rb +0 -20
- data/spec/faraday/adapter/em_http_spec.rb +0 -47
- data/spec/faraday/adapter/em_synchrony_spec.rb +0 -16
- data/spec/faraday/adapter/excon_spec.rb +0 -49
- data/spec/faraday/adapter/httpclient_spec.rb +0 -73
- data/spec/faraday/adapter/net_http_persistent_spec.rb +0 -57
- data/spec/faraday/adapter/net_http_spec.rb +0 -64
- data/spec/faraday/adapter/patron_spec.rb +0 -18
- data/spec/faraday/adapter/rack_spec.rb +0 -8
- data/spec/faraday/adapter/typhoeus_spec.rb +0 -7
- data/spec/faraday/composite_read_io_spec.rb +0 -80
- data/spec/faraday/request/multipart_spec.rb +0 -274
- data/spec/faraday/request/retry_spec.rb +0 -242
- data/spec/faraday/response/middleware_spec.rb +0 -52
- data/spec/support/webmock_rack_app.rb +0 -68
data/spec/faraday/error_spec.rb
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# frozen_string_literal: true
|
2
2
|
|
3
|
-
RSpec.describe Faraday::
|
3
|
+
RSpec.describe Faraday::Error do
|
4
4
|
describe '.initialize' do
|
5
5
|
subject { described_class.new(exception, response) }
|
6
6
|
let(:response) { nil }
|
@@ -12,7 +12,10 @@ RSpec.describe Faraday::ClientError do
|
|
12
12
|
it { expect(subject.response).to be_nil }
|
13
13
|
it { expect(subject.message).to eq(exception.message) }
|
14
14
|
it { expect(subject.backtrace).to eq(exception.backtrace) }
|
15
|
-
it { expect(subject.inspect).to eq('#<Faraday::
|
15
|
+
it { expect(subject.inspect).to eq('#<Faraday::Error wrapped=#<RuntimeError: test>>') }
|
16
|
+
it { expect(subject.response_status).to be_nil }
|
17
|
+
it { expect(subject.response_headers).to be_nil }
|
18
|
+
it { expect(subject.response_body).to be_nil }
|
16
19
|
end
|
17
20
|
|
18
21
|
context 'with response hash' do
|
@@ -21,7 +24,10 @@ RSpec.describe Faraday::ClientError do
|
|
21
24
|
it { expect(subject.wrapped_exception).to be_nil }
|
22
25
|
it { expect(subject.response).to eq(exception) }
|
23
26
|
it { expect(subject.message).to eq('the server responded with status 400') }
|
24
|
-
it { expect(subject.inspect).to eq('#<Faraday::
|
27
|
+
it { expect(subject.inspect).to eq('#<Faraday::Error response={:status=>400}>') }
|
28
|
+
it { expect(subject.response_status).to eq(400) }
|
29
|
+
it { expect(subject.response_headers).to be_nil }
|
30
|
+
it { expect(subject.response_body).to be_nil }
|
25
31
|
end
|
26
32
|
|
27
33
|
context 'with string' do
|
@@ -30,7 +36,10 @@ RSpec.describe Faraday::ClientError do
|
|
30
36
|
it { expect(subject.wrapped_exception).to be_nil }
|
31
37
|
it { expect(subject.response).to be_nil }
|
32
38
|
it { expect(subject.message).to eq('custom message') }
|
33
|
-
it { expect(subject.inspect).to eq('#<Faraday::
|
39
|
+
it { expect(subject.inspect).to eq('#<Faraday::Error #<Faraday::Error: custom message>>') }
|
40
|
+
it { expect(subject.response_status).to be_nil }
|
41
|
+
it { expect(subject.response_headers).to be_nil }
|
42
|
+
it { expect(subject.response_body).to be_nil }
|
34
43
|
end
|
35
44
|
|
36
45
|
context 'with anything else #to_s' do
|
@@ -39,7 +48,38 @@ RSpec.describe Faraday::ClientError do
|
|
39
48
|
it { expect(subject.wrapped_exception).to be_nil }
|
40
49
|
it { expect(subject.response).to be_nil }
|
41
50
|
it { expect(subject.message).to eq('["error1", "error2"]') }
|
42
|
-
it { expect(subject.inspect).to eq('#<Faraday::
|
51
|
+
it { expect(subject.inspect).to eq('#<Faraday::Error #<Faraday::Error: ["error1", "error2"]>>') }
|
52
|
+
it { expect(subject.response_status).to be_nil }
|
53
|
+
it { expect(subject.response_headers).to be_nil }
|
54
|
+
it { expect(subject.response_body).to be_nil }
|
55
|
+
end
|
56
|
+
|
57
|
+
context 'with exception string and response hash' do
|
58
|
+
let(:exception) { 'custom message' }
|
59
|
+
let(:response) { { status: 400 } }
|
60
|
+
|
61
|
+
it { expect(subject.wrapped_exception).to be_nil }
|
62
|
+
it { expect(subject.response).to eq(response) }
|
63
|
+
it { expect(subject.message).to eq('custom message') }
|
64
|
+
it { expect(subject.inspect).to eq('#<Faraday::Error response={:status=>400}>') }
|
65
|
+
it { expect(subject.response_status).to eq(400) }
|
66
|
+
it { expect(subject.response_headers).to be_nil }
|
67
|
+
it { expect(subject.response_body).to be_nil }
|
68
|
+
end
|
69
|
+
|
70
|
+
context 'with exception and response object' do
|
71
|
+
let(:exception) { RuntimeError.new('test') }
|
72
|
+
let(:body) { { test: 'test' } }
|
73
|
+
let(:headers) { { 'Content-Type' => 'application/json' } }
|
74
|
+
let(:response) { Faraday::Response.new(status: 400, response_headers: headers, response_body: body) }
|
75
|
+
|
76
|
+
it { expect(subject.wrapped_exception).to eq(exception) }
|
77
|
+
it { expect(subject.response).to eq(response) }
|
78
|
+
it { expect(subject.message).to eq(exception.message) }
|
79
|
+
it { expect(subject.backtrace).to eq(exception.backtrace) }
|
80
|
+
it { expect(subject.response_status).to eq(400) }
|
81
|
+
it { expect(subject.response_headers).to eq(headers) }
|
82
|
+
it { expect(subject.response_body).to eq(body) }
|
43
83
|
end
|
44
84
|
end
|
45
85
|
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
RSpec.describe Faraday::MiddlewareRegistry do
|
4
|
+
before do
|
5
|
+
stub_const('CustomMiddleware', custom_middleware_klass)
|
6
|
+
end
|
7
|
+
let(:custom_middleware_klass) { Class.new(Faraday::Middleware) }
|
8
|
+
let(:dummy) { Class.new { extend Faraday::MiddlewareRegistry } }
|
9
|
+
|
10
|
+
after { dummy.unregister_middleware(:custom) }
|
11
|
+
|
12
|
+
it 'allows to register with constant' do
|
13
|
+
dummy.register_middleware(custom: custom_middleware_klass)
|
14
|
+
expect(dummy.lookup_middleware(:custom)).to eq(custom_middleware_klass)
|
15
|
+
end
|
16
|
+
|
17
|
+
it 'allows to register with symbol' do
|
18
|
+
dummy.register_middleware(custom: :CustomMiddleware)
|
19
|
+
expect(dummy.lookup_middleware(:custom)).to eq(custom_middleware_klass)
|
20
|
+
end
|
21
|
+
|
22
|
+
it 'allows to register with string' do
|
23
|
+
dummy.register_middleware(custom: 'CustomMiddleware')
|
24
|
+
expect(dummy.lookup_middleware(:custom)).to eq(custom_middleware_klass)
|
25
|
+
end
|
26
|
+
|
27
|
+
it 'allows to register with Proc' do
|
28
|
+
dummy.register_middleware(custom: -> { custom_middleware_klass })
|
29
|
+
expect(dummy.lookup_middleware(:custom)).to eq(custom_middleware_klass)
|
30
|
+
end
|
31
|
+
end
|
@@ -2,23 +2,67 @@
|
|
2
2
|
|
3
3
|
RSpec.describe Faraday::Middleware do
|
4
4
|
subject { described_class.new(app) }
|
5
|
+
let(:app) { double }
|
6
|
+
|
7
|
+
describe 'options' do
|
8
|
+
context 'when options are passed to the middleware' do
|
9
|
+
subject { described_class.new(app, options) }
|
10
|
+
let(:options) { { field: 'value' } }
|
11
|
+
|
12
|
+
it 'accepts options when initialized' do
|
13
|
+
expect(subject.options[:field]).to eq('value')
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
|
18
|
+
describe '#on_request' do
|
19
|
+
subject do
|
20
|
+
Class.new(described_class) do
|
21
|
+
def on_request(env)
|
22
|
+
# do nothing
|
23
|
+
end
|
24
|
+
end.new(app)
|
25
|
+
end
|
26
|
+
|
27
|
+
it 'is called by #call' do
|
28
|
+
expect(app).to receive(:call).and_return(app)
|
29
|
+
expect(app).to receive(:on_complete)
|
30
|
+
is_expected.to receive(:call).and_call_original
|
31
|
+
is_expected.to receive(:on_request)
|
32
|
+
subject.call(double)
|
33
|
+
end
|
34
|
+
end
|
35
|
+
|
36
|
+
describe '#on_error' do
|
37
|
+
subject do
|
38
|
+
Class.new(described_class) do
|
39
|
+
def on_error(error)
|
40
|
+
# do nothing
|
41
|
+
end
|
42
|
+
end.new(app)
|
43
|
+
end
|
44
|
+
|
45
|
+
it 'is called by #call' do
|
46
|
+
expect(app).to receive(:call).and_raise(Faraday::ConnectionFailed)
|
47
|
+
is_expected.to receive(:call).and_call_original
|
48
|
+
is_expected.to receive(:on_error)
|
49
|
+
|
50
|
+
expect { subject.call(double) }.to raise_error(Faraday::ConnectionFailed)
|
51
|
+
end
|
52
|
+
end
|
5
53
|
|
6
54
|
describe '#close' do
|
7
55
|
context "with app that doesn't support \#close" do
|
8
|
-
let(:app) { double }
|
9
|
-
|
10
56
|
it 'should issue warning' do
|
11
|
-
|
57
|
+
is_expected.to receive(:warn)
|
12
58
|
subject.close
|
13
59
|
end
|
14
60
|
end
|
15
61
|
|
16
62
|
context "with app that supports \#close" do
|
17
|
-
let(:app) { double }
|
18
|
-
|
19
63
|
it 'should issue warning' do
|
20
64
|
expect(app).to receive(:close)
|
21
|
-
|
65
|
+
is_expected.to_not receive(:warn)
|
22
66
|
subject.close
|
23
67
|
end
|
24
68
|
end
|
@@ -27,14 +27,20 @@ RSpec.describe Faraday::Env do
|
|
27
27
|
expect(ssl.fetch(:verify, true)).to be_falsey
|
28
28
|
end
|
29
29
|
|
30
|
+
it 'handle verify_hostname when fetching' do
|
31
|
+
ssl = Faraday::SSLOptions.new
|
32
|
+
ssl.verify_hostname = true
|
33
|
+
expect(ssl.fetch(:verify_hostname, false)).to be_truthy
|
34
|
+
end
|
35
|
+
|
30
36
|
it 'retains custom members' do
|
31
37
|
env[:foo] = 'custom 1'
|
32
|
-
env[:bar] = :
|
38
|
+
env[:bar] = :custom2
|
33
39
|
env2 = Faraday::Env.from(env)
|
34
40
|
env2[:baz] = 'custom 3'
|
35
41
|
|
36
42
|
expect(env2[:foo]).to eq('custom 1')
|
37
|
-
expect(env2[:bar]).to eq(:
|
43
|
+
expect(env2[:bar]).to eq(:custom2)
|
38
44
|
expect(env[:baz]).to be_nil
|
39
45
|
end
|
40
46
|
|
@@ -14,6 +14,13 @@ RSpec.describe Faraday::ProxyOptions do
|
|
14
14
|
expect(options.inspect).to match('#<Faraday::ProxyOptions uri=')
|
15
15
|
end
|
16
16
|
|
17
|
+
it 'defaults to http' do
|
18
|
+
options = Faraday::ProxyOptions.from 'example.org'
|
19
|
+
expect(options.port).to eq(80)
|
20
|
+
expect(options.host).to eq('example.org')
|
21
|
+
expect(options.scheme).to eq('http')
|
22
|
+
end
|
23
|
+
|
17
24
|
it 'works with nil' do
|
18
25
|
options = Faraday::ProxyOptions.from nil
|
19
26
|
expect(options).to be_a_kind_of(Faraday::ProxyOptions)
|
@@ -25,6 +32,14 @@ RSpec.describe Faraday::ProxyOptions do
|
|
25
32
|
expect(proxy.user).to be_nil
|
26
33
|
expect(proxy.password).to be_nil
|
27
34
|
end
|
35
|
+
|
36
|
+
it 'treats empty string as nil' do
|
37
|
+
proxy = nil
|
38
|
+
proxy_string = proxy.to_s # => empty string
|
39
|
+
options = Faraday::ProxyOptions.from proxy_string
|
40
|
+
expect(options).to be_a_kind_of(Faraday::ProxyOptions)
|
41
|
+
expect(options.inspect).to eq('#<Faraday::ProxyOptions (empty)>')
|
42
|
+
end
|
28
43
|
end
|
29
44
|
|
30
45
|
it 'allows hash access' do
|
@@ -31,4 +31,12 @@ RSpec.describe Faraday::FlatParamsEncoder do
|
|
31
31
|
params = { a: [] }
|
32
32
|
expect(subject.encode(params)).to eq('a=')
|
33
33
|
end
|
34
|
+
|
35
|
+
it 'encodes unsorted when asked' do
|
36
|
+
params = { b: false, a: true }
|
37
|
+
expect(subject.encode(params)).to eq('a=true&b=false')
|
38
|
+
Faraday::FlatParamsEncoder.sort_params = false
|
39
|
+
expect(subject.encode(params)).to eq('b=false&a=true')
|
40
|
+
Faraday::FlatParamsEncoder.sort_params = true
|
41
|
+
end
|
34
42
|
end
|
@@ -94,6 +94,22 @@ RSpec.describe Faraday::NestedParamsEncoder do
|
|
94
94
|
expect(subject.encode(params)).to eq('a%5B%5D=true&a%5B%5D=false')
|
95
95
|
end
|
96
96
|
|
97
|
+
it 'encodes unsorted when asked' do
|
98
|
+
params = { b: false, a: true }
|
99
|
+
expect(subject.encode(params)).to eq('a=true&b=false')
|
100
|
+
Faraday::NestedParamsEncoder.sort_params = false
|
101
|
+
expect(subject.encode(params)).to eq('b=false&a=true')
|
102
|
+
Faraday::NestedParamsEncoder.sort_params = true
|
103
|
+
end
|
104
|
+
|
105
|
+
it 'encodes arrays indices when asked' do
|
106
|
+
params = { a: [0, 1, 2] }
|
107
|
+
expect(subject.encode(params)).to eq('a%5B%5D=0&a%5B%5D=1&a%5B%5D=2')
|
108
|
+
Faraday::NestedParamsEncoder.array_indices = true
|
109
|
+
expect(subject.encode(params)).to eq('a%5B0%5D=0&a%5B1%5D=1&a%5B2%5D=2')
|
110
|
+
Faraday::NestedParamsEncoder.array_indices = false
|
111
|
+
end
|
112
|
+
|
97
113
|
shared_examples 'a wrong decoding' do
|
98
114
|
it do
|
99
115
|
expect { subject.decode(query) }.to raise_error(TypeError) do |e|
|
@@ -12,16 +12,16 @@ RSpec.describe Faraday::RackBuilder do
|
|
12
12
|
|
13
13
|
class Apple < Handler
|
14
14
|
end
|
15
|
+
|
15
16
|
class Orange < Handler
|
16
17
|
end
|
17
|
-
class Banana < Handler
|
18
|
-
end
|
19
18
|
|
20
|
-
class
|
21
|
-
dependency 'zomg/i_dont/exist'
|
19
|
+
class Banana < Handler
|
22
20
|
end
|
23
21
|
|
24
22
|
subject { conn.builder }
|
23
|
+
before { Faraday.default_adapter = :test }
|
24
|
+
after { Faraday.default_adapter = nil }
|
25
25
|
|
26
26
|
context 'with default stack' do
|
27
27
|
let(:conn) { Faraday::Connection.new }
|
@@ -88,13 +88,6 @@ RSpec.describe Faraday::RackBuilder do
|
|
88
88
|
|
89
89
|
it { expect(subject.handlers).to eq([Apple]) }
|
90
90
|
|
91
|
-
it 'allows rebuilding' do
|
92
|
-
subject.build do |builder|
|
93
|
-
builder.use(Orange)
|
94
|
-
end
|
95
|
-
expect(subject.handlers).to eq([Orange])
|
96
|
-
end
|
97
|
-
|
98
91
|
it 'allows use' do
|
99
92
|
subject.use(Orange)
|
100
93
|
expect(subject.handlers).to eq([Apple, Orange])
|
@@ -117,36 +110,6 @@ RSpec.describe Faraday::RackBuilder do
|
|
117
110
|
end
|
118
111
|
end
|
119
112
|
|
120
|
-
context 'with custom registered middleware' do
|
121
|
-
let(:conn) { Faraday::Connection.new {} }
|
122
|
-
|
123
|
-
after { Faraday::Middleware.unregister_middleware(:apple) }
|
124
|
-
|
125
|
-
it 'allows to register with constant' do
|
126
|
-
Faraday::Middleware.register_middleware(apple: Apple)
|
127
|
-
subject.use(:apple)
|
128
|
-
expect(subject.handlers).to eq([Apple])
|
129
|
-
end
|
130
|
-
|
131
|
-
it 'allows to register with symbol' do
|
132
|
-
Faraday::Middleware.register_middleware(apple: :Apple)
|
133
|
-
subject.use(:apple)
|
134
|
-
expect(subject.handlers).to eq([Apple])
|
135
|
-
end
|
136
|
-
|
137
|
-
it 'allows to register with string' do
|
138
|
-
Faraday::Middleware.register_middleware(apple: 'Apple')
|
139
|
-
subject.use(:apple)
|
140
|
-
expect(subject.handlers).to eq([Apple])
|
141
|
-
end
|
142
|
-
|
143
|
-
it 'allows to register with Proc' do
|
144
|
-
Faraday::Middleware.register_middleware(apple: -> { Apple })
|
145
|
-
subject.use(:apple)
|
146
|
-
expect(subject.handlers).to eq([Apple])
|
147
|
-
end
|
148
|
-
end
|
149
|
-
|
150
113
|
context 'when having two handlers' do
|
151
114
|
let(:conn) { Faraday::Connection.new {} }
|
152
115
|
|
@@ -176,21 +139,179 @@ RSpec.describe Faraday::RackBuilder do
|
|
176
139
|
end
|
177
140
|
end
|
178
141
|
|
179
|
-
context 'when
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
142
|
+
context 'when adapter is added with named options' do
|
143
|
+
after { Faraday.default_adapter_options = {} }
|
144
|
+
let(:conn) { Faraday::Connection.new {} }
|
145
|
+
|
146
|
+
let(:cat_adapter) do
|
147
|
+
Class.new(Faraday::Adapter) do
|
148
|
+
attr_accessor :name
|
149
|
+
|
150
|
+
def initialize(app, name:)
|
151
|
+
super(app)
|
152
|
+
@name = name
|
184
153
|
end
|
185
154
|
end
|
186
155
|
end
|
187
156
|
|
188
|
-
|
157
|
+
let(:cat) { subject.adapter.build }
|
158
|
+
|
159
|
+
it 'adds a handler to construct adapter with named options' do
|
160
|
+
Faraday.default_adapter = cat_adapter
|
161
|
+
Faraday.default_adapter_options = { name: 'Chloe' }
|
162
|
+
expect { cat }.to_not output(
|
163
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
164
|
+
).to_stderr
|
165
|
+
expect(cat.name).to eq 'Chloe'
|
166
|
+
end
|
167
|
+
end
|
168
|
+
|
169
|
+
context 'when middleware is added with named arguments' do
|
170
|
+
let(:conn) { Faraday::Connection.new {} }
|
171
|
+
|
172
|
+
let(:dog_middleware) do
|
173
|
+
Class.new(Faraday::Middleware) do
|
174
|
+
attr_accessor :name
|
189
175
|
|
190
|
-
|
191
|
-
|
192
|
-
|
176
|
+
def initialize(app, name:)
|
177
|
+
super(app)
|
178
|
+
@name = name
|
179
|
+
end
|
193
180
|
end
|
194
181
|
end
|
182
|
+
let(:dog) do
|
183
|
+
subject.handlers.find { |handler| handler == dog_middleware }.build
|
184
|
+
end
|
185
|
+
|
186
|
+
it 'adds a handler to construct middleware with options passed to use' do
|
187
|
+
subject.use dog_middleware, name: 'Rex'
|
188
|
+
expect { dog }.to_not output(
|
189
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
190
|
+
).to_stderr
|
191
|
+
expect(dog.name).to eq('Rex')
|
192
|
+
end
|
193
|
+
end
|
194
|
+
|
195
|
+
context 'when a middleware is added with named arguments' do
|
196
|
+
let(:conn) { Faraday::Connection.new {} }
|
197
|
+
|
198
|
+
let(:cat_request) do
|
199
|
+
Class.new(Faraday::Middleware) do
|
200
|
+
attr_accessor :name
|
201
|
+
|
202
|
+
def initialize(app, name:)
|
203
|
+
super(app)
|
204
|
+
@name = name
|
205
|
+
end
|
206
|
+
end
|
207
|
+
end
|
208
|
+
let(:cat) do
|
209
|
+
subject.handlers.find { |handler| handler == cat_request }.build
|
210
|
+
end
|
211
|
+
|
212
|
+
it 'adds a handler to construct request adapter with options passed to request' do
|
213
|
+
Faraday::Request.register_middleware cat_request: cat_request
|
214
|
+
subject.request :cat_request, name: 'Felix'
|
215
|
+
expect { cat }.to_not output(
|
216
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
217
|
+
).to_stderr
|
218
|
+
expect(cat.name).to eq('Felix')
|
219
|
+
end
|
220
|
+
end
|
221
|
+
|
222
|
+
context 'when a middleware is added with named arguments' do
|
223
|
+
let(:conn) { Faraday::Connection.new {} }
|
224
|
+
|
225
|
+
let(:fish_response) do
|
226
|
+
Class.new(Faraday::Middleware) do
|
227
|
+
attr_accessor :name
|
228
|
+
|
229
|
+
def initialize(app, name:)
|
230
|
+
super(app)
|
231
|
+
@name = name
|
232
|
+
end
|
233
|
+
end
|
234
|
+
end
|
235
|
+
let(:fish) do
|
236
|
+
subject.handlers.find { |handler| handler == fish_response }.build
|
237
|
+
end
|
238
|
+
|
239
|
+
it 'adds a handler to construct response adapter with options passed to response' do
|
240
|
+
Faraday::Response.register_middleware fish_response: fish_response
|
241
|
+
subject.response :fish_response, name: 'Bubbles'
|
242
|
+
expect { fish }.to_not output(
|
243
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
244
|
+
).to_stderr
|
245
|
+
expect(fish.name).to eq('Bubbles')
|
246
|
+
end
|
247
|
+
end
|
248
|
+
|
249
|
+
context 'when a plain adapter is added with named arguments' do
|
250
|
+
let(:conn) { Faraday::Connection.new {} }
|
251
|
+
|
252
|
+
let(:rabbit_adapter) do
|
253
|
+
Class.new(Faraday::Adapter) do
|
254
|
+
attr_accessor :name
|
255
|
+
|
256
|
+
def initialize(app, name:)
|
257
|
+
super(app)
|
258
|
+
@name = name
|
259
|
+
end
|
260
|
+
end
|
261
|
+
end
|
262
|
+
let(:rabbit) do
|
263
|
+
subject.adapter.build
|
264
|
+
end
|
265
|
+
|
266
|
+
it 'adds a handler to construct adapter with options passed to adapter' do
|
267
|
+
Faraday::Adapter.register_middleware rabbit_adapter: rabbit_adapter
|
268
|
+
subject.adapter :rabbit_adapter, name: 'Thumper'
|
269
|
+
expect { rabbit }.to_not output(
|
270
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
271
|
+
).to_stderr
|
272
|
+
expect(rabbit.name).to eq('Thumper')
|
273
|
+
end
|
274
|
+
end
|
275
|
+
|
276
|
+
context 'when handlers are directly added or updated' do
|
277
|
+
let(:conn) { Faraday::Connection.new {} }
|
278
|
+
|
279
|
+
let(:rock_handler) do
|
280
|
+
Class.new do
|
281
|
+
attr_accessor :name
|
282
|
+
|
283
|
+
def initialize(_app, name:)
|
284
|
+
@name = name
|
285
|
+
end
|
286
|
+
end
|
287
|
+
end
|
288
|
+
let(:rock) do
|
289
|
+
subject.handlers.find { |handler| handler == rock_handler }.build
|
290
|
+
end
|
291
|
+
|
292
|
+
it 'adds a handler to construct adapter with options passed to insert' do
|
293
|
+
subject.insert 0, rock_handler, name: 'Stony'
|
294
|
+
expect { rock }.to_not output(
|
295
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
296
|
+
).to_stderr
|
297
|
+
expect(rock.name).to eq('Stony')
|
298
|
+
end
|
299
|
+
|
300
|
+
it 'adds a handler with options passed to insert_after' do
|
301
|
+
subject.insert_after 0, rock_handler, name: 'Rocky'
|
302
|
+
expect { rock }.to_not output(
|
303
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
304
|
+
).to_stderr
|
305
|
+
expect(rock.name).to eq('Rocky')
|
306
|
+
end
|
307
|
+
|
308
|
+
it 'adds a handler with options passed to swap' do
|
309
|
+
subject.insert 0, rock_handler, name: 'Flint'
|
310
|
+
subject.swap 0, rock_handler, name: 'Chert'
|
311
|
+
expect { rock }.to_not output(
|
312
|
+
/warning: Using the last argument as keyword parameters is deprecated/
|
313
|
+
).to_stderr
|
314
|
+
expect(rock.name).to eq('Chert')
|
315
|
+
end
|
195
316
|
end
|
196
317
|
end
|
@@ -3,7 +3,7 @@
|
|
3
3
|
RSpec.describe Faraday::Request::Authorization do
|
4
4
|
let(:conn) do
|
5
5
|
Faraday.new do |b|
|
6
|
-
b.request auth_type, *auth_config
|
6
|
+
b.request :authorization, auth_type, *auth_config
|
7
7
|
b.adapter :test do |stub|
|
8
8
|
stub.get('/auth-echo') do |env|
|
9
9
|
[200, {}, env[:request_headers]['Authorization']]
|
@@ -14,10 +14,10 @@ RSpec.describe Faraday::Request::Authorization do
|
|
14
14
|
|
15
15
|
shared_examples 'does not interfere with existing authentication' do
|
16
16
|
context 'and request already has an authentication header' do
|
17
|
-
let(:response) { conn.get('/auth-echo', nil, authorization: '
|
17
|
+
let(:response) { conn.get('/auth-echo', nil, authorization: 'OAuth oauth_token') }
|
18
18
|
|
19
19
|
it 'does not interfere with existing authorization' do
|
20
|
-
expect(response.body).to eq('
|
20
|
+
expect(response.body).to eq('OAuth oauth_token')
|
21
21
|
end
|
22
22
|
end
|
23
23
|
end
|
@@ -25,7 +25,7 @@ RSpec.describe Faraday::Request::Authorization do
|
|
25
25
|
let(:response) { conn.get('/auth-echo') }
|
26
26
|
|
27
27
|
describe 'basic_auth' do
|
28
|
-
let(:auth_type) { :
|
28
|
+
let(:auth_type) { :basic }
|
29
29
|
|
30
30
|
context 'when passed correct params' do
|
31
31
|
let(:auth_config) { %w[aladdin opensesame] }
|
@@ -44,43 +44,73 @@ RSpec.describe Faraday::Request::Authorization do
|
|
44
44
|
end
|
45
45
|
end
|
46
46
|
|
47
|
-
describe '
|
48
|
-
let(:auth_type) { :
|
47
|
+
describe 'authorization' do
|
48
|
+
let(:auth_type) { :Bearer }
|
49
49
|
|
50
|
-
context 'when passed
|
51
|
-
let(:auth_config) { '
|
50
|
+
context 'when passed a string' do
|
51
|
+
let(:auth_config) { ['custom'] }
|
52
52
|
|
53
|
-
it { expect(response.body).to eq('
|
53
|
+
it { expect(response.body).to eq('Bearer custom') }
|
54
54
|
|
55
55
|
include_examples 'does not interfere with existing authentication'
|
56
56
|
end
|
57
57
|
|
58
|
-
context 'when
|
59
|
-
let(:auth_config) { ['
|
58
|
+
context 'when passed a proc' do
|
59
|
+
let(:auth_config) { [-> { 'custom_from_proc' }] }
|
60
60
|
|
61
|
-
it { expect(response.body).to
|
62
|
-
it { expect(response.body).to match(/token="baz"/) }
|
63
|
-
it { expect(response.body).to match(/foo="42"/) }
|
61
|
+
it { expect(response.body).to eq('Bearer custom_from_proc') }
|
64
62
|
|
65
63
|
include_examples 'does not interfere with existing authentication'
|
66
64
|
end
|
67
|
-
end
|
68
|
-
|
69
|
-
describe 'authorization' do
|
70
|
-
let(:auth_type) { :authorization }
|
71
65
|
|
72
|
-
context 'when passed
|
73
|
-
let(:
|
66
|
+
context 'when passed a callable' do
|
67
|
+
let(:callable) { double('Callable Authorizer', call: 'custom_from_callable') }
|
68
|
+
let(:auth_config) { [callable] }
|
74
69
|
|
75
|
-
it { expect(response.body).to eq('
|
70
|
+
it { expect(response.body).to eq('Bearer custom_from_callable') }
|
76
71
|
|
77
72
|
include_examples 'does not interfere with existing authentication'
|
78
73
|
end
|
79
74
|
|
80
|
-
context '
|
81
|
-
let(:
|
75
|
+
context 'with an argument' do
|
76
|
+
let(:response) { conn.get('/auth-echo', nil, 'middle' => 'crunchy surprise') }
|
77
|
+
|
78
|
+
context 'when passed a proc' do
|
79
|
+
let(:auth_config) { [proc { |env| "proc #{env.request_headers['middle']}" }] }
|
80
|
+
|
81
|
+
it { expect(response.body).to eq('Bearer proc crunchy surprise') }
|
82
|
+
|
83
|
+
include_examples 'does not interfere with existing authentication'
|
84
|
+
end
|
85
|
+
|
86
|
+
context 'when passed a lambda' do
|
87
|
+
let(:auth_config) { [->(env) { "lambda #{env.request_headers['middle']}" }] }
|
88
|
+
|
89
|
+
it { expect(response.body).to eq('Bearer lambda crunchy surprise') }
|
90
|
+
|
91
|
+
include_examples 'does not interfere with existing authentication'
|
92
|
+
end
|
93
|
+
|
94
|
+
context 'when passed a callable with an argument' do
|
95
|
+
let(:callable) do
|
96
|
+
Class.new do
|
97
|
+
def call(env)
|
98
|
+
"callable #{env.request_headers['middle']}"
|
99
|
+
end
|
100
|
+
end.new
|
101
|
+
end
|
102
|
+
let(:auth_config) { [callable] }
|
103
|
+
|
104
|
+
it { expect(response.body).to eq('Bearer callable crunchy surprise') }
|
105
|
+
|
106
|
+
include_examples 'does not interfere with existing authentication'
|
107
|
+
end
|
108
|
+
end
|
109
|
+
|
110
|
+
context 'when passed too many arguments' do
|
111
|
+
let(:auth_config) { %w[baz foo] }
|
82
112
|
|
83
|
-
it { expect
|
113
|
+
it { expect { response }.to raise_error(ArgumentError) }
|
84
114
|
|
85
115
|
include_examples 'does not interfere with existing authentication'
|
86
116
|
end
|