take2 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59388477e42afe74b6c90644d81827c912f32009
-  data.tar.gz: b90cad82f9cbede51323717710e8221858c75bd7
+  metadata.gz: c8ec07213b11c7223692259cee1c4fae9af86069
+  data.tar.gz: e3050a3a0aac4b6454193e2051a899e4b2b52635
 SHA512:
-  metadata.gz: e0fd246fd3e70ce50675a0c4356cc183e2af51dde8b70ec69f30c9e5124e18d70a83e2352cd3ebe03fe6e27df0876cb04c7737ab709ada1d9c1c07e3e5055bf3
-  data.tar.gz: 73016bec098e375b5d055999e8ca6d51972c11c7188671d554039676201f23e8ce0085a27c3d05191fa6aeb74d749f6332e29b9fe03a69cf0d9084e8822a1e25
+  metadata.gz: 73b036448036c9903c5cae7243ff7dfe1df679f04f5482ac413a40aeb3587652fd7f66ac457be8feb624706bf4534e73cede712935e47ffb7131f4dc89fe1cac
+  data.tar.gz: 83cfcac40ee6e3c24f546091a016ab93b6a72527a9a66a3f713df9a7376625cd29c1d339fc876597c24e0832e6ffb08a2364d7b271087b57ac392a39597fc04a

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+0.0.1  
+#  
+* Add class validations for class helper methods
+* Add basic documentation
+* Rename the public api to :call_with_retry

data/Gemfile

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

data/README.md

@@ -1 +1 @@
-# take2
+# Work in process

data/lib/take2.rb

@@ -29,6 +29,30 @@ module Take2
 
   module InstanceMethods
 
+    # Yields a block and retries on retriable errors n times.
+    # The raised error could be the defined retriable or it child.
+    #
+    # Example:
+    #   class KatorzaService
+    #     include Take2
+    #
+    #     number_of_retries 3
+    #     retriable_errors Net::HTTPRetriableError, Net::HTTPServerError
+    #     retriable_condition proc { |error| response_status(error.response) < 500 }
+    #     on_retry proc do |error, tries|
+    #       puts "#{self.class.name} - Retrying.. #{tries} of #{self.class.retriable_configuration[:retries]} (#{error})"
+    #     end
+    #     sleep_before_retry 3
+    #
+    #     def give_me_food
+    #       call_api_with_retry do
+    #         # Some logic that might raise..
+    #         # If it will raise retriable, magic happens.
+    #         # If not the original error re raised
+    #       end
+    #     end
+    #
+    #   end
     def call_api_with_retry
       config = self.class.retriable_configuration
       tries ||= config[:retries]
@@ -42,41 +66,85 @@ module Take2
             tries -= 1
             retry
           end
-        end
-        log_error e
+        end        
         raise e
       end
     end
-
-    def log_error(error)
-      # Overrider this method in the includer
-      true
-    end
     
   end
 
   module ClassMethods
-
+    # Sets number of retries.
+    #
+    # Example:
+    #   class KatorzaService
+    #     include Take2
+    #     number_of_retries 3
+    #   end
+    # Arguments:
+    #   num: Positive integer
     def number_of_retries(num)
+      raise ArgumentError, 'Must be positive Integer' unless num.is_a?(Integer) && num.positive?
       self.retries = num
     end
 
+    # Sets list of errors on which the block will retry.
+    #
+    # Example:
+    #   class KatorzaService
+    #     include Take2
+    #     retriable_errors Net::HTTPRetriableError, Errno::ECONNRESET
+    #   end
+    # Arguments:
+    #   errors: List of retiable errors
     def retriable_errors(*errors)
       self.retriable = errors
     end
 
+    # Sets condition for retry attempt. 
+    # If set, it MUST result to +false+ with number left retries greater that zero in order to retry.
+    #
+    # Example:
+    #   class KatorzaService
+    #     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
     def retriable_condition(proc)
+      raise ArgumentError, 'Must be callable' unless proc.respond_to?(:call)
       self.retry_condition_proc = proc
     end
 
+    # Defines a proc that is called *before* retry attempt. 
+    #
+    # Example:
+    #   class KatorzaService
+    #     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.
     def on_retry(proc)
+      raise ArgumentError, 'Must be callable' unless proc.respond_to?(:call)
       self.retry_proc = proc
     end
 
+    # Sets number of seconds to sleep before next retry.
+    #
+    # Example:
+    #   class KatorzaService
+    #     include Take2
+    #     sleep_before_retry 1.5
+    #   end
+    # Arguments:
+    #   seconds: Positive 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
     end
 
+    # Exposes current class configuration
     def retriable_configuration
       Take2::Configuration::CONFIG_ATTRS.each_with_object({}) do |key, hash|
         hash[key] = send(key)
@@ -99,11 +167,6 @@ module Take2
       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/version.rb

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

data/spec/take2_spec.rb

@@ -57,7 +57,7 @@ RSpec.describe Take2 do
     describe '#retriable_errors' do
 
       it 'sets the :retriable_errors attribute' do
-        retriables = IOError, Faraday::ClientError
+        retriables = IOError
         klass.retriable_errors retriables
         expect(subject[:retriable]).to eql [retriables]
       end
@@ -124,10 +124,10 @@ RSpec.describe Take2 do
         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
+      # 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
 
@@ -158,10 +158,10 @@ RSpec.describe Take2 do
         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 '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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: take2
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Anton Magids
@@ -19,6 +19,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md