attempt 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 087065c51e729d16ae28f79cb654fe9297320902
-  data.tar.gz: b3ec80db39e164a6ec2f551e0815dbc29e0b4c61
+  metadata.gz: 1ec70ec03f74ac462d0981aae31fd9e896b9aa68
+  data.tar.gz: 00a6fda1a874fe350ba06867f595e84c311cdf92
 SHA512:
-  metadata.gz: 3e65bf3517b1d6d529fc7e1e292b046f4b7a95a6e984f05c42addf293066a50082f9b88c78a6bf0ff5c0f2aeba3de5f0331f54981fd307ecfbbc1eb56276a880
-  data.tar.gz: e3e4a05d424117e0a3315f82d39f90f48927e348a6e87b400f5d1e54bd57ee87a9ef83c332f6b6a0a087cfe691781677512be76bb1c014f6de5879b576f34cd7
+  metadata.gz: 48a3c30acad26d4411cf450897defea366d343294e0b43f16f5685900461b323256da6f2c0a390c993da09dac844c1934bb213fbc5f17269154e12449aeed2cd
+  data.tar.gz: fddca1ffba92d22baf4c2d7ff6a4f6b410e33aee00f0045c6780a535fb3af93f62bd333241b27483140d41f25f8c5342d1feebd6ea39c873bcacf8adc94431a8

data/CHANGES

@@ -1,3 +1,9 @@
+== 0.4.0 - 5-Sep-2017
+* Switched constructor to use keyword arguments.
+* Replaced Timeout with SafeTimeout and added the safe_timeout dependency.
+* The :log option now accepts either an IO or Logger object.
+* Updated cert.
+
 == 0.3.2 - 4-Apr-2017
 * Fix metadata key names.
 

data/attempt.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'attempt'
-  spec.version    = '0.3.2'
+  spec.version    = '0.4.0'
   spec.author     = 'Daniel J. Berger'
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -22,6 +22,8 @@ Gem::Specification.new do |spec|
   }
 
   spec.add_dependency('structured_warnings', '~> 0.3.0')
+  spec.add_dependency('safe_timeout', '~> 0.0.5')
+
   spec.add_development_dependency('test-unit')
 
   spec.description = <<-EOF

data/certs/djberg96_pub.pem

@@ -1,21 +1,21 @@
 -----BEGIN CERTIFICATE-----
 MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
 cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-MB4XDTE2MDkxOTAzNDY0NVoXDTE3MDkxOTAzNDY0NVowPzERMA8GA1UEAwwIZGpi
+MB4XDTE3MDkwMzE1MjMxM1oXDTE4MDkwMzE1MjMxM1owPzERMA8GA1UEAwwIZGpi
 ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM0eOHOQRpLOeqkyeK7O
-DGHYLkO0Wq7gStVVVyHXahgyCopLN6JVBwGy5aCpKFcy5sFz2DdnISj+hQ7FctDa
-yz6Lq9TvAF8Jkis8dDFLQKeHilB/AM4ssQAsGQyoQnoE4v5tCOSW4e3YHFDp/dMZ
-s7Hkoim6PeEdkh4hB5LCa90OrHSPe8nlMFsVhRIGj86xNTRazEiWPZCOKmN9rZgW
-ziheP/6hC2c7vNRevv5iE/K+NqaL/WOdMquOSZoF2mdBcoMIPDDBNzh/oHinPQ3N
-1oOvoET0+Tj+O5tXX/L1TAsUrwZXlyrYGaZ5aYyoo/7r9pmvmbfgBqaU6JywT0EE
-5x0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFO+k
-C/3R+t2aIyIpwU5wPrAfYVL6MB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
+bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ8y4kEssxNpAdPhNNw2
+p4zkERFndPAnmOKDdErczFYYUA9uYpA7/iTjkLlNyRwvsNHpnMXdSF7vy++YIU+F
+Ux3AGTmspupbdSzqBNUhSEJ9TmpjMer1dMYMR9fRw3r3qQreiO2u/O/tV4VpzrDj
+28JC0b1PcKtfobxbnk+hporZqTH6ClOxDsRx+trlkr7q7FLZwTZn0ywjAV8WMVTO
+SMmkzXQ37s2Nnrq6r+dDZI0voBxyQkAUzmdBOQTrvOFAo3tuWcnJNR/RRdFhJ9nK
+mYMPmEd1z0s+cU0SUEeTvhGv/9LCmbSyZqKezDLYNR4Gb0FOA9D50+4OOi2+3G1o
+1U0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJCx
+ukSSioTiLtwQCdML0IyEZAJ/MB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
 bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-ggEBAIJWpqQOUMoYhpm0wJ4kfiYv9rZVbpZ3L2cFYt4O6+wgbpdWP8DBBgZfCSQW
-1J9miChMKdxZ8eOoeId79IMXN3IAcnalTFvD0Rp9ltaFZTXBfXMFqxQN3fHsIVwz
-as/JSbwXo/PE8rULhjU+Utwcmji38cKEDWLAW4vsCBmwvBTwmAmcuHHKjnNvd8aR
-YMrq9v505w8IjSysIO3KKysxCFuzoIPIYMdYswquvmtuTA+lpB9btWHr8n2FFsDp
-A943I/wqE6xbYQpHxkndWo5uLDUbZh+XxG+fhZKpeqLIqHaFuU6wdO5odt32kB/B
-nCjVswaVYlu1U2iLPCqE+MrjmTA=
+ggEBAJh/dmRaTpJAUeJ2x9CEyy9gSP6SZjMeAwWgPNdowPDyw0JzlpBIrYiTnCYK
+2OqxvIi8L38+rHw3KYL0fEyNqP3RbMl6+SljRwiU0JwEqj9e1pqIx99RTLKeI9PM
+F8LxxmDHreGOaY4R8JBOMxys1wBkF/Iilx4qoT4LBn+DzraAlmYjr6O6itIxGten
+NFJFS/tFBTTeNW6SJLdDnGd2b7vBBEd/ZpIhuZNxriU6FKWC5FJeBdAiuw6lqHun
+QLLepVJthIvwmfc8AU5TJGMawtVAUHIWiuQPoBBVVKOkeEhioO0cV8UabKsKMbE8
+VpiARrgH+4lYiRFJ+gKpIbSEJvk=
 -----END CERTIFICATE-----

data/lib/attempt.rb

@@ -1,4 +1,4 @@
-require 'timeout'
+require 'safe_timeout'
 require 'structured_warnings'
 
 # The Attempt class encapsulates methods related to multiple attempts at
@@ -6,7 +6,7 @@ require 'structured_warnings'
 class Attempt
 
   # The version of the attempt library.
-  VERSION = '0.3.2'.freeze
+  VERSION = '0.4.0'.freeze
 
   # Warning raised if an attempt fails before the maximum number of tries
   # has been reached.
@@ -38,21 +38,34 @@ class Attempt
   attr_accessor :level
 
   # :call-seq:
-  #    Attempt.new{ |a| ... }
+  #    Attempt.new(**kwargs)
   #
-  # Creates and returns a new +Attempt+ object.  Use a block to set the
-  # accessors.
+  # Creates and returns a new +Attempt+ object. The supported keyword options
+  # are as follows:
   #
-  def initialize
-    @tries     = 3         # Reasonable default
-    @interval  = 60        # Reasonable default
-    @log       = nil       # Should be an IO handle, if provided
-    @increment = nil       # Should be an int, if provided
-    @timeout   = nil       # Wrap the code in a timeout block if provided
-    @level     = Exception # Level of exception to be caught
-    @warnings  = true      # Errors are sent to STDERR as warnings if true
-
-    yield self if block_given?
+  # * tries     - The number of attempts to make before giving up. The default is 3.
+  # * interval  - The delay in seconds between each attempt. The default is 60.
+  # * log       - An IO handle or Logger instance where warnings/errors are logged to. The default is nil.
+  # * increment - The amount to increment the interval between tries. The default is 0.
+  # * level     - The level of exception to be caught. The default is everything, i.e. Exception.
+  # * warnings  - Boolean value that indicates whether or not errors are treated as warnings
+  #               until the maximum number of attempts has been made. The default is true.
+  # * timeout   - Boolean value to indicate whether or not to automatically wrap your
+  #               proc in a SafeTimeout block. The default is false.
+  #
+  # Example:
+  #
+  #   a = Attempt.new(tries: 5, increment: 10, timeout: true)
+  #   a.attempt{ http.get("http://something.foo.com") }
+  #
+  def initialize(**options)
+    @tries     = options[:tries] || 3         # Reasonable default
+    @interval  = options[:interval] || 60     # Reasonable default
+    @log       = options[:log]                # Should be an IO handle, if provided
+    @increment = options[:increment] || 0     # Should be an integer, if provided
+    @timeout   = options[:timeout] || false   # Wrap the code in a timeout block if provided
+    @level     = options[:level] || Exception # Level of exception to be caught
+    @warnings  = options[:warnings] || true   # Errors are sent to STDERR as warnings if true
   end
 
   # Attempt to perform the operation in the provided block up to +tries+
@@ -65,7 +78,7 @@ class Attempt
     count = 1
     begin
       if @timeout
-        Timeout.timeout(@timeout){ yield }
+        SafeTimeout.timeout(@timeout){ yield }
       else
         yield
       end
@@ -75,7 +88,11 @@ class Attempt
         msg = "Error on attempt # #{count}: #{error}; retrying"
         count += 1
         warn Warning, msg if @warnings
-        @log.puts msg if @log
+
+        if @log # Accept an IO or Logger object
+          @log.respond_to?(:puts) ? @log.puts(msg) : @log.warn(msg)
+        end
+
         @interval += @increment if @increment
         sleep @interval
         retry
@@ -87,34 +104,28 @@ end
 
 module Kernel
    # :call-seq:
-   #    attempt(tries = 3, interval = 60, timeout = nil){ # some op }
+   #    attempt(tries: 3, interval: 60, timeout: 10){ # some op }
    #
    # Attempt to perform the operation in the provided block up to +tries+
-   # times, sleeping +interval+ between each try.  By default the number
+   # times, sleeping +interval+ between each try. By default the number
    # of tries defaults to 3, the interval defaults to 60 seconds, and there
    # is no timeout specified.
    #
    # If +timeout+ is provided then the operation is wrapped in a Timeout
-   # block as well.  This is handy for those rare occasions when an IO
+   # block as well. This is handy for those rare occasions when an IO
    # connection could hang indefinitely, for example.
    #
    # If the operation still fails the (last) error is then re-raised.
    #
-   # This is really just a wrapper for Attempt.new where the simple case is
-   # good enough i.e. you don't care about warnings, increments or logging,
-   # and you want a little added convenience.
+   # This is really just a convenient wrapper for Attempt.new + Attempt#attempt.
    #
    # Example:
    #
    #    # Make 3 attempts to connect to the database, 60 seconds apart.
    #    attempt{ DBI.connect(dsn, user, passwd) }
    #
-   def attempt(tries = 3, interval = 60, timeout = nil, &block)
-      raise 'no block given' unless block_given?
-      Attempt.new{ |a|
-        a.tries    = tries
-        a.interval = interval
-        a.timeout  = timeout if timeout
-      }.attempt(&block)
+   def attempt(**kwargs, &block)
+     object = Attempt.new(kwargs)
+     object.attempt(&block)
    end
 end

data/test.rb

@@ -0,0 +1,10 @@
+$:.unshift 'lib'
+require 'attempt'
+require 'logger'
+
+log = Logger.new(STDOUT)
+
+p Attempt::VERSION
+
+
+attempt(tries: 2, log: log, timeout: 1, interval: 2){ sleep 3 }

data/test/test_attempt.rb

@@ -23,7 +23,7 @@ class TC_Attempt < Test::Unit::TestCase
   end
 
   test "version constant is set to expected value" do
-    assert_equal('0.3.2', Attempt::VERSION)
+    assert_equal('0.4.0', Attempt::VERSION)
   end
 
   test "attempt works as expected without arguments" do
@@ -31,24 +31,28 @@ class TC_Attempt < Test::Unit::TestCase
   end
 
   test "attempt retries the number of times specified" do
-    assert_nothing_raised{ attempt(@tries){ $value += 1; raise if $value < 2 } }
+    assert_nothing_raised{ attempt(tries: @tries){ $value += 1; raise if $value < 2 } }
     assert_equal(2, $value)
   end
 
   test "attempt retries the number of times specified with interval" do
-    assert_nothing_raised{ attempt(@tries, @interval){ $value += 1; raise if $value < 2 } }
+    assert_nothing_raised{
+      attempt(tries: @tries, interval: @interval){ $value += 1; raise if $value < 2 }
+    }
   end
 
   test "attempt retries the number of times specified with interval and timeout" do
-    assert_nothing_raised{ attempt(@tries, @interval, @timeout){ $value += 1; raise if $value < 2 } }
+    assert_nothing_raised{
+      attempt(tries: @tries, interval: @interval, timeout: @timeout){ $value += 1; raise if $value < 2 }
+    }
   end
 
   test "attempt raises a timeout error if timeout value is exceeded" do
-    assert_raises(Timeout::Error){ attempt(1, 1, @timeout){ sleep 5 } }
+    assert_raises(Timeout::Error){ attempt(tries: 1, interval: 1, timeout: @timeout){ sleep 5 } }
   end
 
   test "attempt raises exception as expected" do
