faraday 1.10.4 → 2.13.1

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.
Files changed (82) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +198 -4
  3. data/LICENSE.md +1 -1
  4. data/README.md +34 -20
  5. data/Rakefile +6 -1
  6. data/examples/client_spec.rb +41 -19
  7. data/examples/client_test.rb +48 -22
  8. data/lib/faraday/adapter/test.rb +62 -13
  9. data/lib/faraday/adapter.rb +6 -10
  10. data/lib/faraday/connection.rb +72 -150
  11. data/lib/faraday/encoders/nested_params_encoder.rb +14 -7
  12. data/lib/faraday/error.rb +24 -5
  13. data/lib/faraday/logging/formatter.rb +29 -16
  14. data/lib/faraday/middleware.rb +43 -2
  15. data/lib/faraday/middleware_registry.rb +17 -63
  16. data/lib/faraday/options/connection_options.rb +7 -6
  17. data/lib/faraday/options/env.rb +85 -62
  18. data/lib/faraday/options/proxy_options.rb +11 -5
  19. data/lib/faraday/options/request_options.rb +7 -6
  20. data/lib/faraday/options/ssl_options.rb +62 -45
  21. data/lib/faraday/options.rb +7 -6
  22. data/lib/faraday/rack_builder.rb +43 -40
  23. data/lib/faraday/request/authorization.rb +33 -41
  24. data/lib/faraday/request/instrumentation.rb +5 -1
  25. data/lib/faraday/request/json.rb +18 -3
  26. data/lib/faraday/request/url_encoded.rb +5 -1
  27. data/lib/faraday/request.rb +15 -30
  28. data/lib/faraday/response/json.rb +25 -5
  29. data/lib/faraday/response/logger.rb +11 -3
  30. data/lib/faraday/response/raise_error.rb +45 -18
  31. data/lib/faraday/response.rb +9 -21
  32. data/lib/faraday/utils/headers.rb +15 -4
  33. data/lib/faraday/utils.rb +11 -7
  34. data/lib/faraday/version.rb +1 -1
  35. data/lib/faraday.rb +8 -44
  36. data/spec/faraday/adapter/test_spec.rb +65 -0
  37. data/spec/faraday/connection_spec.rb +165 -93
  38. data/spec/faraday/error_spec.rb +39 -6
  39. data/spec/faraday/middleware_registry_spec.rb +31 -0
  40. data/spec/faraday/middleware_spec.rb +161 -0
  41. data/spec/faraday/options/env_spec.rb +8 -2
  42. data/spec/faraday/options/options_spec.rb +1 -1
  43. data/spec/faraday/options/proxy_options_spec.rb +35 -0
  44. data/spec/faraday/params_encoders/nested_spec.rb +10 -1
  45. data/spec/faraday/rack_builder_spec.rb +26 -54
  46. data/spec/faraday/request/authorization_spec.rb +50 -28
  47. data/spec/faraday/request/instrumentation_spec.rb +5 -7
  48. data/spec/faraday/request/json_spec.rb +88 -0
  49. data/spec/faraday/request/url_encoded_spec.rb +12 -2
  50. data/spec/faraday/request_spec.rb +5 -15
  51. data/spec/faraday/response/json_spec.rb +93 -6
  52. data/spec/faraday/response/logger_spec.rb +77 -4
  53. data/spec/faraday/response/raise_error_spec.rb +111 -5
  54. data/spec/faraday/response_spec.rb +3 -1
  55. data/spec/faraday/utils/headers_spec.rb +31 -4
  56. data/spec/faraday/utils_spec.rb +65 -1
  57. data/spec/faraday_spec.rb +10 -4
  58. data/spec/spec_helper.rb +5 -6
  59. data/spec/support/fake_safe_buffer.rb +1 -1
  60. data/spec/support/faraday_middleware_subclasses.rb +18 -0
  61. data/spec/support/helper_methods.rb +0 -37
  62. data/spec/support/shared_examples/adapter.rb +2 -2
  63. data/spec/support/shared_examples/request_method.rb +22 -21
  64. metadata +24 -149
  65. data/lib/faraday/adapter/typhoeus.rb +0 -15
  66. data/lib/faraday/autoload.rb +0 -89
  67. data/lib/faraday/dependency_loader.rb +0 -39
  68. data/lib/faraday/deprecate.rb +0 -110
  69. data/lib/faraday/request/basic_authentication.rb +0 -20
  70. data/lib/faraday/request/token_authentication.rb +0 -20
  71. data/spec/faraday/adapter/em_http_spec.rb +0 -49
  72. data/spec/faraday/adapter/em_synchrony_spec.rb +0 -18
  73. data/spec/faraday/adapter/excon_spec.rb +0 -49
  74. data/spec/faraday/adapter/httpclient_spec.rb +0 -73
  75. data/spec/faraday/adapter/net_http_spec.rb +0 -64
  76. data/spec/faraday/adapter/patron_spec.rb +0 -18
  77. data/spec/faraday/adapter/rack_spec.rb +0 -8
  78. data/spec/faraday/adapter/typhoeus_spec.rb +0 -7
  79. data/spec/faraday/composite_read_io_spec.rb +0 -80
  80. data/spec/faraday/deprecate_spec.rb +0 -147
  81. data/spec/faraday/response/middleware_spec.rb +0 -68
  82. data/spec/support/webmock_rack_app.rb +0 -68
