simple_circuit_breaker 0.1.0 → 0.2.0

data/README.md

@@ -4,6 +4,11 @@
 
 Simple Ruby implementation of the [Circuit Breaker design pattern][0].
 
+This implementation aims to be as simple as possible. It does not have external
+dependencies and only handles the core circuit breaker functionality. Wrapping
+backend calls in timeouts and other exception handling is left to the user of
+the library.
+
 ## Usage
 
 ```ruby
@@ -11,13 +16,26 @@ failure_threshold = 3 # Trip the circuit after 3 consecutive failures.
 retry_timeout = 10    # Retry on an open circuit after 10 seconds.
 circuit_breaker = SimpleCircuitBreaker.new(failure_threshold, retry_timeout)
 
+# By default, all exceptions will trip the circuit.
 circuit_breaker.handle do
-  FakeClient.new.request
+  FooClient.new.request
+end
+
+# Setting explicit exceptions that trip the circuit:
+circuit_breaker.handle FooError, BarError do
+  FooClient.new.request
 end
 ```
 
-`SimpleCircuitBreaker#handle` raises a `SimpleCircuitBreaker::Error` when the
-circuit is open.
+`SimpleCircuitBreaker#handle` raises a `SimpleCircuitBreaker::CircuitOpenError`
+when the circuit is open. Otherwise, it re-raises any exceptions that occur in
+the block.
+
+## Installation
+
+```bash
+gem install simple_circuit_breaker
+```
 
 ## Testing
 
@@ -33,9 +51,16 @@ rake
 
 Julius Volz (julius@soundcloud.com), Tobias Schmidt (ts@soundcloud.com).
 
+## Alternatives
+
+  * [Circuit Breaker][2]: heavily customizable circuit handler
+  * [CircuitB][3]: supports keeping global circuit state in memcached
+
 ## Contributing
 
 Pull requests welcome!
 
 [0]: http://en.wikipedia.org/wiki/Circuit_breaker_design_pattern
 [1]: http://travis-ci.org/soundcloud/simple_circuit_breaker
+[2]: https://github.com/wsargent/circuit_breaker
+[3]: https://github.com/alg/circuit_b

data/lib/simple_circuit_breaker.rb

@@ -1,7 +1,7 @@
 class SimpleCircuitBreaker
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 
-  class Error < StandardError
+  class CircuitOpenError < StandardError
   end
 
   attr_reader :failure_threshold, :retry_timeout
@@ -12,21 +12,23 @@ class SimpleCircuitBreaker
     reset!
   end
 
-  def handle(&block)
+  def handle(*exceptions, &block)
     if tripped?
-      raise Error, 'Circuit is open'
+      raise CircuitOpenError, 'Circuit is open'
     else
-      execute(&block)
+      execute(exceptions, &block)
     end
   end
 
 protected
 
-  def execute(&block)
+  def execute(exceptions, &block)
     begin
       yield.tap { success! }
-    rescue Exception
-      fail!
+    rescue Exception => exception
+      if exceptions.empty? || exceptions.include?(exception.class)
+        fail!
+      end
       raise
     end
   end

data/simple_circuit_breaker.gemspec

@@ -0,0 +1,18 @@
+require './lib/simple_circuit_breaker'
+
+Gem::Specification.new do |s|
+  s.name         = 'simple_circuit_breaker'
+  s.version      = SimpleCircuitBreaker::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.summary      = 'Ruby Circuit Breaker implementation'
+  s.description  = 'Simple Ruby implementation of the Circuit Breaker design pattern'
+  s.authors      = ['Julius Volz', 'Tobias Schmidt']
+  s.email        = 'julius@soundcloud.com ts@soundcloud.com'
+  s.homepage     = 'http://github.com/soundcloud/simple_circuit_breaker'
+
+  s.files        = `git ls-files`.split("\n")
+  s.test_files   = `git ls-files -- test/*`.split("\n")
+  s.require_path = 'lib'
+
+  s.required_ruby_version = '>= 1.9'
+end

data/test/simple_circuit_breaker_test.rb

@@ -32,7 +32,7 @@ describe SimpleCircuitBreaker do
       foo.must_equal 42
     end
 
-    it 'opens after 3 consecutive failures' do
+    it 'opens after 3 consecutive failures with no explicit handled exceptions' do
       3.times do
         begin
           @breaker.handle { raise RuntimeError }
@@ -42,9 +42,36 @@ describe SimpleCircuitBreaker do
 
       Proc.new do
         @breaker.handle do
-          raiseRuntimeError
+          raise RuntimeError
+        end
+      end.must_raise SimpleCircuitBreaker::CircuitOpenError
+    end
+
+    it 'opens after 3 consecutive failures for handled exception' do
+      3.times do
+        begin
+          @breaker.handle(RuntimeError) { raise RuntimeError }
+        rescue RuntimeError
+        end
+      end
+
+      Proc.new do
+        @breaker.handle(RuntimeError) do
+          raise RuntimeError
+        end
+      end.must_raise SimpleCircuitBreaker::CircuitOpenError
+    end
+
+    it 'doesn\'t open after 3 consecutive failures for non-handled exception' do
+      class FooError < Exception
+      end
+
+      4.times do
+        begin
+          @breaker.handle(FooError) { raise RuntimeError }
+        rescue RuntimeError
         end
-      end.must_raise SimpleCircuitBreaker::Error
+      end
     end
   end
 
@@ -55,7 +82,7 @@ describe SimpleCircuitBreaker do
         @breaker.handle { raise RuntimeError } rescue nil
       end
 
-      lambda { @breaker.handle {} }.must_raise SimpleCircuitBreaker::Error
+      lambda { @breaker.handle {} }.must_raise SimpleCircuitBreaker::CircuitOpenError
     end
 
     it 'closes after timeout and subsequent success' do
@@ -73,7 +100,7 @@ describe SimpleCircuitBreaker do
         end
       end.must_raise RuntimeError
 
-      lambda { @breaker.handle {} }.must_raise SimpleCircuitBreaker::Error
+      lambda { @breaker.handle {} }.must_raise SimpleCircuitBreaker::CircuitOpenError
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_circuit_breaker
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-06 00:00:00.000000000 Z
+date: 2012-11-07 00:00:00.000000000 Z
 dependencies: []
 description: Simple Ruby implementation of the Circuit Breaker design pattern
 email: julius@soundcloud.com ts@soundcloud.com
@@ -23,6 +23,7 @@ files:
 - README.md
 - Rakefile
 - lib/simple_circuit_breaker.rb
+- simple_circuit_breaker.gemspec
 - test/simple_circuit_breaker_test.rb
 homepage: http://github.com/soundcloud/simple_circuit_breaker
 licenses: []