circuitbox 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a837fae089566b81f6ccd58a7b89b4c119f122d4
-  data.tar.gz: e78c6f2bf1437d2e5cd4495d106b8c822dbbd896
+  metadata.gz: 87808cd77975fc82ac067b5c0c82f72f993f6b77
+  data.tar.gz: 74889c759914d18561ec967cd77edde519bd6d5d
 SHA512:
-  metadata.gz: bcd00fa6cb16dbb3a7ea62d912049a1b6c1d676b4c484f1e42e8ae65b060b215e673e3ec0ccb0ff2f15cce6ceff60c0b62e0ab1bc752a4b9d65674a74edf6afe
-  data.tar.gz: f066a4d85503ed0db075a0df074f9eacd5dd9740cc2a5af5fbb289c07b48a287cea07a64c75eb3ced6b37f06a410608f657a24ce9688cf49c0fae31171b9bb9f
+  metadata.gz: 427a52c594b433cc8a506ebe995d56c64b7f1174766c74ce43f476cbf4f848656c2e9c9f6867a8cc31fcadecd92c64a7fcff4db865e7e4cca2c0605e18f6fc0b
+  data.tar.gz: 6236374797da10131120158b8c2c65f2cff3b4654f3b3ca24a0c85a27f02a6ccb20025babab8c412f6ea82d8457027d600544b9cd857c16fdea2a4636cfb38f8

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.idea

data/README.md

@@ -32,6 +32,17 @@ class ExampleServiceClient
 end
 ```
 
+Using the `run!` method will throw an exception when the circuit is open or the underlying service fails.
+
+```ruby
+  def http_get
+    circuit.run! do
+      Zephyr.new("http://example.com").get(200, 1000, "/api/messages")
+    end
+  end
+```
+
+
 ## Configuration
 
 ```ruby
@@ -188,7 +199,7 @@ c.use Circuitbox::FaradayMiddleware, circuit_breaker_options: {}
 ## TODO
 * ~~Fix Faraday integration to return a Faraday response object~~
 * Split stats into it's own repository
-* Circuit Breaker should raise an exception by default instead of returning nil
+* ~~Circuit Breaker should raise an exception by default instead of returning nil~~
 * Refactor to use single state variable
 * Fix the partition hack
 * Integrate with Breakerbox/Hystrix

data/lib/circuitbox.rb

@@ -3,12 +3,16 @@ require 'active_support'
 require 'logger'
 require 'timeout'
 
-require "circuitbox/version"
+require 'circuitbox/version'
 require 'circuitbox/memcache_store'
 require 'circuitbox/railtie' if defined?(Rails)  
 require 'circuitbox/circuit_breaker'
 require 'circuitbox/notifier'
 
+require 'circuitbox/errors/error'
+require 'circuitbox/errors/open_circuit_error'
+require 'circuitbox/errors/service_failure_error'
+
 class Circuitbox
   attr_accessor :circuits, :circuit_store, :stat_store
   cattr_accessor :configure
@@ -67,4 +71,4 @@ class Circuitbox
     uri = URI(param.to_s)
     uri.host.present? ? uri.host : param.to_s
   end
-end
+end

data/lib/circuitbox/circuit_breaker.rb

@@ -41,14 +41,14 @@ class Circuitbox
       value.is_a?(Proc) ? value.call : value
     end
 
-    def run(run_options = {}, &block)
+    def run!(run_options = {})
       @partition = run_options.delete(:partition) # sorry for this hack.
       cache_key  = run_options.delete(:storage_key)
 
       if open?
         logger.debug "[CIRCUIT] open: skipping #{service}"
-        response = nil
         open! unless open_flag?
+        raise Circuitbox::OpenCircuitError.new(service)
       else
         close! if was_open?
         logger.debug "[CIRCUIT] closed: querying #{service}"
@@ -67,14 +67,26 @@ class Circuitbox
         rescue *exceptions => exception
           logger.debug "[CIRCUIT] closed: detected #{service} failure"
           failure!
-          response = cache_key ? get_cached_response(cache_key) : nil
           open! if half_open?
+          if cache_key
+            response = get_cached_response(cache_key)
+          else
+            raise Circuitbox::ServiceFailureError.new(service, exception)
+          end
         end
       end
 
       return response
     end
 
+    def run(run_options = {})
+      begin
+        run!(run_options, &Proc.new)
+      rescue Circuitbox::Error
+        nil
+      end
+    end
+
     def open?
       if open_flag?
         true

data/lib/circuitbox/errors/error.rb

@@ -0,0 +1,4 @@
+class Circuitbox
+  class Error < StandardError
+  end
+end

data/lib/circuitbox/errors/open_circuit_error.rb

@@ -0,0 +1,10 @@
+class Circuitbox
+  class OpenCircuitError < Circuitbox::Error
+    attr_reader :service
+
+    def initialize(service)
+      @service = service
+    end
+
+  end
+end

data/lib/circuitbox/errors/service_failure_error.rb

@@ -0,0 +1,11 @@
+class Circuitbox
+  class ServiceFailureError < Circuitbox::Error
+    attr_reader :service, :original
+
+    def initialize(service, exception)
+      @service = service
+      @original = exception
+    end
+
+  end
+end

data/lib/circuitbox/version.rb

@@ -1,3 +1,3 @@
 class Circuitbox
-VERSION='0.8.0'
+VERSION='0.9.0'
 end

data/test/circuit_breaker_test.rb

@@ -133,6 +133,23 @@ class CircuitBreakerTest < Minitest::Test
 
   end
 
+  describe 'exceptions' do
+    before do
+      Circuitbox::CircuitBreaker.reset
+      @circuit = Circuitbox::CircuitBreaker.new(:yammer, exceptions: [SomeOtherError])
+    end
+
+    it 'raises exception when circuit is open' do
+      @circuit.stubs(open_flag?: true)
+      -> { @circuit.run! {} }.must_raise Circuitbox::OpenCircuitError
+    end
+
+    it 'raises exception when service fails' do
+      err = -> { @circuit.run! { raise SomeOtherError } }.must_raise Circuitbox::ServiceFailureError
+      err.original.must_be_instance_of SomeOtherError
+    end
+  end
+
   describe 'closing the circuit after sleep' do
     class GodTime < SimpleDelegator
       def now

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuitbox
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Fahim Ferdous
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -209,6 +209,9 @@ files:
 - circuitbox.gemspec
 - lib/circuitbox.rb
 - lib/circuitbox/circuit_breaker.rb
+- lib/circuitbox/errors/error.rb
+- lib/circuitbox/errors/open_circuit_error.rb
+- lib/circuitbox/errors/service_failure_error.rb
 - lib/circuitbox/faraday_middleware.rb
 - lib/circuitbox/memcache_store.rb
 - lib/circuitbox/notifier.rb
@@ -242,7 +245,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A robust circuit breaker that manages failing external services.