@@ -1,147 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- RSpec.describe Faraday::DeprecatedClass do
4
- class SampleClass < StandardError
5
- attr_accessor :foo
6
-
7
- def initialize(foo = nil)
8
- @foo = foo || :foo
9
- end
10
- end
11
-
12
- SampleDeprecatedClass = Faraday::DeprecatedClass.proxy_class(SampleClass)
13
-
14
- it 'does not raise error for deprecated classes but prints an error message' do
15
- error_message, foobar = with_warn_squelching { SampleDeprecatedClass.new(:foo_bar) }
16
- expect(foobar).to be_a(SampleClass)
17
- expect(foobar.foo).to eq(:foo_bar)
18
- expect(error_message).to match(
19
- Regexp.new(
20
- 'NOTE: SampleDeprecatedClass.new is deprecated; '\
21
- 'use SampleClass.new instead. It will be removed in or after version 1.0'
22
- )
23
- )
24
- end
25
-
26
- it 'does not raise an error for inherited error-namespaced classes but prints an error message' do
27
- error_message, = with_warn_squelching { Class.new(SampleDeprecatedClass) }
28
-
29
- expect(error_message).to match(
30
- Regexp.new(
31
- 'NOTE: Inheriting SampleDeprecatedClass is deprecated; '\
32
- 'use SampleClass instead. It will be removed in or after version 1.0'
33
- )
34
- )
35
- end
36
-
37
- it 'allows backward-compatible class to be subclassed' do
38
- expect do
39
- with_warn_squelching { Class.new(SampleDeprecatedClass) }
40
- end.not_to raise_error
41
- end
42
-
43
- it 'allows rescuing of a current error with a deprecated error' do
44
- expect { raise SampleClass, nil }.to raise_error(SampleDeprecatedClass)
45
- end
46
-
47
- it 'allows rescuing of a current error with a current error' do
48
- expect { raise SampleClass, nil }.to raise_error(SampleClass)
49
- end
50
-
51
- it 'allows rescuing of a deprecated error with a deprecated error' do
52
- expect { raise SampleDeprecatedClass, nil }.to raise_error(SampleDeprecatedClass)
53
- end
54
-
55
- it 'allows rescuing of a deprecated error with a current error' do
56
- expect { raise SampleDeprecatedClass, nil }.to raise_error(SampleClass)
57
- end
58
-
59
- describe 'match behavior' do
60
- class SampleDeprecatedClassA < SampleDeprecatedClass; end
61
- class SampleDeprecatedClassB < SampleDeprecatedClass; end
62
-
63
- class SampleDeprecatedClassAX < SampleDeprecatedClassA; end
64
-
65
- class SampleClassA < SampleClass; end
66
-
67
- describe 'undeprecated class' do
68
- it 'is === to instance of deprecated class' do
69
- expect(SampleDeprecatedClass.new.is_a?(SampleClass)).to be true
70
- end
71
-
72
- it 'is === to instance of subclass of deprecated class' do
73
- expect(SampleDeprecatedClassA.new.is_a?(SampleClass)).to be true
74
- end
75
-
76
- it 'is === to instance of subclass of subclass of deprecated class' do
77
- expect(SampleDeprecatedClassAX.new.is_a?(SampleClass)).to be true
78
- end
79
- end
80
-
81
- describe 'subclass of undeprecated class' do
82
- it 'is not === to instance of undeprecated class' do
83
- expect(SampleClass.new.is_a?(SampleClassA)).to be false
84
- end
85
-
86
- it 'is not === to instance of deprecated class' do
87
- expect(SampleDeprecatedClass.new.is_a?(SampleClassA)).to be false
88
- end
89
- end
90
-
91
- describe 'deprecated class' do
92
- it 'is === to instance of undeprecated class' do
93
- expect(SampleDeprecatedClass.new.is_a?(SampleClass)).to be true
94
- end
95
-
96
- it 'is === to instance of subclass of undeprecated class' do
97
- expect(SampleClassA.superclass == SampleDeprecatedClass.superclass).to be true
98
- end
99
-
100
- it 'is === to instance of subclass of deprecated class' do
101
- expect(SampleDeprecatedClassA.new.is_a?(SampleDeprecatedClass)).to be true
102
- end
103
-
104
- it 'is === to instance of subclass of subclass of deprecated class' do
105
- expect(SampleDeprecatedClassAX.new.is_a?(SampleDeprecatedClass)).to be true
106
- end
107
- end
108
-
109
- describe 'subclass of deprecated class' do
110
- it 'is not === to instance of subclass of undeprecated class' do
111
- expect(SampleClass.new.is_a?(SampleDeprecatedClassA)).to be false
112
- end
113
-
114
- it 'is not === to instance of another subclass of deprecated class' do
115
- expect(SampleDeprecatedClassB.new.is_a?(SampleDeprecatedClassA)).to be false
116
- end
117
-
118
- it 'is === to instance of its subclass' do
119
- expect(SampleDeprecatedClassAX.new.is_a?(SampleDeprecatedClassA)).to be true
120
- end
121
-
122
- it 'is === to instance of deprecated class' do
123
- expect(SampleDeprecatedClassB.new.is_a?(SampleDeprecatedClass)).to be true
124
- end
125
- end
126
-
127
- describe 'subclass of subclass of deprecated class' do
128
- it 'is not === to instance of subclass of another subclass of deprecated class' do
129
- expect(SampleDeprecatedClassB.new.is_a?(SampleDeprecatedClassAX)).to be false
130
- end
131
-
132
- it 'is not === to instance of its superclass' do
133
- expect(SampleDeprecatedClass.new.is_a?(SampleDeprecatedClassA)).to be false
134
- end
135
- end
136
- end
137
-
138
- def with_warn_squelching
139
- stderr_catcher = StringIO.new
140
- original_stderr = $stderr
141
- $stderr = stderr_catcher
142
- result = yield if block_given?
143
- [stderr_catcher.tap(&:rewind).string, result]
144
- ensure
145
- $stderr = original_stderr
146
- end
147
- end
@@ -1,68 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- RSpec.describe Faraday::Response::Middleware do
4
- let(:conn) do
5
- Faraday.new do |b|
6
- b.use custom_middleware
7
- b.adapter :test do |stub|
8
- stub.get('ok') { [200, { 'Content-Type' => 'text/html' }, '<body></body>'] }
9
- stub.get('not_modified') { [304, nil, nil] }
10
- stub.get('no_content') { [204, nil, nil] }
11
- end
12
- end
13
- end
14
-
15
- context 'with a custom ResponseMiddleware' do
16
- let(:custom_middleware) do
17
- Class.new(Faraday::Response::Middleware) do
18
- def parse(body)
19
- body.upcase
20
- end
21
- end
22
- end
23
-
24
- it 'parses the response' do
25
- expect(conn.get('ok').body).to eq('<BODY></BODY>')
26
- end
27
- end
28
-
29
- context 'with a custom ResponseMiddleware and private parse' do
30
- let(:custom_middleware) do
31
- Class.new(Faraday::Response::Middleware) do
32
- private
33
-
34
- def parse(body)
35
- body.upcase
36
- end
37
- end
38
- end
39
-
40
- it 'parses the response' do
41
- expect(conn.get('ok').body).to eq('<BODY></BODY>')
42
- end
43
- end
44
-
45
- context 'with a custom ResponseMiddleware but empty response' do
46
- let(:custom_middleware) do
47
- Class.new(Faraday::Response::Middleware) do
48
- def parse(_body)
49
- raise 'this should not be called'
50
- end
51
- end
52
- end
53
-
54
- it 'raises exception for 200 responses' do
55
- expect { conn.get('ok') }.to raise_error(StandardError)
56
- end
57
-
58
- it 'doesn\'t call the middleware for 204 responses' do
59
- expect_any_instance_of(custom_middleware).not_to receive(:parse)
60
- expect(conn.get('no_content').body).to be_nil
61
- end
62
-
63
- it 'doesn\'t call the middleware for 304 responses' do
64
- expect_any_instance_of(custom_middleware).not_to receive(:parse)
65
- expect(conn.get('not_modified').body).to be_nil
66
- end
67
- end
68
- end
@@ -1,68 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- # Rack app used to test the Rack adapter.
4
- # Uses Webmock to check if requests are registered, in which case it returns
5
- # the registered response.
6
- class WebmockRackApp
7
- def call(env)
8
- req_signature = WebMock::RequestSignature.new(
9
- req_method(env),
10
- req_uri(env),
11
- body: req_body(env),
12
- headers: req_headers(env)
13
- )
14
-
15
- WebMock::RequestRegistry
16
- .instance
17
- .requested_signatures
18
- .put(req_signature)
19
-
20
- process_response(req_signature)
21
- end
22
-
23
- def req_method(env)
24
- env['REQUEST_METHOD'].downcase.to_sym
25
- end
26
-
27
- def req_uri(env)
28
- scheme = env['rack.url_scheme']
29
- host = env['SERVER_NAME']
30
- port = env['SERVER_PORT']
31
- path = env['PATH_INFO']
32
- query = env['QUERY_STRING']
33
-
34
- url = +"#{scheme}://#{host}:#{port}#{path}"
35
- url += "?#{query}" if query
36
-
37
- uri = WebMock::Util::URI.heuristic_parse(url)
38
- uri.path = uri.normalized_path.gsub('[^:]//', '/')
39
- uri
40
- end
41
-
42
- def req_headers(env)
43
- http_headers = env.select { |k, _| k.start_with?('HTTP_') }
44
- .map { |k, v| [k[5..-1], v] }
45
- .to_h
46
-
47
- special_headers = Faraday::Adapter::Rack::SPECIAL_HEADERS
48
- http_headers.merge(env.select { |k, _| special_headers.include?(k) })
49
- end
50
-
51
- def req_body(env)
52
- env['rack.input'].read
53
- end
54
-
55
- def process_response(req_signature)
56
- res = WebMock::StubRegistry.instance.response_for_request(req_signature)
57
-
58
- if res.nil? && req_signature.uri.host == 'localhost'
59
- raise Faraday::ConnectionFailed, 'Trying to connect to localhost'
60
- end
61
-
62
- raise WebMock::NetConnectNotAllowedError, req_signature unless res
63
-
64
- raise Faraday::TimeoutError if res.should_timeout
65
-
66
- [res.status[0], res.headers || {}, [res.body || '']]
67
- end
68
- end