faraday-retry 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b07a16fd11fb4fcc1041260ad3e7341f40762eef86984f23ee5785c1c15b4334
-  data.tar.gz: 3551328efd8212c9f2079ce2e4b2b192271bfccc3c4df337f921f9403fefd742
+  metadata.gz: c2b88675fec154db2d70b835b98124879b77dbcd283b898fea74fe88c1a75a4b
+  data.tar.gz: 57eefe94dd39d192dff652e90cfadda2ce06d244a3a20e849dd9f3df6a88ffb4
 SHA512:
-  metadata.gz: c0a0b3718c1085d8c43f350ab4d82a21b508d215fc1caa59751d2552ee2598dc9281a5a21589d9cf08bad4a4b68925d6d6e27c592fe38fc3a40d6d2a606e0ce1
-  data.tar.gz: 891a2994edb8f81ea829710faa26b87056206be42d12092ce6c7250bb7cebaaaf1cd4363ce0f4d36307d12f1ecaa9a15385418bec80a2cab390b3f245f96ae54
+  metadata.gz: de85932e530b33168b83399f0135fd862071c10318faaaef324935c3e51bc1914dd9361c68a5c2a6d3a4fc81e9f0193b928a4fe65c2dbc34826998573465af86
+  data.tar.gz: f5e12ca382154fac0fbff872f9f906a62c0a990b06226363c701fa52d05ee927d23b0358f005e6de974e7fad938944beb2621413419b48a5d43b29e4b3180af8

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v2.1.1 (2023-02-17)
+
+### Changed
+
+* Support for custom RateLimit headers. [PR #13](https://github.com/lostisland/faraday-retry/pull/13). Thanks, [@brookemckim]!
+
+## v2.1.0 (2023-02-17)
+
+Invalid release, use v2.1.1.
+
 ## v2.0.0 (2022-06-08)
 
 ### Changed
@@ -22,3 +32,4 @@ This release consists of the same middleware that was previously bundled with Fa
 *  Retry middleware `retry_block` is not called if retry will not happen due to `max_interval`, https://github.com/lostisland/faraday/pull/1350
 
 [@maxprokopiev]: https://github.com/maxprokopiev
+[@brookemckim]: https://github.com/brookemckim

data/README.md

@@ -1,6 +1,6 @@
 # Faraday Retry
 
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/lostisland/faraday-retry/CI)](https://github.com/lostisland/faraday-retry/actions?query=branch%3Amain)
+[![CI](https://github.com/lostisland/faraday-retry/actions/workflows/ci.yaml/badge.svg)](https://github.com/lostisland/faraday-retry/actions/workflows/ci.yaml)
 [![Gem](https://img.shields.io/gem/v/faraday-retry.svg?style=flat-square)](https://rubygems.org/gems/faraday-retry)
 [![License](https://img.shields.io/github/license/lostisland/faraday-retry.svg?style=flat-square)](LICENSE.md)
 
@@ -100,7 +100,7 @@ retry_options = {
 
 Some APIs, like the [Slack API](https://api.slack.com/docs/rate-limits), will inform you when you reach their API limits by replying with a response status code of `429`
 and a response header of `Retry-After` containing a time in seconds. You should then only retry querying after the amount of time provided by the `Retry-After` header,
-otherwise you won't get a response. Other APIs communicate their rate limits via the [RateLimit-xxx](https://tools.ietf.org/id/draft-polli-ratelimit-headers-00.html#rfc.section.3.3) headers
+otherwise you won't get a response. Other APIs communicate their rate limits via the [RateLimit-xxx](https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-05.html#name-providing-ratelimit-fields) headers
 where `RateLimit-Reset` behaves similarly to the `Retry-After`.
 
 You can automatically handle both headers and have Faraday pause and retry for the right amount of time by including the `429` status code in the retry statuses list:
@@ -111,6 +111,16 @@ retry_options = {
 }
 ```
 
+If you are working with an API which does not comply with the Rate Limit RFC you can specify custom headers to be used for retry and reset.
+
+```ruby
+retry_options = {
+  retry_statuses: [429],
+  rate_limit_retry_header: 'x-rate-limit-retry-after',
+  rate_limit_reset_header: 'x-rate-limit-reset'
+}
+```
+
 #### Specify a custom retry logic
 
 You can also specify a custom retry logic with the `retry_if` option.
@@ -142,7 +152,7 @@ For example, you might want to keep track of the response statuses:
 ```ruby
 response_statuses = []
 retry_options = {
-  retry_block: -> (env:, options:, retries_remaining:, exception:, will_retry_in:) { response_statuses << env.status }
+  retry_block: -> (env:, options:, retry_count:, exception:, will_retry_in:) { response_statuses << env.status }
 }
 ```
 

data/lib/faraday/retry/middleware.rb

@@ -26,7 +26,8 @@ module Faraday
                                            :interval_randomness,
                                            :backoff_factor, :exceptions,
                                            :methods, :retry_if, :retry_block,
-                                           :retry_statuses)
+                                           :retry_statuses, :rate_limit_retry_header,
+                                           :rate_limit_reset_header)
 
         DEFAULT_CHECK = ->(_env, _exception) { false }
 
@@ -213,15 +214,17 @@ module Faraday
       end
 
       # RFC for RateLimit Header Fields for HTTP:
-      # https://tools.ietf.org/id/draft-polli-ratelimit-headers-00.html#rfc.section.3.3
+      # https://www.ietf.org/archive/id/draft-ietf-httpapi-ratelimit-headers-05.html#name-fields-definition
       def calculate_rate_limit_reset(env)
-        parse_retry_header(env, 'RateLimit-Reset')
+        reset_header = @options.rate_limit_reset_header || 'RateLimit-Reset'
+        parse_retry_header(env, reset_header)
       end
 
       # MDN spec for Retry-After header:
       # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After
       def calculate_retry_after(env)
-        parse_retry_header(env, 'Retry-After')
+        retry_header = @options.rate_limit_retry_header || 'Retry-After'
+        parse_retry_header(env, retry_header)
       end
 
       def calculate_retry_interval(retries)

data/lib/faraday/retry/version.rb

@@ -2,6 +2,6 @@
 
 module Faraday
   module Retry
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-retry
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-15 00:00:00.000000000 Z
+date: 2023-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -157,8 +157,8 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/lostisland/faraday-retry/issues
-  changelog_uri: https://github.com/lostisland/faraday-retry/blob/v2.0.0/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.0.0
+  changelog_uri: https://github.com/lostisland/faraday-retry/blob/v2.1.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.1.0
   homepage_uri: https://github.com/lostisland/faraday-retry
   source_code_uri: https://github.com/lostisland/faraday-retry
 post_install_message: