faraday 0.11.0 → 0.17.4

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 (65) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +232 -0
  3. data/LICENSE.md +1 -1
  4. data/README.md +151 -13
  5. data/Rakefile +13 -0
  6. data/lib/faraday/adapter/em_http.rb +9 -9
  7. data/lib/faraday/adapter/em_synchrony.rb +5 -5
  8. data/lib/faraday/adapter/excon.rb +6 -4
  9. data/lib/faraday/adapter/httpclient.rb +5 -5
  10. data/lib/faraday/adapter/net_http.rb +27 -9
  11. data/lib/faraday/adapter/net_http_persistent.rb +34 -16
  12. data/lib/faraday/adapter/patron.rb +32 -13
  13. data/lib/faraday/adapter/rack.rb +1 -1
  14. data/lib/faraday/adapter/test.rb +21 -13
  15. data/lib/faraday/adapter/typhoeus.rb +4 -115
  16. data/lib/faraday/adapter.rb +2 -0
  17. data/lib/faraday/autoload.rb +1 -1
  18. data/lib/faraday/connection.rb +59 -12
  19. data/lib/faraday/deprecate.rb +109 -0
  20. data/lib/faraday/error.rb +130 -35
  21. data/lib/faraday/options.rb +31 -25
  22. data/lib/faraday/parameters.rb +2 -1
  23. data/lib/faraday/rack_builder.rb +26 -2
  24. data/lib/faraday/request/multipart.rb +7 -2
  25. data/lib/faraday/request/retry.rb +76 -17
  26. data/lib/faraday/request.rb +20 -0
  27. data/lib/faraday/response/logger.rb +3 -3
  28. data/lib/faraday/response/raise_error.rb +7 -3
  29. data/lib/faraday/response.rb +3 -3
  30. data/lib/faraday/utils.rb +18 -9
  31. data/lib/faraday.rb +9 -5
  32. data/spec/faraday/deprecate_spec.rb +147 -0
  33. data/spec/faraday/error_spec.rb +102 -0
  34. data/spec/faraday/response/raise_error_spec.rb +106 -0
  35. data/spec/spec_helper.rb +105 -0
  36. data/test/adapters/default_test.rb +14 -0
  37. data/test/adapters/em_http_test.rb +30 -0
  38. data/test/adapters/em_synchrony_test.rb +32 -0
  39. data/test/adapters/excon_test.rb +30 -0
  40. data/test/adapters/httpclient_test.rb +34 -0
  41. data/test/adapters/integration.rb +263 -0
  42. data/test/adapters/logger_test.rb +136 -0
  43. data/test/adapters/net_http_persistent_test.rb +114 -0
  44. data/test/adapters/net_http_test.rb +79 -0
  45. data/test/adapters/patron_test.rb +40 -0
  46. data/test/adapters/rack_test.rb +38 -0
  47. data/test/adapters/test_middleware_test.rb +157 -0
  48. data/test/adapters/typhoeus_test.rb +38 -0
  49. data/test/authentication_middleware_test.rb +65 -0
  50. data/test/composite_read_io_test.rb +109 -0
  51. data/test/connection_test.rb +738 -0
  52. data/test/env_test.rb +268 -0
  53. data/test/helper.rb +75 -0
  54. data/test/live_server.rb +67 -0
  55. data/test/middleware/instrumentation_test.rb +88 -0
  56. data/test/middleware/retry_test.rb +282 -0
  57. data/test/middleware_stack_test.rb +260 -0
  58. data/test/multibyte.txt +1 -0
  59. data/test/options_test.rb +333 -0
  60. data/test/parameters_test.rb +157 -0
  61. data/test/request_middleware_test.rb +126 -0
  62. data/test/response_middleware_test.rb +72 -0
  63. data/test/strawberry.rb +2 -0
  64. data/test/utils_test.rb +98 -0
  65. metadata +48 -7
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 88d17f843f96e641d4cb8b87b360b99adfee6c53
4
- data.tar.gz: 3c0031b2fa042939cc5e7f27aefa00f8ebe6a97f
2
+ SHA256:
3
+ metadata.gz: b53b5c1f4239a1b798cc39d21c2ba204f1f1682c68650dfd5abd2a15acad8f4c
4
+ data.tar.gz: 494d3b48b2b5cbd07433d786e3dcac4570c5a8319b6bdbbba481957ec18ad667
5
5
  SHA512:
6
- metadata.gz: 03fa51e8008930909fb2e5f40afe8f3d59d176574a084e364569d256b0c073bd06796bb0fe96f79c42cfacda2ee8417fecb1b3fc13e5b46bbb76f960136d116c
7
- data.tar.gz: 16432e693c7c666ac40de8a03ca890f08ee1cba705477afd31d64346282f018abf9ee617e1996330bbe2b2c3352021683e386522d700c49d08246b77d36fb65a
6
+ metadata.gz: e473d6f5f690de91f62283db0364e3a304077dd3445b924a9636a7691593d8d7abf715d5e1ccd7838364a85d4e8611bc4c7d6ab1195b5f0c30d24e32a9d6946c
7
+ data.tar.gz: 84f629bd1dce5dc09637fec05c46d8f78d018b7f89adc4b7a945e50f3edc0cc2077733ca74b41b92e5afb02876f25168b6e40832cf40bebe5c9b63d53fe6a9ac
data/CHANGELOG.md ADDED
@@ -0,0 +1,232 @@
1
+ # Faraday Changelog
2
+
3
+ ## v0.17.3
4
+
5
+ Fixes:
6
+
7
+ * Reverts changes in error classes hierarchy. #1092 (@iMacTia)
8
+ * Fix Ruby 1.9 syntax errors and improve Error class testing #1094 (@BanzaiMan,
9
+ @mrexox, @technoweenie)
10
+
11
+ Misc:
12
+
13
+ * Stops using `&Proc.new` for block forwarding. #1083 (@olleolleolle)
14
+ * Update CI to test against ruby 2.0-2.7 #1087, #1099 (@iMacTia, @olleolleolle,
15
+ @technoweenie)
16
+ * require FARADAY_DEPRECATE=warn to show Faraday v1.0 deprecation warnings
17
+ #1098 (@technoweenie)
18
+
19
+ ## v0.17.1
20
+
21
+ Final release before Faraday v1.0, with important fixes for Ruby 2.7.
22
+
23
+ Fixes:
24
+
25
+ * RaiseError response middleware raises exception if HTTP client returns a nil
26
+ status. #1042 (@jonnyom, @BobbyMcWho)
27
+
28
+ Misc:
29
+
30
+ * Fix Ruby 2.7 warnings (#1009)
31
+ * Add `Faraday::Deprecate` to warn about upcoming v1.0 changes. (#1054, #1059,
32
+ #1076, #1077)
33
+ * Add release notes up to current in CHANGELOG.md (#1066)
34
+ * Port minimal rspec suite from main branch to run backported tests. (#1058)
35
+
36
+ ## v0.17.0
37
+
38
+ This release is the same as v0.15.4. It was pushed to cover up releases
39
+ v0.16.0-v0.16.2.
40
+
41
+ ## v0.15.4
42
+
43
+ * Expose `pool_size` as a option for the NetHttpPersistent adapter (#834)
44
+
45
+ ## v0.15.3
46
+
47
+ * Make Faraday::Request serialisable with Marshal. (#803)
48
+ * Add DEFAULT_EXCEPTIONS constant to Request::Retry (#814)
49
+ * Add support for Ruby 2.6 Net::HTTP write_timeout (#824)
50
+
51
+ ## v0.15.2
52
+
53
+ * Prevents `Net::HTTP` adapters to retry request internally by setting `max_retries` to 0 if available (Ruby 2.5+). (#799)
54
+ * Fixes `NestedParamsEncoder` handling of empty array values (#801)
55
+
56
+ ## v0.15.1
57
+
58
+ * NetHttpPersistent adapter better reuse of SSL connections (#793)
59
+ * Refactor: inline cached_connection (#797)
60
+ * Logger middleware: use $stdout instead of STDOUT (#794)
61
+ * Fix: do not memoize/reuse Patron session (#796)
62
+
63
+ Also in this release:
64
+
65
+ * Allow setting min/max ssl version for Net::HTTP (#792)
66
+ * Allow setting min/max ssl version for Excon (#795)
67
+
68
+ ## v0.15.0
69
+
70
+ Features:
71
+
72
+ * Added retry block option to retry middleware. (#770)
73
+ * Retry middleware improvements (honour Retry-After header, retry statuses) (#773)
74
+ * Improve response logger middleware output (#784)
75
+
76
+ Fixes:
77
+
78
+ * Remove unused class error (#767)
79
+ * Fix minor typo in README (#760)
80
+ * Reuse persistent connections when using net-http-persistent (#778)
81
+ * Fix Retry middleware documentation (#781)
82
+ * Returns the http response when giving up on retrying by status (#783)
83
+
84
+ ## v0.14.0
85
+
86
+ Features:
87
+
88
+ * Allow overriding env proxy (#754)
89
+ * Remove legacy Typhoeus adapter (#715)
90
+ * External Typhoeus Adapter Compatibility (#748)
91
+ * Warn about missing adapter when making a request (#743)
92
+ * Faraday::Adapter::Test stubs now support entire urls (with host) (#741)
93
+
94
+ Fixes:
95
+
96
+ * If proxy is manually provided, this takes priority over `find_proxy` (#724)
97
+ * Fixes the behaviour for Excon's open_timeout (not setting write_timeout anymore) (#731)
98
+ * Handle all connection timeout messages in Patron (#687)
99
+
100
+ ## v0.13.1
101
+
102
+ * Fixes an incompatibility with Addressable::URI being used as uri_parser
103
+
104
+ ## v0.13.0
105
+
106
+ Features:
107
+
108
+ * Dynamically reloads the proxy when performing a request on an absolute domain (#701)
109
+ * Adapter support for Net::HTTP::Persistent v3.0.0 (#619)
110
+
111
+ Fixes:
112
+
113
+ * Prefer #hostname over #host. (#714)
114
+ * Fixes an edge-case issue with response headers parsing (missing HTTP header) (#719)
115
+
116
+ ## v0.12.2
117
+
118
+ * Parse headers from aggregated proxy requests/responses (#681)
119
+ * Guard against invalid middleware configuration with warning (#685)
120
+ * Do not use :insecure option by default in Patron (#691)
121
+ * Fixes an issue with HTTPClient not raising a `Faraday::ConnectionFailed` (#702)
122
+ * Fixes YAML serialization/deserialization for `Faraday::Utils::Headers` (#690)
123
+ * Fixes an issue with Options having a nil value (#694)
124
+ * Fixes an issue with Faraday.default_connection not using Faraday.default_connection_options (#698)
125
+ * Fixes an issue with Options.merge! and Faraday instrumentation middleware (#710)
126
+
127
+ ## v0.12.1
128
+
129
+ * Fix an issue with Patron tests failing on jruby
130
+ * Fix an issue with new `rewind_files` feature that was causing an exception when the body was not an Hash
131
+ * Expose wrapped_exception in all client errors
132
+ * Add Authentication Section to the ReadMe
133
+
134
+ ## v0.12.0.1
135
+
136
+ * Hotfix release to address an issue with TravisCI deploy on Rubygems
137
+
138
+ ## v0.12.0
139
+
140
+ Features:
141
+
142
+ * Proxy feature now relies on Ruby `URI::Generic#find_proxy` and can use `no_proxy` ENV variable (not compatible with ruby < 2.0)
143
+ * Adds support for `context` request option to pass arbitrary information to middlewares
144
+
145
+ Fixes:
146
+
147
+ * Fix an issue with options that was causing new options to override defaults ones unexpectedly
148
+ * Rewind `UploadIO`s on retry to fix a compatibility issue
149
+ * Make multipart boundary unique
150
+ * Improvements in `README.md`
151
+
152
+ ## v0.11.0
153
+
154
+ Features:
155
+
156
+ * Add `filter` method to Logger middleware
157
+ * Add support for Ruby2.4 and Minitest 6
158
+ * Introduce block syntax to customise the adapter
159
+
160
+ Fixes:
161
+
162
+ * Fix an issue that was allowing to override `default_connection_options` from a connection instance
163
+ * Fix a bug that was causing newline escape characters ("\n") to be used when building the Authorization header
164
+
165
+ ## v0.10.1
166
+
167
+ - Fix an issue with HTTPClient adapter that was causing the SSL to be reset on every request
168
+ - Rescue `IOError` instead of specific subclass
169
+ - `Faraday::Utils::Headers` can now be successfully serialised in YAML
170
+ - Handle `default_connection_options` set with hash
171
+
172
+ ## v0.10.0
173
+
174
+ Breaking changes:
175
+ - Drop support for Ruby 1.8
176
+
177
+ Features:
178
+ - Include wrapped exception/reponse in ClientErrors
179
+ - Add `response.reason_phrase`
180
+ - Provide option to selectively skip logging request/response headers
181
+ - Add regex support for pattern matching in `test` adapter
182
+
183
+ Fixes:
184
+ - Add `Faraday.respond_to?` to find methods managed by `method_missing`
185
+ - em-http: `request.host` instead of `connection.host` should be taken for SSL validations
186
+ - Allow `default_connection_options` to be merged when options are passed as url parameter
187
+ - Improve splitting key-value pairs in raw HTTP headers
188
+
189
+ ## v0.9.2
190
+
191
+ Adapters:
192
+ - Enable gzip compression for httpclient
193
+ - Fixes default certificate store for httpclient not having default paths.
194
+ - Make excon adapter compatible with 0.44 excon version
195
+ - Add compatibility with Patron 0.4.20
196
+ - Determine default port numbers in Net::HTTP adapters (Addressable compatibility)
197
+ - em-http: wrap "connection closed by server" as ConnectionFailed type
198
+ - Wrap Errno::ETIMEDOUT in Faraday::Error::TimeoutError
199
+
200
+ Utils:
201
+ - Add Rack-compatible support for parsing `a[][b]=c` nested queries
202
+ - Encode nil values in queries different than empty strings. Before: `a=`; now: `a`.
203
+ - Have `Faraday::Utils::Headers#replace` clear internal key cache
204
+ - Dup the internal key cache when a Headers hash is copied
205
+
206
+ Env and middleware:
207
+ - Ensure `env` stored on middleware response has reference to the response
208
+ - Ensure that Response properties are initialized during `on_complete` (VCR compatibility)
209
+ - Copy request options in Faraday::Connection#dup
210
+ - Env custom members should be copied by Env.from(env)
211
+ - Honour per-request `request.options.params_encoder`
212
+ - Fix `interval_randomness` data type for Retry middleware
213
+ - Add maximum interval option for Retry middleware
214
+
215
+ ## v0.9.1
216
+
217
+ * Refactor Net:HTTP adapter so that with_net_http_connection can be overridden to allow pooled connections. (@Ben-M)
218
+ * Add configurable methods that bypass `retry_if` in the Retry request middleware. (@mike-bourgeous)
219
+
220
+ ## v0.9.0
221
+
222
+ * Add HTTPClient adapter (@hakanensari)
223
+ * Improve Retry handler (@mislav)
224
+ * Remove autoloading by default (@technoweenie)
225
+ * Improve internal docs (@technoweenie, @mislav)
226
+ * Respect user/password in http proxy string (@mislav)
227
+ * Adapter options are structs. Reinforces consistent options across adapters
228
+ (@technoweenie)
229
+ * Stop stripping trailing / off base URLs in a Faraday::Connection. (@technoweenie)
230
+ * Add a configurable URI parser. (@technoweenie)
231
+ * Remove need to manually autoload when using the authorization header helpers on `Faraday::Connection`. (@technoweenie)
232
+ * `Faraday::Adapter::Test` respects the `Faraday::RequestOptions#params_encoder` option. (@technoweenie)
data/LICENSE.md CHANGED
@@ -1,4 +1,4 @@
1
- Copyright (c) 2009-2015 Rick Olson, Zack Hobson
1
+ Copyright (c) 2009-2017 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,19 +1,29 @@
1
1
  # Faraday
2
2
 
3
+ [![Gem Version](https://badge.fury.io/rb/faraday.svg)](https://rubygems.org/gems/faraday)
4
+ [![Build Status](https://travis-ci.org/lostisland/faraday.svg?branch=master)](https://travis-ci.org/lostisland/faraday)
5
+ [![Coverage Status](https://coveralls.io/repos/github/lostisland/faraday/badge.svg?branch=master)](https://coveralls.io/github/lostisland/faraday?branch=master)
6
+ [![Code Climate](https://codeclimate.com/github/lostisland/faraday/badges/gpa.svg)](https://codeclimate.com/github/lostisland/faraday)
7
+ [![Gitter](https://badges.gitter.im/lostisland/faraday.svg)](https://gitter.im/lostisland/faraday?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
8
+
9
+
3
10
  Faraday is an HTTP client lib that provides a common interface over many
4
11
  adapters (such as Net::HTTP) and embraces the concept of Rack middleware when
5
12
  processing the request/response cycle.
6
13
 
7
- Faraday supports these adapters:
14
+ Faraday supports these adapters out of the box:
8
15
 
9
16
  * [Net::HTTP][net_http] _(default)_
10
17
  * [Net::HTTP::Persistent][persistent]
11
18
  * [Excon][]
12
- * [Typhoeus][]
13
19
  * [Patron][]
14
20
  * [EventMachine][]
15
21
  * [HTTPClient][]
16
22
 
23
+ Adapters are slowly being moved into their own gems, or bundled with HTTP clients:
24
+
25
+ * [Typhoeus][]
26
+
17
27
  It also includes a Rack adapter for hitting loaded Rack applications through
18
28
  Rack::Test, and a Test adapter for stubbing requests by hand.
19
29
 
@@ -21,23 +31,58 @@ Rack::Test, and a Test adapter for stubbing requests by hand.
21
31
 
22
32
  Available at [rubydoc.info](http://www.rubydoc.info/gems/faraday).
23
33
 
34
+ ## Faraday 1.0
35
+
36
+ Faraday 1.0 will ship soon! Faraday 0.17 will be the last 0.x release, except for serious bugs or security issues.
37
+ Faraday 1.0 is a major release, but it will be mostly backwards-compatible with 0.x, so we strongly encourage you
38
+ to use it on your next projects and/or consider to upgrade your existing ones.
39
+ Upgrading is simple:
40
+
41
+ * Checkout the new code from [`master`](https://github.com/lostisland/faraday) and the new [Documentation Website](https://lostisland.github.io/faraday/).
42
+ * If you're upgrading an existing project, check the [UPGRADING](https://github.com/lostisland/faraday/blob/master/UPGRADING.md) file.
43
+ * You can also enable upgrade warnings on apps with Faraday 0.x if you run them with `FARADAY_DEPRECATE=warn` or `FARADAY_DEPRECATE=1` in ENV.
44
+
24
45
  ## Usage
25
46
 
47
+ ### Basic Use
48
+
49
+ ```ruby
50
+ response = Faraday.get 'http://sushi.com/nigiri/sake.json'
51
+ ```
52
+ A simple `get` request can be performed by using the syntax described above. This works if you don't need to set up anything; you can roll with just the default middleware
53
+ stack and default adapter (see [Faraday::RackBuilder#initialize](https://github.com/lostisland/faraday/blob/master/lib/faraday/rack_builder.rb)).
54
+
55
+ A more flexible way to use Faraday is to start with a Connection object. If you want to keep the same defaults, you can use this syntax:
56
+
57
+ ```ruby
58
+ conn = Faraday.new(:url => 'http://www.example.com')
59
+ response = conn.get '/users' # GET http://www.example.com/users'
60
+ ```
61
+
62
+ Connections can also take an options hash as a parameter or be configured by using a block. Checkout the section called [Advanced middleware usage](#advanced-middleware-usage) for more details about how to use this block for configurations.
63
+ Since the default middleware stack uses url\_encoded middleware and default adapter, use them on building your own middleware stack.
64
+
26
65
  ```ruby
27
66
  conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
28
67
  faraday.request :url_encoded # form-encode POST params
29
- faraday.response :logger # log requests to STDOUT
68
+ faraday.response :logger # log requests to $stdout
30
69
  faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
31
70
  end
32
71
 
33
72
  # Filter sensitive information from logs with a regex matcher
34
73
 
35
74
  conn = Faraday.new(:url => 'http://sushi.com/api_key=s3cr3t') do |faraday|
75
+ faraday.request :url_encoded # form-encode POST params
36
76
  faraday.response :logger do | logger |
37
77
  logger.filter(/(api_key=)(\w+)/,'\1[REMOVED]')
38
78
  end
79
+ faraday.adapter Faraday.default_adapter # make requests with Net::HTTP
39
80
  end
81
+ ```
82
+
83
+ Once you have the connection object, use it to make HTTP requests. You can pass parameters to it in a few different ways:
40
84
 
85
+ ```ruby
41
86
  ## GET ##
42
87
 
43
88
  response = conn.get '/nigiri/sake.json' # GET http://sushi.com/nigiri/sake.json
@@ -53,7 +98,11 @@ end
53
98
  ## POST ##
54
99
 
55
100
  conn.post '/nigiri', { :name => 'Maguro' } # POST "name=maguro" to http://sushi.com/nigiri
101
+ ```
56
102
 
103
+ Some configuration options can be adjusted per request:
104
+
105
+ ```ruby
57
106
  # post payload as JSON instead of "www-form-urlencoded" encoding:
58
107
  conn.post do |req|
59
108
  req.url '/nigiri'
@@ -70,11 +119,18 @@ conn.get do |req|
70
119
  end
71
120
  ```
72
121
 
73
- If you don't need to set up anything, you can roll with just the default middleware
74
- stack and default adapter (see [Faraday::RackBuilder#initialize](https://github.com/lostisland/faraday/blob/master/lib/faraday/rack_builder.rb)):
122
+ And you can inject arbitrary data into the request using the `context` option:
75
123
 
76
124
  ```ruby
77
- response = Faraday.get 'http://sushi.com/nigiri/sake.json'
125
+ # Anything you inject using context option will be available in the env on all middlewares
126
+
127
+ conn.get do |req|
128
+ req.url '/search'
129
+ req.options.context = {
130
+ foo: 'foo',
131
+ bar: 'bar'
132
+ }
133
+ end
78
134
  ```
79
135
 
80
136
  ### Changing how parameters are serialized
@@ -103,6 +159,36 @@ The value of Faraday `params_encoder` can be any object that responds to:
103
159
  The encoder will affect both how query strings are processed and how POST bodies
104
160
  get serialized. The default encoder is Faraday::NestedParamsEncoder.
105
161
 
162
+ ## Authentication
163
+
164
+ Basic and Token authentication are handled by Faraday::Request::BasicAuthentication and Faraday::Request::TokenAuthentication respectively. These can be added as middleware manually or through the helper methods.
165
+
166
+ ```ruby
167
+ Faraday.new(...) do |conn|
168
+ conn.basic_auth('username', 'password')
169
+ end
170
+
171
+ Faraday.new(...) do |conn|
172
+ conn.token_auth('authentication-token')
173
+ end
174
+ ```
175
+
176
+ ## Proxy
177
+
178
+ Faraday will try to automatically infer the proxy settings from your system using `URI#find_proxy`.
179
+ This will retrieve them from environment variables such as http_proxy, ftp_proxy, no_proxy, etc.
180
+ If for any reason you want to disable this behaviour, you can do so by setting the global varibale `ignore_env_proxy`:
181
+
182
+ ```ruby
183
+ Faraday.ignore_env_proxy = true
184
+ ```
185
+
186
+ You can also specify a custom proxy when initializing the connection
187
+
188
+ ```ruby
189
+ Faraday.new('http://www.example.com', :proxy => 'http://proxy.com')
190
+ ```
191
+
106
192
  ## Advanced middleware usage
107
193
 
108
194
  The order in which middleware is stacked is important. Like with Rack, the
@@ -114,7 +200,11 @@ Faraday.new(...) do |conn|
114
200
  # POST/PUT params encoders:
115
201
  conn.request :multipart
116
202
  conn.request :url_encoded
203
+
204
+ # add custom middleware
205
+ conn.use MyMiddleware
117
206
 
207
+ # Last middleware must be the adapter:
118
208
  conn.adapter :net_http
119
209
  end
120
210
  ```
@@ -177,6 +267,53 @@ later, response. Some keys are:
177
267
  :response_headers
178
268
  ```
179
269
 
270
+ ## Ad-hoc adapters customization
271
+
272
+ Faraday is intended to be a generic interface between your code and the adapter. However, sometimes you need to access a feature specific to one of the adapters that is not covered in Faraday's interface.
273
+
274
+ When that happens, you can pass a block when specifying the adapter to customize it. The block parameter will change based on the adapter you're using. See below for some examples.
275
+
276
+ ### NetHttp
277
+ ```ruby
278
+ conn = Faraday.new(...) do |f|
279
+ f.adapter :net_http do |http| # yields Net::HTTP
280
+ http.idle_timeout = 100
281
+ http.verify_callback = lambda do | preverify_ok, cert_store |
282
+ # do something here...
283
+ end
284
+ end
285
+ end
286
+ ```
287
+
288
+ ### NetHttpPersistent
289
+ ```ruby
290
+ conn = Faraday.new(...) do |f|
291
+ f.adapter :net_http_persistent, pool_size: 5 do |http| # yields Net::HTTP::Persistent
292
+ http.idle_timeout = 100
293
+ http.retry_change_requests = true
294
+ end
295
+ end
296
+ ```
297
+
298
+ ### Patron
299
+ ```ruby
300
+ conn = Faraday.new(...) do |f|
301
+ f.adapter :patron do |session| # yields Patron::Session
302
+ session.max_redirects = 10
303
+ end
304
+ end
305
+ ```
306
+
307
+ ### HTTPClient
308
+ ```ruby
309
+ conn = Faraday.new(...) do |f|
310
+ f.adapter :httpclient do |client| # yields HTTPClient
311
+ client.keep_alive_timeout = 20
312
+ client.ssl_config.timeout = 25
313
+ end
314
+ end
315
+ ```
316
+
180
317
  ## Using Faraday for testing
181
318
 
182
319
  ```ruby
@@ -212,11 +349,6 @@ resp = test.get '/else' #=> raises "no such stub" error
212
349
  stubs.verify_stubbed_calls
213
350
  ```
214
351
 
215
- ## TODO
216
-
217
- * support streaming requests/responses
218
- * better stubbing API
219
-
220
352
  ## Supported Ruby versions
221
353
 
222
354
  This library aims to support and is [tested against][travis] the following Ruby
@@ -239,19 +371,25 @@ implementation, you will be responsible for providing patches in a timely
239
371
  fashion. If critical issues for a particular implementation exist at the time
240
372
  of a major release, support for that Ruby version may be dropped.
241
373
 
374
+ ## Contribute
375
+
376
+ Do you want to contribute to Faraday?
377
+ Open the issues page and check for the `help wanted` label!
378
+ But before you start coding, please read our [Contributing Guide](https://github.com/lostisland/faraday/blob/master/.github/CONTRIBUTING.md)
379
+
242
380
  ## Copyright
243
381
 
244
- Copyright (c) 2009-2013 [Rick Olson](mailto:technoweenie@gmail.com), Zack Hobson.
382
+ Copyright (c) 2009-2017 [Rick Olson](mailto:technoweenie@gmail.com), Zack Hobson.
245
383
  See [LICENSE][] for details.
246
384
 
247
385
  [net_http]: http://ruby-doc.org/stdlib/libdoc/net/http/rdoc/Net/HTTP.html
248
386
  [persistent]: https://github.com/drbrain/net-http-persistent
249
387
  [travis]: https://travis-ci.org/lostisland/faraday
250
388
  [excon]: https://github.com/excon/excon#readme
251
- [typhoeus]: https://github.com/typhoeus/typhoeus#readme
252
389
  [patron]: http://toland.github.io/patron/
253
390
  [eventmachine]: https://github.com/igrigorik/em-http-request#readme
254
391
  [httpclient]: https://github.com/nahi/httpclient
392
+ [typhoeus]: https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/adapters/faraday.rb
255
393
  [jruby]: http://jruby.org/
256
394
  [rubinius]: http://rubini.us/
257
395
  [license]: LICENSE.md
data/Rakefile ADDED
@@ -0,0 +1,13 @@
1
+ # frozen_string_literal: true
2
+
3
+ require 'rake/testtask'
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ task :default => :test
9
+
10
+ desc "Run all tests"
11
+ task :test => :spec do
12
+ exec 'script/test'
13
+ end
@@ -124,9 +124,9 @@ module Faraday
124
124
  end
125
125
  rescue EventMachine::Connectify::CONNECTError => err
126
126
  if err.message.include?("Proxy Authentication Required")
127
- raise Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
127
+ raise Faraday::ConnectionFailed, %{407 "Proxy Authentication Required "}
128
128
  else
129
- raise Error::ConnectionFailed, err
129
+ raise Faraday::ConnectionFailed, err
130
130
  end
131
131
  rescue => err
132
132
  if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
@@ -159,15 +159,15 @@ module Faraday
159
159
  end
160
160
 
161
161
  def raise_error(msg)
162
- errklass = Faraday::Error::ClientError
162
+ errklass = Faraday::ClientError
163
163
  if msg == Errno::ETIMEDOUT
164
- errklass = Faraday::Error::TimeoutError
164
+ errklass = Faraday::TimeoutError
165
165
  msg = "request timed out"
166
166
  elsif msg == Errno::ECONNREFUSED
167
- errklass = Faraday::Error::ConnectionFailed
167
+ errklass = Faraday::ConnectionFailed
168
168
  msg = "connection refused"
169
169
  elsif msg == "connection closed by server"
170
- errklass = Faraday::Error::ConnectionFailed
170
+ errklass = Faraday::ConnectionFailed
171
171
  end
172
172
  raise errklass, msg
173
173
  end
@@ -193,11 +193,11 @@ module Faraday
193
193
 
194
194
  def running?() @running end
195
195
 
196
- def add
196
+ def add(&block)
197
197
  if running?
198
198
  perform_request { yield }
199
199
  else
200
- @registered_procs << Proc.new
200
+ @registered_procs << block
201
201
  end
202
202
  @num_registered += 1
203
203
  end
@@ -211,7 +211,7 @@ module Faraday
211
211
  end
212
212
  end
213
213
  if @errors.size > 0
214
- raise Faraday::Error::ClientError, @errors.first || "connection failed"
214
+ raise Faraday::ClientError, @errors.first || "connection failed"
215
215
  end
216
216
  end
217
217
  ensure
@@ -65,18 +65,18 @@ module Faraday
65
65
 
66
66
  @app.call env
67
67
  rescue Errno::ECONNREFUSED
68
- raise Error::ConnectionFailed, $!
68
+ raise Faraday::ConnectionFailed, $!
69
69
  rescue EventMachine::Connectify::CONNECTError => err
70
70
  if err.message.include?("Proxy Authentication Required")
71
- raise Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
71
+ raise Faraday::ConnectionFailed, %{407 "Proxy Authentication Required "}
72
72
  else
73
- raise Error::ConnectionFailed, err
73
+ raise Faraday::ConnectionFailed, err
74
74
  end
75
75
  rescue Errno::ETIMEDOUT => err
76
- raise Error::TimeoutError, err
76
+ raise Faraday::TimeoutError, err
77
77
  rescue RuntimeError => err
78
78
  if err.message == "connection closed by server"
79
- raise Error::ConnectionFailed, err
79
+ raise Faraday::ConnectionFailed, err
80
80
  else
81
81
  raise
82
82
  end
@@ -15,6 +15,9 @@ module Faraday
15
15
  opts[:client_key] = ssl[:client_key] if ssl[:client_key]
16
16
  opts[:certificate] = ssl[:certificate] if ssl[:certificate]
17
17
  opts[:private_key] = ssl[:private_key] if ssl[:private_key]
18
+ opts[:ssl_version] = ssl[:version] if ssl[:version]
19
+ opts[:ssl_min_version] = ssl[:min_version] if ssl[:min_version]
20
+ opts[:ssl_max_version] = ssl[:max_version] if ssl[:max_version]
18
21
 
19
22
  # https://github.com/geemus/excon/issues/106
20
23
  # https://github.com/jruby/jruby-ossl/issues/19
@@ -30,7 +33,6 @@ module Faraday
30
33
 
31
34
  if req[:open_timeout]
32
35
  opts[:connect_timeout] = req[:open_timeout]
33
- opts[:write_timeout] = req[:open_timeout]
34
36
  end
35
37
 
36
38
  if req[:proxy]
@@ -57,14 +59,14 @@ module Faraday
57
59
  @app.call env
58
60
  rescue ::Excon::Errors::SocketError => err
59
61
  if err.message =~ /\btimeout\b/
60
- raise Error::TimeoutError, err
62
+ raise Faraday::TimeoutError, err
61
63
  elsif err.message =~ /\bcertificate\b/
62
64
  raise Faraday::SSLError, err
63
65
  else
64
- raise Error::ConnectionFailed, err
66
+ raise Faraday::ConnectionFailed, err
65
67
  end
66
68
  rescue ::Excon::Errors::Timeout => err
67
- raise Error::TimeoutError, err
69
+ raise Faraday::TimeoutError, err
68
70
  end
69
71
 
70
72
  def create_connection(env, opts)
@@ -43,15 +43,15 @@ module Faraday
43
43
 
44
44
  @app.call env
45
45
  rescue ::HTTPClient::TimeoutError, Errno::ETIMEDOUT
46
- raise Faraday::Error::TimeoutError, $!
46
+ raise Faraday::TimeoutError, $!
47
47
  rescue ::HTTPClient::BadResponseError => err
48
48
  if err.message.include?('status 407')
49
- raise Faraday::Error::ConnectionFailed, %{407 "Proxy Authentication Required "}
49
+ raise Faraday::ConnectionFailed, %{407 "Proxy Authentication Required "}
50
50
  else
51
- raise Faraday::Error::ClientError, $!
51
+ raise Faraday::ClientError, $!
52
52
  end
53
- rescue Errno::ECONNREFUSED, IOError
54
- raise Faraday::Error::ConnectionFailed, $!
53
+ rescue Errno::ECONNREFUSED, IOError, SocketError
54
+ raise Faraday::ConnectionFailed, $!
55
55
  rescue => err
56
56
  if defined?(OpenSSL) && OpenSSL::SSL::SSLError === err
57
57
  raise Faraday::SSLError, err