cb21 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 23f01fd05a90a50ecf546f56d48996ab4aa30035830d3e8450b2b28fb9d99850
+  data.tar.gz: 489095dbae4aa3f63ec29029acf596e01b3b61e5c10334582bc9353655737008
+SHA512:
+  metadata.gz: b0025340b77170a311ab048e712f782ffd5209b8047add8202aa553f26e4a6b4738fe94af73b1e5ed874eb242dce8e6dcae4b34129bde27dde41213d6eb2155e
+  data.tar.gz: abf0bee6068b84d851b0fd251110565db8d3accb744a5c7dec879558d2d5560badec66aff63dd1b34b61b430f95d10b1187cd7c5a7882a06d33add1f2790387c

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    cb2 (0.0.3)
+      redis (~> 3.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.3.2)
+    redis (3.2.0)
+    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)
+      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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cb2!
+  rake (> 0)
+  rr (~> 1.1)
+  rspec (~> 3.1)
+  timecop (~> 0.7)

data/lib/cb2/breaker.rb

@@ -0,0 +1,63 @@
+class CB2::Breaker
+  attr_accessor :service, :strategy
+
+  def initialize(options)
+    @service  = options[:service] || "default"
+    @strategy = initialize_strategy(options)
+  end
+
+  def run
+    if open?
+      raise CB2::BreakerOpen
+    end
+
+    begin
+      process_count
+      ret = yield
+      process_success
+    rescue => e
+      process_error
+      raise e
+    end
+
+    return ret
+  end
+
+  def open?
+    strategy.open?
+  rescue Redis::BaseError
+    false
+  end
+
+  def process_count
+    strategy.count if strategy.respond_to?(:count)
+  rescue Redis::BaseError
+  end
+
+  def process_success
+    strategy.success if strategy.respond_to?(:success)
+  rescue Redis::BaseError
+  end
+
+  def process_error
+    strategy.error if strategy.respond_to?(:error)
+  rescue Redis::BaseError
+  end
+
+  def initialize_strategy(options)
+    strategy_options = options.dup.merge(service: self.service)
+
+    if options[:strategy].respond_to?(:open?)
+      return options[:strategy].new(strategy_options)
+    end
+
+    case options[:strategy].to_s
+    when "", "percentage"
+      CB2::Percentage.new(strategy_options)
+    when "rolling_window"
+      CB2::RollingWindow.new(strategy_options)
+    when "stub"
+      CB2::Stub.new(strategy_options)
+    end
+  end
+end

data/lib/cb2/error.rb

@@ -0,0 +1,4 @@
+module CB2
+  class BreakerOpen < StandardError
+  end
+end

data/lib/cb2/strategies/percentage.rb

@@ -0,0 +1,16 @@
+class CB2::Percentage < CB2::RollingWindow
+  # keep a rolling window of all calls too
+  def count
+    @current_count = increment_rolling_window(key("count"))
+  end
+
+  private
+
+  def should_open?(error_count)
+    # do not open until we have a reasonable number of requests
+    return false if @current_count < 5
+
+    error_perc = error_count * 100 / @current_count.to_f
+    return error_perc >= threshold
+  end
+end

data/lib/cb2/strategies/rolling_window.rb

@@ -0,0 +1,72 @@
+class CB2::RollingWindow
+  attr_accessor :service, :duration, :threshold, :reenable_after, :redis
+
+  def initialize(options)
+    @service        = options.fetch(:service)
+    @duration       = options.fetch(:duration)
+    @threshold      = options.fetch(:threshold)
+    @reenable_after = options.fetch(:reenable_after)
+    @redis          = options[:redis] || Redis.current
+  end
+
+  def open?
+    @last_open = nil # always fetch the latest value from redis here
+    last_open && last_open.to_i > (Time.now.to_i - reenable_after)
+  end
+
+  def half_open?
+    last_open && last_open.to_i < (Time.now.to_i - reenable_after)
+  end
+
+  def last_open
+    @last_open ||= redis.get(key)
+  end
+
+  def success
+    if half_open?
+      reset!
+    end
+  end
+
+  def error
+    count = increment_rolling_window(key("error"))
+    if half_open? || should_open?(count)
+      trip!
+    end
+  end
+
+  def reset!
+    @last_open = nil
+    redis.del(key)
+  end
+
+  def trip!
+    @last_open = Time.now.to_i
+    redis.set(key, @last_open)
+  end
+
+  # generate a key to use in redis
+  def key(id=nil)
+    postfix = id ? "-#{id}" : ""
+    "cb2-#{service}#{postfix}"
+  end
+
+  protected
+
+  def increment_rolling_window(key)
+    t   = Time.now.to_i
+    pipeline = redis.pipelined do
+      # keep the sorted set clean
+      redis.zremrangebyscore(key, "-inf", t - duration)
+      # add as a random uuid because sorted sets won't take duplicate items:
+      redis.zadd(key, t, SecureRandom.uuid)
+      # just count how many errors are left in the set
+      redis.zcard(key)
+    end
+    return pipeline.last # return the count
+  end
+
+  def should_open?(error_count)
+    error_count >= threshold
+  end
+end

data/lib/cb2/strategies/stub.rb

@@ -0,0 +1,11 @@
+class CB2::Stub
+  attr_accessor :allow
+
+  def initialize(options)
+    @allow = options.fetch(:allow)
+  end
+
+  def open?
+    !allow
+  end
+end

data/lib/cb2.rb

@@ -0,0 +1,10 @@
+require "redis"
+
+module CB2
+end
+
+require "cb2/breaker"
+require "cb2/error"
+require "cb2/strategies/rolling_window"
+require "cb2/strategies/percentage"
+require "cb2/strategies/stub"

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: cb21
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Talha Shoaib
+- Rab Nawaz
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-12-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Implementation of the circuit breaker pattern in Ruby
+email:
+- talhashoaib27@gmail.com
+- rabn1993@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- 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: https://github.com/talhashoaib/cb2
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.7.8
+signing_key:
+specification_version: 4
+summary: Circuit breaker with latest redis
+test_files: []