just-retry 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 52925b7cd266c04ff2661957b6a9d2588ab008ea
4
+ data.tar.gz: a45b31c19198f5f162e7d149237dad585ee03bbd
5
+ SHA512:
6
+ metadata.gz: d8220378433a47e3107fbb0971db3e956bb4eb280da26bae9813ad459aca455d1d815cc9697d42ce9aff0ff92063cfb31e3c13f1541df8a824e9834ff3e50602
7
+ data.tar.gz: 884f542ac243e5cde8388b0b0cfbaf32eacc35f6b606e14cf070bbcb5495d02ed0edfa1715cfacd295f19f61fbebaa179c4a35dfa90d688e07dcd3114600aee0
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in just-retry.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2013 Michael Greenly
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining
6
+ a copy of this software and associated documentation files (the
7
+ "Software"), to deal in the Software without restriction, including
8
+ without limitation the rights to use, copy, modify, merge, publish,
9
+ distribute, sublicense, and/or sell copies of the Software, and to
10
+ permit persons to whom the Software is furnished to do so, subject to
11
+ the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be
14
+ included in all copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,81 @@
1
+ # Just::Retry
2
+
3
+ A tiny gem that only provides a single retry method capable of catching specific exceptions, providing delays between retries and logging it's behavior.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'just-retry'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install just-retry
18
+
19
+ Then load it using:
20
+
21
+ require 'just/retry'
22
+
23
+ ## Examples
24
+
25
+ In it's most simple form it will retry the block one time on any exception with zero delay between attempts.
26
+
27
+ ```ruby
28
+ Just::retry do
29
+ # work
30
+ end
31
+ ```
32
+
33
+ You can limit which exceptions are rescued.
34
+
35
+ ```ruby
36
+ Just::retry on: exception do
37
+ # work
38
+ end
39
+ ```
40
+
41
+ You can specify the number of retry attempts
42
+
43
+ ```ruby
44
+ Just::retry tries: count do
45
+ # work
46
+ end
47
+ ```
48
+
49
+ You can specify a delay that should occur before retries.
50
+
51
+ ```ruby
52
+ Just::retry delay: seconds do
53
+ # work
54
+ end
55
+ ```
56
+
57
+ If you provide a logger it will record it's behavior. It will record
58
+ any retry attempts at log level 'error' (recoverable errors) and provides
59
+ additional information about the error rescued at log level 'debug'.
60
+
61
+ ```ruby
62
+ Just::retry logger: logger do
63
+ # work
64
+ end
65
+ ```
66
+
67
+ An example that ties it all together.
68
+
69
+ ```ruby
70
+ Just::retry on: Timeout::Error, tries: 3, delay: 5, logger: Logger.new($stdout) do
71
+ # work
72
+ end
73
+ ```
74
+
75
+ ## Contributing
76
+
77
+ 1. Fork it
78
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
79
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
80
+ 4. Push to the branch (`git push origin my-new-feature`)
81
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,23 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'just/retry/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "just-retry"
8
+ spec.version = Just::Retry::VERSION
9
+ spec.authors = ["Michael Greenly"]
10
+ spec.email = ["mgreenly@gmail.com"]
11
+ spec.description = %q{Provides a counted retry machanism}
12
+ spec.summary = %q{Provides a counted retry mechansim}
13
+ spec.homepage = ""
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files`.split($/)
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_development_dependency "bundler", "~> 1.3"
22
+ spec.add_development_dependency "rake"
23
+ end
@@ -0,0 +1,5 @@
1
+ module Just
2
+ module Retry
3
+ VERSION = "0.1.2"
4
+ end
5
+ end
data/lib/just/retry.rb ADDED
@@ -0,0 +1,27 @@
1
+ require "just/retry/version"
2
+
3
+ module Just
4
+ def retry(opts={})
5
+ opts = { :delay => 0.0, :tries => 2, :exception => Exception }.merge(opts)
6
+ delay, tries, exception, logger = opts[:delay], opts[:tries], opts[:exception], opts[:logger]
7
+ count = 0
8
+ begin
9
+ count += 1
10
+ return yield
11
+ rescue exception => e
12
+ if count < tries
13
+ if logger
14
+ logger.error "retry #{count} of #{tries - 1} on #{e.message}"
15
+ logger.debug "rescued: #{e.class} - #{e.backtrace.first}"
16
+ end
17
+ if delay > 0.0
18
+ sleep delay
19
+ end
20
+ retry
21
+ else
22
+ raise
23
+ end
24
+ end
25
+ end
26
+ module_function :retry
27
+ end
metadata ADDED
@@ -0,0 +1,80 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: just-retry
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.2
5
+ platform: ruby
6
+ authors:
7
+ - Michael Greenly
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2013-06-01 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: bundler
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - ~>
18
+ - !ruby/object:Gem::Version
19
+ version: '1.3'
20
+ type: :development
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - ~>
25
+ - !ruby/object:Gem::Version
26
+ version: '1.3'
27
+ - !ruby/object:Gem::Dependency
28
+ name: rake
29
+ requirement: !ruby/object:Gem::Requirement
30
+ requirements:
31
+ - - '>='
32
+ - !ruby/object:Gem::Version
33
+ version: '0'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - '>='
39
+ - !ruby/object:Gem::Version
40
+ version: '0'
41
+ description: Provides a counted retry machanism
42
+ email:
43
+ - mgreenly@gmail.com
44
+ executables: []
45
+ extensions: []
46
+ extra_rdoc_files: []
47
+ files:
48
+ - .gitignore
49
+ - Gemfile
50
+ - LICENSE.txt
51
+ - README.md
52
+ - Rakefile
53
+ - just-retry.gemspec
54
+ - lib/just/retry.rb
55
+ - lib/just/retry/version.rb
56
+ homepage: ''
57
+ licenses:
58
+ - MIT
59
+ metadata: {}
60
+ post_install_message:
61
+ rdoc_options: []
62
+ require_paths:
63
+ - lib
64
+ required_ruby_version: !ruby/object:Gem::Requirement
65
+ requirements:
66
+ - - '>='
67
+ - !ruby/object:Gem::Version
68
+ version: '0'
69
+ required_rubygems_version: !ruby/object:Gem::Requirement
70
+ requirements:
71
+ - - '>='
72
+ - !ruby/object:Gem::Version
73
+ version: '0'
74
+ requirements: []
75
+ rubyforge_project:
76
+ rubygems_version: 2.0.3
77
+ signing_key:
78
+ specification_version: 4
79
+ summary: Provides a counted retry mechansim
80
+ test_files: []