faraday-retry 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b88675fec154db2d70b835b98124879b77dbcd283b898fea74fe88c1a75a4b
-  data.tar.gz: 57eefe94dd39d192dff652e90cfadda2ce06d244a3a20e849dd9f3df6a88ffb4
+  metadata.gz: f4c985b60e619c7a2161b8643fda86adcd4927847a66d903bbc22a32ed851d13
+  data.tar.gz: 010d8a002a7310f82c44395344cc81cb3f8acfe9e53ca8aae8ae84cd3b66d90a
 SHA512:
-  metadata.gz: de85932e530b33168b83399f0135fd862071c10318faaaef324935c3e51bc1914dd9361c68a5c2a6d3a4fc81e9f0193b928a4fe65c2dbc34826998573465af86
-  data.tar.gz: f5e12ca382154fac0fbff872f9f906a62c0a990b06226363c701fa52d05ee927d23b0358f005e6de974e7fad938944beb2621413419b48a5d43b29e4b3180af8
+  metadata.gz: b6dc78fe8c3b3ccc189c086271eb646e06f6e598a0a2b311ce3f0831321ba8f00b01d24be1c29521f7bbef5367eb17c43be7f6dfaa6402f0ec9cf206483f8794
+  data.tar.gz: 6338884c1806a7d06f33457db3939d71aaf761c9cc8c427a14c68257600d0601ff6765dde9b061254fd5af8f4ff77315d018a8d42d5326842fd0d26d0e52219f

data/CHANGELOG.md

@@ -1,14 +1,14 @@
 # Changelog
 
-## v2.1.1 (2023-02-17)
+## v2.2.0 (2023-06-01)
 
-### Changed
+* Support new `header_parser_block` option. [PR #28](https://github.com/lostisland/faraday-retry/pull/28). Thanks, [@zavan]!
 
-* Support for custom RateLimit headers. [PR #13](https://github.com/lostisland/faraday-retry/pull/13). Thanks, [@brookemckim]!
+## v2.1.0 (2023-03-03)
 
-## v2.1.0 (2023-02-17)
+* Support for custom RateLimit headers. [PR #13](https://github.com/lostisland/faraday-retry/pull/13). Thanks, [@brookemckim]!
 
-Invalid release, use v2.1.1.
+v2.1.1 (2023-02-17) is a spurious not-released version that you may have seen mentioned in this CHANGELOG.
 
 ## v2.0.0 (2022-06-08)
 
@@ -33,3 +33,4 @@ This release consists of the same middleware that was previously bundled with Fa
 
 [@maxprokopiev]: https://github.com/maxprokopiev
 [@brookemckim]: https://github.com/brookemckim
+[@zavan]: https://github.com/zavan

data/README.md

@@ -111,13 +111,14 @@ 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.
+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, as well as a block to parse the headers:
 
 ```ruby
 retry_options = {
   retry_statuses: [429],
   rate_limit_retry_header: 'x-rate-limit-retry-after',
-  rate_limit_reset_header: 'x-rate-limit-reset'
+  rate_limit_reset_header: 'x-rate-limit-reset',
+  header_parser_block: ->(value) { Time.at(value.to_i).utc - Time.now.utc }
 }
 ```
 

data/lib/faraday/retry/middleware.rb

@@ -27,7 +27,7 @@ module Faraday
                                            :backoff_factor, :exceptions,
                                            :methods, :retry_if, :retry_block,
                                            :retry_statuses, :rate_limit_retry_header,
-                                           :rate_limit_reset_header)
+                                           :rate_limit_reset_header, :header_parser_block)
 
         DEFAULT_CHECK = ->(_env, _exception) { false }
 
@@ -120,6 +120,10 @@ module Faraday
       #   codes or a single Integer value that determines whether to raise
       #   a Faraday::RetriableResponse exception based on the HTTP status code
       #   of an HTTP response.
+      # @option options [Block] :header_parser_block block that will receive
+      #   the the value of the retry header and should return the number of
+      #   seconds to wait before retrying the request. This is useful if the
+      #   value of the header is not a number of seconds or a RFC 2822 formatted date.
       def initialize(app, options = nil)
         super(app)
         @options = Options.from(options)
@@ -244,12 +248,16 @@ module Faraday
 
         retry_after_value = env[:response_headers][header]
 
-        # Try to parse date from the header value
-        begin
-          datetime = DateTime.rfc2822(retry_after_value)
-          datetime.to_time - Time.now.utc
-        rescue ArgumentError
-          retry_after_value.to_f
+        if @options.header_parser_block
+          @options.header_parser_block.call(retry_after_value)
+        else
+          # Try to parse date from the header value
+          begin
+            datetime = DateTime.rfc2822(retry_after_value)
+            datetime.to_time - Time.now.utc
+          rescue ArgumentError
+            retry_after_value.to_f
+          end
         end
       end
     end

data/lib/faraday/retry/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday-retry
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-06-01 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.1.0/CHANGELOG.md
-  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.1.0
+  changelog_uri: https://github.com/lostisland/faraday-retry/blob/v2.2.0/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.2.0
   homepage_uri: https://github.com/lostisland/faraday-retry
   source_code_uri: https://github.com/lostisland/faraday-retry
 post_install_message: