greenjaguar 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ea25f0dabc607887639c7464307e62e12b80e3f
-  data.tar.gz: cb247a82fc96793de4c6bbb8da97a59b3c7da30e
+  metadata.gz: 5dd4f387ad0f79d53b1622d411199d55cb640d2c
+  data.tar.gz: 46b57205cb9a7bbac6aa9df87f24d1d92f3243ba
 SHA512:
-  metadata.gz: d2bd34a55d564d49e9c5fa82674a3c5b4a950d9313575230ff5f417ddd9f25ebc96e75075013908b0acde767e6e3748840911e4f317664e68ec4de816eca0efe
-  data.tar.gz: ddb3c0705c9ec28d82bdaeeb2e5278a958ec96f2453d55de2215d8d58745cc5cab184788371072f81bb7803d9f6095368a38bb0f0f646222964c79165565421c
+  metadata.gz: e425dc9d9967cb79eef0d516e2fccb57c23613d259e0067b0d97c62e645029da63e23fc58623d7ce4f182dfeaf6e9ed17bc7927bc6584e3ca5331972dff12812
+  data.tar.gz: ce72b91c424aea7cef0c52ba55230a05e7ed27e058022d4057f79da81e6db5ba2668e6c23fe035e9574798f7ab778d09b28515454f20096ea0a503f29aa9db7e

data/README.md

@@ -45,7 +45,7 @@ class YourClass
   def your_method
     # Build retry policy
     @policy = build_policy do
-        retry_times 10
+        times 10
         with_strategy :exponential_backoff
         measure_time_in :ms
         only_on_exceptions [Net::HTTPError]
@@ -63,6 +63,23 @@ In the above example your code block is passed to Greenjaguar which executes it
 If all calls fail, the last exception is raised. Retry happens only if the error raised is of the
 specified type.
 
+## Available Options explained
+- times: Number of retry attempts
+- with_strategy: Retry Strategy to use. Greenjaguar currently supports following
+    - exponential_backoff: wait times after each failed retry will increase exponentially. This is the standard
+     used in most of the industry's retry policies.
+    - fibonacci: wait times increase in fibonacci series.
+    - fixed_interval: wait times between retries are fixed.
+    - random: wait times are randomly selected between 0 to 5 secs.
+  Skip this option if you want immediate retries.
+- measure_time_in: wait times can be in either sec or ms.
+- only_on_exceptions: Provide the Exception Types for which Greenjaguar should retry. Default is all.
+- fail_silently: Will fail silently without raising any exceptions after all retries fail.
+- never_give_up: Retry will continue indefinitely or until there is success.
+- timeout_after: Set a timeout period after which Greenjaguar should quit and just raise the exception.
+
+Refer spec/greenjaguar_spec.rb to se examples of using the options.
+
 ## Issues
 
 1. Need more tests.

data/greenjaguar.gemspec

@@ -10,7 +10,6 @@ Gem::Specification.new do |spec|
   spec.email         = ["anides84 AT hotmail DOT com"]
   spec.summary       = %q{Applies retry behavior to arbitrary code blocks with different policies like fibonacci,
 exponential backoff, FixedInterval, etc. This basically is the 'retry' construct on steroids.}
-  spec.description   = ""
   spec.homepage      = "https://github.com/aniruddha84/greenjaguar"
   spec.license       = "MIT"
 

data/lib/greenjaguar/policy_builder.rb

@@ -9,17 +9,17 @@ module Greenjaguar
       instance_eval(&block)
     end
 
-    def retry_times(retry_count)
+    def times(retry_count)
       @count = retry_count
       self
     end
 
-    def should_timeout_after(retry_timeout)
+    def timeout_after(retry_timeout)
       @timeout = retry_timeout
       self
     end
 
-    def use_logger(logger)
+    def logger(logger)
       @logger = logger
       self
     end

data/lib/greenjaguar/version.rb

@@ -1,3 +1,3 @@
 module Greenjaguar
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/greenjaguar_spec.rb

@@ -16,7 +16,7 @@ module Specs
 
     it '#run should call the passed code block 4 times' do
       policy = class_under_test.build_policy do
-        retry_times 3
+        times 3
       end
 
       expect do
@@ -31,7 +31,7 @@ module Specs
       @stub = stub_request(:get, "http://www.example.com")
 
       policy = class_under_test.build_policy do
-        retry_times 3
+        times 3
       end
 
       class_under_test.robust_retry(policy) do
@@ -42,7 +42,7 @@ module Specs
 
     it '#run should raise the error once retrying is completed' do
       policy = class_under_test.build_policy do
-        retry_times 3
+        times 3
       end
 
       expect do
@@ -54,7 +54,7 @@ module Specs
 
     it '#run should call the passed code block 4 times according to fibonacci sequence' do
       policy = class_under_test.build_policy do
-        retry_times 3
+        times 3
         with_strategy :fibonacci
         measure_time_in :ms
       end
@@ -69,7 +69,7 @@ module Specs
 
     it '#run should call the passed code block 4 times according to fixed interval strategy' do
       policy = class_under_test.build_policy do
-        retry_times 3
+        times 3
         with_strategy :fixed_interval, 2
         measure_time_in :ms
       end
@@ -84,7 +84,7 @@ module Specs
 
     it '#run should call the passed code block 4 times according to exponential backoff sequence' do
       policy = class_under_test.build_policy do
-        retry_times 5
+        times 5
         with_strategy :exponential_backoff
         measure_time_in :ms
       end
@@ -100,7 +100,7 @@ module Specs
     it '#run does not call the passed code block if exception is not part of allowed exception(s)' do
       @stub = stub_request(:get, "www.example.com").to_raise(RegexpError)
       policy = class_under_test.build_policy do
-        retry_times 5
+        times 5
         with_strategy :fibonacci
         only_on_exceptions [ZeroDivisionError]
       end
@@ -117,7 +117,7 @@ module Specs
       @stub = stub_request(:get, "http://www.example.com").to_raise(ZeroDivisionError)
 
       policy = class_under_test.build_policy do
-        retry_times 10
+        times 10
         with_strategy :fibonacci
         measure_time_in :ms
         only_on_exceptions [ZeroDivisionError, IOError]
@@ -133,7 +133,7 @@ module Specs
 
     it '#run should not raise the error if set to fail silently' do
       policy = class_under_test.build_policy do
-        retry_times 3
+        times 3
         fail_silently
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: greenjaguar
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Aniruddha Deshpande
@@ -108,7 +108,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.21'
-description: ''
+description: 
 email:
 - anides84 AT hotmail DOT com
 executables: []