faraday_middleware-request-retry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7aa9342c9636f4ecd594b79f8bbf40efe64c5092
-  data.tar.gz: ae7a148dcce1ecbcb12e5801f66f2242f997b4bf
+  metadata.gz: 0ca0587453305189b8a204f3d68cb995c9570854
+  data.tar.gz: 9865555586b7328f99d5980f7cecbe6b6f1b90a3
 SHA512:
-  metadata.gz: 9febff9858f8c17495793773ebc4d75c1469c959f47d1813dedee59f75ae60a77d266848aca3938492d5736b457cee14ad8a3a1270c5cbba05fc149888923f74
-  data.tar.gz: 1d7cd9529a89f91b0ac492bc367da09e85db67a83322d4347afcf53c28885bce7c8dcd6a13bd275c3426649f0d6023c0755c1f147e3ed54fb0704c5fc0475d30
+  metadata.gz: 1af7393a7fdef619daba5a1c088e33786cf45922a214bdd3423e1f3edf4f585c62264bf12020e081c49896e5412ed2d4ac315e63baf207dc6ed5ce24abc24dee
+  data.tar.gz: 37a0981c817b5f2d4a01d77889d21acd4b52bb24498a9f2b0cb46e240b442a79491911898846deb5fa6181488e314ecf567ded441a0bd5d9d3dedfb6b0bc608f

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

@@ -61,6 +61,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)

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.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-26 00:00:00.000000000 Z
+date: 2016-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday