take2 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59388477e42afe74b6c90644d81827c912f32009
+  data.tar.gz: b90cad82f9cbede51323717710e8221858c75bd7
+SHA512:
+  metadata.gz: e0fd246fd3e70ce50675a0c4356cc183e2af51dde8b70ec69f30c9e5124e18d70a83e2352cd3ebe03fe6e27df0876cb04c7737ab709ada1d9c1c07e3e5055bf3
+  data.tar.gz: 73016bec098e375b5d055999e8ca6d51972c11c7188671d554039676201f23e8ce0085a27c3d05191fa6aeb74d749f6332e29b9fe03a69cf0d9084e8822a1e25

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+gemspec
+
+gem "take2", :path => File.expand_path("..", __FILE__)
+
+gem "rake"
+
+group :test do
+  gem "rspec", "3.8.0"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Restaurant Cheetah
+
+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 @@
+# take2

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+end
+
+task default: [:spec]

data/lib/take2.rb

@@ -0,0 +1,109 @@
+require 'net/http'
+
+require 'take2/version'
+require 'take2/configuration'
+
+module Take2
+
+  def self.included(base)
+    base.extend ClassMethods
+    base.send :set_defaults
+    base.send :include, InstanceMethods
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset(options = {})
+    @configuration = Configuration.new(options)
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  module InstanceMethods
+
+    def call_api_with_retry
+      config = self.class.retriable_configuration
+      tries ||= config[:retries]
+      begin
+        yield
+      rescue => e
+        if config[:retriable].map {|klass| e.class <= klass }.any?
+          unless tries.zero? || config[:retry_condition_proc]&.call(e)
+            config[:retry_proc]&.call(e, tries)
+            sleep(config[:time_to_sleep]) if config[:time_to_sleep]
+            tries -= 1
+            retry
+          end
+        end
+        log_error e
+        raise e
+      end
+    end
+
+    def log_error(error)
+      # Overrider this method in the includer
+      true
+    end
+    
+  end
+
+  module ClassMethods
+
+    def number_of_retries(num)
+      self.retries = num
+    end
+
+    def retriable_errors(*errors)
+      self.retriable = errors
+    end
+
+    def retriable_condition(proc)
+      self.retry_condition_proc = proc
+    end
+
+    def on_retry(proc)
+      self.retry_proc = proc
+    end
+
+    def sleep_before_retry(seconds)
+      self.time_to_sleep = seconds
+    end
+
+    def retriable_configuration
+      Take2::Configuration::CONFIG_ATTRS.each_with_object({}) do |key, hash|
+        hash[key] = send(key)
+      end
+    end
+
+    private
+
+    attr_accessor(*Take2::Configuration::CONFIG_ATTRS)
+
+    def set_defaults
+      config = Take2.configuration.to_hash
+      Take2::Configuration::CONFIG_ATTRS.each do |attr|
+        instance_variable_set("@#{attr}", config[attr])
+      end
+    end
+
+    def response_status(response)
+      return response.status if response.respond_to? :status
+      response.status_code if response.respond_to? :status_code
+    end
+
+    def log_client_error(error, tries)
+      # Override this method in the includer
+      true
+    end
+
+  end
+
+end

data/lib/take2/configuration.rb

@@ -0,0 +1,39 @@
+module Take2
+  class Configuration
+    CONFIG_ATTRS = [:retries, :retriable, :retry_proc, :retry_condition_proc, :time_to_sleep].freeze
+    attr_accessor(*CONFIG_ATTRS)
+
+    def initialize(options = {})
+      # Defaults
+      @retries = 3
+      @retriable = [
+        Net::HTTPServerError,
+        Net::HTTPServerException,
+        Net::HTTPRetriableError,        
+        Errno::ECONNRESET,
+        IOError,
+       ].freeze
+      @retry_proc = proc {}
+      @retry_condition_proc = proc { false }
+      @time_to_sleep = 3
+      # Overwriting the defaults
+      options.each do |k, v|
+        raise ArgumentError, "#{k} is not a valid configuration"  unless CONFIG_ATTRS.include?(k)
+        raise ArgumentError, "#{k} must be positive integer"      unless v.is_a?(Integer) && v.positive?
+        raise ArgumentError, "#{k} must be positive number"       unless (v.is_a?(Integer) || v.is_a?(Float)) && v.positive?
+        instance_variable_set(:"@#{k}", v)
+      end
+    end
+
+    def to_hash
+      CONFIG_ATTRS.each_with_object({}) do |key, hash|
+        hash[key] = public_send(key)
+      end
+    end
+
+    def [](value)
+      self.public_send(value)
+    end
+
+  end
+end

data/lib/take2/version.rb

@@ -0,0 +1,3 @@
+module Take2
+  VERSION = "0.0.0"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'rspec'
+require 'take2'

data/spec/take2_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+require 'take2'
+
+RSpec.describe Take2 do
+
+  let!(:config) do
+    Take2.configure do |c|
+      c.retries               = 1
+      c.retriable             = [Net::HTTPServerError, Net::HTTPRetriableError].freeze
+      c.retry_condition_proc  = proc {false}
+      c.retry_proc            = proc {}
+      c.time_to_sleep         = 0.5
+    end
+  end
+  let(:klass)   { Class.new { include Take2 } }
+  let(:object)  { klass.new }
+
+  describe 'default values' do
+
+    subject { klass.retriable_configuration }
+
+    it 'has a default value for :retries' do
+      expect(subject[:retries]).to eql described_class.configuration[:retries]
+    end
+
+    it 'has a default value for :retriable' do
+      expect(subject[:retriable]).to eql described_class.configuration[:retriable]
+    end
+
+    it 'has a default value for :retry_condition_proc' do
+      expect(subject[:retry_condition_proc].call).to eql described_class.configuration[:retry_condition_proc].call
+    end
+
+    it 'has a default value for :retry_proc' do
+      expect(subject[:retry_proc].call).to eql described_class.configuration[:retry_proc].call
+    end
+
+    it 'has a default value for :time_to_sleep' do
+      expect(subject[:time_to_sleep]).to eql described_class.configuration[:time_to_sleep]
+    end
+
+  end
+
+  describe 'included helpers' do
+
+    subject { klass.retriable_configuration }
+
+    describe '#number_of_retries' do
+
+      it 'sets the :retries attribute' do
+        klass.number_of_retries 1
+        expect(subject[:retries]).to eql 1
+      end
+
+    end
+
+    describe '#retriable_errors' do
+
+      it 'sets the :retriable_errors attribute' do
+        retriables = IOError, Faraday::ClientError
+        klass.retriable_errors retriables
+        expect(subject[:retriable]).to eql [retriables]
+      end
+
+    end
+
+    describe '#retriable_condition' do
+
+      it 'sets the :retriable_condition attribute' do
+        retriable_proc = proc { 'Ho-Ho-Ho' }
+        klass.retriable_condition retriable_proc
+        expect(subject[:retry_condition_proc].call).to eql retriable_proc.call
+      end
+
+    end
+
+    describe '#on_retry' do
+
+      it 'sets the :on_retry attribute' do
+        retry_proc = proc { |el| el }
+        klass.on_retry retry_proc
+        expect(subject[:retry_proc].call).to eql retry_proc.call
+      end
+
+    end
+
+    describe '#sleep_before_retry' do
+
+      it 'sets the :sleep_before_retry attribute' do
+        klass.sleep_before_retry 3.5
+        expect(subject[:time_to_sleep]).to eql 3.5
+      end
+
+    end
+
+  end
+
+  describe '.call_api_with_retry' do
+
+    def increment_retry_counter
+      @tries += 1
+    end
+
+    def wrath_the_gods_with(error)
+      increment_retry_counter
+      raise error
+    end
+
+    context 'when raised with non retriable error' do
+
+      let(:error) { StandardError.new 'Release the Kraken!!' }
+
+      before(:each) { @tries = 0 }
+
+      it 're raises the original error' do
+        expect do
+          object.call_api_with_retry { wrath_the_gods_with error }
+        end.to raise_error error.class
+      end
+
+      it 'is not retried' do
+        expect do
+          object.call_api_with_retry { wrath_the_gods_with error } rescue nil
+        end.to change{@tries}.from(0).to(1)
+      end
+
+      it 'logs the error' do
+        expect(object).to receive(:log_error).with(error)
+        object.call_api_with_retry { wrath_the_gods_with error } rescue nil
+      end
+
+    end
+
+    context 'when raised with retriable error' do
+
+      let(:retriable_error) {  Net::HTTPRetriableError.new 'Release the Kraken...many times!!', nil }
+
+      before(:each) { @tries = 0 }
+
+      it 'retries correct number of times' do
+        expect do
+          object.call_api_with_retry { wrath_the_gods_with retriable_error } rescue nil
+        end.to change{@tries}.from(0).to(klass.retriable_configuration[:retries] + 1)
+      end
+
+      it 'calls the retry proc' do
+        expect(klass.retriable_configuration[:retry_proc]).to receive(:call).exactly(klass.retriable_configuration[:retries])
+        object.call_api_with_retry { wrath_the_gods_with retriable_error } rescue nil
+      end
+
+      it 'calls the retry_condition proc' do
+        expect(klass.retriable_configuration[:retry_condition_proc]).to receive(:call).exactly(klass.retriable_configuration[:retries])
+        object.call_api_with_retry { wrath_the_gods_with retriable_error } rescue nil
+      end
+
+      it 'sleeps the correct amount of time' do
+        allow_any_instance_of(Object).to receive(:sleep).with(klass.retriable_configuration[:time_to_sleep])
+        object.call_api_with_retry { wrath_the_gods_with retriable_error } rescue nil
+      end
+
+      it 'logs the error' do
+        expect(object).to receive(:log_error).with(retriable_error)
+        object.call_api_with_retry { wrath_the_gods_with retriable_error } rescue nil
+      end
+
+      it 're raises the original error' do
+        expect do
+          object.call_api_with_retry { wrath_the_gods_with retriable_error }
+        end.to raise_error retriable_error.class
+      end
+
+    end
+
+  end
+
+end

data/take2.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path("../lib/take2/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "take2"
+  s.version     = Take2::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.licenses    = ['MIT']
+  s.authors     = ["Anton Magids"]
+  s.email       = ["evnomadx@gmail.com"]
+  s.homepage    = "https://github.com/restaurant-cheetah/take2"
+  s.summary     = "Provides Take2 for your APIs calls"
+  s.description = "Easily define Take2 / retry behavior for API wrappers, service objects or a single method."
+  s.post_install_message = "Getting Take2 is dead easy!"
+
+  all_files = `git ls-files`.split("\n")
+  test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  
+  s.files         = all_files - test_files
+  s.test_files    = test_files
+  s.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: take2
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Anton Magids
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-09-12 00:00:00.000000000 Z
+dependencies: []
+description: Easily define Take2 / retry behavior for API wrappers, service objects
+  or a single method.
+email:
+- evnomadx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/take2.rb
+- lib/take2/configuration.rb
+- lib/take2/version.rb
+- spec/spec_helper.rb
+- spec/take2_spec.rb
+- take2.gemspec
+homepage: https://github.com/restaurant-cheetah/take2
+licenses:
+- MIT
+metadata: {}
+post_install_message: Getting Take2 is dead easy!
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Provides Take2 for your APIs calls
+test_files:
+- spec/spec_helper.rb
+- spec/take2_spec.rb