disyuntor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7ab5e6badbc47e7babf6bd794c93b14c826458bd
+  data.tar.gz: a8b0a6b6fc72713b987ae48fb091364471568d08
+SHA512:
+  metadata.gz: 3bd3266ebe4e42789dbeac531495e08544a2959ed4b62b39e900a312f6cb1084bbab73f8f02d21aac1df44303d614f077ddb8324642187f9f866e84a31ef2264
+  data.tar.gz: 5d2350086bb03289c4510998d7fa806fd3e7c443c7b2615f77750432a8e2304c37dda443f6d8454a8470d2942981d8ddecfce77131e0dfa5c5f809d083137046

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Leandro López
+
+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,50 @@
+# Simple Circuit Breaker Pattern in Ruby
+
+[![Join the chat at https://gitter.im/inkel/disyuntor](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/inkel/disyuntor?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+This gem implements a very simple class to deal with the Circuit Breaker Pattern as described by [Michael T. Nygard](http://www.michaelnygard.com/) in his amazing and highly recommended [Release It! - Design and Deploy Production-Ready Software](http://www.amazon.com/Release-It-Production-Ready-Pragmatic-Programmers/dp/0978739213).
+
+## Usage
+
+```ruby
+require "disyuntor"
+
+options = {
+  # Trip circuit after 10 errors
+  threshold: 10,
+  # Wait 5 seconds before trying again
+  timeout: 5
+}
+
+circuit_breaker = Disyuntor.new(options)
+
+res = circuit_breaker.try do
+  # …your potentially failing operation…
+end
+```
+
+By default, when the circuit is open, `Disyuntor#try` will fail with a `Disyuntor::CircuitOpenError`. This behavior can be changed by passing a `Proc` in the `on_circuit_open` option or method.
+
+If you want to use it as a [`Rack`](https://github.com/rack/rack) middleware, add the following in your `config.ru`:
+
+```ruby
+require "rack/disyuntor"
+
+use Rack::Disyuntor, threshold: 10, timeout: 5
+```
+
+This will start responding with `[503, { "Content-Type" => "text/plain", ["Service Unavailable"]]` when the circuit is open.
+
+## Custom actions when circuit is open
+
+Every time the circuit is open, the `#on_circuit_open` method is called, passing the circuit as its argument. This allows customizing the failure mode of your circuit:
+
+```ruby
+circuit_breaker = Disyuntor.new(threshold: 3, timeout: 5)
+
+circuit_breaker.on_circuit_open do |c|
+  "Circuit was open at #{c.opened_at}"
+end
+```
+
+The value of the block will be returned as the value of `Disyuntor#try` when it fails.

data/disyuntor.gemspec

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+
+require_relative "lib/disyuntor/version"
+
+Gem::Specification.new do |s|
+  s.name        = "disyuntor"
+  s.version     = Disyuntor::VERSION
+  s.summary     = "Circuit Breaker Pattern in Ruby"
+  s.description = "Simple implementation of Michael T. Nygard's Circuit Breaker Pattern"
+  s.authors     = ["Leandro López"]
+  s.email       = ["inkel.ar@gmail.com"]
+  s.homepage    = "http://github.com/inkel/disyuntor"
+  s.license     = "MIT"
+
+  s.required_ruby_version = '>= 2.0'
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_dependency "micromachine", "1.2.0"
+end

data/lib/disyuntor.rb

@@ -0,0 +1,92 @@
+require "micromachine"
+
+class Disyuntor
+  CircuitOpenError = Class.new(RuntimeError)
+
+  attr_reader :failures, :opened_at, :threshold, :timeout
+
+  def initialize(threshold: 5, timeout: 10, &block)
+    @threshold = threshold
+    @timeout   = timeout
+
+    @on_circuit_open = if block_given?
+                         block
+                       else
+                         Proc.new{ fail CircuitOpenError }
+                       end
+
+    close!
+  end
+
+  def states
+    @states ||= MicroMachine.new(:closed).tap do |fsm|
+      fsm.when(:trip,  :half_open => :open,   :closed => :open)
+      fsm.when(:reset, :half_open => :closed, :closed => :closed)
+      fsm.when(:try,   :open      => :half_open)
+
+      fsm.on(:open) do
+        @opened_at = Time.now.to_i
+      end
+
+      fsm.on(:closed) do
+        @opened_at = nil
+        @failures  = 0
+      end
+    end
+  end
+
+  def close!     () states.trigger!(:reset) end
+  def open!      () states.trigger!(:trip)  end
+  def half_open! () states.trigger!(:try)   end
+
+  def state      () states.state        end
+
+  def closed?    () state == :closed    end
+  def open?      () state == :open      end
+  def half_open? () state == :half_open end
+
+  def timed_out?
+    open? && Time.now.to_i > (@opened_at + @timeout)
+  end
+
+  def try(&block)
+    half_open! if timed_out?
+
+    case
+    when closed?    then on_circuit_closed(&block)
+    when half_open? then on_circuit_half_open(&block)
+    when open?      then on_circuit_open
+    else
+      fail RuntimeError, "Invalid state! #{state}"
+    end
+  end
+
+  def on_circuit_closed(&block)
+    ret = block.call
+  rescue
+    @failures += 1
+    open! if @failures > @threshold
+    raise
+  else
+    close!
+    ret
+  end
+
+  def on_circuit_half_open(&block)
+    ret = block.call
+  rescue
+    open!
+    raise
+  else
+    close!
+    ret
+  end
+
+  def on_circuit_open(&block)
+    if block_given?
+      @on_circuit_open = block
+    else
+      @on_circuit_open.(self)
+    end
+  end
+end

data/lib/disyuntor/version.rb

@@ -0,0 +1,3 @@
+class Disyuntor
+  VERSION = "0.1.0"
+end

data/lib/rack/disyuntor.rb

@@ -0,0 +1,20 @@
+require "rack"
+require_relative "../disyuntor"
+
+class Rack::Disyuntor
+  def initialize(app, options={})
+    @app = app
+
+    options[:on_circuit_open] ||= -> { circuit_open_response }
+
+    @circuit_breaker = Disyuntor.new(options)
+  end
+
+  def call(env)
+    @circuit_breaker.try { @app.call(env) }
+  end
+
+  def circuit_open_response
+    [503, { "Content-Type" => "text/plain" }, ["Service Unavailable"]]
+  end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: disyuntor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Leandro López
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: micromachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+description: Simple implementation of Michael T. Nygard's Circuit Breaker Pattern
+email:
+- inkel.ar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- disyuntor.gemspec
+- lib/disyuntor.rb
+- lib/disyuntor/version.rb
+- lib/rack/disyuntor.rb
+homepage: http://github.com/inkel/disyuntor
+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.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: Circuit Breaker Pattern in Ruby
+test_files: []