faraday_middleware-circuit_breaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0183813e3f33b1488951d3da7f958fb767cd483
+  data.tar.gz: fd175219034a378135773072438614392a583392
+SHA512:
+  metadata.gz: ad670e91d0be1eadd145e8cb51cf795e952aac7b09fe9bbba0399db8a87a381a47a3594880c3c561629db16de6bad86d001d28fc3cce81629fec9451bc787a64
+  data.tar.gz: 5e67a83e2035dd6f1d1fcd70ef4ccff4d8398da1ed94098c4f1f5a0ddd1f77c2a45403f18a61dae727dd92fd97c5e7d12ba9ec752c3865dc29644bb7fad02eae

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Pierre-Louis Gottfrois
+
+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,179 @@
+# FaradayMiddleware::CircuitBreaker
+
+A Faraday Middleware to handle spotty web services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'faraday_middleware-circuit_breaker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install faraday_middleware-circuit_breaker
+
+## Usage
+
+Simply add the middleware:
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker
+end
+```
+
+## Configuration
+
+### Timeout
+
+Middleware will automatically attempt to recover after a certain amount of time. This timeout is customizable:
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, timeout: 10
+end
+```
+
+The default is `60` seconds. To disable automatic recovery, set the timeout to `Float::INFINITY`. To make automatic recovery
+instantaneous, set the timeout to `0` seconds though it's not recommended.
+
+### Threshold
+
+Some services might be allowed to fail more or less frequently than others. You can configure this by setting a custom threshold:
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, threshold: 5
+end
+```
+
+The default is `3` times.
+
+### Custom fallback
+
+On a failure, middlware will render an empty `503` http response by default. You can customize the fallback response:
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, fallback: ->(env, exception) { # do something }
+end
+```
+
+Middleware will try to call the `call` method on `fallback` passing 2 arguments:
+
+- `env` -- the connection environement from faraday
+- `exception` -- the exception raised that triggered the circuit breaker
+
+You can pass a method to be eager called like this:
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, fallback: method(:foo)
+end
+
+def foo(env, exception)
+  # do something
+end
+```
+
+Whatever you chose, your method should return a valid faraday response. For example, here is the default fallback implementation:
+
+```ruby
+proc { Faraday::Response.new(status: 503, response_headers: {}) }
+```
+
+### Notifiers
+
+Middleware send notifications to standard error by default. You can customize the receivers.
+
+#### Logger
+
+To send notifications to a logger:
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, notifiers: { logger: Rails.logger }
+end
+```
+
+#### Honeybadger
+
+To send notifications to honeybadger:
+
+```ruby
+require 'honeybadger'
+
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, notifiers: { honeybadger: "api_key" }
+end
+```
+
+You'll need to have [Honeybadger](https://rubygems.org/gems/honeybadger) gem installed.
+
+#### Slack
+
+To send notifications to slack:
+
+```ruby
+require 'slack-notifier'
+
+slack = Slack::Notifier.new('http://www.example.com/webhook-url')
+
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, notifiers: { slack: slack }
+end
+```
+
+You'll need to have [Slack](https://rubygems.org/gems/slack-notifier) gem installed.
+
+#### HipChat
+
+To send notifications to hipchat:
+
+```ruby
+require 'hipchat'
+
+hip_chat = HipChat::Client.new('token')
+
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, notifiers: { hipchat: { client: hipchat, room: 'room' } }
+end
+```
+
+You'll need to have [HipChat](https://rubygems.org/gems/hipchat) gem installed.
+
+#### Bugsnag
+
+To send notifications to bugsnag:
+
+```ruby
+require 'bugsnag'
+
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, notifiers: { bugsnag: Bugsnag }
+end
+```
+
+You'll need to have [Bugsnag](https://rubygems.org/gems/bugsnag) gem installed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/faraday_middleware-circuit_breaker.
+
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "faraday_middleware/circuit_breaker"
+
+# 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/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/faraday_middleware-circuit_breaker.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'faraday_middleware/circuit_breaker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "faraday_middleware-circuit_breaker"
+  spec.version       = FaradayMiddleware::CircuitBreaker::VERSION
+  spec.authors       = ["Pierre-Louis Gottfrois"]
+  spec.email         = ["pierrelouis.gottfrois@gmail.com"]
+
+  spec.summary       = %q{Middleware to apply circuit breaker pattern.}
+  spec.description   = %q{A Faraday Middleware to handle spotty web services.}
+  spec.homepage      = "http://textmaster.com"
+  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_dependency 'faraday', '~> 0.9'
+  spec.add_dependency 'stoplight', '~> 1.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+end

data/lib/faraday_middleware/circuit_breaker/middleware.rb

@@ -0,0 +1,55 @@
+require 'faraday'
+require 'stoplight'
+require 'faraday_middleware/circuit_breaker/option_set'
+
+module FaradayMiddleware
+  module CircuitBreaker
+    class Middleware < Faraday::Middleware
+
+      def initialize(app, options = {})
+        super(app)
+        assert_valid_options!(options)
+
+        @option_set = OptionSet.new(options)
+
+        setup_notifiers
+      end
+
+      def call(env)
+        Stoplight(env.url.to_s) do
+          @app.call(env)
+        end
+        .with_timeout(option_set.timeout)
+        .with_threshold(option_set.threshold)
+        .with_fallback { |e| option_set.fallback.call(env, e) }
+        .run
+      end
+
+      private
+
+      attr_reader :option_set
+
+      def setup_notifiers
+        option_set.notifiers.each do |notifier, value|
+          case notifier.to_sym
+          when :logger
+            Stoplight::Light.default_notifiers += [Stoplight::Notifier::Logger.new(value)]
+          when :honeybadger
+            Stoplight::Light.default_notifiers += [Stoplight::Notifier::Honeybadger.new(value)]
+          when :hip_chat
+            Stoplight::Light.default_notifiers += [Stoplight::Notifier::HipChat.new(value[:client], value[:room])]
+          when :slack
+            Stoplight::Light.default_notifiers += [Stoplight::Notifier::Slack.new(value)]
+          when :bugsnag
+            Stoplight::Light.default_notifiers += [Stoplight::Notifier::Bugsnag.new(value)]
+          end
+        end
+      end
+
+      def assert_valid_options!(options)
+        OptionSet.validate!(options)
+      end
+
+    end
+  end
+end

data/lib/faraday_middleware/circuit_breaker/option_set.rb

@@ -0,0 +1,30 @@
+require 'faraday'
+require 'stoplight'
+require 'faraday_middleware/circuit_breaker/option_set'
+
+module FaradayMiddleware
+  module CircuitBreaker
+    class OptionSet
+
+      VALID_OPTIONS = %w(timeout threshold fallback notifiers)
+
+      attr_accessor :timeout, :threshold, :fallback, :notifiers
+
+      def initialize(options = {})
+        @timeout   = options[:timeout] || 60.0
+        @threshold = options[:threshold] || 3
+        @fallback  = options[:fallback] || proc { Faraday::Response.new(status: 503, response_headers: {}) }
+        @notifiers = options[:notifiers] || {}
+      end
+
+      def self.validate!(options)
+        options.each_key do |key|
+          unless VALID_OPTIONS.include?(key.to_s)
+            fail ArgumentError.new("Unknown option: #{key}. Valid options are :#{VALID_OPTIONS.join(', ')}")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/faraday_middleware/circuit_breaker/version.rb

@@ -0,0 +1,5 @@
+module FaradayMiddleware
+  module CircuitBreaker
+    VERSION = "0.1.0"
+  end
+end

data/lib/faraday_middleware/circuit_breaker.rb

@@ -0,0 +1,14 @@
+require 'faraday_middleware/circuit_breaker/version'
+require 'faraday_middleware/circuit_breaker/middleware'
+
+module FaradayMiddleware
+  module CircuitBreaker
+
+    if Faraday.respond_to?(:register_middleware)
+      Faraday.register_middleware circuit_breaker: FaradayMiddleware::CircuitBreaker::Middleware
+    elsif Faraday::Middleware.respond_to?(:register_middleware)
+      Faraday::Middleware.register_middleware circuit_breaker: FaradayMiddleware::CircuitBreaker::Middleware
+    end
+
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: faraday_middleware-circuit_breaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pierre-Louis Gottfrois
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: stoplight
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !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: rspec
+  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: A Faraday Middleware to handle spotty web services.
+email:
+- pierrelouis.gottfrois@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- faraday_middleware-circuit_breaker.gemspec
+- lib/faraday_middleware/circuit_breaker.rb
+- lib/faraday_middleware/circuit_breaker/middleware.rb
+- lib/faraday_middleware/circuit_breaker/option_set.rb
+- lib/faraday_middleware/circuit_breaker/version.rb
+homepage: http://textmaster.com
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Middleware to apply circuit breaker pattern.
+test_files: []
+has_rdoc: