exponential-backoff 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+script: ruby -Ilib -Itest test/exponential_backoff_test.rb
+rvm:
+  - 1.9.3
+  - 1.9.2
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in exponential_backoff.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Paweł Pacana
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+Exponential Backoff
+===================
+
+[![Build Status](https://secure.travis-ci.org/pawelpacana/exponential-backoff.png)](http://travis-ci.org/pawelpacana/exponential-backoff)
+
+Too lazy to make retries to external services in a fashion that providers recommend? Never heard of [exponential backoff](http://en.wikipedia.org/wiki/Exponential_backoff) technique? Now there is no excuse not to be nice.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'exponential-backoff'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install exponential-backoff
+```
+
+Usage
+-----
+
+Start with specifying minimal and maximal intervals, that is `4s` and `60s` respectively:
+
+```ruby
+minimal_interval = 4.0
+maximal_elapsed_time = 60.0
+
+backoff = ExponentialBackoff.new(minimal_interval, maximal_elapsed_time)
+```
+
+You can get intervals for specified range:
+
+```ruby
+backoff.intervals_for(0..5) # [4.0, 8.0, 16.0, 32.0, 60.0, 60.0]
+```
+
+Enumerate on them:
+
+```ruby
+backoff.intervals.each do |interval|
+  sleep(interval)
+end
+```
+
+Or just get interval for requested, that is 3rd, iteration:
+
+```ruby
+backoff.interval_at(3) # 32.0
+```
+
+Intervals don't exceed maximal allowed time:
+
+```ruby
+backoff.interval_at(20) # 60.0
+```
+
+Backoff instance maintains state, you can ask for next interval...
+
+```ruby
+backoff.next_interval # 4.0
+backoff.next_interval # 8.0
+```
+
+...and reset it to start from beginning
+
+```ruby
+backoff.clear
+backoff.next_interval # 4.0
+```
+
+Finally you can specify interval multiplier and randomization factor:
+
+```ruby
+backoff = ExponentialBackoff.new(min_interval, max_elapsed)
+backoff.multiplier = 1.5
+backoff.randomize_factor = 0.25
+
+backoff.intervals_for(0..2) # [3.764, 6.587, 9.76]
+```
+
+You can peek what is the current interval:
+
+```ruby
+backoff.current_interval # 3.764
+```
+
+There is also sugar for executing block of code until successful with increasing intervals:
+
+```ruby
+backoff.until_success do |interval, retry_count|
+  # do your thing
+  # when last line in block evaluates to true, elapsed time clear and loop breaks
+  # when false, increase interval and retry
+
+  # you can break loop earlier if you want,
+  # `nil` return value is considered a success
+  return if retry_count > 3
+end
+```
+
+Running tests
+-------------
+
+    ruby -Ilib -Itest test/exponential_backoff_test.rb
+
+
+Supported rubies
+----------------
+
+Targets all Rubies (including Rubinius and JRuby) provided it's at least 1.9 mode.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/exponential-backoff.gemspec

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/exponential_backoff/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Paweł Pacana"]
+  gem.email         = ["pawel.pacana@gmail.com"]
+  gem.summary       = %q{Exponential backoff algorithm for better reconnect intervals.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "exponential-backoff"
+  gem.require_paths = ["lib"]
+  gem.version       = ExponentialBackoff::VERSION
+end

data/lib/exponential_backoff.rb

@@ -0,0 +1,66 @@
+require 'exponential_backoff/version'
+
+class ExponentialBackoff
+  attr_accessor :multiplier, :randomize_factor
+  attr_reader   :current_interval
+
+  def initialize(minimal_interval, maximum_elapsed_time)
+    @maximum_elapsed_time = maximum_elapsed_time
+    @minimal_interval = minimal_interval
+    @randomize_factor = 0
+    @multiplier = 2.0
+    clear
+  end
+
+  def clear
+    @enumerator = intervals
+  end
+
+  def next_interval
+    @current_interval = @enumerator.next
+  end
+
+  def intervals_for(range)
+    range.to_a.map { |iteration| interval_at(iteration) }
+  end
+
+  def interval_at(iteration)
+    randomized_interval(capped_interval(regular_interval(@minimal_interval, @multiplier, iteration)))
+  end
+
+  def intervals
+    Enumerator.new do |yielder|
+      iteration = 0
+      loop do
+        yielder.yield interval_at(iteration)
+        iteration += 1
+      end
+    end
+  end
+
+  def until_success(&block)
+    intervals.each_with_index do |interval, iteration|
+      retval = block.call(interval, iteration)
+      return if retval || retval.nil?
+      sleep(interval)
+    end
+  end
+
+  protected
+
+  def regular_interval(initial, multiplier, iteration)
+    initial * multiplier ** iteration
+  end
+
+  def randomized_interval(interval)
+    return interval if @randomize_factor == 0
+    min = (1 - @randomize_factor) * interval
+    max = (1 + @randomize_factor) * interval
+    rand(max - min) + min
+  end
+
+  def capped_interval(interval)
+    [@maximum_elapsed_time, interval].min
+  end
+end
+

data/lib/exponential_backoff/version.rb

@@ -0,0 +1,3 @@
+class ExponentialBackoff
+  VERSION = "0.0.1"
+end

data/test/exponential_backoff_test.rb

@@ -0,0 +1,158 @@
+require 'test/unit'
+require 'exponential_backoff'
+
+class ExponentialBackoffTest < Test::Unit::TestCase
+  def test_multiplier_default
+    min, max = 1, 2
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_equal 2, backoff.multiplier
+  end
+
+  def test_randomize_factor_default
+    min, max = 1, 2
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_equal 0, backoff.randomize_factor
+  end
+
+  def test_next_interval
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_equal min, backoff.next_interval
+    assert_equal 2,   backoff.next_interval
+    assert_equal 4,   backoff.next_interval
+    assert_equal max, backoff.next_interval
+  end
+
+  def test_current_interval
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_nil backoff.current_interval
+    backoff.next_interval
+    assert_equal 1, backoff.current_interval
+  end
+
+  def test_clear
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+    2.times { backoff.next_interval }
+    backoff.clear
+
+    assert_equal min, backoff.next_interval
+  end
+
+  def test_interval_at
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_equal 5, backoff.interval_at(3)
+  end
+
+  def test_intervals_for
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_equal [2, 4, 5, 5], backoff.intervals_for(1..4)
+  end
+
+  def test_intervals_is_enumerator
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_kind_of Enumerator, backoff.intervals
+  end
+
+  def test_intervals_enumerator_is_independent
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+    first, second = backoff.intervals, backoff.intervals
+    first.next
+
+    assert_not_equal first.next, second.next
+  end
+
+  def test_interval_is_float
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_kind_of Float, backoff.next_interval
+  end
+
+  def test_multiplier
+    min, max = 1, 512
+    backoff = ExponentialBackoff.new(min, max)
+    backoff.multiplier = 4
+
+    assert_equal [4, 16, 64, 256], backoff.intervals_for(1..4)
+  end
+
+  def test_randomize_factor
+    min, max = 1, 5
+    backoff = ExponentialBackoff.new(min, max)
+    backoff.randomize_factor = 0.25
+
+    1_000.times do
+      assert_in_delta(0.75, 1.25, backoff.interval_at(0))
+      assert_in_delta(3.75, 6.25, backoff.interval_at(100))
+    end
+  end
+
+  def test_until_success_executor_stops_on_truthiness_return_value
+    min, max = 0.1, 0.5
+    backoff = ExponentialBackoff.new(min, max)
+
+    counter = 0
+    return_true = -> {
+      counter += 1
+      return true
+    }
+    backoff.until_success { return_true.call }
+    assert_equal 1, counter
+  end
+
+  def test_until_success_executor_continues_on_falsy_return_value
+    min, max = 0.1, 0.5
+    backoff = ExponentialBackoff.new(min, max)
+
+    counter = 0
+    return_false = -> {
+      counter += 1
+      return if counter > 1
+      return false
+    }
+    backoff.until_success { return_false.call }
+    assert_equal 2, counter
+  end
+
+  def test_until_success_block_params
+    min, max = 0.1, 0.5
+    backoff = ExponentialBackoff.new(min, max)
+
+    assert_block_params = proc do |interval, iteration|
+      assert_equal backoff.interval_at(iteration), interval
+    end
+
+    backoff.until_success { |interval, iteration| assert_block_params.call(interval, iteration) }
+  end
+
+  def test_until_success_executor_sleep_time
+    min, max = 0.1, 0.5
+    backoff = ExponentialBackoff.new(min, max)
+
+    counter = 0
+    return_false = -> {
+      counter += 1
+      return if counter > 2
+      return false
+    }
+
+    time = Time.now.to_f
+    backoff.until_success { return_false.call }
+    elapsed = Time.now.to_f - time
+    assert elapsed >= 0.3
+  end
+end
+

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: exponential-backoff
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Paweł Pacana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-26 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- pawel.pacana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exponential-backoff.gemspec
+- lib/exponential_backoff.rb
+- lib/exponential_backoff/version.rb
+- test/exponential_backoff_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Exponential backoff algorithm for better reconnect intervals.
+test_files:
+- test/exponential_backoff_test.rb
+has_rdoc: