retriable 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 81c2ccf7c0dd361e1ca4f7eac29a8d988910a6c4
-  data.tar.gz: bd45326dd3e4bbad1f93fd7127802ad443de127a
+  metadata.gz: 56415871220fd82fcfd72e2748a5a8283072bfa9
+  data.tar.gz: 93dfae047c70da13dc9b9a64331d1b1e62273ced
 SHA512:
-  metadata.gz: a9b2ef78c9179a0eef716cdfc124a7b0ad325a65d8870d86311560f1f73dac3d055810998a9a0b74909163082508443efcda460cdee2e6c3316dd07885d2f589
-  data.tar.gz: 5a18024b95eb0011b88b0ea3e25a374ca4c72e2d6f39fda027692d3b39a3da9f29b2d894fe9bbf214ff43f5a8ac803b4f266c92c09f4caf0e18a164fadad9402
+  metadata.gz: 42de39c02026a18aa580bac6186038460f1d83a48681b703da8fbe40bb1bcdd5a6f4e06d9cbc9daf5e2129d1e9f32c0cb05ce1f153de721e07341ed0f00dbb8c
+  data.tar.gz: 42dd35b52204d819e1b1d0c31eaadc5eef643b8a1daf69e694e29aff900d7995aa159ec2060bf4d414f66ffb2e5b6fd458ec2574a61d4192064cb0fc802a43e1

data/.travis.yml

@@ -1,10 +1,14 @@
+# Send builds to container-based infrastructure
+# http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
 language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.5
-  - 2.2.0
+  - 2.1.7
+  - 2.2.3
   - rbx
+  - jruby-9.0.0.0
   - ruby-head
   - jruby-head
 
@@ -13,6 +17,7 @@ matrix:
     - rvm: 1.9.3
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: jruby-9.0.0.0
 
 addons:
   code_climate:

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## HEAD
 
+## 2.1.0
+
+* Fix bug #17 due to confusing the initial try as a retry.
+* Switch to `Minitest` 5.6 expect syntax.
+
 ## 2.0.2
 
 * Change required_ruby_version in gemspec to >= 1.9.3.

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
-  gem "ruby_gntp"
+  # gem "ruby_gntp"
   gem "minitest-focus"
   gem "codeclimate-test-reporter", require: false
   gem "simplecov", require: false

data/README.md

@@ -38,9 +38,9 @@ gem 'retriable', '~> 2.0'
 
 ## Usage
 
-Code in a `Retriable.retriable` block will be retried if an exception is raised. By default, Retriable will rescue any exception inherited from `StandardError`, make 3 retry tries before raising the last exception, and also use randomized exponential backoff to calculate each succeeding try interval. The default interval table with 10 tries looks like this (in seconds):
+Code in a `Retriable.retriable` block will be retried if an exception is raised. By default, Retriable will rescue any exception inherited from `StandardError`, make 3 tries (including the initial attempt) before raising the last exception, and also use randomized exponential backoff to calculate each succeeding try interval. The default interval table with 10 tries looks like this (in seconds):
 
-| request# | retry interval | randomized interval             |
+| retry#   | retry interval | randomized interval             |
 | -------- | -------------- | ------------------------------- |
 | 1        |    0.5         |  [0.25,   0.75]                 |
 | 2        |    0.75        |  [0.375,  1.125]                |
@@ -70,7 +70,7 @@ end
 
 Here are the available options:
 
-`tries` (default: 3) - Number of tries to make at running your code block.
+`tries` (default: 3) - Number of attempts to make at running your code block (includes intial attempt).
 
 `base_interval` (default: 0.5) - The initial interval in seconds between tries.
 
@@ -88,7 +88,7 @@ randomized_interval = retry_interval * (random value in range [1 - randomization
 
 `intervals`  (default: nil) - Skip generated intervals and provide your own array of intervals in seconds. Setting this option will ignore `tries`, `base_interval`, `max_interval`, `rand_factor`, and `multiplier` values.
 
-`timeout` (default: 0) - Number of seconds to allow the code block to run before raising a Timeout::Error
+`timeout` (default: nil) - Number of seconds to allow the code block to run before raising a `Timeout::Error` inside each try. Default is `nil` means the code block can run forever without raising error.
 
 `on` (default: [StandardError]) - An `Array` of exceptions to rescue for each try, a `Hash` where the keys are `Exception` classes and the values can be a single `Regexp` pattern or a list of patterns, or a single `Exception` type.
 
@@ -161,6 +161,8 @@ Retriable.retriable intervals: [0.5, 1.0, 2.0, 2.5] do
 end
 ```
 
+This example makes 5 total attempts, if the first attempt fails, the 2nd attempt occurs 0.5 seconds later.
+
 ### Turn off Exponential Backoff
 
 Exponential backoff is enabled by default, if you want to simply retry code every second, 5 times maximum, you can do this:
@@ -248,6 +250,15 @@ retriable do
 end
 ```
 
+## Proxy Wrapper Object
+
+[@julik](https://github.com/julik) has created a gem called [retriable_proxy](https://github.com/julik/retriable_proxy) that extends `retriable` with the ability to wrap objects and specify which methods you want to be retriable, like so:
+
+```ruby
+# api_endpoint is an instance of some kind of class that connects to an API
+RetriableProxy.for_object(api_endpoint, on: Net::TimeoutError)
+```
+
 ## Credits
 
-The randomized exponetial backoff implementation was inspired by the one used in Google's [google-http-java-client](https://code.google.com/p/google-http-java-client/wiki/ExponentialBackoff) project.
+The randomized exponential backoff implementation was inspired by the one used in Google's [google-http-java-client](https://code.google.com/p/google-http-java-client/wiki/ExponentialBackoff) project.

data/lib/retriable.rb

@@ -1,7 +1,7 @@
 require "timeout"
-require "retriable/config"
-require "retriable/exponential_backoff"
-require "retriable/version"
+require_relative "retriable/config"
+require_relative "retriable/exponential_backoff"
+require_relative "retriable/version"
 
 module Retriable
   extend self
@@ -32,10 +32,10 @@ module Retriable
     elapsed_time = -> { Time.now - start_time }
 
     if intervals
-      tries = intervals.size
+      tries = intervals.size + 1
     else
       intervals = ExponentialBackoff.new(
-        tries:          tries,
+        tries:          tries - 1,
         base_interval:  base_interval,
         multiplier:     multiplier,
         max_interval:   max_interval,
@@ -45,7 +45,8 @@ module Retriable
 
     exception_list = on.kind_of?(Hash) ? on.keys : on
 
-    intervals.each.with_index(1) do |interval, try|
+    tries.times do |index|
+      try = index + 1
       begin
         if timeout
           Timeout::timeout(timeout) { return yield(try) }
@@ -65,6 +66,7 @@ module Retriable
           raise unless message_match
         end
 
+        interval = intervals[index]
         on_retry.call(exception, try, elapsed_time.call, interval) if on_retry
         raise if try >= tries || (elapsed_time.call + interval) > max_elapsed_time
         sleep interval if config.sleep_disabled != true

data/lib/retriable/core_ext/kernel.rb

@@ -1,4 +1,4 @@
-require "retriable"
+require_relative "../../retriable"
 
 module Kernel
   def retriable(opts = {}, &block)

data/lib/retriable/version.rb

@@ -1,3 +1,3 @@
 module Retriable
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/retriable.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.4"
 
-  spec.add_development_dependency "minitest", "~> 5.5"
+  spec.add_development_dependency "minitest", "~> 5.6"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-minitest"
 end

data/spec/config_spec.rb

@@ -6,42 +6,42 @@ describe Retriable::Config do
   end
 
   it "sleep defaults to enabled" do
-    subject.new.sleep_disabled.must_equal false
+    expect(subject.new.sleep_disabled).must_equal false
   end
 
   it "tries defaults to 3" do
-    subject.new.tries.must_equal 3
+    expect(subject.new.tries).must_equal 3
   end
 
   it "max interval defaults to 60" do
-    subject.new.max_interval.must_equal 60
+    expect(subject.new.max_interval).must_equal 60
   end
 
   it "randomization factor defaults to 0.5" do
-    subject.new.base_interval.must_equal 0.5
+    expect(subject.new.base_interval).must_equal 0.5
   end
 
   it "multiplier defaults to 1.5" do
-    subject.new.multiplier.must_equal 1.5
+    expect(subject.new.multiplier).must_equal 1.5
   end
 
   it "max elapsed time defaults to 900" do
-    subject.new.max_elapsed_time.must_equal 900
+    expect(subject.new.max_elapsed_time).must_equal 900
   end
 
   it "intervals defaults to nil" do
-    subject.new.intervals.must_be_nil
+    expect(subject.new.intervals).must_be_nil
   end
 
   it "timeout defaults to nil" do
-    subject.new.timeout.must_be_nil
+    expect(subject.new.timeout).must_be_nil
   end
 
   it "on defaults to [StandardError]" do
-    subject.new.on.must_equal [StandardError]
+    expect(subject.new.on).must_equal [StandardError]
   end
 
   it "on retry handler defaults to nil" do
-    subject.new.on_retry.must_be_nil
+    expect(subject.new.on_retry).must_be_nil
   end
 end

data/spec/exponential_backoff_spec.rb

@@ -10,23 +10,23 @@ describe Retriable::ExponentialBackoff do
   end
 
   it "tries defaults to 3" do
-    subject.new.tries.must_equal 3
+    expect(subject.new.tries).must_equal 3
   end
 
   it "max interval defaults to 60" do
-    subject.new.max_interval.must_equal 60
+    expect(subject.new.max_interval).must_equal 60
   end
 
   it "randomization factor defaults to 0.5" do
-    subject.new.base_interval.must_equal 0.5
+    expect(subject.new.base_interval).must_equal 0.5
   end
 
   it "multiplier defaults to 1.5" do
-    subject.new.multiplier.must_equal 1.5
+    expect(subject.new.multiplier).must_equal 1.5
   end
 
   it "generates 10 randomized intervals" do
-    subject.new(tries: 9).intervals.must_equal([
+    expect(subject.new(tries: 9).intervals).must_equal([
       0.5244067512211441,
       0.9113920238761231,
       1.2406087918999114,
@@ -40,11 +40,11 @@ describe Retriable::ExponentialBackoff do
   end
 
   it "generates defined number of intervals" do
-    subject.new(tries: 5).intervals.size.must_equal 5
+    expect(subject.new(tries: 5).intervals.size).must_equal 5
   end
 
   it "generates intervals with a defined base interval" do
-    subject.new(base_interval: 1).intervals.must_equal([
+    expect(subject.new(base_interval: 1).intervals).must_equal([
       1.0488135024422882,
       1.8227840477522461,
       2.4812175837998227
@@ -52,7 +52,7 @@ describe Retriable::ExponentialBackoff do
   end
 
   it "generates intervals with a defined multiplier" do
-    subject.new(multiplier: 1).intervals.must_equal([
+    expect(subject.new(multiplier: 1).intervals).must_equal([
       0.5244067512211441,
       0.607594682584082,
       0.5513816852888495
@@ -60,7 +60,7 @@ describe Retriable::ExponentialBackoff do
   end
 
   it "generates intervals with a defined max interval" do
-    subject.new(max_interval: 1.0, rand_factor: 0.0).intervals.must_equal([
+    expect(subject.new(max_interval: 1.0, rand_factor: 0.0).intervals).must_equal([
       0.5,
       0.75,
       1.0
@@ -68,7 +68,7 @@ describe Retriable::ExponentialBackoff do
   end
 
   it "generates intervals with a defined rand_factor" do
-    subject.new(rand_factor: 0.2).intervals.must_equal([
+    expect(subject.new(rand_factor: 0.2).intervals).must_equal([
       0.5097627004884576,
       0.8145568095504492,
       1.1712435167599646
@@ -76,10 +76,10 @@ describe Retriable::ExponentialBackoff do
   end
 
   it "generates 10 non-randomized intervals" do
-    subject.new(
+    expect(subject.new(
       tries: 10,
       rand_factor: 0.0
-    ).intervals.must_equal([
+    ).intervals).must_equal([
       0.5,
       0.75,
       1.125,

data/spec/retriable_spec.rb

@@ -24,15 +24,15 @@ describe Retriable do
         tries += 1
       end
 
-      tries.must_equal 1
+      expect(tries).must_equal 1
     end
 
     it "raises a LocalJumpError if #retriable is not given a block" do
-      -> do
+      expect do
         subject.retriable on: StandardError
       end.must_raise LocalJumpError
 
-      -> do
+      expect do
         subject.retriable on: StandardError, timeout: 2
       end.must_raise LocalJumpError
     end
@@ -40,58 +40,59 @@ describe Retriable do
     it "makes 3 tries when retrying block of code raising StandardError with no arguments" do
       tries = 0
 
-      -> do
+      expect do
         subject.retriable do
           tries += 1
           raise StandardError.new
         end
       end.must_raise StandardError
 
-      tries.must_equal 3
+      expect(tries).must_equal 3
     end
 
     it "makes only 1 try when exception raised is not ancestor of StandardError" do
       tries = 0
 
-      -> do
+      expect do
         subject.retriable do
           tries += 1
           raise TestError.new
         end
       end.must_raise TestError
 
-      tries.must_equal 1
+      expect(tries).must_equal 1
     end
 
     it "#retriable with custom exception tries 3 times and re-raises the exception" do
       tries = 0
-      -> do
+
+      expect do
         subject.retriable on: TestError do
           tries += 1
           raise TestError.new
         end
       end.must_raise TestError
 
-      tries.must_equal 3
+      expect(tries).must_equal 3
     end
 
     it "#retriable tries 10 times" do
       tries = 0
 
-      -> do
+      expect do
         subject.retriable(
-          tries: 10
+          tries: 10,
         ) do
-            tries += 1
-            raise StandardError.new
+          tries += 1
+          raise StandardError.new
         end
       end.must_raise StandardError
 
-      tries.must_equal 10
+      expect(tries).must_equal 10
     end
 
     it "#retriable will timeout after 1 second" do
-      -> do
+      expect do
         subject.retriable timeout: 1 do
           sleep 1.1
         end
@@ -99,26 +100,26 @@ describe Retriable do
     end
 
     it "applies a randomized exponential backoff to each try" do
-      @tries = 0
-      @time_table = []
+      tries = 0
+      time_table = []
 
       handler = ->(exception, try, elapsed_time, next_interval) do
-        exception.class.must_equal ArgumentError
-        @time_table << next_interval
+        expect(exception.class).must_equal ArgumentError
+        time_table << next_interval
       end
 
-      -> do
+      expect do
         Retriable.retriable(
           on: [EOFError, ArgumentError],
           on_retry: handler,
-          tries: 9
+          tries: 10,
         ) do
-          @tries += 1
+          tries += 1
           raise ArgumentError.new
         end
       end.must_raise ArgumentError
 
-      @time_table.must_equal([
+      expect(time_table).must_equal([
         0.5244067512211441,
         0.9113920238761231,
         1.2406087918999114,
@@ -127,18 +128,21 @@ describe Retriable do
         4.350816718580626,
         5.339852157217869,
         11.889873261212443,
-        18.756037881636484
+        18.756037881636484,
+        nil,
       ])
+
+      expect(tries).must_equal(10)
     end
 
     describe "retries with an on_#retriable handler, 6 max retries, and a 0.0 rand_factor" do
       before do
         tries = 6
-        @tries = 0
+        @try_count = 0
         @time_table = {}
 
         handler = ->(exception, try, elapsed_time, next_interval) do
-          exception.class.must_equal ArgumentError
+          expect(exception.class).must_equal ArgumentError
           @time_table[try] = next_interval
         end
 
@@ -146,24 +150,24 @@ describe Retriable do
           on: [EOFError, ArgumentError],
           on_retry: handler,
           rand_factor: 0.0,
-          tries: tries
+          tries: tries,
         ) do
-          @tries += 1
-          raise ArgumentError.new if @tries < tries
+          @try_count += 1
+          raise ArgumentError.new if @try_count < tries
         end
       end
 
       it "makes 6 tries" do
-        @tries.must_equal 6
+        expect(@try_count).must_equal 6
       end
 
       it "applies a non-randomized exponential backoff to each try" do
-        @time_table.must_equal({
+        expect(@time_table).must_equal({
           1 => 0.5,
           2 => 0.75,
           3 => 1.125,
           4 => 1.6875,
-          5 => 2.53125
+          5 => 2.53125,
         })
       end
     end
@@ -176,25 +180,25 @@ describe Retriable do
         time_table[try] = next_interval
       end
 
-      -> do
+      expect do
         subject.retriable(
           on: StandardError,
           on_retry: handler,
           rand_factor: 0.0,
           tries: 5,
-          max_interval: 1.5
+          max_interval: 1.5,
         ) do
           tries += 1
           raise StandardError.new
         end
       end.must_raise StandardError
 
-      time_table.must_equal({
+      expect(time_table).must_equal({
         1 => 0.5,
         2 => 0.75,
         3 => 1.125,
         4 => 1.5,
-        5 => 1.5
+        5 => nil,
       })
     end
 
@@ -204,7 +208,7 @@ describe Retriable do
         0.75,
         1.125,
         1.5,
-        1.5
+        1.5,
       ]
       time_table = {}
 
@@ -212,32 +216,38 @@ describe Retriable do
         time_table[try] = next_interval
       end
 
-      -> do
+      try_count = 0
+
+      expect do
         subject.retriable(
           on_retry: handler,
-          intervals: intervals
+          intervals: intervals,
         ) do
+          try_count += 1
           raise StandardError.new
         end
       end.must_raise StandardError
 
-      time_table.must_equal({
+      expect(time_table).must_equal({
         1 => 0.5,
         2 => 0.75,
         3 => 1.125,
         4 => 1.5,
-        5 => 1.5
+        5 => 1.5,
+        6 => nil,
       })
+
+      expect(try_count).must_equal(6)
     end
 
     it "#retriable with a hash exception where the value is an exception message pattern" do
-      e = -> do
+      e = expect do
         subject.retriable on: { TestError => /something went wrong/ } do
           raise TestError.new('something went wrong')
         end
       end.must_raise TestError
 
-      e.message.must_equal "something went wrong"
+      expect(e.message).must_equal "something went wrong"
     end
 
     it "#retriable with a hash exception list where the values are exception message patterns" do
@@ -247,7 +257,7 @@ describe Retriable do
         exceptions[try] = exception
       end
 
-      e = -> do
+      e = expect do
         subject.retriable tries: 4, on: { StandardError => nil, TestError => [/foo/, /bar/] }, on_retry: handler do
           tries += 1
           case tries
@@ -263,16 +273,16 @@ describe Retriable do
         end
       end.must_raise TestError
 
-      e.message.must_equal "crash"
-      exceptions[1].class.must_equal TestError
-      exceptions[1].message.must_equal "foo"
-      exceptions[2].class.must_equal TestError
-      exceptions[2].message.must_equal "bar"
-      exceptions[3].class.must_equal StandardError
+      expect(e.message).must_equal "crash"
+      expect(exceptions[1].class).must_equal TestError
+      expect(exceptions[1].message).must_equal "foo"
+      expect(exceptions[2].class).must_equal TestError
+      expect(exceptions[2].message).must_equal "bar"
+      expect(exceptions[3].class).must_equal StandardError
     end
 
     it "#retriable can be called in the global scope" do
-      -> do
+      expect do
         retriable do
           puts "should raise NoMethodError"
         end
@@ -282,14 +292,14 @@ describe Retriable do
 
       tries = 0
 
-      -> do
+      expect do
         retriable do
           tries += 1
           raise StandardError.new
         end
       end.must_raise StandardError
 
-      tries.must_equal 3
+      expect(tries).must_equal 3
     end
   end
 
@@ -298,7 +308,7 @@ describe Retriable do
       c.sleep_disabled = false
     end
 
-    subject.config.sleep_disabled.must_equal false
+    expect(subject.config.sleep_disabled).must_equal false
 
     tries = 0
     time_table = {}
@@ -307,19 +317,19 @@ describe Retriable do
       time_table[try] = elapsed_time
     end
 
-    -> do
+    expect do
       subject.retriable(
         base_interval: 1.0,
         multiplier: 1.0,
         rand_factor: 0.0,
         max_elapsed_time: 2.0,
-        on_retry: handler
+        on_retry: handler,
       ) do
         tries += 1
         raise EOFError.new
       end
     end.must_raise EOFError
 
-    tries.must_equal 2
+    expect(tries).must_equal 2
   end
 end

data/wercker.yml

@@ -7,7 +7,7 @@ build:
     steps:
         # Uncomment this to force RVM to use a specific Ruby version
         - rvm-use:
-            version: 2.1.5
+            version: 2.2.3
 
         # A step that executes `bundle install` command
         - bundle-install
@@ -24,4 +24,4 @@ build:
         # Add more steps here:
         - script:
              name: rake
-             code: bundle exec rake
+             code: bundle exec rake

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Jack Chu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-31 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.5'
+        version: '5.6'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Retriable is an simple DSL to retry failed code blocks with randomized exponential