cb2 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7745238479e3b771cd4250afd72b38628690b89c
-  data.tar.gz: 4a52b01231637cbfce2e2ab95f5a1ef05137a525
+SHA256:
+  metadata.gz: 3323bac7ddd5764b21f46a29100e035c5fefc75454bc593e8e8a73409cb9f50e
+  data.tar.gz: b3f3353141dcdad1f71eec514869c2379232d041c7afb501283ba6c50b2c0cab
 SHA512:
-  metadata.gz: 050ca6b08571141c02da98e85a064f76039955e180e14ddae4b071dfbb18fe6f3da4077e705f9809e9576e9553dd0b971c6241368736dfbaba93f3ec6412ccea
-  data.tar.gz: 8b21fa54a558a8cb7caf67f6c22c37d05aa208505913bcfcfeb98cedbfc1732dd64044cc315478166410e37667af23bdcbab8e04d25b79731511e9aa3c67d8c4
+  metadata.gz: 829d3b1044257eefe478c72ce18f993f3b9620dc029711efdc274a07773130485b41f284a7cd1c01c19895578874475f3c4ecfa43003fdf2d5affa9a2b377388
+  data.tar.gz: ed44bd343dc9d248710ca1232f3bb212bc629c03949585af7be07d86d6a1e1f535a0f3add1f0cc7b0297df6ded3da4ee5ab66956c0d8e5e6a7cda6391032f98c

data/Gemfile.lock

@@ -1,36 +1,48 @@
 PATH
   remote: .
   specs:
