try-until 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTgyNWMzYmMwZjI0MWQ1OGJkZjRlYjJmNjVhMmM4NjViZjNmZTI3Mw==
+  data.tar.gz: !binary |-
+    YzliYTUyOGIwOTExNmUwNjZiZGVlMTMwNmRmZjY1NDc0Y2Y5ZGMxMQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZjRkOWU5NWI5M2I3OWI4OTJlMzNlNDc3ZTM3Y2I4ZmExNDNkNjU4ZGYyN2U0
+    MjUxNzY0NDhiOWY1YmQxZGEyMTQ4MDFkODFkODI5ZGUwZmRmZDk5YzE2NTlh
+    ZjcyNjZlZGQ0NTRiYzJjNzQ5YTlmZmEzODQ0YmNiYjZhMGNmNmU=
+  data.tar.gz: !binary |-
+    ODY3MDVhMzAxNjlkZWRhMDE2NGFlNWE0ZDJhNDk4YzlmZjYxMWNkNTdmNDNi
+    MjgxZGI2NzU2ZjAwY2VlZTJmZTQ2Yzk4NDMxNTk0Y2YxYjRlMjdlMmYzODQ4
+    YWQ3MTRjNzUyZjIyMmRiYTgxOWY1ZWFjZGYyMGIwN2Y2ZWRiNGM=

data/lib/try-until.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/try_until'

data/lib/try_until.rb

@@ -0,0 +1,4 @@
+require 'try_until/probe'
+require 'try_until/repeatedly'
+
+

data/lib/try_until/probe.rb

@@ -0,0 +1,23 @@
+module TryUntil
+  # This PORO holds information about a target object against which
+  # to call a specified method with specified arguments
+  class Probe
+
+    # Example: Probe.new(SomeClass.new, :some_method, [arg1, arg2, ...])
+    def initialize(target, method, args = [])
+      @target = target
+      @method = method
+      @args = args
+    end
+
+    def sample
+      @target.send(@method, *@args)
+    end
+
+    def to_s
+      "Probe: #{@target.class}##{@method}(#{@args})"
+    end
+  end
+end
+
+

data/lib/try_until/repeatedly.rb

@@ -0,0 +1,73 @@
+module TryUntil
+  # External interface
+  # Example:
+  # include TryUntil
+  # result = Repeatedly.new(Probe.new(Object.new, :to_s))
+  #   .attempts(5)
+  #   .interval(10)
+  #   .rescues([ ArgumentError, IOError ])
+  #   .stop_when(lambda { |response| JSON.parse(response.body)['id'] == 'some_id' })
+  # .execute
+  #
+  # Not all of the above settings are required. These are the default values:
+  # attempt    = 3
+  # interval   = 0
+  # rescues    = []
+  # stop_when  = lambda { |response| false }
+  #
+  class Repeatedly
+
+    def initialize(probe)
+      @probe = probe
+    end
+
+    def attempts(int_num)
+      @attempts = int_num
+      self
+    end
+
+    def interval(seconds)
+      @interval = seconds
+      self
+    end
+
+    def rescues(errors)
+      @rescues = errors
+      self
+    end
+
+    def stop_when(callable)
+      @stop_when = callable
+      self
+    end
+
+    # The heart of this gem: This method will repeatedly call '#sample' on the
+    # subject and evaluate if the expectated result is returned.
+    # In case of errors it will rescue those and continue, provided the type
+    # of error is among the ones defined in @rescues.
+    def execute
+      @attempts = 3 unless @attempts
+      @interval = 0 unless @interval
+      @stop_when = lambda { |response| false } unless @stop_when
+      @rescues = [] unless @rescues
+      count = 0
+      while count < @attempts
+        begin
+          result = @probe.sample
+          return result if @stop_when.call(result)
+        rescue *@rescues => exception
+          raise exception, "During final attempt (#{@attempts} configured) target returned #{exception}" if count + 1 == @attempts
+        ensure
+          count += 1
+          Kernel.sleep @interval if @interval > 0
+        end
+      end
+      raise "After #{@attempts} attempts, the expected result was not returned!"
+    end
+
+    def configuration
+      { :probe => @probe.to_s, :attempts => @attempts, :interval => @interval,
+        :rescues => @rescues, :stop_when => @stop_when }
+    end
+  end
+end

data/lib/try_until/version.rb

@@ -0,0 +1,3 @@
+module TryUntil
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: try-until
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Markus Krogemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: metric_fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.4.1
+description: The try-until library supports repeatedly calling code that may fail
+  or respond with values other than expected. Matchers, realized as lambdas, can be
+  used to specify expected result.
+email:
+- markus@krogemann.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/try-until.rb
+- lib/try_until/probe.rb
+- lib/try_until/repeatedly.rb
+- lib/try_until/version.rb
+- lib/try_until.rb
+homepage: https://github.com/mkrogemann/try-until
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Retry and matching logic
+test_files: []