take2 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 93023dc58265f6607decc8cb6aa621c3ac538752
-  data.tar.gz: 99d85d1401815f441b891ac84468dac5cce4860e
+  metadata.gz: fdbb5ecf82b31d399cf75eacacd3a7c8b4cf4aaa
+  data.tar.gz: 3662448022c2ca158c789982b7d51a62ae81c0e4
 SHA512:
-  metadata.gz: d38f2b5982925c8d4a116b14d799e8deb93256bccd886cc0dd0a560eed664f0caf8d5ba158074d15fc9ae2f54df33592b473af0f5611e2f19fba4a4281902d3d
-  data.tar.gz: 34fb1713275927a3edeee00870331f8e44b182ac1da2dcd0238e5c459f86839b8e03424224da3be84a0c0a472b7aa7de937febd9a3e7006c7da00a28860b3741
+  metadata.gz: 153630133ce8f3dee9d7f0ef2f0ad2ca57673591ac08435e11b692124aec32cbae50b4d9b2bed42545156168fc3e60f3fa58e61060f5952d08fd5fd74202e582
+  data.tar.gz: 5f73de42c0c6a7381bc6943f5a02d77bc8fc16f893ee59e749699210cd7a4c8f5821d908df8cd830cba92cf59bc254c9b30ab6b2093df86cc4ed9c2da7fd720d

data/.circleci/config.yml

@@ -0,0 +1,53 @@
+# Ruby CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-ruby/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+       - image: circleci/ruby:2.4-node        
+      
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/take2
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+          - v1-dependencies-{{ checksum "Gemfile.lock" }}
+          # fallback to using the latest cache if no exact match is found
+          - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+      - save_cache:
+          paths:
+            - ./vendor/bundle
+          key: v1-dependencies-{{ checksum "Gemfile.lock" }}
+  
+      # run tests!
+      - run:
+          name: run tests
+          command: |
+            mkdir /tmp/test-results
+            TEST_FILES="$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)"
+            
+            bundle exec rspec $TEST_FILES --format doc
+                                                      
+      # collect reports
+      - store_test_results:
+          path: /tmp/test-results
+      - store_artifacts:
+          path: /tmp/test-results
+          destination: test-results

data/Gemfile

@@ -5,4 +5,9 @@ gem "rake"
 
 group :test do
   gem "rspec", "3.8.0"
+end
+
+group :development, :test do
+  gem 'pry'
+  gem 'pry-nav'
 end

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    take2 (0.0.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rake (12.3.1)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  pry-nav
+  rake
+  rspec (= 3.8.0)
+  take2!
+
+BUNDLED WITH
+   1.16.4

data/README.md

@@ -1,17 +1,20 @@
 ## Take2
-#  
+[![CircleCI](https://circleci.com/gh/restaurant-cheetah/take2/tree/master.svg?style=shield)](https://circleci.com/gh/restaurant-cheetah/take2/tree/master)
+![Gem](https://img.shields.io/gem/dt/take2.svg)
+![GitHub last commit](https://img.shields.io/github/last-commit/restaurant-cheetah/take2.svg)
+![Gem](https://img.shields.io/gem/v/take2.svg)  
 Define rules for retrying behavior.  
 Yield block of code into the public api of the take2.  
 Things getting take two :)
 
 ## Install
-#
-```
+
+```ruby
 gem install take2
 ```
 ## Examples
-#
-```
+
+```ruby
 class KratosService
   include Take2
 
@@ -39,14 +42,22 @@ class KratosService
     end
   end
 
+  # Pass custom options per method call
+  # The class defaults will not be overwritten
+  def kill_baldur
+    call_api_with_retry(retries: 2, retriable: [IOError], retry_proc: proc {}, retry_condition_proc: proc {}, time_to_sleep: 1.11) do
+      # Some logic that might raise..
+    end
+  end
+
 end  
 
-KratosService.new.call_boy =>
-KratosService - Retrying.. 3 of 3 (Release the Kraken...many times!!)
-KratosService - Retrying.. 2 of 3 (Release the Kraken...many times!!)
-KratosService - Retrying.. 1 of 3 (Release the Kraken...many times!!)
+KratosService.new.call_boy
+#=> KratosService - Retrying.. 3 of 3 (Release the Kraken...many times!!)
+#=> KratosService - Retrying.. 2 of 3 (Release the Kraken...many times!!)
+#=> KratosService - Retrying.. 1 of 3 (Release the Kraken...many times!!)
 # After the retrying is done, original error re-raised  
-Net::HTTPRetriableError: Release the Kraken...many times!!
+#=> Net::HTTPRetriableError: Release the Kraken...many times!!
 
 # Not wrapping with method
 KratosService.new.call_api_with_retry { 1 / 0 }
@@ -62,8 +73,8 @@ KratosService.retriable_configuration
 
 ## Configurations
 #### could be implemented as rails initializer
-#
-```
+
+```ruby
 # config/initializers/take2.rb
 
 Take2.configure do |config|

data/lib/take2.rb

@@ -23,6 +23,10 @@ module Take2
     @configuration = Configuration.new(options)
   end
 
+  def self.local_defaults(options)
+    configuration.validate_options(options)
+  end
+
   def self.configure
     yield(configuration) if block_given?
   end
@@ -33,7 +37,7 @@ module Take2
     # The raised error could be the defined retriable or it child.
     #
     # Example:
-    #   class KatorzaService
+    #   class PizzaService
     #     include Take2
     #
     #     number_of_retries 3
@@ -51,8 +55,9 @@ module Take2
     #     end
     #
     #   end
-    def call_api_with_retry
+    def call_api_with_retry(options = {})        
       config = self.class.retriable_configuration
+      config.merge! Take2.local_defaults(options) unless options.empty?
       tries ||= config[:retries]
       begin
         yield
@@ -75,12 +80,12 @@ module Take2
     # Sets number of retries.
     #
     # Example:
-    #   class KatorzaService
+    #   class PizzaService
     #     include Take2
     #     number_of_retries 3
     #   end
     # Arguments:
-    #   num: Positive integer
+    #   num: integer
     def number_of_retries(num)
       raise ArgumentError, 'Must be positive Integer' unless num.is_a?(Integer) && num.positive?
       self.retries = num
@@ -89,13 +94,14 @@ module Take2
     # Sets list of errors on which the block will retry.
     #
     # Example:
-    #   class KatorzaService
+    #   class PizzaService
     #     include Take2
     #     retriable_errors Net::HTTPRetriableError, Errno::ECONNRESET
     #   end
     # Arguments:
     #   errors: List of retiable errors
     def retriable_errors(*errors)
+      raise ArgumentError, 'All retriable errors must be StandardError decendants' unless errors.all? { |e| e <= StandardError }
       self.retriable = errors
     end
 
@@ -103,12 +109,12 @@ module Take2
     # If set, it MUST result to +false+ with number left retries greater that zero in order to retry.
     #
     # Example:
-    #   class KatorzaService
+    #   class PizzaService
     #     include Take2
     #     retriable_condition proc { |error| error.response.status_code < 500 }
     #   end
     # Arguments:
-    #   proc: Proc. The +proc+ called by default with the raised error argument
+    #   proc: Proc. The proc called by default with the raised error argument
     def retriable_condition(proc)
       raise ArgumentError, 'Must be callable' unless proc.respond_to?(:call)
       self.retry_condition_proc = proc
@@ -117,12 +123,12 @@ module Take2
     # Defines a proc that is called *before* retry attempt. 
     #
     # Example:
-    #   class KatorzaService
+    #   class PizzaService
     #     include Take2
     #     on_retry proc { |error, tries| puts "Retrying.. #{tries} of #{self.class.retriable_configuration[:retries]}" }
     #   end
     # Arguments:
-    #   proc: Proc. The +proc+ called by default with the raised error and number of left retries.
+    #   proc: Proc. The proc called by default with the raised error and number of left retries.
     def on_retry(proc)
       raise ArgumentError, 'Must be callable' unless proc.respond_to?(:call)
       self.retry_proc = proc
@@ -131,12 +137,12 @@ module Take2
     # Sets number of seconds to sleep before next retry.
     #
     # Example:
-    #   class KatorzaService
+    #   class PizzaService
     #     include Take2
     #     sleep_before_retry 1.5
     #   end
     # Arguments:
-    #   seconds: Positive number.
+    #   seconds: number
     def sleep_before_retry(seconds)
       raise ArgumentError, 'Must be positive numer' unless (seconds.is_a?(Integer) || seconds.is_a?(Float)) && seconds.positive?
       self.time_to_sleep = seconds

data/lib/take2/configuration.rb

@@ -17,12 +17,7 @@ module Take2
       @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
+      validate_options(options, &setter)
     end
 
     def to_hash
@@ -35,5 +30,26 @@ module Take2
       self.public_send(value)
     end
 
+    def validate_options(options, &setter)
+      options.each do |k, v|
+        raise ArgumentError, "#{k} is not a valid configuration"  unless CONFIG_ATTRS.include?(k)
+        case k
+          when :retries
+            raise ArgumentError, "#{k} must be positive integer" unless v.is_a?(Integer) && v.positive?
+          when :time_to_sleep  
+            raise ArgumentError, "#{k} must be positive number" unless (v.is_a?(Integer) || v.is_a?(Float)) && v >= 0
+          when :retriable
+            raise ArgumentError, "#{k} must be array of retriable errors" unless v.is_a?(Array)
+          when :retry_proc, :retry_condition_proc
+            raise ArgumentError, "#{k} must be Proc" unless v.is_a?(Proc)
+        end
+        setter.call(k, v) if block_given?
+      end  
+    end
+
+    def setter
+      proc { |key, value| instance_variable_set(:"@#{key}", value) }
+    end
+
   end
 end

data/lib/take2/version.rb

@@ -1,3 +1,3 @@
 module Take2
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 require 'rspec'
-require 'take2'
+require 'take2'
+require 'pry'

data/spec/take2/configuration_spec.rb

@@ -0,0 +1,125 @@
+require 'spec_helper'
+
+RSpec.describe Take2::Configuration do
+
+  describe 'default configurations' do
+
+    let(:default) { described_class.new }
+
+    it 'has correct default value for retries' do
+      expect(default.retries).to eql 3
+    end
+
+    it 'has correct default retriable errors array' do
+      expect(default.retriable).to eql [
+        Net::HTTPServerError,
+        Net::HTTPServerException,
+        Net::HTTPRetriableError,        
+        Errno::ECONNRESET,
+        IOError,
+       ].freeze
+    end
+
+    it 'has default proc for retry_proc' do
+      p = proc {}
+      expect(default.retry_proc.call).to eql p.call
+    end
+
+    it 'has default proc for retry_condition_proc' do
+      p = proc {false}
+      expect(default.retry_condition_proc.call).to eql p.call
+    end
+
+    it 'has correct default value for time_to_sleep' do
+      expect(default.time_to_sleep).to eql 3
+    end
+
+  end
+
+  describe 'overwriting the default configurations' do
+
+    context 'with valid hash' do
+
+      let!(:new_configs_hash) { 
+        {
+          retries: 2,
+          retriable: [Net::HTTPRetriableError],
+          retry_condition_proc: proc { true },
+          retry_proc: proc { 2*2 },
+          time_to_sleep: 0
+        }
+      }
+
+      let!(:new_configuration) { described_class.new(new_configs_hash).to_hash }
+
+      [:retries, :retriable, :retry_proc, :retry_condition_proc, :time_to_sleep].each do |key|
+        it "sets the #{key} key" do
+          if new_configs_hash[key].respond_to?(:call)
+            expect(new_configuration[key].call).to eql new_configs_hash[key].call
+          else  
+            expect(new_configuration[key]).to eql new_configs_hash[key]
+          end
+        end
+      end
+
+    end
+
+    context 'with invalid hash' do
+
+      context 'when retries set to invalid value' do
+
+        it 'raises ArgumentError' do
+
+          expect { described_class.new(retries: -1) }.to raise_error ArgumentError
+          expect { described_class.new(retries: 0) }.to raise_error ArgumentError
+
+        end
+
+      end
+
+      context 'when time_to_sleep set to invalid value' do
+
+        it 'raises ArgumentError' do
+
+          expect { described_class.new(time_to_sleep: -1) }.to raise_error ArgumentError
+          
+        end
+
+      end
+
+      context 'when retriable set to invalid value' do
+
+        it 'raises ArgumentError' do
+
+          expect { described_class.new(retriable: StandardError) }.to raise_error ArgumentError
+          
+        end
+
+      end
+
+      context 'when retry_proc set to invalid value' do
+
+        it 'raises ArgumentError' do
+
+          expect { described_class.new(retry_proc: {}) }.to raise_error ArgumentError
+          
+        end
+
+      end
+
+      context 'when retry_condition_proc set to invalid value' do
+
+        it 'raises ArgumentError' do
+
+          expect { described_class.new(retry_condition_proc: {}) }.to raise_error ArgumentError
+          
+        end
+
+      end
+      
+    end
+
+  end
+
+
+end

data/spec/take2_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'take2'
 
 RSpec.describe Take2 do
 
@@ -41,54 +40,115 @@ RSpec.describe Take2 do
 
   end
 
-  describe 'included helpers' do
+  describe 'included class helpers' do
 
     subject { klass.retriable_configuration }
 
-    describe '#number_of_retries' do
+    describe '.number_of_retries' do
+
+      context 'with valid argument' do
+
+        it 'sets the :retries attribute' do
+          klass.number_of_retries 1
+          expect(subject[:retries]).to eql 1
+        end
+
+      end
+
+      context 'with invalid argument' do
+
+        it 'raises ArgumentError' do
+          expect { klass.number_of_retries 0 }.to raise_error ArgumentError
+        end
 
-      it 'sets the :retries attribute' do
-        klass.number_of_retries 1
-        expect(subject[:retries]).to eql 1
       end
 
     end
 
-    describe '#retriable_errors' do
+    describe '.retriable_errors' do
+
+      context 'with valid argument' do
+
+        it 'sets the :retriable_errors attribute' do
+          retriables = IOError
+          klass.retriable_errors retriables
+          expect(subject[:retriable]).to eql [retriables]
+        end
+
+      end
+
+      context 'with invalid argument' do
+
+        it 'raises ArgumentError' do
+          class Klass; end
+          expect { klass.retriable_errors Klass }.to raise_error ArgumentError
+        end
 
-      it 'sets the :retriable_errors attribute' do
-        retriables = IOError
-        klass.retriable_errors retriables
-        expect(subject[:retriable]).to eql [retriables]
       end
 
     end
 
-    describe '#retriable_condition' do
+    describe '.retriable_condition' do
+
+      context 'with valid argument' 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
+
+      context 'with invalid argument' do
+
+         it 'raises ArgumentError' do
+          expect { klass.retriable_condition Class.new }.to raise_error ArgumentError
+         end
 
-      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
+    describe '.on_retry' do
+
+      context 'with valid argument' 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  
+
+      context 'with invalid argument' do
+
+        it 'raises ArgumentError' do
+          expect { klass.on_retry Class.new }.to raise_error ArgumentError
+        end
 
-      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
+    describe '.sleep_before_retry' do
+
+      context 'with valid argument' 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
+      
+      context 'with invalid argument' do
+
+        it 'raises ArgumentError' do
+          expect { klass.sleep_before_retry -1 }.to raise_error ArgumentError
+        end
 
-      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
@@ -140,7 +200,7 @@ RSpec.describe Take2 do
       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.to change {@tries}.from(0).to(klass.retriable_configuration[:retries] + 1)
       end
 
       it 'calls the retry proc' do
@@ -171,6 +231,50 @@ RSpec.describe Take2 do
 
     end
 
+    context 'with custom options' do
+
+      let(:retriable_error)     { Net::HTTPRetriableError.new 'Release the Kraken...many times!!', nil }
+      let(:new_retriable_error) { IOError.new 'You shall not PASS!' }
+
+      before(:each) { @tries = 0 }
+        
+      it 'overwrites the :retries' do
+        expect do
+          object.call_api_with_retry(retries: 3) { wrath_the_gods_with retriable_error } rescue nil
+        end.to change { @tries }.from(0).to(4)
+      end
+
+      it 'overwrites the :retry_proc' do
+        new_proc = proc { 1**1 }
+        expect(new_proc).to receive(:call).exactly(klass.retriable_configuration[:retries])
+        object.call_api_with_retry(retry_proc: new_proc) { wrath_the_gods_with retriable_error } rescue nil          
+      end
+
+      it 'overwrites the :retry_condition_proc' do
+        new_proc = proc { true }
+        expect(new_proc).to receive(:call).exactly(klass.retriable_configuration[:retries])
+        object.call_api_with_retry(retry_condition_proc: new_proc) { wrath_the_gods_with retriable_error } rescue nil          
+      end
+
+      it 'overwrites the :time_to_sleep' do
+        allow_any_instance_of(Object).to receive(:sleep).with(1.66)
+        object.call_api_with_retry(time_to_sleep: 1.66) { wrath_the_gods_with retriable_error } rescue nil
+      end
+
+      it 'overwrites the :retriable' do
+        expect do                
+          object.call_api_with_retry(retriable: [new_retriable_error]) { wrath_the_gods_with retriable_error } rescue nil
+        end.to change { @tries }.from(0).to(1)
+      end
+
+      it 'raises ArgumentError if there are invalid keys' do
+        expect do                
+          object.call_api_with_retry(invalid_key: :nope) { wrath_the_gods_with retriable_error }
+        end.to raise_error ArgumentError
+      end
+
+    end
+
   end
 
 end

data/take2.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   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.description = "Retry API calls, methods or blocks of code. Define take2 retry behavior or use defaults and you good to go."
   s.post_install_message = "Getting Take2 is dead easy!"
 
   all_files = `git ls-files`.split("\n")

metadata

@@ -1,28 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: take2
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Anton Magids
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-13 00:00:00.000000000 Z
+date: 2018-09-24 00:00:00.000000000 Z
 dependencies: []
-description: Easily define Take2 / retry behavior for API wrappers, service objects
-  or a single method.
+description: Retry API calls, methods or blocks of code. Define take2 retry behavior
+  or use defaults and you good to go.
 email:
 - evnomadx@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
@@ -30,6 +32,7 @@ files:
 - lib/take2/configuration.rb
 - lib/take2/version.rb
 - spec/spec_helper.rb
+- spec/take2/configuration_spec.rb
 - spec/take2_spec.rb
 - take2.gemspec
 homepage: https://github.com/restaurant-cheetah/take2
@@ -58,4 +61,5 @@ specification_version: 4
 summary: Provides Take2 for your APIs calls
 test_files:
 - spec/spec_helper.rb
+- spec/take2/configuration_spec.rb
 - spec/take2_spec.rb