simple_circuit_breaker 0.1.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/LICENSE

@@ -0,0 +1,19 @@
+The MIT License (MIT) Copyright (c) 2012 SoundCloud, Julius Volz, Tobias Schmidt
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,41 @@
+# SimpleCircuitBreaker
+
+## Overview
+
+Simple Ruby implementation of the [Circuit Breaker design pattern][0].
+
+## Usage
+
+```ruby
+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)
+
+circuit_breaker.handle do
+  FakeClient.new.request
+end
+```
+
+`SimpleCircuitBreaker#handle` raises a `SimpleCircuitBreaker::Error` when the
+circuit is open.
+
+## Testing
+
+[![Build Status](https://secure.travis-ci.org/soundcloud/simple_circuit_breaker.png)][1]
+
+Run the tests with
+
+```bash
+rake
+```
+
+## Authors
+
+Julius Volz (julius@soundcloud.com), Tobias Schmidt (ts@soundcloud.com).
+
+## Contributing
+
+Pull requests welcome!
+
+[0]: http://en.wikipedia.org/wiki/Circuit_breaker_design_pattern
+[1]: http://travis-ci.org/soundcloud/simple_circuit_breaker

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/*_test.rb'
+end

data/lib/simple_circuit_breaker.rb

@@ -0,0 +1,70 @@
+class SimpleCircuitBreaker
+  VERSION = '0.1.0'
+
+  class Error < StandardError
+  end
+
+  attr_reader :failure_threshold, :retry_timeout
+
+  def initialize(failure_threshold=3, retry_timeout=10)
+    @failure_threshold = failure_threshold
+    @retry_timeout = retry_timeout
+    reset!
+  end
+
+  def handle(&block)
+    if tripped?
+      raise Error, 'Circuit is open'
+    else
+      execute(&block)
+    end
+  end
+
+protected
+
+  def execute(&block)
+    begin
+      yield.tap { success! }
+    rescue Exception
+      fail!
+      raise
+    end
+  end
+
+  def success!
+    if @state == :half_open
+      reset!
+    end
+  end
+
+  def fail!
+    @failures += 1
+    if @failures >= @failure_threshold
+      @state = :open
+      @open_time = Time.now
+    end
+  end
+
+  def reset!
+    @state = :closed
+    @failures = 0
+  end
+
+  def tripped?
+    @state != :closed && !try_to_close
+  end
+
+  def try_to_close
+    if timeout_exceeded?
+      @state = :half_open
+      true
+    else
+      false
+    end
+  end
+
+  def timeout_exceeded?
+    @open_time + @retry_timeout < Time.now
+  end
+
+end

data/test/simple_circuit_breaker_test.rb

@@ -0,0 +1,79 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require_relative '../lib/simple_circuit_breaker'
+
+describe SimpleCircuitBreaker do
+  describe 'constructor' do
+    it 'takes two arguments' do
+      breaker = SimpleCircuitBreaker.new(5, 8)
+
+      breaker.failure_threshold.must_equal 5
+      breaker.retry_timeout.must_equal 8
+    end
+
+    it 'works without explicit arguments' do
+      breaker = SimpleCircuitBreaker.new
+
+      breaker.failure_threshold.must_equal 3
+      breaker.retry_timeout.must_equal 10
+    end
+  end
+
+  describe 'closed circuit' do
+    before do
+      @breaker = SimpleCircuitBreaker.new(3, 10)
+    end
+
+    it 'is initially closed' do
+      foo = @breaker.handle do
+        42
+      end
+
+      foo.must_equal 42
+    end
+
+    it 'opens after 3 consecutive failures' do
+      3.times do
+        begin
+          @breaker.handle { raise RuntimeError }
+        rescue RuntimeError
+        end
+      end
+
+      Proc.new do
+        @breaker.handle do
+          raiseRuntimeError
+        end
+      end.must_raise SimpleCircuitBreaker::Error
+    end
+  end
+
+  describe 'opened circuit' do
+    before do
+      @breaker = SimpleCircuitBreaker.new(3, 0.1)
+      3.times do
+        @breaker.handle { raise RuntimeError } rescue nil
+      end
+
+      lambda { @breaker.handle {} }.must_raise SimpleCircuitBreaker::Error
+    end
+
+    it 'closes after timeout and subsequent success' do
+      sleep(0.15)
+
+      @breaker.handle { 23 }.must_equal 23
+    end
+
+    it 'stays open after timeout and subsequent error' do
+      sleep(0.15)
+
+      Proc.new do
+        @breaker.handle do
+          raise RuntimeError
+        end
+      end.must_raise RuntimeError
+
+      lambda { @breaker.handle {} }.must_raise SimpleCircuitBreaker::Error
+    end
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: simple_circuit_breaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Julius Volz
+- Tobias Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-06 00:00:00.000000000 Z
+dependencies: []
+description: Simple Ruby implementation of the Circuit Breaker design pattern
+email: julius@soundcloud.com ts@soundcloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .travis.yml
+- LICENSE
+- README.md
+- Rakefile
+- lib/simple_circuit_breaker.rb
+- test/simple_circuit_breaker_test.rb
+homepage: http://github.com/soundcloud/simple_circuit_breaker
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Circuit Breaker implementation
+test_files:
+- test/simple_circuit_breaker_test.rb