retriable 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b752911d256dced83d90ff384285f521001fd21
-  data.tar.gz: bc8abdb30075bfe7948bff5e2a7ddec0cdeb62ac
+  metadata.gz: 8d49b14baf33d9680297e0deeffaa6f4151eee60
+  data.tar.gz: 16c3c0a85a0ecf4ba880d9a24d51469940a21e1c
 SHA512:
-  metadata.gz: b564835a63aa4d7e890cc0417d55132a8124070b92747074d9c5795daf28d2cc896cdc887e1da31b6176ee4061a83c9513b47dc15171f1332c1b0f40d4f59752
-  data.tar.gz: 7560dac587dfc6556602117c3f698ce2a7e52ef00f465e9a1dc871e7faf8a764d220a6ef8a34fb16dd2a45c278c9965043664cec4d300bf6a508bbd4d121480a
+  metadata.gz: 7f5f5189eeddd4b00048a49a706e1ac76d3c9e3487d565bbaed482b45264b1a9d9d24ff3688d7d2939fd4996657836d476b6298238a21d1f485b29c9767395e7
+  data.tar.gz: ca03e49b50e5f33eb0954de07fb0af1358abe3e595936684e91cd394c6397bd08f290ea6c7abd08c76e69564c0e6eba6dd524b2b295ed365724f203c61ef527f

data/.travis.yml

@@ -1,5 +1,6 @@
 language: ruby
 rvm:
+  - 1.9.3
   - 2.0.0
   - 2.1.5
   - 2.2.0
@@ -9,6 +10,7 @@ rvm:
 
 matrix:
   allow_failures:
+    - rvm: 1.9.3
     - rvm: ruby-head
     - rvm: jruby-head
 

data/CHANGELOG.md

@@ -1,13 +1,28 @@
 ## HEAD
 
-  * Require ruby 2.0.0 minimum in gemspec.
+## 2.0.1
+
+* Add support for ruby 1.9.3.
+
+## 2.0.0
+
+* Require ruby 2.0+.
+* Time intervals default to randomized exponential backoff instead of fixed time intervals. The delay between retries grows with every attempt and there's a randomization factor added to each attempt.
+* `base_interval`, `max_interval`, `rand_factor`, and `multiplier` are new arguments that are used to generate randomized exponential back off time intervals.
+* `interval` argument removed.
+* Accept `intervals` array argument to provide your own custom intervals.
+* Allow configurable defaults via `Retriable#configure` block.
+* Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or array of `Regexp` pattern(s) to match against exception messages for retrial.
+* Raise, not return, on max elapsed time.
+* Check for elapsed time after next interval is calculated and it goes over the max elapsed time.
+* Support early termination via `max_elapsed_time` argument.
 
 ## 2.0.0.beta5
 * Change `:max_tries` back to `:tries`.
 
 ## 2.0.0.beta4
 * Change #retry back to #retriable. Didn't like the idea of defining a method that is also a reserved word.
-* Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or list of `Regexp` pattern(s) to match against exception messages for retrial.
+* Add ability for `:on` argument to accept a `Hash` where the keys are exception types and the values are a single or array of `Regexp` pattern(s) to match against exception messages for retrial.
 
 ## 2.0.0.beta3
 * Accept `intervals` array argument to provide your own custom intervals.
@@ -15,15 +30,16 @@
 * Add specs for exponential backoff, randomization, and config.
 
 ## 2.0.0.beta2
-* Raise not return on max elapsed time, also check for elapsed time after next interval is calculated and it goes over the max elapsed time.
+* Raise, not return, on max elapsed time.
+* Check for elapsed time after next interval is calculated and it goes over the max elapsed time.
 * Add specs for `max_elapsed_time` and `max_interval`.
 
 ## 2.0.0.beta1
 * Require ruby 2.0+.
 * Default to random exponential backoff, removes the `interval` option. Exponential backoff is configurable via arguments.
-* Allow configurable defaults via `#configure`.
+* Allow configurable defaults via `Retriable#configure` block.
 * Change `Retriable.retriable` to `Retriable.retry`.
-* Support `max_elapsed_time` termination.
+* Support early termination via `max_elapsed_time` argument.
 
 ## 1.4.1
 * Fixes non kernel mode bug. Remove DSL class, move `#retriable` into Retriable module. Thanks @mkrogemann.

data/README.md

