resilient 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 822421a58f373992d96937a055b287a2f633ef1b
+  data.tar.gz: 6e29f01491cce3b1244998c9dc38758db56bc58d
+SHA512:
+  metadata.gz: d6952a74ffed454c5c1909991db5dfd056dfb5f26932bc1537776cee363dcc55cbeff6b549da1ac112f124437032b92d24c071e516a9702bc72bd747187a3522
+  data.tar.gz: 9d1edae9fb8f13856fc988af0b257a7d2d2e184a04068e5dc1f054d945666c49cbe934ee5ff23e8a983ed074b27f527f5258bdcfced828ef420434bfd5669d8b

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.4
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in resilient.gemspec
+gemspec
+
+gem "guard", "~> 2.13.0"
+gem "guard-minitest", "~> 2.4.4"
+gem "timecop", "0.8.0"

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+guard :minitest do
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$}) { "test" }
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$}) { "test" }
+  watch(%r{^test/test_helper\.rb$}) { "test" }
+  watch(%r{test/support/.*}) { "test" }
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Nunemaker
+
+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,105 @@
+# Resilient
+
+Some tools for resilient in ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "resilient"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resilient
+
+## Usage
+
+```ruby
+require "resilient/circuit_breaker"
+
+# default config for circuit
+circuit_breaker = Resilient::CircuitBreaker.new
+if circuit_breaker.request_allowed?
+  begin
+    # do something expensive
+    circuit_breaker.mark_success
+  rescue => boom
+    # do fallback
+    circuit_breaker.mark_failure
+  end
+else
+  # do fallback
+end
+```
+
+customize config of circuit:
+
+```ruby
+config = Resilient::CircuitBreaker::RollingConfig.new({
+  # at what percentage of errors should we open the circuit
+  error_threshold_percentage: 50,
+  # do not try request again for 5 seconds
+  sleep_window_seconds: 5,
+  # do not open circuit until at least 5 requests have happened
+  request_volume_threshold: 5,
+})
+circuit_breaker = Resilient::CircuitBreaker.new(config: config)
+# etc etc etc
+```
+
+force the circuit to be always open:
+
+```ruby
+config = Resilient::CircuitBreaker::RollingConfig.new(force_open: true)
+circuit_breaker = Resilient::CircuitBreaker.new(config: config)
+# etc etc etc
+```
+
+force the circuit to be always closed:
+
+```ruby
+config = Resilient::CircuitBreaker::RollingConfig.new(force_closed: true)
+circuit_breaker = Resilient::CircuitBreaker.new(config: config)
+# etc etc etc
+```
+
+customize rolling window to be 10 buckets of 1 second each (10 seconds in all):
+
+```ruby
+metrics = Resilient::CircuitBreaker::RollingMetrics.new({
+  number_of_buckets: 10,
+  bucket_size_in_seconds: 1,
+})
+circuit_breaker = Resilient::CircuitBreaker.new(metrics: metrics)
+# etc etc etc
+```
+
+## Development
+
+```bash
+# install dependencies
+script/bootstrap
+
+# run tests
+script/test
+
+# ...or to auto run tests with guard
+script/watch
+
+# to get a shell to play in
+script/console
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jnunemaker/resilient.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

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

data/TODO.md

@@ -0,0 +1,4 @@
+- [ ] instrumentation
+- [ ] add duration to mark success/failure; use it for tracking latency and for making circuit decisions
+- [ ] add timeout to metrics separate from failures (if we add duration)?
+- [ ] should force closed still instrument and all that so we can test in prod before enabling or should we allow enabling/disabling with instrumentation in a different way?

data/lib/resilient/circuit_breaker/rolling_config.rb

@@ -0,0 +1,23 @@
+module Resilient
+  class CircuitBreaker
+    class RollingConfig
+      attr_reader :error_threshold_percentage
+      attr_reader :sleep_window_seconds
+      attr_reader :request_volume_threshold
+      attr_reader :force_open
+      attr_reader :force_closed
+      attr_reader :number_of_buckets
+      attr_reader :bucket_size_in_seconds
+
+      def initialize(options = {})
+        @force_open = options.fetch(:force_open, false)
+        @force_closed = options.fetch(:force_closed, false)
+        @sleep_window_seconds = options.fetch(:sleep_window_seconds, 5)
+        @request_volume_threshold = options.fetch(:request_volume_threshold, 20)
+        @error_threshold_percentage = options.fetch(:error_threshold_percentage, 50)
+        @number_of_buckets = options.fetch(:number_of_buckets, 6)
+        @bucket_size_in_seconds = options.fetch(:bucket_size_in_seconds, 10)
+      end
+    end
+  end
+end

data/lib/resilient/circuit_breaker/rolling_metrics/bucket.rb

@@ -0,0 +1,37 @@
+module Resilient
+  class CircuitBreaker
+    class RollingMetrics
+      class Bucket
+        attr_reader :successes
+        attr_reader :failures
+
+        def initialize(timestamp_start, timestamp_end)
+          @timestamp_start = timestamp_start
+          @timestamp_end = timestamp_end
+          @successes = 0
+          @failures = 0
+        end
+
+        def mark_success
+          @successes += 1
+        end
+
+        def mark_failure
+          @failures += 1
+        end
+
+        def requests
+          @successes + @failures
+        end
+
+        def include?(timestamp)
+          timestamp >= @timestamp_start && timestamp <= @timestamp_end
+        end
+
+        def prune?(timestamp)
+          @timestamp_end <= timestamp
+        end
+      end
+    end
+  end
+end

data/lib/resilient/circuit_breaker/rolling_metrics.rb

@@ -0,0 +1,73 @@
+require "resilient/circuit_breaker/rolling_metrics/bucket"
+
+module Resilient
+  class CircuitBreaker
+    class RollingMetrics
+      attr_reader :number_of_buckets
+      attr_reader :bucket_size_in_seconds
+      attr_reader :buckets
+
+      def initialize(options = {})
+        @number_of_buckets = options.fetch(:number_of_buckets, 6)
+        @bucket_size_in_seconds = options.fetch(:bucket_size_in_seconds, 10)
+        reset
+      end
+
+      def mark_success
+        timestamp = Time.now.to_i
+        bucket(timestamp).mark_success
+        prune_buckets(timestamp)
+        nil
+      end
+
+      def mark_failure
+        timestamp = Time.now.to_i
+        bucket(timestamp).mark_failure
+        prune_buckets(timestamp)
+        nil
+      end
+
+      def successes
+        prune_buckets
+        @buckets.inject(0) { |sum, bucket| sum += bucket.successes }
+      end
+
+      def failures
+        prune_buckets
+        @buckets.inject(0) { |sum, bucket| sum += bucket.failures }
+      end
+
+      def requests
+        prune_buckets
+        @buckets.inject(0) { |sum, bucket| sum += bucket.requests }
+      end
+
+      def error_percentage
+        return 0 if failures == 0 || requests == 0
+        ((failures / requests.to_f) * 100).to_i
+      end
+
+      def reset
+        @buckets = []
+        nil
+      end
+
+      private
+
+      def bucket(timestamp)
+        bucket = @buckets.detect { |bucket| bucket.include?(timestamp) }
+        return bucket if bucket
+
+        bucket = Bucket.new(timestamp, timestamp + @bucket_size_in_seconds - 1)
+        @buckets.push bucket
+
+        bucket
+      end
+
+      def prune_buckets(timestamp = Time.now.to_i)
+        cutoff = timestamp - (@number_of_buckets * @bucket_size_in_seconds)
+        @buckets.delete_if { |bucket| bucket.prune?(cutoff) }
+      end
+    end
+  end
+end

data/lib/resilient/circuit_breaker.rb

@@ -0,0 +1,92 @@
+require "resilient/circuit_breaker/rolling_metrics"
+require "resilient/circuit_breaker/rolling_config"
+
+module Resilient
+  class CircuitBreaker
+    attr_reader :metrics
+    attr_reader :config
+    attr_reader :open
+    attr_reader :opened_or_last_checked_at_epoch
+
+    def initialize(open: false, config: RollingConfig.new, metrics: RollingMetrics.new)
+      @open = open
+      @opened_or_last_checked_at_epoch = 0
+      @config = config
+      @metrics = if metrics
+        metrics
+      else
+        RollingMetrics.new({
+          number_of_buckets: config.number_of_buckets,
+          bucket_size_in_seconds: config.bucket_size_in_seconds,
+        })
+      end
+    end
+
+    def allow_request?
+      return false if @config.force_open
+      return true if @config.force_closed
+
+      closed? || allow_single_request?
+    end
+
+    def mark_success
+      close_circuit if @open
+    end
+
+    def mark_failure
+      @metrics.mark_failure
+    end
+
+    def reset
+      @open = false
+      @opened_or_last_checked_at_epoch = 0
+      @metrics.reset
+      nil
+    end
+
+    private
+
+    def open_circuit
+      @open = true
+      @opened_or_last_checked_at_epoch = Time.now.to_i
+    end
+
+    def close_circuit
+      @open = false
+      @opened_or_last_checked_at_epoch = 0
+      @metrics.reset
+    end
+
+    def under_request_volume_threshold?
+      @metrics.requests < @config.request_volume_threshold
+    end
+
+    def under_error_threshold_percentage?
+      @metrics.error_percentage < @config.error_threshold_percentage
+    end
+
+    def open?
+      return true if @open
+      return false if under_request_volume_threshold?
+      return false if under_error_threshold_percentage?
+
+      open_circuit
+    end
+
+    def closed?
+      !open?
+    end
+
+    def allow_single_request?
+      try_next_request_at = @opened_or_last_checked_at_epoch + @config.sleep_window_seconds
+      now = Time.now.to_i
+
+      if @open && now > try_next_request_at
+        @opened_or_last_checked_at_epoch = now + @config.sleep_window_seconds
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/resilient/version.rb

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

data/lib/resilient.rb

@@ -0,0 +1,4 @@
+require "resilient/version"
+
+module Resilient
+end

data/resilient.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resilient/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resilient"
+  spec.version       = Resilient::VERSION
+  spec.authors       = ["John Nunemaker"]
+  spec.email         = ["nunemaker@gmail.com"]
+
+  spec.summary       = %q{toolkit for resilient ruby apps}
+  spec.homepage      = "https://github.com/jnunemaker/resilient"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.8"
+end

data/script/bootstrap

@@ -0,0 +1 @@
+bundle --quiet

data/script/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "resilient"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/script/release

@@ -0,0 +1,42 @@
+#!/bin/sh
+#/ Usage: release
+#/
+#/ Tag the version in the repo and push the gem.
+#/
+
+set -e
+cd $(dirname "$0")/..
+
+[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
+    grep '^#/' <"$0"| cut -c4-
+    exit 0
+}
+
+gem_name=resilient
+
+# Build a new gem archive.
+rm -rf $gem_name-*.gem
+gem build -q $gem_name.gemspec
+
+# Make sure we're on the master branch.
+(git branch | grep -q '* master') || {
+  echo "Only release from the master branch."
+  exit 1
+}
+
+# Figure out what version we're releasing.
+tag=v`ls $gem_name-*.gem | sed "s/^$gem_name-\(.*\)\.gem$/\1/"`
+
+echo "Releasing $tag"
+
+# Make sure we haven't released this version before.
+git fetch -t origin
+
+(git tag -l | grep -q "$tag") && {
+  echo "Whoops, there's already a '${tag}' tag."
+  exit 1
+}
+
+# Tag it and bag it.
+gem push $gem_name-*.gem && git tag "$tag" &&
+  git push origin master && git push origin "$tag"

data/script/test

@@ -0,0 +1,25 @@
+#!/bin/sh
+#/ Usage: test [individual test file]
+#/
+#/ Bootstrap and run all tests or an individual test.
+#/
+#/ Examples:
+#/
+#/   # run all tests
+#/   test
+#/
+#/   # run individual test
+#/   test test/controller_instrumentation_test.rb
+#/
+
+set -e
+cd $(dirname "$0")/..
+
+[ "$1" = "--help" -o "$1" = "-h" -o "$1" = "help" ] && {
+    grep '^#/' <"$0"| cut -c4-
+    exit 0
+}
+
+ruby -I lib -I test -r rubygems \
+  -e 'require "bundler/setup"' \
+  -e '(ARGV.empty? ? Dir["test/**/*_test.rb"] : ARGV).each { |f| load f }' -- "$@"

data/script/watch

@@ -0,0 +1 @@
+bundle exec guard

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: resilient
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Nunemaker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+description: 
+email:
+- nunemaker@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- lib/resilient.rb
+- lib/resilient/circuit_breaker.rb
+- lib/resilient/circuit_breaker/rolling_config.rb
+- lib/resilient/circuit_breaker/rolling_metrics.rb
+- lib/resilient/circuit_breaker/rolling_metrics/bucket.rb
+- lib/resilient/version.rb
+- resilient.gemspec
+- script/bootstrap
+- script/console
+- script/release
+- script/test
+- script/watch
+homepage: https://github.com/jnunemaker/resilient
+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.2
+signing_key: 
+specification_version: 4
+summary: toolkit for resilient ruby apps
+test_files: []