faraday 0.17.3 → 2.7.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (124) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +350 -8
  3. data/LICENSE.md +1 -1
  4. data/README.md +27 -367
  5. data/Rakefile +1 -7
  6. data/examples/client_spec.rb +119 -0
  7. data/examples/client_test.rb +144 -0
  8. data/lib/faraday/adapter/test.rb +170 -72
  9. data/lib/faraday/adapter.rb +69 -23
  10. data/lib/faraday/adapter_registry.rb +30 -0
  11. data/lib/faraday/connection.rb +309 -233
  12. data/lib/faraday/encoders/flat_params_encoder.rb +105 -0
  13. data/lib/faraday/encoders/nested_params_encoder.rb +183 -0
  14. data/lib/faraday/error.rb +31 -42
  15. data/lib/faraday/logging/formatter.rb +122 -0
  16. data/lib/faraday/methods.rb +6 -0
  17. data/lib/faraday/middleware.rb +21 -25
  18. data/lib/faraday/middleware_registry.rb +83 -0
  19. data/lib/faraday/options/connection_options.rb +22 -0
  20. data/lib/faraday/options/env.rb +205 -0
  21. data/lib/faraday/options/proxy_options.rb +32 -0
  22. data/lib/faraday/options/request_options.rb +22 -0
  23. data/lib/faraday/options/ssl_options.rb +69 -0
  24. data/lib/faraday/options.rb +38 -193
  25. data/lib/faraday/parameters.rb +4 -197
  26. data/lib/faraday/rack_builder.rb +91 -76
  27. data/lib/faraday/request/authorization.rb +42 -29
  28. data/lib/faraday/request/instrumentation.rb +47 -27
  29. data/lib/faraday/request/json.rb +55 -0
  30. data/lib/faraday/request/url_encoded.rb +48 -24
  31. data/lib/faraday/request.rb +64 -42
  32. data/lib/faraday/response/json.rb +54 -0
  33. data/lib/faraday/response/logger.rb +24 -67
  34. data/lib/faraday/response/raise_error.rb +57 -18
  35. data/lib/faraday/response.rb +26 -32
  36. data/lib/faraday/utils/headers.rb +144 -0
  37. data/lib/faraday/utils/params_hash.rb +61 -0
  38. data/lib/faraday/utils.rb +47 -251
  39. data/lib/faraday/version.rb +5 -0
  40. data/lib/faraday.rb +108 -198
  41. data/spec/external_adapters/faraday_specs_setup.rb +14 -0
  42. data/spec/faraday/adapter/test_spec.rb +442 -0
  43. data/spec/faraday/adapter_registry_spec.rb +28 -0
  44. data/spec/faraday/adapter_spec.rb +55 -0
  45. data/spec/faraday/connection_spec.rb +808 -0
  46. data/spec/faraday/error_spec.rb +12 -54
  47. data/spec/faraday/middleware_registry_spec.rb +31 -0
  48. data/spec/faraday/middleware_spec.rb +70 -0
  49. data/spec/faraday/options/env_spec.rb +76 -0
  50. data/spec/faraday/options/options_spec.rb +297 -0
  51. data/spec/faraday/options/proxy_options_spec.rb +44 -0
  52. data/spec/faraday/options/request_options_spec.rb +19 -0
  53. data/spec/faraday/params_encoders/flat_spec.rb +42 -0
  54. data/spec/faraday/params_encoders/nested_spec.rb +150 -0
  55. data/spec/faraday/rack_builder_spec.rb +317 -0
  56. data/spec/faraday/request/authorization_spec.rb +118 -0
  57. data/spec/faraday/request/instrumentation_spec.rb +74 -0
  58. data/spec/faraday/request/json_spec.rb +111 -0
  59. data/spec/faraday/request/url_encoded_spec.rb +93 -0
  60. data/spec/faraday/request_spec.rb +110 -0
  61. data/spec/faraday/response/json_spec.rb +117 -0
  62. data/spec/faraday/response/logger_spec.rb +248 -0
  63. data/spec/faraday/response/raise_error_spec.rb +81 -15
  64. data/spec/faraday/response_spec.rb +77 -0
  65. data/spec/faraday/utils/headers_spec.rb +100 -0
  66. data/spec/faraday/utils_spec.rb +118 -0
  67. data/spec/faraday_spec.rb +37 -0
  68. data/spec/spec_helper.rb +63 -36
  69. data/spec/support/disabling_stub.rb +14 -0
  70. data/spec/support/fake_safe_buffer.rb +15 -0
  71. data/spec/support/helper_methods.rb +96 -0
  72. data/spec/support/shared_examples/adapter.rb +105 -0
  73. data/spec/support/shared_examples/params_encoder.rb +18 -0
  74. data/spec/support/shared_examples/request_method.rb +263 -0
  75. data/spec/support/streaming_response_checker.rb +35 -0
  76. metadata +76 -59
  77. data/lib/faraday/adapter/em_http.rb +0 -243
  78. data/lib/faraday/adapter/em_http_ssl_patch.rb +0 -56
  79. data/lib/faraday/adapter/em_synchrony/parallel_manager.rb +0 -66
  80. data/lib/faraday/adapter/em_synchrony.rb +0 -106
  81. data/lib/faraday/adapter/excon.rb +0 -82
  82. data/lib/faraday/adapter/httpclient.rb +0 -128
  83. data/lib/faraday/adapter/net_http.rb +0 -152
  84. data/lib/faraday/adapter/net_http_persistent.rb +0 -68
  85. data/lib/faraday/adapter/patron.rb +0 -95
  86. data/lib/faraday/adapter/rack.rb +0 -58
  87. data/lib/faraday/adapter/typhoeus.rb +0 -12
  88. data/lib/faraday/autoload.rb +0 -84
  89. data/lib/faraday/deprecate.rb +0 -107
  90. data/lib/faraday/request/basic_authentication.rb +0 -13
  91. data/lib/faraday/request/multipart.rb +0 -68
  92. data/lib/faraday/request/retry.rb +0 -213
  93. data/lib/faraday/request/token_authentication.rb +0 -15
  94. data/lib/faraday/upload_io.rb +0 -67
  95. data/spec/faraday/deprecate_spec.rb +0 -69
  96. data/test/adapters/default_test.rb +0 -14
  97. data/test/adapters/em_http_test.rb +0 -30
  98. data/test/adapters/em_synchrony_test.rb +0 -32
  99. data/test/adapters/excon_test.rb +0 -30
  100. data/test/adapters/httpclient_test.rb +0 -34
  101. data/test/adapters/integration.rb +0 -263
  102. data/test/adapters/logger_test.rb +0 -136
  103. data/test/adapters/net_http_persistent_test.rb +0 -114
  104. data/test/adapters/net_http_test.rb +0 -79
  105. data/test/adapters/patron_test.rb +0 -40
  106. data/test/adapters/rack_test.rb +0 -38
  107. data/test/adapters/test_middleware_test.rb +0 -157
  108. data/test/adapters/typhoeus_test.rb +0 -38
  109. data/test/authentication_middleware_test.rb +0 -65
  110. data/test/composite_read_io_test.rb +0 -109
  111. data/test/connection_test.rb +0 -738
  112. data/test/env_test.rb +0 -268
  113. data/test/helper.rb +0 -75
  114. data/test/live_server.rb +0 -67
  115. data/test/middleware/instrumentation_test.rb +0 -88
  116. data/test/middleware/retry_test.rb +0 -282
  117. data/test/middleware_stack_test.rb +0 -260
  118. data/test/multibyte.txt +0 -1
  119. data/test/options_test.rb +0 -333
  120. data/test/parameters_test.rb +0 -157
  121. data/test/request_middleware_test.rb +0 -126
  122. data/test/response_middleware_test.rb +0 -72
  123. data/test/strawberry.rb +0 -2
  124. data/test/utils_test.rb +0 -98
@@ -24,27 +24,36 @@ RSpec.describe Faraday::Response::RaiseError do
24
24
  expect { conn.get('ok') }.not_to raise_error
25
25
  end
26
26
 
27
- it 'raises Faraday::ClientError for 400 responses' do
28
- expect { conn.get('bad-request') }.to raise_error(Faraday::ClientError) do |ex|
27
+ it 'raises Faraday::BadRequestError for 400 responses' do
28
+ expect { conn.get('bad-request') }.to raise_error(Faraday::BadRequestError) do |ex|
29
29
  expect(ex.message).to eq('the server responded with status 400')
30
30
  expect(ex.response[:headers]['X-Reason']).to eq('because')
31
31
  expect(ex.response[:status]).to eq(400)
32
+ expect(ex.response_status).to eq(400)
33
+ expect(ex.response_body).to eq('keep looking')
34
+ expect(ex.response_headers['X-Reason']).to eq('because')
32
35
  end
33
36
  end
34
37
 
35
- it 'raises Faraday::ClientError for 401 responses' do
36
- expect { conn.get('unauthorized') }.to raise_error(Faraday::ClientError) do |ex|
38
+ it 'raises Faraday::UnauthorizedError for 401 responses' do
39
+ expect { conn.get('unauthorized') }.to raise_error(Faraday::UnauthorizedError) do |ex|
37
40
  expect(ex.message).to eq('the server responded with status 401')
