attempt 0.3.1 → 0.6.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 3ec96dbde6accdfcbeab30ff4c2d5cc99037afdb
4
- data.tar.gz: d00f94bd32f8d9373df7b69d0637204378369c69
2
+ SHA256:
3
+ metadata.gz: 50246b73fb46376da7117edb646bcf0e729f02ae64bf1282d4f352af4c738b47
4
+ data.tar.gz: 37037458bafef3d5bc310f4fb4d856af3bd4058cbdeaeaee9af6fde67bf62b5b
5
5
  SHA512:
6
- metadata.gz: 8a09fe92d69d759cfcfb0c9e58f0d2236de290e7cd5020c7bebd571150a266eedd7aca36b3d7ed9940a2c1e3fc574c49297c6d3650af2d01a2e429bc2ee8ee41
7
- data.tar.gz: 1365e62d69f496ef92513f438507b2eff4f8edf005e766a3290713f78930ef71e11521afa1bdcfc913b558cd498f08871cf84443b579bf4cee7ef4ca31aa5f9f
6
+ metadata.gz: b592f0a5df1a9d9a01ce5ec50661fdf4541bab52de11a1c8dff501f55035f072ad9b88c0f53ba7546d509cb4042027cf12a7ad4972b85c124e3f940d8b283b84
7
+ data.tar.gz: 0ca007e3d8bdb894e5d2991685dfc00cb3fcf5eb8f4e29205b06d0c862827495ba991d767ff49ea1656c3372d9e0186973a26b7733a8b19ccf7f52085182742d
Binary file
data.tar.gz.sig CHANGED
Binary file
data/CHANGES CHANGED
@@ -1,3 +1,25 @@
1
+ == 0.6.0 - 17-Sep-2020
2
+ * Switched from test-unit to rspec and rewrote the specs.
3
+
4
+ == 0.5.1 - 28-Aug-2020
5
+ * Added a Gemfile.
6
+ * Updated Rakefile to clean .lock files.
7
+ * Bumped structured_warnings version to 0.4.0 so that it works with Ruby 2.7.
8
+ Thanks go to Alexey Zapriy for the spot.
9
+
10
+ == 0.5.0 - 2-Jun-2020
11
+ * Switched to Apache-2.0 license, added LICENSE file.
12
+ * Updated cert again.
13
+
14
+ == 0.4.0 - 5-Sep-2017
15
+ * Switched constructor to use keyword arguments.
16
+ * Replaced Timeout with SafeTimeout and added the safe_timeout dependency.
17
+ * The :log option now accepts either an IO or Logger object.
18
+ * Updated cert.
19
+
20
+ == 0.3.2 - 4-Apr-2017
21
+ * Fix metadata key names.
22
+
1
23
  == 0.3.1 - 4-Apr-2017
2
24
  * Added some metadata to the gemspec.
3
25
 
data/Gemfile ADDED
@@ -0,0 +1,8 @@
1
+ source 'https://rubygems.org' do
2
+ gem 'rake'
3
+ gem 'structured_warnings', '~> 0.4.0'
4
+ gem 'safe_timeout', '~> 0.0.5'
5
+ group 'test' do
6
+ gem 'rspec', '~> 3.9'
7
+ end
8
+ end
data/LICENSE ADDED
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
data/MANIFEST CHANGED
@@ -1,8 +1,10 @@
1
1
  * CHANGES
2
+ * LICENSE
2
3
  * MANIFEST
3
4
  * README
5
+ * Gemfile
4
6
  * Rakefile
5
7
  * attempt.gemspec
6
8
  * certs/djberg96_pub.pem
7
9
  * lib/attempt.rb
8
- * test/test_attempt.rb
10
+ * spec/attempt_spec.rb
data/README CHANGED
@@ -9,16 +9,16 @@
9
9
 
10
10
  # Attempt to ftp to some host, trying 3 times with 30 seconds between
11
11
  # attempts before finally raising an error.
12
- #
13
- attempt(3, 30){
12
+
13
+ attempt(tries: 3, interval: 30){
14
14
  Net::FTP.open(host, user, passwd){ ... }
15
15
  }
16
16
 
17
17
  # Or, do things the long way...
18
- code = Attempt.new{ |a|
18
+ code = Attempt.new do |a|
19
19
  a.tries = 3
20
20
  a.interval = 30
21
- }
21
+ end
22
22
 
23
23
  code.attempt{
24
24
  Net::FTP.open(host, user, passwd){ ... }
@@ -42,6 +42,11 @@
42
42
  As of version 0.3.0, this library requires structured_warnings 0.3.0 or
43
43
  later. This is necessary because of changes in Ruby 2.4.
44
44
 
45
+ Update: I've switched from the timeout library in the standard library to
46
+ the safe_timeout library which should improve things. In addition, the
47
+ structured_warnings library requirement is now 0.4.0 or later in order to
48
+ work with Ruby 2.7.
49
+
45
50
  == Future Plans
46
51
  Add the ability to set an absolute maximum number of seconds to prevent
47
52
  nested sleep/retry from delaying attempts longer than expected.
@@ -57,10 +62,10 @@
57
62
  warranties of merchantability and fitness for a particular purpose.
58
63
 
59
64
  == License
60
- Artistic 2.0
65
+ Apache-2.0
61
66
 
62
67
  == Copyright
63
- (C) 2006-2017, Daniel J. Berger
68
+ (C) 2006-2020, Daniel J. Berger
64
69
  All Rights Reserved
65
70
 
66
71
  == Author
data/Rakefile CHANGED
@@ -1,29 +1,26 @@
1
- require 'rake'
2
- require 'rake/clean'
3
- require 'rake/testtask'
4
-
5
- CLEAN.include('**/*.gem', '**/*.rbc')
6
-
7
- namespace :gem do
8
- desc 'Build the attempt gem'
9
- task :create => [:clean] do
10
- require 'rubygems/package'
11
- spec = eval(IO.read('attempt.gemspec'))
12
- spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
13
- Gem::Package.build(spec, true)
14
- end
15
-
16
- desc "Install the attempt gem"
17
- task :install => [:create] do
18
- file = Dir["*.gem"].first
19
- sh "gem install -l #{file}"
20
- end
21
- end
22
-
23
- Rake::TestTask.new do |t|
24
- task :test => :clean
25
- t.warning = true
26
- t.verbose = true
27
- end
28
-
29
- task :default => :test
1
+ require 'rake'
2
+ require 'rake/clean'
3
+ require 'rspec/core/rake_task'
4
+
5
+ CLEAN.include('**/*.gem', '**/*.rbc', '**/*.lock')
6
+
7
+ namespace :gem do
8
+ desc 'Build the attempt gem'
9
+ task :create => [:clean] do
10
+ require 'rubygems/package'
11
+ spec = eval(IO.read('attempt.gemspec'))
12
+ spec.signing_key = File.join(Dir.home, '.ssh', 'gem-private_key.pem')
13
+ Gem::Package.build(spec)
14
+ end
15
+
16
+ desc "Install the attempt gem"
17
+ task :install => [:create] do
18
+ file = Dir["*.gem"].first
19
+ sh "gem install -l #{file}"
20
+ end
21
+ end
22
+
23
+ desc "Run the test suite"
24
+ RSpec::Core::RakeTask.new(:spec)
25
+
26
+ task :default => :spec
@@ -2,34 +2,33 @@ require 'rubygems'
2
2
 
3
3
  Gem::Specification.new do |spec|
4
4
  spec.name = 'attempt'
5
- spec.version = '0.3.1'
5
+ spec.version = '0.6.0'
6
6
  spec.author = 'Daniel J. Berger'
7
- spec.license = 'Artistic 2.0'
7
+ spec.license = 'Apache-2.0'
8
8
  spec.email = 'djberg96@gmail.com'
9
9
  spec.homepage = 'https://github.com/djberg96/attempt'
10
10
  spec.summary = 'A thin wrapper for begin + rescue + sleep + retry'
11
- spec.test_file = 'test/test_attempt.rb'
11
+ spec.test_file = 'spec/attempt_spec.rb'
12
12
  spec.files = Dir['**/*'].reject{ |f| f.include?('git') }
13
13
  spec.cert_chain = Dir['certs/*']
14
14
 
15
15
  spec.extra_rdoc_files = ['README','CHANGES','MANIFEST']
16
16
 
17
17
  spec.metadata = {
18
- 'issue_tracker' => 'https://github.com/djberg96/attempt/issues',
19
- 'changelog' => 'https://github.com/djberg96/attempt/blob/master/CHANGES',
20
- 'code' => 'https://github.com/djberg96/attempt/blob/master/lib/attempt.rb',
21
- 'docs' => 'https://github.com/djberg96/attempt/blob/master/README',
22
- 'bugs' => 'https://github.com/djberg96/attempt/issues',
23
- 'wiki' => 'https://github.com/djberg96/attempt/wiki'
18
+ 'changelog_uri' => 'https://github.com/djberg96/attempt/blob/master/CHANGES',
19
+ 'source_code_uri' => 'https://github.com/djberg96/attempt/blob/master/lib/attempt.rb',
20
+ 'bug_tracker_uri' => 'https://github.com/djberg96/attempt/issues',
21
+ 'wiki_uri' => 'https://github.com/djberg96/attempt/wiki'
24
22
  }
25
23
 
26
- spec.add_dependency('structured_warnings', '~> 0.3.0')
27
- spec.add_development_dependency('test-unit')
24
+ spec.add_dependency('structured_warnings', '~> 0.4.0')
25
+ spec.add_dependency('safe_timeout', '~> 0.0.5')
26
+ spec.add_dependency('rspec', '~> 3.9')
28
27
 
29
28
  spec.description = <<-EOF
30
29
  The attempt library provides a thin wrapper for the typical
31
30
  begin/rescue/sleep/retry dance. Use this in order to robustly
32
- handle blocks of code that could briefly flake out, such as a socket
31
+ handle blocks of code that could briefly flake out, such as an http
33
32
  or database connection, where it's often better to try again after
34
33
  a brief period rather than fail immediately.
35
34
  EOF
@@ -1,21 +1,26 @@
1
1
  -----BEGIN CERTIFICATE-----
2
- MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
2
+ MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
3
3
  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
4
- MB4XDTE2MDkxOTAzNDY0NVoXDTE3MDkxOTAzNDY0NVowPzERMA8GA1UEAwwIZGpi
4
+ MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
5
5
  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
6
- bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM0eOHOQRpLOeqkyeK7O
7
- DGHYLkO0Wq7gStVVVyHXahgyCopLN6JVBwGy5aCpKFcy5sFz2DdnISj+hQ7FctDa
8
- yz6Lq9TvAF8Jkis8dDFLQKeHilB/AM4ssQAsGQyoQnoE4v5tCOSW4e3YHFDp/dMZ
9
- s7Hkoim6PeEdkh4hB5LCa90OrHSPe8nlMFsVhRIGj86xNTRazEiWPZCOKmN9rZgW
10
- ziheP/6hC2c7vNRevv5iE/K+NqaL/WOdMquOSZoF2mdBcoMIPDDBNzh/oHinPQ3N
11
- 1oOvoET0+Tj+O5tXX/L1TAsUrwZXlyrYGaZ5aYyoo/7r9pmvmbfgBqaU6JywT0EE
12
- 5x0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFO+k
13
- C/3R+t2aIyIpwU5wPrAfYVL6MB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
14
- bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
15
- ggEBAIJWpqQOUMoYhpm0wJ4kfiYv9rZVbpZ3L2cFYt4O6+wgbpdWP8DBBgZfCSQW
16
- 1J9miChMKdxZ8eOoeId79IMXN3IAcnalTFvD0Rp9ltaFZTXBfXMFqxQN3fHsIVwz
17
- as/JSbwXo/PE8rULhjU+Utwcmji38cKEDWLAW4vsCBmwvBTwmAmcuHHKjnNvd8aR
18
- YMrq9v505w8IjSysIO3KKysxCFuzoIPIYMdYswquvmtuTA+lpB9btWHr8n2FFsDp
19
- A943I/wqE6xbYQpHxkndWo5uLDUbZh+XxG+fhZKpeqLIqHaFuU6wdO5odt32kB/B
20
- nCjVswaVYlu1U2iLPCqE+MrjmTA=
6
+ bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
7
+ A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
8
+ u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
9
+ 75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
10
+ 6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
11
+ iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
12
+ ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
13
+ 74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
14
+ 058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
15
+ HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
16
+ AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
17
+ YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
18
+ /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
19
+ h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
20
+ 6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
21
+ ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
22
+ 1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
23
+ DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
24
+ ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
25
+ WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
21
26
  -----END CERTIFICATE-----
@@ -1,4 +1,4 @@
1
- require 'timeout'
1
+ require 'safe_timeout'
2
2
  require 'structured_warnings'
3
3
 
4
4
  # The Attempt class encapsulates methods related to multiple attempts at
@@ -6,7 +6,7 @@ require 'structured_warnings'
6
6
  class Attempt
7
7
 
8
8
  # The version of the attempt library.
9
- VERSION = '0.3.1'.freeze
9
+ VERSION = '0.6.0'.freeze
10
10
 
11
11
  # Warning raised if an attempt fails before the maximum number of tries
12
12
  # has been reached.
@@ -38,21 +38,34 @@ class Attempt
38
38
  attr_accessor :level
39
39
 
40
40
  # :call-seq:
41
- # Attempt.new{ |a| ... }
41
+ # Attempt.new(**kwargs)
42
42
  #
43
- # Creates and returns a new +Attempt+ object. Use a block to set the
44
- # accessors.
43
+ # Creates and returns a new +Attempt+ object. The supported keyword options
44
+ # are as follows:
45
45
  #
46
- def initialize
47
- @tries = 3 # Reasonable default
48
- @interval = 60 # Reasonable default
49
- @log = nil # Should be an IO handle, if provided
50
- @increment = nil # Should be an int, if provided
51
- @timeout = nil # Wrap the code in a timeout block if provided
52
- @level = Exception # Level of exception to be caught
53
- @warnings = true # Errors are sent to STDERR as warnings if true
54
-
55
- yield self if block_given?
46
+ # * tries - The number of attempts to make before giving up. The default is 3.
47
+ # * interval - The delay in seconds between each attempt. The default is 60.
48
+ # * log - An IO handle or Logger instance where warnings/errors are logged to. The default is nil.
49
+ # * increment - The amount to increment the interval between tries. The default is 0.
50
+ # * level - The level of exception to be caught. The default is everything, i.e. Exception.
51
+ # * warnings - Boolean value that indicates whether or not errors are treated as warnings
52
+ # until the maximum number of attempts has been made. The default is true.
53
+ # * timeout - Boolean value to indicate whether or not to automatically wrap your
54
+ # proc in a SafeTimeout block. The default is false.
55
+ #
56
+ # Example:
57
+ #
58
+ # a = Attempt.new(tries: 5, increment: 10, timeout: true)
59
+ # a.attempt{ http.get("http://something.foo.com") }
60
+ #
61
+ def initialize(**options)
62
+ @tries = options[:tries] || 3 # Reasonable default
63
+ @interval = options[:interval] || 60 # Reasonable default
64
+ @log = options[:log] # Should be an IO handle, if provided
65
+ @increment = options[:increment] || 0 # Should be an integer, if provided
66
+ @timeout = options[:timeout] || false # Wrap the code in a timeout block if provided
67
+ @level = options[:level] || Exception # Level of exception to be caught
68
+ @warnings = options[:warnings] || true # Errors are sent to STDERR as warnings if true
56
69
  end
57
70
 
58
71
  # Attempt to perform the operation in the provided block up to +tries+
@@ -65,7 +78,7 @@ class Attempt
65
78
  count = 1
66
79
  begin
67
80
  if @timeout
68
- Timeout.timeout(@timeout){ yield }
81
+ SafeTimeout.timeout(@timeout){ yield }
69
82
  else
70
83
  yield
71
84
  end
@@ -75,7 +88,11 @@ class Attempt
75
88
  msg = "Error on attempt # #{count}: #{error}; retrying"
76
89
  count += 1
77
90
  warn Warning, msg if @warnings
78
- @log.puts msg if @log
91
+
92
+ if @log # Accept an IO or Logger object
93
+ @log.respond_to?(:puts) ? @log.puts(msg) : @log.warn(msg)
94
+ end
95
+
79
96
  @interval += @increment if @increment
80
97
  sleep @interval
81
98
  retry
@@ -87,34 +104,28 @@ end
87
104
 
88
105
  module Kernel
89
106
  # :call-seq:
90
- # attempt(tries = 3, interval = 60, timeout = nil){ # some op }
107
+ # attempt(tries: 3, interval: 60, timeout: 10){ # some op }
91
108
  #
92
109
  # Attempt to perform the operation in the provided block up to +tries+
93
- # times, sleeping +interval+ between each try. By default the number
110
+ # times, sleeping +interval+ between each try. By default the number
94
111
  # of tries defaults to 3, the interval defaults to 60 seconds, and there
95
112
  # is no timeout specified.
96
113
  #
97
114
  # If +timeout+ is provided then the operation is wrapped in a Timeout
98
- # block as well. This is handy for those rare occasions when an IO
115
+ # block as well. This is handy for those rare occasions when an IO
99
116
  # connection could hang indefinitely, for example.
100
117
  #
101
118
  # If the operation still fails the (last) error is then re-raised.
102
119
  #
103
- # This is really just a wrapper for Attempt.new where the simple case is
104
- # good enough i.e. you don't care about warnings, increments or logging,
105
- # and you want a little added convenience.
120
+ # This is really just a convenient wrapper for Attempt.new + Attempt#attempt.
106
121
  #
107
122
  # Example:
108
123
  #
109
124
  # # Make 3 attempts to connect to the database, 60 seconds apart.
110
125
  # attempt{ DBI.connect(dsn, user, passwd) }
111
126
  #
112
- def attempt(tries = 3, interval = 60, timeout = nil, &block)
113
- raise 'no block given' unless block_given?
114
- Attempt.new{ |a|
115
- a.tries = tries
116
- a.interval = interval
117
- a.timeout = timeout if timeout
118
- }.attempt(&block)
127
+ def attempt(**kwargs, &block)
128
+ object = Attempt.new(kwargs)
129
+ object.attempt(&block)
119
130
  end
120
131
  end
@@ -0,0 +1,67 @@
1
+ #####################################################################
2
+ # attempt_spec.rb
3
+ #
4
+ # Tests for the attempt library. You should run this test case via
5
+ # the 'rake test' Rakefile task (or just 'rake').
6
+ #
7
+ # TODO: Test that an Attempt::Warning is raised.
8
+ #####################################################################
9
+ require 'rspec'
10
+ require 'attempt'
11
+ require 'stringio'
12
+
13
+ RSpec.describe Attempt do
14
+ before(:all) do
15
+ $stderr = StringIO.new
16
+ end
17
+
18
+ before do
19
+ @tries = 2
20
+ @interval = 0.1
21
+ @timeout = 0.1
22
+ $value = 0
23
+ end
24
+
25
+ example "version constant is set to expected value" do
26
+ expect(Attempt::VERSION).to eq('0.6.0')
27
+ expect(Attempt::VERSION).to be_frozen
28
+ end
29
+
30
+ example "attempt works as expected without arguments" do
31
+ expect{ attempt{ 2 + 2 } }.not_to raise_error
32
+ end
33
+
34
+ example "attempt retries the number of times specified" do
35
+ expect{ attempt(tries: @tries){ $value += 1; raise if $value < 2 } }.not_to raise_error
36
+ expect($value).to eq(2)
37
+ end
38
+
39
+ example "attempt retries the number of times specified with interval" do
40
+ expect{
41
+ attempt(tries: @tries, interval: @interval){ $value += 1; raise if $value < 2 }
42
+ }.not_to raise_error
43
+ expect($value).to eq(2)
44
+ end
45
+
46
+ example "attempt retries the number of times specified with interval and timeout" do
47
+ expect{
48
+ attempt(tries: @tries, interval: @interval, timeout: @timeout){ $value += 1; raise if $value < 2 }
49
+ }.not_to raise_error
50
+ end
51
+
52
+ example "attempt raises a timeout error if timeout value is exceeded" do
53
+ expect{ attempt(tries: 1, interval: 1, timeout: @timeout){ sleep 5 } }.to raise_error(Timeout::Error)
54
+ end
55
+
56
+ example "attempt raises exception as expected" do
57
+ expect{ attempt(tries: 2, interval: 2){ raise } }.to raise_error(RuntimeError)
58
+ end
59
+
60
+ after do
61
+ $after = 0
62
+ end
63
+
64
+ after(:all) do
65
+ $stderr = STDERR
66
+ end
67
+ end
metadata CHANGED
@@ -1,36 +1,41 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: attempt
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.1
4
+ version: 0.6.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Daniel J. Berger
8
- autorequire:
8
+ autorequire:
9
9
  bindir: bin
10
10
  cert_chain:
11
11
  - |
12
12
  -----BEGIN CERTIFICATE-----
13
- MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MREwDwYDVQQDDAhkamJl
13
+ MIIEcDCCAtigAwIBAgIBATANBgkqhkiG9w0BAQsFADA/MREwDwYDVQQDDAhkamJl
14
14
  cmc5NjEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPyLGQBGRYDY29t
15
- MB4XDTE2MDkxOTAzNDY0NVoXDTE3MDkxOTAzNDY0NVowPzERMA8GA1UEAwwIZGpi
15
+ MB4XDTE4MDMxODE1MjIwN1oXDTI4MDMxNTE1MjIwN1owPzERMA8GA1UEAwwIZGpi
16
16
  ZXJnOTYxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkWA2Nv
17
- bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAM0eOHOQRpLOeqkyeK7O
18
- DGHYLkO0Wq7gStVVVyHXahgyCopLN6JVBwGy5aCpKFcy5sFz2DdnISj+hQ7FctDa
19
- yz6Lq9TvAF8Jkis8dDFLQKeHilB/AM4ssQAsGQyoQnoE4v5tCOSW4e3YHFDp/dMZ
20
- s7Hkoim6PeEdkh4hB5LCa90OrHSPe8nlMFsVhRIGj86xNTRazEiWPZCOKmN9rZgW
21
- ziheP/6hC2c7vNRevv5iE/K+NqaL/WOdMquOSZoF2mdBcoMIPDDBNzh/oHinPQ3N
22
- 1oOvoET0+Tj+O5tXX/L1TAsUrwZXlyrYGaZ5aYyoo/7r9pmvmbfgBqaU6JywT0EE
23
- 5x0CAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFO+k
24
- C/3R+t2aIyIpwU5wPrAfYVL6MB0GA1UdEQQWMBSBEmRqYmVyZzk2QGdtYWlsLmNv
25
- bTAdBgNVHRIEFjAUgRJkamJlcmc5NkBnbWFpbC5jb20wDQYJKoZIhvcNAQEFBQAD
26
- ggEBAIJWpqQOUMoYhpm0wJ4kfiYv9rZVbpZ3L2cFYt4O6+wgbpdWP8DBBgZfCSQW
27
- 1J9miChMKdxZ8eOoeId79IMXN3IAcnalTFvD0Rp9ltaFZTXBfXMFqxQN3fHsIVwz
28
- as/JSbwXo/PE8rULhjU+Utwcmji38cKEDWLAW4vsCBmwvBTwmAmcuHHKjnNvd8aR
29
- YMrq9v505w8IjSysIO3KKysxCFuzoIPIYMdYswquvmtuTA+lpB9btWHr8n2FFsDp
30
- A943I/wqE6xbYQpHxkndWo5uLDUbZh+XxG+fhZKpeqLIqHaFuU6wdO5odt32kB/B
31
- nCjVswaVYlu1U2iLPCqE+MrjmTA=
17
+ bTCCAaIwDQYJKoZIhvcNAQEBBQADggGPADCCAYoCggGBALgfaroVM6CI06cxr0/h
18
+ A+j+pc8fgpRgBVmHFaFunq28GPC3IvW7Nvc3Y8SnAW7pP1EQIbhlwRIaQzJ93/yj
19
+ u95KpkP7tA9erypnV7dpzBkzNlX14ACaFD/6pHoXoe2ltBxk3CCyyzx70mTqJpph
20
+ 75IB03ni9a8yqn8pmse+s83bFJOAqddSj009sGPcQO+QOWiNxqYv1n5EHcvj2ebO
21
+ 6hN7YTmhx7aSia4qL/quc4DlIaGMWoAhvML7u1fmo53CYxkKskfN8MOecq2vfEmL
22
+ iLu+SsVVEAufMDDFMXMJlvDsviolUSGMSNRTujkyCcJoXKYYxZSNtIiyd9etI0X3
23
+ ctu0uhrFyrMZXCedutvXNjUolD5r9KGBFSWH1R9u2I3n3SAyFF2yzv/7idQHLJJq
24
+ 74BMnx0FIq6fCpu5slAipvxZ3ZkZpEXZFr3cIBtO1gFvQWW7E/Y3ijliWJS1GQFq
25
+ 058qERadHGu1yu1dojmFRo6W2KZvY9al2yIlbkpDrD5MYQIDAQABo3cwdTAJBgNV
26
+ HRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNVHQ4EFgQUFZsMapgzJimzsbaBG2Tm8j5e
27
+ AzgwHQYDVR0RBBYwFIESZGpiZXJnOTZAZ21haWwuY29tMB0GA1UdEgQWMBSBEmRq
28
+ YmVyZzk2QGdtYWlsLmNvbTANBgkqhkiG9w0BAQsFAAOCAYEAW2tnYixXQtKxgGXq
29
+ /3iSWG2bLwvxS4go3srO+aRXZHrFUMlJ5W0mCxl03aazxxKTsVVpZD8QZxvK91OQ
30
+ h9zr9JBYqCLcCVbr8SkmYCi/laxIZxsNE5YI8cC8vvlLI7AMgSfPSnn/Epq1GjGY
31
+ 6L1iRcEDtanGCIvjqlCXO9+BmsnCfEVehqZkQHeYczA03tpOWb6pon2wzvMKSsKH
32
+ ks0ApVdstSLz1kzzAqem/uHdG9FyXdbTAwH1G4ZPv69sQAFAOCgAqYmdnzedsQtE
33
+ 1LQfaQrx0twO+CZJPcRLEESjq8ScQxWRRkfuh2VeR7cEU7L7KqT10mtUwrvw7APf
34
+ DYoeCY9KyjIBjQXfbj2ke5u1hZj94Fsq9FfbEQg8ygCgwThnmkTrrKEiMSs3alYR
35
+ ORVCZpRuCPpmC8qmqxUnARDArzucjaclkxjLWvCVHeFa9UP7K3Nl9oTjJNv+7/jM
36
+ WZs4eecIcUc4tKdHxcAJ0MO/Dkqq7hGaiHpwKY76wQ1+8xAh
32
37
  -----END CERTIFICATE-----
33
- date: 2017-04-04 00:00:00.000000000 Z
38
+ date: 2020-09-17 00:00:00.000000000 Z
34
39
  dependencies:
35
40
  - !ruby/object:Gem::Dependency
36
41
  name: structured_warnings
@@ -38,32 +43,46 @@ dependencies:
38
43
  requirements:
39
44
  - - "~>"
40
45
  - !ruby/object:Gem::Version
41
- version: 0.3.0
46
+ version: 0.4.0
42
47
  type: :runtime
43
48
  prerelease: false
44
49
  version_requirements: !ruby/object:Gem::Requirement
45
50
  requirements:
46
51
  - - "~>"
47
52
  - !ruby/object:Gem::Version
48
- version: 0.3.0
53
+ version: 0.4.0
49
54
  - !ruby/object:Gem::Dependency
50
- name: test-unit
55
+ name: safe_timeout
51
56
  requirement: !ruby/object:Gem::Requirement
52
57
  requirements:
53
- - - ">="
58
+ - - "~>"
54
59
  - !ruby/object:Gem::Version
55
- version: '0'
56
- type: :development
60
+ version: 0.0.5
61
+ type: :runtime
57
62
  prerelease: false
58
63
  version_requirements: !ruby/object:Gem::Requirement
59
64
  requirements:
60
- - - ">="
65
+ - - "~>"
66
+ - !ruby/object:Gem::Version
67
+ version: 0.0.5
68
+ - !ruby/object:Gem::Dependency
69
+ name: rspec
70
+ requirement: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - "~>"
61
73
  - !ruby/object:Gem::Version
62
- version: '0'
74
+ version: '3.9'
75
+ type: :runtime
76
+ prerelease: false
77
+ version_requirements: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - "~>"
80
+ - !ruby/object:Gem::Version
81
+ version: '3.9'
63
82
  description: |2
64
83
  The attempt library provides a thin wrapper for the typical
65
84
  begin/rescue/sleep/retry dance. Use this in order to robustly
66
- handle blocks of code that could briefly flake out, such as a socket
85
+ handle blocks of code that could briefly flake out, such as an http
67
86
  or database connection, where it's often better to try again after
68
87
  a brief period rather than fail immediately.
69
88
  email: djberg96@gmail.com
@@ -74,28 +93,25 @@ extra_rdoc_files:
74
93
  - CHANGES
75
94
  - MANIFEST
76
95
  files:
77
- - attempt.gemspec
78
- - certs
79
- - certs/djberg96_pub.pem
80
96
  - CHANGES
81
- - lib
82
- - lib/attempt.rb
97
+ - Gemfile
98
+ - LICENSE
83
99
  - MANIFEST
84
- - Rakefile
85
100
  - README
86
- - test
87
- - test/test_attempt.rb
101
+ - Rakefile
102
+ - attempt.gemspec
103
+ - certs/djberg96_pub.pem
104
+ - lib/attempt.rb
105
+ - spec/attempt_spec.rb
88
106
  homepage: https://github.com/djberg96/attempt
89
107
  licenses:
90
- - Artistic 2.0
108
+ - Apache-2.0
91
109
  metadata:
92
- issue_tracker: https://github.com/djberg96/attempt/issues
93
- changelog: https://github.com/djberg96/attempt/blob/master/CHANGES
94
- code: https://github.com/djberg96/attempt/blob/master/lib/attempt.rb
95
- docs: https://github.com/djberg96/attempt/blob/master/README
96
- bugs: https://github.com/djberg96/attempt/issues
97
- wiki: https://github.com/djberg96/attempt/wiki
98
- post_install_message:
110
+ changelog_uri: https://github.com/djberg96/attempt/blob/master/CHANGES
111
+ source_code_uri: https://github.com/djberg96/attempt/blob/master/lib/attempt.rb
112
+ bug_tracker_uri: https://github.com/djberg96/attempt/issues
113
+ wiki_uri: https://github.com/djberg96/attempt/wiki
114
+ post_install_message:
99
115
  rdoc_options: []
100
116
  require_paths:
101
117
  - lib
@@ -110,10 +126,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
110
126
  - !ruby/object:Gem::Version
111
127
  version: '0'
112
128
  requirements: []
113
- rubyforge_project:
114
- rubygems_version: 2.6.11
115
- signing_key:
129
+ rubygems_version: 3.1.4
130
+ signing_key:
116
131
  specification_version: 4
117
132
  summary: A thin wrapper for begin + rescue + sleep + retry
118
133
  test_files:
119
- - test/test_attempt.rb
134
+ - spec/attempt_spec.rb
metadata.gz.sig CHANGED
Binary file
@@ -1,64 +0,0 @@
1
- #####################################################################
2
- # test_attempt.rb
3
- #
4
- # Test case for the attempt library. You should run this test case
5
- # via the 'rake test' Rakefile task.
6
- #
7
- # TODO: Test that an Attempt::Warning is raised.
8
- #####################################################################
9
- require 'test-unit'
10
- require 'attempt'
11
- require 'stringio'
12
-
13
- class TC_Attempt < Test::Unit::TestCase
14
- def self.startup
15
- $stderr = StringIO.new
16
- end
17
-
18
- def setup
19
- @tries = 2
20
- @interval = 0.1
21
- @timeout = 0.1
22
- $value = 0
23
- end
24
-
25
- test "version constant is set to expected value" do
26
- assert_equal('0.3.1', Attempt::VERSION)
27
- end
28
-
29
- test "attempt works as expected without arguments" do
30
- assert_nothing_raised{ attempt{ 2 + 2 } }
31
- end
32
-
33
- test "attempt retries the number of times specified" do
34
- assert_nothing_raised{ attempt(@tries){ $value += 1; raise if $value < 2 } }
35
- assert_equal(2, $value)
36
- end
37
-
38
- test "attempt retries the number of times specified with interval" do
39
- assert_nothing_raised{ attempt(@tries, @interval){ $value += 1; raise if $value < 2 } }
40
- end
41
-
42
- test "attempt retries the number of times specified with interval and timeout" do
43
- assert_nothing_raised{ attempt(@tries, @interval, @timeout){ $value += 1; raise if $value < 2 } }
44
- end
45
-
46
- test "attempt raises a timeout error if timeout value is exceeded" do
47
- assert_raises(Timeout::Error){ attempt(1, 1, @timeout){ sleep 5 } }
48
- end
49
-
50
- test "attempt raises exception as expected" do
51
- assert_raises(RuntimeError){ attempt(2, 2){ raise } }
52
- end
53
-
54
- def teardown
55
- @tries = nil
56
- @interval = nil
57
- @timeout = nil
58
- $value = 0
59
- end
60
-
61
- def self.shutdown
62
- $stderr = STDERR
63
- end
64
- end