http_retriable 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

@@ -0,0 +1 @@
+http_retriable

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3-p448

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Tyler Montgomery
+
+MIT License
+
+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,79 @@
+# HttpRetriable
+
+ HttpRetriable is designed to catch routine http errors and retry the provided
+ block that makes network calls.
+
+ By default, requests are tried 5 times with an exponential backoff to prevent
+ thrashing a service that may need a few seconds to recover.
+
+ You can optionally provide a constant amount of time to sleep between retries
+ and provide the number of times to retry the request if 5 retries doesn't suit
+ your neeeds.
+
+ Unlike other libraries that provide a similar function this does not polute
+ Kernal or Object with additional methods. You can include or extend HttpRetriable
+ for use within your own class or module, or you can call the module directly,
+ examples are below.
+
+##Examples:
+
+###Calling directly:
+
+```ruby
+def get_funny_cats(id)
+  HttpRetriable.call do
+    LulzService.get("/cats/lulz/#{id}")
+  end
+end
+```
+
+###Mixing it in:
+
+```ruby
+class FunnyCats
+
+  include HttpRetriable
+
+  def get_funny_cats(id)
+    retry_http do
+      LulzService.get("/cats/lulz/#{id}")
+    end
+  end
+end
+```
+
+### Options
+ You can provide several options:
+   * retries    - Integer: The number of times to retry the request
+   * sleep      - Integer: The number of seconds to sleep
+   * exceptions - Array: List of exceptions classes
+
+```ruby
+def get_funny_cats(id)
+  exceptions = [LulzService::Error, Timeout::Error]
+  HttpRetriable.call(:retries => 3, :sleep => 10, :exceptions => exceptions) do
+    LulzService.get("/cats/lulz/#{id}")
+  end
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'http_retriable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install http_retriable
+
+## Contributing
+
+1. Fork it.
+2. Branch it.
+3. Code it.
+4. Pull Request it.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/http_retriable.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/http_retriable/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Tyler Montgomery"]
+  gem.email         = ["tyler.a.montgomery@gmail.com"]
+  gem.description   = %q{Catches common http exceptions and retries your block}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "http_retriable"
+  gem.require_paths = ["lib"]
+  gem.version       = HttpRetriable::VERSION
+end

data/lib/http_retriable.rb

@@ -0,0 +1,57 @@
+require "http_retriable/version"
+module HttpRetriable
+
+  extend self
+
+  def retry_http(*args, &block)
+    options = args.extract_options!
+    default_exceptions = [
+      EOFError,
+      Errno::ECONNREFUSED,
+      Errno::ECONNRESET,
+      Errno::EHOSTUNREACH,
+      Errno::EINVAL,
+      Errno::EPIPE,
+      Errno::ETIMEDOUT]
+    if defined?(RestClient)
+      default_exceptions += [RestClient::RequestTimeout, RestClient::ServerBrokeConnection]
+    end
+
+    retries = options.fetch(:retries, 5)
+    should_sleep = options.fetch(:sleep, false)
+    backoff = !should_sleep # if sleep is provided by the user, don't backoff
+    exceptions = options.fetch(:exceptions, default_exceptions)
+
+    retried = 0
+    seconds_to_sleep = should_sleep ? should_sleep : 2
+    quick_retries = 2
+    begin
+      yield
+    rescue *exceptions => e
+      retried += 1
+      if backoff
+        if retried < quick_retries
+          retry
+        elsif retried < retries
+          seconds_to_sleep = seconds_to_sleep ** 2
+          sleep seconds_to_sleep
+          retry
+        else
+          raise e
+        end
+      else
+        if retried < retries
+          sleep seconds_to_sleep
+          retry
+        else
+          raise e
+        end
+      end
+    end
+  end
+
+  def self.call(*args, &block)
+    self.retry_http(*args, &block)
+  end
+end
+

data/lib/http_retriable/version.rb

@@ -0,0 +1,3 @@
+module HttpRetriable
+  VERSION = "0.0.1"
+end

data/test/retry_test.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+require 'http_retriable'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'fakeweb'
+
+class RetryTest < MiniTest::Spec
+
+  it "should back off" do
+    #verify how much time it takes to execute
+  end
+
+  it "should sleep constantly" do
+    # verify time it takes to execute"
+  end
+
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: http_retriable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tyler Montgomery
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-25 00:00:00.000000000 Z
+dependencies: []
+description: Catches common http exceptions and retries your block
+email:
+- tyler.a.montgomery@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- http_retriable.gemspec
+- lib/http_retriable.rb
+- lib/http_retriable/version.rb
+- test/retry_test.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files:
+- test/retry_test.rb