eventmachine-circuit_breaker 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6547a8dbd0d172bbab8aa845e8f6a710827b4ab7
+  data.tar.gz: 8d7055f41829d12155f7ec5a9303c15df31b6333
+SHA512:
+  metadata.gz: b4505e388cb189625c17b8f7847703cf24b74bb609d85b62a60c29db55f7e60d8246f3618a05360c89b77969aaab92432169e5599d2934fb2153113fda4952e2
+  data.tar.gz: 86b765fed2e48efaa4e3a13f45caba5008acc6527f012d96367643493b38367e2ec04e3d3bd54994f789f42a6392389d296e428f295d7d0a0123080d6b142c79

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.15.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at darren@darrencoxall.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in eventmachine-circuit_breaker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Darren Coxall
+
+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,64 @@
+# EventMachine::CircuitBreaker
+
+[![Build Status](https://travis-ci.org/dcoxall/eventmachine-circuit_breaker.svg?branch=master)](https://travis-ci.org/dcoxall/eventmachine-circuit_breaker)
+
+**This project is still in active development**
+
+This library is meant to provide a simple way to enable the circuit breaker pattern to em-http requests by providing some middleware that can prevent requests and manage circuit state based on response parameters.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventmachine-circuit_breaker'
+```
+
+And then execute:
+
+    $ bundle
+
+
+## Usage
+
+```ruby
+require 'eventmachine/circuit_breaker'
+require 'em-http-request'
+
+# circuit breaker for all requests
+EventMachine.run do
+  EventMachine::HttpRequest.use EventMachine::CircuitBreaker
+  # now you can use em-http-request as normal
+end
+
+# circuit breaker per connection
+EventMachine.run do
+  connection = EventMachine::HttpRequest.new("http://example.com")
+  connection.use EventMachine::CircuitBreaker
+  connection.get
+  # ...
+end
+
+# sharing circuit state
+EventMachine.run do
+  circuit_strategy = EventMachine::CircuitBreaker::Startegy::Basic.new
+
+  connection_1 = EventMachine::HttpRequest.new("http://example.com/foo")
+  connection_1.use EventMachine::CircuitBreaker, strategy: circuit_strategy
+  connection_1.get
+  # ...
+
+  connection_2 = EventMachine::HttpRequest.new("http://example.com/bar")
+  connection_2.use EventMachine::CircuitBreaker, strategy: circuit_strategy
+  connection_2.get
+  # ...
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dcoxall/eventmachine-circuit_breaker.

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/bin/console

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

data/bin/setup

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

data/eventmachine-circuit_breaker.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "eventmachine/circuit_breaker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "eventmachine-circuit_breaker"
+  spec.version       = EventMachine::CircuitBreaker::VERSION
+  spec.authors       = ["Darren Coxall"]
+  spec.email         = ["darren@darrencoxall.com"]
+
+  spec.summary       = %q{A circuit breaker designed for use with EventMachine.}
+  spec.description   = %q{A circuit breaker for use with eventmachine and em-http-request.}
+  spec.homepage      = "https://github.com/dcoxall/eventmachine-circuit_breaker"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "eventmachine"
+  spec.add_runtime_dependency "em-http-request"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 2.0"
+end

data/lib/eventmachine/circuit_breaker.rb

@@ -0,0 +1,12 @@
+require "eventmachine/circuit_breaker/version"
+require "eventmachine/circuit_breaker/breaker"
+require "eventmachine/circuit_breaker/strategy/basic"
+
+module EventMachine
+  module CircuitBreaker
+    def new(options = {})
+      Breaker.new(options[:strategy])
+    end
+    module_function :new
+  end
+end

data/lib/eventmachine/circuit_breaker/breaker.rb

@@ -0,0 +1,26 @@
+module EventMachine
+  module CircuitBreaker
+    class Breaker
+      def initialize(strategy = Strategy::Basic.new)
+        @strategy = strategy
+      end
+
+      def request(client, headers, body)
+        close!(client) if strategy.open?
+      end
+
+      def response(client)
+        strategy.handle_response(client)
+        close!(client) if strategy.open?
+      end
+
+      private
+
+      attr_reader :strategy
+
+      def close!(client, reason: 'circuit open')
+        client.close(reason)
+      end
+    end
+  end
+end

data/lib/eventmachine/circuit_breaker/strategy/basic.rb

@@ -0,0 +1,48 @@
+module EventMachine
+  module CircuitBreaker
+    module Strategy
+      class Basic
+        def initialize(failure_count: 5, recovery_time: 30)
+          close!
+          @failure_limit = failure_count
+          @recovery_time = recovery_time
+        end
+
+        def open?
+          @state == :open
+        end
+
+        def handle_response(client)
+          increment_failures if client.response_header.server_error?
+          close! if half_open? && client.response_header.successful?
+        end
+
+        private
+
+        def half_open?
+          @state == :half_open
+        end
+
+        def increment_failures
+          @failures += 1
+          open! if @failures >= @failure_limit
+        end
+
+        def half_open!
+          @state = :half_open
+        end
+
+        def open!
+          @state = :open
+
+          EventMachine.add_timer(@recovery_time) { half_open! }
+        end
+
+        def close!
+          @state = :closed
+          @failures = 0
+        end
+      end
+    end
+  end
+end

data/lib/eventmachine/circuit_breaker/version.rb

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

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: eventmachine-circuit_breaker
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Darren Coxall
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: em-http-request
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A circuit breaker for use with eventmachine and em-http-request.
+email:
+- darren@darrencoxall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- eventmachine-circuit_breaker.gemspec
+- lib/eventmachine/circuit_breaker.rb
+- lib/eventmachine/circuit_breaker/breaker.rb
+- lib/eventmachine/circuit_breaker/strategy/basic.rb
+- lib/eventmachine/circuit_breaker/version.rb
+homepage: https://github.com/dcoxall/eventmachine-circuit_breaker
+licenses: []
+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.6.13
+signing_key: 
+specification_version: 4
+summary: A circuit breaker designed for use with EventMachine.
+test_files: []