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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: f6441da03048f7371bd0cb898dd3e27c7be6382c67fc4901883e9dbe9841b56f
|
4
|
+
data.tar.gz: 0beb3f2da75282655fc46cd5540de96d5fef259dd35193ec9eb0d3163cc959d2
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 1ab1aa0e0c68c9348d9e180a903f01f2517bd38672fe1bdf056ceab4729e841944173e47dc26aa1b4fe16b2779f1a8102914ed594ea92d08feff6dc944412f0b
|
7
|
+
data.tar.gz: bc43fbac427062861e79d5328b60886a5b9c8783f707faa1fcfad064b9c6945f6a4e2a97dbad9ecadc1c1620b5327d651a764962764b7fc86e6d2fbd84ad0b4b
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,365 @@
|
|
1
1
|
# Faraday Changelog
|
2
2
|
|
3
|
+
## [v1.3.0](https://github.com/lostisland/faraday/releases/tag/v1.3.0) (2020-12-31)
|
4
|
+
|
5
|
+
### Highlights
|
6
|
+
Faraday v1.3.0 is the first release to officially support Ruby 3.0 in the CI pipeline 🎉 🍾!
|
7
|
+
|
8
|
+
This is also the first release with a previously "included" adapter (Net::HTTP) being isolated into a [separate gem](https://github.com/lostisland/faraday-net_http) 🎊!
|
9
|
+
The new adapter is added to Faraday as a dependency for now, so that means full backwards-compatibility, but just to be safe be careful when upgrading!
|
10
|
+
|
11
|
+
This is a huge step towards are Faraday v2.0 objective of pushing adapters and middleware into separate gems.
|
12
|
+
Many thanks to the Faraday Team, @JanDintel and everyone who attended the [ROSS Conf remote event](https://www.rossconf.io/event/remote/)
|
13
|
+
|
14
|
+
### Features
|
15
|
+
|
16
|
+
* Improves consistency with Faraday::Error and Faraday::RaiseError (#1229, @qsona, @iMacTia)
|
17
|
+
|
18
|
+
### Fixes
|
19
|
+
|
20
|
+
* Don't assign to global ::Timer (#1227, @bpo)
|
21
|
+
|
22
|
+
### Documentation
|
23
|
+
|
24
|
+
* CHANGELOG: add releases after 1.0 (#1225, @olleolleolle)
|
25
|
+
* Improves retry middleware documentation. (#1228, @iMacTia)
|
26
|
+
|
27
|
+
### Misc
|
28
|
+
|
29
|
+
* Move out Net::HTTP adapter (#1222, @JanDintel, @iMacTia)
|
30
|
+
* Adds Ruby 3.0 to CI Matrix (#1226, @iMacTia)
|
31
|
+
|
32
|
+
|
33
|
+
## [v1.2.0](https://github.com/lostisland/faraday/releases/tag/v1.2.0) (2020-12-23)
|
34
|
+
|
35
|
+
### Features
|
36
|
+
|
37
|
+
* Introduces `on_request` and `on_complete` methods in `Faraday::Middleware`. (#1194, @iMacTia)
|
38
|
+
|
39
|
+
### Fixes
|
40
|
+
|
41
|
+
* Require 'date' to avoid retry exception (#1206, @rustygeldmacher)
|
42
|
+
* Fix rdebug recursion issue (#1205, @native-api)
|
43
|
+
* Update call to `em_http_ssl_patch` (#1202, @kylekeesling)
|
44
|
+
* `EmHttp` adapter: drop superfluous loaded? check (#1213, @olleolleolle)
|
45
|
+
* Avoid 1 use of keyword hackery (#1211, @grosser)
|
46
|
+
* Fix #1219 `Net::HTTP` still uses env proxy (#1221, @iMacTia)
|
47
|
+
|
48
|
+
### Documentation
|
49
|
+
|
50
|
+
* Add comment in gemspec to explain exposure of `examples` and `spec` folders. (#1192, @iMacTia)
|
51
|
+
* Adapters, how to create them (#1193, @olleolleolle)
|
52
|
+
* Update documentation on using the logger (#1196, @tijmenb)
|
53
|
+
* Adjust the retry documentation and spec to align with implementation (#1198, @nbeyer)
|
54
|
+
|
55
|
+
### Misc
|
56
|
+
|
57
|
+
* Test against ruby head (#1208, @grosser)
|
58
|
+
|
59
|
+
## [v1.1.0](https://github.com/lostisland/faraday/releases/tag/v1.1.0) (2020-10-17)
|
60
|
+
|
61
|
+
### Features
|
62
|
+
|
63
|
+
* Makes parameters sorting configurable (#1162 @wishdev)
|
64
|
+
* Introduces `flat_encode` option for multipart adapter. (#1163 @iMacTia)
|
65
|
+
* Include request info in exceptions raised by RaiseError Middleware (#1181 @SandroDamilano)
|
66
|
+
|
67
|
+
### Fixes
|
68
|
+
|
69
|
+
* Avoid `last arg as keyword param` warning when building user middleware on Ruby 2.7 (#1153 @dgholz)
|
70
|
+
* Limits net-http-persistent version to < 4.0 (#1156 @iMacTia)
|
71
|
+
* Update `typhoeus` to new stable version (`1.4`) (#1159 @AlexWayfer)
|
72
|
+
* Properly fix test failure with Rack 2.1+. (#1171 @voxik)
|
73
|
+
|
74
|
+
### Documentation
|
75
|
+
|
76
|
+
* Improves documentation on how to contribute to the site by using Docker. (#1175 @iMacTia)
|
77
|
+
* Remove retry_change_requests from documentation (#1185 @stim371)
|
78
|
+
|
79
|
+
### Misc
|
80
|
+
|
81
|
+
* Link from GitHub Actions badge to CI workflow (#1141 @olleolleolle)
|
82
|
+
* Return tests of `Test` adapter (#1147 @AlexWayfer)
|
83
|
+
* Add 1.0 release to wording in CONTRIBUTING (#1155 @olleolleolle)
|
84
|
+
* Fix linting bumping Rubocop to 0.90.0 (#1182 @iMacTia)
|
85
|
+
* Drop `git ls-files` in gemspec (#1183 @utkarsh2102)
|
86
|
+
* Upgrade CI to ruby/setup-ruby (#1187 @gogainda)
|
87
|
+
|
88
|
+
## [v1.0.1](https://github.com/lostisland/faraday/releases/tag/v1.0.1) (2020-03-29)
|
89
|
+
|
90
|
+
### Fixes
|
91
|
+
|
92
|
+
* Use Net::HTTP#start(&block) to ensure closed TCP connections (#1117)
|
93
|
+
* Fully qualify constants to be checked (#1122)
|
94
|
+
* Allows `parse` method to be private/protected in response middleware (#1123)
|
95
|
+
* Encode Spaces in Query Strings as '%20' Instead of '+' (#1125)
|
96
|
+
* Limits rack to v2.0.x (#1127)
|
97
|
+
* Adapter Registry reads also use mutex (#1136)
|
98
|
+
|
99
|
+
### Documentation
|
100
|
+
|
101
|
+
* Retry middleware documentation fix (#1109)
|
102
|
+
* Docs(retry): precise usage of retry-after (#1111)
|
103
|
+
* README: Link the logo to the website (#1112)
|
104
|
+
* Website: add search bar (#1116)
|
105
|
+
* Fix request/response mix-up in docs text (#1132)
|
106
|
+
|
107
|
+
## v1.0
|
108
|
+
|
109
|
+
Features:
|
110
|
+
|
111
|
+
* Add #trace support to Faraday::Connection #861 (@technoweenie)
|
112
|
+
* Add the log formatter that is easy to override and safe to inherit #889 (@prikha)
|
113
|
+
* Support standalone adapters #941 (@iMacTia)
|
114
|
+
* Introduce Faraday::ConflictError for 409 response code #979 (@lucasmoreno)
|
115
|
+
* Add support for setting `read_timeout` option separately #1003 (@springerigor)
|
116
|
+
* Refactor and cleanup timeout settings across adapters #1022 (@technoweenie)
|
117
|
+
* Create ParamPart class to allow multipart posts with JSON content and file upload at the same time #1017 (@jeremy-israel)
|
118
|
+
* Copy UploadIO const -> FilePart for consistency with ParamPart #1018, #1021 (@technoweenie)
|
119
|
+
* Implement streaming responses in the Excon adapter #1026 (@technoweenie)
|
120
|
+
* Add default implementation of `Middleware#close`. #1069 (@ioquatix)
|
121
|
+
* Add `Adapter#close` so that derived classes can call super. #1091 (@ioquatix)
|
122
|
+
* Add log_level option to logger default formatter #1079 (@amrrbakry)
|
123
|
+
* Fix empty array for FlatParamsEncoder `{key: []} -> "key="` #1084 (@mrexox)
|
124
|
+
|
125
|
+
Bugs:
|
126
|
+
|
127
|
+
* Explicitly require date for DateTime library in Retry middleware #844 (@nickpresta)
|
128
|
+
* Refactor Adapter as final endpoints #846 (@iMacTia)
|
129
|
+
* Separate Request and Response bodies in Faraday::Env #847 (@iMacTia)
|
130
|
+
* Implement Faraday::Connection#options to make HTTP requests with the OPTIONS verb. #857 (@technoweenie)
|
131
|
+
* Multipart: Drop Ruby 1.8 String behavior compat #892 (@olleolleolle)
|
132
|
+
* Fix Ruby warnings in Faraday::Options.memoized #962 (@technoweenie)
|
133
|
+
* Allow setting min/max SSL version for a Net::HTTP::Persistent connection #972, #973 (@bdewater, @olleolleolle)
|
134
|
+
* Fix instances of frozen empty string literals #1040 (@BobbyMcWho)
|
135
|
+
* remove temp_proxy and improve proxy tests #1063 (@technoweenie)
|
136
|
+
* improve error initializer consistency #1095 (@technoweenie)
|
137
|
+
|
138
|
+
Misc:
|
139
|
+
|
140
|
+
* Convert minitest suite to RSpec #832 (@iMacTia, with help from @gaynetdinov, @Insti, @technoweenie)
|
141
|
+
* Major effort to update code to RuboCop standards. #854 (@olleolleolle, @iMacTia, @technoweenie, @htwroclau, @jherdman, @Drenmi, @Insti)
|
142
|
+
* Rubocop #1044, #1047 (@BobbyMcWho, @olleolleolle)
|
143
|
+
* Documentation tweaks (@adsteel, @Hubro, @iMacTia, @olleolleolle, @technoweenie)
|
144
|
+
* Update license year #981 (@Kevin-Kawai)
|
145
|
+
* Configure Jekyll plugin jekyll-remote-theme to support Docker usage #999 (@Lewiscowles1986)
|
146
|
+
* Fix Ruby 2.7 warnings #1009 (@tenderlove)
|
147
|
+
* Cleanup adapter connections #1023 (@technoweenie)
|
148
|
+
* Describe clearing cached stubs #1045 (@viraptor)
|
149
|
+
* Add project metadata to the gemspec #1046 (@orien)
|
150
|
+
|
151
|
+
## v0.17.3
|
152
|
+
|
153
|
+
Fixes:
|
154
|
+
|
155
|
+
* Reverts changes in error classes hierarchy. #1092 (@iMacTia)
|
156
|
+
* Fix Ruby 1.9 syntax errors and improve Error class testing #1094 (@BanzaiMan,
|
157
|
+
@mrexox, @technoweenie)
|
158
|
+
|
159
|
+
Misc:
|
160
|
+
|
161
|
+
* Stops using `&Proc.new` for block forwarding. #1083 (@olleolleolle)
|
162
|
+
* Update CI to test against ruby 2.0-2.7 #1087, #1099 (@iMacTia, @olleolleolle,
|
163
|
+
@technoweenie)
|
164
|
+
* require FARADAY_DEPRECATE=warn to show Faraday v1.0 deprecation warnings
|
165
|
+
#1098 (@technoweenie)
|
166
|
+
|
167
|
+
## v0.17.1
|
168
|
+
|
169
|
+
Final release before Faraday v1.0, with important fixes for Ruby 2.7.
|
170
|
+
|
171
|
+
Fixes:
|
172
|
+
|
173
|
+
* RaiseError response middleware raises exception if HTTP client returns a nil
|
174
|
+
status. #1042 (@jonnyom, @BobbyMcWho)
|
175
|
+
|
176
|
+
Misc:
|
177
|
+
|
178
|
+
* Fix Ruby 2.7 warnings (#1009)
|
179
|
+
* Add `Faraday::Deprecate` to warn about upcoming v1.0 changes. (#1054, #1059,
|
180
|
+
#1076, #1077)
|
181
|
+
* Add release notes up to current in CHANGELOG.md (#1066)
|
182
|
+
* Port minimal rspec suite from main branch to run backported tests. (#1058)
|
183
|
+
|
184
|
+
## v0.17.0
|
185
|
+
|
186
|
+
This release is the same as v0.15.4. It was pushed to cover up releases
|
187
|
+
v0.16.0-v0.16.2.
|
188
|
+
|
189
|
+
## v0.15.4
|
190
|
+
|
191
|
+
* Expose `pool_size` as a option for the NetHttpPersistent adapter (#834)
|
192
|
+
|
193
|
+
## v0.15.3
|
194
|
+
|
195
|
+
* Make Faraday::Request serialisable with Marshal. (#803)
|
196
|
+
* Add DEFAULT_EXCEPTIONS constant to Request::Retry (#814)
|
197
|
+
* Add support for Ruby 2.6 Net::HTTP write_timeout (#824)
|
198
|
+
|
199
|
+
## v0.15.2
|
200
|
+
|
201
|
+
* Prevents `Net::HTTP` adapters to retry request internally by setting `max_retries` to 0 if available (Ruby 2.5+). (#799)
|
202
|
+
* Fixes `NestedParamsEncoder` handling of empty array values (#801)
|
203
|
+
|
204
|
+
## v0.15.1
|
205
|
+
|
206
|
+
* NetHttpPersistent adapter better reuse of SSL connections (#793)
|
207
|
+
* Refactor: inline cached_connection (#797)
|
208
|
+
* Logger middleware: use $stdout instead of STDOUT (#794)
|
209
|
+
* Fix: do not memoize/reuse Patron session (#796)
|
210
|
+
|
211
|
+
Also in this release:
|
212
|
+
|
213
|
+
* Allow setting min/max ssl version for Net::HTTP (#792)
|
214
|
+
* Allow setting min/max ssl version for Excon (#795)
|
215
|
+
|
216
|
+
## v0.15.0
|
217
|
+
|
218
|
+
Features:
|
219
|
+
|
220
|
+
* Added retry block option to retry middleware. (#770)
|
221
|
+
* Retry middleware improvements (honour Retry-After header, retry statuses) (#773)
|
222
|
+
* Improve response logger middleware output (#784)
|
223
|
+
|
224
|
+
Fixes:
|
225
|
+
|
226
|
+
* Remove unused class error (#767)
|
227
|
+
* Fix minor typo in README (#760)
|
228
|
+
* Reuse persistent connections when using net-http-persistent (#778)
|
229
|
+
* Fix Retry middleware documentation (#781)
|
230
|
+
* Returns the http response when giving up on retrying by status (#783)
|
231
|
+
|
232
|
+
## v0.14.0
|
233
|
+
|
234
|
+
Features:
|
235
|
+
|
236
|
+
* Allow overriding env proxy #754 (@iMacTia)
|
237
|
+
* Remove legacy Typhoeus adapter #715 (@olleolleolle)
|
238
|
+
* External Typhoeus Adapter Compatibility #748 (@iMacTia)
|
239
|
+
* Warn about missing adapter when making a request #743 (@antstorm)
|
240
|
+
* Faraday::Adapter::Test stubs now support entire urls (with host) #741 (@erik-escobedo)
|
241
|
+
|
242
|
+
Fixes:
|
243
|
+
|
244
|
+
* If proxy is manually provided, this takes priority over `find_proxy` #724 (@iMacTia)
|
245
|
+
* Fixes the behaviour for Excon's open_timeout (not setting write_timeout anymore) #731 (@apachelogger)
|
246
|
+
* Handle all connection timeout messages in Patron #687 (@stayhero)
|
247
|
+
|
248
|
+
## v0.13.1
|
249
|
+
|
250
|
+
* Fixes an incompatibility with Addressable::URI being used as uri_parser
|
251
|
+
|
252
|
+
## v0.13.0
|
253
|
+
|
254
|
+
Features:
|
255
|
+
|
256
|
+
* Dynamically reloads the proxy when performing a request on an absolute domain (#701)
|
257
|
+
* Adapter support for Net::HTTP::Persistent v3.0.0 (#619)
|
258
|
+
|
259
|
+
Fixes:
|
260
|
+
|
261
|
+
* Prefer #hostname over #host. (#714)
|
262
|
+
* Fixes an edge-case issue with response headers parsing (missing HTTP header) (#719)
|
263
|
+
|
264
|
+
## v0.12.2
|
265
|
+
|
266
|
+
* Parse headers from aggregated proxy requests/responses (#681)
|
267
|
+
* Guard against invalid middleware configuration with warning (#685)
|
268
|
+
* Do not use :insecure option by default in Patron (#691)
|
269
|
+
* Fixes an issue with HTTPClient not raising a `Faraday::ConnectionFailed` (#702)
|
270
|
+
* Fixes YAML serialization/deserialization for `Faraday::Utils::Headers` (#690)
|
271
|
+
* Fixes an issue with Options having a nil value (#694)
|
272
|
+
* Fixes an issue with Faraday.default_connection not using Faraday.default_connection_options (#698)
|
273
|
+
* Fixes an issue with Options.merge! and Faraday instrumentation middleware (#710)
|
274
|
+
|
275
|
+
## v0.12.1
|
276
|
+
|
277
|
+
* Fix an issue with Patron tests failing on jruby
|
278
|
+
* Fix an issue with new `rewind_files` feature that was causing an exception when the body was not an Hash
|
279
|
+
* Expose wrapped_exception in all client errors
|
280
|
+
* Add Authentication Section to the ReadMe
|
281
|
+
|
282
|
+
## v0.12.0.1
|
283
|
+
|
284
|
+
* Hotfix release to address an issue with TravisCI deploy on Rubygems
|
285
|
+
|
286
|
+
## v0.12.0
|
287
|
+
|
288
|
+
Features:
|
289
|
+
|
290
|
+
* Proxy feature now relies on Ruby `URI::Generic#find_proxy` and can use `no_proxy` ENV variable (not compatible with ruby < 2.0)
|
291
|
+
* Adds support for `context` request option to pass arbitrary information to middlewares
|
292
|
+
|
293
|
+
Fixes:
|
294
|
+
|
295
|
+
* Fix an issue with options that was causing new options to override defaults ones unexpectedly
|
296
|
+
* Rewind `UploadIO`s on retry to fix a compatibility issue
|
297
|
+
* Make multipart boundary unique
|
298
|
+
* Improvements in `README.md`
|
299
|
+
|
300
|
+
## v0.11.0
|
301
|
+
|
302
|
+
Features:
|
303
|
+
|
304
|
+
* Add `filter` method to Logger middleware
|
305
|
+
* Add support for Ruby2.4 and Minitest 6
|
306
|
+
* Introduce block syntax to customise the adapter
|
307
|
+
|
308
|
+
Fixes:
|
309
|
+
|
310
|
+
* Fix an issue that was allowing to override `default_connection_options` from a connection instance
|
311
|
+
* Fix a bug that was causing newline escape characters ("\n") to be used when building the Authorization header
|
312
|
+
|
313
|
+
## v0.10.1
|
314
|
+
|
315
|
+
- Fix an issue with HTTPClient adapter that was causing the SSL to be reset on every request
|
316
|
+
- Rescue `IOError` instead of specific subclass
|
317
|
+
- `Faraday::Utils::Headers` can now be successfully serialised in YAML
|
318
|
+
- Handle `default_connection_options` set with hash
|
319
|
+
|
320
|
+
## v0.10.0
|
321
|
+
|
322
|
+
Breaking changes:
|
323
|
+
- Drop support for Ruby 1.8
|
324
|
+
|
325
|
+
Features:
|
326
|
+
- Include wrapped exception/reponse in ClientErrors
|
327
|
+
- Add `response.reason_phrase`
|
328
|
+
- Provide option to selectively skip logging request/response headers
|
329
|
+
- Add regex support for pattern matching in `test` adapter
|
330
|
+
|
331
|
+
Fixes:
|
332
|
+
- Add `Faraday.respond_to?` to find methods managed by `method_missing`
|
333
|
+
- em-http: `request.host` instead of `connection.host` should be taken for SSL validations
|
334
|
+
- Allow `default_connection_options` to be merged when options are passed as url parameter
|
335
|
+
- Improve splitting key-value pairs in raw HTTP headers
|
336
|
+
|
337
|
+
## v0.9.2
|
338
|
+
|
339
|
+
Adapters:
|
340
|
+
- Enable gzip compression for httpclient
|
341
|
+
- Fixes default certificate store for httpclient not having default paths.
|
342
|
+
- Make excon adapter compatible with 0.44 excon version
|
343
|
+
- Add compatibility with Patron 0.4.20
|
344
|
+
- Determine default port numbers in Net::HTTP adapters (Addressable compatibility)
|
345
|
+
- em-http: wrap "connection closed by server" as ConnectionFailed type
|
346
|
+
- Wrap Errno::ETIMEDOUT in Faraday::Error::TimeoutError
|
347
|
+
|
348
|
+
Utils:
|
349
|
+
- Add Rack-compatible support for parsing `a[][b]=c` nested queries
|
350
|
+
- Encode nil values in queries different than empty strings. Before: `a=`; now: `a`.
|
351
|
+
- Have `Faraday::Utils::Headers#replace` clear internal key cache
|
352
|
+
- Dup the internal key cache when a Headers hash is copied
|
353
|
+
|
354
|
+
Env and middleware:
|
355
|
+
- Ensure `env` stored on middleware response has reference to the response
|
356
|
+
- Ensure that Response properties are initialized during `on_complete` (VCR compatibility)
|
357
|
+
- Copy request options in Faraday::Connection#dup
|
358
|
+
- Env custom members should be copied by Env.from(env)
|
359
|
+
- Honour per-request `request.options.params_encoder`
|
360
|
+
- Fix `interval_randomness` data type for Retry middleware
|
361
|
+
- Add maximum interval option for Retry middleware
|
362
|
+
|
3
363
|
## v0.9.1
|
4
364
|
|
5
365
|
* Refactor Net:HTTP adapter so that with_net_http_connection can be overridden to allow pooled connections. (@Ben-M)
|
data/LICENSE.md
CHANGED
data/README.md
CHANGED
@@ -1,200 +1,30 @@
|
|
1
|
-
# Faraday
|
1
|
+
# [![Faraday](./docs/assets/img/repo-card-slim.png)][website]
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
Faraday supports these adapters:
|
8
|
-
|
9
|
-
* Net::HTTP
|
10
|
-
* [Excon][]
|
11
|
-
* [Typhoeus][]
|
12
|
-
* [Patron][]
|
13
|
-
* [EventMachine][]
|
14
|
-
* [HTTPClient][]
|
15
|
-
|
16
|
-
It also includes a Rack adapter for hitting loaded Rack applications through
|
17
|
-
Rack::Test, and a Test adapter for stubbing requests by hand.
|
18
|
-
|
19
|
-
## Usage
|
20
|
-
|
21
|
-
```ruby
|
22
|
-
conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
|
23
|
-
faraday.request :url_encoded # form-encode POST params
|
24
|
-
faraday.response :logger # log requests to STDOUT
|
25
|
-
faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
|
26
|
-
end
|
27
|
-
|
28
|
-
## GET ##
|
29
|
-
|
30
|
-
response = conn.get '/nigiri/sake.json' # GET http://sushi.com/nigiri/sake.json
|
31
|
-
response.body
|
32
|
-
|
33
|
-
conn.get '/nigiri', { :name => 'Maguro' } # GET http://sushi.com/nigiri?name=Maguro
|
34
|
-
|
35
|
-
conn.get do |req| # GET http://sushi.com/search?page=2&limit=100
|
36
|
-
req.url '/search', :page => 2
|
37
|
-
req.params['limit'] = 100
|
38
|
-
end
|
39
|
-
|
40
|
-
## POST ##
|
41
|
-
|
42
|
-
conn.post '/nigiri', { :name => 'Maguro' } # POST "name=maguro" to http://sushi.com/nigiri
|
43
|
-
|
44
|
-
# post payload as JSON instead of "www-form-urlencoded" encoding:
|
45
|
-
conn.post do |req|
|
46
|
-
req.url '/nigiri'
|
47
|
-
req.headers['Content-Type'] = 'application/json'
|
48
|
-
req.body = '{ "name": "Unagi" }'
|
49
|
-
end
|
50
|
-
|
51
|
-
## Per-request options ##
|
52
|
-
|
53
|
-
conn.get do |req|
|
54
|
-
req.url '/search'
|
55
|
-
req.options.timeout = 5 # open/read timeout in seconds
|
56
|
-
req.options.open_timeout = 2 # connection open timeout in seconds
|
57
|
-
end
|
58
|
-
```
|
59
|
-
|
60
|
-
If you don't need to set up anything, you can roll with just the default middleware
|
61
|
-
stack and default adapter (see [Faraday::RackBuilder#initialize](https://github.com/lostisland/faraday/blob/master/lib/faraday/rack_builder.rb)):
|
62
|
-
|
63
|
-
```ruby
|
64
|
-
response = Faraday.get 'http://sushi.com/nigiri/sake.json'
|
65
|
-
```
|
66
|
-
|
67
|
-
## Advanced middleware usage
|
68
|
-
|
69
|
-
The order in which middleware is stacked is important. Like with Rack, the
|
70
|
-
first middleware on the list wraps all others, while the last middleware is the
|
71
|
-
innermost one, so that must be the adapter.
|
72
|
-
|
73
|
-
```ruby
|
74
|
-
Faraday.new(...) do |conn|
|
75
|
-
# POST/PUT params encoders:
|
76
|
-
conn.request :multipart
|
77
|
-
conn.request :url_encoded
|
78
|
-
|
79
|
-
conn.adapter :net_http
|
80
|
-
end
|
81
|
-
```
|
3
|
+
[![Gem Version](https://badge.fury.io/rb/faraday.svg)](https://rubygems.org/gems/faraday)
|
4
|
+
[![GitHub Actions CI](https://github.com/lostisland/faraday/workflows/CI/badge.svg)](https://github.com/lostisland/faraday/actions?query=workflow%3ACI)
|
5
|
+
[![Gitter](https://badges.gitter.im/lostisland/faraday.svg)](https://gitter.im/lostisland/faraday?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
82
6
|
|
83
|
-
This request middleware setup affects POST/PUT requests in the following way:
|
84
7
|
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
already encoded or of another type
|
89
|
-
|
90
|
-
Swapping middleware means giving the other priority. Specifying the
|
91
|
-
"Content-Type" for the request is explicitly stating which middleware should
|
92
|
-
process it.
|
93
|
-
|
94
|
-
Examples:
|
95
|
-
|
96
|
-
```ruby
|
97
|
-
# uploading a file:
|
98
|
-
payload[:profile_pic] = Faraday::UploadIO.new('/path/to/avatar.jpg', 'image/jpeg')
|
99
|
-
|
100
|
-
# "Multipart" middleware detects files and encodes with "multipart/form-data":
|
101
|
-
conn.put '/profile', payload
|
102
|
-
```
|
103
|
-
|
104
|
-
## Writing middleware
|
105
|
-
|
106
|
-
Middleware are classes that implement a `call` instance method. They hook into
|
107
|
-
the request/response cycle.
|
108
|
-
|
109
|
-
```ruby
|
110
|
-
def call(request_env)
|
111
|
-
# do something with the request
|
112
|
-
# request_env[:request_headers].merge!(...)
|
113
|
-
|
114
|
-
@app.call(request_env).on_complete do |response_env|
|
115
|
-
# do something with the response
|
116
|
-
# response_env[:response_headers].merge!(...)
|
117
|
-
end
|
118
|
-
end
|
119
|
-
```
|
120
|
-
|
121
|
-
It's important to do all processing of the response only in the `on_complete`
|
122
|
-
block. This enables middleware to work in parallel mode where requests are
|
123
|
-
asynchronous.
|
124
|
-
|
125
|
-
The `env` is a hash with symbol keys that contains info about the request and,
|
126
|
-
later, response. Some keys are:
|
127
|
-
|
128
|
-
```
|
129
|
-
# request phase
|
130
|
-
:method - :get, :post, ...
|
131
|
-
:url - URI for the current request; also contains GET parameters
|
132
|
-
:body - POST parameters for :post/:put requests
|
133
|
-
:request_headers
|
134
|
-
|
135
|
-
# response phase
|
136
|
-
:status - HTTP response status code, such as 200
|
137
|
-
:body - the response body
|
138
|
-
:response_headers
|
139
|
-
```
|
140
|
-
|
141
|
-
## Using Faraday for testing
|
142
|
-
|
143
|
-
```ruby
|
144
|
-
# It's possible to define stubbed request outside a test adapter block.
|
145
|
-
stubs = Faraday::Adapter::Test::Stubs.new do |stub|
|
146
|
-
stub.get('/tamago') { |env| [200, {}, 'egg'] }
|
147
|
-
end
|
148
|
-
|
149
|
-
# You can pass stubbed request to the test adapter or define them in a block
|
150
|
-
# or a combination of the two.
|
151
|
-
test = Faraday.new do |builder|
|
152
|
-
builder.adapter :test, stubs do |stub|
|
153
|
-
stub.get('/ebi') { |env| [ 200, {}, 'shrimp' ]}
|
154
|
-
end
|
155
|
-
end
|
156
|
-
|
157
|
-
# It's also possible to stub additional requests after the connection has
|
158
|
-
# been initialized. This is useful for testing.
|
159
|
-
stubs.get('/uni') { |env| [ 200, {}, 'urchin' ]}
|
160
|
-
|
161
|
-
resp = test.get '/tamago'
|
162
|
-
resp.body # => 'egg'
|
163
|
-
resp = test.get '/ebi'
|
164
|
-
resp.body # => 'shrimp'
|
165
|
-
resp = test.get '/uni'
|
166
|
-
resp.body # => 'urchin'
|
167
|
-
resp = test.get '/else' #=> raises "no such stub" error
|
168
|
-
|
169
|
-
# If you like, you can treat your stubs as mocks by verifying that all of
|
170
|
-
# the stubbed calls were made. NOTE that this feature is still fairly
|
171
|
-
# experimental: It will not verify the order or count of any stub, only that
|
172
|
-
# it was called once during the course of the test.
|
173
|
-
stubs.verify_stubbed_calls
|
174
|
-
```
|
8
|
+
Faraday is an HTTP client library that provides a common interface over many
|
9
|
+
adapters (such as Net::HTTP) and embraces the concept of Rack middleware when
|
10
|
+
processing the request/response cycle.
|
175
11
|
|
176
|
-
##
|
12
|
+
## Getting Started
|
177
13
|
|
178
|
-
|
179
|
-
|
14
|
+
The best starting point is the [Faraday Website][website], with its introduction and explanation.
|
15
|
+
Need more details? See the [Faraday API Documentation][apidoc] to see how it works internally.
|
180
16
|
|
181
17
|
## Supported Ruby versions
|
182
18
|
|
183
|
-
This library aims to support and is [tested against][
|
19
|
+
This library aims to support and is [tested against][actions] the following Ruby
|
184
20
|
implementations:
|
185
21
|
|
186
|
-
*
|
187
|
-
* MRI 1.9.2
|
188
|
-
* MRI 1.9.3
|
189
|
-
* MRI 2.0.0
|
190
|
-
* MRI 2.1.0
|
191
|
-
* [JRuby][]
|
192
|
-
* [Rubinius][]
|
22
|
+
* Ruby 2.4+
|
193
23
|
|
194
24
|
If something doesn't work on one of these Ruby versions, it's a bug.
|
195
25
|
|
196
26
|
This library may inadvertently work (or seem to work) on other Ruby
|
197
|
-
implementations, however support will only be provided for the versions listed
|
27
|
+
implementations and versions, however support will only be provided for the versions listed
|
198
28
|
above.
|
199
29
|
|
200
30
|
If you would like this library to support another Ruby version, you may
|
@@ -204,17 +34,20 @@ implementation, you will be responsible for providing patches in a timely
|
|
204
34
|
fashion. If critical issues for a particular implementation exist at the time
|
205
35
|
of a major release, support for that Ruby version may be dropped.
|
206
36
|
|
207
|
-
##
|
37
|
+
## Contribute
|
208
38
|
|
209
|
-
|
210
|
-
|
39
|
+
Do you want to contribute to Faraday?
|
40
|
+
Open the issues page and check for the `help wanted` label!
|
41
|
+
But before you start coding, please read our [Contributing Guide][contributing]
|
211
42
|
|
212
|
-
|
213
|
-
[
|
214
|
-
|
215
|
-
[
|
216
|
-
[
|
217
|
-
[
|
218
|
-
[
|
219
|
-
[
|
220
|
-
[
|
43
|
+
## Copyright
|
44
|
+
© 2009 - 2020, the [Faraday Team][faraday_team]. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
|
45
|
+
|
46
|
+
[website]: https://lostisland.github.io/faraday
|
47
|
+
[faraday_team]: https://lostisland.github.io/faraday/team
|
48
|
+
[contributing]: https://github.com/lostisland/faraday/blob/master/.github/CONTRIBUTING.md
|
49
|
+
[apidoc]: https://www.rubydoc.info/github/lostisland/faraday
|
50
|
+
[actions]: https://github.com/lostisland/faraday/actions
|
51
|
+
[jruby]: http://jruby.org/
|
52
|
+
[rubinius]: http://rubini.us/
|
53
|
+
[license]: LICENSE.md
|