-    cb2 (0.0.2)
-      redis (~> 3.1)
+    cb2 (0.0.4)
+      redis (>= 4)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.2.5)
-    rake (10.3.2)
-    redis (3.1.0)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.0)
+    minitest (5.18.1)
+    mutex_m (0.3.0)
+    rake (13.0.6)
+    redis (5.2.0)
+      redis-client (>= 0.22.0)
+    redis-client (0.22.2)
+      connection_pool
     rr (1.1.2)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    timecop (0.7.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    timecop (0.9.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   cb2!
+  minitest (> 0)
+  mutex_m (> 0)
   rake (> 0)
   rr (~> 1.1)
   rspec (~> 3.1)
-  timecop (~> 0.7)
+  timecop (> 0)
+
+BUNDLED WITH
+   2.3.26

data/Gemfile.redis4

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "redis", "~> 4.0"

data/Gemfile.redis4.lock

@@ -0,0 +1,46 @@
+PATH
+  remote: .
+  specs:
+    cb2 (0.0.4)
+      redis (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.6.2)
+    minitest (5.25.5)
+    mutex_m (0.3.0)
+    rake (13.2.1)
+    redis (4.8.1)
+    rr (1.2.1)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    timecop (0.9.10)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  cb2!
+  minitest (> 0)
+  mutex_m (> 0)
+  rake (> 0)
+  redis (~> 4.0)
+  rr (~> 1.1)
+  rspec (~> 3.1)
+  timecop (> 0)
+
+BUNDLED WITH
+   2.5.23

data/Gemfile.redis5

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "redis", "~> 5.0"

data/Gemfile.redis5.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    cb2 (0.0.4)
+      redis (>= 4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    connection_pool (2.5.3)
+    diff-lcs (1.6.2)
+    minitest (5.25.5)
+    mutex_m (0.3.0)
+    rake (13.2.1)
+    redis (5.4.0)
+      redis-client (>= 0.22.0)
+    redis-client (0.24.0)
+      connection_pool
+    rr (1.2.1)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.4)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    timecop (0.9.10)
+
+PLATFORMS
+  arm64-darwin-24
+  ruby
+
+DEPENDENCIES
+  cb2!
+  minitest (> 0)
+  mutex_m (> 0)
+  rake (> 0)
+  redis (~> 5.0)
+  rr (~> 1.1)
+  rspec (~> 3.1)
+  timecop (> 0)
+
+BUNDLED WITH
+   2.5.23

data/README.md

@@ -0,0 +1,73 @@
+# CB2
+
+[![Gem version](http://img.shields.io/gem/v/cb2.svg)](https://rubygems.org/gems/cb2)
+[![Build Status](https://github.com/prognostikos/cb2/actions/workflows/verify.yml/badge.svg)](https://github.com/prognostikos/cb2/actions)
+
+Implementation of the [circuit breaker pattern](http://martinfowler.com/bliki/CircuitBreaker.html) in Ruby, backed by Redis.
+
+Setup circuit breakers wrapping external service calls, be it HTTP, TCP, etc. When a service becomes unavailable the circuit breaker will open and quickly refuse any additional requests to it. After a specific window the breaker closes again, allowing calls to go through.
+
+This pattern makes your application more resilient to third party failures, because it won't exhaust resources trying to make calls to an unresponsive service. This is particularly relevant to apps running on servers susceptible to request queuing, like Unicorn or Puma. It can also help the services you depend on to recover faster, by reducing the load on them.
+
+CB2 tracks errors over a rolling window of time (size configurable), and opens after the error rate hits a certain percentage. The circuit stays open (rejecting calls) for another specified period, and then from there it goes to the half-open state: in which a succesful request will make it close again, but a failure will put it immediatelly back at the open state. [Martin Fowler has a nice diagram to further explain these states](http://martinfowler.com/bliki/CircuitBreaker.html).
+
+
+## Usage
+
+Instantiate a circuit breaker:
+
+```ruby
+breaker = CB2::Breaker.new(
+  service: "aws"       # identify each circuit breaker individually
+  duration: 60,        # keep track of errors over a 1 min window
+  threshold: 5,        # open the circuit breaker when error rate is at 5%
+  reenable_after: 600, # keep it open for 10 mins
+  redis: Redis.new)    # redis connection it should use to keep state
+```
+
+Then wrap service calls with it:
+
+```ruby
+breaker.run do
+  some_api_request()
+end
+```
+
+The breaker will open when that block raises enough exceptions to trigger the threshold. Handle these exceptions to react accordingly:
+
+```ruby
+begin
+  breaker.run do
+    some_api_request()
+  end
+rescue CB2::BreakerOpen
+  alternate_response() # fallback to cached data, or raise a user-friendly exception
+end
+```
+
+### Circuit breaker stub
+
+CB2 can also run as a stub. Use it to aid testing, simulations and gradual rollouts:
+
+```ruby
+breaker = CB2::Breaker.new(
+  strategy: "stub",
+  allow: true) # set it to false to always block requests
+```
+
+## See also
+
+This might be the only percent-based breaker in Ruby so far. For count-based breakers (eg: open after X exceptions) you can also check [breaker_box](https://github.com/sittercity/breaker_box) and [circuit_breaker](https://github.com/wsargent/circuit_breaker).
+
+## Development
+
+Running the tests locally requires a running `redis` service listening on port `6379`. If the service is not running locally, use a `container`:
+
+```
+docker run -p 6379:6379 -d redis
+bundle exec rspec
+```
+
+## Meta
+
+Created by Pedro Belo.

data/lib/cb2/breaker.rb

@@ -8,7 +8,7 @@ class CB2::Breaker
 
   def run
     if open?
-      raise CB2::BreakerOpen
+      raise CB2::BreakerOpen.new("#{service} breaker open")
     end
 
     begin

data/lib/cb2/strategies/rolling_window.rb

@@ -6,7 +6,7 @@ class CB2::RollingWindow
     @duration       = options.fetch(:duration)
     @threshold      = options.fetch(:threshold)
     @reenable_after = options.fetch(:reenable_after)
-    @redis          = options[:redis] || Redis.current
+    @redis          = options[:redis] || Redis.new
   end
 
   def open?
@@ -54,16 +54,17 @@ class CB2::RollingWindow
   protected
 
   def increment_rolling_window(key)
-    t   = Time.now.to_i
-    pipeline = redis.pipelined do
+    t = Time.now.to_i
+    result = redis.pipelined do |pipeline|
       # keep the sorted set clean
-      redis.zremrangebyscore(key, "-inf", t - duration)
+      pipeline.zremrangebyscore(key, "-inf", t - duration)
       # add as a random uuid because sorted sets won't take duplicate items:
-      redis.zadd(key, t, SecureRandom.uuid)
+      pipeline.zadd(key, t, SecureRandom.uuid)
       # just count how many errors are left in the set
-      redis.zcard(key)
+      pipeline.zcard(key)
     end
-    return pipeline.last # return the count
+
+    result.last # return the count
   end
 
   def should_open?(error_count)

data/lib/cb2.rb

@@ -1,4 +1,5 @@
 require "redis"
+require "securerandom"
 
 module CB2
 end

metadata

@@ -1,29 +1,30 @@
 --- !ruby/object:Gem::Specification
 name: cb2
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Pedro Belo
-autorequire: 
+- Matt Rohrer
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2025-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,38 +67,72 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mutex_m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Implementation of the circuit breaker pattern in Ruby
-email: pedrobelo@gmail.com
+email: matt@prognostikos.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
 - Gemfile.lock
+- Gemfile.redis4
+- Gemfile.redis4.lock
+- Gemfile.redis5
+- Gemfile.redis5.lock
+- README.md
 - lib/cb2.rb
 - lib/cb2/breaker.rb
 - lib/cb2/error.rb
 - lib/cb2/strategies/percentage.rb
 - lib/cb2/strategies/rolling_window.rb
 - lib/cb2/strategies/stub.rb
-homepage: http://github.com/pedro/cb2
-licenses: []
+homepage: http://github.com/prognostikos/cb2
+licenses:
+- MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -112,10 +147,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.3
-signing_key: 
+rubygems_version: 3.5.22
+signing_key:
 specification_version: 4
 summary: Circuit breaker
 test_files: []
-has_rdoc: