circuit_breakage 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d643902ba2ada91222c75da26be3426d55eb5db4
-  data.tar.gz: f8f3a7c49ec02514e4bd54d54f401c9d257e6430
+  metadata.gz: bf00e430eba8f24feacafd2a94ebfc2e9ce53737
+  data.tar.gz: d6550c42f12736a6a87a6059df53ba2315fa320b
 SHA512:
-  metadata.gz: b539db6b88213831b37ec97b00c317b088a87558130c6f2533a2360bae3b3e9b1139a3725be313e88c46f27b4eba55fb9b49c23efe5604a17694c5d2690a587f
-  data.tar.gz: 78ab5583212c28a9368168cc4425c96b6ccf44b2afe5bfa791aa93846bbff3bb130ed942d4ee919c6f6d47fd64fc547ec040816cd7e31189578b6fcee49ea797
+  metadata.gz: 5752657e3fd2e10342190cbfab8539068087cb145a07070f02091dbdaa0da50249afede7656def46eef30dd524f242041e7c5ff0bc8573ef56a5aae509b0a79c
+  data.tar.gz: a51e540148c42f4de8d3008b40a14b77ae680010ae4d64f4f404b04cb0793822d9e850c63f29e1b82c45e4967a571aaf0920e522ecf9f5e07ce6293b9fb39699

data/README.md

@@ -10,20 +10,20 @@ description of the pattern.
 
 ## Usage
 
-### Normal Boring Circuit Breakers
+### Simple Example
 
 ```ruby
-block = ->(*args) do
+proc = ->(*args) do
   # Some dangerous thing.
 end
 
-breaker = CircuitBreakage::Breaker.new(block)
-breaker.failure_threshold = 3 # only 3 failures before tripping circuit
-breaker.duration = 10         # 10 seconds before retry
-breaker.timeout = 0.5         # 500 milliseconds allowed before auto-fail
+breaker = CircuitBreakage::Breaker.new(proc)
+breaker.failure_threshold =   3 # only 3 failures before tripping circuit
+breaker.duration          =  10 # 10 seconds before retry
+breaker.timeout           = 0.5 # 500 milliseconds allowed before auto-fail
 
 begin
-  breaker.call(*some_args)    # args are passed through to block
+  breaker.call(*some_args)    # args are passed through to the proc
 rescue CircuitBreakage::CircuitOpen
   puts "Too many recent failures!"
 rescue CircuitBreakage::CircuitTimeout
@@ -31,9 +31,58 @@ rescue CircuitBreakage::CircuitTimeout
 end
 ```
 
-A "failure" in this context means that the block either raised an exception or
+A "failure" in this context means that the proc either raised an exception or
 timed out.
 
+### Slightly More Complex Example in Rails
+
+This example shows one way you might choose to wrap a remote service call in a
+Rails app.
+
+```ruby
+# in your controller
+class MyController
+  def show
+    widget_client = WidgetClient.new
+    @widgets = widget_client.get_widget(id)
+  end
+end
+
+# in lib/widget_client.rb
+class WidgetClient
+  class << self
+    def breaker
+      if @breaker.nil?
+        @breaker = CircuitBreakage::Breaker.new method(:do_get_widget)
+        @breaker.failure_threshold =   3
+        @breaker.duration          =  10
+        @breaker.timeout           = 0.5
+      end
+
+      return @breaker
+    end
+
+    def do_get_widget(id)
+      # Do the remote service call here.
+    end
+  end
+
+  def get_widget(id)
+    class.breaker.call(id)
+  end
+end
+```
+
+This makes it easy to control all calls to the remote service with a single
+breaker. This way, they are all tripped and reset together, even if the service
+is called by several different parts of your code. Don't forget to handle
+errors somewhere -- probably either the controller or the client library,
+depending on the needs of your code.
+
+Note that we've actually used a `Method` object rather than a proc to
+initialize the circuit breaker. That's fine -- breakers will actually work with
+any object that responds to `call`.
+
 ### Redis-Backed "Shared" Circuit Breakers
 
 The unique feature of this particular Circuit Breaker gem is that it also
@@ -50,7 +99,7 @@ the retry timer as appropriate.
 connection = some_redis_connection
 key = 'my_app/this_operation'
 
-breaker = CircuitBreakage::RedisBackedBreaker.new(connection, key, block)
+breaker = CircuitBreakage::RedisBackedBreaker.new(connection, key, proc)
 breaker.lock_timeout = 30  # seconds before assuming a locking process has crashed
 
 # Everything else is the same as above.
@@ -59,7 +108,7 @@ breaker.lock_timeout = 30  # seconds before assuming a locking process has crash
 The `lock_timeout` setting is necessary since a process that crashes or is
 killed might be holding the retry lock. This sets the amount of time other
 processes will wait before deciding a lock has expired.  It should be longer
-than the amount of time you expect the block to take to run.
+than the amount of time you expect the proc to take to run.
 
 All circuit breakers using the same key and the same Redis instance will share
 their state . It is strongly recommended that their settings

data/circuit_breakage.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |spec|
   spec.authors       = ["John Hyland"]
   spec.email         = ["john@djspinmonkey.com"]
   spec.summary       = %q{Provides a simple circuit breaker pattern.}
-  spec.description   = %q{Provides a circuit breaker pattern with configurable error tolerance, timeout, breakage duration, and state storage.}
-  spec.homepage      = "https://source.datanerd.us/jhyland/circuit_breakage" # TODO: move to some org
-  spec.license       = "New Relic"
+  spec.description   = %q{Provides a circuit breaker pattern with optional support for distributed state.}
+  spec.homepage      = "https://github.com/djspinmonkey/circuit_breakage"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/circuit_breakage/version.rb

@@ -1,3 +1,3 @@
 module CircuitBreakage
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: circuit_breakage
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - John Hyland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-15 00:00:00.000000000 Z
+date: 2015-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,8 +66,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-description: Provides a circuit breaker pattern with configurable error tolerance,
-  timeout, breakage duration, and state storage.
+description: Provides a circuit breaker pattern with optional support for distributed
+  state.
 email:
 - john@djspinmonkey.com
 executables: []
@@ -88,9 +88,9 @@ files:
 - spec/breaker_spec.rb
 - spec/redis_backed_breaker_spec.rb
 - spec/spec_helper.rb
-homepage: https://source.datanerd.us/jhyland/circuit_breakage
+homepage: https://github.com/djspinmonkey/circuit_breakage
 licenses:
-- New Relic
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []