faraday_middleware-request-retry 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c95fc8ef595dda3ae855d1b4bed6a349d0f57845
-  data.tar.gz: c8383acba9bda0678b6bc3def6b77f9ad4676c02
+  metadata.gz: 7aa9342c9636f4ecd594b79f8bbf40efe64c5092
+  data.tar.gz: ae7a148dcce1ecbcb12e5801f66f2242f997b4bf
 SHA512:
-  metadata.gz: 25e1867ae59320f8855934866be27e7ff2d137c8720b6bad4f58a92441def75aacf69ff2271e910ea2dee5f4e3f6418aa4563124aa497fefc42ed2c29398f4d4
-  data.tar.gz: 7d004ca6238f6da7e18335c9cce576d0904d1997f3ed62d262335880a90484edfcd256427400efadc3b5873f26f9b56439659935e83a46d33c30c8b820e5be29
+  metadata.gz: 9febff9858f8c17495793773ebc4d75c1469c959f47d1813dedee59f75ae60a77d266848aca3938492d5736b457cee14ad8a3a1270c5cbba05fc149888923f74
+  data.tar.gz: 1d7cd9529a89f91b0ac492bc367da09e85db67a83322d4347afcf53c28885bce7c8dcd6a13bd275c3426649f0d6023c0755c1f147e3ed54fb0704c5fc0475d30

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 CHANGELOG
 ---------
+- **2016-12-28**: 0.1.0
+  - Add custom retry time support
+  - Add custom status code support
+  - Add Codacy analysis
 - **2016-11-09**: 0.0.2
   - Update license in `.gemspec`
 - **2016-11-09**: 0.0.1

data/README.md

@@ -5,6 +5,7 @@ FaradayMiddleware::Request::Retry
 [![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]
@@ -45,13 +46,21 @@ require 'faraday_middleware-request-retry'
 require 'logger'
 
 conn = Faraday.new(url: "http://example.com") do |builder|
-  builder.use FaradayMiddleware::Refresh::Retry, logger: Logger.new(STDOUT)
+  builder.use FaradayMiddleware::Refresh::Retry, logger: Logger.new(STDOUT), retry_after: 15
   builder.adapter Faraday.default_adapter
 end
 
 conn.get "/foo" # sends token
 ```
 
+Options include:
+
+| Option | Values | Optional | Default |
+|--------|--------|----------|---------|
+| `:logger` | `Logger` object | optional |
+| `:retry_after` | Default retry seconds | optional | `10` seconds |
+| `:error_codes` | Array of error codes, e.g. `[429, 503, 504]` | optional | `[429, 503]` |
+
 ## Change Log
 
 See [CHANGELOG.md](CHANGELOG.md)
@@ -70,7 +79,7 @@ Please report these on [Github](https://github.com/grokify/faraday_middleware-re
 
 ## Credits
 
-This code is extracted from the Zendesk Ruby SDK's `ZendeskAPI::Middleware::Request::Retry` class.
+This library is originally based on code extracted from the Zendesk Ruby SDK's `ZendeskAPI::Middleware::Request::Retry` class, in [v1.14.0](https://github.com/zendesk/zendesk_api_client_rb/releases/tag/v1.14.0) (commit [2c2b52e](https://github.com/zendesk/zendesk_api_client_rb/blob/2c2b52ea390b3641d4af383759217fda75bc74ec/LICENSE)) available under the Apache 2.0 license. 
 
 ## Copyright and license
 
@@ -94,6 +103,8 @@ Unless required by applicable law or agreed to in writing, software distributed
  [coverage-status-link]: https://coveralls.io/r/grokify/faraday_middleware-request-retry?branch=master
  [dependency-status-svg]: https://gemnasium.com/grokify/faraday_middleware-request-retry.svg
  [dependency-status-link]: https://gemnasium.com/grokify/faraday_middleware-request-retry
+ [codacy-svg]: https://api.codacy.com/project/badge/Grade/d2c515165a60402eb10410cf4bd51f50
+ [codacy-link]: https://www.codacy.com/app/grokify/faraday_middleware-request-retry
  [codeclimate-status-svg]: https://codeclimate.com/github/grokify/faraday_middleware-request-retry/badges/gpa.svg
  [codeclimate-status-link]: https://codeclimate.com/github/grokify/faraday_middleware-request-retry
  [scrutinizer-status-svg]: https://scrutinizer-ci.com/g/grokify/faraday_middleware-request-retry/badges/quality-score.png?b=master

data/lib/faraday_middleware-request-retry.rb

@@ -1 +1 @@
-require 'faraday_middleware-request-retry/retry'
+require 'faraday_middleware-request-retry/retry'

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

@@ -7,17 +7,22 @@ module FaradayMiddleware
       DEFAULT_RETRY_AFTER = 10
       ERROR_CODES = [429, 503]
 
+      attr_reader :error_codes
+      attr_reader :retry_after
+
       def initialize(app, options = {})
-        super(app)
+        super app
         @logger = options[:logger]
+        @error_codes = options[:error_codes] || ERROR_CODES
+        @retry_after = options[:retry_after] || DEFAULT_RETRY_AFTER
       end
 
       def call(env)
         original_env = env.dup
-        response = @app.call(env)
+        response = @app.call env
 
-        if ERROR_CODES.include?(response.env[:status])
-          seconds_left = (response.env[:response_headers][:retry_after] || DEFAULT_RETRY_AFTER).to_i
+        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
 
           seconds_left.times do |i|
@@ -26,9 +31,8 @@ module FaradayMiddleware
             @logger.warn "#{time_left}..." if time_left > 0 && time_left % 5 == 0 && @logger
           end
 
-          @logger.warn "" if @logger
-
-          @app.call(original_env)
+          @logger.warn 'Retrying...' if @logger
+          @app.call original_env
         else
           response
         end

data/test/test_setup.rb

@@ -1,17 +1,16 @@
 require 'coveralls'
 Coveralls.wear!
 
-require 'test/unit'
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday_middleware-request-retry'
+require 'test/unit'
 
 class RetryTest < Test::Unit::TestCase
-  def testSetup
-
+  def test_setup
     @conn = Faraday.new 'http://example.com/api' do |builder|
       builder.use FaradayMiddleware::Request::Retry
     end
-
+    assert_equal 'FaradayMiddleware::Request::Retry', @conn.builder.app.class.name
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-request-retry
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - John Wang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-09 00:00:00.000000000 Z
+date: 2016-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,20 +16,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -121,7 +121,7 @@ files:
 - test/test_setup.rb
 homepage: https://github.com/grokify/
 licenses:
-- Apache License Version 2.0
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -139,7 +139,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Faraday request middleware with retry