faraday-retry 2.1.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2b88675fec154db2d70b835b98124879b77dbcd283b898fea74fe88c1a75a4b
-  data.tar.gz: 57eefe94dd39d192dff652e90cfadda2ce06d244a3a20e849dd9f3df6a88ffb4
+  metadata.gz: 4215b6f0b7dd61fa8702103e77d6373cace2c46b469defeb0ed93ce94aa26e6c
+  data.tar.gz: 295faca61565e49a36a7f03201d6aee90b6a353c40d22a8bf8e1f6b1c729c041
 SHA512:
-  metadata.gz: de85932e530b33168b83399f0135fd862071c10318faaaef324935c3e51bc1914dd9361c68a5c2a6d3a4fc81e9f0193b928a4fe65c2dbc34826998573465af86
-  data.tar.gz: f5e12ca382154fac0fbff872f9f906a62c0a990b06226363c701fa52d05ee927d23b0358f005e6de974e7fad938944beb2621413419b48a5d43b29e4b3180af8
+  metadata.gz: 5b8f2bee0e35492efc578659ce28a0b947374c8cafdba07606d953c417e8844128248a639392e4ad60c682528c0d478d3a894ca688e1f72965172633aee3be7f
+  data.tar.gz: 148ac2094f76cd59ea9278a4d1948b3211f0c2abc1876b6f10fbdd88a384257dfdfab33f9a1cf102ed23352b5b0dd2e9f1f4d533cd8459c4b86d1f5e7578a053

data/CHANGELOG.md

@@ -1,14 +1,20 @@
 # Changelog
 
-## v2.1.1 (2023-02-17)
+## Unreleased
 
-### Changed
+* Avoid deprecation warning about ::UploadIO constant when used without faraday-multipart gem [PR #37](https://github.com/lostisland/faraday-retry/pull/37) [@iMacTia]
+* Documentation update [PR #30](https://github.com/lostisland/faraday-retry/pull/30) [@olleolleolle]
+* Documentation update [PR #32](https://github.com/lostisland/faraday-retry/pull/32) Thanks, [@Drowze]!
 
-* Support for custom RateLimit headers. [PR #13](https://github.com/lostisland/faraday-retry/pull/13). Thanks, [@brookemckim]!
+## v2.2.0 (2023-06-01)
+
+* Support new `header_parser_block` option. [PR #28](https://github.com/lostisland/faraday-retry/pull/28). Thanks, [@zavan]!
 
-## v2.1.0 (2023-02-17)
+## v2.1.0 (2023-03-03)
+
+* 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 +39,7 @@ 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
+[@Drowze]: https://github.com/Drowze
+[@olleolleolle]: https://github.com/olleolleolle
+[@iMacTia]: https://github.com/iMacTia

data/README.md

@@ -75,7 +75,7 @@ retry_options = {
 #### Specify which exceptions should trigger a retry
 
 You can provide an `exceptions` option with a list of exceptions that will replace
-the default list of network-related exceptions: `Errno::ETIMEDOUT`, `Timeout::Error`, `Faraday::TimeoutError`.
+the default exceptions: `Errno::ETIMEDOUT`, `Timeout::Error`, `Faraday::TimeoutError`, `Faraday::Error::RetriableResponse`.
 This can be particularly useful when combined with the [RaiseError][raise_error] middleware.
 
 ```ruby
@@ -84,6 +84,14 @@ retry_options = {
 }
 ```
 
+If you want to inherit default exceptions, do it this way.
+
+```ruby
+retry_options = {
+  exceptions: Faraday::Retry::Middleware::DEFAULT_EXCEPTIONS + [Faraday::ResourceNotFound, Faraday::UnauthorizedError]
+}
+```
+
 #### Specify on which response statuses to retry
 
 By default the `Retry` middleware will only retry the request if one of the expected exceptions arise.
@@ -111,13 +119,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 }
 }
 ```
 
@@ -143,10 +152,8 @@ retry_options = {
 You can specify a proc object through the `retry_block` option that will be called before every
 retry, before  There are many different applications for this feature, spacing from instrumentation to monitoring.
 
-
 The block is passed keyword arguments with contextual information: Request environment, middleware options, current number of retries, exception, and amount of time we will wait before retrying. (retry_block is called before the wait time happens)
 
-
 For example, you might want to keep track of the response statuses:
 
 ```ruby
@@ -176,4 +183,4 @@ Bug reports and pull requests are welcome on [GitHub](https://github.com/lostisl
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
 
-[raise_error]:  https://lostisland.github.io/faraday/middleware/raise-error
+[raise_error]:  https://lostisland.github.io/faraday/#/middleware/included/raising-errors

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 }
 
@@ -95,8 +95,8 @@ module Faraday
       #   'Timeout::Error', Faraday::TimeoutError, Faraday::RetriableResponse])
       #   The list of exceptions to handle. Exceptions can be given as
       #   Class, Module, or String.
-      # @option options [Array] :methods (the idempotent HTTP methods
-      #   in IDEMPOTENT_METHODS) A list of HTTP methods to retry without
+      # @option options [Array<Symbol>] :methods (the idempotent HTTP methods
+      #   in IDEMPOTENT_METHODS) A list of HTTP methods, as symbols, to retry without
       #   calling retry_if. Pass an empty Array to call retry_if
       #   for all exceptions.
       # @option options [Block] :retry_if (false) block that will receive
@@ -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)
@@ -205,11 +209,11 @@ module Faraday
       end
 
       def rewind_files(body)
-        return unless defined?(UploadIO)
+        return unless defined?(Faraday::UploadIO)
         return unless body.is_a?(Hash)
 
         body.each do |_, value|
-          value.rewind if value.is_a?(UploadIO)
+          value.rewind if value.is_a?(Faraday::UploadIO)
         end
       end
 
@@ -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.1'
   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.1
 platform: ruby
 authors:
 - Mattia Giuffrida
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2024-04-15 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.1/CHANGELOG.md
+  documentation_uri: http://www.rubydoc.info/gems/faraday-retry/2.2.1
   homepage_uri: https://github.com/lostisland/faraday-retry
   source_code_uri: https://github.com/lostisland/faraday-retry
 post_install_message: