tryout 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+coverage
+doc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+gemspec
+
+
+group :development, :test do
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    tryout (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.9)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.1)
+    multi_json (1.5.0)
+    redcarpet (2.2.2)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.1)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (>= 3.0.0)
+  redcarpet (~> 2.2.2)
+  rspec (>= 2.0.0)
+  simplecov
+  tryout!
+  yard (~> 0.8.3)

data/LICENSE

@@ -0,0 +1,18 @@
+Copyright (c) 2012 Endel Dreyer
+
+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,35 @@
+Tryout [![Build Status](https://secure.travis-ci.org/endel/tryout.png)](http://travis-ci.org/endel/tryout)
+===
+
+Allows you to do dirty stuff without messing up your code base.
+
+Background
+---
+
+I've found myself using begin/rescue/retry through HTTP requests frequently, due
+timeout, weird stuff caused by a messed up third-party service, or even due
+internet connectivity lost.
+
+
+How to use
+---
+
+Currently, Tryout supports 3 alternatives of conditional logic.
+
+**if/unless**: call any method on the result of the `try` block.
+
+    value = Tryout.try { RestClient.get('http://www.google.com') }.retry(3, :if => :empty?)
+    value = Tryout.try { RestClient.get('http://www.google.com') }.retry(3, :unless => :present?)
+
+**block**: the result of the `try` block will be passed as argument for the second one.
+Is up to you when the result is considered invalid.
+
+    value = Tryout.try { RestClient.get('http://www.google.com') }.retry(3) do |invalid|
+      # Invalidate when response have length lesser than 100
+      invalid.length < 100
+    end
+
+License
+---
+
+Tryout is released under the MIT license. Please read the LICENSE file.

data/lib/tryout/version.rb

@@ -0,0 +1,5 @@
+class Tryout
+  # Gem Version
+  VERSION = '0.1.0'
+end
+

data/lib/tryout.rb

@@ -0,0 +1,73 @@
+#
+#  Allows you to do dirty stuff without messing up your code base.
+#
+class Tryout
+  # Initialize the Tryout instance.
+  #
+  # @example
+  #   value = Tryout.try { RestClient.get('http://www.google.com') }.retry(3, :if => :empty?)
+  #
+  # @param [block] block content retrieval logic
+  # @return [Tryout] tryout object
+  def self.try &block
+    self.new(&block)
+  end
+
+  autoload :VERSION, 'tryout/version'
+
+  # Initializes Tryout with the content retrieval logic.
+  # @param [block] block content retrieval logic
+  def initialize(&block)
+    @attempts = 0
+    @block = block
+  end
+
+  # Retry the block call
+  #
+  # @param [Integer] times (default: 2)
+  # @param [Hash] conditions
+  # @option [Symbol] if       method to call from result
+  # @option [Symbol] unless   method to call from result
+  #
+  # @return [Object] result from block call
+  def retry(times = 2, conditions = nil, &evaluator)
+    result = @block.call
+
+    # Call block to evaluate valid result
+    if block_given?
+      conditions = { :match => evaluator.call(result) }
+    end
+
+    # Throw a exception to be rescued, if retry count reached the limit.
+    if apply_conditions?(result, conditions)
+      throw Exception.new("#{result.inspect} doesn't match conditions. Already retried #{times.inspect} times.")
+    end
+
+    result
+  rescue Exception => e
+    @attempts += 1
+    if @attempts < times
+      retry
+    else
+      raise e
+    end
+  end
+
+  protected
+
+    # Apply conditions to check a valid result
+    # @param [Object] result
+    # @param [Hash] conditions
+    # @return [Boolean] need a retry?
+    def apply_conditions?(result, conditions)
+      negation = conditions.has_key?(:unless)
+      bool = if conditions.has_key?(:match)
+               conditions[:match]
+             else
+               result.send(conditions[:if] || conditions[:unless])
+             end
+
+      (negation) ? !bool : bool
+    end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$: << 'lib'
+
+require 'bundler/setup'
+require 'simplecov'
+SimpleCov.start
+
+require 'rspec'
+require 'tryout'
+require 'active_support/core_ext'

data/spec/tryout_spec.rb

@@ -0,0 +1,45 @@
+require File.expand_path('spec/spec_helper')
+
+describe Tryout do
+  it "should allow to access version" do
+    Tryout::VERSION.should be_a(String)
+  end
+
+  it "should retry 3 times" do
+    sample = [1,2,3].each
+    valid = Tryout.try do
+      sample.next
+    end.retry(3) do |invalid|
+      invalid < 3
+    end
+    valid.should == 3
+  end
+
+  it "should raise error when retried more than allowed" do
+    sample = [1,2,3,4,5,6].each
+    expect do
+      valid = Tryout.try do
+        sample.next
+      end.retry(5) do |invalid|
+        invalid < 6
+      end
+    end.to raise_exception
+  end
+
+  it "allow :if option" do
+    emptyness = ["", "", "", "hey!"].each
+    valid = Tryout.try do
+      emptyness.next
+    end.retry(5, :if => :empty?)
+    valid.should == "hey!"
+  end
+
+  it "allow :unless option" do
+    presence = ["", "", "", "hey!"].each
+    valid = Tryout.try do
+      presence.next
+    end.retry(5, :unless => :present?)
+    valid.should == "hey!"
+  end
+end
+

data/tryout.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'tryout/version'
+
+Gem::Specification.new do |s|
+  s.name        = "tryout"
+  s.version     = Tryout::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Endel Dreyer"]
+  s.email       = ["endel.dreyer@gmail.com"]
+  s.homepage    = "http://github.com/endel/tryout"
+
+  s.summary     = "Clean begin/rescue/retry utility."
+  s.description = "Allows you to do dirty stuff without messing up your code base."
+  s.licenses    = ['MIT']
+
+  s.add_development_dependency "activesupport", ">= 3.0.0"
+  s.add_development_dependency "rspec", ">= 2.0.0"
+  s.add_development_dependency "yard", "~> 0.8.3"
+  s.add_development_dependency "redcarpet", "~> 2.2.2"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+end
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: tryout
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Endel Dreyer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.2
+description: Allows you to do dirty stuff without messing up your code base.
+email:
+- endel.dreyer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/tryout.rb
+- lib/tryout/version.rb
+- spec/spec_helper.rb
+- spec/tryout_spec.rb
+- tryout.gemspec
+homepage: http://github.com/endel/tryout
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: Clean begin/rescue/retry utility.
+test_files: []
+has_rdoc: