circuit_breakage 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b436b7a83a4e4470cf5bf209e276afa440eea28d
-  data.tar.gz: bbf480897ba2a7db87096a939b505617bdaccb17
+  metadata.gz: 5aeb1835130f99946eddad6d46d8f01dd44a0fed
+  data.tar.gz: bdd92ef38ba1a708da8ac1cab7e9bb34c1b4fe8d
 SHA512:
-  metadata.gz: dacf62b792eadf2d5c9589eb221a028f5e597a071362374357e200c5c0a41b33313243e99851fd9daa8d654aab52228d754350354d04e68afaaddf821e84de48
-  data.tar.gz: 77455e880e39b757d046a11fb1e6cfe1394a88a947601a5b8adbbf8c55883b3dd5000b236485cdc5e696b7d971e507cff1a81b04e7935f7551e4b9f7e46121f6
+  metadata.gz: 73d6b93182c3bd07d75196ac21c3fb7a7ca47259183c57a512ae131821eddfb035abc65509cd3d62a9cb3deae30f148aa3d352d9a12c4362e9297ddf397bcc18
+  data.tar.gz: f7f86f802260ab60af42d2db4031ac62110ff8081bcc681e74be062a4a376af5e00a721e33df9cd50f3dd14d33472710d70cf7fe7bdaf864de72cc41a444892a

data/README.md

@@ -1,7 +1,7 @@
 # CircuitBreakage
 
-A simple Circuit Breaker implementation in Ruby with a timeout.  A Circuit
-Breaker wraps a potentially troublesome block of code and will "trip" the
+A simple circuit breaker implementation in Ruby with a timeout.  A circuit
+breaker wraps a potentially troublesome block of code and will "trip" the
 circuit (ie, stop trying to run the code) if it sees too many failures.  After
 a configurable amount of time, the circuit breaker will retry.
 
@@ -24,9 +24,9 @@ breaker.timeout = 0.5         # 500 milliseconds allowed before auto-fail
 
 begin
   breaker.call(*some_args)    # args are passed through to block
-rescue CircuitBreaker::CircuitOpen
+rescue CircuitBreakage::CircuitOpen
   puts "Too many recent failures!"
-rescue CircuitBreaker::CircuitTimeout
+rescue CircuitBreakage::CircuitTimeout
   puts "Operation timed out!"
 end
 ```
@@ -34,7 +34,7 @@ end
 A "failure" in this context means that the block either raised an exception or
 timed out.
 
-### Redis-backed "Shared" Circuit Breakers
+### Redis-Backed "Shared" Circuit Breakers
 
 The unique feature of this particular Circuit Breaker gem is that it also
 supports shared state via Redis, using the SETNX and GETSET commands.  This

data/lib/circuit_breakage.rb

@@ -1,3 +1,3 @@
-require "circuit_breakage/version"
-require "circuit_breakage/breaker"
-require "circuit_breakage/redis_backed_breaker"
+require_relative "circuit_breakage/version"
+require_relative "circuit_breakage/breaker"
+require_relative "circuit_breakage/redis_backed_breaker"

data/lib/circuit_breakage/breaker.rb

@@ -9,7 +9,7 @@ module CircuitBreakage
   #
   class Breaker
     attr_accessor :failure_count, :last_failed, :state, :block
-    attr_accessor :failure_threshold, :duration, :timeout
+    attr_accessor :failure_threshold, :duration, :timeout, :last_exception
 
     DEFAULT_FAILURE_THRESHOLD = 5     # Number of failures required to trip circuit
     DEFAULT_DURATION          = 300   # Number of seconds the circuit stays tripped
@@ -54,7 +54,7 @@ module CircuitBreakage
 
       return ret_value
     rescue Exception => e
-      handle_failure
+      handle_failure(e)
     end
 
     def time_to_retry?
@@ -66,12 +66,15 @@ module CircuitBreakage
       self.state = 'closed'
     end
 
-    def handle_failure
+    def handle_failure(error)
       self.last_failed = Time.now
       self.failure_count += 1
       if self.failure_count >= self.failure_threshold
         self.state = 'open'
       end
+
+      self.last_exception = error
+      raise(error)
     end
   end
 end

data/lib/circuit_breakage/version.rb

@@ -1,3 +1,3 @@
 module CircuitBreakage
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/breaker_spec.rb

@@ -10,7 +10,7 @@ module CircuitBreakage
     end
 
     describe '#call' do
-      subject { -> { breaker.call(arg) } }
+      subject { -> { breaker.call(arg) rescue nil} }
       let(:arg) { 'This is an argument.' }
 
       context 'when the circuit is closed' do
@@ -29,10 +29,15 @@ module CircuitBreakage
         end
 
         context 'and the call fails' do
-          let(:block) { -> { raise 'some error' } }
+          let(:block) { ->(_) { raise 'some error' } }
 
           it { is_expected.to change { breaker.failure_count }.by(1) }
           it { is_expected.to change { breaker.last_failed } }
+          it { is_expected.to change { breaker.last_exception }.from(nil) }
+
+          it 'raises the exception that caused the failure' do
+            expect { breaker.call(arg) }.to raise_exception('some error')
+          end
 
           context 'and the failure count exceeds the failure threshold' do
             before { breaker.failure_count = breaker.failure_threshold }
@@ -46,7 +51,11 @@ module CircuitBreakage
           before { breaker.timeout = 0.1 }
 
           it 'counts as a failure' do
-            expect { breaker.call(arg) }.to change { breaker.failure_count }.by(1)
+            expect { breaker.call(arg) rescue nil }.to change { breaker.failure_count }.by(1)
+          end
+
+          it 'raises CircuitBreakage::CircuitTimeout' do
+            expect { breaker.call(arg) }.to raise_exception(CircuitBreakage::CircuitTimeout)
           end
         end
       end
@@ -57,7 +66,9 @@ module CircuitBreakage
         context 'before the retry_time' do
           before { breaker.last_failed = Time.now - breaker.duration + 30 }
 
-          it { is_expected.to raise_error(CircuitOpen) }
+          it 'raises CircuitBreakage::CircuitOpen' do
+            expect { breaker.call(arg) }.to raise_error(CircuitOpen)
+          end
         end
 
         context 'after the retry time' do

data/spec/redis_backed_breaker_spec.rb

@@ -9,7 +9,7 @@ module CircuitBreakage
     let(:block)      { ->(x) { return x } }
 
     describe '#call' do
-      subject { -> { breaker.call(arg) } }
+      subject { -> { breaker.call(arg) rescue nil } }
       let(:arg) { 'This is an argument.' }
 
       context 'when the circuit is closed' do
@@ -28,7 +28,7 @@ module CircuitBreakage
         end
 
         context 'and the call fails' do
-          let(:block) { -> { raise 'some error' } }
+          let(:block) { ->(_) { raise 'some error' } }
 
           it { is_expected.to change { breaker.failure_count }.by(1) }
           it { is_expected.to change { breaker.last_failed } }
@@ -45,7 +45,7 @@ module CircuitBreakage
           before { breaker.timeout = 0.1 }
 
           it 'counts as a failure' do
-            expect { breaker.call(arg) }.to change { breaker.failure_count }.by(1)
+            expect { breaker.call(arg) rescue nil }.to change { breaker.failure_count }.by(1)
           end
         end
       end
@@ -56,7 +56,9 @@ module CircuitBreakage
         context 'before the retry_time' do
           before { breaker.last_failed = Time.now - breaker.duration + 30 }
 
-          it { is_expected.to raise_error(CircuitOpen) }
+          it 'raises CircuitBreakage::CircuitOpen' do
+            expect { breaker.call(arg) }.to raise_error(CircuitOpen)
+          end
         end
 
         context 'after the retry time' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_breakage
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - John Hyland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2015-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler