exponential-backoff 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b3d8890e6844a79464767d236abf56bc79bc042b7cc326cc8b02b9ec5930c42
+  data.tar.gz: 36a5cbf1b5858ec4f0c8c751c6dd1cbc5f7287ba8aebb793104f824f87e73950
+SHA512:
+  metadata.gz: 9d6580e6e8fa3af28e4432bc2f6614ecdc08547f73c30892056edec9c689157ca50425cadaf8281fa2cc546526318f3cb0c679d0a8d7718f390e76cb1f944f1b
+  data.tar.gz: 1dac51c82eee0325daaf8708bb867e28346c78a31c6438d5dccced7cc48e24390d6d381d57799527f97e4e4b3c04793075efe1fb4372560fd575bcfab7600d0d

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,6 @@
+language: ruby
+rvm:
+  - 2.6.5
+  - 2.5.7
+  - 2.4.9
+  - jruby

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+0.0.3
+
+  - Give bundler a chance to require this gem when listed in Gemfile
+
+0.0.2
+
+  - Initialize backoff with Array or Range as a convenience.
+  - Check if given iteration is one of intervals when running in a loop.
+
+0.0.1
+
+  - Initial version.

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,136 @@
+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)
+```
+
+Arrays and ranges work for your convenience too:
+
+```ruby
+backoff = ExponentialBackoff.new(minimal_interval..maximal_elapsed_time)
+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
+```
+
+You can check if given iteration is one of intervals or maximum interval multiple:
+
+```ruby
+backoff = ExponentialBackoff.new(1, 10)
+backoff.iteration_active?(4) # true
+backoff.iteration_active?(20) # true
+backoff.iteration_active?(3) # false
+```
+
+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
+-------------
+
+    bundle exec rake test
+
+
+Supported rubies
+----------------
+
+Targets all Rubies (including Rubinius and JRuby) provided it's at least 1.9 mode.

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+desc "Run tests"
+task :default => :test

data/exponential-backoff.gemspec

@@ -0,0 +1,19 @@
+# -*- 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
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'test-unit'
+end

data/lib/exponential/backoff.rb

@@ -0,0 +1 @@
+require 'exponential_backoff'

data/lib/exponential_backoff.rb

@@ -0,0 +1,81 @@
+require 'exponential_backoff/version'
+
+class ExponentialBackoff
+  attr_accessor :multiplier, :randomize_factor
+  attr_reader   :current_interval
+
+  def initialize(interval, maximum_elapsed_time = nil)
+    if interval.respond_to?(:first)
+      @minimal_interval, @maximum_elapsed_time = interval.first, interval.last
+    else
+      @minimal_interval, @maximum_elapsed_time = interval, maximum_elapsed_time
+    end
+    raise ArgumentError, "Invalid range specified" if [@minimal_interval, @maximum_elapsed_time].any? { |i| !i.is_a?(Numeric) }
+
+    @randomize_factor = 0
+    @multiplier = 2.0
+    clear
+  end
+
+  def clear
+    @enumerator = intervals
+  end
+
+  def next_interval
+    @current_interval = @enumerator.next
+  end
+
+  def iteration_active?(iteration)
+    index = 0
+    current_interval = interval_at(index)
+    while current_interval < iteration && current_interval < @maximum_elapsed_time
+      index += 1
+      current_interval = interval_at(index)
+    end
+    current_interval == iteration || iteration % @maximum_elapsed_time == 0
+  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.3"
+end

data/test/exponential_backoff_test.rb

@@ -0,0 +1,189 @@
+require 'test/unit'
+require 'exponential_backoff'
+
+class ExponentialBackoffTest < Test::Unit::TestCase
+  def test_range_initializer
+    backoff = ExponentialBackoff.new(1..5)
+    assert_equal [1, 2, 4, 5], backoff.intervals_for(0..3)
+  end
+
+  def test_array_initializer
+    backoff = ExponentialBackoff.new([1, 5])
+    assert_equal [1, 2, 4, 5], backoff.intervals_for(0..3)
+  end
+
+  def test_no_maximal_time
+    assert_raise ArgumentError do
+      ExponentialBackoff.new(2)
+    end
+  end
+
+  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
+
+  def test_iteration_active_for_one_from_list
+    backoff = ExponentialBackoff.new(1, 10)
+    assert backoff.iteration_active?(4)
+  end
+
+  def test_iteration_active_for_maximum_interval_multiple
+    backoff = ExponentialBackoff.new(1, 10)
+    assert backoff.iteration_active?(20)
+  end
+
+  def test_iteration_active_for_not_from_list_and_not_multiple
+    backoff = ExponentialBackoff.new(1, 10)
+    refute backoff.iteration_active?(6)
+  end
+end
+

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: exponential-backoff
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Paweł Pacana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- pawel.pacana@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- exponential-backoff.gemspec
+- lib/exponential/backoff.rb
+- lib/exponential_backoff.rb
+- lib/exponential_backoff/version.rb
+- test/exponential_backoff_test.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Exponential backoff algorithm for better reconnect intervals.
+test_files:
+- test/exponential_backoff_test.rb