38
41
  expect(ex.response[:headers]['X-Reason']).to eq('because')
39
42
  expect(ex.response[:status]).to eq(401)
43
+ expect(ex.response_status).to eq(401)
44
+ expect(ex.response_body).to eq('keep looking')
45
+ expect(ex.response_headers['X-Reason']).to eq('because')
40
46
  end
41
47
  end
42
48
 
43
- it 'raises Faraday::ClientError for 403 responses' do
44
- expect { conn.get('forbidden') }.to raise_error(Faraday::ClientError) do |ex|
49
+ it 'raises Faraday::ForbiddenError for 403 responses' do
50
+ expect { conn.get('forbidden') }.to raise_error(Faraday::ForbiddenError) do |ex|
45
51
  expect(ex.message).to eq('the server responded with status 403')
46
52
  expect(ex.response[:headers]['X-Reason']).to eq('because')
47
53
  expect(ex.response[:status]).to eq(403)
54
+ expect(ex.response_status).to eq(403)
55
+ expect(ex.response_body).to eq('keep looking')
56
+ expect(ex.response_headers['X-Reason']).to eq('because')
48
57
  end
49
58
  end
50
59
 
@@ -53,30 +62,42 @@ RSpec.describe Faraday::Response::RaiseError do
53
62
  expect(ex.message).to eq('the server responded with status 404')
54
63
  expect(ex.response[:headers]['X-Reason']).to eq('because')
55
64
  expect(ex.response[:status]).to eq(404)
65
+ expect(ex.response_status).to eq(404)
66
+ expect(ex.response_body).to eq('keep looking')
67
+ expect(ex.response_headers['X-Reason']).to eq('because')
56
68
  end
57
69
  end
58
70
 
59
- it 'raises Faraday::ConnectionFailed for 407 responses' do
60
- expect { conn.get('proxy-error') }.to raise_error(Faraday::ConnectionFailed) do |ex|
61
- expect(ex.message).to eq('407 "Proxy Authentication Required "')
71
+ it 'raises Faraday::ProxyAuthError for 407 responses' do
72
+ expect { conn.get('proxy-error') }.to raise_error(Faraday::ProxyAuthError) do |ex|
73
+ expect(ex.message).to eq('407 "Proxy Authentication Required"')
62
74
  expect(ex.response[:headers]['X-Reason']).to eq('because')
63
75
  expect(ex.response[:status]).to eq(407)
76
+ expect(ex.response_status).to eq(407)
77
+ expect(ex.response_body).to eq('keep looking')
78
+ expect(ex.response_headers['X-Reason']).to eq('because')
64
79
  end
65
80
  end
66
81
 
67
- it 'raises Faraday::ClientError for 409 responses' do
68
- expect { conn.get('conflict') }.to raise_error(Faraday::ClientError) do |ex|
82
+ it 'raises Faraday::ConflictError for 409 responses' do
83
+ expect { conn.get('conflict') }.to raise_error(Faraday::ConflictError) do |ex|
69
84
  expect(ex.message).to eq('the server responded with status 409')
70
85
  expect(ex.response[:headers]['X-Reason']).to eq('because')
71
86
  expect(ex.response[:status]).to eq(409)
87
+ expect(ex.response_status).to eq(409)
88
+ expect(ex.response_body).to eq('keep looking')
89
+ expect(ex.response_headers['X-Reason']).to eq('because')
72
90
  end
73
91
  end
74
92
 
75
- it 'raises Faraday::ClientError for 422 responses' do
76
- expect { conn.get('unprocessable-entity') }.to raise_error(Faraday::ClientError) do |ex|
93
+ it 'raises Faraday::UnprocessableEntityError for 422 responses' do
94
+ expect { conn.get('unprocessable-entity') }.to raise_error(Faraday::UnprocessableEntityError) do |ex|
77
95
  expect(ex.message).to eq('the server responded with status 422')
78
96
  expect(ex.response[:headers]['X-Reason']).to eq('because')
79
97
  expect(ex.response[:status]).to eq(422)
98
+ expect(ex.response_status).to eq(422)
99
+ expect(ex.response_body).to eq('keep looking')
100
+ expect(ex.response_headers['X-Reason']).to eq('because')
80
101
  end
81
102
  end
82
103
 
@@ -85,6 +106,9 @@ RSpec.describe Faraday::Response::RaiseError do
85
106
  expect(ex.message).to eq('http status could not be derived from the server response')
86
107
  expect(ex.response[:headers]['X-Reason']).to eq('nil')
87
108
  expect(ex.response[:status]).to be_nil
109
+ expect(ex.response_status).to be_nil
110
+ expect(ex.response_body).to eq('fail')
111
+ expect(ex.response_headers['X-Reason']).to eq('nil')
88
112
  end
89
113
  end
90
114
 
@@ -93,14 +117,56 @@ RSpec.describe Faraday::Response::RaiseError do
93
117
  expect(ex.message).to eq('the server responded with status 499')
94
118
  expect(ex.response[:headers]['X-Reason']).to eq('because')
95
119
  expect(ex.response[:status]).to eq(499)
120
+ expect(ex.response_status).to eq(499)
121
+ expect(ex.response_body).to eq('keep looking')
122
+ expect(ex.response_headers['X-Reason']).to eq('because')
96
123
  end
97
124
  end
98
125
 
99
- it 'raises Faraday::ClientError for 500 responses' do
100
- expect { conn.get('server-error') }.to raise_error(Faraday::ClientError) do |ex|
126
+ it 'raises Faraday::ServerError for 500 responses' do
127
+ expect { conn.get('server-error') }.to raise_error(Faraday::ServerError) do |ex|
101
128
  expect(ex.message).to eq('the server responded with status 500')
102
129
  expect(ex.response[:headers]['X-Error']).to eq('bailout')
103
130
  expect(ex.response[:status]).to eq(500)
131
+ expect(ex.response_status).to eq(500)
132
+ expect(ex.response_body).to eq('fail')
133
+ expect(ex.response_headers['X-Error']).to eq('bailout')
134
+ end
135
+ end
136
+
137
+ describe 'request info' do
138
+ let(:conn) do
139
+ Faraday.new do |b|
140
+ b.response :raise_error
141
+ b.adapter :test do |stub|
142
+ stub.post(url, request_body, request_headers) do
143
+ [400, { 'X-Reason' => 'because' }, 'keep looking']
144
+ end
145
+ end
146
+ end
147
+ end
148
+ let(:request_body) { JSON.generate({ 'item' => 'sth' }) }
149
+ let(:request_headers) { { 'Authorization' => 'Basic 123' } }
150
+ let(:url_path) { 'request' }
151
+ let(:query_params) { 'full=true' }
152
+ let(:url) { "#{url_path}?#{query_params}" }
153
+
154
+ subject(:perform_request) do
155
+ conn.post url do |req|
156
+ req.headers['Authorization'] = 'Basic 123'
157
+ req.body = request_body
158
+ end
159
+ end
160
+
161
+ it 'returns the request info in the exception' do
162
+ expect { perform_request }.to raise_error(Faraday::BadRequestError) do |ex|
163
+ expect(ex.response[:request][:method]).to eq(:post)
164
+ expect(ex.response[:request][:url]).to eq(URI("http:/#{url}"))
165
+ expect(ex.response[:request][:url_path]).to eq("/#{url_path}")
166
+ expect(ex.response[:request][:params]).to eq({ 'full' => 'true' })
167
+ expect(ex.response[:request][:headers]).to match(a_hash_including(request_headers))
168
+ expect(ex.response[:request][:body]).to eq(request_body)
169
+ end
104
170
  end
105
171
  end
106
172
  end
@@ -0,0 +1,77 @@
1
+ # frozen_string_literal: true
2
+
3
+ RSpec.describe Faraday::Response do
4
+ subject { Faraday::Response.new(env) }
5
+
6
+ let(:env) do
7
+ Faraday::Env.from(status: 404, body: 'yikes', url: Faraday::Utils.URI('https://lostisland.github.io/faraday'),
8
+ response_headers: { 'Content-Type' => 'text/plain' })
9
+ end
10
+
11
+ it { expect(subject.finished?).to be_truthy }
12
+ it { expect { subject.finish({}) }.to raise_error(RuntimeError) }
13
+ it { expect(subject.success?).to be_falsey }
14
+ it { expect(subject.status).to eq(404) }
15
+ it { expect(subject.body).to eq('yikes') }
16
+ it { expect(subject.headers['Content-Type']).to eq('text/plain') }
17
+ it { expect(subject['content-type']).to eq('text/plain') }
18
+
19
+ describe '#apply_request' do
20
+ before { subject.apply_request(body: 'a=b', method: :post) }
21
+
22
+ it { expect(subject.body).to eq('yikes') }
23
+ it { expect(subject.env[:method]).to eq(:post) }
24
+ end
25
+
26
+ describe '#to_hash' do
27
+ let(:hash) { subject.to_hash }
28
+
29
+ it { expect(hash).to be_a(Hash) }
30
+ it { expect(hash[:status]).to eq(subject.status) }
31
+ it { expect(hash[:response_headers]).to eq(subject.headers) }
32
+ it { expect(hash[:body]).to eq(subject.body) }
33
+ it { expect(hash[:url]).to eq(subject.env.url) }
34
+ end
35
+
36
+ describe 'marshal serialization support' do
37
+ subject { Faraday::Response.new }
38
+ let(:loaded) { Marshal.load(Marshal.dump(subject)) }
39
+
40
+ before do
41
+ subject.on_complete {}
42
+ subject.finish(env.merge(params: 'moo'))
43
+ end
44
+
45
+ it { expect(loaded.env[:params]).to be_nil }
46
+ it { expect(loaded.env[:body]).to eq(env[:body]) }
47
+ it { expect(loaded.env[:response_headers]).to eq(env[:response_headers]) }
48
+ it { expect(loaded.env[:status]).to eq(env[:status]) }
49
+ it { expect(loaded.env[:url]).to eq(env[:url]) }
50
+ end
51
+
52
+ describe '#on_complete' do
53
+ subject { Faraday::Response.new }
54
+
55
+ it 'parse body on finish' do
56
+ subject.on_complete { |env| env[:body] = env[:body].upcase }
57
+ subject.finish(env)
58
+
59
+ expect(subject.body).to eq('YIKES')
60
+ end
61
+
62
+ it 'can access response body in on_complete callback' do
63
+ subject.on_complete { |env| env[:body] = subject.body.upcase }
64
+ subject.finish(env)
65
+
66
+ expect(subject.body).to eq('YIKES')
67
+ end
68
+
69
+ it 'can access response body in on_complete callback' do
70
+ callback_env = nil
71
+ subject.on_complete { |env| callback_env = env }
72
+ subject.finish({})
73
+
74
+ expect(subject.env).to eq(callback_env)
75
+ end
76
+ end
77
+ end
@@ -0,0 +1,100 @@
1
+ # frozen_string_literal: true
2
+
3
+ RSpec.describe Faraday::Utils::Headers do
4
+ subject { Faraday::Utils::Headers.new }
5
+
6
+ context 'when Content-Type is set to application/json' do
7
+ before { subject['Content-Type'] = 'application/json' }
8
+
9
+ it { expect(subject.keys).to eq(['Content-Type']) }
10
+ it { expect(subject['Content-Type']).to eq('application/json') }
11
+ it { expect(subject['CONTENT-TYPE']).to eq('application/json') }
12
+ it { expect(subject['content-type']).to eq('application/json') }
13
+ it { is_expected.to include('content-type') }
14
+ end
15
+
16
+ context 'when Content-Type is set to application/xml' do
17
+ before { subject['Content-Type'] = 'application/xml' }
18
+
19
+ it { expect(subject.keys).to eq(['Content-Type']) }
20
+ it { expect(subject['Content-Type']).to eq('application/xml') }
21
+ it { expect(subject['CONTENT-TYPE']).to eq('application/xml') }
22
+ it { expect(subject['content-type']).to eq('application/xml') }
23
+ it { is_expected.to include('content-type') }
24
+ end
25
+
26
+ describe '#fetch' do
27
+ before { subject['Content-Type'] = 'application/json' }
28
+
29
+ it { expect(subject.fetch('Content-Type')).to eq('application/json') }
30
+ it { expect(subject.fetch('CONTENT-TYPE')).to eq('application/json') }
31
+ it { expect(subject.fetch(:content_type)).to eq('application/json') }
32
+ it { expect(subject.fetch('invalid', 'default')).to eq('default') }
33
+ it { expect(subject.fetch('invalid', false)).to eq(false) }
34
+ it { expect(subject.fetch('invalid', nil)).to be_nil }
35
+ it { expect(subject.fetch('Invalid') { |key| "#{key} key" }).to eq('Invalid key') }
36
+ it 'calls a block when provided' do
37
+ block_called = false
38
+ expect(subject.fetch('content-type') { block_called = true }).to eq('application/json')
39
+ expect(block_called).to be_falsey
40
+ end
41
+ it 'raises an error if key not found' do
42
+ expected_error = defined?(KeyError) ? KeyError : IndexError
43
+ expect { subject.fetch('invalid') }.to raise_error(expected_error)
44
+ end
45
+ end
46
+
47
+ describe '#delete' do
48
+ before do
49
+ subject['Content-Type'] = 'application/json'
50
+ @deleted = subject.delete('content-type')
51
+ end
52
+
53
+ it { expect(@deleted).to eq('application/json') }
54
+ it { expect(subject.size).to eq(0) }
55
+ it { is_expected.not_to include('content-type') }
56
+ it { expect(subject.delete('content-type')).to be_nil }
57
+ end
58
+
59
+ describe '#parse' do
60
+ context 'when response headers leave http status line out' do
61
+ let(:headers) { "HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n" }
62
+
63
+ before { subject.parse(headers) }
64
+
65
+ it { expect(subject.keys).to eq(%w[Content-Type]) }
66
+ it { expect(subject['Content-Type']).to eq('text/html') }
67
+ it { expect(subject['content-type']).to eq('text/html') }
68
+ end
69
+
70
+ 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://httpbingo.org/\r\n\r\n" }
72
+
73
+ before { subject.parse(headers) }
74
+
75
+ it { expect(subject['location']).to eq('http://httpbingo.org/') }
76
+ end
77
+
78
+ context 'when response headers include a blank line' do
79
+ let(:headers) { "HTTP/1.1 200 OK\r\n\r\nContent-Type: text/html\r\n\r\n" }
80
+
81
+ before { subject.parse(headers) }
82
+
83
+ it { expect(subject['content-type']).to eq('text/html') }
84
+ end
85
+
86
+ context 'when response headers include already stored keys' do
87
+ let(:headers) { "HTTP/1.1 200 OK\r\nX-Numbers: 123\r\n\r\n" }
88
+
89
+ before do
90
+ h = subject
91
+ h[:x_numbers] = 8
92
+ h.parse(headers)
93
+ end
94
+
95
+ it do
96
+ expect(subject[:x_numbers]).to eq('8, 123')
97
+ end
98
+ end
99
+ end
100
+ end
@@ -0,0 +1,118 @@
1
+ # frozen_string_literal: true
2
+
3
+ RSpec.describe Faraday::Utils do
4
+ describe 'headers parsing' do
5
+ let(:multi_response_headers) do
6
+ "HTTP/1.x 500 OK\r\nContent-Type: text/html; charset=UTF-8\r\n" \
7
+ "HTTP/1.x 200 OK\r\nContent-Type: application/json; charset=UTF-8\r\n\r\n"
8
+ end
9
+
10
+ it 'parse headers for aggregated responses' do
11
+ headers = Faraday::Utils::Headers.new
12
+ headers.parse(multi_response_headers)
13
+
14
+ result = headers.to_hash
15
+
16
+ expect(result['Content-Type']).to eq('application/json; charset=UTF-8')
17
+ end
18
+ end
19
+
20
+ describe 'URI parsing' do
21
+ let(:url) { 'http://example.com/abc' }
22
+
23
+ it 'escapes safe buffer' do
24
+ str = FakeSafeBuffer.new('$32,000.00')
25
+ expect(Faraday::Utils.escape(str)).to eq('%2432%2C000.00')
26
+ end
27
+
28
+ it 'parses with default parser' do
29
+ with_default_uri_parser(nil) do
30
+ uri = normalize(url)
31
+ expect(uri.host).to eq('example.com')
32
+ end
33
+ end
34
+
35
+ it 'parses with URI' do
36
+ with_default_uri_parser(::URI) do
37
+ uri = normalize(url)
38
+ expect(uri.host).to eq('example.com')
39
+ end
40
+ end
41
+
42
+ it 'parses with block' do
43
+ with_default_uri_parser(->(u) { "booya#{'!' * u.size}" }) do
44
+ expect(normalize(url)).to eq('booya!!!!!!!!!!!!!!!!!!!!!!')
45
+ end
46
+ end
47
+
48
+ it 'replaces headers hash' do
49
+ headers = Faraday::Utils::Headers.new('authorization' => 't0ps3cr3t!')
50
+ expect(headers).to have_key('authorization')
51
+
52
+ headers.replace('content-type' => 'text/plain')
53
+ expect(headers).not_to have_key('authorization')
54
+ end
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
+ }
108
+ end
109
+
110
+ it 'does not overwrite an Options Struct value' do
111
+ deep_merge = Faraday::Utils.deep_merge!(connection_options, url)
112
+
113
+ expect(deep_merge.request.to_h).to eq(request)
114
+ expect(deep_merge.ssl.to_h).to eq(ssl)
115
+ end
116
+ end
117
+ end
118
+ end
@@ -0,0 +1,37 @@
1
+ # frozen_string_literal: true
2
+
3
+ RSpec.describe Faraday do
4
+ it 'has a version number' do
5
+ expect(Faraday::VERSION).not_to be nil
6
+ end
7
+
8
+ context 'proxies to default_connection' do
9
+ let(:mock_connection) { double('Connection') }
10
+ before do
11
+ Faraday.default_connection = mock_connection
12
+ end
13
+
14
+ it 'proxies methods that exist on the default_connection' do
15
+ expect(mock_connection).to receive(:this_should_be_proxied)
16
+
17
+ Faraday.this_should_be_proxied
18
+ end
19
+
20
+ it 'uses method_missing on Faraday if there is no proxyable method' do
21
+ expect { Faraday.this_method_does_not_exist }.to raise_error(
22
+ NoMethodError,
23
+ "undefined method `this_method_does_not_exist' for Faraday:Module"
24
+ )
25
+ end
26
+
27
+ it 'proxied methods can be accessed' do
28
+ allow(mock_connection).to receive(:this_should_be_proxied)
29
+
30
+ expect(Faraday.method(:this_should_be_proxied)).to be_a(Method)
31
+ end
32
+
33
+ after do
34
+ Faraday.default_connection = nil
35
+ end
36
+ end
37
+ end
data/spec/spec_helper.rb CHANGED
@@ -1,8 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'faraday'
4
- Faraday::Deprecate.skip = false
5
-
6
3
  # This file was generated by the `rspec --init` command. Conventionally, all
7
4
  # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
8
5
  # The generated `.rspec` file contains `--require spec_helper` which will cause
@@ -18,6 +15,29 @@ Faraday::Deprecate.skip = false
18
15
  # it.
19
16
  #
20
17
  # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
18
+
19
+ require 'simplecov'
20
+ require 'coveralls'
21
+ require 'webmock/rspec'
22
+ WebMock.disable_net_connect!(allow_localhost: true)
23
+
24
+ SimpleCov.formatters = [SimpleCov::Formatter::HTMLFormatter, Coveralls::SimpleCov::Formatter]
25
+
26
+ SimpleCov.start do
27
+ add_filter '/spec/'
28
+ minimum_coverage 84
29
+ minimum_coverage_by_file 26
30
+ end
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
+ require 'faraday'
37
+ require 'pry'
38
+
39
+ Dir['./spec/support/**/*.rb'].sort.each { |f| require f }
40
+
21
41
  RSpec.configure do |config|
22
42
  # rspec-expectations config goes here. You can use an alternate
23
43
  # assertion/expectation library such as wrong or the stdlib/minitest
@@ -49,57 +69,64 @@ RSpec.configure do |config|
49
69
  # triggering implicit auto-inclusion in groups with matching metadata.
50
70
  config.shared_context_metadata_behavior = :apply_to_host_groups