@@ -8,9 +8,11 @@ Retriable is an simple DSL to retry failed code blocks with randomized [exponent
 
 ## Requirements
 
-Ruby 2.0+
+Ruby 1.9.3+
 
-If you need 1.9.x support, use the [1.x branch](https://github.com/kamui/retriable/tree/1.x).
+If you need ruby 1.8.x to 1.9.2 support, use the [1.x branch](https://github.com/kamui/retriable/tree/1.x).
+
+There's a [1.x to 2.x migration wiki entry](https://github.com/kamui/retriable/wiki/Migrating-to-2.x) available.
 
 WARNING: 2.x isn't API compatible with 1.x.
 
@@ -161,10 +163,22 @@ end
 
 ### Turn off Exponential Backoff
 
-Exponential backoff is enabled by default, if you want to simply execute code every second, you can do this:
+Exponential backoff is enabled by default, if you want to simply retry code every second, 5 times maximum, you can do this:
 
 ```ruby
-Retriable.retriable base_interval: 1.0, multiplier: 1.0, rand_factor: 0.0 do
+Retriable.retriable tries: 5, base_interval: 1.0, multiplier: 1.0, rand_factor: 0.0 do
+  # code here...
+end
+```
+
+This works by starting at a 1 second interval (`base_interval`), setting the `multipler` to 1.0 means each subsequent try will increase 1x, which is still `1.0` seconds, and then a `rand_factor` of 0.0 means that there's no randomization of that interval. By default, it would randomize 0.25 seconds, which would mean normally the intervals would randomize between 0.75 and 1.25 seconds, but in this case `rand_factor` is basically being disabled.
+
+Another way to accomplish this would be to create an array with a fixed interval. In this example, `Array.new(5, 1)` creates an array with 5 elements, all with the value 1. The code block will retry up to 5 times, and wait 1 second between each attempt.
+
+```ruby
+# Array.new(5, 1) # => [1, 1, 1, 1, 1]
+
+Retriable.retriable intervals: Array.new(5, 1) do
   # code here...
 end
 ```
@@ -236,4 +250,4 @@ end
 
 ## Credits
 
-Retriable was originally forked from the retryable-rb gem by [Robert Sosinski](https://github.com/robertsosinski), which in turn originally inspired by code written by [Michael Celona](http://github.com/mcelona) and later assisted by [David Malin](http://github.com/dmalin). The [attempt](https://rubygems.org/gems/attempt) gem by Daniel J. Berger was also an inspiration.
+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.

data/lib/retriable.rb

@@ -16,18 +16,17 @@ module Retriable
     @config ||= Config.new
   end
 
-  def retriable(
-      tries:             config.tries,
-      base_interval:     config.base_interval,
-      max_interval:      config.max_interval,
-      rand_factor:       config.rand_factor,
-      multiplier:        config.multiplier,
-      max_elapsed_time:  config.max_elapsed_time,
-      intervals:         config.intervals,
-      timeout:           config.timeout,
-      on:                config.on,
-      on_retry:          config.on_retry
-    )
+  def retriable(opts = {})
+    tries             = opts[:tries]            || config.tries
+    base_interval     = opts[:base_interval]    || config.base_interval
+    max_interval      = opts[:max_interval]     || config.max_interval
+    rand_factor       = opts[:rand_factor]      || config.rand_factor
+    multiplier        = opts[:multiplier]       || config.multiplier
+    max_elapsed_time  = opts[:max_elapsed_time] || config.max_elapsed_time
+    intervals         = opts[:intervals]        || config.intervals
+    timeout           = opts[:timeout]          || config.timeout
+    on                = opts[:on]               || config.on
+    on_retry          = opts[:on_retry]         || config.on_retry
 
     start_time = Time.now
     elapsed_time = -> { Time.now - start_time }

data/lib/retriable/core_ext/kernel.rb

@@ -1,7 +1,7 @@
 require "retriable"
 
 module Kernel
-  def retriable(opts={}, &block)
+  def retriable(opts = {}, &block)
     Retriable.retriable(opts, &block)
   end
 end

data/lib/retriable/exponential_backoff.rb

@@ -6,19 +6,12 @@ module Retriable
     attr_accessor :max_interval
     attr_accessor :rand_factor
 
-    def initialize(
-        tries:            Retriable.config.tries,
-        base_interval:    Retriable.config.base_interval,
-        multiplier:       Retriable.config.multiplier,
-        max_interval:     Retriable.config.max_interval,
-        rand_factor:      Retriable.config.rand_factor
-      )
-
-      @tries          = tries
-      @base_interval  = base_interval
-      @multiplier     = multiplier
-      @max_interval   = max_interval
-      @rand_factor    = rand_factor
+    def initialize(opts = {})
+      @tries         = opts[:tries]         || Retriable.config.tries
+      @base_interval = opts[:base_interval] || Retriable.config.base_interval
+      @max_interval  = opts[:max_interval]  || Retriable.config.max_interval
+      @rand_factor   = opts[:rand_factor]   || Retriable.config.rand_factor
+      @multiplier    = opts[:multiplier]    || Retriable.config.multiplier
     end
 
     def intervals

data/lib/retriable/version.rb

@@ -1,3 +1,3 @@
 module Retriable
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/retriable.gemspec

@@ -22,9 +22,9 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0.0'
 
   spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 10.4"
 
-  spec.add_development_dependency "minitest", "~> 5.4"
+  spec.add_development_dependency "minitest", "~> 5.5"
   spec.add_development_dependency "guard"
   spec.add_development_dependency "guard-minitest"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: retriable
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Jack Chu
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '10.4'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.4'
+        version: '5.5'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement