attempt 0.3.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 087065c51e729d16ae28f79cb654fe9297320902
-  data.tar.gz: b3ec80db39e164a6ec2f551e0815dbc29e0b4c61
+SHA256:
+  metadata.gz: 9f4489fdcd16a1e4fd93187cf684afc4eb42b9d1b35987372ce099b0081ab938
+  data.tar.gz: 0d359e069dded75e7e0871c1903f5950275b5f033e22490ea3358c55e8883df0
 SHA512:
-  metadata.gz: 3e65bf3517b1d6d529fc7e1e292b046f4b7a95a6e984f05c42addf293066a50082f9b88c78a6bf0ff5c0f2aeba3de5f0331f54981fd307ecfbbc1eb56276a880
-  data.tar.gz: e3e4a05d424117e0a3315f82d39f90f48927e348a6e87b400f5d1e54bd57ee87a9ef83c332f6b6a0a087cfe691781677512be76bb1c014f6de5879b576f34cd7
+  metadata.gz: 61728e4d946893471d103dfa8f2114212bf9438774b6636cff3744186fe0c99f7e48687969abe8627aa48b4cdb0d7203666978ded8bae2b3ba9d4f1e2616d57b
+  data.tar.gz: a34ac935d3fde78fed37884e93f9019c015a106c15f741732fedd2184c298eb1233ab23f967dfb85bfa6eaf1bb873d6e208730c20cf59cf40bbf101122f5c1a5

data/{CHANGES → CHANGES.md}

@@ -1,21 +1,53 @@
-== 0.3.2 - 4-Apr-2017
+## 0.6.1 - 20-Oct-2020
+* Switched the README, MANIFEST and CHANGES to markdown format.
+* Fiddling with the .travis.yml file again.
+
+## 0.6.0 - 17-Sep-2020
+
+* Switched from test-unit to rspec and rewrote the specs.
+
+## 0.5.1 - 28-Aug-2020
+
+* Added a Gemfile.
+* Updated Rakefile to clean .lock files.
+* Bumped structured_warnings version to 0.4.0 so that it works with Ruby 2.7.
+  Thanks go to Alexey Zapriy for the spot.
+
+## 0.5.0 - 2-Jun-2020
+
+* Switched to Apache-2.0 license, added LICENSE file.
+* Updated cert again.
+
+## 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.
 
-== 0.3.1 - 4-Apr-2017
+## 0.3.1 - 4-Apr-2017
+
 * Added some metadata to the gemspec.
 
-== 0.3.0 - 27-Mar-2017
+## 0.3.0 - 27-Mar-2017
+
 * The structured_warnings gem requirement was updated to 0.3.0 or later. This
   is necessary if you are using Ruby 2.4 or later.
 * The VERSION string is now frozen.
 * Updated the certs file.
 
-== 0.2.1 - 13-Dec-2015
+## 0.2.1 - 13-Dec-2015
+
 * This gem is now signed.
 * Updates to the Rakefile and gemspec.
 * Added a caveat regarding the timeout module to the README.
 
-== 0.2.0 - 26-Sep-2009
+## 0.2.0 - 26-Sep-2009
+
 * Now requires and uses the structured_warnings gem. If a block of code fails
   prior to reaching the maximum number of tries, and warnings are on, then
   an Attempt::Warning is raised.
@@ -23,16 +55,19 @@
 * Refactored the attempt.gemspec file a bit.
 * Added the 'gem' task to the Rakefile.
 
-== 0.1.2 - 1-Aug-2009
+## 0.1.2 - 1-Aug-2009
+
 * License changed to Artistic 2.0.
 * Added test-unit as a development dependency.
 * Test file renamed to more closely follow Ruby style.
 * Gemspec updates, including addition of license.
 
-== 0.1.1 - 31-Jul-2007
+## 0.1.1 - 31-Jul-2007
+
 * Added a Rakefile with tasks for testing and installation.
 * Removed the install.rb file, since installation is now handled by the Rakefile.
 * Some minor doc updates.
 
