circuit_breakage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dad99a3f4f0f6b939a2092e865ac7dca10b5fe4b
+  data.tar.gz: 6e7684487d5a883b407013767e8f6a454933c9fb
+SHA512:
+  metadata.gz: 4895d56acb08b9c942e1f571162017b46b40da00b5872b5a5891d411dd5db3461d48d0f21c3ef8227efbf3aab48e3c7df10a1f79ea32e50b45cefc43a2b6d6cf
+  data.tar.gz: 3f9da79d01746dcf5e3d8e14ae4adc7eb3f831370ed1cbf55842d97eca744fd15f85662c572905038c7e4f7c61a38a141ab9a26c8de0df0c803bf6aa0fabb963

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in circuit_breakage.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Hyland
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,20 @@
+# CircuitBreakage
+
+A simple Circuit Breaker implementation in Ruby with a timeout.  A Circuit
+Breaker wraps potentially troublesome logic and will "trip" the circuit (and
+stop trying to run the logic) if it sees too many failures.  After a while, it
+will retry.
+
+## Usage
+
+```ruby
+block = ->(*args) do
+  # Some dangerous thing.
+end
+
+breaker = CircuitBreakage.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.call(*some_args)      # args are passed through to block

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/circuit_breakage.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'circuit_breakage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "circuit_breakage"
+  spec.version       = CircuitBreakage::VERSION
+  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.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 0"
+  spec.add_development_dependency "rspec", "~> 0"
+  spec.add_development_dependency "pry", "~> 0"
+end

data/lib/circuit_breakage/breaker.rb

@@ -0,0 +1,78 @@
+require 'timeout'
+
+module CircuitBreakage
+  class CircuitOpen < RuntimeError; end
+  class CircuitTimeout < RuntimeError; end
+
+  # A simple circuit breaker implementation.  See the main README for usage
+  # details.
+  #
+  class Breaker
+    attr_accessor :failure_count, :last_failed, :state, :block
+    attr_accessor :failure_threshold, :duration, :timeout
+
+    DEFAULT_FAILURE_THRESHOLD = 5     # Number of failures required to trip circuit
+    DEFAULT_DURATION          = 300   # Number of seconds the circuit stays tripped
+    DEFAULT_TIMEOUT           = 10    # Number of seconds before the call times out
+
+    def initialize(block)
+      @block = block
+      self.failure_threshold  = DEFAULT_FAILURE_THRESHOLD
+      self.duration           = DEFAULT_DURATION
+      self.timeout            = DEFAULT_TIMEOUT
+
+      self.failure_count ||= 0
+      self.last_failed   ||= Time.at(0)
+      closed!
+    end
+
+    def call(*args)
+      if open?
+        if time_to_retry?
+          half_open!
+        else
+          raise CircuitOpen
+        end
+      end
+
+      begin
+        ret_value = nil
+        Timeout.timeout(self.timeout, CircuitTimeout) do
+          ret_value = @block.call(*args)
+        end
+        handle_success
+
+        return ret_value
+      rescue Exception => e
+        handle_failure
+      end
+    end
+
+    [:open, :closed, :half_open].each do |state|
+      define_method("#{state}?") {
+        self.state == state
+      }
+
+      define_method("#{state}!") {
+        self.state = state
+      }
+    end
+
+    private
+
+    def time_to_retry?
+      Time.now >= self.last_failed + self.duration
+    end
+
+    def handle_success
+      closed!
+      self.failure_count = 0
+    end
+
+    def handle_failure
+      self.last_failed = Time.now
+      self.failure_count += 1
+      open! if self.failure_count >= self.failure_threshold
+    end
+  end
+end

data/lib/circuit_breakage/caching_breaker.rb

@@ -0,0 +1,31 @@
+module CircuitBreakage
+  # Similar to Breaker, but accepts a cache object, and will call #write and
+  # #fetch on that object to store and retrieve all state, instead of keeping
+  # it in memory.
+  #
+  class CachingBreaker < Breaker
+    attr_reader :cache, :key
+
+    def initialize(cache, key, block)
+      @cache = cache
+      @key = key
+      super(block)
+    end
+
+    def self.cached_attr(*attrs)
+      attrs.each do |attr|
+        define_method attr do
+          raise "You must define the cache and key on a CachingBreaker!" unless cache && key
+          cache.fetch "#{key}/#{attr}"
+        end
+
+        define_method "#{attr}=" do |value|
+          raise "You must define the cache and key on a CachingBreaker!" unless cache && key
+          cache.write "#{key}/#{attr}", value
+        end
+      end
+    end
+
+    cached_attr :failure_count, :last_failed, :state
+  end
+end

data/lib/circuit_breakage/version.rb

@@ -0,0 +1,3 @@
+module CircuitBreakage
+  VERSION = "0.0.1"
+end

data/lib/circuit_breakage.rb

@@ -0,0 +1,5 @@
+require "circuit_breakage/version"
+
+module CircuitBreakage
+  # Your code goes here...
+end

data/spec/breaker_spec.rb

@@ -0,0 +1,125 @@
+module CircuitBreakage
+  describe Breaker do
+    let(:breaker) { Breaker.new(block) }
+    let(:block) { ->(x) { return x } }
+
+    it 'initializes with a block' do
+      block = ->() { "This is a block!" }
+      breaker = Breaker.new(block)
+      expect(breaker).to be_a(Breaker)
+    end
+
+    describe '#call' do
+      subject { -> { breaker.call(arg) } }
+      let(:arg) { 'This is an argument.' }
+
+      context 'when the circuit is closed' do
+        before { breaker.closed! }
+
+        it 'calls the block' do
+          # The default block just returns the arg.
+          expect(breaker.call(arg)).to eq arg
+        end
+
+        context 'and the call succeeds' do
+          it 'resets the failure count' do
+            breaker.failure_count = 3
+            expect { breaker.call(arg) }.to change { breaker.failure_count }.to(0)
+          end
+        end
+
+        context 'and the call fails' do
+          let(:block) { -> { raise 'some error' } }
+
+          it { is_expected.to change { breaker.failure_count }.by(1) }
+          it { is_expected.to change { breaker.last_failed } }
+
+          context 'and the failure count exceeds the failure threshold' do
+            before { breaker.failure_count = breaker.failure_threshold }
+
+            it { is_expected.to change { breaker.open? }.to(true) }
+          end
+        end
+
+        context 'and the call times out' do
+          let(:block) { ->(_) { sleep 2 } }
+          before { breaker.timeout = 0.1 }
+
+          it 'counts as a failure' do
+            expect { breaker.call(arg) }.to change { breaker.failure_count }.by(1)
+          end
+        end
+      end
+
+      context 'when the circuit is open' do
+        before { breaker.open! }
+
+        context 'before the retry_time' do
+          before { breaker.last_failed = Time.now - breaker.duration + 30 }
+
+          it { is_expected.to raise_error(CircuitOpen) }
+        end
+
+        context 'after the retry time' do
+          before { breaker.last_failed = Time.now - breaker.duration - 30 }
+
+          it 'calls the block' do
+            # This is the same as being half open, see below for further tests.
+            expect(breaker.call(arg)).to eq arg
+          end
+        end
+      end
+
+      context 'when the circuit is half open' do
+        before do
+          # For the circuit to be tripped in the first place, the failure count
+          # must have reached the failure threshold.
+          breaker.failure_count = breaker.failure_threshold
+          breaker.half_open!
+        end
+
+        it 'calls the block' do
+          expect(breaker.call(arg)).to eq arg
+        end
+
+        context 'and the call succeeds' do
+          before { breaker.failure_count = 3 }
+
+          it { is_expected.to change { breaker.closed? }.to(true) }
+          it { is_expected.to change { breaker.failure_count }.to(0) }
+        end
+
+        context 'and the call fails' do
+          let(:block) { -> { raise 'some error' } }
+
+          it { is_expected.to change { breaker.open? }.to(true) }
+          it { is_expected.to change { breaker.last_failed } }
+        end
+      end
+    end
+
+    # #half_open?, #half_open!, #closed?, and #closed! are all exactly the same
+    # as #open? and #open!, so we're just going to test the open methods.
+
+    describe '#open!' do
+      it 'opens the circuit' do
+        breaker.open!
+        expect(breaker).to be_open
+      end
+    end
+
+    describe '#open?' do
+      subject { breaker.open? }
+
+      context 'when open' do
+        before { breaker.open! }
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when not open' do
+        before { breaker.closed! }
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end

data/spec/caching_breaker_spec.rb

@@ -0,0 +1,140 @@
+# TODO: Extract the common tests (ie, most of them) in to a shared example
+# group for this and the vanilla Breaker spec.
+
+module CircuitBreakage
+  describe CachingBreaker do
+    let(:breaker) { CachingBreaker.new(cache, key, block) }
+    let(:cache)   { MockCache.new }
+    let(:key)     { 'test/data' }
+    let(:block)   { ->(x) { return x } }
+
+    describe '#call' do
+      subject { -> { breaker.call(arg) } }
+      let(:arg) { 'This is an argument.' }
+
+      context 'when the circuit is closed' do
+        before { breaker.closed! }
+
+        it 'calls the block' do
+          # The default block just returns the arg.
+          expect(breaker.call(arg)).to eq arg
+        end
+
+        context 'and the call succeeds' do
+          it 'resets the failure count' do
+            breaker.failure_count = 3
+            expect { breaker.call(arg) }.to change { breaker.failure_count }.to(0)
+          end
+        end
+
+        context 'and the call fails' do
+          let(:block) { -> { raise 'some error' } }
+
+          it { is_expected.to change { breaker.failure_count }.by(1) }
+          it { is_expected.to change { breaker.last_failed } }
+
+          context 'and the failure count exceeds the failure threshold' do
+            before { breaker.failure_count = breaker.failure_threshold }
+
+            it { is_expected.to change { breaker.open? }.to(true) }
+          end
+        end
+
+        context 'and the call times out' do
+          let(:block) { ->(_) { sleep 2 } }
+          before { breaker.timeout = 0.1 }
+
+          it 'counts as a failure' do
+            expect { breaker.call(arg) }.to change { breaker.failure_count }.by(1)
+          end
+        end
+      end
+
+      context 'when the circuit is open' do
+        before { breaker.open! }
+
+        context 'before the retry_time' do
+          before { breaker.last_failed = Time.now - breaker.duration + 30 }
+
+          it { is_expected.to raise_error(CircuitOpen) }
+        end
+
+        context 'after the retry time' do
+          before { breaker.last_failed = Time.now - breaker.duration - 30 }
+
+          it 'calls the block' do
+            # This is the same as being half open, see below for further tests.
+            expect(breaker.call(arg)).to eq arg
+          end
+        end
+      end
+
+      context 'when the circuit is half open' do
+        before do
+          # For the circuit to be tripped in the first place, the failure count
+          # must have reached the failure threshold.
+          breaker.failure_count = breaker.failure_threshold
+          breaker.half_open!
+        end
+
+        it 'calls the block' do
+          expect(breaker.call(arg)).to eq arg
+        end
+
+        context 'and the call succeeds' do
+          before { breaker.failure_count = 3 }
+
+          it { is_expected.to change { breaker.closed? }.to(true) }
+          it { is_expected.to change { breaker.failure_count }.to(0) }
+        end
+
+        context 'and the call fails' do
+          let(:block) { -> { raise 'some error' } }
+
+          it { is_expected.to change { breaker.open? }.to(true) }
+          it { is_expected.to change { breaker.last_failed } }
+        end
+      end
+    end
+
+    # #half_open?, #half_open!, #closed?, and #closed! are all exactly the same
+    # as #open? and #open!, so we're just going to test the open methods.
+
+    describe '#open!' do
+      it 'opens the circuit' do
+        breaker.open!
+        expect(breaker).to be_open
+      end
+    end
+
+    describe '#open?' do
+      subject { breaker.open? }
+
+      context 'when open' do
+        before { breaker.open! }
+        it { is_expected.to be_truthy }
+      end
+
+      context 'when not open' do
+        before { breaker.closed! }
+        it { is_expected.to be_falsey }
+      end
+    end
+  end
+end
+
+class MockCache
+  attr_accessor :stored_data
+
+  def initialize
+    @stored_data = {}
+  end
+
+  def write(key, val)
+    @stored_data[key] = val
+  end
+
+  def fetch(key)
+    @stored_data[key]
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'pry'
+
+lib_dir = File.expand_path('../../lib/', __FILE__)
+Dir["#{lib_dir}/**/*.rb"].each { |file| require file }
+
+RSpec.configure do |config|
+  if config.files_to_run.one?
+    config.default_formatter = 'doc'
+  end
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: circuit_breakage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Hyland
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: rspec
+  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: pry
+  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'
+description: Provides a circuit breaker pattern with configurable error tolerance,
+  timeout, breakage duration, and state storage.
+email:
+- john@djspinmonkey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circuit_breakage.gemspec
+- lib/circuit_breakage.rb
+- lib/circuit_breakage/breaker.rb
+- lib/circuit_breakage/caching_breaker.rb
+- lib/circuit_breakage/version.rb
+- spec/breaker_spec.rb
+- spec/caching_breaker_spec.rb
+- spec/spec_helper.rb
+homepage: https://source.datanerd.us/jhyland/circuit_breakage
+licenses:
+- New Relic
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Provides a simple circuit breaker pattern.
+test_files:
+- spec/breaker_spec.rb
+- spec/caching_breaker_spec.rb
+- spec/spec_helper.rb