wsargent-circuit_breaker 1.0.0

data/History.txt

@@ -0,0 +1,3 @@
+=== 1.0.0 / 2009-07-13
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+circuit_breaker.gemspec
+lib/circuit_breaker.rb
+lib/circuit_breaker/circuit_state.rb
+lib/circuit_breaker/circuit_handler.rb
+lib/circuit_breaker/circuit_broken_exception.rb
+spec/unit_spec_helper.rb
+spec/unit/circuit_breaker_spec.rb

data/README.txt

@@ -0,0 +1,234 @@
+= circuit_breaker
+
+* http://github.com/wsargent/circuit_breaker
+* http://rdoc.info/projects/wsargent/circuit_breaker
+* Will Sargent <will.sargent@gmail.com>
+* Copyright 2009 Will Sargent
+
+== DESCRIPTION:
+
+ CircuitBreaker is a relatively simple Ruby mixin that will wrap
+ a call to a given service in a circuit breaker pattern.
+
+ The circuit starts off "closed" meaning that all calls will go through.
+ However, consecutive failures are recorded and after a threshold is reached,
+ the circuit will "trip", setting the circuit into an "open" state.
+
+ In an "open" state, every call to the service will fail by raising
+ CircuitBrokenException.
+
+ The circuit will remain in an "open" state until the failure timeout has
+ elapsed.
+
+ After the failure_timeout has elapsed, the circuit will go into
+ a "half open" state and the call will go through.  A failure will
+ immediately pop the circuit open again, and a success will close the
+ circuit and reset the failure count.
+
+     require 'circuit_breaker'
+     class TestService
+
+       include CircuitBreaker
+
+       def call_remote_service() ...
+
+       circuit_method :call_remote_service
+    
+       # Optional
+       circuit_handler do |handler|
+         handler.logger = Logger.new(STDOUT)
+         handler.failure_threshold = 5
+         handler.failure_timeout = 5
+       end
+
+       # Optional
+       circuit_handler_class MyCustomCircuitHandler
+     end
+
+== FEATURES/PROBLEMS:
+
+* Can run out of the box with minimal dependencies and a couple of lines of code.
+* Easy to extend: add your own circuit breakers or states or extend the existing ones.
+* Does not currently handle static class methods.
+
+== SYNOPSIS:
+
+  An implementation of Michael Nygard's Circuit Breaker pattern.
+
+== REQUIREMENTS:
+
+  circuit_breaker has a dependency on AASM @ http://github.com/rubyist/aasm/tree/master
+
+== INSTALL:
+
+* gem sources -a http://gems.github.com
+* gem install rubyist-aasm
+* gem install wsargent_circuit-breaker
+
+== LICENSE:
+
+		   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/Rakefile

@@ -0,0 +1,26 @@
+# -*- ruby -*-
+$:.unshift(File.dirname(__FILE__) + "/lib")
+
+require 'rubygems'
+require 'hoe'
+require 'circuit_breaker'
+
+hoe = Hoe.spec 'circuit_breaker' do |p|
+  self.rubyforge_name = 'will_sargent'
+  developer('Will Sargent', 'will.sargent@gmail.com')
+  
+  p.remote_rdoc_dir = '' # Release to root only one project
+
+  p.extra_deps << [ 'rubyist-aasm' ]
+  p.extra_dev_deps << [ 'rspec' ]
+  File.open(File.join(File.dirname(__FILE__), 'VERSION'), 'w') do |file|
+    file.puts CircuitBreaker::VERSION
+  end
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new(hoe.spec)
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/circuit_breaker.gemspec

@@ -0,0 +1,76 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{circuit_breaker}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Will Sargent"]
+  s.date = %q{2009-07-13}
+  s.description = %q{CircuitBreaker is a relatively simple Ruby mixin that will wrap
+ a call to a given service in a circuit breaker pattern.
+
+ The circuit starts off "closed" meaning that all calls will go through.
+ However, consecutive failures are recorded and after a threshold is reached,
+ the circuit will "trip", setting the circuit into an "open" state.
+
+ In an "open" state, every call to the service will fail by raising
+ CircuitBrokenException.
+
+ The circuit will remain in an "open" state until the failure timeout has
+ elapsed.
+
+ After the failure_timeout has elapsed, the circuit will go into
+ a "half open" state and the call will go through.  A failure will
+ immediately pop the circuit open again, and a success will close the
+ circuit and reset the failure count.
+
+ require 'circuit_breaker'
+ class TestService
+
+   include CircuitBreaker
+
+   def call_remote_service() ...
+
+   circuit_method :call_remote_service
+
+   # Optional
+   circuit_handler do |handler|
+     handler.logger = Logger.new(STDOUT)
+     handler.failure_threshold = 5
+     handler.failure_timeout = 5
+   end
+
+   # Optional
+   circuit_handler_class MyCustomCircuitHandler
+ end}
+  s.email = ["will.sargent@gmail.com"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt", "README.txt"]
+  s.files = ["History.txt", "Manifest.txt", "README.txt", "Rakefile", "circuit_breaker.gemspec", "lib/circuit_breaker.rb", "lib/circuit_breaker/circuit_state.rb", "lib/circuit_breaker/circuit_handler.rb", "lib/circuit_breaker/circuit_broken_exception.rb", "spec/unit_spec_helper.rb", "spec/unit/circuit_breaker_spec.rb"]
+  s.homepage = %q{http://github.com/wsargent/circuit_breaker}
+  s.rdoc_options = ["--main", "README.txt", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{will_sargent}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{CircuitBreaker is a relatively simple Ruby mixin that will wrap a call to a given service in a circuit breaker pattern}
+  s.test_files = ["spec/unit/circuit_breaker_spec.rb", "spec/unit_spec_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rubyist-aasm>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.7"])
+      s.add_development_dependency(%q<hoe>, [">= 2.3.1"])
+    else
+      s.add_dependency(%q<rubyist-aasm>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.7"])
+      s.add_dependency(%q<hoe>, [">= 2.3.1"])
+    end
+  else
+    s.add_dependency(%q<rubyist-aasm>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.7"])
+    s.add_dependency(%q<hoe>, [">= 2.3.1"])
+  end
+end

data/lib/circuit_breaker.rb

@@ -0,0 +1,103 @@
+#
+# CircuitBreaker is a relatively simple Ruby mixin that will wrap
+# a call to a given service in a circuit breaker pattern.
+#
+# The circuit starts off "closed" meaning that all calls will go through.
+# However, consecutive failures are recorded and after a threshold is reached,
+# the circuit will "trip", setting the circuit into an "open" state.
+#
+# In an "open" state, every call to the service will fail by raising
+# CircuitBrokenException.
+#
+# The circuit will remain in an "open" state until the failure timeout has
+# elapsed.
+#
+# After the failure_timeout has elapsed, the circuit will go into
+# a "half open" state and the call will go through.  A failure will
+# immediately pop the circuit open again, and a success will close the
+# circuit and reset the failure count.
+#
+# require 'circuit_breaker'
+# class TestService
+#
+#   include CircuitBreaker
+#
+#   def call_remote_service() ...
+#
+#   circuit_method :call_remote_service
+#
+#   # Optional
+#   circuit_handler do |handler|
+#     handler.logger = Logger.new(STDOUT)
+#     handler.failure_threshold = 5
+#     handler.failure_timeout = 5
+#   end
+#
+#   # Optional
+#   circuit_handler_class MyCustomCircuitHandler
+#
+# end
+#
+# Copyright 2009 Will Sargent
+# Author: Will Sargent <will.sargent@gmail.com>
+# Many thanks to Devin Mullins
+#
+module CircuitBreaker
+  VERSION = '1.0.0'
+  
+  #
+  # Extends the included class with CircuitBreaker
+  #
+  def self.included(klass)
+    klass.extend ::CircuitBreaker::ClassMethods
+  end
+
+  #
+  # Returns the current circuit state.  This is defined on the instance, so
+  # you can have several instances of the same class with different states.
+  #
+  def circuit_state
+    @circuit_state ||= self.class.circuit_handler.new_circuit_state
+  end
+
+  module ClassMethods
+
+    #
+    # Takes a splat of method names, and wraps them with the circuit_handler.
+    #
+    def circuit_method(*methods)
+      circuit_handler = self.circuit_handler
+
+      methods.each do |meth|
+        m = instance_method meth
+        define_method meth do |*args|
+          circuit_handler.handle self.circuit_state, m.bind(self), *args
+        end
+      end
+    end
+
+    #
+    # Returns circuit_handler.  Yields the instance back when passed a block.
+    #
+    def circuit_handler(&block)
+      @circuit_handler ||= circuit_handler_class.new
+
+      yield @circuit_handler if block_given?
+
+      return @circuit_handler
+    end
+
+    #
+    # Allows you to define a custom circuit_handler instead of CircuitBreaker::CircuitHandler
+    #
+    def circuit_handler_class(klass = nil)
+      @circuit_handler_class ||= (klass || CircuitBreaker::CircuitHandler)
+    end
+
+  end
+
+end
+
+require 'circuit_breaker/circuit_handler'
+require 'circuit_breaker/circuit_broken_exception'
+require 'circuit_breaker/circuit_state'

data/lib/circuit_breaker/circuit_broken_exception.rb

@@ -0,0 +1,10 @@
+class CircuitBreaker::CircuitBrokenException < StandardError
+
+  def initialize(msg, circuit_state)
+    @circuit_state = circuit_state
+    super(msg)
+  end
+
+  attr_reader :circuit_state
+
+end

data/lib/circuit_breaker/circuit_handler.rb

@@ -0,0 +1,135 @@
+#
+#
+# CircuitHandler is stateless,
+# so the circuit_state gets mixed in with the calling object.
+#
+#
+class CircuitBreaker::CircuitHandler
+
+  #
+  # The number of failures needed to trip the breaker.
+  #
+  attr_accessor :failure_threshold
+
+  #
+  # The period of time in seconds before attempting to reset the breaker.
+  #
+  attr_accessor :failure_timeout
+
+  #
+  # Optional logger.
+  #
+  attr_accessor :logger
+
+  DEFAULT_FAILURE_THRESHOLD = 5
+  DEFAULT_FAILURE_TIMEOUT = 5
+
+  def initialize(logger = nil)
+    @logger = logger
+    @failure_threshold = DEFAULT_FAILURE_THRESHOLD
+    @failure_timeout = DEFAULT_FAILURE_TIMEOUT
+  end
+
+  #
+  # Returns a new CircuitState instance.
+  #
+  def new_circuit_state
+    ::CircuitBreaker::CircuitState.new
+  end
+  
+  #
+  # Handles the method covered by the circuit breaker.
+  #
+  def handle(circuit_state, method, *args)
+    if is_tripped(circuit_state)
+      @logger.debug("handle: breaker is tripped, refusing to execute: #{circuit_state.inspect}") if @logger
+      on_circuit_open(circuit_state)
+    end
+
+    begin
+      out = method[*args]
+      on_success(circuit_state)
+    rescue Exception
+      on_failure(circuit_state)
+      raise
+    end
+    return out
+  end
+
+  #
+  # Returns true when the number of failures is sufficient to trip the breaker, false otherwise.
+  #
+  def is_failure_threshold_reached(circuit_state)
+    out = (circuit_state.failure_count > failure_threshold)
+    @logger.debug("is_failure_threshold_reached: #{circuit_state.failure_count} > #{failure_threshold} == #{out}") if @logger
+
+    return out
+  end
+
+  #
+  # Returns true if enough time has elapsed since the last failure time, false otherwise.
+  #
+  def is_timeout_exceeded(circuit_state)
+    now = Time.now
+
+    time_since = now - circuit_state.last_failure_time
+    @logger.debug("timeout_exceeded: time since last failure = #{time_since.inspect}") if @logger
+    return time_since >= failure_timeout
+  end
+
+  #
+  # Returns true if the circuit breaker is still open and the timeout has
+  # not been exceeded, false otherwise.
+  #
+  def is_tripped(circuit_state)
+
+    if circuit_state.open? && is_timeout_exceeded(circuit_state)
+      @logger.debug("is_tripped: attempting reset into half open state for #{circuit_state.inspect}") if @logger
+      circuit_state.attempt_reset
+    end
+
+    return circuit_state.open?
+  end
+
+  #
+  # Called when an individual success happens. 
+  #
+  def on_success(circuit_state)
+    @logger.debug("on_success: #{circuit_state.inspect}") if @logger
+
+    if circuit_state.closed?
+      @logger.debug("on_success: reset_failure_count #{circuit_state.inspect}") if @logger
+      circuit_state.reset_failure_count
+    end
+
+    if circuit_state.half_open?
+      @logger.debug("on_success: reset circuit #{circuit_state.inspect}") if @logger
+      circuit_state.reset
+    end
+  end
+
+  #
+  # Called when an individual failure happens.
+  #
+  def on_failure(circuit_state)
+    @logger.debug("on_failure: circuit_state = #{circuit_state.inspect}") if @logger
+    
+    circuit_state.increment_failure_count
+
+    if is_failure_threshold_reached(circuit_state) || circuit_state.half_open?
+      # Set us into a closed state.
+      @logger.debug("on_failure: tripping circuit breaker #{circuit_state.inspect}") if @logger
+      circuit_state.trip
+    end
+  end
+
+  #
+  # Called when a call is made and the circuit is open.   Raises a CircuitBrokenException exception. 
+  #
+  def on_circuit_open(circuit_state)
+    @logger.debug("on_circuit_open: raising for #{circuit_state.inspect}") if @logger
+        
+    raise CircuitBreaker::CircuitBrokenException.new("Circuit broken, please wait for timeout", circuit_state)
+  end
+   
+end

data/lib/circuit_breaker/circuit_state.rb

@@ -0,0 +1,60 @@
+require 'aasm'
+
+#
+# CircuitState is created individually for each object, and keeps
+# track of how the object is doing and whether the object's circuit
+# has tripped or not.
+#
+class CircuitBreaker::CircuitState
+
+  include AASM
+
+  aasm_state :half_open
+
+  aasm_state :open
+
+  aasm_state :closed, :enter => :reset_failure_count
+
+  aasm_initial_state :closed
+
+  #
+  # Trips the circuit breaker into the open state where it will immediately fail.
+  #
+  aasm_event :trip do
+    transitions :to => :open, :from => [:closed, :half_open]
+  end
+
+  #
+  # Transitions from an open state to a half_open state.
+  #
+  aasm_event :attempt_reset do
+    transitions :to => :half_open, :from => [:open]
+  end
+
+  #
+  # Close the circuit from an open or half open state.
+  #
+  aasm_event :reset do
+    transitions :to => :closed, :from => [:open, :half_open]
+  end
+
+  def initialize()
+    @failure_count = 0
+    @last_failure_time = nil
+  end
+
+  attr_accessor :last_failure_time
+
+  attr_accessor :failure_count
+
+  def increment_failure_count
+    @failure_count = @failure_count + 1
+    @last_failure_time = Time.now
+  end
+
+  def reset_failure_count
+    @failure_count = 0
+  end
+  
+end
+

data/spec/unit/circuit_breaker_spec.rb

@@ -0,0 +1,150 @@
+require File.dirname(__FILE__) + '/../unit_spec_helper'
+
+describe CircuitBreaker do
+
+  class TestClass
+
+   include CircuitBreaker
+
+   def initialize()
+      @failure = false
+    end
+
+    def fail!
+      @failure = true
+    end
+
+    def succeed!
+      @failure = false
+    end
+
+    def call_external_method()
+      if @failure == true
+        raise "FAIL"
+      end
+
+      "hello world!"
+    end
+
+    # Register this method with the circuit breaker...
+    #
+    circuit_method :call_external_method
+
+    #
+    # Define what needs to be set for configuration...
+    #
+    circuit_handler do |handler|
+      handler.logger = Logger.new(STDOUT)
+      handler.failure_threshold = 5
+      handler.failure_timeout = 5      
+    end
+
+  end
+
+  before(:each) do
+    @test_object = TestClass.new()
+  end
+
+  describe "when closed" do
+
+    it "should execute without failing" do
+      @test_object.call_external_method().should == 'hello world!'
+      @test_object.circuit_state.closed? == true
+      @test_object.circuit_state.failure_count == 0
+    end
+
+    it 'should increment the failure count when a failure occurs' do
+      @test_object.fail!
+
+      lambda { @test_object.call_external_method() }.should raise_error
+      @test_object.circuit_state.closed? == true
+      @test_object.circuit_state.failure_count == 1
+    end
+    
+    it 'should trip the circuit when too many failures occur' do
+      @test_object.fail!
+
+      lambda { @test_object.call_external_method() }.should raise_error
+      lambda { @test_object.call_external_method() }.should raise_error
+      lambda { @test_object.call_external_method() }.should raise_error
+      lambda { @test_object.call_external_method() }.should raise_error
+      lambda { @test_object.call_external_method() }.should raise_error
+      lambda { @test_object.call_external_method() }.should raise_error
+
+      @test_object.circuit_state.open?.should == true
+      @test_object.circuit_state.failure_count.should == 6
+    end
+
+    it 'should reset the failure count if closed after a successful call.' do
+      @test_object.fail!
+
+      lambda { @test_object.call_external_method() }.should raise_error("FAIL")
+
+      @test_object.succeed!
+      @test_object.call_external_method()
+
+      @test_object.circuit_state.failure_count.should == 0
+      @test_object.circuit_state.closed?.should == true
+
+    end
+
+  end
+
+  describe "when open" do
+
+    it 'should fail immediately if the circuit is open' do
+      now = Time.now
+      @test_object.circuit_state.trip!
+      @test_object.circuit_state.last_failure_time = now
+      @test_object.circuit_state.failure_count = 5
+
+      # Should return CircuitBrokenException explicitly
+      lambda { @test_object.call_external_method() }.should raise_error(::CircuitBreaker::CircuitBrokenException)
+
+      # Failure count should not be open
+      @test_object.circuit_state.failure_count.should == 5
+      @test_object.circuit_state.open?.should == true
+    end
+
+  end
+
+  describe "when half open" do
+
+    it 'should reset the circuit when enough time has passed' do
+      now = Time.now
+
+      @test_object.circuit_state.trip
+      @test_object.circuit_state.attempt_reset
+      @test_object.circuit_state.last_failure_time = now - 5
+      @test_object.circuit_state.failure_count = 5
+
+      @test_object.call_external_method()
+
+      # After a successful call, the failure count is reset.
+      @test_object.circuit_state.failure_count.should == 0
+      @test_object.circuit_state.closed?.should == true
+    end
+
+    it 'should trip the circuit immediately if in a half open state' do
+      now = Time.now
+
+      @test_object.circuit_state.trip
+
+      # Set to half open...
+      @test_object.circuit_state.attempt_reset
+      @test_object.circuit_state.last_failure_time = now - 5
+      @test_object.circuit_state.failure_count = 5
+
+      # Have an unsuccessful call...
+      @test_object.fail!
+      lambda { @test_object.call_external_method() }.should raise_error("FAIL")
+
+      @test_object.circuit_state.failure_count.should == 6
+
+      # The circuit should immediately pop open again.
+      @test_object.circuit_state.open?.should == true
+    end
+
+  end
+
+end

data/spec/unit_spec_helper.rb

@@ -0,0 +1,5 @@
+$:.unshift File.join(File.dirname(__FILE__),'..','lib')
+
+require 'spec'
+require 'circuit_breaker'
+

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: wsargent-circuit_breaker
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Will Sargent
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rubyist-aasm
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.7
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.1
+    version: 
+description: "CircuitBreaker is a relatively simple Ruby mixin that will wrap a call to a given service in a circuit breaker pattern.  The circuit starts off \"closed\" meaning that all calls will go through. However, consecutive failures are recorded and after a threshold is reached, the circuit will \"trip\", setting the circuit into an \"open\" state.  In an \"open\" state, every call to the service will fail by raising CircuitBrokenException.  The circuit will remain in an \"open\" state until the failure timeout has elapsed.  After the failure_timeout has elapsed, the circuit will go into a \"half open\" state and the call will go through.  A failure will immediately pop the circuit open again, and a success will close the circuit and reset the failure count.  require 'circuit_breaker' class TestService  include CircuitBreaker  def call_remote_service() ...  circuit_method :call_remote_service  # Optional circuit_handler do |handler| handler.logger = Logger.new(STDOUT) handler.failure_threshold = 5 handler.failure_timeout = 5 end  # Optional circuit_handler_class MyCustomCircuitHandler end"
+email: 
+- will.sargent@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- circuit_breaker.gemspec
+- lib/circuit_breaker.rb
+- lib/circuit_breaker/circuit_state.rb
+- lib/circuit_breaker/circuit_handler.rb
+- lib/circuit_breaker/circuit_broken_exception.rb
+- spec/unit_spec_helper.rb
+- spec/unit/circuit_breaker_spec.rb
+has_rdoc: false
+homepage: http://github.com/wsargent/circuit_breaker
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: will_sargent
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: CircuitBreaker is a relatively simple Ruby mixin that will wrap a call to a given service in a circuit breaker pattern
+test_files: 
+- spec/unit/circuit_breaker_spec.rb
+- spec/unit_spec_helper.rb