ya_circuit_breaker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19c5a1febb2815b14631a08290d37e85614995ad
+  data.tar.gz: b69c97cc1822d3082498dd4c86cefc3054829a14
+SHA512:
+  metadata.gz: ba7df7178c31b07f93fceb26081a59affc43110f4f0bf51335db9437bbcff97394af04050ce03160804900092f1cb5a9b5ea7f95ec01b6cbf003e48ad27e080b
+  data.tar.gz: 4230a0d18be188e4cca94d19bf07e6addc571023738da7f1b4c88f6f1cd0512bf43a1ade11e927b633c9cfab0d9264aaa75c499d28d73b3e9158a517847eb7ac

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/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.1.0
+  - 2.1.1
+  - jruby-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Patrick Huesler
+
+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,57 @@
+# CircuitBreaker
+
+Implementation of the circuit breaker pattern to protect against high latencies or outages of services.
+See Martin Fowlers [writeup](http://martinfowler.com/bliki/CircuitBreaker.html) for more information.
+
+There are other implementations by [wsargent.](https://github.com/wsargent/circuit_breaker) and [soundcloud](https://github.com/soundcloud/simple_circuit_breaker).
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ya_circuit_breaker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ya_circuit_breaker
+
+## Usage
+
+````
+require 'circuit_breaker'
+
+options = {
+  # number of failures before the circuit breaker trips
+  failure_threshold: 5,
+  # invocation timeout in seconds
+  invocation_timeout: 0.5,
+  # a list of timeouts for consecutive failures in seconds. can be used for exponential backoff
+  reset_timeouts: [2, 4, 8, 16, 32, 64, 128]
+}
+
+circuit_breaker = CircuitBreaker::Basic.new(options)
+
+begin
+  circuit_breaker.execute do
+    http_api_call()
+  end
+rescue CircuitBreaker::CircuitBrokenError
+  $stderr.puts "Circuit tripped"
+rescue Timeout::Error
+  $stderr.puts "Call took too long"
+rescue Error
+  $stderr.puts "Error thrown by 'http_api_call'"
+end
+````
+## Contributing
+
+1. Fork it ( https://github.com/wooga/circuit_breaker/fork )
+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,13 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => ['test:units']
+
+namespace :test do
+  Rake::TestTask.new(:units) do |t|
+    t.libs << "test"
+    t.test_files = FileList['test/*_test.rb']
+
+    t.verbose = true
+  end
+end

data/circuit_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 'circuit_breaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ya_circuit_breaker"
+  spec.version       = CircuitBreaker::VERSION
+  spec.authors       = ["Patrick Huesler", "Nadezda Zryanina"]
+  spec.email         = ["patrick.huesler@gmail.com", "n.s.zryanina@gmail.com"]
+  spec.summary       = %q{Basic circuit breaker in Ruby}
+  spec.description   = %q{Prevent long running external calls from blocking an application}
+  spec.homepage      = "https://github.com/wooga/circuit_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.5"
+  spec.add_development_dependency "rake"
+end

data/lib/circuit_breaker.rb

@@ -0,0 +1,92 @@
+require "circuit_breaker/version"
+require "circuit_breaker/circuit_broken_error"
+require "timeout"
+
+
+module CircuitBreaker
+  class Basic
+
+    DEFAULTS = {
+      failure_threshold:    5,
+      invocation_timeout:   2,
+      reset_timeouts:      10
+    }
+
+    attr_reader :failure_count, :last_failure_time, :failure_threshold
+
+    def initialize(options = {})
+      options             = DEFAULTS.merge(options)
+      @failure_threshold  = options[:failure_threshold]
+      @invocation_timeout = options[:invocation_timeout]
+      @reset_timeouts     = Array(options[:reset_timeouts])
+      @last_failure_time  = nil
+      @failure_count      = 0
+    end
+
+    def closed?
+      state == :closed
+    end
+
+    def open?
+      state == :open
+    end
+
+    def half_open?
+      state == :half_open
+    end
+
+    def trip!
+      @failure_count = @failure_threshold
+      @last_failure_time = Time.now
+    end
+
+    def reset!
+      @failure_count     = 0
+      @last_failure_time = nil
+    end
+
+    def retry_counter
+      @failure_count - @failure_threshold
+    end
+
+    def reset_timeout
+      @reset_timeouts[[@reset_timeouts.size - 1, retry_counter].min]
+    end
+
+
+    def state
+      case
+        when (@failure_count >= @failure_threshold) &&
+          (Time.now - @last_failure_time) > reset_timeout
+          :half_open
+        when @failure_count >= @failure_threshold
+          :open
+        else
+          :closed
+      end
+    end
+
+    def execute &block
+      if closed? || half_open?
+        begin
+          Timeout::timeout(@invocation_timeout) do
+            block.call if block_given?
+          end
+          reset!
+        rescue Timeout::Error
+          record_failure
+          raise
+        end
+      else
+        raise CircuitBrokenError.new("Circuit is broken")
+      end
+    end
+
+    def record_failure
+      @failure_count += 1
+      @last_failure_time = Time.now
+    end
+  end
+
+end
+

data/lib/circuit_breaker/circuit_broken_error.rb

@@ -0,0 +1,3 @@
+module CircuitBreaker
+  class CircuitBrokenError < StandardError ; end
+end

data/lib/circuit_breaker/version.rb

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

data/test/circuit_breaker_test.rb

@@ -0,0 +1,135 @@
+# encoding: UTF-8
+require 'test_helper'
+
+def successful_method
+  nil
+end
+
+def slow_method(sleep_time)
+  sleep(sleep_time)
+end
+
+describe CircuitBreaker::Basic do
+
+  it "should initialize in a closed state" do
+    assert CircuitBreaker::Basic.new.closed?
+  end
+
+  it "should trip the circuit breaker" do
+    circuit_breaker = CircuitBreaker::Basic.new
+    circuit_breaker.trip!
+
+    assert circuit_breaker.open?
+  end
+
+  it "should reset the circuit breaker" do
+    circuit_breaker = CircuitBreaker::Basic.new
+    circuit_breaker.trip!
+    assert circuit_breaker.open?
+
+    circuit_breaker.reset!
+
+    assert circuit_breaker.closed?
+  end
+
+  it "should execute the call in an closed state" do
+    circuit_breaker = CircuitBreaker::Basic.new
+    assert CircuitBreaker::Basic.new.closed?
+
+    @mock = MiniTest::Mock.new
+    @mock.expect(:do_something, nil)
+
+    circuit_breaker.execute do
+      @mock.do_something
+    end
+
+    @mock.verify
+  end
+
+  it "should trip after the failure threshold has been exceeded" do
+    invocation_timeout = 0.1
+    circuit_breaker    = CircuitBreaker::Basic.new(failure_threshold: 1, invocation_timeout: invocation_timeout)
+
+    assert_raises Timeout::Error do
+      circuit_breaker.execute do
+        slow_method(invocation_timeout + 0.1)
+      end
+    end
+
+    assert_raises CircuitBreaker::CircuitBrokenError do
+      circuit_breaker.execute do
+        assert false, "The call should not be executed in open state"
+      end
+    end
+  end
+
+  it "should reset after reset timeout" do
+    reset_timeouts  = 0.1
+    circuit_breaker = CircuitBreaker::Basic.new(reset_timeouts: reset_timeouts)
+
+    # switch into an open state
+    circuit_breaker.trip!
+
+    assert circuit_breaker.open?
+
+    sleep(reset_timeouts)
+
+    assert circuit_breaker.half_open?
+  end
+
+  it "should change from half open to closed on success" do
+    reset_timeouts  = 0.1
+    circuit_breaker = CircuitBreaker::Basic.new(reset_timeouts: reset_timeouts)
+
+    # switch into an open state
+    circuit_breaker.trip!
+
+    sleep(reset_timeouts)
+
+    assert circuit_breaker.half_open?
+
+    circuit_breaker.execute do
+      successful_method
+    end
+
+    assert circuit_breaker.closed?
+  end
+
+  it "should change from hald open to closed on failure" do
+    invocation_timeout = 0.1
+    reset_timeouts     = 0.1
+    circuit_breaker    = CircuitBreaker::Basic.new(invocation_timeout: invocation_timeout, reset_timeouts: reset_timeouts)
+    circuit_breaker.trip!
+
+    sleep(reset_timeouts)
+
+    assert circuit_breaker.half_open?
+
+    assert_raises Timeout::Error do
+      circuit_breaker.execute do
+        slow_method(invocation_timeout + 0.1)
+      end
+    end
+
+    assert circuit_breaker.open?
+  end
+
+  it "should back off exponentially" do
+    invocation_timeout = 0.1
+    reset_timeout      = 0.1
+    reset_timeouts     = [reset_timeout, 2 * reset_timeout, 3 * reset_timeout]
+    circuit_breaker    = CircuitBreaker::Basic.new(failure_threshold: 1, invocation_timeout: invocation_timeout, reset_timeouts: reset_timeouts)
+
+    reset_timeouts.each do |timeout|
+      assert_raises Timeout::Error do
+        circuit_breaker.execute do
+          slow_method(invocation_timeout + 0.1)
+        end
+      end
+      assert circuit_breaker.open?
+      sleep(timeout)
+    end
+  end
+
+
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+$LOAD_PATH.unshift( File.join( File.dirname(__FILE__), "..", "lib") )
+
+require "rubygems"
+require 'minitest/spec'
+require 'minitest/mock'
+require 'minitest/autorun'
+require 'circuit_breaker'

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: ya_circuit_breaker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrick Huesler
+- Nadezda Zryanina
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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: Prevent long running external calls from blocking an application
+email:
+- patrick.huesler@gmail.com
+- n.s.zryanina@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- circuit_breaker.gemspec
+- lib/circuit_breaker.rb
+- lib/circuit_breaker/circuit_broken_error.rb
+- lib/circuit_breaker/version.rb
+- test/circuit_breaker_test.rb
+- test/test_helper.rb
+homepage: https://github.com/wooga/circuit_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.1
+signing_key: 
+specification_version: 4
+summary: Basic circuit breaker in Ruby
+test_files:
+- test/circuit_breaker_test.rb
+- test/test_helper.rb