circuit_breakage 0.2.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf00e430eba8f24feacafd2a94ebfc2e9ce53737
-  data.tar.gz: d6550c42f12736a6a87a6059df53ba2315fa320b
+  metadata.gz: 44c83ed5565612433627a4466aa4486ebdf25543
+  data.tar.gz: a0f65eb73e9dd27f832adf19d860e979112efb9e
 SHA512:
-  metadata.gz: 5752657e3fd2e10342190cbfab8539068087cb145a07070f02091dbdaa0da50249afede7656def46eef30dd524f242041e7c5ff0bc8573ef56a5aae509b0a79c
-  data.tar.gz: a51e540148c42f4de8d3008b40a14b77ae680010ae4d64f4f404b04cb0793822d9e850c63f29e1b82c45e4967a571aaf0920e522ecf9f5e07ce6293b9fb39699
+  metadata.gz: 1eaece305ff4a9fb83f1cd4f1a138930b28bde2724bd70c8d0d6fae16a67afa0a94e8514034fe9272133530fb7cd5ad349a264316490ddbf026c2e02e28ea879
+  data.tar.gz: 79ca29de3a040028ff01023c07889ce12fcf88b249fbb694082ce87e48737e3083bbfbd59ba1b875027d3e0965891c68215a0888d6e8ccb0e1fd324b58f6bef1

data/README.md

@@ -34,6 +34,32 @@ end
 A "failure" in this context means that the proc either raised an exception or
 timed out.
 
+### Example yielding to a block
+
+As an alternative to initializing the breaker with a block you can
+use a single breaker with different remote calls by invoking call with a block.
+
+```ruby
+class ShapeAPI
+  def initialize
+    @breaker = CircuitBreakage::Breaker.new
+    @breaker.failure_threshold =   3
+    @breaker.duration          =  10
+    @breaker.timeout           = 0.5
+    @service = ShapeService.new
+  end
+
+  def get_square
+    @breaker.call { @service.get_square_widget }
+  end
+
+  def get_circles(count)
+    @breaker.call { @service.get_circles(count) }
+  end
+
+end
+```
+
 ### Slightly More Complex Example in Rails
 
 This example shows one way you might choose to wrap a remote service call in a

data/lib/circuit_breakage/breaker.rb

@@ -15,7 +15,7 @@ module CircuitBreakage
     DEFAULT_DURATION          = 300   # Number of seconds the circuit stays tripped
     DEFAULT_TIMEOUT           = 10    # Number of seconds before the call times out
 
-    def initialize(block)
+    def initialize(block=nil)
       self.block              = block
       self.failure_threshold  = DEFAULT_FAILURE_THRESHOLD
       self.duration           = DEFAULT_DURATION
@@ -25,30 +25,32 @@ module CircuitBreakage
       self.state              ||= 'closed'
     end
 
-    def call(*args)
+    # Yield the block within the circuit.  If no block
+    # is passed use the block passed in at initialization
+    def call(*args, &block_arg)
       case(state)
       when 'open'
         if time_to_retry?
-          do_retry(*args)
+          do_retry(*args, &block_arg)
         else
           raise CircuitOpen
         end
       when 'closed'
-        do_call(*args)
+        do_call(*args, &block_arg)
       end
     end
 
     private
 
     # Defined independently so that it can be overridden.
-    def do_retry(*args)
-      do_call(*args)
+    def do_retry(*args, &block_arg)
+      do_call(*args, &block_arg)
     end
 
-    def do_call(*args)
+    def do_call(*args, &block_arg)
       ret_value = nil
       Timeout.timeout(self.timeout) do
-        ret_value = @block.call(*args)
+        ret_value = (block_arg || @block).call(*args)
       end
       handle_success
 

data/lib/circuit_breakage/version.rb

@@ -1,3 +1,3 @@
 module CircuitBreakage
-  VERSION = "0.2.3"
+  VERSION = "1.0.0"
 end

data/spec/breaker_spec.rb

@@ -9,6 +9,11 @@ module CircuitBreakage
       expect(breaker).to be_a(Breaker)
     end
 
+    it 'initializes without a block' do
+      breaker = Breaker.new
+      expect(breaker).to be_a(Breaker)
+    end
+
     describe '#call' do
       subject { -> { breaker.call(arg) rescue nil} }
       let(:arg) { 'This is an argument.' }
@@ -21,6 +26,21 @@ module CircuitBreakage
           expect(breaker.call(arg)).to eq arg
         end
 
+        it 'yields the block' do
+          value = breaker.call(arg) do | param |
+            param
+          end
+          expect(value).to eq arg
+        end
+
+        it 'yields the block with dynamic binding variables' do
+          param = 'Felix'
+          value = breaker.call do
+            param.size
+          end
+          expect(value).to eq 'Felix'.size
+        end
+
         context 'and the call succeeds' do
           it 'resets the failure count' do
             breaker.failure_count = 3

data/spec/redis_backed_breaker_spec.rb

@@ -20,6 +20,21 @@ module CircuitBreakage
           expect(breaker.call(arg)).to eq arg
         end
 
+        it 'yields the block' do
+          value = breaker.call(arg) do | param |
+            param
+          end
+          expect(value).to eq arg
+        end
+
+        it 'yields the block with dynamic binding variables' do
+          param = 'Felix'
+          value = breaker.call do
+            param.size
+          end
+          expect(value).to eq 'Felix'.size
+        end
+
         context 'and the call succeeds' do
           it 'resets the failure count' do
             breaker.failure_count = 3

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: circuit_breakage
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 1.0.0
 platform: ruby
 authors:
 - John Hyland