faraday_middleware-circuit_breaker 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 8deaaad1b7866b3bb93efe91ae63f492e446f382
-  data.tar.gz: 4c79b86afe36d6ae42733d83ff21beac8365284c
+SHA256:
+  metadata.gz: 005afebe17fb37c37d260ca776c581cc92cda261b7cafc241d6d4fb7ce39d860
+  data.tar.gz: e54b70864d6a74e8b13414c8af69dfb9ec5040a7c883663b088478ac523f19e3
 SHA512:
-  metadata.gz: 0a1267f7b41141ff8f6c02dc96a5ae199d2ff5b2cc6b3e83e242d1eade766a0a24de721c3602525fd38867cf192df2ebb627fca73cd376d4d1b745ce31eb7387
-  data.tar.gz: 2361860fcffd409f10db8ac07265116bedd52c0bc2947645ae4f00c2e4b802936679cbced2faf4f74a7c0d6b1688cf5737625df2910384658a227c5fb94ab2d8
+  metadata.gz: 81884db0ec02ed879a7e09d71b370a16a64a23daa183c9d9cfeb2db8650bc4f11339c7a83702f169e814ae048723caa2bb7ecf7c6426055f8a18ad9e4b978e49
+  data.tar.gz: d4f2942b93d59d50f9a994a9e86625a52307a38356b3e40fbf7454ca54c0774da2ca75667babab2fdd2950c71883ee457d49a622f892e50b1cb4fa5c2f3c2b0e

data/.github/workflows/ruby.yml

@@ -0,0 +1,50 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+- push
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby:
+        - "2.4"
+        - "2.5"
+        - "2.6"
+        - "2.7"
+
+    name: ${{ matrix.ruby }}
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Set up Cache
+      uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-gems-
+
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.ruby-version
+.rbenv-gemsets

data/CHANGELOG.md

@@ -1,7 +1,41 @@
-# 0.3.0
+# Changelog
+All notable changes to this project will be documented in this file.
 
-* Handles stoplight data store
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-# 0.2.0
+## [Unreleased]
+
+## [0.5.0]
+
+### Changed
+
+- Relaxed version requirement for Stoplight to include 3.0
+
+## [0.4.1]
+### Fixed
+
+- Fixed `ArgumentError: Unknown option: data_store. Valid options are :timeout, threshold, fallback, notifiers, data_store,, error_handler`
+  due to an extra comma introduced in the valid option list.
+
+## [0.4.0]
+### Added
+
+- Handle stoplight custom error handlers. Fixes https://github.com/textmaster/faraday_middleware-circuit_breaker/issues/3
+
+## [0.3.0]
+### Added
+- Handles stoplight data store
+
+## [0.2.0]
+### Added
 
 * Introduces sentry/raven notifier
+
+[Unreleased]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.5.0...HEAD
+[0.5.0]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.4.0...v0.4.1
+[0.4.0]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.3.0...v0.4.0
+[0.3.0]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.2.0...v0.3.0
+[0.2.0]: https://github.com/textmaster/faraday_middleware-circuit_breaker/compare/v0.1.0...v0.2.0
+[0.0.1]: https://github.com/textmaster/faraday_middleware-circuit_breaker/releases/tag/v0.1.0

data/Gemfile

@@ -1,4 +1,6 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in faraday_middleware-circuit_breaker.gemspec
 gemspec
+
+gem "rake", "~> 12.0"

data/README.md

@@ -57,7 +57,7 @@ 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:
+On a failure, middleware will render an empty `503` http response by default. You can customize the fallback response:
 
 ```ruby
 Faraday.new(url: 'http://foo.com') do |c|
@@ -88,6 +88,40 @@ Whatever you chose, your method should return a valid faraday response. For exam
 proc { Faraday::Response.new(status: 503, response_headers: {}) }
 ```
 
+### Custom error handling
+
+In some situations, it might required to allow for particular error types to be exempt from tripping the circuit breaker
+(like regular 403 or 401 HTTP responses, which aren't really out-of-the-ordinary conditions that should trip the circuit breaker).
+The underlying stoplight gem supports [custom error handling](https://github.com/orgsync/stoplight#custom-errors),
+The `error_handler` option allows you to add your own customer error handler behavior: 
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, error_handler: ->(exception, handler) { # do something }
+end
+```
+
+Middleware will try to call the `call` method on `error_handler` passing 2 arguments:
+
+- `exception` -- the exception raised that triggered the circuit breaker
+- `handler` -- the current error handler `Proc` that would be in charge of handling the `exception` if no `error_handler` option was passed 
+
+You can pass a method to be eager called like this (with a handler that exempts `ArgumentError` from tripping the circuit):
+
+```ruby
+Faraday.new(url: 'http://foo.com') do |c|
+  c.use :circuit_breaker, error_handler: method(:foo)
+end
+
+def foo(exception, handler)
+  raise exception if exception.is_a?(ArgumentError)
+  handler.call(exception)
+end
+```
+
+NOTE: It is most always a good idea to call the original `handler` with the exception that was passed in at the end of your
+handler. (By default, the `error_handler` will just be [`Stoplight::Default::ERROR_HANDLER`](https://github.com/orgsync/stoplight/blob/master/lib/stoplight/default.rb#L9))
+
 ### Notifiers
 
 Middleware send notifications to standard error by default. You can customize the receivers.

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/faraday_middleware-circuit_breaker.gemspec

@@ -1,7 +1,4 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'faraday_middleware/circuit_breaker/version'
+require_relative 'lib/faraday_middleware/circuit_breaker/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "faraday_middleware-circuit_breaker"
@@ -13,16 +10,25 @@ Gem::Specification.new do |spec|
   spec.description   = %q{A Faraday Middleware to handle spotty web services.}
   spec.homepage      = "https://github.com/textmaster/faraday_middleware-circuit_breaker"
   spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/textmaster/faraday_middleware-circuit_breaker"
+  spec.metadata["changelog_uri"] = "https://github.com/textmaster/faraday_middleware-circuit_breaker/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_dependency 'faraday', '~> 0.9'
-  spec.add_dependency 'stoplight', '~> 2.1'
+  spec.add_dependency 'faraday', '>= 0.9', '< 2.0'
+  spec.add_dependency 'stoplight', '>= 2.1', '< 4.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 11.2'
   spec.add_development_dependency 'rspec'
 end

data/lib/faraday_middleware/circuit_breaker/middleware.rb

@@ -17,12 +17,14 @@ module FaradayMiddleware
       end
 
       def call(env)
-        Stoplight(env.url.to_s) do
+        base_url = URI.join(env.url, '/')
+        Stoplight(base_url.to_s) do
           @app.call(env)
         end
         .with_cool_off_time(option_set.timeout)
         .with_threshold(option_set.threshold)
         .with_fallback { |e| option_set.fallback.call(env, e) }
+        .with_error_handler { |err, handler| option_set.error_handler.call(err, handler) }
         .run
       end
 

data/lib/faraday_middleware/circuit_breaker/option_set.rb

@@ -6,9 +6,9 @@ module FaradayMiddleware
   module CircuitBreaker
     class OptionSet
 
-      VALID_OPTIONS = %w(timeout threshold fallback notifiers data_store)
+      VALID_OPTIONS = %w(timeout threshold fallback notifiers data_store error_handler)
 
-      attr_accessor :timeout, :threshold, :fallback, :notifiers, :data_store
+      attr_accessor :timeout, :threshold, :fallback, :notifiers, :data_store, :error_handler
 
       def initialize(options = {})
         @timeout    = options[:timeout] || 60.0
@@ -16,6 +16,7 @@ module FaradayMiddleware
         @fallback   = options[:fallback] || proc { Faraday::Response.new(status: 503, response_headers: {}) }
         @notifiers  = options[:notifiers] || {}
         @data_store = options[:data_store] || proc { Stoplight::Light.default_data_store }
+        @error_handler = options[:error_handler] || Stoplight::Default::ERROR_HANDLER
       end
 
       def self.validate!(options)

data/lib/faraday_middleware/circuit_breaker/version.rb

@@ -1,5 +1,5 @@
 module FaradayMiddleware
   module CircuitBreaker
-    VERSION = "0.3.0"
+    VERSION = "0.5.0".freeze
   end
 end

metadata

@@ -1,71 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: faraday_middleware-circuit_breaker
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Pierre-Louis Gottfrois
-autorequire: 
-bindir: bin
+autorequire:
+bindir: exe
 cert_chain: []
-date: 2017-10-09 00:00:00.000000000 Z
+date: 2022-04-27 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'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.9'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: stoplight
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
-- !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: '11.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '11.2'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -83,12 +67,11 @@ dependencies:
 description: A Faraday Middleware to handle spotty web services.
 email:
 - pierre-louis@textmaster.com
-executables:
-- console
-- setup
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -107,8 +90,12 @@ files:
 homepage: https://github.com/textmaster/faraday_middleware-circuit_breaker
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/textmaster/faraday_middleware-circuit_breaker
+  source_code_uri: https://github.com/textmaster/faraday_middleware-circuit_breaker
+  changelog_uri: https://github.com/textmaster/faraday_middleware-circuit_breaker/blob/master/CHANGELOG.md
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -116,16 +103,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.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: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Middleware to apply circuit breaker pattern.
 test_files: []