51
71
 
52
- # Run specs in random order to surface order dependencies. If you find an
53
- # order dependency and want to debug it, you can fix the order by providing
54
- # the seed, which is printed after each run.
55
- # --seed 1234
56
- config.order = :random
57
-
58
- # Seed global randomization in this process using the `--seed` CLI option.
59
- # Setting this allows you to use `--seed` to deterministically reproduce
60
- # test failures related to randomization by passing the same `--seed` value
61
- # as the one that triggered the failure.
62
- Kernel.srand config.seed
63
-
64
- # Limits the available syntax to the non-monkey patched syntax that is
65
- # recommended. For more details, see:
66
- # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
67
- # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
68
- # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
69
- config.disable_monkey_patching!
70
-
71
- # The settings below are suggested to provide a good initial experience
72
- # with RSpec, but feel free to customize to your heart's content.
73
- =begin
74
72
  # This allows you to limit a spec run to individual examples or groups
75
73
  # you care about by tagging them with `:focus` metadata. When nothing
76
74
  # is tagged with `:focus`, all examples get run. RSpec also provides
77
75
  # aliases for `it`, `describe`, and `context` that include `:focus`
78
76
  # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
79
- config.filter_run_when_matching :focus
77
+ # config.filter_run_when_matching :focus
80
78
 
81
79
  # Allows RSpec to persist some state between runs in order to support
82
80
  # the `--only-failures` and `--next-failure` CLI options. We recommend
83
81
  # you configure your source control system to ignore this file.
84
- config.example_status_persistence_file_path = "spec/examples.txt"
82
+ # config.example_status_persistence_file_path = "spec/examples.txt"
83
+
84
+ # Limits the available syntax to the non-monkey patched syntax that is
85
+ # recommended. For more details, see:
86
+ # - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
87
+ # - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
88
+ # - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
89
+ # config.disable_monkey_patching!
85
90
 
86
91
  # This setting enables warnings. It's recommended, but in some cases may
87
92
  # be too noisy due to issues in dependencies.
88
- config.warnings = true
93
+ # config.warnings = true
89
94
 
90
95
  # Many RSpec users commonly either run the entire suite or an individual
91
96
  # file, and it's useful to allow more verbose output when running an
92
97
  # individual spec file.
93
- if config.files_to_run.one?
94
- # Use the documentation formatter for detailed output,
95
- # unless a formatter has already been configured
96
- # (e.g. via a command-line flag).
97
- config.default_formatter = "doc"
98
- end
98
+ # if config.files_to_run.one?
99
+ # # Use the documentation formatter for detailed output,
100
+ # # unless a formatter has already been configured
101
+ # # (e.g. via a command-line flag).
102
+ # config.default_formatter = "doc"
103
+ # end
99
104
 
100
105
  # Print the 10 slowest examples and example groups at the
101
106
  # end of the spec run, to help surface which specs are running
102
107
  # particularly slow.
103
- config.profile_examples = 10
104
- =end
108
+ # config.profile_examples = 10
109
+
110
+ # Run specs in random order to surface order dependencies. If you find an
111
+ # order dependency and want to debug it, you can fix the order by providing
112
+ # the seed, which is printed after each run.
113
+ # --seed 1234
114
+ config.order = :random
115
+
116
+ # Seed global randomization in this process using the `--seed` CLI option.
117
+ # Setting this allows you to use `--seed` to deterministically reproduce
118
+ # test failures related to randomization by passing the same `--seed` value
119
+ # as the one that triggered the failure.
120
+ Kernel.srand config.seed
121
+
122
+ config.include Faraday::HelperMethods
123
+ end
124
+
125
+ # Extends RSpec DocumentationFormatter to hide skipped tests.
126
+ module FormatterOverrides
127
+ def example_pending(_arg); end
128
+
129
+ def dump_pending(_arg); end
130
+
131
+ RSpec::Core::Formatters::DocumentationFormatter.prepend self
105
132
  end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Allows to disable WebMock stubs
4
+ module DisablingStub
5
+ def disable
6
+ @disabled = true
7
+ end
8
+
9
+ def disabled?
10
+ @disabled
11
+ end
12
+
13
+ WebMock::RequestStub.prepend self
14
+ end
@@ -0,0 +1,15 @@
1
+ # frozen_string_literal: true
2
+
3
+ # emulates ActiveSupport::SafeBuffer#gsub
4
+ FakeSafeBuffer = Struct.new(:string) do
5
+ def to_s
6
+ self
7
+ end
8
+
9
+ def gsub(regex)
10
+ string.gsub(regex) do
11
+ match, = Regexp.last_match(0), '' =~ /a/ # rubocop:disable Performance/StringInclude
12
+ yield(match)
13
+ end
14
+ end
15
+ end