take2 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8ec07213b11c7223692259cee1c4fae9af86069
-  data.tar.gz: e3050a3a0aac4b6454193e2051a899e4b2b52635
+  metadata.gz: 93023dc58265f6607decc8cb6aa621c3ac538752
+  data.tar.gz: 99d85d1401815f441b891ac84468dac5cce4860e
 SHA512:
-  metadata.gz: 73b036448036c9903c5cae7243ff7dfe1df679f04f5482ac413a40aeb3587652fd7f66ac457be8feb624706bf4534e73cede712935e47ffb7131f4dc89fe1cac
-  data.tar.gz: 83cfcac40ee6e3c24f546091a016ab93b6a72527a9a66a3f713df9a7376625cd29c1d339fc876597c24e0832e6ffb08a2364d7b271087b57ac392a39597fc04a
+  metadata.gz: d38f2b5982925c8d4a116b14d799e8deb93256bccd886cc0dd0a560eed664f0caf8d5ba158074d15fc9ae2f54df33592b473af0f5611e2f19fba4a4281902d3d
+  data.tar.gz: 34fb1713275927a3edeee00870331f8e44b182ac1da2dcd0238e5c459f86839b8e03424224da3be84a0c0a472b7aa7de937febd9a3e7006c7da00a28860b3741

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/README.md

@@ -1 +1,82 @@
-# Work in process
+## Take2
+#  
+Define rules for retrying behavior.  
+Yield block of code into the public api of the take2.  
+Things getting take two :)
+
+## Install
+#
+```
+gem install take2
+```
+## Examples
+#
+```
+class KratosService
+  include Take2
+
+  
+  number_of_retries 3
+  
+  # Could be configured globally or on class level.
+  retriable_errors Net::HTTPRetriableError, Net::HTTPServerError
+
+  # Retry unless the response status is 5xx. The implementation is dependent of the http lib in use.
+  retriable_condition proc { |error| error.response.code < 500 }
+
+  # Defines callable code to run before next retry. Could be an out put to some logger.
+  on_retry proc { |error, tries| puts "#{self.name} - Retrying.. #{tries} of #{self.retriable_configuration[:retries]} (#{error})" }
+       
+  sleep_before_retry 3.3
+
+  def call_boy
+    call_api_with_retry do
+      # Some logic that might raise..
+      # If it will raise retriable, magic happens.
+      # If not the original error re raised
+
+      raise Net::HTTPRetriableError.new 'Release the Kraken...many times!!', nil
+    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!!)
+# After the retrying is done, original error re-raised  
+Net::HTTPRetriableError: Release the Kraken...many times!!
+
+# Not wrapping with method
+KratosService.new.call_api_with_retry { 1 / 0 }
+
+# Or..
+Class.new { include Take2 }.new.call_api_with_retry { 1 / 0 }
+
+
+# Current configuration hash
+KratosService.retriable_configuration
+
+```
+
+## Configurations
+#### could be implemented as rails initializer
+#
+```
+# config/initializers/take2.rb
+
+Take2.configure do |config|
+  config.retries    = 3
+  config.retriable  = [
+      Net::HTTPServerError,
+      Net::HTTPServerException,
+      Net::HTTPRetriableError,      
+      Errno::ECONNRESET,
+      IOError
+  ].freeze
+  config.retry_condition_proc = proc {false}
+  config.time_to_sleep        = nil
+  config.retry_proc           = proc {Rails.logger.info "Retry message"}
+end
+```

data/lib/take2.rb

@@ -39,9 +39,7 @@ module 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
+    #     on_retry proc { |error, tries| puts "#{self.name} - Retrying.. #{tries} of #{self.retriable_configuration[:retries]} (#{error})" }    
     #     sleep_before_retry 3
     #
     #     def give_me_food

data/lib/take2/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: take2
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Anton Magids
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-12 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies: []
 description: Easily define Take2 / retry behavior for API wrappers, service objects
   or a single method.
@@ -18,6 +18,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile