circuit_breaker-ruby 0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZTU0MWI4NmExMGFlNTY1YjlkNGYxNTEwMzk4MmQ4ZjhmNjU4MWQwZQ==
+  data.tar.gz: !binary |-
+    ODEyZGE5Y2Q1OTY2ODdjZDMwM2ExM2U1NjFjYWYwNTY3MGY1YjBjMg==
+SHA512:
+  metadata.gz: !binary |-
+    NDM2NGNiYmZlNDAxNWQwY2EwNWVmYTYyYjBlYWQ3NzI5YjE5MjNhYmM4NzU4
+    MTcyNDZjOTk4MmU1ZDcxZGJkZmQ1NDRmYWM5NjVhYTA3OGViY2MwYTU1MTA1
+    YzJjMTU0MjliNjJjYjRmZDJkYjU4MDNlZmMzZmI0ZTUyMjA4MzM=
+  data.tar.gz: !binary |-
+    OTQyMzRmZDRjMzcwNjQ4YWIwMmMyMmIzMjYxNzM2ZmQ3ZDg1NTdlMTZjODVk
+    ZDlmZDZiNjQ2OTgwZWRlNmQ4YzZhODBkMDNlNDE3MzEzZmE2Nzc3ZWM3NTA1
+    Y2M2NmM5MzdjYTQyZjcyZjU3ZTY2ODFlNTUyN2NmYjQ3ZTAwNTE=

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+*.DS_Store
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.ruby-version

@@ -0,0 +1 @@
+2.1.8

data/.travis.yml

@@ -0,0 +1,6 @@
+deploy:
+  provider: rubygems
+  api_key:
+    secure: FVH5+GPQvp39HEE+uIQYwXVFtN7Vb9gTbKXH2KCGKq2KQVC6zJv58Is1TSmqtcay6heAhLju9G3MXb9ezNP3IusP8uNPPa/1qlIV90kWasyr3Y+2Ji4LGPqyb8Tvs7BAqhsdKI+do4ELrvvYqZ11nXrAlwuSyU34KluEh7apuebUD1KJczpryQ1OpSXo/dLqca5PP7pTRbULXKg9f6elade95oSrtROjqYb3/2rG0vK3B52Sl+nTibwrprg2JQRzFGFrq8mjPAgHlY4xzwUEAxZ7+zjupJB59/Lmj1pIDaxkhTkDAMBwFYFvG9RAbDC6PKDDLNoJZpafv66NZbzczNn1LlNFLUgnNyVNHpK/a2c1ye4+wsGA6/IFJ1TssDm20lMAaOJAiBCDaOnil758RrkeCixJB9WvZ33JAF327ZsQvCn0kJS5UFNEKjnMYZxDHq4XJa4Lu1Bn6cDXba+Ro3fqgr0r5CItL4wppOLydCCoblRMd5SJu0xgr/LLBhwkWu/9WZPecDE0kBVcl8DzCz+em/P45REeOLsqHj2o+aK5c3Q21TzmhV84nXPXt+YSD4f3FqSNMngOb++eWJRhXsdURGW+i0abmeRTn/TxfSV3LTxCAibXL0WVz+THavV8gHomHtCmkUSkfDEvRYEvxJ8Y9sVjvDMfJryLiXICsXI=
+  on:
+    tags: true

data/Gemfile

@@ -0,0 +1,8 @@
+# A sample Gemfile
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rspec', '>= 3.1'
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    circuit_breaker-ruby (0.1)
+      rake (~> 10)
+      rspec (~> 3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.1.1)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.3)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  circuit_breaker-ruby!
+  rspec (>= 3.1)
+
+BUNDLED WITH
+   1.11.2

