faraday 0.9.1 → 1.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/CHANGELOG.md +360 -0
- data/LICENSE.md +1 -1
- data/README.md +28 -195
- data/Rakefile +4 -68
- data/examples/client_spec.rb +97 -0
- data/examples/client_test.rb +118 -0
- data/lib/faraday/adapter/test.rb +158 -58
- data/lib/faraday/adapter/typhoeus.rb +7 -115
- data/lib/faraday/adapter.rb +79 -20
- data/lib/faraday/adapter_registry.rb +30 -0
- data/lib/faraday/autoload.rb +39 -36
- data/lib/faraday/connection.rb +378 -168
- data/lib/faraday/dependency_loader.rb +37 -0
- data/lib/faraday/encoders/flat_params_encoder.rb +105 -0
- data/lib/faraday/encoders/nested_params_encoder.rb +176 -0
- data/lib/faraday/error.rb +128 -29
- data/lib/faraday/file_part.rb +128 -0
- data/lib/faraday/logging/formatter.rb +105 -0
- data/lib/faraday/methods.rb +6 -0
- data/lib/faraday/middleware.rb +19 -25
- data/lib/faraday/middleware_registry.rb +129 -0
- data/lib/faraday/options/connection_options.rb +22 -0
- data/lib/faraday/options/env.rb +181 -0
- data/lib/faraday/options/proxy_options.rb +32 -0
- data/lib/faraday/options/request_options.rb +22 -0
- data/lib/faraday/options/ssl_options.rb +59 -0
- data/lib/faraday/options.rb +61 -193
- data/lib/faraday/param_part.rb +53 -0
- data/lib/faraday/parameters.rb +4 -180
- data/lib/faraday/rack_builder.rb +84 -47
- data/lib/faraday/request/authorization.rb +51 -31
- data/lib/faraday/request/basic_authentication.rb +14 -7
- data/lib/faraday/request/instrumentation.rb +45 -27
- data/lib/faraday/request/multipart.rb +88 -45
- data/lib/faraday/request/retry.rb +212 -121
- data/lib/faraday/request/token_authentication.rb +15 -10
- data/lib/faraday/request/url_encoded.rb +43 -23
- data/lib/faraday/request.rb +96 -32
- data/lib/faraday/response/logger.rb +22 -48
- data/lib/faraday/response/raise_error.rb +49 -14
- data/lib/faraday/response.rb +33 -25
- data/lib/faraday/utils/headers.rb +139 -0
- data/lib/faraday/utils/params_hash.rb +61 -0
- data/lib/faraday/utils.rb +38 -218
- data/lib/faraday/version.rb +5 -0
- data/lib/faraday.rb +130 -213
- data/spec/external_adapters/faraday_specs_setup.rb +14 -0
- data/spec/faraday/adapter/em_http_spec.rb +49 -0
- data/spec/faraday/adapter/em_synchrony_spec.rb +18 -0
- data/spec/faraday/adapter/excon_spec.rb +49 -0
- data/spec/faraday/adapter/httpclient_spec.rb +73 -0
- data/spec/faraday/adapter/net_http_spec.rb +64 -0
- data/spec/faraday/adapter/patron_spec.rb +18 -0
- data/spec/faraday/adapter/rack_spec.rb +8 -0
- data/spec/faraday/adapter/test_spec.rb +377 -0
- data/spec/faraday/adapter/typhoeus_spec.rb +7 -0
- data/spec/faraday/adapter_registry_spec.rb +28 -0
- data/spec/faraday/adapter_spec.rb +55 -0
- data/spec/faraday/composite_read_io_spec.rb +80 -0
- data/spec/faraday/connection_spec.rb +736 -0
- data/spec/faraday/error_spec.rb +60 -0
- data/spec/faraday/middleware_spec.rb +52 -0
- data/spec/faraday/options/env_spec.rb +70 -0
- data/spec/faraday/options/options_spec.rb +297 -0
- data/spec/faraday/options/proxy_options_spec.rb +44 -0
- data/spec/faraday/options/request_options_spec.rb +19 -0
- data/spec/faraday/params_encoders/flat_spec.rb +42 -0
- data/spec/faraday/params_encoders/nested_spec.rb +142 -0
- data/spec/faraday/rack_builder_spec.rb +345 -0
- data/spec/faraday/request/authorization_spec.rb +96 -0
- data/spec/faraday/request/instrumentation_spec.rb +76 -0
- data/spec/faraday/request/multipart_spec.rb +302 -0
- data/spec/faraday/request/retry_spec.rb +242 -0
- data/spec/faraday/request/url_encoded_spec.rb +83 -0
- data/spec/faraday/request_spec.rb +120 -0
- data/spec/faraday/response/logger_spec.rb +220 -0
- data/spec/faraday/response/middleware_spec.rb +68 -0
- data/spec/faraday/response/raise_error_spec.rb +169 -0
- data/spec/faraday/response_spec.rb +75 -0
- data/spec/faraday/utils/headers_spec.rb +82 -0
- data/spec/faraday/utils_spec.rb +56 -0
- data/spec/faraday_spec.rb +37 -0
- data/spec/spec_helper.rb +132 -0
- data/spec/support/disabling_stub.rb +14 -0
- data/spec/support/fake_safe_buffer.rb +15 -0
- data/spec/support/helper_methods.rb +133 -0
- data/spec/support/shared_examples/adapter.rb +105 -0
- data/spec/support/shared_examples/params_encoder.rb +18 -0
- data/spec/support/shared_examples/request_method.rb +262 -0
- data/spec/support/streaming_response_checker.rb +35 -0
- data/spec/support/webmock_rack_app.rb +68 -0
- metadata +199 -98
- data/.document +0 -6
- data/CONTRIBUTING.md +0 -36
- data/Gemfile +0 -25
- data/faraday.gemspec +0 -34
- data/lib/faraday/adapter/em_http.rb +0 -237
- data/lib/faraday/adapter/em_http_ssl_patch.rb +0 -56
- data/lib/faraday/adapter/em_synchrony/parallel_manager.rb +0 -66
- data/lib/faraday/adapter/em_synchrony.rb +0 -92
- data/lib/faraday/adapter/excon.rb +0 -80
- data/lib/faraday/adapter/httpclient.rb +0 -106
- data/lib/faraday/adapter/net_http.rb +0 -130
- data/lib/faraday/adapter/net_http_persistent.rb +0 -48
- data/lib/faraday/adapter/patron.rb +0 -72
- data/lib/faraday/adapter/rack.rb +0 -58
- data/lib/faraday/upload_io.rb +0 -67
- data/script/cached-bundle +0 -46
- data/script/console +0 -7
- data/script/generate_certs +0 -42
- data/script/package +0 -7
- data/script/proxy-server +0 -42
- data/script/release +0 -17
- data/script/s3-put +0 -71
- data/script/server +0 -36
- data/script/test +0 -172
- data/test/adapters/default_test.rb +0 -14
- data/test/adapters/em_http_test.rb +0 -20
- data/test/adapters/em_synchrony_test.rb +0 -20
- data/test/adapters/excon_test.rb +0 -20
- data/test/adapters/httpclient_test.rb +0 -21
- data/test/adapters/integration.rb +0 -254
- data/test/adapters/logger_test.rb +0 -82
- data/test/adapters/net_http_persistent_test.rb +0 -20
- data/test/adapters/net_http_test.rb +0 -14
- data/test/adapters/patron_test.rb +0 -20
- data/test/adapters/rack_test.rb +0 -31
- data/test/adapters/test_middleware_test.rb +0 -114
- data/test/adapters/typhoeus_test.rb +0 -28
- data/test/authentication_middleware_test.rb +0 -65
- data/test/composite_read_io_test.rb +0 -111
- data/test/connection_test.rb +0 -522
- data/test/env_test.rb +0 -218
- data/test/helper.rb +0 -81
- data/test/live_server.rb +0 -67
- data/test/middleware/instrumentation_test.rb +0 -88
- data/test/middleware/retry_test.rb +0 -177
- data/test/middleware_stack_test.rb +0 -173
- data/test/multibyte.txt +0 -1
- data/test/options_test.rb +0 -252
- data/test/parameters_test.rb +0 -64
- data/test/request_middleware_test.rb +0 -142
- data/test/response_middleware_test.rb +0 -72
- data/test/strawberry.rb +0 -2
- data/test/utils_test.rb +0 -58
@@ -0,0 +1,302 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
RSpec.describe Faraday::Request::Multipart do
|
4
|
+
let(:options) { {} }
|
5
|
+
let(:conn) do
|
6
|
+
Faraday.new do |b|
|
7
|
+
b.request :multipart, options
|
8
|
+
b.request :url_encoded
|
9
|
+
b.adapter :test do |stub|
|
10
|
+
stub.post('/echo') do |env|
|
11
|
+
posted_as = env[:request_headers]['Content-Type']
|
12
|
+
expect(env[:body]).to be_a_kind_of(Faraday::CompositeReadIO)
|
13
|
+
[200, { 'Content-Type' => posted_as }, env[:body].read]
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
|
19
|
+
shared_examples 'a multipart request' do
|
20
|
+
it 'generates a unique boundary for each request' do
|
21
|
+
response1 = conn.post('/echo', payload)
|
22
|
+
response2 = conn.post('/echo', payload)
|
23
|
+
|
24
|
+
b1 = parse_multipart_boundary(response1.headers['Content-Type'])
|
25
|
+
b2 = parse_multipart_boundary(response2.headers['Content-Type'])
|
26
|
+
expect(b1).to_not eq(b2)
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
context 'FilePart: when multipart objects in param' do
|
31
|
+
let(:payload) do
|
32
|
+
{
|
33
|
+
a: 1,
|
34
|
+
b: {
|
35
|
+
c: Faraday::FilePart.new(__FILE__, 'text/x-ruby', nil,
|
36
|
+
'Content-Disposition' => 'form-data; foo=1'),
|
37
|
+
d: 2
|
38
|
+
}
|
39
|
+
}
|
40
|
+
end
|
41
|
+
it_behaves_like 'a multipart request'
|
42
|
+
|
43
|
+
it 'forms a multipart request' do
|
44
|
+
response = conn.post('/echo', payload)
|
45
|
+
|
46
|
+
boundary = parse_multipart_boundary(response.headers['Content-Type'])
|
47
|
+
result = parse_multipart(boundary, response.body)
|
48
|
+
expect(result[:errors]).to be_empty
|
49
|
+
|
50
|
+
part_a, body_a = result.part('a')
|
51
|
+
expect(part_a).to_not be_nil
|
52
|
+
expect(part_a.filename).to be_nil
|
53
|
+
expect(body_a).to eq('1')
|
54
|
+
|
55
|
+
part_bc, body_bc = result.part('b[c]')
|
56
|
+
expect(part_bc).to_not be_nil
|
57
|
+
expect(part_bc.filename).to eq('multipart_spec.rb')
|
58
|
+
expect(part_bc.headers['content-disposition'])
|
59
|
+
.to eq(
|
60
|
+
'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
|
61
|
+
)
|
62
|
+
expect(part_bc.headers['content-type']).to eq('text/x-ruby')
|
63
|
+
expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
|
64
|
+
expect(body_bc).to eq(File.read(__FILE__))
|
65
|
+
|
66
|
+
part_bd, body_bd = result.part('b[d]')
|
67
|
+
expect(part_bd).to_not be_nil
|
68
|
+
expect(part_bd.filename).to be_nil
|
69
|
+
expect(body_bd).to eq('2')
|
70
|
+
end
|
71
|
+
end
|
72
|
+
|
73
|
+
context 'FilePart: when providing json and IO content in the same payload' do
|
74
|
+
let(:io) { StringIO.new('io-content') }
|
75
|
+
let(:json) do
|
76
|
+
{
|
77
|
+
b: 1,
|
78
|
+
c: 2
|
79
|
+
}.to_json
|
80
|
+
end
|
81
|
+
|
82
|
+
let(:payload) do
|
83
|
+
{
|
84
|
+
json: Faraday::ParamPart.new(json, 'application/json'),
|
85
|
+
io: Faraday::FilePart.new(io, 'application/pdf')
|
86
|
+
}
|
87
|
+
end
|
88
|
+
|
89
|
+
it_behaves_like 'a multipart request'
|
90
|
+
|
91
|
+
it 'forms a multipart request' do
|
92
|
+
response = conn.post('/echo', payload)
|
93
|
+
|
94
|
+
boundary = parse_multipart_boundary(response.headers['Content-Type'])
|
95
|
+
result = parse_multipart(boundary, response.body)
|
96
|
+
expect(result[:errors]).to be_empty
|
97
|
+
|
98
|
+
part_json, body_json = result.part('json')
|
99
|
+
expect(part_json).to_not be_nil
|
100
|
+
expect(part_json.mime).to eq('application/json')
|
101
|
+
expect(part_json.filename).to be_nil
|
102
|
+
expect(body_json).to eq(json)
|
103
|
+
|
104
|
+
part_io, body_io = result.part('io')
|
105
|
+
expect(part_io).to_not be_nil
|
106
|
+
expect(part_io.mime).to eq('application/pdf')
|
107
|
+
expect(part_io.filename).to eq('local.path')
|
108
|
+
expect(body_io).to eq(io.string)
|
109
|
+
end
|
110
|
+
end
|
111
|
+
|
112
|
+
context 'FilePart: when multipart objects in array param' do
|
113
|
+
let(:payload) do
|
114
|
+
{
|
115
|
+
a: 1,
|
116
|
+
b: [{
|
117
|
+
c: Faraday::FilePart.new(__FILE__, 'text/x-ruby'),
|
118
|
+
d: 2
|
119
|
+
}]
|
120
|
+
}
|
121
|
+
end
|
122
|
+
|
123
|
+
it_behaves_like 'a multipart request'
|
124
|
+
|
125
|
+
it 'forms a multipart request' do
|
126
|
+
response = conn.post('/echo', payload)
|
127
|
+
|
128
|
+
boundary = parse_multipart_boundary(response.headers['Content-Type'])
|
129
|
+
result = parse_multipart(boundary, response.body)
|
130
|
+
expect(result[:errors]).to be_empty
|
131
|
+
|
132
|
+
part_a, body_a = result.part('a')
|
133
|
+
expect(part_a).to_not be_nil
|
134
|
+
expect(part_a.filename).to be_nil
|
135
|
+
expect(body_a).to eq('1')
|
136
|
+
|
137
|
+
part_bc, body_bc = result.part('b[][c]')
|
138
|
+
expect(part_bc).to_not be_nil
|
139
|
+
expect(part_bc.filename).to eq('multipart_spec.rb')
|
140
|
+
expect(part_bc.headers['content-disposition'])
|
141
|
+
.to eq(
|
142
|
+
'form-data; name="b[][c]"; filename="multipart_spec.rb"'
|
143
|
+
)
|
144
|
+
expect(part_bc.headers['content-type']).to eq('text/x-ruby')
|
145
|
+
expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
|
146
|
+
expect(body_bc).to eq(File.read(__FILE__))
|
147
|
+
|
148
|
+
part_bd, body_bd = result.part('b[][d]')
|
149
|
+
expect(part_bd).to_not be_nil
|
150
|
+
expect(part_bd.filename).to be_nil
|
151
|
+
expect(body_bd).to eq('2')
|
152
|
+
end
|
153
|
+
end
|
154
|
+
|
155
|
+
context 'UploadIO: when multipart objects in param' do
|
156
|
+
let(:payload) do
|
157
|
+
{
|
158
|
+
a: 1,
|
159
|
+
b: {
|
160
|
+
c: Faraday::UploadIO.new(__FILE__, 'text/x-ruby', nil,
|
161
|
+
'Content-Disposition' => 'form-data; foo=1'),
|
162
|
+
d: 2
|
163
|
+
}
|
164
|
+
}
|
165
|
+
end
|
166
|
+
it_behaves_like 'a multipart request'
|
167
|
+
|
168
|
+
it 'forms a multipart request' do
|
169
|
+
response = conn.post('/echo', payload)
|
170
|
+
|
171
|
+
boundary = parse_multipart_boundary(response.headers['Content-Type'])
|
172
|
+
result = parse_multipart(boundary, response.body)
|
173
|
+
expect(result[:errors]).to be_empty
|
174
|
+
|
175
|
+
part_a, body_a = result.part('a')
|
176
|
+
expect(part_a).to_not be_nil
|
177
|
+
expect(part_a.filename).to be_nil
|
178
|
+
expect(body_a).to eq('1')
|
179
|
+
|
180
|
+
part_bc, body_bc = result.part('b[c]')
|
181
|
+
expect(part_bc).to_not be_nil
|
182
|
+
expect(part_bc.filename).to eq('multipart_spec.rb')
|
183
|
+
expect(part_bc.headers['content-disposition'])
|
184
|
+
.to eq(
|
185
|
+
'form-data; foo=1; name="b[c]"; filename="multipart_spec.rb"'
|
186
|
+
)
|
187
|
+
expect(part_bc.headers['content-type']).to eq('text/x-ruby')
|
188
|
+
expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
|
189
|
+
expect(body_bc).to eq(File.read(__FILE__))
|
190
|
+
|
191
|
+
part_bd, body_bd = result.part('b[d]')
|
192
|
+
expect(part_bd).to_not be_nil
|
193
|
+
expect(part_bd.filename).to be_nil
|
194
|
+
expect(body_bd).to eq('2')
|
195
|
+
end
|
196
|
+
end
|
197
|
+
|
198
|
+
context 'UploadIO: when providing json and IO content in the same payload' do
|
199
|
+
let(:io) { StringIO.new('io-content') }
|
200
|
+
let(:json) do
|
201
|
+
{
|
202
|
+
b: 1,
|
203
|
+
c: 2
|
204
|
+
}.to_json
|
205
|
+
end
|
206
|
+
|
207
|
+
let(:payload) do
|
208
|
+
{
|
209
|
+
json: Faraday::ParamPart.new(json, 'application/json'),
|
210
|
+
io: Faraday::UploadIO.new(io, 'application/pdf')
|
211
|
+
}
|
212
|
+
end
|
213
|
+
|
214
|
+
it_behaves_like 'a multipart request'
|
215
|
+
|
216
|
+
it 'forms a multipart request' do
|
217
|
+
response = conn.post('/echo', payload)
|
218
|
+
|
219
|
+
boundary = parse_multipart_boundary(response.headers['Content-Type'])
|
220
|
+
result = parse_multipart(boundary, response.body)
|
221
|
+
expect(result[:errors]).to be_empty
|
222
|
+
|
223
|
+
part_json, body_json = result.part('json')
|
224
|
+
expect(part_json).to_not be_nil
|
225
|
+
expect(part_json.mime).to eq('application/json')
|
226
|
+
expect(part_json.filename).to be_nil
|
227
|
+
expect(body_json).to eq(json)
|
228
|
+
|
229
|
+
part_io, body_io = result.part('io')
|
230
|
+
expect(part_io).to_not be_nil
|
231
|
+
expect(part_io.mime).to eq('application/pdf')
|
232
|
+
expect(part_io.filename).to eq('local.path')
|
233
|
+
expect(body_io).to eq(io.string)
|
234
|
+
end
|
235
|
+
end
|
236
|
+
|
237
|
+
context 'UploadIO: when multipart objects in array param' do
|
238
|
+
let(:payload) do
|
239
|
+
{
|
240
|
+
a: 1,
|
241
|
+
b: [{
|
242
|
+
c: Faraday::UploadIO.new(__FILE__, 'text/x-ruby'),
|
243
|
+
d: 2
|
244
|
+
}]
|
245
|
+
}
|
246
|
+
end
|
247
|
+
|
248
|
+
it_behaves_like 'a multipart request'
|
249
|
+
|
250
|
+
it 'forms a multipart request' do
|
251
|
+
response = conn.post('/echo', payload)
|
252
|
+
|
253
|
+
boundary = parse_multipart_boundary(response.headers['Content-Type'])
|
254
|
+
result = parse_multipart(boundary, response.body)
|
255
|
+
expect(result[:errors]).to be_empty
|
256
|
+
|
257
|
+
part_a, body_a = result.part('a')
|
258
|
+
expect(part_a).to_not be_nil
|
259
|
+
expect(part_a.filename).to be_nil
|
260
|
+
expect(body_a).to eq('1')
|
261
|
+
|
262
|
+
part_bc, body_bc = result.part('b[][c]')
|
263
|
+
expect(part_bc).to_not be_nil
|
264
|
+
expect(part_bc.filename).to eq('multipart_spec.rb')
|
265
|
+
expect(part_bc.headers['content-disposition'])
|
266
|
+
.to eq(
|
267
|
+
'form-data; name="b[][c]"; filename="multipart_spec.rb"'
|
268
|
+
)
|
269
|
+
expect(part_bc.headers['content-type']).to eq('text/x-ruby')
|
270
|
+
expect(part_bc.headers['content-transfer-encoding']).to eq('binary')
|
271
|
+
expect(body_bc).to eq(File.read(__FILE__))
|
272
|
+
|
273
|
+
part_bd, body_bd = result.part('b[][d]')
|
274
|
+
expect(part_bd).to_not be_nil
|
275
|
+
expect(part_bd.filename).to be_nil
|
276
|
+
expect(body_bd).to eq('2')
|
277
|
+
end
|
278
|
+
end
|
279
|
+
|
280
|
+
context 'when passing flat_encode=true option' do
|
281
|
+
let(:options) { { flat_encode: true } }
|
282
|
+
let(:io) { StringIO.new('io-content') }
|
283
|
+
let(:payload) do
|
284
|
+
{
|
285
|
+
a: 1,
|
286
|
+
b: [
|
287
|
+
Faraday::UploadIO.new(io, 'application/pdf'),
|
288
|
+
Faraday::UploadIO.new(io, 'application/pdf')
|
289
|
+
]
|
290
|
+
}
|
291
|
+
end
|
292
|
+
|
293
|
+
it_behaves_like 'a multipart request'
|
294
|
+
|
295
|
+
it 'encode params using flat encoder' do
|
296
|
+
response = conn.post('/echo', payload)
|
297
|
+
|
298
|
+
expect(response.body).to include('name="b"')
|
299
|
+
expect(response.body).not_to include('name="b[]"')
|
300
|
+
end
|
301
|
+
end
|
302
|
+
end
|
@@ -0,0 +1,242 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
RSpec.describe Faraday::Request::Retry do
|
4
|
+
let(:calls) { [] }
|
5
|
+
let(:times_called) { calls.size }
|
6
|
+
let(:options) { [] }
|
7
|
+
let(:conn) do
|
8
|
+
Faraday.new do |b|
|
9
|
+
b.request :retry, *options
|
10
|
+
|
11
|
+
b.adapter :test do |stub|
|
12
|
+
%w[get post].each do |method|
|
13
|
+
stub.send(method, '/unstable') do |env|
|
14
|
+
calls << env.dup
|
15
|
+
env[:body] = nil # simulate blanking out response body
|
16
|
+
callback.call
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
context 'when an unexpected error happens' do
|
24
|
+
let(:callback) { -> { raise 'boom!' } }
|
25
|
+
|
26
|
+
before { expect { conn.get('/unstable') }.to raise_error(RuntimeError) }
|
27
|
+
|
28
|
+
it { expect(times_called).to eq(1) }
|
29
|
+
|
30
|
+
context 'and this is passed as a custom exception' do
|
31
|
+
let(:options) { [{ exceptions: StandardError }] }
|
32
|
+
|
33
|
+
it { expect(times_called).to eq(3) }
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
context 'when an expected error happens' do
|
38
|
+
let(:callback) { -> { raise Errno::ETIMEDOUT } }
|
39
|
+
|
40
|
+
before do
|
41
|
+
@started = Time.now
|
42
|
+
expect { conn.get('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
43
|
+
end
|
44
|
+
|
45
|
+
it { expect(times_called).to eq(3) }
|
46
|
+
|
47
|
+
context 'and legacy max_retry set to 1' do
|
48
|
+
let(:options) { [1] }
|
49
|
+
|
50
|
+
it { expect(times_called).to eq(2) }
|
51
|
+
end
|
52
|
+
|
53
|
+
context 'and legacy max_retry set to -9' do
|
54
|
+
let(:options) { [-9] }
|
55
|
+
|
56
|
+
it { expect(times_called).to eq(1) }
|
57
|
+
end
|
58
|
+
|
59
|
+
context 'and new max_retry set to 3' do
|
60
|
+
let(:options) { [{ max: 3 }] }
|
61
|
+
|
62
|
+
it { expect(times_called).to eq(4) }
|
63
|
+
end
|
64
|
+
|
65
|
+
context 'and new max_retry set to -9' do
|
66
|
+
let(:options) { [{ max: -9 }] }
|
67
|
+
|
68
|
+
it { expect(times_called).to eq(1) }
|
69
|
+
end
|
70
|
+
|
71
|
+
context 'and both max_retry and interval are set' do
|
72
|
+
let(:options) { [{ max: 2, interval: 0.1 }] }
|
73
|
+
|
74
|
+
it { expect(Time.now - @started).to be_within(0.04).of(0.2) }
|
75
|
+
end
|
76
|
+
end
|
77
|
+
|
78
|
+
context 'when no exception raised' do
|
79
|
+
let(:options) { [{ max: 1, retry_statuses: 429 }] }
|
80
|
+
|
81
|
+
before { conn.get('/unstable') }
|
82
|
+
|
83
|
+
context 'and response code is in retry_statuses' do
|
84
|
+
let(:callback) { -> { [429, {}, ''] } }
|
85
|
+
|
86
|
+
it { expect(times_called).to eq(2) }
|
87
|
+
end
|
88
|
+
|
89
|
+
context 'and response code is not in retry_statuses' do
|
90
|
+
let(:callback) { -> { [503, {}, ''] } }
|
91
|
+
|
92
|
+
it { expect(times_called).to eq(1) }
|
93
|
+
end
|
94
|
+
end
|
95
|
+
|
96
|
+
describe '#calculate_retry_interval' do
|
97
|
+
context 'with exponential backoff' do
|
98
|
+
let(:options) { { max: 5, interval: 0.1, backoff_factor: 2 } }
|
99
|
+
let(:middleware) { Faraday::Request::Retry.new(nil, options) }
|
100
|
+
|
101
|
+
it { expect(middleware.send(:calculate_retry_interval, 5)).to eq(0.1) }
|
102
|
+
it { expect(middleware.send(:calculate_retry_interval, 4)).to eq(0.2) }
|
103
|
+
it { expect(middleware.send(:calculate_retry_interval, 3)).to eq(0.4) }
|
104
|
+
end
|
105
|
+
|
106
|
+
context 'with exponential backoff and max_interval' do
|
107
|
+
let(:options) { { max: 5, interval: 0.1, backoff_factor: 2, max_interval: 0.3 } }
|
108
|
+
let(:middleware) { Faraday::Request::Retry.new(nil, options) }
|
109
|
+
|
110
|
+
it { expect(middleware.send(:calculate_retry_interval, 5)).to eq(0.1) }
|
111
|
+
it { expect(middleware.send(:calculate_retry_interval, 4)).to eq(0.2) }
|
112
|
+
it { expect(middleware.send(:calculate_retry_interval, 3)).to eq(0.3) }
|
113
|
+
it { expect(middleware.send(:calculate_retry_interval, 2)).to eq(0.3) }
|
114
|
+
end
|
115
|
+
|
116
|
+
context 'with exponential backoff and interval_randomness' do
|
117
|
+
let(:options) { { max: 2, interval: 0.1, interval_randomness: 0.05 } }
|
118
|
+
let(:middleware) { Faraday::Request::Retry.new(nil, options) }
|
119
|
+
|
120
|
+
it { expect(middleware.send(:calculate_retry_interval, 2)).to be_between(0.1, 0.105) }
|
121
|
+
end
|
122
|
+
end
|
123
|
+
|
124
|
+
context 'when method is not idempotent' do
|
125
|
+
let(:callback) { -> { raise Errno::ETIMEDOUT } }
|
126
|
+
|
127
|
+
before { expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT) }
|
128
|
+
|
129
|
+
it { expect(times_called).to eq(1) }
|
130
|
+
end
|
131
|
+
|
132
|
+
describe 'retry_if option' do
|
133
|
+
let(:callback) { -> { raise Errno::ETIMEDOUT } }
|
134
|
+
let(:options) { [{ retry_if: @check }] }
|
135
|
+
|
136
|
+
it 'retries if retry_if block always returns true' do
|
137
|
+
body = { foo: :bar }
|
138
|
+
@check = ->(_, _) { true }
|
139
|
+
expect { conn.post('/unstable', body) }.to raise_error(Errno::ETIMEDOUT)
|
140
|
+
expect(times_called).to eq(3)
|
141
|
+
expect(calls.all? { |env| env[:body] == body }).to be_truthy
|
142
|
+
end
|
143
|
+
|
144
|
+
it 'does not retry if retry_if block returns false checking env' do
|
145
|
+
@check = ->(env, _) { env[:method] != :post }
|
146
|
+
expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
147
|
+
expect(times_called).to eq(1)
|
148
|
+
end
|
149
|
+
|
150
|
+
it 'does not retry if retry_if block returns false checking exception' do
|
151
|
+
@check = ->(_, exception) { !exception.is_a?(Errno::ETIMEDOUT) }
|
152
|
+
expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
153
|
+
expect(times_called).to eq(1)
|
154
|
+
end
|
155
|
+
|
156
|
+
it 'FilePart: should rewind files on retry' do
|
157
|
+
io = StringIO.new('Test data')
|
158
|
+
filepart = Faraday::FilePart.new(io, 'application/octet/stream')
|
159
|
+
|
160
|
+
rewound = 0
|
161
|
+
rewind = -> { rewound += 1 }
|
162
|
+
|
163
|
+
@check = ->(_, _) { true }
|
164
|
+
allow(filepart).to receive(:rewind, &rewind)
|
165
|
+
expect { conn.post('/unstable', file: filepart) }.to raise_error(Errno::ETIMEDOUT)
|
166
|
+
expect(times_called).to eq(3)
|
167
|
+
expect(rewound).to eq(2)
|
168
|
+
end
|
169
|
+
|
170
|
+
it 'UploadIO: should rewind files on retry' do
|
171
|
+
io = StringIO.new('Test data')
|
172
|
+
upload_io = Faraday::UploadIO.new(io, 'application/octet/stream')
|
173
|
+
|
174
|
+
rewound = 0
|
175
|
+
rewind = -> { rewound += 1 }
|
176
|
+
|
177
|
+
@check = ->(_, _) { true }
|
178
|
+
allow(upload_io).to receive(:rewind, &rewind)
|
179
|
+
expect { conn.post('/unstable', file: upload_io) }.to raise_error(Errno::ETIMEDOUT)
|
180
|
+
expect(times_called).to eq(3)
|
181
|
+
expect(rewound).to eq(2)
|
182
|
+
end
|
183
|
+
|
184
|
+
context 'when explicitly specifying methods to retry' do
|
185
|
+
let(:options) { [{ retry_if: @check, methods: [:post] }] }
|
186
|
+
|
187
|
+
it 'does not call retry_if for specified methods' do
|
188
|
+
@check = ->(_, _) { raise 'this should have never been called' }
|
189
|
+
expect { conn.post('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
190
|
+
expect(times_called).to eq(3)
|
191
|
+
end
|
192
|
+
end
|
193
|
+
|
194
|
+
context 'with empty list of methods to retry' do
|
195
|
+
let(:options) { [{ retry_if: @check, methods: [] }] }
|
196
|
+
|
197
|
+
it 'calls retry_if for all methods' do
|
198
|
+
@check = ->(_, _) { calls.size < 2 }
|
199
|
+
expect { conn.get('/unstable') }.to raise_error(Errno::ETIMEDOUT)
|
200
|
+
expect(times_called).to eq(2)
|
201
|
+
end
|
202
|
+
end
|
203
|
+
end
|
204
|
+
|
205
|
+
describe 'retry_after header support' do
|
206
|
+
let(:callback) { -> { [504, headers, ''] } }
|
207
|
+
let(:elapsed) { Time.now - @started }
|
208
|
+
|
209
|
+
before do
|
210
|
+
@started = Time.now
|
211
|
+
conn.get('/unstable')
|
212
|
+
end
|
213
|
+
|
214
|
+
context 'when retry_after bigger than interval' do
|
215
|
+
let(:headers) { { 'Retry-After' => '0.5' } }
|
216
|
+
let(:options) { [{ max: 1, interval: 0.1, retry_statuses: 504 }] }
|
217
|
+
|
218
|
+
it { expect(elapsed).to be > 0.5 }
|
219
|
+
end
|
220
|
+
|
221
|
+
context 'when retry_after smaller than interval' do
|
222
|
+
let(:headers) { { 'Retry-After' => '0.1' } }
|
223
|
+
let(:options) { [{ max: 1, interval: 0.2, retry_statuses: 504 }] }
|
224
|
+
|
225
|
+
it { expect(elapsed).to be > 0.2 }
|
226
|
+
end
|
227
|
+
|
228
|
+
context 'when retry_after is a timestamp' do
|
229
|
+
let(:headers) { { 'Retry-After' => (Time.now.utc + 2).strftime('%a, %d %b %Y %H:%M:%S GMT') } }
|
230
|
+
let(:options) { [{ max: 1, interval: 0.1, retry_statuses: 504 }] }
|
231
|
+
|
232
|
+
it { expect(elapsed).to be > 1 }
|
233
|
+
end
|
234
|
+
|
235
|
+
context 'when retry_after is bigger than max_interval' do
|
236
|
+
let(:headers) { { 'Retry-After' => (Time.now.utc + 20).strftime('%a, %d %b %Y %H:%M:%S GMT') } }
|
237
|
+
let(:options) { [{ max: 2, interval: 0.1, max_interval: 5, retry_statuses: 504 }] }
|
238
|
+
|
239
|
+
it { expect(times_called).to eq(1) }
|
240
|
+
end
|
241
|
+
end
|
242
|
+
end
|
@@ -0,0 +1,83 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
RSpec.describe Faraday::Request::UrlEncoded do
|
4
|
+
let(:conn) do
|
5
|
+
Faraday.new do |b|
|
6
|
+
b.request :multipart
|
7
|
+
b.request :url_encoded
|
8
|
+
b.adapter :test do |stub|
|
9
|
+
stub.post('/echo') do |env|
|
10
|
+
posted_as = env[:request_headers]['Content-Type']
|
11
|
+
[200, { 'Content-Type' => posted_as }, env[:body]]
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
it 'does nothing without payload' do
|
18
|
+
response = conn.post('/echo')
|
19
|
+
expect(response.headers['Content-Type']).to be_nil
|
20
|
+
expect(response.body.empty?).to be_truthy
|
21
|
+
end
|
22
|
+
|
23
|
+
it 'ignores custom content type' do
|
24
|
+
response = conn.post('/echo', { some: 'data' }, 'content-type' => 'application/x-foo')
|
25
|
+
expect(response.headers['Content-Type']).to eq('application/x-foo')
|
26
|
+
expect(response.body).to eq(some: 'data')
|
27
|
+
end
|
28
|
+
|
29
|
+
it 'works with no headers' do
|
30
|
+
response = conn.post('/echo', fruit: %w[apples oranges])
|
31
|
+
expect(response.headers['Content-Type']).to eq('application/x-www-form-urlencoded')
|
32
|
+
expect(response.body).to eq('fruit%5B%5D=apples&fruit%5B%5D=oranges')
|
33
|
+
end
|
34
|
+
|
35
|
+
it 'works with with headers' do
|
36
|
+
response = conn.post('/echo', { 'a' => 123 }, 'content-type' => 'application/x-www-form-urlencoded')
|
37
|
+
expect(response.headers['Content-Type']).to eq('application/x-www-form-urlencoded')
|
38
|
+
expect(response.body).to eq('a=123')
|
39
|
+
end
|
40
|
+
|
41
|
+
it 'works with nested params' do
|
42
|
+
response = conn.post('/echo', user: { name: 'Mislav', web: 'mislav.net' })
|
43
|
+
expect(response.headers['Content-Type']).to eq('application/x-www-form-urlencoded')
|
44
|
+
expected = { 'user' => { 'name' => 'Mislav', 'web' => 'mislav.net' } }
|
45
|
+
expect(Faraday::Utils.parse_nested_query(response.body)).to eq(expected)
|
46
|
+
end
|
47
|
+
|
48
|
+
it 'works with non nested params' do
|
49
|
+
response = conn.post('/echo', dimensions: %w[date location]) do |req|
|
50
|
+
req.options.params_encoder = Faraday::FlatParamsEncoder
|
51
|
+
end
|
52
|
+
expect(response.headers['Content-Type']).to eq('application/x-www-form-urlencoded')
|
53
|
+
expected = { 'dimensions' => %w[date location] }
|
54
|
+
expect(Faraday::Utils.parse_query(response.body)).to eq(expected)
|
55
|
+
expect(response.body).to eq('dimensions=date&dimensions=location')
|
56
|
+
end
|
57
|
+
|
58
|
+
it 'works with unicode' do
|
59
|
+
err = capture_warnings do
|
60
|
+
response = conn.post('/echo', str: 'eé cç aã aâ')
|
61
|
+
expect(response.body).to eq('str=e%C3%A9+c%C3%A7+a%C3%A3+a%C3%A2')
|
62
|
+
end
|
63
|
+
expect(err.empty?).to be_truthy
|
64
|
+
end
|
65
|
+
|
66
|
+
it 'works with nested keys' do
|
67
|
+
response = conn.post('/echo', 'a' => { 'b' => { 'c' => ['d'] } })
|
68
|
+
expect(response.body).to eq('a%5Bb%5D%5Bc%5D%5B%5D=d')
|
69
|
+
end
|
70
|
+
|
71
|
+
context 'customising default_space_encoding' do
|
72
|
+
around do |example|
|
73
|
+
Faraday::Utils.default_space_encoding = '%20'
|
74
|
+
example.run
|
75
|
+
Faraday::Utils.default_space_encoding = nil
|
76
|
+
end
|
77
|
+
|
78
|
+
it 'uses the custom character to encode spaces' do
|
79
|
+
response = conn.post('/echo', str: 'apple banana')
|
80
|
+
expect(response.body).to eq('str=apple%20banana')
|
81
|
+
end
|
82
|
+
end
|
83
|
+
end
|