-    assert_raises(RuntimeError){ attempt(2, 2){ raise } }
+    assert_raises(RuntimeError){ attempt(tries: 2, interval: 2){ raise } }
   end
 
   def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attempt
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Daniel J. Berger
@@ -12,25 +12,25 @@ cert_chain:
   -----BEGIN CERTIFICATE-----
   MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
   cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTE2MDkxOTAzNDY0NVoXDTE3MDkxOTAzNDY0NVowPzERMA8GA1UEAwwIZGpi
+  MB4XDTE3MDkwMzE1MjMxM1oXDTE4MDkwMzE1MjMxM1owPzERMA8GA1UEAwwIZGpi
   ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
-  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM0eOHOQRpLOeqkyeK7O
-  DGHYLkO0Wq7gStVVVyHXahgyCopLN6JVBwGy5aCpKFcy5sFz2DdnISj+hQ7FctDa
-  yz6Lq9TvAF8Jkis8dDFLQKeHilB/AM4ssQAsGQyoQnoE4v5tCOSW4e3YHFDp/dMZ
-  s7Hkoim6PeEdkh4hB5LCa90OrHSPe8nlMFsVhRIGj86xNTRazEiWPZCOKmN9rZgW
-  ziheP/6hC2c7vNRevv5iE/K+NqaL/WOdMquOSZoF2mdBcoMIPDDBNzh/oHinPQ3N
-  1oOvoET0+Tj+O5tXX/L1TAsUrwZXlyrYGaZ5aYyoo/7r9pmvmbfgBqaU6JywT0EE
-  5x0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFO+k
-  C/3R+t2aIyIpwU5wPrAfYVL6MB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAJ8y4kEssxNpAdPhNNw2
+  p4zkERFndPAnmOKDdErczFYYUA9uYpA7/iTjkLlNyRwvsNHpnMXdSF7vy++YIU+F
+  Ux3AGTmspupbdSzqBNUhSEJ9TmpjMer1dMYMR9fRw3r3qQreiO2u/O/tV4VpzrDj
+  28JC0b1PcKtfobxbnk+hporZqTH6ClOxDsRx+trlkr7q7FLZwTZn0ywjAV8WMVTO
+  SMmkzXQ37s2Nnrq6r+dDZI0voBxyQkAUzmdBOQTrvOFAo3tuWcnJNR/RRdFhJ9nK
+  mYMPmEd1z0s+cU0SUEeTvhGv/9LCmbSyZqKezDLYNR4Gb0FOA9D50+4OOi2+3G1o
+  1U0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFJCx
+  ukSSioTiLtwQCdML0IyEZAJ/MB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
   bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-  ggEBAIJWpqQOUMoYhpm0wJ4kfiYv9rZVbpZ3L2cFYt4O6+wgbpdWP8DBBgZfCSQW
-  1J9miChMKdxZ8eOoeId79IMXN3IAcnalTFvD0Rp9ltaFZTXBfXMFqxQN3fHsIVwz
-  as/JSbwXo/PE8rULhjU+Utwcmji38cKEDWLAW4vsCBmwvBTwmAmcuHHKjnNvd8aR
-  YMrq9v505w8IjSysIO3KKysxCFuzoIPIYMdYswquvmtuTA+lpB9btWHr8n2FFsDp
-  A943I/wqE6xbYQpHxkndWo5uLDUbZh+XxG+fhZKpeqLIqHaFuU6wdO5odt32kB/B
-  nCjVswaVYlu1U2iLPCqE+MrjmTA=
+  ggEBAJh/dmRaTpJAUeJ2x9CEyy9gSP6SZjMeAwWgPNdowPDyw0JzlpBIrYiTnCYK
+  2OqxvIi8L38+rHw3KYL0fEyNqP3RbMl6+SljRwiU0JwEqj9e1pqIx99RTLKeI9PM
+  F8LxxmDHreGOaY4R8JBOMxys1wBkF/Iilx4qoT4LBn+DzraAlmYjr6O6itIxGten
+  NFJFS/tFBTTeNW6SJLdDnGd2b7vBBEd/ZpIhuZNxriU6FKWC5FJeBdAiuw6lqHun
+  QLLepVJthIvwmfc8AU5TJGMawtVAUHIWiuQPoBBVVKOkeEhioO0cV8UabKsKMbE8
+  VpiARrgH+4lYiRFJ+gKpIbSEJvk=
   -----END CERTIFICATE-----
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2017-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: structured_warnings
@@ -46,6 +46,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: safe_timeout
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -85,6 +99,7 @@ files:
 - README
 - test
 - test/test_attempt.rb
+- test.rb
 homepage: https://github.com/djberg96/attempt
 licenses:
 - Artistic 2.0
@@ -109,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: A thin wrapper for begin + rescue + sleep + retry