-== 0.1.0 - 9-Jun-2006
+## 0.1.0 - 9-Jun-2006
+
 * Initial commit

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org' do
+  gem 'rake'
+  gem 'structured_warnings', '~> 0.4.0'
+  gem 'safe_timeout', '~> 0.0.5'
+  group 'test' do
+    gem 'rspec', '~> 3.9'
+  end
+end

data/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

data/MANIFEST.md

@@ -0,0 +1,10 @@
+* CHANGES.md
+* LICENSE
+* MANIFEST.md
+* README.md
+* Gemfile
+* Rakefile
+* attempt.gemspec
+* certs/djberg96_pub.pem
+* lib/attempt.rb
+* spec/attempt_spec.rb

data/README.md

@@ -0,0 +1,84 @@
+## Description
+
+A thin wrapper for begin + rescue + sleep + retry.
+
+## Installation
+
+gem install attempt   
+
+## Synopsis
+
+```
+  require 'attempt'
+   
+  # Attempt to ftp to some host, trying 3 times with 30 seconds between
+  # attempts before finally raising an error.
+ 
+  attempt(tries: 3, interval: 30){
+    Net::FTP.open(host, user, passwd){ ... }
+  }
+   
+  # Or, do things the long way...
+  code = Attempt.new do |a|
+    a.tries    = 3
+    a.interval = 30
+  end
+   
+  code.attempt{
+    Net::FTP.open(host, user, passwd){ ... }
+  }
+```
+
+## Known Bugs
+
+None that I'm aware of. If you find any bugs, please log them on the project page at:
+
+https://github.com/djberg96/attempt
+
+## Caveats
+
+Use with caution. Specifically, make sure you aren't inadvertantly
+wrapping code that already performs sleep + retry. Otherwise, you'll
+end up with a series of nested retry's that could take much longer to
+work than you expect. 
+
+Also, this library uses the timeout library internally, which has some
+known issues. See Future Plans, below.
+
+As of version 0.3.0, this library requires structured_warnings 0.3.0 or
+later. This is necessary because of changes in Ruby 2.4.
+
+Update: I've switched from the timeout library in the standard library to
+the safe_timeout library which should improve things. In addition, the
+structured_warnings library requirement is now 0.4.0 or later in order to
+work with Ruby 2.7.
+
+## Future Plans
+
+Add the ability to set an absolute maximum number of seconds to prevent
+nested sleep/retry from delaying attempts longer than expected.
+
+Replace the timeout library with a self selecting pipe if possible.
+
+## Acknowledgements
+
+This library is partially based on Mark Fowler's 'Attempt' Perl module.
+
+## Warranty
+
+This package is provided "as is" and without any express or
+implied warranties, including, without limitation, the implied
+warranties of merchantability and fitness for a particular purpose.
+
+## License
+
+Apache-2.0
+
+## Copyright
+
+(C) 2006-2020, Daniel J. Berger
+All Rights Reserved
+
+## Author
+
+Daniel J. Berger

data/Rakefile

@@ -1,29 +1,26 @@
-require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-
-CLEAN.include('**/*.gem', '**/*.rbc')
-
-namespace :gem do
-  desc 'Build the attempt gem'
-  task :create => [:clean] do
-    require 'rubygems/package'
-    spec = eval(IO.read('attempt.gemspec'))
-    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
-    Gem::Package.build(spec, true)
-  end
-
-  desc "Install the attempt gem"
-  task :install => [:create] do
-    file = Dir["*.gem"].first
-    sh "gem install -l #{file}"
-  end
-end
-
-Rake::TestTask.new do |t|
-  task :test => :clean
-  t.warning = true
-  t.verbose = true
-end
-
-task :default => :test
+require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+
+CLEAN.include('**/*.gem', '**/*.rbc', '**/*.lock')
+
+namespace :gem do
+  desc 'Build the attempt gem'
+  task :create => [:clean] do
+    require 'rubygems/package'
+    spec = eval(IO.read('attempt.gemspec'))
+    spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
+    Gem::Package.build(spec)
+  end
+
+  desc "Install the attempt gem"
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install -l #{file}"
+  end
+end
+
+desc "Run the test suite"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/attempt.gemspec

@@ -2,18 +2,16 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'attempt'
-  spec.version    = '0.3.2'
+  spec.version    = '0.6.1'
   spec.author     = 'Daniel J. Berger'
-  spec.license    = 'Artistic 2.0'
+  spec.license    = 'Apache-2.0'
   spec.email      = 'djberg96@gmail.com'
   spec.homepage   = 'https://github.com/djberg96/attempt'
   spec.summary    = 'A thin wrapper for begin + rescue + sleep + retry'
-  spec.test_file  = 'test/test_attempt.rb'
+  spec.test_file  = 'spec/attempt_spec.rb'
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
   spec.cert_chain = Dir['certs/*']
   
-  spec.extra_rdoc_files  = ['README','CHANGES','MANIFEST']
-
   spec.metadata = {
     'changelog_uri'   => 'https://github.com/djberg96/attempt/blob/master/CHANGES',
     'source_code_uri' => 'https://github.com/djberg96/attempt/blob/master/lib/attempt.rb',
@@ -21,13 +19,14 @@ Gem::Specification.new do |spec|
     'wiki_uri'        => 'https://github.com/djberg96/attempt/wiki'
   }
 
-  spec.add_dependency('structured_warnings', '~> 0.3.0')
-  spec.add_development_dependency('test-unit')
+  spec.add_dependency('structured_warnings', '~> 0.4.0')
+  spec.add_dependency('safe_timeout', '~> 0.0.5')
+  spec.add_dependency('rspec', '~> 3.9')
 
   spec.description = <<-EOF
     The attempt library provides a thin wrapper for the typical
     begin/rescue/sleep/retry dance. Use this in order to robustly
-    handle blocks of code that could briefly flake out, such as a socket
+    handle blocks of code that could briefly flake out, such as an http
     or database connection, where it's often better to try again after
     a brief period rather than fail immediately.
   EOF

data/certs/djberg96_pub.pem

@@ -1,21 +1,26 @@
 -----BEGIN CERTIFICATE-----
-MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
+MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
 cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-MB4XDTE2MDkxOTAzNDY0NVoXDTE3MDkxOTAzNDY0NVowPzERMA8GA1UEAwwIZGpi
+MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
 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
-bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-ggEBAIJWpqQOUMoYhpm0wJ4kfiYv9rZVbpZ3L2cFYt4O6+wgbpdWP8DBBgZfCSQW
-1J9miChMKdxZ8eOoeId79IMXN3IAcnalTFvD0Rp9ltaFZTXBfXMFqxQN3fHsIVwz
-as/JSbwXo/PE8rULhjU+Utwcmji38cKEDWLAW4vsCBmwvBTwmAmcuHHKjnNvd8aR
-YMrq9v505w8IjSysIO3KKysxCFuzoIPIYMdYswquvmtuTA+lpB9btWHr8n2FFsDp
-A943I/wqE6xbYQpHxkndWo5uLDUbZh+XxG+fhZKpeqLIqHaFuU6wdO5odt32kB/B
-nCjVswaVYlu1U2iLPCqE+MrjmTA=
+bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+/3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
 -----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.6.1'.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/spec/attempt_spec.rb

@@ -0,0 +1,67 @@
+#####################################################################
+# attempt_spec.rb
+#
+# Tests for the attempt library. You should run this test case via
+# the 'rake test' Rakefile task (or just 'rake').
+#
+# TODO: Test that an Attempt::Warning is raised.
+#####################################################################
+require 'rspec'
+require 'attempt'
+require 'stringio'
+
+RSpec.describe Attempt do
+  before(:all) do
+    $stderr = StringIO.new
+  end
+
+  before do
+    @tries    = 2
+    @interval = 0.1
+    @timeout  = 0.1
+    $value    = 0
+  end
+
+  example "version constant is set to expected value" do
+    expect(Attempt::VERSION).to eq('0.6.1')
+    expect(Attempt::VERSION).to be_frozen
+  end
+
+  example "attempt works as expected without arguments" do
+    expect{ attempt{ 2 + 2 } }.not_to raise_error
+  end
+
+  example "attempt retries the number of times specified" do
+    expect{ attempt(tries: @tries){ $value += 1; raise if $value < 2 } }.not_to raise_error
+    expect($value).to eq(2)
+  end
+
+  example "attempt retries the number of times specified with interval" do
+    expect{
+      attempt(tries: @tries, interval: @interval){ $value += 1; raise if $value < 2 }
+    }.not_to raise_error
+    expect($value).to eq(2)
+  end
+
+  example "attempt retries the number of times specified with interval and timeout" do
+    expect{
+      attempt(tries: @tries, interval: @interval, timeout: @timeout){ $value += 1; raise if $value < 2 }
+    }.not_to raise_error
+  end
+
+  example "attempt raises a timeout error if timeout value is exceeded" do
+    expect{ attempt(tries: 1, interval: 1, timeout: @timeout){ sleep 5 } }.to raise_error(Timeout::Error)
+  end
+
+  example "attempt raises exception as expected" do
+    expect{ attempt(tries: 2, interval: 2){ raise } }.to raise_error(RuntimeError)
+  end
+
+  after do
+    $after = 0
+  end
+
+  after(:all) do
+    $stderr = STDERR
+  end
+end

metadata

@@ -1,36 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: attempt
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Daniel J. Berger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
+  MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
   cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
-  MB4XDTE2MDkxOTAzNDY0NVoXDTE3MDkxOTAzNDY0NVowPzERMA8GA1UEAwwIZGpi
+  MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
   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
-  bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
-  ggEBAIJWpqQOUMoYhpm0wJ4kfiYv9rZVbpZ3L2cFYt4O6+wgbpdWP8DBBgZfCSQW
-  1J9miChMKdxZ8eOoeId79IMXN3IAcnalTFvD0Rp9ltaFZTXBfXMFqxQN3fHsIVwz
-  as/JSbwXo/PE8rULhjU+Utwcmji38cKEDWLAW4vsCBmwvBTwmAmcuHHKjnNvd8aR
-  YMrq9v505w8IjSysIO3KKysxCFuzoIPIYMdYswquvmtuTA+lpB9btWHr8n2FFsDp
-  A943I/wqE6xbYQpHxkndWo5uLDUbZh+XxG+fhZKpeqLIqHaFuU6wdO5odt32kB/B
-  nCjVswaVYlu1U2iLPCqE+MrjmTA=
+  bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
+  A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
+  u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
+  75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
+  6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
+  iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
+  ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
+  74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
+  058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
+  HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
+  AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
+  YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
+  /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
+  h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
+  6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
+  ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
+  1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
+  DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
+  ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
+  WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
   -----END CERTIFICATE-----
-date: 2017-04-04 00:00:00.000000000 Z
+date: 2020-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: structured_warnings
@@ -38,62 +43,72 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: safe_timeout
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: 0.0.5
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
 description: |2
       The attempt library provides a thin wrapper for the typical
       begin/rescue/sleep/retry dance. Use this in order to robustly
-      handle blocks of code that could briefly flake out, such as a socket
+      handle blocks of code that could briefly flake out, such as an http
       or database connection, where it's often better to try again after
       a brief period rather than fail immediately.
 email: djberg96@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- README
-- CHANGES
-- MANIFEST
+extra_rdoc_files: []
 files:
+- CHANGES.md
+- Gemfile
+- LICENSE
+- MANIFEST.md
+- README.md
+- Rakefile
 - attempt.gemspec
-- certs
 - certs/djberg96_pub.pem
-- CHANGES
-- lib
 - lib/attempt.rb
-- MANIFEST
-- Rakefile
-- README
-- test
-- test/test_attempt.rb
+- spec/attempt_spec.rb
 homepage: https://github.com/djberg96/attempt
 licenses:
-- Artistic 2.0
+- Apache-2.0
 metadata:
   changelog_uri: https://github.com/djberg96/attempt/blob/master/CHANGES
   source_code_uri: https://github.com/djberg96/attempt/blob/master/lib/attempt.rb
   bug_tracker_uri: https://github.com/djberg96/attempt/issues
   wiki_uri: https://github.com/djberg96/attempt/wiki
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -108,10 +123,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A thin wrapper for begin + rescue + sleep + retry
 test_files:
-- test/test_attempt.rb
+- spec/attempt_spec.rb

data/MANIFEST

@@ -1,8 +0,0 @@
-* CHANGES
-* MANIFEST
-* README
-* Rakefile
-* attempt.gemspec
-* certs/djberg96_pub.pem
-* lib/attempt.rb
-* test/test_attempt.rb

data/README

@@ -1,67 +0,0 @@
-== Description
-  A thin wrapper for begin + rescue + sleep + retry.
-
-== Installation
-  gem install attempt   
-
-== Synopsis
-  require 'attempt'
-   
-  # Attempt to ftp to some host, trying 3 times with 30 seconds between
-  # attempts before finally raising an error.
-  #
-  attempt(3, 30){
-    Net::FTP.open(host, user, passwd){ ... }
-  }
-   
-  # Or, do things the long way...
-  code = Attempt.new{ |a|
-    a.tries    = 3
-    a.interval = 30
-  }
-   
-  code.attempt{
-    Net::FTP.open(host, user, passwd){ ... }
-  }
-
-== Known Bugs
-  None that I'm aware of. If you find any bugs, please log them on the
-  project page at:
-
-  https://github.com/djberg96/attempt
-
-== Caveats
-  Use with caution. Specifically, make sure you aren't inadvertantly
-  wrapping code that already performs sleep + retry. Otherwise, you'll
-  end up with a series of nested retry's that could take much longer to
-  work than you expect. 
-
-  Also, this library uses the timeout library internally, which has some
-  known issues. See Future Plans, below.
-
-  As of version 0.3.0, this library requires structured_warnings 0.3.0 or
-  later. This is necessary because of changes in Ruby 2.4.
-
-== Future Plans
-  Add the ability to set an absolute maximum number of seconds to prevent
-  nested sleep/retry from delaying attempts longer than expected.
-
-  Replace the timeout library with a self selecting pipe if possible.
-
-== Acknowledgements
-  This library is partially based on Mark Fowler's 'Attempt' Perl module.
-
-== Warranty
-  This package is provided "as is" and without any express or
-  implied warranties, including, without limitation, the implied
-  warranties of merchantability and fitness for a particular purpose.
-
-== License
-  Artistic 2.0
-
-== Copyright
-  (C) 2006-2017, Daniel J. Berger
-  All Rights Reserved
-
-== Author
-  Daniel J. Berger

data/test/test_attempt.rb

@@ -1,64 +0,0 @@
-#####################################################################
-# test_attempt.rb
-#
-# Test case for the attempt library. You should run this test case
-# via the 'rake test' Rakefile task.
-#
-# TODO: Test that an Attempt::Warning is raised.
-#####################################################################
-require 'test-unit'
-require 'attempt'
-require 'stringio'
-
-class TC_Attempt < Test::Unit::TestCase
-  def self.startup
-    $stderr = StringIO.new
-  end
-
-  def setup
-    @tries    = 2
-    @interval = 0.1
-    @timeout  = 0.1
-    $value    = 0
-  end
-
-  test "version constant is set to expected value" do
-    assert_equal('0.3.2', Attempt::VERSION)
-  end
-
-  test "attempt works as expected without arguments" do
-    assert_nothing_raised{ attempt{ 2 + 2 } }
-  end
-
-  test "attempt retries the number of times specified" do
-    assert_nothing_raised{ attempt(@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 } }
-  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 } }
-  end
-
-  test "attempt raises a timeout error if timeout value is exceeded" do
-    assert_raises(Timeout::Error){ attempt(1, 1, @timeout){ sleep 5 } }
-  end
-
-  test "attempt raises exception as expected" do
-    assert_raises(RuntimeError){ attempt(2, 2){ raise } }
-  end
-
-  def teardown
-    @tries    = nil
-    @interval = nil
-    @timeout  = nil
-    $value    = 0
-  end
-
-  def self.shutdown
-    $stderr = STDERR
-  end
-end