faraday_middleware-request-retry 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7aa9342c9636f4ecd594b79f8bbf40efe64c5092
-  data.tar.gz: ae7a148dcce1ecbcb12e5801f66f2242f997b4bf
+SHA256:
+  metadata.gz: 7b22970596e52bff369b3bfec6cd6a8812edb3024c9b59c206358ec864fcabac
+  data.tar.gz: 0fb7fa15f6063559932f0b6bdf0e593a0a2c873077e80c1220e1841c70e5547f
 SHA512:
-  metadata.gz: 9febff9858f8c17495793773ebc4d75c1469c959f47d1813dedee59f75ae60a77d266848aca3938492d5736b457cee14ad8a3a1270c5cbba05fc149888923f74
-  data.tar.gz: 1d7cd9529a89f91b0ac492bc367da09e85db67a83322d4347afcf53c28885bce7c8dcd6a13bd275c3426649f0d6023c0755c1f147e3ed54fb0704c5fc0475d30
+  metadata.gz: 8aebdbe48a13730b3913803c09afed4d46aac46557e905f6efa0753cc0b9807b13c0d4750f8c1ad1984a74f23731fef4fa515265d436141cb1148982ea90f530
+  data.tar.gz: 320cbd78a690c6ee6594299897cb311635e2a0116d9e58b66ba993767c963f67f7164b118cd0a4e08e353690d171030e080f421b95d6bddeada2abeabd592ce7

data/CHANGELOG.md

@@ -1,5 +1,7 @@
 CHANGELOG
 ---------
+- **2016-12-28**: 0.2.0
+  - Refactor to support external use via `RetryUtil`
 - **2016-12-28**: 0.1.0
   - Add custom retry time support
   - Add custom status code support

data/README.md

@@ -4,11 +4,8 @@ FaradayMiddleware::Request::Retry
 [![Gem Version][gem-version-svg]][gem-version-link]
 [![Build Status][build-status-svg]][build-status-link]
 [![Coverage Status][coverage-status-svg]][coverage-status-link]
-[![Dependency Status][dependency-status-svg]][dependency-status-link]
-[![Codacy Badge][codacy-svg]][codacy-link]
 [![Code Climate][codeclimate-status-svg]][codeclimate-status-link]
 [![Scrutinizer Code Quality][scrutinizer-status-svg]][scrutinizer-status-link]
-[![Downloads][downloads-svg]][downloads-link]
 [![Docs][docs-rubydoc-svg]][docs-rubydoc-link]
 [![License][license-svg]][license-link]
 
@@ -61,6 +58,20 @@ Options include:
 | `:retry_after` | Default retry seconds | optional | `10` seconds |
 | `:error_codes` | Array of error codes, e.g. `[429, 503, 504]` | optional | `[429, 503]` |
 
+### External Use
+
+The core retry functionality can be used separately from Faraday when necessary. For example, when requests cannot be replayed, e.g. when `Faraday::UploadIO` is used.
+
+```ruby
+res = faraday_client.get '/my_url'
+
+retry_util = FaradayMiddleware::Request::RetryUtil.new
+
+# The following will return `true` for retry, `false` for don't,
+# while sleeping when necessary
+want_retry = retry_util.retry_status res.status, res.headers['Retry-After']
+```
+
 ## Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)
@@ -83,7 +94,7 @@ This library is originally based on code extracted from the Zendesk Ruby SDK's `
 
 ## Copyright and license
 
-Copyright © 2015 Zendesk, 2016 John Wang
+Copyright © 2015 Zendesk, 2016-2023 John Wang
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
 

data/lib/faraday_middleware-request-retry/retry.rb

@@ -4,34 +4,20 @@ module FaradayMiddleware
   module Request
     # Faraday middleware to handle HTTP Status 429 (rate limiting) / 503 (maintenance)
     class Retry < Faraday::Middleware
-      DEFAULT_RETRY_AFTER = 10
-      ERROR_CODES = [429, 503]
-
-      attr_reader :error_codes
-      attr_reader :retry_after
+      attr_reader :retry_util
 
-      def initialize(app, options = {})
+      def initialize(app, opts = {})
         super app
-        @logger = options[:logger]
-        @error_codes = options[:error_codes] || ERROR_CODES
-        @retry_after = options[:retry_after] || DEFAULT_RETRY_AFTER
+        @retry_util = FaradayMiddleware::Request::RetryUtil.new opts
       end
 
       def call(env)
         original_env = env.dup
         response = @app.call env
 
-        if @error_codes.include? response.env[:status]
-          seconds_left = (response.env[:response_headers][:retry_after] || @retry_after).to_i
-          @logger.warn "You have been rate limited. Retrying in #{seconds_left} seconds..." if @logger
+        retry_status = @retry_util.retry_status response.env[:status], response.env[:response_headers][:retry_after]
 
-          seconds_left.times do |i|
-            sleep 1
-            time_left = seconds_left - i
-            @logger.warn "#{time_left}..." if time_left > 0 && time_left % 5 == 0 && @logger
-          end
-
-          @logger.warn 'Retrying...' if @logger
+        if retry_status
           @app.call original_env
         else
           response
@@ -40,3 +26,37 @@ module FaradayMiddleware
     end
   end
 end
+
+module FaradayMiddleware
+  module Request
+    # Standalone HTTP request retry utility class
+    # Can be used outside of FaradayMiddleware, e.g.
+    # when Faraday::UploadIO is used
+    class RetryUtil
+      DEFAULT_ERROR_CODES = [429, 503].freeze
+      DEFAULT_RETRY_AFTER = 10
+
+      attr_accessor :error_codes
+      attr_accessor :retry_after
+
+      def initialize(opts = {})
+        @error_codes = opts[:error_codes] || DEFAULT_ERROR_CODES
+        @retry_after = opts[:retry_after] || DEFAULT_RETRY_AFTER
+        @logger = opts[:logger]
+      end
+
+      def retry_status(status, this_retry_after = nil)
+        return false unless @error_codes.include? status
+        seconds_left = (this_retry_after || @retry_after).to_i
+        @logger.warn "You have been rate limited. Retrying in #{seconds_left} seconds..." if @logger
+        seconds_left.times do |i|
+          sleep 1
+          time_left = seconds_left - i
+          @logger.warn "#{time_left}..." if time_left > 0 && time_left % 5 == 0 && @logger
+        end
+        @logger.warn 'Retrying...' if @logger
+        true
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-request-retry
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - John Wang
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2023-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,40 +16,40 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.10'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.10.3
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -70,14 +70,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: '13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.6
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -119,11 +125,11 @@ files:
 - lib/faraday_middleware-request-retry.rb
 - lib/faraday_middleware-request-retry/retry.rb
 - test/test_setup.rb
-homepage: https://github.com/grokify/
+homepage: https://github.com/grokify/faraday_middleware-request-retry
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,9 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.4.2
+signing_key:
 specification_version: 4
 summary: Faraday request middleware with retry
 test_files: []