perfect_retry 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: df42efb005b014fff2b0f07ecd946275f6b1a5aa
+  data.tar.gz: 35c9efee15aa976457560695596c2cd81384b7b0
+SHA512:
+  metadata.gz: ba546819efc99ae687d3e8903caeb6e57f8275b3dbe26d5579c89993a296295140479b25c94813a03b0438afff3fca865b5c754592279630f354a0b7ff66998a
+  data.tar.gz: 208cbaf2b5526cbaacb424d28ecd567054135bdf25ae6df5125df2f85fcc2e9c5054d9ace4db7bab05896c5ecbd9be84f420aa442059e0ec87bd56bf3ee7c771

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,18 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2.3
+  - jruby-19mode
+  - jruby-9.0.0.0
+  - jruby-head
+  - ruby-head
+
+sudo: false
+
+addons:
+  code_climate:
+      repo_token: 0ddf2a14a01d14b70843d9ad37ce4e7f1ff7edd7c08aec35d5d830299342850d
+
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in perfect_retry.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 uu59
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+[![Build Status](https://travis-ci.org/uu59/perfect_retry.svg?branch=master)](https://travis-ci.org/uu59/perfect_retry)
+[![Code Climate](https://codeclimate.com/github/uu59/perfect_retry/badges/gpa.svg)](https://codeclimate.com/github/uu59/perfect_retry)
+[![Test Coverage](https://codeclimate.com/github/uu59/perfect_retry/badges/coverage.svg)](https://codeclimate.com/github/uu59/perfect_retry/coverage)
+
+# PerfectRetry
+
+Implement to handle retry kit.
+
+## Usage and Config
+
+```ruby
+PerfectRetry.with_retry do
+  do_something_have_possibilities_errors_task()
+end
+```
+
+```ruby
+# in setup.rb
+
+require "timeout"
+
+PerfectRetry.register(:timeout_handling) do |config|
+  # Try 4 times retry.
+  # default: 3
+  config.limit = 4
+
+  # Rescue these error in a block.
+  # default: [StandardError]
+  config.rescues = [Timeout::Error, StandardError]
+
+  # Sleep this seconds before next retry. `n` is a retry times (1-origin).
+  # default: proc{|n| n ** 2}
+  config.sleep = proc{|n| n * 5 }
+
+  # Logger for something information e.g. '[2/5] Retrying after 3 seconds blah blah'.
+  # default: Logger.new(STDERR)
+  config.logger = Logger.new("/var/log/agent.log")
+
+  # Ensure block. Call this block after with_retry block finished with and without any errors.
+  # default: proc {}
+  config.ensure = proc { puts "finished" }
+end
+
+# in main.rb
+
+require "open-uri"
+
+PerfectRetry.new(:timeout_handling).with_retry do
+  open("http://example.com")
+end
+
+# or
+
+PerfectRetry.with_retry(:timeout_handling) do
+  open("http://example.com")
+end
+```
+
+### Manually retry 
+
+```ruby
+PerfectRetry.register(:dont_retry_automatically) do |config|
+  config.limit = 0
+end
+
+PerfectRetry.with_retry(:dont_retry_automatically) do
+  response = HTTPClient.get("http://example.com")
+  if response.code == 500
+    sleep 3
+    throw :retry
+  end
+end
+```
+
+`throw :retry` redo the block at first without `config.limit` checking. In above case, infinity retry while example.com returns 500.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'perfect_retry'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install perfect_retry
+
+# See also
+
+- [retryable](https://github.com/nfedyashev/retryable)
+- [retry-handler](https://github.com/kimoto/retry-handler)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "perfect_retry"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/perfect_retry/config.rb

@@ -0,0 +1,21 @@
+require "logger"
+
+class PerfectRetry
+  class Config < Struct.new(:limit, :rescues, :logger, :sleep, :ensure)
+    def self.create_from_hash(hash)
+      config = new
+      hash.each do |k, v|
+        config.send("#{k}=", v)
+      end
+      config
+    end
+
+    def sleep_sec(count)
+      if sleep.is_a?(Proc)
+        sleep.call(count)
+      else
+        sleep
+      end
+    end
+  end
+end

data/lib/perfect_retry/version.rb

@@ -0,0 +1,3 @@
+class PerfectRetry
+  VERSION = "0.0.1".freeze
+end

data/lib/perfect_retry.rb

@@ -0,0 +1,87 @@
+require "perfect_retry/version"
+require "perfect_retry/config"
+
+class PerfectRetry
+  class TooManyRetry < StandardError; end
+
+  REGISTERED_CONFIG = { }
+
+  DEFAULTS = {
+    limit: 5,
+    rescues: [StandardError],
+    logger: Logger.new(STDERR),
+    sleep: lambda{|n| n ** 2},
+    ensure: lambda{},
+  }.freeze
+
+  def self.with_retry(config_key = nil, &block)
+    new(config_key).with_retry(&block)
+  end
+
+  def self.register(name, &block)
+    config = Config.create_from_hash(DEFAULTS)
+    block.call(config)
+    REGISTERED_CONFIG[name] = config
+  end
+
+  def self.registered_config_all
+    REGISTERED_CONFIG
+  end
+
+  def self.registered_config(key)
+    REGISTERED_CONFIG[key]
+  end
+
+  def self.deregister_all
+    REGISTERED_CONFIG.clear
+  end
+
+  attr_reader :config
+
+  def initialize(config_key = nil)
+    @config = REGISTERED_CONFIG[config_key] || default_config
+  end
+
+  def default_config
+    Config.create_from_hash(DEFAULTS)
+  end
+
+  def with_retry(&block)
+    count = 0
+    begin
+      retry_with_catch(count, &block)
+    rescue *config.rescues => e
+      if should_retry?(count)
+        count += 1
+        config.logger.warn "[#{count}/#{config.limit || "Infinitiy"}] Retrying after #{config.sleep_sec(count)} seconds. Ocurred: #{e}(#{e.class})"
+        sleep_before_retry(count)
+        retry
+      end
+
+      raise TooManyRetry.new("too many retry (#{config.limit} times)")
+    ensure
+      config.ensure.call
+    end
+  end
+
+  def sleep_before_retry(count)
+    sleep config.sleep_sec(count)
+  end
+
+  def should_retry?(count)
+    return true unless config.limit
+    count < config.limit
+  end
+
+  private
+
+  def retry_with_catch(count, &block)
+    proc do
+      catch(:retry) do
+        return block.call(count)
+      end
+
+      redo # reached here only `throw :retry` called in a block
+    end.call
+  end
+end

data/perfect_retry.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'perfect_retry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "perfect_retry"
+  spec.version       = PerfectRetry::VERSION
+  spec.authors       = ["uu59"]
+  spec.email         = ["k@uu59.org"]
+
+  spec.summary       = %q{Retry handling kit}
+  spec.description   = %q{Retry handling kit}
+  spec.homepage      = "https://github.com/uu59/perfect_retry"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: perfect_retry
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- uu59
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Retry handling kit
+email:
+- k@uu59.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/perfect_retry.rb
+- lib/perfect_retry/config.rb
+- lib/perfect_retry/version.rb
+- perfect_retry.gemspec
+homepage: https://github.com/uu59/perfect_retry
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Retry handling kit
+test_files: []