faraday 1.10.4 → 2.14.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 +198 -4
- data/LICENSE.md +1 -1
- data/README.md +34 -20
- data/Rakefile +6 -1
- data/examples/client_spec.rb +41 -19
- data/examples/client_test.rb +48 -22
- data/lib/faraday/adapter/test.rb +62 -13
- data/lib/faraday/adapter.rb +6 -10
- data/lib/faraday/connection.rb +72 -150
- data/lib/faraday/encoders/flat_params_encoder.rb +2 -2
- data/lib/faraday/encoders/nested_params_encoder.rb +14 -7
- data/lib/faraday/error.rb +66 -10
- data/lib/faraday/logging/formatter.rb +30 -17
- data/lib/faraday/middleware.rb +43 -2
- 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 -5
- data/lib/faraday/options/request_options.rb +7 -6
- data/lib/faraday/options/ssl_options.rb +62 -45
- data/lib/faraday/options.rb +7 -6
- data/lib/faraday/rack_builder.rb +44 -45
- data/lib/faraday/request/authorization.rb +33 -41
- data/lib/faraday/request/instrumentation.rb +5 -1
- data/lib/faraday/request/json.rb +18 -3
- data/lib/faraday/request/url_encoded.rb +5 -1
- data/lib/faraday/request.rb +15 -30
- data/lib/faraday/response/json.rb +25 -5
- data/lib/faraday/response/logger.rb +11 -3
- data/lib/faraday/response/raise_error.rb +45 -18
- data/lib/faraday/response.rb +14 -22
- data/lib/faraday/utils/headers.rb +15 -4
- data/lib/faraday/utils.rb +11 -7
- data/lib/faraday/version.rb +1 -1
- data/lib/faraday.rb +10 -45
- data/spec/faraday/adapter/test_spec.rb +65 -0
- data/spec/faraday/connection_spec.rb +165 -93
- data/spec/faraday/error_spec.rb +122 -7
- data/spec/faraday/middleware_registry_spec.rb +31 -0
- data/spec/faraday/middleware_spec.rb +161 -0
- 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 +35 -0
- data/spec/faraday/params_encoders/nested_spec.rb +10 -1
- data/spec/faraday/rack_builder_spec.rb +26 -54
- data/spec/faraday/request/authorization_spec.rb +50 -28
- data/spec/faraday/request/instrumentation_spec.rb +5 -7
- data/spec/faraday/request/json_spec.rb +88 -0
- data/spec/faraday/request/url_encoded_spec.rb +12 -2
- data/spec/faraday/request_spec.rb +5 -15
- data/spec/faraday/response/json_spec.rb +93 -6
- data/spec/faraday/response/logger_spec.rb +83 -4
- data/spec/faraday/response/raise_error_spec.rb +133 -16
- data/spec/faraday/response_spec.rb +10 -1
- data/spec/faraday/utils/headers_spec.rb +31 -4
- data/spec/faraday/utils_spec.rb +65 -1
- data/spec/faraday_spec.rb +10 -4
- data/spec/spec_helper.rb +5 -6
- data/spec/support/fake_safe_buffer.rb +1 -1
- data/spec/support/faraday_middleware_subclasses.rb +18 -0
- data/spec/support/helper_methods.rb +0 -37
- data/spec/support/shared_examples/adapter.rb +2 -2
- data/spec/support/shared_examples/request_method.rb +22 -21
- metadata +24 -149
- data/lib/faraday/adapter/typhoeus.rb +0 -15
- data/lib/faraday/autoload.rb +0 -89
- data/lib/faraday/dependency_loader.rb +0 -39
- data/lib/faraday/deprecate.rb +0 -110
- data/lib/faraday/request/basic_authentication.rb +0 -20
- data/lib/faraday/request/token_authentication.rb +0 -20
- data/spec/faraday/adapter/em_http_spec.rb +0 -49
- data/spec/faraday/adapter/em_synchrony_spec.rb +0 -18
- data/spec/faraday/adapter/excon_spec.rb +0 -49
- data/spec/faraday/adapter/httpclient_spec.rb +0 -73
- 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/deprecate_spec.rb +0 -147
- data/spec/faraday/response/middleware_spec.rb +0 -68
- data/spec/support/webmock_rack_app.rb +0 -68
|
@@ -11,8 +11,10 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
11
11
|
stub.get('forbidden') { [403, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
12
12
|
stub.get('not-found') { [404, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
13
13
|
stub.get('proxy-error') { [407, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
14
|
+
stub.get('request-timeout') { [408, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
14
15
|
stub.get('conflict') { [409, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
15
|
-
stub.get('unprocessable-
|
|
16
|
+
stub.get('unprocessable-content') { [422, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
17
|
+
stub.get('too-many-requests') { [429, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
16
18
|
stub.get('4xx') { [499, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
17
19
|
stub.get('nil-status') { [nil, { 'X-Reason' => 'nil' }, 'fail'] }
|
|
18
20
|
stub.get('server-error') { [500, { 'X-Error' => 'bailout' }, 'fail'] }
|
|
@@ -26,7 +28,7 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
26
28
|
|
|
27
29
|
it 'raises Faraday::BadRequestError for 400 responses' do
|
|
28
30
|
expect { conn.get('bad-request') }.to raise_error(Faraday::BadRequestError) do |ex|
|
|
29
|
-
expect(ex.message).to eq('the server responded with status 400')
|
|
31
|
+
expect(ex.message).to eq('the server responded with status 400 for GET http:/bad-request')
|
|
30
32
|
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
31
33
|
expect(ex.response[:status]).to eq(400)
|
|
32
34
|
expect(ex.response_status).to eq(400)
|
|
@@ -37,7 +39,7 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
37
39
|
|
|
38
40
|
it 'raises Faraday::UnauthorizedError for 401 responses' do
|
|
39
41
|
expect { conn.get('unauthorized') }.to raise_error(Faraday::UnauthorizedError) do |ex|
|
|
40
|
-
expect(ex.message).to eq('the server responded with status 401')
|
|
42
|
+
expect(ex.message).to eq('the server responded with status 401 for GET http:/unauthorized')
|
|
41
43
|
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
42
44
|
expect(ex.response[:status]).to eq(401)
|
|
43
45
|
expect(ex.response_status).to eq(401)
|
|
@@ -48,7 +50,7 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
48
50
|
|
|
49
51
|
it 'raises Faraday::ForbiddenError for 403 responses' do
|
|
50
52
|
expect { conn.get('forbidden') }.to raise_error(Faraday::ForbiddenError) do |ex|
|
|
51
|
-
expect(ex.message).to eq('the server responded with status 403')
|
|
53
|
+
expect(ex.message).to eq('the server responded with status 403 for GET http:/forbidden')
|
|
52
54
|
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
53
55
|
expect(ex.response[:status]).to eq(403)
|
|
54
56
|
expect(ex.response_status).to eq(403)
|
|
@@ -59,7 +61,7 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
59
61
|
|
|
60
62
|
it 'raises Faraday::ResourceNotFound for 404 responses' do
|
|
61
63
|
expect { conn.get('not-found') }.to raise_error(Faraday::ResourceNotFound) do |ex|
|
|
62
|
-
expect(ex.message).to eq('the server responded with status 404')
|
|
64
|
+
expect(ex.message).to eq('the server responded with status 404 for GET http:/not-found')
|
|
63
65
|
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
64
66
|
expect(ex.response[:status]).to eq(404)
|
|
65
67
|
expect(ex.response_status).to eq(404)
|
|
@@ -79,9 +81,20 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
79
81
|
end
|
|
80
82
|
end
|
|
81
83
|
|
|
84
|
+
it 'raises Faraday::RequestTimeoutError for 408 responses' do
|
|
85
|
+
expect { conn.get('request-timeout') }.to raise_error(Faraday::RequestTimeoutError) do |ex|
|
|
86
|
+
expect(ex.message).to eq('the server responded with status 408 for GET http:/request-timeout')
|
|
87
|
+
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
88
|
+
expect(ex.response[:status]).to eq(408)
|
|
89
|
+
expect(ex.response_status).to eq(408)
|
|
90
|
+
expect(ex.response_body).to eq('keep looking')
|
|
91
|
+
expect(ex.response_headers['X-Reason']).to eq('because')
|
|
92
|
+
end
|
|
93
|
+
end
|
|
94
|
+
|
|
82
95
|
it 'raises Faraday::ConflictError for 409 responses' do
|
|
83
96
|
expect { conn.get('conflict') }.to raise_error(Faraday::ConflictError) do |ex|
|
|
84
|
-
expect(ex.message).to eq('the server responded with status 409')
|
|
97
|
+
expect(ex.message).to eq('the server responded with status 409 for GET http:/conflict')
|
|
85
98
|
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
86
99
|
expect(ex.response[:status]).to eq(409)
|
|
87
100
|
expect(ex.response_status).to eq(409)
|
|
@@ -90,9 +103,20 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
90
103
|
end
|
|
91
104
|
end
|
|
92
105
|
|
|
93
|
-
it 'raises Faraday::UnprocessableEntityError for 422 responses' do
|
|
94
|
-
expect { conn.get('unprocessable-
|
|
95
|
-
expect(ex.message).to eq('the server responded with status 422')
|
|
106
|
+
it 'raises legacy Faraday::UnprocessableEntityError for 422 responses' do
|
|
107
|
+
expect { conn.get('unprocessable-content') }.to raise_error(Faraday::UnprocessableEntityError) do |ex|
|
|
108
|
+
expect(ex.message).to eq('the server responded with status 422 for GET http:/unprocessable-content')
|
|
109
|
+
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
110
|
+
expect(ex.response[:status]).to eq(422)
|
|
111
|
+
expect(ex.response_status).to eq(422)
|
|
112
|
+
expect(ex.response_body).to eq('keep looking')
|
|
113
|
+
expect(ex.response_headers['X-Reason']).to eq('because')
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
it 'raises Faraday::UnprocessableContentError for 422 responses' do
|
|
118
|
+
expect { conn.get('unprocessable-content') }.to raise_error(Faraday::UnprocessableContentError) do |ex|
|
|
119
|
+
expect(ex.message).to eq('the server responded with status 422 for GET http:/unprocessable-content')
|
|
96
120
|
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
97
121
|
expect(ex.response[:status]).to eq(422)
|
|
98
122
|
expect(ex.response_status).to eq(422)
|
|
@@ -101,6 +125,17 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
101
125
|
end
|
|
102
126
|
end
|
|
103
127
|
|
|
128
|
+
it 'raises Faraday::TooManyRequestsError for 429 responses' do
|
|
129
|
+
expect { conn.get('too-many-requests') }.to raise_error(Faraday::TooManyRequestsError) do |ex|
|
|
130
|
+
expect(ex.message).to eq('the server responded with status 429 for GET http:/too-many-requests')
|
|
131
|
+
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
132
|
+
expect(ex.response[:status]).to eq(429)
|
|
133
|
+
expect(ex.response_status).to eq(429)
|
|
134
|
+
expect(ex.response_body).to eq('keep looking')
|
|
135
|
+
expect(ex.response_headers['X-Reason']).to eq('because')
|
|
136
|
+
end
|
|
137
|
+
end
|
|
138
|
+
|
|
104
139
|
it 'raises Faraday::NilStatusError for nil status in response' do
|
|
105
140
|
expect { conn.get('nil-status') }.to raise_error(Faraday::NilStatusError) do |ex|
|
|
106
141
|
expect(ex.message).to eq('http status could not be derived from the server response')
|
|
@@ -114,7 +149,7 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
114
149
|
|
|
115
150
|
it 'raises Faraday::ClientError for other 4xx responses' do
|
|
116
151
|
expect { conn.get('4xx') }.to raise_error(Faraday::ClientError) do |ex|
|
|
117
|
-
expect(ex.message).to eq('the server responded with status 499')
|
|
152
|
+
expect(ex.message).to eq('the server responded with status 499 for GET http:/4xx')
|
|
118
153
|
expect(ex.response[:headers]['X-Reason']).to eq('because')
|
|
119
154
|
expect(ex.response[:status]).to eq(499)
|
|
120
155
|
expect(ex.response_status).to eq(499)
|
|
@@ -125,7 +160,7 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
125
160
|
|
|
126
161
|
it 'raises Faraday::ServerError for 500 responses' do
|
|
127
162
|
expect { conn.get('server-error') }.to raise_error(Faraday::ServerError) do |ex|
|
|
128
|
-
expect(ex.message).to eq('the server responded with status 500')
|
|
163
|
+
expect(ex.message).to eq('the server responded with status 500 for GET http:/server-error')
|
|
129
164
|
expect(ex.response[:headers]['X-Error']).to eq('bailout')
|
|
130
165
|
expect(ex.response[:status]).to eq(500)
|
|
131
166
|
expect(ex.response_status).to eq(500)
|
|
@@ -137,21 +172,24 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
137
172
|
describe 'request info' do
|
|
138
173
|
let(:conn) do
|
|
139
174
|
Faraday.new do |b|
|
|
140
|
-
b.response :raise_error
|
|
175
|
+
b.response :raise_error, **middleware_options
|
|
141
176
|
b.adapter :test do |stub|
|
|
142
|
-
stub.post(
|
|
177
|
+
stub.post(url, request_body, request_headers) do
|
|
143
178
|
[400, { 'X-Reason' => 'because' }, 'keep looking']
|
|
144
179
|
end
|
|
145
180
|
end
|
|
146
181
|
end
|
|
147
182
|
end
|
|
183
|
+
let(:middleware_options) { {} }
|
|
148
184
|
let(:request_body) { JSON.generate({ 'item' => 'sth' }) }
|
|
149
185
|
let(:request_headers) { { 'Authorization' => 'Basic 123' } }
|
|
186
|
+
let(:url_path) { 'request' }
|
|
187
|
+
let(:query_params) { 'full=true' }
|
|
188
|
+
let(:url) { "#{url_path}?#{query_params}" }
|
|
150
189
|
|
|
151
190
|
subject(:perform_request) do
|
|
152
|
-
conn.post
|
|
191
|
+
conn.post url do |req|
|
|
153
192
|
req.headers['Authorization'] = 'Basic 123'
|
|
154
|
-
req.params[:full] = true
|
|
155
193
|
req.body = request_body
|
|
156
194
|
end
|
|
157
195
|
end
|
|
@@ -159,11 +197,90 @@ RSpec.describe Faraday::Response::RaiseError do
|
|
|
159
197
|
it 'returns the request info in the exception' do
|
|
160
198
|
expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
|
|
161
199
|
expect(ex.response[:request][:method]).to eq(:post)
|
|
162
|
-
expect(ex.response[:request][:
|
|
200
|
+
expect(ex.response[:request][:url]).to eq(URI("http:/#{url}"))
|
|
201
|
+
expect(ex.response[:request][:url_path]).to eq("/#{url_path}")
|
|
163
202
|
expect(ex.response[:request][:params]).to eq({ 'full' => 'true' })
|
|
164
203
|
expect(ex.response[:request][:headers]).to match(a_hash_including(request_headers))
|
|
165
204
|
expect(ex.response[:request][:body]).to eq(request_body)
|
|
166
205
|
end
|
|
167
206
|
end
|
|
207
|
+
|
|
208
|
+
describe 'DEFAULT_OPTION: include_request' do
|
|
209
|
+
before(:each) do
|
|
210
|
+
Faraday::Response::RaiseError.instance_variable_set(:@default_options, nil)
|
|
211
|
+
Faraday::Middleware.instance_variable_set(:@default_options, nil)
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
after(:all) do
|
|
215
|
+
Faraday::Response::RaiseError.instance_variable_set(:@default_options, nil)
|
|
216
|
+
Faraday::Middleware.instance_variable_set(:@default_options, nil)
|
|
217
|
+
end
|
|
218
|
+
|
|
219
|
+
context 'when RaiseError DEFAULT_OPTION (include_request: true) is used' do
|
|
220
|
+
it 'includes request info in the exception' do
|
|
221
|
+
expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
|
|
222
|
+
expect(ex.response.keys).to contain_exactly(
|
|
223
|
+
:status,
|
|
224
|
+
:headers,
|
|
225
|
+
:body,
|
|
226
|
+
:request
|
|
227
|
+
)
|
|
228
|
+
end
|
|
229
|
+
end
|
|
230
|
+
end
|
|
231
|
+
|
|
232
|
+
context 'when application sets default_options `include_request: false`' do
|
|
233
|
+
before(:each) do
|
|
234
|
+
Faraday::Response::RaiseError.default_options = { include_request: false }
|
|
235
|
+
end
|
|
236
|
+
|
|
237
|
+
context 'and when include_request option is omitted' do
|
|
238
|
+
it 'does not include request info in the exception' do
|
|
239
|
+
expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
|
|
240
|
+
expect(ex.response.keys).to contain_exactly(
|
|
241
|
+
:status,
|
|
242
|
+
:headers,
|
|
243
|
+
:body
|
|
244
|
+
)
|
|
245
|
+
end
|
|
246
|
+
end
|
|
247
|
+
end
|
|
248
|
+
|
|
249
|
+
context 'and when include_request option is explicitly set for instance' do
|
|
250
|
+
let(:middleware_options) { { include_request: true } }
|
|
251
|
+
|
|
252
|
+
it 'includes request info in the exception' do
|
|
253
|
+
expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
|
|
254
|
+
expect(ex.response.keys).to contain_exactly(
|
|
255
|
+
:status,
|
|
256
|
+
:headers,
|
|
257
|
+
:body,
|
|
258
|
+
:request
|
|
259
|
+
)
|
|
260
|
+
end
|
|
261
|
+
end
|
|
262
|
+
end
|
|
263
|
+
end
|
|
264
|
+
end
|
|
265
|
+
end
|
|
266
|
+
|
|
267
|
+
describe 'allowing certain status codes' do
|
|
268
|
+
let(:conn) do
|
|
269
|
+
Faraday.new do |b|
|
|
270
|
+
b.response :raise_error, allowed_statuses: [404]
|
|
271
|
+
b.adapter :test do |stub|
|
|
272
|
+
stub.get('bad-request') { [400, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
273
|
+
stub.get('not-found') { [404, { 'X-Reason' => 'because' }, 'keep looking'] }
|
|
274
|
+
end
|
|
275
|
+
end
|
|
276
|
+
end
|
|
277
|
+
|
|
278
|
+
it 'raises an error for status codes that are not explicitly allowed' do
|
|
279
|
+
expect { conn.get('bad-request') }.to raise_error(Faraday::BadRequestError)
|
|
280
|
+
end
|
|
281
|
+
|
|
282
|
+
it 'does not raise an error for allowed status codes' do
|
|
283
|
+
expect { conn.get('not-found') }.not_to raise_error
|
|
284
|
+
end
|
|
168
285
|
end
|
|
169
286
|
end
|
|
@@ -4,7 +4,7 @@ RSpec.describe Faraday::Response do
|
|
|
4
4
|
subject { Faraday::Response.new(env) }
|
|
5
5
|
|
|
6
6
|
let(:env) do
|
|
7
|
-
Faraday::Env.from(status: 404, body: 'yikes',
|
|
7
|
+
Faraday::Env.from(status: 404, body: 'yikes', url: Faraday::Utils.URI('https://lostisland.github.io/faraday'),
|
|
8
8
|
response_headers: { 'Content-Type' => 'text/plain' })
|
|
9
9
|
end
|
|
10
10
|
|
|
@@ -13,6 +13,7 @@ RSpec.describe Faraday::Response do
|
|
|
13
13
|
it { expect(subject.success?).to be_falsey }
|
|
14
14
|
it { expect(subject.status).to eq(404) }
|
|
15
15
|
it { expect(subject.body).to eq('yikes') }
|
|
16
|
+
it { expect(subject.url).to eq(URI('https://lostisland.github.io/faraday')) }
|
|
16
17
|
it { expect(subject.headers['Content-Type']).to eq('text/plain') }
|
|
17
18
|
it { expect(subject['content-type']).to eq('text/plain') }
|
|
18
19
|
|
|
@@ -30,6 +31,13 @@ RSpec.describe Faraday::Response do
|
|
|
30
31
|
it { expect(hash[:status]).to eq(subject.status) }
|
|
31
32
|
it { expect(hash[:response_headers]).to eq(subject.headers) }
|
|
32
33
|
it { expect(hash[:body]).to eq(subject.body) }
|
|
34
|
+
it { expect(hash[:url]).to eq(subject.env.url) }
|
|
35
|
+
|
|
36
|
+
context 'when response is not finished' do
|
|
37
|
+
subject { Faraday::Response.new.to_hash }
|
|
38
|
+
|
|
39
|
+
it { is_expected.to eq({ status: nil, body: nil, response_headers: {}, url: nil }) }
|
|
40
|
+
end
|
|
33
41
|
end
|
|
34
42
|
|
|
35
43
|
describe 'marshal serialization support' do
|
|
@@ -45,6 +53,7 @@ RSpec.describe Faraday::Response do
|
|
|
45
53
|
it { expect(loaded.env[:body]).to eq(env[:body]) }
|
|
46
54
|
it { expect(loaded.env[:response_headers]).to eq(env[:response_headers]) }
|
|
47
55
|
it { expect(loaded.env[:status]).to eq(env[:status]) }
|
|
56
|
+
it { expect(loaded.env[:url]).to eq(env[:url]) }
|
|
48
57
|
end
|
|
49
58
|
|
|
50
59
|
describe '#on_complete' do
|
|
@@ -56,27 +56,54 @@ RSpec.describe Faraday::Utils::Headers do
|
|
|
56
56
|
it { expect(subject.delete('content-type')).to be_nil }
|
|
57
57
|
end
|
|
58
58
|
|
|
59
|
-
describe '#
|
|
60
|
-
before { subject
|
|
59
|
+
describe '#dig' do
|
|
60
|
+
before { subject['Content-Type'] = 'application/json' }
|
|
61
|
+
|
|
62
|
+
it { expect(subject&.dig('Content-Type')).to eq('application/json') }
|
|
63
|
+
it { expect(subject&.dig('CONTENT-TYPE')).to eq('application/json') }
|
|
64
|
+
it { expect(subject&.dig(:content_type)).to eq('application/json') }
|
|
65
|
+
it { expect(subject&.dig('invalid')).to be_nil }
|
|
66
|
+
end
|
|
61
67
|
|
|
68
|
+
describe '#parse' do
|
|
62
69
|
context 'when response headers leave http status line out' do
|
|
63
70
|
let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n" }
|
|
64
71
|
|
|
72
|
+
before { subject.parse(headers) }
|
|
73
|
+
|
|
65
74
|
it { expect(subject.keys).to eq(%w[Content-Type]) }
|
|
66
75
|
it { expect(subject['Content-Type']).to eq('text/html') }
|
|
67
76
|
it { expect(subject['content-type']).to eq('text/html') }
|
|
68
77
|
end
|
|
69
78
|
|
|
70
79
|
context 'when response headers values include a colon' do
|
|
71
|
-
let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://
|
|
80
|
+
let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://httpbingo.org/\r\n\r\n" }
|
|
72
81
|
|
|
73
|
-
|
|
82
|
+
before { subject.parse(headers) }
|
|
83
|
+
|
|
84
|
+
it { expect(subject['location']).to eq('http://httpbingo.org/') }
|
|
74
85
|
end
|
|
75
86
|
|
|
76
87
|
context 'when response headers include a blank line' do
|
|
77
88
|
let(:headers) { "HTTP/1.1 200 OK\r\n\r\nContent-Type: text/html\r\n\r\n" }
|
|
78
89
|
|
|
90
|
+
before { subject.parse(headers) }
|
|
91
|
+
|
|
79
92
|
it { expect(subject['content-type']).to eq('text/html') }
|
|
80
93
|
end
|
|
94
|
+
|
|
95
|
+
context 'when response headers include already stored keys' do
|
|
96
|
+
let(:headers) { "HTTP/1.1 200 OK\r\nX-Numbers: 123\r\n\r\n" }
|
|
97
|
+
|
|
98
|
+
before do
|
|
99
|
+
h = subject
|
|
100
|
+
h[:x_numbers] = 8
|
|
101
|
+
h.parse(headers)
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
it do
|
|
105
|
+
expect(subject[:x_numbers]).to eq('8, 123')
|
|
106
|
+
end
|
|
107
|
+
end
|
|
81
108
|
end
|
|
82
109
|
end
|
data/spec/faraday/utils_spec.rb
CHANGED
|
@@ -4,7 +4,7 @@ RSpec.describe Faraday::Utils do
|
|
|
4
4
|
describe 'headers parsing' do
|
|
5
5
|
let(:multi_response_headers) do
|
|
6
6
|
"HTTP/1.x 500 OK\r\nContent-Type: text/html; charset=UTF-8\r\n" \
|
|
7
|
-
|
|
7
|
+
"HTTP/1.x 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n"
|
|
8
8
|
end
|
|
9
9
|
|
|
10
10
|
it 'parse headers for aggregated responses' do
|
|
@@ -53,4 +53,68 @@ RSpec.describe Faraday::Utils do
|
|
|
53
53
|
expect(headers).not_to have_key('authorization')
|
|
54
54
|
end
|
|
55
55
|
end
|
|
56
|
+
|
|
57
|
+
describe '.deep_merge!' do
|
|
58
|
+
let(:connection_options) { Faraday::ConnectionOptions.new }
|
|
59
|
+
let(:url) do
|
|
60
|
+
{
|
|
61
|
+
url: 'http://example.com/abc',
|
|
62
|
+
headers: { 'Mime-Version' => '1.0' },
|
|
63
|
+
request: { oauth: { consumer_key: 'anonymous' } },
|
|
64
|
+
ssl: { version: '2' }
|
|
65
|
+
}
|
|
66
|
+
end
|
|
67
|
+
|
|
68
|
+
it 'recursively merges the headers' do
|
|
69
|
+
connection_options.headers = { user_agent: 'My Agent 1.0' }
|
|
70
|
+
deep_merge = Faraday::Utils.deep_merge!(connection_options, url)
|
|
71
|
+
|
|
72
|
+
expect(deep_merge.headers).to eq('Mime-Version' => '1.0', user_agent: 'My Agent 1.0')
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
context 'when a target hash has an Options Struct value' do
|
|
76
|
+
let(:request) do
|
|
77
|
+
{
|
|
78
|
+
params_encoder: nil,
|
|
79
|
+
proxy: nil,
|
|
80
|
+
bind: nil,
|
|
81
|
+
timeout: nil,
|
|
82
|
+
open_timeout: nil,
|
|
83
|
+
read_timeout: nil,
|
|
84
|
+
write_timeout: nil,
|
|
85
|
+
boundary: nil,
|
|
86
|
+
oauth: { consumer_key: 'anonymous' },
|
|
87
|
+
context: nil,
|
|
88
|
+
on_data: nil
|
|
89
|
+
}
|
|
90
|
+
end
|
|
91
|
+
let(:ssl) do
|
|
92
|
+
{
|
|
93
|
+
verify: nil,
|
|
94
|
+
ca_file: nil,
|
|
95
|
+
ca_path: nil,
|
|
96
|
+
verify_mode: nil,
|
|
97
|
+
cert_store: nil,
|
|
98
|
+
client_cert: nil,
|
|
99
|
+
client_key: nil,
|
|
100
|
+
certificate: nil,
|
|
101
|
+
private_key: nil,
|
|
102
|
+
verify_depth: nil,
|
|
103
|
+
version: '2',
|
|
104
|
+
min_version: nil,
|
|
105
|
+
max_version: nil,
|
|
106
|
+
verify_hostname: nil,
|
|
107
|
+
hostname: nil,
|
|
108
|
+
ciphers: nil
|
|
109
|
+
}
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
it 'does not overwrite an Options Struct value' do
|
|
113
|
+
deep_merge = Faraday::Utils.deep_merge!(connection_options, url)
|
|
114
|
+
|
|
115
|
+
expect(deep_merge.request.to_h).to eq(request)
|
|
116
|
+
expect(deep_merge.ssl.to_h).to eq(ssl)
|
|
117
|
+
end
|
|
118
|
+
end
|
|
119
|
+
end
|
|
56
120
|
end
|
data/spec/faraday_spec.rb
CHANGED
|
@@ -18,10 +18,16 @@ RSpec.describe Faraday do
|
|
|
18
18
|
end
|
|
19
19
|
|
|
20
20
|
it 'uses method_missing on Faraday if there is no proxyable method' do
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
expected_message =
|
|
22
|
+
if RUBY_VERSION >= '3.4'
|
|
23
|
+
"undefined method 'this_method_does_not_exist' for module Faraday"
|
|
24
|
+
elsif RUBY_VERSION >= '3.3'
|
|
25
|
+
"undefined method `this_method_does_not_exist' for module Faraday"
|
|
26
|
+
else
|
|
27
|
+
"undefined method `this_method_does_not_exist' for Faraday:Module"
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
expect { Faraday.this_method_does_not_exist }.to raise_error(NoMethodError, expected_message)
|
|
25
31
|
end
|
|
26
32
|
|
|
27
33
|
it 'proxied methods can be accessed' do
|
data/spec/spec_helper.rb
CHANGED
|
@@ -29,16 +29,15 @@ SimpleCov.start do
|
|
|
29
29
|
minimum_coverage_by_file 26
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
# Ensure all /lib files are loaded
|
|
33
|
-
# so they will be included in the test coverage report.
|
|
34
|
-
Dir['./lib/**/*.rb'].sort.each { |file| require file }
|
|
35
|
-
|
|
36
32
|
require 'faraday'
|
|
37
33
|
require 'pry'
|
|
38
34
|
|
|
39
|
-
|
|
35
|
+
# Ensure all /lib files are loaded
|
|
36
|
+
# so they will be included in the test coverage report.
|
|
37
|
+
Dir['./lib/**/*.rb'].each { |file| require file }
|
|
40
38
|
|
|
41
|
-
|
|
39
|
+
# Load all Rspec support files
|
|
40
|
+
Dir['./spec/support/**/*.rb'].each { |file| require file }
|
|
42
41
|
|
|
43
42
|
RSpec.configure do |config|
|
|
44
43
|
# rspec-expectations config goes here. You can use an alternate
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module FaradayMiddlewareSubclasses
|
|
4
|
+
class SubclassNoOptions < Faraday::Middleware
|
|
5
|
+
end
|
|
6
|
+
|
|
7
|
+
class SubclassOneOption < Faraday::Middleware
|
|
8
|
+
DEFAULT_OPTIONS = { some_other_option: false }.freeze
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
class SubclassTwoOptions < Faraday::Middleware
|
|
12
|
+
DEFAULT_OPTIONS = { some_option: true, some_other_option: false }.freeze
|
|
13
|
+
end
|
|
14
|
+
end
|
|
15
|
+
|
|
16
|
+
Faraday::Response.register_middleware(no_options: FaradayMiddlewareSubclasses::SubclassNoOptions)
|
|
17
|
+
Faraday::Response.register_middleware(one_option: FaradayMiddlewareSubclasses::SubclassOneOption)
|
|
18
|
+
Faraday::Response.register_middleware(two_options: FaradayMiddlewareSubclasses::SubclassTwoOptions)
|
|
@@ -1,7 +1,5 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
-
require 'multipart_parser/reader'
|
|
4
|
-
|
|
5
3
|
module Faraday
|
|
6
4
|
module HelperMethods
|
|
7
5
|
def self.included(base)
|
|
@@ -86,41 +84,6 @@ module Faraday
|
|
|
86
84
|
end
|
|
87
85
|
end
|
|
88
86
|
|
|
89
|
-
def multipart_file
|
|
90
|
-
Faraday::FilePart.new(__FILE__, 'text/x-ruby')
|
|
91
|
-
end
|
|
92
|
-
|
|
93
|
-
# parse boundary out of a Content-Type header like:
|
|
94
|
-
# Content-Type: multipart/form-data; boundary=gc0p4Jq0M2Yt08jU534c0p
|
|
95
|
-
def parse_multipart_boundary(ctype)
|
|
96
|
-
MultipartParser::Reader.extract_boundary_value(ctype)
|
|
97
|
-
end
|
|
98
|
-
|
|
99
|
-
# parse a multipart MIME message, returning a hash of any multipart errors
|
|
100
|
-
def parse_multipart(boundary, body)
|
|
101
|
-
reader = MultipartParser::Reader.new(boundary)
|
|
102
|
-
result = { errors: [], parts: [] }
|
|
103
|
-
def result.part(name)
|
|
104
|
-
hash = self[:parts].detect { |h| h[:part].name == name }
|
|
105
|
-
[hash[:part], hash[:body].join]
|
|
106
|
-
end
|
|
107
|
-
|
|
108
|
-
reader.on_part do |part|
|
|
109
|
-
result[:parts] << thispart = {
|
|
110
|
-
part: part,
|
|
111
|
-
body: []
|
|
112
|
-
}
|
|
113
|
-
part.on_data do |chunk|
|
|
114
|
-
thispart[:body] << chunk
|
|
115
|
-
end
|
|
116
|
-
end
|
|
117
|
-
reader.on_error do |msg|
|
|
118
|
-
result[:errors] << msg
|
|
119
|
-
end
|
|
120
|
-
reader.write(body)
|
|
121
|
-
result
|
|
122
|
-
end
|
|
123
|
-
|
|
124
87
|
def method_with_body?(method)
|
|
125
88
|
self.class.method_with_body?(method)
|
|
126
89
|
end
|
|
@@ -37,10 +37,10 @@ shared_examples 'adapter examples' do |**options|
|
|
|
37
37
|
|
|
38
38
|
let(:conn) do
|
|
39
39
|
conn_options[:ssl] ||= {}
|
|
40
|
-
conn_options[:ssl][:ca_file] ||= ENV
|
|
40
|
+
conn_options[:ssl][:ca_file] ||= ENV.fetch('SSL_FILE', nil)
|
|
41
|
+
conn_options[:ssl][:verify_hostname] ||= ENV['SSL_VERIFY_HOSTNAME'] == 'yes'
|
|
41
42
|
|
|
42
43
|
Faraday.new(remote, conn_options) do |conn|
|
|
43
|
-
conn.request :multipart
|
|
44
44
|
conn.request :url_encoded
|
|
45
45
|
conn.response :raise_error
|
|
46
46
|
conn.adapter described_class, *adapter_options
|
|
@@ -79,7 +79,7 @@ shared_examples 'a request method' do |http_method|
|
|
|
79
79
|
|
|
80
80
|
on_feature :request_body_on_query_methods do
|
|
81
81
|
it 'sends request body' do
|
|
82
|
-
request_stub.with(
|
|
82
|
+
request_stub.with({ body: 'test' })
|
|
83
83
|
res = if query_or_body == :body
|
|
84
84
|
conn.public_send(http_method, '/', 'test')
|
|
85
85
|
else
|
|
@@ -93,7 +93,7 @@ shared_examples 'a request method' do |http_method|
|
|
|
93
93
|
|
|
94
94
|
it 'sends url encoded parameters' do
|
|
95
95
|
payload = { name: 'zack' }
|
|
96
|
-
request_stub.with(
|
|
96
|
+
request_stub.with({ query_or_body => payload })
|
|
97
97
|
res = conn.public_send(http_method, '/', payload)
|
|
98
98
|
if query_or_body == :query
|
|
99
99
|
expect(res.env.request_body).to be_nil
|
|
@@ -104,7 +104,7 @@ shared_examples 'a request method' do |http_method|
|
|
|
104
104
|
|
|
105
105
|
it 'sends url encoded nested parameters' do
|
|
106
106
|
payload = { name: { first: 'zack' } }
|
|
107
|
-
request_stub.with(
|
|
107
|
+
request_stub.with({ query_or_body => payload })
|
|
108
108
|
conn.public_send(http_method, '/', payload)
|
|
109
109
|
end
|
|
110
110
|
|
|
@@ -126,19 +126,6 @@ shared_examples 'a request method' do |http_method|
|
|
|
126
126
|
expect { conn.public_send(http_method, '/') }.to raise_error(exc)
|
|
127
127
|
end
|
|
128
128
|
|
|
129
|
-
# Can't send files on get, head and delete methods
|
|
130
|
-
if method_with_body?(http_method)
|
|
131
|
-
it 'sends files' do
|
|
132
|
-
payload = { uploaded_file: multipart_file }
|
|
133
|
-
request_stub.with(headers: { 'Content-Type' => %r{\Amultipart/form-data} }) do |request|
|
|
134
|
-
# WebMock does not support matching body for multipart/form-data requests yet :(
|
|
135
|
-
# https://github.com/bblimke/webmock/issues/623
|
|
136
|
-
request.body.include?('RubyMultipartPost')
|
|
137
|
-
end
|
|
138
|
-
conn.public_send(http_method, '/', payload)
|
|
139
|
-
end
|
|
140
|
-
end
|
|
141
|
-
|
|
142
129
|
on_feature :reason_phrase_parse do
|
|
143
130
|
it 'parses the reason phrase' do
|
|
144
131
|
request_stub.to_return(status: [200, 'OK'])
|
|
@@ -166,12 +153,19 @@ shared_examples 'a request method' do |http_method|
|
|
|
166
153
|
let(:streamed) { [] }
|
|
167
154
|
|
|
168
155
|
context 'when response is empty' do
|
|
169
|
-
it do
|
|
156
|
+
it 'handles streaming' do
|
|
157
|
+
env = nil
|
|
170
158
|
conn.public_send(http_method, '/') do |req|
|
|
171
|
-
req.options.on_data = proc
|
|
159
|
+
req.options.on_data = proc do |chunk, size, block_env|
|
|
160
|
+
streamed << [chunk, size]
|
|
161
|
+
env ||= block_env
|
|
162
|
+
end
|
|
172
163
|
end
|
|
173
164
|
|
|
174
165
|
expect(streamed).to eq([['', 0]])
|
|
166
|
+
# TODO: enable this after updating all existing adapters to the new streaming API
|
|
167
|
+
# expect(env).to be_a(Faraday::Env)
|
|
168
|
+
# expect(env.status).to eq(200)
|
|
175
169
|
end
|
|
176
170
|
end
|
|
177
171
|
|
|
@@ -179,12 +173,19 @@ shared_examples 'a request method' do |http_method|
|
|
|
179
173
|
before { request_stub.to_return(body: big_string) }
|
|
180
174
|
|
|
181
175
|
it 'handles streaming' do
|
|
176
|
+
env = nil
|
|
182
177
|
response = conn.public_send(http_method, '/') do |req|
|
|
183
|
-
req.options.on_data = proc
|
|
178
|
+
req.options.on_data = proc do |chunk, size, block_env|
|
|
179
|
+
streamed << [chunk, size]
|
|
180
|
+
env ||= block_env
|
|
181
|
+
end
|
|
184
182
|
end
|
|
185
183
|
|
|
186
184
|
expect(response.body).to eq('')
|
|
187
185
|
check_streaming_response(streamed, chunk_size: 16 * 1024)
|
|
186
|
+
# TODO: enable this after updating all existing adapters to the new streaming API
|
|
187
|
+
# expect(env).to be_a(Faraday::Env)
|
|
188
|
+
# expect(env.status).to eq(200)
|
|
188
189
|
end
|
|
189
190
|
end
|
|
190
191
|
end
|
|
@@ -199,11 +200,11 @@ shared_examples 'a request method' do |http_method|
|
|
|
199
200
|
@payload2 = { b: '2' }
|
|
200
201
|
|
|
201
202
|
request_stub
|
|
202
|
-
.with(
|
|
203
|
+
.with({ query_or_body => @payload1 })
|
|
203
204
|
.to_return(body: @payload1.to_json)
|
|
204
205
|
|
|
205
206
|
stub_request(http_method, remote)
|
|
206
|
-
.with(
|
|
207
|
+
.with({ query_or_body => @payload2 })
|
|
207
208
|
.to_return(body: @payload2.to_json)
|
|
208
209
|
|
|
209
210
|
conn.in_parallel do
|