faraday_middleware-circuit_breaker 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +3 -0
- data/.travis.yml +4 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +179 -0
- data/Rakefile +6 -0
- data/bin/console +14 -0
- data/bin/setup +7 -0
- data/faraday_middleware-circuit_breaker.gemspec +28 -0
- data/lib/faraday_middleware/circuit_breaker/middleware.rb +55 -0
- data/lib/faraday_middleware/circuit_breaker/option_set.rb +30 -0
- data/lib/faraday_middleware/circuit_breaker/version.rb +5 -0
- data/lib/faraday_middleware/circuit_breaker.rb +14 -0
- metadata +129 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b0183813e3f33b1488951d3da7f958fb767cd483
|
4
|
+
data.tar.gz: fd175219034a378135773072438614392a583392
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: ad670e91d0be1eadd145e8cb51cf795e952aac7b09fe9bbba0399db8a87a381a47a3594880c3c561629db16de6bad86d001d28fc3cce81629fec9451bc787a64
|
7
|
+
data.tar.gz: 5e67a83e2035dd6f1d1fcd70ef4ccff4d8398da1ed94098c4f1f5a0ddd1f77c2a45403f18a61dae727dd92fd97c5e7d12ba9ec752c3865dc29644bb7fad02eae
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2015 Pierre-Louis Gottfrois
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,179 @@
|
|
1
|
+
# FaradayMiddleware::CircuitBreaker
|
2
|
+
|
3
|
+
A Faraday Middleware to handle spotty web services.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'faraday_middleware-circuit_breaker'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install faraday_middleware-circuit_breaker
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Simply add the middleware:
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
27
|
+
c.use :circuit_breaker
|
28
|
+
end
|
29
|
+
```
|
30
|
+
|
31
|
+
## Configuration
|
32
|
+
|
33
|
+
### Timeout
|
34
|
+
|
35
|
+
Middleware will automatically attempt to recover after a certain amount of time. This timeout is customizable:
|
36
|
+
|
37
|
+
```ruby
|
38
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
39
|
+
c.use :circuit_breaker, timeout: 10
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
The default is `60` seconds. To disable automatic recovery, set the timeout to `Float::INFINITY`. To make automatic recovery
|
44
|
+
instantaneous, set the timeout to `0` seconds though it's not recommended.
|
45
|
+
|
46
|
+
### Threshold
|
47
|
+
|
48
|
+
Some services might be allowed to fail more or less frequently than others. You can configure this by setting a custom threshold:
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
52
|
+
c.use :circuit_breaker, threshold: 5
|
53
|
+
end
|
54
|
+
```
|
55
|
+
|
56
|
+
The default is `3` times.
|
57
|
+
|
58
|
+
### Custom fallback
|
59
|
+
|
60
|
+
On a failure, middlware will render an empty `503` http response by default. You can customize the fallback response:
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
64
|
+
c.use :circuit_breaker, fallback: ->(env, exception) { # do something }
|
65
|
+
end
|
66
|
+
```
|
67
|
+
|
68
|
+
Middleware will try to call the `call` method on `fallback` passing 2 arguments:
|
69
|
+
|
70
|
+
- `env` -- the connection environement from faraday
|
71
|
+
- `exception` -- the exception raised that triggered the circuit breaker
|
72
|
+
|
73
|
+
You can pass a method to be eager called like this:
|
74
|
+
|
75
|
+
```ruby
|
76
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
77
|
+
c.use :circuit_breaker, fallback: method(:foo)
|
78
|
+
end
|
79
|
+
|
80
|
+
def foo(env, exception)
|
81
|
+
# do something
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
Whatever you chose, your method should return a valid faraday response. For example, here is the default fallback implementation:
|
86
|
+
|
87
|
+
```ruby
|
88
|
+
proc { Faraday::Response.new(status: 503, response_headers: {}) }
|
89
|
+
```
|
90
|
+
|
91
|
+
### Notifiers
|
92
|
+
|
93
|
+
Middleware send notifications to standard error by default. You can customize the receivers.
|
94
|
+
|
95
|
+
#### Logger
|
96
|
+
|
97
|
+
To send notifications to a logger:
|
98
|
+
|
99
|
+
```ruby
|
100
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
101
|
+
c.use :circuit_breaker, notifiers: { logger: Rails.logger }
|
102
|
+
end
|
103
|
+
```
|
104
|
+
|
105
|
+
#### Honeybadger
|
106
|
+
|
107
|
+
To send notifications to honeybadger:
|
108
|
+
|
109
|
+
```ruby
|
110
|
+
require 'honeybadger'
|
111
|
+
|
112
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
113
|
+
c.use :circuit_breaker, notifiers: { honeybadger: "api_key" }
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
You'll need to have [Honeybadger](https://rubygems.org/gems/honeybadger) gem installed.
|
118
|
+
|
119
|
+
#### Slack
|
120
|
+
|
121
|
+
To send notifications to slack:
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
require 'slack-notifier'
|
125
|
+
|
126
|
+
slack = Slack::Notifier.new('http://www.example.com/webhook-url')
|
127
|
+
|
128
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
129
|
+
c.use :circuit_breaker, notifiers: { slack: slack }
|
130
|
+
end
|
131
|
+
```
|
132
|
+
|
133
|
+
You'll need to have [Slack](https://rubygems.org/gems/slack-notifier) gem installed.
|
134
|
+
|
135
|
+
#### HipChat
|
136
|
+
|
137
|
+
To send notifications to hipchat:
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
require 'hipchat'
|
141
|
+
|
142
|
+
hip_chat = HipChat::Client.new('token')
|
143
|
+
|
144
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
145
|
+
c.use :circuit_breaker, notifiers: { hipchat: { client: hipchat, room: 'room' } }
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
You'll need to have [HipChat](https://rubygems.org/gems/hipchat) gem installed.
|
150
|
+
|
151
|
+
#### Bugsnag
|
152
|
+
|
153
|
+
To send notifications to bugsnag:
|
154
|
+
|
155
|
+
```ruby
|
156
|
+
require 'bugsnag'
|
157
|
+
|
158
|
+
Faraday.new(url: 'http://foo.com') do |c|
|
159
|
+
c.use :circuit_breaker, notifiers: { bugsnag: Bugsnag }
|
160
|
+
end
|
161
|
+
```
|
162
|
+
|
163
|
+
You'll need to have [Bugsnag](https://rubygems.org/gems/bugsnag) gem installed.
|
164
|
+
|
165
|
+
## Development
|
166
|
+
|
167
|
+
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.
|
168
|
+
|
169
|
+
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).
|
170
|
+
|
171
|
+
## Contributing
|
172
|
+
|
173
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/faraday_middleware-circuit_breaker.
|
174
|
+
|
175
|
+
|
176
|
+
## License
|
177
|
+
|
178
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
179
|
+
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "faraday_middleware/circuit_breaker"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'faraday_middleware/circuit_breaker/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "faraday_middleware-circuit_breaker"
|
8
|
+
spec.version = FaradayMiddleware::CircuitBreaker::VERSION
|
9
|
+
spec.authors = ["Pierre-Louis Gottfrois"]
|
10
|
+
spec.email = ["pierrelouis.gottfrois@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{Middleware to apply circuit breaker pattern.}
|
13
|
+
spec.description = %q{A Faraday Middleware to handle spotty web services.}
|
14
|
+
spec.homepage = "http://textmaster.com"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.bindir = "exe"
|
19
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_dependency 'faraday', '~> 0.9'
|
23
|
+
spec.add_dependency 'stoplight', '~> 1.2'
|
24
|
+
|
25
|
+
spec.add_development_dependency 'bundler', '~> 1.10'
|
26
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
27
|
+
spec.add_development_dependency 'rspec'
|
28
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
require 'stoplight'
|
3
|
+
require 'faraday_middleware/circuit_breaker/option_set'
|
4
|
+
|
5
|
+
module FaradayMiddleware
|
6
|
+
module CircuitBreaker
|
7
|
+
class Middleware < Faraday::Middleware
|
8
|
+
|
9
|
+
def initialize(app, options = {})
|
10
|
+
super(app)
|
11
|
+
assert_valid_options!(options)
|
12
|
+
|
13
|
+
@option_set = OptionSet.new(options)
|
14
|
+
|
15
|
+
setup_notifiers
|
16
|
+
end
|
17
|
+
|
18
|
+
def call(env)
|
19
|
+
Stoplight(env.url.to_s) do
|
20
|
+
@app.call(env)
|
21
|
+
end
|
22
|
+
.with_timeout(option_set.timeout)
|
23
|
+
.with_threshold(option_set.threshold)
|
24
|
+
.with_fallback { |e| option_set.fallback.call(env, e) }
|
25
|
+
.run
|
26
|
+
end
|
27
|
+
|
28
|
+
private
|
29
|
+
|
30
|
+
attr_reader :option_set
|
31
|
+
|
32
|
+
def setup_notifiers
|
33
|
+
option_set.notifiers.each do |notifier, value|
|
34
|
+
case notifier.to_sym
|
35
|
+
when :logger
|
36
|
+
Stoplight::Light.default_notifiers += [Stoplight::Notifier::Logger.new(value)]
|
37
|
+
when :honeybadger
|
38
|
+
Stoplight::Light.default_notifiers += [Stoplight::Notifier::Honeybadger.new(value)]
|
39
|
+
when :hip_chat
|
40
|
+
Stoplight::Light.default_notifiers += [Stoplight::Notifier::HipChat.new(value[:client], value[:room])]
|
41
|
+
when :slack
|
42
|
+
Stoplight::Light.default_notifiers += [Stoplight::Notifier::Slack.new(value)]
|
43
|
+
when :bugsnag
|
44
|
+
Stoplight::Light.default_notifiers += [Stoplight::Notifier::Bugsnag.new(value)]
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
def assert_valid_options!(options)
|
50
|
+
OptionSet.validate!(options)
|
51
|
+
end
|
52
|
+
|
53
|
+
end
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
require 'faraday'
|
2
|
+
require 'stoplight'
|
3
|
+
require 'faraday_middleware/circuit_breaker/option_set'
|
4
|
+
|
5
|
+
module FaradayMiddleware
|
6
|
+
module CircuitBreaker
|
7
|
+
class OptionSet
|
8
|
+
|
9
|
+
VALID_OPTIONS = %w(timeout threshold fallback notifiers)
|
10
|
+
|
11
|
+
attr_accessor :timeout, :threshold, :fallback, :notifiers
|
12
|
+
|
13
|
+
def initialize(options = {})
|
14
|
+
@timeout = options[:timeout] || 60.0
|
15
|
+
@threshold = options[:threshold] || 3
|
16
|
+
@fallback = options[:fallback] || proc { Faraday::Response.new(status: 503, response_headers: {}) }
|
17
|
+
@notifiers = options[:notifiers] || {}
|
18
|
+
end
|
19
|
+
|
20
|
+
def self.validate!(options)
|
21
|
+
options.each_key do |key|
|
22
|
+
unless VALID_OPTIONS.include?(key.to_s)
|
23
|
+
fail ArgumentError.new("Unknown option: #{key}. Valid options are :#{VALID_OPTIONS.join(', ')}")
|
24
|
+
end
|
25
|
+
end
|
26
|
+
end
|
27
|
+
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
require 'faraday_middleware/circuit_breaker/version'
|
2
|
+
require 'faraday_middleware/circuit_breaker/middleware'
|
3
|
+
|
4
|
+
module FaradayMiddleware
|
5
|
+
module CircuitBreaker
|
6
|
+
|
7
|
+
if Faraday.respond_to?(:register_middleware)
|
8
|
+
Faraday.register_middleware circuit_breaker: FaradayMiddleware::CircuitBreaker::Middleware
|
9
|
+
elsif Faraday::Middleware.respond_to?(:register_middleware)
|
10
|
+
Faraday::Middleware.register_middleware circuit_breaker: FaradayMiddleware::CircuitBreaker::Middleware
|
11
|
+
end
|
12
|
+
|
13
|
+
end
|
14
|
+
end
|
metadata
ADDED
@@ -0,0 +1,129 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: faraday_middleware-circuit_breaker
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Pierre-Louis Gottfrois
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-11-03 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: faraday
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.9'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.9'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: stoplight
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.2'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.2'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.10'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.10'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: rspec
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
description: A Faraday Middleware to handle spotty web services.
|
84
|
+
email:
|
85
|
+
- pierrelouis.gottfrois@gmail.com
|
86
|
+
executables: []
|
87
|
+
extensions: []
|
88
|
+
extra_rdoc_files: []
|
89
|
+
files:
|
90
|
+
- ".gitignore"
|
91
|
+
- ".rspec"
|
92
|
+
- ".travis.yml"
|
93
|
+
- Gemfile
|
94
|
+
- LICENSE.txt
|
95
|
+
- README.md
|
96
|
+
- Rakefile
|
97
|
+
- bin/console
|
98
|
+
- bin/setup
|
99
|
+
- faraday_middleware-circuit_breaker.gemspec
|
100
|
+
- lib/faraday_middleware/circuit_breaker.rb
|
101
|
+
- lib/faraday_middleware/circuit_breaker/middleware.rb
|
102
|
+
- lib/faraday_middleware/circuit_breaker/option_set.rb
|
103
|
+
- lib/faraday_middleware/circuit_breaker/version.rb
|
104
|
+
homepage: http://textmaster.com
|
105
|
+
licenses:
|
106
|
+
- MIT
|
107
|
+
metadata: {}
|
108
|
+
post_install_message:
|
109
|
+
rdoc_options: []
|
110
|
+
require_paths:
|
111
|
+
- lib
|
112
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - ">="
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '0'
|
117
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
118
|
+
requirements:
|
119
|
+
- - ">="
|
120
|
+
- !ruby/object:Gem::Version
|
121
|
+
version: '0'
|
122
|
+
requirements: []
|
123
|
+
rubyforge_project:
|
124
|
+
rubygems_version: 2.4.8
|
125
|
+
signing_key:
|
126
|
+
specification_version: 4
|
127
|
+
summary: Middleware to apply circuit breaker pattern.
|
128
|
+
test_files: []
|
129
|
+
has_rdoc:
|