retriable_proxy 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 176edfcfbf0397271894e8fbc383621f86142941
+  data.tar.gz: faad1b6f9d394430f48e2bedeb0c455ea4cb19e7
+SHA512:
+  metadata.gz: 58a0543fbe48dc8c38d1248c709cc46079d58b5d357f91e35a7cdbd5c3ca5e1167c015ba3565fb6c1454ad591bd82fd92a4d6d8e39ad401584a98f63160b7a87
+  data.tar.gz: fc977c40ac1b5a71879fcc29322f6f0739182d3c920c778960ab83a288873ce5b417fc953b4925c165a207747040522197678f93749ef175c7b491a284357271

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+cache: bundler
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: 1.9.3
+    - rvm: ruby-head
+    - rvm: jruby-head
+

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'retriable'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 3.2.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0"
+  gem "jeweler"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Julik Tarkhanov
+
+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,33 @@
+# retriable_proxy
+
+[![Build Status](https://travis-ci.org/julik/retriable_proxy.svg?branch=master)](https://travis-ci.org/julik/retriable_proxy)
+
+Creates an object wrapper on top of [Retriable.](https://github.com/kamui/retriable)
+The accepted keyword arguments are the same as for Retriable itself.
+
+    network_interface = API.new(unreliable_server: 'https://api-server.com')
+    stubborn_interface = RetriableProxy.for_object(network_interface, on: Net::TimeoutError)
+    stubborn_interface.create(id: 123, name: 'Some object that gets created') # Will retry
+
+If you only want to wrap certain methods, add the `:methods` option and pass in an `Array` of symbols.
+
+    network_interface = API.new(unreliable_server: 'https://api-server.com')
+    stubborn_interface = RetriableProxy.for_object(network_interface, on: Net::TimeoutError, methods: [:fetch_comments])
+    stubborn_interface.create(id: 123, name: 'Some object that gets created') # Will not retry
+    stubborn_interface.fetch_comments # Will do retry
+
+## Contributing to retriable_proxy
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2015 Julik Tarkhanov. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require_relative 'lib/retriable_proxy'
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://guides.rubygems.org/specification-reference/ for more options
+  gem.version = RetriableProxy::VERSION
+  gem.name = "retriable_proxy"
+  gem.homepage = "http://github.com/julik/retriable_proxy"
+  gem.license = "MIT"
+  gem.description = 'Adds an object wrapper on top of Retriable'
+  gem.summary = 'Retry arbitrary method calls on a given object, no matter its class'
+  gem.email = "me@julik.nl"
+  gem.authors = ["Julik Tarkhanov"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['spec'].execute
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "retriable_proxy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/retriable_proxy.rb

@@ -0,0 +1,54 @@
+require 'retriable'
+
+module RetriableProxy
+  VERSION = '1.0.0'
+  
+  class Wrapper
+    # Creates a new Wrapper that will wrap the messages to the wrapped object with
+    # a +retriable+ block.
+    #
+    # If the :methods option is passed, only the methods in the given array will be
+    # subjected to retries.
+    def initialize(with_object, options_for_retriable = {})
+      @o = with_object
+      @methods = options_for_retriable.delete(:methods)
+      @retriable_options = options_for_retriable
+    end
+  
+    # Returns the wrapped object
+    def __getobj__
+      @o
+    end
+  
+    # Assists in supporting method_missing
+    def respond_to_missing?(*a)
+      @o.respond_to?(*a)
+    end
+  
+    # Forwards all methods not defined on the Wrapper to the wrapped object.
+    def method_missing(*a)
+      method_name = a[0]
+      if block_given?
+        __retrying(method_name) { @o.public_send(*a){|*ba| yield(*ba)} }
+      else
+        __retrying(method_name) { @o.public_send(*a) }
+      end
+    end
+  
+    private
+  
+    # Executes a block within Retriable setup with @retriable_options
+    def __retrying(method_name_on_delegate)
+      if @methods.nil? || @methods.include?(method_name_on_delegate)
+        Retriable.retriable(@retriable_options) { yield }
+      else
+        yield
+      end
+    end
+  end
+  
+  
+  def self.for_object(object, retriable_opts={})
+    Wrapper.new(object, retriable_opts)
+  end
+end

data/retriable_proxy.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: retriable_proxy 1.0.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "retriable_proxy"
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Julik Tarkhanov"]
+  s.date = "2015-07-29"
+  s.description = "Adds an object wrapper on top of Retriable"
+  s.email = "me@julik.nl"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    ".travis.yml",
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "lib/retriable_proxy.rb",
+    "retriable_proxy.gemspec",
+    "spec/retriable_proxy_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/julik/retriable_proxy"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.2.2"
+  s.summary = "Retry arbitrary method calls on a given object, no matter its class"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<retriable>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.2.0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<retriable>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 3.2.0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<retriable>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 3.2.0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+  end
+end
+

data/spec/retriable_proxy_spec.rb

@@ -0,0 +1,68 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+require_relative "spec_helper"
+
+describe RetriableProxy do
+  
+  describe '.for_object' do
+    it 'wraps the object with a Retriable' do
+      w = described_class.for_object(:symbol_to_wrap)
+      expect(w).to be_kind_of(RetriableProxy::Wrapper)
+    end
+  end
+  
+  describe 'RetriableProxy::Wrapper' do
+    let(:subject) { RetriableProxy::Wrapper }
+    
+    it 'returns the wrapped object via __setobj__' do
+      item = :foo
+      wrapped = subject.new(item)
+      expect(wrapped).to be_kind_of(subject)
+      unwrapped = wrapped.__getobj__
+      expect(unwrapped).to be_kind_of(Symbol)
+    end
+  
+    it 'supports setting retrying methods explicitly' do
+      raising_class = Class.new do
+        def self.perform_failing_operation
+          @tries_failing ||= 0
+          @tries_failing += 1
+          raise StandardError.new if @tries_failing < 3
+          "success"
+        end
+      
+        def self.perform_non_retrying_operation
+          @tries_non_retrying ||= 0
+          @tries_non_retrying += 1
+          raise StandardError.new if @tries_non_retrying < 2 
+        end
+      end
+    
+      wrapped_raising_class = subject.new(raising_class, methods: [:perform_failing_operation])
+      expect(wrapped_raising_class.perform_failing_operation).to eq("success")
+    
+      expect {
+        wrapped_raising_class.perform_non_retrying_operation
+      }.to raise_error(StandardError)
+    end
+  
+    it "makes 3 tries when retrying block of code raising StandardError with no arguments" do
+      $tries = 0
+    
+      raising_class = Class.new do
+        def self.perform_failing_operation
+          $tries += 1
+          raise StandardError.new
+        end
+      end
+    
+      expect {
+        wrapped_raising_class = subject.new(raising_class, {})
+        wrapped_raising_class.perform_failing_operation
+      }.to raise_error(StandardError)
+    
+      expect($tries).to eq(3)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'retriable_proxy'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: retriable_proxy
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Julik Tarkhanov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: retriable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  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: Adds an object wrapper on top of Retriable
+email: me@julik.nl
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- ".document"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/retriable_proxy.rb
+- retriable_proxy.gemspec
+- spec/retriable_proxy_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/julik/retriable_proxy
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Retry arbitrary method calls on a given object, no matter its class
+test_files: []