circuit_breaker 1.0.1 → 1.1.0

data/History.txt

@@ -1,3 +1,7 @@
+=== 1.1.0 / 2013-04-18
+
+* Feature to ignore specified exceptions (wandenberg)
+
 === 1.0.1 / 2011-01-05
 
 * Gem dependency issue "rubyist-aasm" is now "aasm" (ttdonovan)

data/README.txt

@@ -44,6 +44,7 @@
          handler.failure_threshold = 5
          handler.failure_timeout = 5
          handler.invocation_timeout = 10
+         handler.excluded_exceptions = [NotConsideredFailureException]
        end
 
        # Optional

data/circuit_breaker.gemspec

@@ -5,7 +5,7 @@ require 'circuit_breaker/version'
 Gem::Specification.new do |s|
   s.name        = %q{circuit_breaker}
   s.version     = CircuitBreaker::VERSION
-  s.date        = %q{2011-01-05}
+  s.date        = %q{2013-04-13}
 
   s.authors     = ["Will Sargent"]
   s.email       = ["will.sargent@gmail.com"]

data/lib/circuit_breaker/circuit_handler.rb

@@ -23,6 +23,11 @@ class CircuitBreaker::CircuitHandler
   #
   attr_accessor :invocation_timeout
 
+  #
+  # The exceptions which should be ignored if happens, they are not counted as failures
+  #
+  attr_accessor :excluded_exceptions
+
   #
   # Optional logger.
   #
@@ -31,12 +36,14 @@ class CircuitBreaker::CircuitHandler
   DEFAULT_FAILURE_THRESHOLD  = 5
   DEFAULT_FAILURE_TIMEOUT    = 5
   DEFAULT_INVOCATION_TIMEOUT = 30
+  DEFAULT_EXCLUDED_EXCEPTIONS= []
 
   def initialize(logger = nil)
     @logger = logger
     @failure_threshold = DEFAULT_FAILURE_THRESHOLD
     @failure_timeout = DEFAULT_FAILURE_TIMEOUT
     @invocation_timeout = DEFAULT_INVOCATION_TIMEOUT
+    @excluded_exceptions = DEFAULT_EXCLUDED_EXCEPTIONS
   end
 
   #
@@ -61,8 +68,8 @@ class CircuitBreaker::CircuitHandler
         out = method[*args]
         on_success(circuit_state)
       end
-    rescue Exception
-      on_failure(circuit_state)
+    rescue Exception => e
+      on_failure(circuit_state) unless @excluded_exceptions.include?(e.class)
       raise
     end
     return out

data/lib/circuit_breaker/version.rb

@@ -1,3 +1,3 @@
 module CircuitBreaker
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/circuit_breaker_spec.rb

@@ -3,6 +3,9 @@ require 'logger'
 
 describe CircuitBreaker do
 
+  class SpecificException < Exception; end
+  class NotFoundException < Exception; end
+
   class TestClass
 
    include CircuitBreaker
@@ -36,9 +39,17 @@ describe CircuitBreaker do
       "unresponsive method returned"
     end
 
+    def raise_specific_error_method
+      if @failure == true
+        raise SpecificException.new "SPECIFIC FAIL"
+      end
+
+      raise NotFoundException.new "NOT FOUND FAIL"
+    end
+
     # Register this method with the circuit breaker...
     #
-    circuit_method :call_external_method, :second_method, :unresponsive_method
+    circuit_method :call_external_method, :second_method, :unresponsive_method, :raise_specific_error_method
 
     #
     # Define what needs to be set for configuration...
@@ -48,11 +59,13 @@ describe CircuitBreaker do
       handler.failure_threshold = 5
       handler.failure_timeout = 5
       handler.invocation_timeout = 1
+      handler.excluded_exceptions = [NotFoundException]
     end
 
   end
 
   before(:each) do
+    TestClass.circuit_handler.failure_threshold = 5
     @test_object = TestClass.new()
   end
 
@@ -113,9 +126,26 @@ describe CircuitBreaker do
       @test_object.circuit_state.failure_count.should == 1
     end
 
-    it 'should trip the circuit when the method takes too long to return' do
+    it 'should increment the failure count when the method takes too long to return' do
       lambda { @test_object.unresponsive_method }.should raise_error(CircuitBreaker::CircuitBrokenException)
-      @test_object.circuit_state.open?.should == true
+      @test_object.circuit_state.closed?.should == true
+      @test_object.circuit_state.failure_count.should == 1
+    end
+
+    describe "and some exceptions not indicates a circuit problem" do
+      it 'should not increment the failure count when a failure of a specific type occurs' do
+        @test_object.fail!
+
+        lambda { @test_object.raise_specific_error_method }.should raise_error(SpecificException)
+        @test_object.circuit_state.closed?.should == true
+        @test_object.circuit_state.failure_count.should == 1
+
+        @test_object.succeed!
+
+        lambda { @test_object.raise_specific_error_method }.should raise_error(NotFoundException)
+        @test_object.circuit_state.closed?.should == true
+        @test_object.circuit_state.failure_count.should == 1
+      end
     end
 
   end

metadata

@@ -1,112 +1,87 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: circuit_breaker
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 1.1.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 1
-  version: 1.0.1
 platform: ruby
-authors: 
+authors:
 - Will Sargent
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-05 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-04-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: aasm
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-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: 
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "CircuitBreaker is a relatively simple Ruby mixin that will wrap\n
+  a call to a given service in a circuit breaker pattern.\n\n The circuit starts off
+  \"closed\" meaning that all calls will go through.\n However, consecutive failures
+  are recorded and after a threshold is reached,\n the circuit will \"trip\", setting
+  the circuit into an \"open\" state.\n\n In an \"open\" state, every call to the
+  service will fail by raising\n CircuitBrokenException.\n\n The circuit will remain
+  in an \"open\" state until the failure timeout has\n elapsed.\n\n After the failure_timeout
+  has elapsed, the circuit will go into\n a \"half open\" state and the call will
+  go through.  A failure will\n immediately pop the circuit open again, and a success
+  will close the\n circuit and reset the failure count.\n\n     require 'circuit_breaker'\n
+  \    class TestService\n\n       include CircuitBreaker\n\n       def call_remote_service()
+  ...\n\n       circuit_method :call_remote_service\n\n       # Optional\n       circuit_handler
+  do |handler|\n         handler.logger = Logger.new(STDOUT)\n         handler.failure_threshold
+  = 5\n         handler.failure_timeout = 5\n       end\n\n       # Optional\n       circuit_handler_class
+  MyCustomCircuitHandler\n     end"
+email:
 - will.sargent@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - History.txt
 - README.txt
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -123,39 +98,32 @@ files:
 - spec/spec_helper.rb
 homepage: http://github.com/wsargent/circuit_breaker
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.txt
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: will_sargent
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 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: 
+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/circuit_breaker_spec.rb
 - spec/spec_helper.rb