faraday 1.8.0 → 2.7.11

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 (84) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +197 -3
  3. data/LICENSE.md +1 -1
  4. data/README.md +34 -20
  5. data/Rakefile +3 -1
  6. data/examples/client_spec.rb +41 -19
  7. data/examples/client_test.rb +48 -22
  8. data/lib/faraday/adapter/test.rb +61 -12
  9. data/lib/faraday/adapter.rb +5 -9
  10. data/lib/faraday/connection.rb +58 -145
  11. data/lib/faraday/encoders/nested_params_encoder.rb +13 -6
  12. data/lib/faraday/error.rb +16 -11
  13. data/lib/faraday/logging/formatter.rb +27 -14
  14. data/lib/faraday/middleware.rb +3 -1
  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 +7 -3
  19. data/lib/faraday/options/request_options.rb +7 -6
  20. data/lib/faraday/options/ssl_options.rb +56 -45
  21. data/lib/faraday/options.rb +4 -3
  22. data/lib/faraday/rack_builder.rb +23 -20
  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 +64 -0
  26. data/lib/faraday/request/url_encoded.rb +5 -1
  27. data/lib/faraday/request.rb +20 -37
  28. data/lib/faraday/response/json.rb +54 -0
  29. data/lib/faraday/response/logger.rb +8 -4
  30. data/lib/faraday/response/raise_error.rb +29 -4
  31. data/lib/faraday/response.rb +10 -20
  32. data/lib/faraday/utils/headers.rb +7 -2
  33. data/lib/faraday/utils.rb +10 -5
  34. data/lib/faraday/version.rb +1 -1
  35. data/lib/faraday.rb +10 -38
  36. data/spec/faraday/adapter/test_spec.rb +65 -0
  37. data/spec/faraday/connection_spec.rb +163 -91
  38. data/spec/faraday/error_spec.rb +31 -6
  39. data/spec/faraday/middleware_registry_spec.rb +31 -0
  40. data/spec/faraday/middleware_spec.rb +18 -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 +8 -0
  44. data/spec/faraday/params_encoders/nested_spec.rb +8 -0
  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 +135 -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 +117 -0
  52. data/spec/faraday/response/logger_spec.rb +38 -0
  53. data/spec/faraday/response/raise_error_spec.rb +35 -5
  54. data/spec/faraday/response_spec.rb +3 -1
  55. data/spec/faraday/utils/headers_spec.rb +22 -4
  56. data/spec/faraday/utils_spec.rb +63 -1
  57. data/spec/faraday_spec.rb +8 -4
  58. data/spec/support/fake_safe_buffer.rb +1 -1
  59. data/spec/support/helper_methods.rb +0 -37
  60. data/spec/support/shared_examples/adapter.rb +2 -2
  61. data/spec/support/shared_examples/request_method.rb +22 -21
  62. metadata +19 -134
  63. data/lib/faraday/adapter/typhoeus.rb +0 -15
  64. data/lib/faraday/autoload.rb +0 -87
  65. data/lib/faraday/dependency_loader.rb +0 -37
  66. data/lib/faraday/file_part.rb +0 -128
  67. data/lib/faraday/param_part.rb +0 -53
  68. data/lib/faraday/request/basic_authentication.rb +0 -20
  69. data/lib/faraday/request/multipart.rb +0 -106
  70. data/lib/faraday/request/retry.rb +0 -239
  71. data/lib/faraday/request/token_authentication.rb +0 -20
  72. data/spec/faraday/adapter/em_http_spec.rb +0 -49
  73. data/spec/faraday/adapter/em_synchrony_spec.rb +0 -18
  74. data/spec/faraday/adapter/excon_spec.rb +0 -49
  75. data/spec/faraday/adapter/httpclient_spec.rb +0 -73
  76. data/spec/faraday/adapter/net_http_spec.rb +0 -64
  77. data/spec/faraday/adapter/patron_spec.rb +0 -18
  78. data/spec/faraday/adapter/rack_spec.rb +0 -8
  79. data/spec/faraday/adapter/typhoeus_spec.rb +0 -7
  80. data/spec/faraday/composite_read_io_spec.rb +0 -80
  81. data/spec/faraday/request/multipart_spec.rb +0 -302
  82. data/spec/faraday/request/retry_spec.rb +0 -242
  83. data/spec/faraday/response/middleware_spec.rb +0 -68
  84. data/spec/support/webmock_rack_app.rb +0 -68
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f6441da03048f7371bd0cb898dd3e27c7be6382c67fc4901883e9dbe9841b56f
4
- data.tar.gz: 0beb3f2da75282655fc46cd5540de96d5fef259dd35193ec9eb0d3163cc959d2
3
+ metadata.gz: 72fbb1db4fce28541cd53b5908e1fc18539ead8322d0b642069bd2e63d2a6543
4
+ data.tar.gz: a5e4f596d8f23e00f064c9789f85fa1cb194cac85168177750b76b3a3e9c7f4d
5
5
  SHA512:
6
- metadata.gz: 1ab1aa0e0c68c9348d9e180a903f01f2517bd38672fe1bdf056ceab4729e841944173e47dc26aa1b4fe16b2779f1a8102914ed594ea92d08feff6dc944412f0b
7
- data.tar.gz: bc43fbac427062861e79d5328b60886a5b9c8783f707faa1fcfad064b9c6945f6a4e2a97dbad9ecadc1c1620b5327d651a764962764b7fc86e6d2fbd84ad0b4b
6
+ metadata.gz: f880cdd4a42f22ac4eafeab1ddfcfb9e7a8ff0299956a279b207e4ed50d9b86fa09e44e74c4810b9ace3748db5edf6a9f62c73310d09ec1bbf73ec981356d921
7
+ data.tar.gz: 159e971ec7168017e0053511217a8b89314cd25aaf626a3a409db800218e39b172741a1264616c7b770a3ce45e9ee9a0bd5f9dc6fd43511cc4b9f8ae5fa8304a
data/CHANGELOG.md CHANGED
@@ -1,9 +1,196 @@
1
1
  # Faraday Changelog
2
2
 
3
+ ## The changelog has moved!
4
+
5
+ This file is not being updated anymore. Instead, please check the [Releases](https://github.com/lostisland/faraday/releases) page.
6
+
7
+ ## [2.2.0](https://github.com/lostisland/faraday/compare/v2.1.0...v2.2.0) (2022-02-03)
8
+
9
+ * Reintroduce the possibility to register middleware with symbols, strings or procs in [#1391](https://github.com/lostisland/faraday/pull/1391)
10
+
11
+ ## [2.1.0](https://github.com/lostisland/faraday/compare/v2.0.1...v2.1.0) (2022-01-15)
12
+
13
+ * Fix test adapter thread safety by @iMacTia in [#1380](https://github.com/lostisland/faraday/pull/1380)
14
+ * Add default adapter options by @hirasawayuki in [#1382](https://github.com/lostisland/faraday/pull/1382)
15
+ * CI: Add Ruby 3.1 to matrix by @petergoldstein in [#1374](https://github.com/lostisland/faraday/pull/1374)
16
+ * docs: fix regex pattern in logger.md examples by @hirasawayuki in [#1378](https://github.com/lostisland/faraday/pull/1378)
17
+
18
+ ## [2.0.1](https://github.com/lostisland/faraday/compare/v2.0.0...v2.0.1) (2022-01-05)
19
+
20
+ * Re-add `faraday-net_http` as default adapter by @iMacTia in [#1366](https://github.com/lostisland/faraday/pull/1366)
21
+ * Updated sample format in UPGRADING.md by @vimutter in [#1361](https://github.com/lostisland/faraday/pull/1361)
22
+ * docs: Make UPGRADING examples more copyable by @olleolleolle in [#1363](https://github.com/lostisland/faraday/pull/1363)
23
+
24
+ ## [2.0.0](https://github.com/lostisland/faraday/compare/v1.8.0...v2.0.0) (2022-01-04)
25
+
26
+ The next major release is here, and it comes almost 2 years after the release of v1.0!
27
+
28
+ This release changes the way you use Faraday and embraces a new paradigm of Faraday as an ecosystem, rather than a library.
29
+
30
+ What does that mean? It means that Faraday is less of a bundled tool and more of a framework for the community to build on top of.
31
+
32
+ As a result, all adapters and some middleware have moved out and are now shipped as standalone gems 🙌!
33
+
34
+ But this doesn't mean that upgrading from Faraday 1.x to Faraday 2.0 should be hard, in fact we've listed everything you need to do in the [UPGRADING.md](https://github.com/lostisland/faraday/blob/main/UPGRADING.md) doc.
35
+
36
+ Moreover, we've setup a new [awesome-faraday](https://github.com/lostisland/awesome-faraday) repository that will showcase a curated list of adapters and middleware 😎.
37
+
38
+ This release was the result of the efforts of the core team and all the contributors, new and old, that have helped achieve this milestone 👏.
39
+
40
+ ## What's Changed
41
+
42
+ * Autoloading, dependency loading and middleware registry cleanup by @iMacTia in [#1301](https://github.com/lostisland/faraday/pull/1301)
43
+ * Move JSON middleware (request and response) from faraday_middleware by @iMacTia in [#1300](https://github.com/lostisland/faraday/pull/1300)
44
+ * Remove deprecated `Faraday::Request#method` by @olleolleolle in [#1303](https://github.com/lostisland/faraday/pull/1303)
45
+ * Remove deprecated `Faraday::UploadIO` by @iMacTia in [#1307](https://github.com/lostisland/faraday/pull/1307)
46
+ * [1.x] Deprecate Authorization helpers in `Faraday::Connection` by @iMacTia in [#1306](https://github.com/lostisland/faraday/pull/1306)
47
+ * Drop deprecated auth helpers from Connection and refactor auth middleware by @iMacTia in [#1308](https://github.com/lostisland/faraday/pull/1308)
48
+ * Add Faraday 1.x examples in authentication.md docs by @iMacTia in [#1320](https://github.com/lostisland/faraday/pull/1320)
49
+ * Fix passing a URL with embedded basic auth by @iMacTia in [#1324](https://github.com/lostisland/faraday/pull/1324)
50
+ * Register JSON middleware by @mollerhoj in [#1331](https://github.com/lostisland/faraday/pull/1331)
51
+ * Retry middleware should handle string exception class name consistently by @jrochkind in [#1334](https://github.com/lostisland/faraday/pull/1334)
52
+ * Improve request info in exceptions raised by RaiseError Middleware by @willianzocolau in [#1335](https://github.com/lostisland/faraday/pull/1335)
53
+ * Remove net-http adapter and update docs by @iMacTia in [#1336](https://github.com/lostisland/faraday/pull/1336)
54
+ * Explain plan for faraday_middleware in UPGRADING.md by @iMacTia in [#1339](https://github.com/lostisland/faraday/pull/1339)
55
+ * Scripts folder cleanup by @iMacTia in [#1340](https://github.com/lostisland/faraday/pull/1340)
56
+ * Replace `Hash#merge` with `Utils#deep_merge` for connection options by @xkwd in [#1343](https://github.com/lostisland/faraday/pull/1343)
57
+ * Callable authorizers by @sled in [#1345](https://github.com/lostisland/faraday/pull/1345)
58
+ * Default value for exc error by @DariuszMusielak in [#1351](https://github.com/lostisland/faraday/pull/1351)
59
+ * Don't call `retry_block` unless a retry is going to happen by @jrochkind in [#1350](https://github.com/lostisland/faraday/pull/1350)
60
+ * Improve documentation for v2 by @iMacTia in [#1353](https://github.com/lostisland/faraday/pull/1353)
61
+ * Remove default `default_adapter` (yes, you read that right) by @iMacTia in [#1354](https://github.com/lostisland/faraday/pull/1354)
62
+ * Remove retry middleware by @iMacTia in [#1356](https://github.com/lostisland/faraday/pull/1356)
63
+ * Remove multipart middleware and all its documentation and tests by @iMacTia in [#1357](https://github.com/lostisland/faraday/pull/1357)
64
+
65
+ ## [1.9.3](https://github.com/lostisland/faraday/compare/v1.9.2...v1.9.3) (2022-01-06)
66
+
67
+ * Re-add support for Ruby 2.4+ by @iMacTia in [#1371](https://github.com/lostisland/faraday/pull/1371)
68
+
69
+ ## [1.9.2](https://github.com/lostisland/faraday/compare/v1.9.1...v1.9.2) (2022-01-06)
70
+
71
+ * Add alias with legacy name to gemified middleware by @iMacTia in [#1372](https://github.com/lostisland/faraday/pull/1372)
72
+
73
+ ## [1.9.1](https://github.com/lostisland/faraday/compare/v1.9.0...v1.9.1) (2022-01-06)
74
+
75
+ * Update adapter dependencies in Gemspec by @iMacTia in [#1370](https://github.com/lostisland/faraday/pull/1370)
76
+
77
+ ## [1.9.0](https://github.com/lostisland/faraday/compare/v1.8.0...v1.9.0) (2022-01-06)
78
+
79
+ * Use external multipart and retry middleware by @iMacTia in [#1367](https://github.com/lostisland/faraday/pull/1367)
80
+
81
+ ## [1.8.0](https://github.com/lostisland/faraday/releases/tag/v1.8.0) (2021-09-18)
82
+
83
+ ### Features
84
+
85
+ * Backport authorization procs (#1322, @jarl-dk)
86
+
87
+ ## [v1.7.0](https://github.com/lostisland/faraday/releases/tag/v1.7.0) (2021-08-09)
88
+
89
+ ### Features
90
+
91
+ * Add strict_mode to Test::Stubs (#1298, @yykamei)
92
+
93
+ ## [v1.6.0](https://github.com/lostisland/faraday/releases/tag/v1.6.0) (2021-08-01)
94
+
95
+ ### Misc
96
+
97
+ * Use external Rack adapter (#1296, @iMacTia)
98
+
99
+ ## [v1.5.1](https://github.com/lostisland/faraday/releases/tag/v1.5.1) (2021-07-11)
100
+
101
+ ### Fixes
102
+
103
+ * Fix JRuby incompatibility after moving out EM adapters (#1294, @ahorek)
104
+
105
+ ### Documentation
106
+
107
+ * Update YARD to follow RackBuilder (#1292, @kachick)
108
+
109
+ ## [v1.5.0](https://github.com/lostisland/faraday/releases/tag/v1.5.0) (2021-07-04)
110
+
111
+ ### Misc
112
+
113
+ * Use external httpclient adapter (#1289, @iMacTia)
114
+ * Use external patron adapter (#1290, @iMacTia)
115
+
116
+ ## [v1.4.3](https://github.com/lostisland/faraday/releases/tag/v1.4.3) (2021-06-24)
117
+
118
+ ### Fixes
119
+
120
+ * Silence warning (#1286, @gurgeous)
121
+ * Always dup url_prefix in Connection#build_exclusive_url (#1288, @alexeyds)
122
+
123
+ ## [v1.4.2](https://github.com/lostisland/faraday/releases/tag/v1.4.2) (2021-05-22)
124
+
125
+ ### Fixes
126
+ * Add proxy setting when url_prefix is changed (#1276, @ci)
127
+ * Default proxy scheme to http:// if necessary, fixes #1282 (#1283, @gurgeous)
128
+
129
+ ### Documentation
130
+ * Improve introduction page (#1273, @gurgeous)
131
+ * Docs: add more middleware examples (#1277, @gurgeous)
132
+
133
+ ### Misc
134
+ * Use external `em_http` and `em_synchrony` adapters (#1274, @iMacTia)
135
+
136
+ ## [v1.4.1](https://github.com/lostisland/faraday/releases/tag/v1.4.1) (2021-04-18)
137
+
138
+ ### Fixes
139
+
140
+ * Fix dependencies from external adapter gems (#1269, @iMacTia)
141
+
142
+ ## [v1.4.0](https://github.com/lostisland/faraday/releases/tag/v1.4.0) (2021-04-16)
143
+
144
+ ### Highlights
145
+
146
+ With this release, we continue the work of gradually moving out adapters into their own gems 🎉
147
+ Thanks to @MikeRogers0 for helping the Faraday team in progressing with this quest 👏
148
+
149
+ And thanks to @olleolleolle efforts, Faraday is becoming more inclusive than ever 🤗
150
+ Faraday's `master` branch has been renamed into `main`, we have an official policy on inclusive language and even a rubocop plugin to check for non-inclusive words ❤️!
151
+ Checkout the "Misc" section below for more details 🙌 !
152
+
153
+ ### Fixes
154
+
155
+ * Fix NoMethodError undefined method 'coverage' (#1255, @Maroo-b)
156
+
157
+ ### Documentation
158
+
159
+ * Some docs on EventMachine adapters. (#1232, @damau)
160
+ * CONTRIBUTING: Fix grammar and layout (#1261, @olleolleolle)
161
+
162
+ ### Misc
163
+
164
+ * Replacing Net::HTTP::Persistent with faraday-net_http_persistent (#1250, @MikeRogers0)
165
+ * CI: Configure the regenerated Coveralls token (#1256, @olleolleolle)
166
+ * Replace Excon adapter with Faraday::Excon gem, and fix autoloading issue with Faraday::NetHttpPersistent (#1257, @iMacTia)
167
+ * Drop CodeClimate (#1259, @olleolleolle)
168
+ * CI: Rename default branch to main (#1263, @olleolleolle)
169
+ * Drop RDoc support file .document (#1264, @olleolleolle, @iMacTia)
170
+ * CONTRIBUTING: add a policy on inclusive language (#1262, @olleolleolle)
171
+ * Add rubocop-inclusivity (#1267, @olleolleolle, @iMacTia)
172
+
173
+ ## [v1.3.1](https://github.com/lostisland/faraday/releases/tag/v1.3.1) (2021-04-16)
174
+
175
+ ### Fixes
176
+
177
+ * Escape colon in path segment (#1237, @yarafan)
178
+ * Handle IPv6 address String on Faraday::Connection#proxy_from_env (#1252, @cosmo0920)
179
+
180
+ ### Documentation
181
+
182
+ * Fix broken Rubydoc.info links (#1236, @nickcampbell18)
183
+ * Add httpx to list of external adapters (#1246, @HoneyryderChuck)
184
+
185
+ ### Misc
186
+
187
+ * Refactor CI to remove duplicated line (#1230, @tricknotes)
188
+ * Gemspec: Pick a good ruby2_keywords release (#1241, @olleolleolle)
189
+
3
190
  ## [v1.3.0](https://github.com/lostisland/faraday/releases/tag/v1.3.0) (2020-12-31)
4
191
 
5
192
  ### Highlights
6
- Faraday v1.3.0 is the first release to officially support Ruby 3.0 in the CI pipeline 🎉 🍾!
193
+ Faraday v1.3.0 is the first release to officially support Ruby 3.0 in the CI pipeline 🎉 🍾!
7
194
 
8
195
  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
196
  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!
@@ -94,7 +281,7 @@ Many thanks to the Faraday Team, @JanDintel and everyone who attended the [ROSS
94
281
  * Allows `parse` method to be private/protected in response middleware (#1123)
95
282
  * Encode Spaces in Query Strings as '%20' Instead of '+' (#1125)
96
283
  * Limits rack to v2.0.x (#1127)
97
- * Adapter Registry reads also use mutex (#1136)
284
+ * Adapter Registry reads also use mutex (#1136)
98
285
 
99
286
  ### Documentation
100
287
 
@@ -104,7 +291,7 @@ Many thanks to the Faraday Team, @JanDintel and everyone who attended the [ROSS
104
291
  * Website: add search bar (#1116)
105
292
  * Fix request/response mix-up in docs text (#1132)
106
293
 
107
- ## v1.0
294
+ ## [v1.0](https://github.com/lostisland/faraday/releases/tag/v1.0.0) (2020-01-22)
108
295
 
109
296
  Features:
110
297
 
@@ -148,6 +335,13 @@ Misc:
148
335
  * Describe clearing cached stubs #1045 (@viraptor)
149
336
  * Add project metadata to the gemspec #1046 (@orien)
150
337
 
338
+ ## v0.17.4
339
+
340
+ Fixes:
341
+
342
+ * NetHttp adapter: wrap Errno::EADDRNOTAVAIL (#1114, @embs)
343
+ * Fix === for subclasses of deprecated classes (#1243, @mervync)
344
+
151
345
  ## v0.17.3
152
346
 
153
347
  Fixes:
data/LICENSE.md CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2009-2020 Rick Olson, Zack Hobson
1
+ Copyright (c) 2009-2023 Rick Olson, Zack Hobson
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining
4
4
  a copy of this software and associated documentation files (the
data/README.md CHANGED
@@ -1,25 +1,41 @@
1
- # [![Faraday](./docs/assets/img/repo-card-slim.png)][website]
1
+ # [![Faraday](./docs/_media/home-logo.svg)][website]
2
2
 
3
3
  [![Gem Version](https://badge.fury.io/rb/faraday.svg)](https://rubygems.org/gems/faraday)
4
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)
5
+ [![GitHub Discussions](https://img.shields.io/github/discussions/lostisland/faraday?logo=github)](https://github.com/lostisland/faraday/discussions)
6
6
 
7
+ Faraday is an HTTP client library abstraction layer that provides a common interface over many
8
+ adapters (such as Net::HTTP) and embraces the concept of Rack middleware when processing the request/response cycle.
9
+ Take a look at [Awesome Faraday][awesome] for a list of available adapters and middleware.
7
10
 
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.
11
+ ## Why use Faraday?
12
+
13
+ Faraday gives you the power of Rack middleware for manipulating HTTP requests and responses,
14
+ making it easier to build sophisticated API clients or web service libraries that abstract away
15
+ the details of how HTTP requests are made.
16
+
17
+ Faraday comes with a lot of features out of the box, such as:
18
+ * Support for multiple adapters (Net::HTTP, Typhoeus, Patron, Excon, HTTPClient, and more)
19
+ * Persistent connections (keep-alive)
20
+ * Parallel requests
21
+ * Automatic response parsing (JSON, XML, YAML)
22
+ * Customization of the request/response cycle with middleware
23
+ * Support for streaming responses
24
+ * Support for uploading files
25
+ * And much more!
11
26
 
12
27
  ## Getting Started
13
28
 
14
29
  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.
16
30
 
17
- ## Supported Ruby versions
31
+ Need more details? See the [Faraday API Documentation][apidoc] to see how it works internally, or take a look at [Advanced techniques for calling HTTP APIs in Ruby](https://mattbrictson.com/blog/advanced-http-techniques-in-ruby) blog post from [@mattbrictson](https://github.com/mattbrictson) 🚀
18
32
 
19
- This library aims to support and is [tested against][actions] the following Ruby
20
- implementations:
33
+ ## Supported Ruby versions
21
34
 
22
- * Ruby 2.4+
35
+ This library aims to support and is [tested against][actions] the currently officially supported Ruby
36
+ implementations. This means that, even without a major release, we could add or drop support for Ruby versions,
37
+ following their [EOL](https://endoflife.date/ruby).
38
+ Currently that means we support Ruby 2.6+
23
39
 
24
40
  If something doesn't work on one of these Ruby versions, it's a bug.
25
41
 
@@ -41,13 +57,11 @@ Open the issues page and check for the `help wanted` label!
41
57
  But before you start coding, please read our [Contributing Guide][contributing]
42
58
 
43
59
  ## 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
60
+
61
+ © 2009 - 2023, the Faraday Team. Website and branding design by [Elena Lo Piccolo](https://elelopic.design).
62
+
63
+ [awesome]: https://github.com/lostisland/awesome-faraday/#adapters
64
+ [website]: https://lostisland.github.io/faraday
65
+ [contributing]: https://github.com/lostisland/faraday/blob/main/.github/CONTRIBUTING.md
66
+ [apidoc]: https://www.rubydoc.info/github/lostisland/faraday
67
+ [actions]: https://github.com/lostisland/faraday/actions
data/Rakefile CHANGED
@@ -2,6 +2,8 @@
2
2
 
3
3
  require 'rspec/core/rake_task'
4
4
 
5
- RSpec::Core::RakeTask.new(:spec)
5
+ RSpec::Core::RakeTask.new(:spec) do |task|
6
+ task.ruby_opts = %w[-W]
7
+ end
6
8
 
7
9
  task default: :spec
@@ -12,10 +12,15 @@ class Client
12
12
  @conn = conn
13
13
  end
14
14
 
15
- def sushi(jname, params: {})
15
+ def httpbingo(jname, params: {})
16
16
  res = @conn.get("/#{jname}", params)
17
17
  data = JSON.parse(res.body)
18
- data['name']
18
+ data['origin']
19
+ end
20
+
21
+ def foo(params)
22
+ res = @conn.post('/foo', JSON.dump(params))
23
+ res.status
19
24
  end
20
25
  end
21
26
 
@@ -24,42 +29,42 @@ RSpec.describe Client do
24
29
  let(:conn) { Faraday.new { |b| b.adapter(:test, stubs) } }
25
30
  let(:client) { Client.new(conn) }
26
31
 
27
- it 'parses name' do
28
- stubs.get('/ebi') do |env|
32
+ it 'parses origin' do
33
+ stubs.get('/ip') do |env|
29
34
  # optional: you can inspect the Faraday::Env
30
- expect(env.url.path).to eq('/ebi')
35
+ expect(env.url.path).to eq('/ip')
31
36
  [
32
37
  200,
33
38
  { 'Content-Type': 'application/javascript' },
34
- '{"name": "shrimp"}'
39
+ '{"origin": "127.0.0.1"}'
35
40
  ]
36
41
  end
37
42
 
38
43
  # uncomment to trigger stubs.verify_stubbed_calls failure
39
44
  # stubs.get('/unused') { [404, {}, ''] }
40
45
 
41
- expect(client.sushi('ebi')).to eq('shrimp')
46
+ expect(client.httpbingo('ip')).to eq('127.0.0.1')
42
47
  stubs.verify_stubbed_calls
43
48
  end
44
49
 
45
50
  it 'handles 404' do
46
- stubs.get('/ebi') do
51
+ stubs.get('/api') do
47
52
  [
48
53
  404,
49
54
  { 'Content-Type': 'application/javascript' },
50
55
  '{}'
51
56
  ]
52
57
  end
53
- expect(client.sushi('ebi')).to be_nil
58
+ expect(client.httpbingo('api')).to be_nil
54
59
  stubs.verify_stubbed_calls
55
60
  end
56
61
 
57
62
  it 'handles exception' do
58
- stubs.get('/ebi') do
59
- raise Faraday::ConnectionFailed, nil
63
+ stubs.get('/api') do
64
+ raise Faraday::ConnectionFailed
60
65
  end
61
66
 
62
- expect { client.sushi('ebi') }.to raise_error(Faraday::ConnectionFailed)
67
+ expect { client.httpbingo('api') }.to raise_error(Faraday::ConnectionFailed)
63
68
  stubs.verify_stubbed_calls
64
69
  end
65
70
 
@@ -67,17 +72,17 @@ RSpec.describe Client do
67
72
  let(:stubs) { Faraday::Adapter::Test::Stubs.new(strict_mode: true) }
68
73
 
69
74
  it 'verifies the all parameter values are identical' do
70
- stubs.get('/ebi?abc=123') do
75
+ stubs.get('/api?abc=123') do
71
76
  [
72
77
  200,
73
78
  { 'Content-Type': 'application/javascript' },
74
- '{"name": "shrimp"}'
79
+ '{"origin": "127.0.0.1"}'
75
80
  ]
76
81
  end
77
82
 
78
83
  # uncomment to raise Stubs::NotFound
79
- # expect(client.sushi('ebi', params: { abc: 123, foo: 'Kappa' })).to eq('shrimp')
80
- expect(client.sushi('ebi', params: { abc: 123 })).to eq('shrimp')
84
+ # expect(client.httpbingo('api', params: { abc: 123, foo: 'Kappa' })).to eq('127.0.0.1')
85
+ expect(client.httpbingo('api', params: { abc: 123 })).to eq('127.0.0.1')
81
86
  stubs.verify_stubbed_calls
82
87
  end
83
88
  end
@@ -86,11 +91,28 @@ RSpec.describe Client do
86
91
  let(:conn) { Faraday.new(request: { params_encoder: Faraday::FlatParamsEncoder }) { |b| b.adapter(:test, stubs) } }
87
92
 
88
93
  it 'handles the same multiple URL parameters' do
89
- stubs.get('/ebi?a=x&a=y&a=z') { [200, { 'Content-Type' => 'application/json' }, '{"name": "shrimp"}'] }
94
+ stubs.get('/api?a=x&a=y&a=z') { [200, { 'Content-Type' => 'application/json' }, '{"origin": "127.0.0.1"}'] }
90
95
 
91
96
  # uncomment to raise Stubs::NotFound
92
- # expect(client.sushi('ebi', params: { a: %w[x y] })).to eq('shrimp')
93
- expect(client.sushi('ebi', params: { a: %w[x y z] })).to eq('shrimp')
97
+ # expect(client.httpbingo('api', params: { a: %w[x y] })).to eq('127.0.0.1')
98
+ expect(client.httpbingo('api', params: { a: %w[x y z] })).to eq('127.0.0.1')
99
+ stubs.verify_stubbed_calls
100
+ end
101
+ end
102
+
103
+ context 'When you want to test the body, you can use a proc as well as string' do
104
+ it 'tests with a string' do
105
+ stubs.post('/foo', '{"name":"YK"}') { [200, {}, ''] }
106
+
107
+ expect(client.foo(name: 'YK')).to eq 200
108
+ stubs.verify_stubbed_calls
109
+ end
110
+
111
+ it 'tests with a proc' do
112
+ check = ->(request_body) { JSON.parse(request_body).slice('name') == { 'name' => 'YK' } }
113
+ stubs.post('/foo', check) { [200, {}, ''] }
114
+
115
+ expect(client.foo(name: 'YK', created_at: Time.now)).to eq 200
94
116
  stubs.verify_stubbed_calls
95
117
  end
96
118
  end
@@ -13,24 +13,29 @@ class Client
13
13
  @conn = conn
14
14
  end
15
15
 
16
- def sushi(jname, params: {})
16
+ def httpbingo(jname, params: {})
17
17
  res = @conn.get("/#{jname}", params)
18
18
  data = JSON.parse(res.body)
19
- data['name']
19
+ data['origin']
20
+ end
21
+
22
+ def foo(params)
23
+ res = @conn.post('/foo', JSON.dump(params))
24
+ res.status
20
25
  end
21
26
  end
22
27
 
23
28
  # Example API client test
24
29
  class ClientTest < Test::Unit::TestCase
25
- def test_sushi_name
30
+ def test_httpbingo_name
26
31
  stubs = Faraday::Adapter::Test::Stubs.new
27
- stubs.get('/ebi') do |env|
32
+ stubs.get('/api') do |env|
28
33
  # optional: you can inspect the Faraday::Env
29
- assert_equal '/ebi', env.url.path
34
+ assert_equal '/api', env.url.path
30
35
  [
31
36
  200,
32
37
  { 'Content-Type': 'application/javascript' },
33
- '{"name": "shrimp"}'
38
+ '{"origin": "127.0.0.1"}'
34
39
  ]
35
40
  end
36
41
 
@@ -38,13 +43,13 @@ class ClientTest < Test::Unit::TestCase
38
43
  # stubs.get('/unused') { [404, {}, ''] }
39
44
 
40
45
  cli = client(stubs)
41
- assert_equal 'shrimp', cli.sushi('ebi')
46
+ assert_equal '127.0.0.1', cli.httpbingo('api')
42
47
  stubs.verify_stubbed_calls
43
48
  end
44
49
 
45
- def test_sushi_404
50
+ def test_httpbingo_not_found
46
51
  stubs = Faraday::Adapter::Test::Stubs.new
47
- stubs.get('/ebi') do
52
+ stubs.get('/api') do
48
53
  [
49
54
  404,
50
55
  { 'Content-Type': 'application/javascript' },
@@ -53,48 +58,48 @@ class ClientTest < Test::Unit::TestCase
53
58
  end
54
59
 
55
60
  cli = client(stubs)
56
- assert_nil cli.sushi('ebi')
61
+ assert_nil cli.httpbingo('api')
57
62
  stubs.verify_stubbed_calls
58
63
  end
59
64
 
60
- def test_sushi_exception
65
+ def test_httpbingo_exception
61
66
  stubs = Faraday::Adapter::Test::Stubs.new
62
- stubs.get('/ebi') do
63
- raise Faraday::ConnectionFailed, nil
67
+ stubs.get('/api') do
68
+ raise Faraday::ConnectionFailed
64
69
  end
65
70
 
66
71
  cli = client(stubs)
67
72
  assert_raise Faraday::ConnectionFailed do
68
- cli.sushi('ebi')
73
+ cli.httpbingo('api')
69
74
  end
70
75
  stubs.verify_stubbed_calls
71
76
  end
72
77
 
73
78
  def test_strict_mode
74
79
  stubs = Faraday::Adapter::Test::Stubs.new(strict_mode: true)
75
- stubs.get('/ebi?abc=123') do
80
+ stubs.get('/api?abc=123') do
76
81
  [
77
82
  200,
78
83
  { 'Content-Type': 'application/javascript' },
79
- '{"name": "shrimp"}'
84
+ '{"origin": "127.0.0.1"}'
80
85
  ]
81
86
  end
82
87
 
83
88
  cli = client(stubs)
84
- assert_equal 'shrimp', cli.sushi('ebi', params: { abc: 123 })
89
+ assert_equal '127.0.0.1', cli.httpbingo('api', params: { abc: 123 })
85
90
 
86
91
  # uncomment to raise Stubs::NotFound
87
- # assert_equal 'shrimp', cli.sushi('ebi', params: { abc: 123, foo: 'Kappa' })
92
+ # assert_equal '127.0.0.1', cli.httpbingo('api', params: { abc: 123, foo: 'Kappa' })
88
93
  stubs.verify_stubbed_calls
89
94
  end
90
95
 
91
96
  def test_non_default_params_encoder
92
97
  stubs = Faraday::Adapter::Test::Stubs.new(strict_mode: true)
93
- stubs.get('/ebi?a=x&a=y&a=z') do
98
+ stubs.get('/api?a=x&a=y&a=z') do
94
99
  [
95
100
  200,
96
101
  { 'Content-Type': 'application/javascript' },
97
- '{"name": "shrimp"}'
102
+ '{"origin": "127.0.0.1"}'
98
103
  ]
99
104
  end
100
105
  conn = Faraday.new(request: { params_encoder: Faraday::FlatParamsEncoder }) do |builder|
@@ -102,10 +107,31 @@ class ClientTest < Test::Unit::TestCase
102
107
  end
103
108
 
104
109
  cli = Client.new(conn)
105
- assert_equal 'shrimp', cli.sushi('ebi', params: { a: %w[x y z] })
110
+ assert_equal '127.0.0.1', cli.httpbingo('api', params: { a: %w[x y z] })
106
111
 
107
112
  # uncomment to raise Stubs::NotFound
108
- # assert_equal 'shrimp', cli.sushi('ebi', params: { a: %w[x y] })
113
+ # assert_equal '127.0.0.1', cli.httpbingo('api', params: { a: %w[x y] })
114
+ stubs.verify_stubbed_calls
115
+ end
116
+
117
+ def test_with_string_body
118
+ stubs = Faraday::Adapter::Test::Stubs.new do |stub|
119
+ stub.post('/foo', '{"name":"YK"}') { [200, {}, ''] }
120
+ end
121
+ cli = client(stubs)
122
+ assert_equal 200, cli.foo(name: 'YK')
123
+
124
+ stubs.verify_stubbed_calls
125
+ end
126
+
127
+ def test_with_proc_body
128
+ stubs = Faraday::Adapter::Test::Stubs.new do |stub|
129
+ check = ->(request_body) { JSON.parse(request_body).slice('name') == { 'name' => 'YK' } }
130
+ stub.post('/foo', check) { [200, {}, ''] }
131
+ end
132
+ cli = client(stubs)
133
+ assert_equal 200, cli.foo(name: 'YK', created_at: Time.now)
134
+
109
135
  stubs.verify_stubbed_calls
110
136
  end
111
137