breaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e96a4a527f8764f01191e363daf25d59bcfc44a1
+  data.tar.gz: 9707df9e63bbdce0166b471beab29456f67c5c6b
+SHA512:
+  metadata.gz: 43cb66bf520aa9d6abd763b274b195a2a64387215c7c31799430f576a742f602dc8ac466edd3b88bcb948d37ade1b5a0f9ac98559ae2673afa9dc1358f4e1dbc
+  data.tar.gz: 4436478a597986c372c032ac72bf0dea6977a2b34b27cfc294113746f6bb6ef4bdf1d454c47d90a794364c57d1421c172b25a218a1e1ae86345bc4a3ebdc0715

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 ahawkins
+
+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,96 @@
+# Breaker
+
+Circuit Breakers for well designed applications.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'breaker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install breaker
+
+## Circuit Breaker Pattern
+
+The circuit breaker pattern is described in the (wonderful) book
+[Release It](http://pragprog.com/book/mnee/release-it) by Michael T.
+Nygard. A circuit breaker in programming terms is modeled after a
+circuit breaker in the real world. A circuit breaker protects the
+larger system from failures in other systems. They are especially
+useful for protecting an application from finnicky remote systems.
+
+The circuit is a state machine. It has three states: open, closed, and
+half-open. The circuit starts off in `open` state--normal operation.
+If the operation failures N times (the failure threshold) the circuit
+moves to `closed`. Calls in the `closed` state will immediate fail and
+raise an exception. After a specified time period has passed (retry
+timeout) the circuit moves into `half-open`. Calls happen normally. If
+a call fails the state moves to `open`. If the call suceeds it moves
+to `open`. All calls are capped with a timeout. If a timeout occurs
+that counts as a failure.
+
+## Usage
+
+Most interaction should go through `Breaker.circuit`. This is a
+factory method that creates `Breaker::Circuit` objects. It requires
+one argument: the name. It also takes an `options` hash for
+customizing the circuit. Thirdly it takes a block to run inside the
+circuit. Here are some examples:
+
+```ruby
+# Simplest example: protect some code with a circuit breaker
+Breaker.circuit 'twitter' do
+  Tweet.post 'Oh Hai'
+end
+```
+
+`Breaker.circuit` is an upsert opertion. It will create or update an
+existing circuit. Pass the options hash to customize the circuit's
+behavior.
+
+```ruby
+circuit = Breaker.circuit 'twitter', timeout: 5
+circuit.run do
+  Tweet.post 'Oh Hai'
+end
+```
+
+`Breaker.circuit` returns `Breaker::Circuit` instances which can be
+saved for later. There use depends no how persistence works.
+
+## Persistence
+
+Circuit breakers are only really useful in a large system (perhaps
+distributed). Some information must be shared acrosss subsystems. Say
+there are 5 different services in the system. Each is
+talking to 2 different systems protected by circuit breakers. Either
+of the systems go down. It's natural that the failure should propogate
+through the system so that each service knows the shared ones are
+down. This is where state and persistence come into play.
+
+The breaker gems bundles a simple in memory repository. This is
+process specific. If you need to share state across multiple processes
+then you must write your own repository.
+
+The repository manages fueses (in the eletrical sense). A fuse
+maintains state. The repository must implement one method: `upsert`
+which creates or updates a fuse given by name. The repistory can
+return some sort of persistent fuse where writer methods write to
+persistent storage.
+
+Refer to `lib/breaker/in_memory_repo.rb` for an example. The class is
+very simple.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.test_files = Rake::FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/breaker.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'breaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "breaker"
+  spec.version       = Breaker::VERSION
+  spec.authors       = ["ahawkins"]
+  spec.email         = ["adam@hawkins.io"]
+  spec.description   = %q{Circuit breaker pattern for well designed Ruby applications }
+  spec.summary       = %q{}
+  spec.homepage      = "https://github.com/ahawkins/breaker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.3"
+  spec.add_development_dependency "rake"
+end

data/lib/breaker.rb

@@ -0,0 +1,133 @@
+require "breaker/version"
+require 'timeout'
+
+module Breaker
+  CircuitOpenError = Class.new RuntimeError
+
+  class << self
+    def circuit(name, options = {})
+      fuse = repo.upsert options.merge(name: name)
+
+      circuit = Circuit.new fuse
+
+      if block_given?
+        circuit.run do
+          yield
+        end
+      end
+
+      circuit
+    end
+
+    def closed?(name)
+      circuit(name).closed?
+    end
+    alias up? closed?
+
+    def open?(name)
+      circuit(name).open?
+    end
+    alias down? open?
+
+    def repo
+      @repo
+    end
+
+    def repo=(repo)
+      @repo = repo
+    end
+  end
+
+  class Circuit
+    attr_accessor :fuse
+
+    def initialize(fuse)
+      @fuse = fuse
+    end
+
+    def name
+      fuse.name
+    end
+
+    def open(clock = Time.now)
+      fuse.failure_count = 1
+      fuse.state = :open
+      fuse.retry_threshold = clock + retry_timeout
+    end
+
+    def close
+      fuse.failure_count = 0
+      fuse.state = :closed
+      fuse.retry_threshold = nil
+    end
+
+    def ==(other)
+      other.instance_of?(self.class) && fuse == other.fuse
+    end
+
+    def open?
+      fuse.state == :open
+    end
+    alias down? open?
+
+    def closed?
+      fuse.state == :closed
+    end
+    alias up? closed?
+
+    def retry_timeout
+      fuse.retry_timeout
+    end
+
+    def failure_count
+      fuse.failure_count
+    end
+
+    def failure_threshold
+      fuse.failure_threshold
+    end
+
+    def timeout
+      fuse.timeout
+    end
+
+    def run(clock = Time.now)
+      if closed? || half_open?(clock)
+        begin
+          result = Timeout.timeout timeout do
+            yield
+          end
+
+          if half_open?(clock)
+            close
+          end
+
+          result
+        rescue => ex
+          fuse.failure_count = fuse.failure_count + 1
+          fuse.retry_threshold = clock + retry_timeout
+
+          open clock
+
+          raise ex
+        end
+      else
+        raise Breaker::CircuitOpenError, "Cannot run code while #{name} is open!"
+      end
+    end
+
+    private
+    def tripped?
+      fuse.failure_count != 0
+    end
+
+    def half_open?(clock)
+      tripped? && clock >= fuse.retry_threshold
+    end
+  end
+end
+
+require_relative 'breaker/in_memory_repo'
+require_relative 'breaker/test_cases'
+
+Breaker.repo = Breaker::InMemoryRepo.new

data/lib/breaker/in_memory_repo.rb

@@ -0,0 +1,69 @@
+module Breaker
+  class InMemoryRepo
+    Fuse = Struct.new :name, :state, :failure_threshold, :retry_timeout, :timeout, :failure_count, :retry_threshold do
+      def initialize(*args)
+        super
+
+        self.failure_threshold ||= 10
+        self.retry_timeout ||= 60
+        self.timeout ||= 5
+
+        self.state ||= :closed
+        self.failure_count ||= 0
+      end
+
+      def ==(other)
+        other.instance_of?(self.class) && name == other.name
+      end
+    end
+
+    attr_reader :store
+
+    def initialize
+      @store = []
+    end
+
+    def upsert(attributes)
+      existing = named attributes.fetch(:name)
+      if existing
+        update existing, attributes
+      else
+        create attributes
+      end
+    end
+
+    def count
+      store.length
+    end
+
+    def first
+      store.first
+    end
+
+    def named(name)
+      store.find { |fuse| fuse.name == name }
+    end
+
+    def create(attributes)
+      fuse = Fuse.new
+
+      attributes.each_pair do |key, value|
+        fuse.send "#{key}=", value
+      end
+
+      store << fuse
+
+      fuse
+    end
+
+    def update(existing, attributes)
+      existing
+
+      attributes.each_pair do |key, value|
+        existing.send "#{key}=", value
+      end
+
+      existing
+    end
+  end
+end

data/lib/breaker/test_cases.rb

@@ -0,0 +1,159 @@
+module Breaker
+  module TestCases
+    DummyError = Class.new RuntimeError
+
+    def repo
+      flunk "Test must define a repo to use"
+    end
+
+    def setup
+      Breaker.repo = repo
+    end
+
+    def test_new_fuses_start_off_clean
+      circuit = Breaker.circuit 'test'
+
+      assert circuit.closed?, "New circuits should be closed"
+      assert_equal 0, circuit.failure_count
+    end
+
+    def test_goes_into_open_state_when_failure_threshold_reached
+      circuit = Breaker.circuit 'test', failure_threshold: 1, retry_timeout: 30
+
+      assert circuit.closed?
+
+      assert_raises DummyError do
+        circuit.run do
+          raise DummyError
+        end
+      end
+
+      assert circuit.open?
+      assert_raises Breaker::CircuitOpenError do
+        circuit.run do
+          assert false, "Block should not run in this state"
+        end
+      end
+    end
+
+    def test_success_in_half_open_state_moves_circuit_into_closed
+      clock = Time.now
+      circuit = Breaker.circuit 'test', failure_threshold: 2, retry_timeout: 15
+
+      circuit.open clock
+      assert circuit.open?
+
+      assert_raises Breaker::CircuitOpenError do
+        circuit.run clock do
+           # nothing
+        end
+      end
+
+      circuit.run clock + circuit.retry_timeout do
+        # do nothing, this works and flips the circuit back closed
+      end
+
+      assert circuit.closed?
+    end
+
+    def test_failures_in_half_open_state_push_retry_timeout_back
+      clock = Time.now
+      circuit = Breaker.circuit 'test', failure_threshold: 2, retry_timeout: 15
+
+      circuit.open clock
+      assert circuit.open?
+
+      assert_raises DummyError do
+        circuit.run clock + circuit.retry_timeout do
+          raise DummyError
+        end
+      end
+
+      assert_raises Breaker::CircuitOpenError do
+        circuit.run clock + circuit.retry_timeout do
+          assert false, "Block should not be run while in this state"
+        end
+      end
+
+      assert_raises DummyError do
+        circuit.run clock + circuit.retry_timeout * 2 do
+          raise DummyError
+        end
+      end
+    end
+
+    def test_counts_timeouts_as_trips
+      circuit = Breaker.circuit 'test', retry_timeout: 15, timeout: 0.01
+      assert circuit.closed?
+
+      assert_raises TimeoutError do
+        circuit.run do
+          sleep circuit.timeout * 2
+        end
+      end
+    end
+
+    def test_circuit_factory_persists_fuses
+      circuit_a = Breaker.circuit 'test'
+      circuit_b = Breaker.circuit 'test'
+
+      assert_equal circuit_a, circuit_b, "Multiple calls to `circuit` should return the same circuit"
+
+      assert_equal 1, Breaker.repo.count
+      fuse = Breaker.repo.first
+
+      assert_equal 'test', fuse.name
+    end
+
+    def test_circuit_factory_creates_new_fuses_with_sensible_defaults
+      circuit = Breaker.circuit 'test'
+
+      assert_equal 1, Breaker.repo.count
+      fuse = Breaker.repo.first
+
+      assert_equal 10, fuse.failure_threshold, "Failure Theshold should have a default"
+      assert_equal 60, fuse.retry_timeout, "Retry timeout should have a default"
+      assert_equal 5, fuse.timeout, "Timeout should have a default"
+    end
+
+    def test_circuit_factory_updates_existing_fuses
+      Breaker.circuit 'test'
+      assert_equal 1, Breaker.repo.count
+
+      Breaker.circuit 'test', failure_threshold: 1,
+        retry_timeout: 2, timeout: 3
+
+      assert_equal 1, Breaker.repo.count
+      fuse = Breaker.repo.first
+
+      assert_equal 1, fuse.failure_threshold
+      assert_equal 2, fuse.retry_timeout
+      assert_equal 3, fuse.timeout
+    end
+
+    def test_circuit_breaker_factory_can_run_code_through_the_circuit
+      assert_raises DummyError do
+        Breaker.circuit 'test' do
+          raise DummyError
+        end
+      end
+    end
+
+    def test_breaker_query_methods
+      circuit = Breaker.circuit 'test'
+      circuit.close
+
+      assert Breaker.closed?('test')
+      assert Breaker.up?('test')
+      refute Breaker.open?('test')
+      refute Breaker.down?('test')
+
+      circuit.open
+
+      assert Breaker.open?('test')
+      assert Breaker.down?('test')
+      refute Breaker.closed?('test')
+      refute Breaker.up?('test')
+    end
+  end
+end

data/lib/breaker/version.rb

@@ -0,0 +1,3 @@
+module Breaker
+  VERSION = "0.1.0"
+end

data/test/acceptance_test.rb

@@ -0,0 +1,16 @@
+require_relative 'test_helper'
+
+class AcceptanceTest < MiniTest::Unit::TestCase
+  include Breaker::TestCases
+
+  InMemoryFuse = Struct.new :state, :failure_count, :retry_threshold,
+    :failure_threshold, :retry_timeout, :timeout
+
+  attr_reader :fuse, :repo
+
+  def setup
+    @repo = Breaker::InMemoryRepo.new
+    @fuse = InMemoryFuse.new :closed, 0, nil, 3, 15, 10
+    super
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+
+require 'minitest/autorun'
+
+require 'breaker'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: breaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ahawkins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: 'Circuit breaker pattern for well designed Ruby applications '
+email:
+- adam@hawkins.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- breaker.gemspec
+- lib/breaker.rb
+- lib/breaker/in_memory_repo.rb
+- lib/breaker/test_cases.rb
+- lib/breaker/version.rb
+- test/acceptance_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ahawkins/breaker
+licenses:
+- MIT
+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.0
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/acceptance_test.rb
+- test/test_helper.rb