data/MIT-LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2016-2018 Vasu Adari
+
+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, sub-license, 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,47 @@
+## Circuit Breaker
+  A circuit breaker which terminates a connection or block of code from executing when it reaches the failure threshold and a percentage. Also it gets reset when a connection succeeds. It also keeps monitoring if connections are working again by checking if it has attained a time to retry.
+
+## Installation
+
+  ```
+  gem install circuit_breaker-ruby
+  ```
+
+## Usage
+
+  ```
+  circuit_breaker = CircuitBreaker::Shield.new(
+    invocation_timeout: 1,
+    failure_threshold: 2,
+    failure_threshold_percentage, 0.2,
+    retry_timeout: 10
+  )
+  circuit_breaker.protect { sleep(10) }
+  ```
+
+### Running the specs
+
+  ```
+  bundle exec rspec spec
+  ```
+
+### Configuration
+
+Add the following configuration to config/initializers/circuit_breaker.rb. These are the default values.
+
+  ```
+  CircuitBreaker.configure do |cb|
+    cb.failure_threshold = 10
+    cb.failure_threshold_percentage = 0.5
+    cb.invocation_timeout = 10
+    cb.retry_timeout = 60
+  end
+  ```
+
+### Contributing
+
+If you have any issues with circuit_breaker-ruby,
+or feature requests,
+please [add an issue](https://github.com/scripbox/circuit_breaker-ruby/issues) on GitHub
+or fork the project and send a pull request.
+Please include passing specs with all pull requests.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/circuit_breaker-ruby.gemspec

@@ -0,0 +1,22 @@
+require './lib/circuit_breaker-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.name         = 'circuit_breaker-ruby'
+  gem.version      = CircuitBreaker::VERSION
+  gem.date         = '2016-10-09'
+  gem.summary      = 'Circuit breaker for ruby'
+  gem.description  = 'Self-resetting breaker retries the protected call after a suitable interval, and it also resets when the call succeeds.'
+  gem.author       = 'Scripbox'
+  gem.email        = 'tech@sripbox.com'
+  gem.homepage     = 'https://github.com/scripbox/circuit_breaker-ruby'
+  gem.license      = 'MIT'
+
+  gem.require_path = 'lib'
+  gem.files        = `git ls-files`.split($/)
+  gem.test_files   = Dir.glob('spec/**/*')
+
+  gem.required_ruby_version = '>= 2.1.8'
+
+  gem.add_dependency 'rspec', '~> 3'
+  gem.add_dependency 'rake', '~> 10'
+end

data/lib/circuit_breaker-ruby.rb

@@ -0,0 +1,18 @@
+require 'circuit_breaker-ruby/version'
+require 'circuit_breaker-ruby/config'
+require 'circuit_breaker-ruby/shield'
+require 'timeout'
+
+module CircuitBreaker
+  class Open < StandardError; end
+
+  class << self
+    def config
+      @config ||= CircuitBreaker::Config.new
+    end
+
+    def configure
+      yield @config = CircuitBreaker::Config.new
+    end
+  end
+end

data/lib/circuit_breaker-ruby/config.rb

@@ -0,0 +1,17 @@
+module CircuitBreaker
+  class Config
+    FAILURE_THRESHOLD = 10
+    FAILURE_THRESHOLD_PERCENTAGE = 0.5
+    INVOCATION_TIMEOUT = 10
+    RETRY_TIMEOUT = 60
+
+    attr_accessor :invocation_timeout, :failure_threshold, :failure_threshold_percentage, :retry_timeout
+
+    def initialize
+      self.failure_threshold = FAILURE_THRESHOLD
+      self.failure_threshold_percentage = FAILURE_THRESHOLD_PERCENTAGE
+      self.invocation_timeout = INVOCATION_TIMEOUT
+      self.retry_timeout = RETRY_TIMEOUT
+    end
+  end
+end

data/lib/circuit_breaker-ruby/shield.rb

@@ -0,0 +1,89 @@
+module CircuitBreaker
+  class Shield
+    module States
+      OPEN = :open
+      CLOSED = :closed
+      HALF_OPEN = :half_open
+    end
+
+    attr_reader :invocation_timeout, :retry_timeout, :failure_threshold, :failure_threshold_percentage,
+                :total_count, :failure_count
+
+    def initialize(**options)
+      @failure_count = 0
+      @total_count = 0
+      @failure_threshold = options[:failure_threshold] || config.failure_threshold
+      @failure_threshold_percentage = options[:failure_threshold_percentage] || config.failure_threshold_percentage
+      @invocation_timeout = options[:invocation_timeout] || config.invocation_timeout
+      @retry_timeout = options[:retry_timeout] || config.retry_timeout
+    end
+
+    def config
+      CircuitBreaker.config
+    end
+
+    def protect(&block)
+      case prev_state = state
+      when States::CLOSED, States::HALF_OPEN
+        connect(&block).tap { update_total_count(prev_state) }
+      when States::OPEN
+        raise CircuitBreaker::Open
+      end
+    end
+
+    private
+
+    def state
+      case
+      when reached_failure_threshold? && reached_retry_timeout?
+        States::HALF_OPEN
+      when reached_failure_threshold?
+        States::OPEN
+      else
+        States::CLOSED
+      end
+    end
+
+    def reached_failure_threshold?
+      (failure_count >= failure_threshold) &&
+        (total_count != 0 &&
+          (failure_count.to_f / total_count.to_f) >= failure_threshold_percentage)
+    end
+
+    def reached_retry_timeout?
+      (Time.now - @last_failure_time) > @retry_timeout
+    end
+
+    def reset
+      @failure_count = 0
+      @state = States::CLOSED
+    end
+
+    def connect(&block)
+      begin
+        result = nil
+        Timeout::timeout(invocation_timeout) do
+          result = block.call
+          reset
+        end
+      rescue Timeout::Error => e
+        record_failure
+      end
+
+      result
+    end
+
+    def update_total_count(state)
+      if state == States::HALF_OPEN
+        @total_count = 0
+      else
+        @total_count += 1
+      end
+    end
+
+    def record_failure
+      @last_failure_time = Time.now
+      @failure_count += 1
+    end
+  end
+end

data/lib/circuit_breaker-ruby/version.rb

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

data/spec/circuit_breaker/shield_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'circuit_breaker-ruby'
+
+CircuitBreaker.configure do |cb|
+  cb.invocation_timeout = 1
+  cb.retry_timeout = 1
+  cb.failure_threshold = 1
+end
+
+describe CircuitBreaker::Shield do
+  let(:circuit_breaker_shield) { CircuitBreaker::Shield.new }
+
+  it 'goes to closed state' do
+    circuit_breaker_shield.protect { sleep(0.1) }
+
+    expect(circuit_breaker_shield.send :state).to be(CircuitBreaker::Shield::States::CLOSED)
+  end
+
+  it 'goes to open state' do
+    no_of_tries = circuit_breaker_shield.failure_threshold * 2
+    no_of_failures = no_of_tries * circuit_breaker_shield.config.failure_threshold_percentage
+    no_of_success = no_of_tries - no_of_failures
+    no_of_success.to_i.times { circuit_breaker_shield.protect { sleep(0.1) } }
+    no_of_failures.to_i.times { circuit_breaker_shield.protect { sleep(2) } }
+
+    expect(circuit_breaker_shield.send :state).to be(CircuitBreaker::Shield::States::OPEN)
+  end
+
+  it 'goes to half open state' do
+    no_of_tries = circuit_breaker_shield.failure_threshold * 2
+    no_of_failures = no_of_tries * circuit_breaker_shield.config.failure_threshold_percentage
+    no_of_success = no_of_tries - no_of_failures
+    no_of_success.to_i.times { circuit_breaker_shield.protect { sleep(0.1) } }
+    no_of_failures.to_i.times { circuit_breaker_shield.protect { sleep(2) } }
+    sleep(1)
+
+    expect(circuit_breaker_shield.send :state).to be(CircuitBreaker::Shield::States::HALF_OPEN)
+  end
+
+  it 'raises CircuitBreaker::Shield::Open' do
+     no_of_tries = circuit_breaker_shield.failure_threshold * 2
+    no_of_failures = no_of_tries * circuit_breaker_shield.config.failure_threshold_percentage
+    no_of_success = no_of_tries - no_of_failures
+    no_of_success.to_i.times { circuit_breaker_shield.protect { sleep(0.1) } }
+
+    expect { (no_of_failures.to_i + 1).times { circuit_breaker_shield.protect { sleep(2) } } }.to(
+      raise_error(CircuitBreaker::Open)
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'rspec'
+
+RSpec.configure do |config|
+  config.tty = true
+  config.color = true
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: circuit_breaker-ruby
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Scripbox
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10'
+description: Self-resetting breaker retries the protected call after a suitable interval,
+  and it also resets when the call succeeds.
+email: tech@sripbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
+- Rakefile
+- circuit_breaker-ruby.gemspec
+- lib/circuit_breaker-ruby.rb
+- lib/circuit_breaker-ruby/config.rb
+- lib/circuit_breaker-ruby/shield.rb
+- lib/circuit_breaker-ruby/version.rb
+- spec/circuit_breaker/shield_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/scripbox/circuit_breaker-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 2.1.8
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Circuit breaker for ruby
+test_files:
+- spec/circuit_breaker/shield_spec.rb
+- spec/spec_helper.rb