routemaster-drain 3.6.5 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 574a92a97a0ae12a367d2aa0021852c9d721f8a542754eb6d038441cf411c38a
-  data.tar.gz: 74fc0e9be7b142971eb6d800e4e77faf88a9a00303490dfb0f2405cd0174f1c6
+  metadata.gz: 91d53145809f5384fe911262c83306264381e1915ce6b6aef4a7de3299fd8eee
+  data.tar.gz: 2a7860c5a46d018aa7e10d82aad853066e5daf5851b6deba44e900985c7218c3
 SHA512:
-  metadata.gz: 599155767c3d938d91c68e81e773b5940a35960fbf9c42ce802a8700c1a049391960afacbe1e4b22945ef199df19569a2627fd68e9bd899fa35d3ddaac78b5d6
-  data.tar.gz: aabdfac82f389474c62856923bbcc87633a44aca389f3bb1ac8e120225f77946c36972d25b46e1ed7b8b40891d8c28f8fddffbfac7e26d72ea4e5a71ce0a9612
+  metadata.gz: 4119a30f7b34f48fcca01432718968523f71ebc9b298c78b6aa1d162c48108db631622ce94ec1859c5715642aa554f009b216cdf016b5391945722302a45ae42
+  data.tar.gz: fa0f8e231efdc36f2bf1f88e0a6a8f9cc14ae3b494761756317cc1924b8f8e505f2e6ca3651132a2e3e2bcddc313071b66523d4626308c324fa8722556ab6ebc

data/.circleci/config.yml

@@ -3,161 +3,24 @@
 
 version: 2
 jobs:
-
-  build_2.3.4_rails_3:
-    docker:
-      - image: deliveroo/multiruby
-      - image: redis:3-alpine
-    steps:
-      - checkout
-
-      - run:
-          name: Select build variant (Ruby 2.3.4, rails_3)
-          command: |
-            rbenv local 2.3.4 ;
-            gem install bundler -v '~> 1.17' ;
-            bundle config --local gemfile $PWD/gemfiles/rails_3.gemfile
-
-      - restore_cache:
-          keys: 
-            - v2-bundle-2.3.4-rails_3-{{ .Branch }}
-            - v2-bundle-2.3.4-rails_3
-            - v2-bundle-2.3.4
-
-      - run: 
-          name: Install dependencies
-          command: |
-            bundle install --jobs=3 --retry=3 --path=$PWD/vendor/bundle
-
-      - run:
-          name: Run test suite
-          command: |
-            unset RACK_ENV &&
-            unset RAILS_ENV &&
-            bundle exec rspec
-
-      - save_cache:
-          key: v2-bundle-2.3.4-rails_3-{{ .Branch }}
-          paths:
-            - ~/project/vendor/bundle
-      - save_cache:
-          key: v2-bundle-2.3.4-rails_3
-          paths:
-            - ~/project/vendor/bundle
-      - save_cache:
-          key: v2-bundle-2.3.4
-          paths:
-            - ~/project/vendor/bundle
-
-  build_2.3.4_rails_4:
+  build_2.5_rails_5:
     docker:
-      - image: deliveroo/multiruby
+      - image: circleci/ruby:2.4.1
       - image: redis:3-alpine
     steps:
       - checkout
 
       - run:
-          name: Select build variant (Ruby 2.3.4, rails_4)
+          name: Install bundler
           command: |
-            rbenv local 2.3.4 ;
-            gem install bundler -v '~> 1.17' ;
-            bundle config --local gemfile $PWD/gemfiles/rails_4.gemfile
-
-      - restore_cache:
-          keys: 
-            - v2-bundle-2.3.4-rails_4-{{ .Branch }}
-            - v2-bundle-2.3.4-rails_4
-            - v2-bundle-2.3.4
-
-      - run: 
-          name: Install dependencies
-          command: |
-            bundle install --jobs=3 --retry=3 --path=$PWD/vendor/bundle
-
-      - run:
-          name: Run test suite
-          command: |
-            unset RACK_ENV &&
-            unset RAILS_ENV &&
-            bundle exec rspec
-
-      - save_cache:
-          key: v2-bundle-2.3.4-rails_4-{{ .Branch }}
-          paths:
-            - ~/project/vendor/bundle
-      - save_cache:
-          key: v2-bundle-2.3.4-rails_4
-          paths:
-            - ~/project/vendor/bundle
-      - save_cache:
-          key: v2-bundle-2.3.4
-          paths:
-            - ~/project/vendor/bundle
-
-  build_2.4.1_rails_4:
-    docker:
-      - image: deliveroo/multiruby
-      - image: redis:3-alpine
-    steps:
-      - checkout
-
-      - run:
-          name: Select build variant (Ruby 2.4.1, rails_4)
-          command: |
-            rbenv local 2.4.1 ;
-            gem install bundler -v '~> 1.17' ;
-            bundle config --local gemfile $PWD/gemfiles/rails_4.gemfile
-
-      - restore_cache:
-          keys: 
-            - v2-bundle-2.4.1-rails_4-{{ .Branch }}
-            - v2-bundle-2.4.1-rails_4
-            - v2-bundle-2.4.1
-
-      - run: 
-          name: Install dependencies
-          command: |
-            bundle install --jobs=3 --retry=3 --path=$PWD/vendor/bundle
-
-      - run:
-          name: Run test suite
-          command: |
-            unset RACK_ENV &&
-            unset RAILS_ENV &&
-            bundle exec rspec
-
-      - save_cache:
-          key: v2-bundle-2.4.1-rails_4-{{ .Branch }}
-          paths:
-            - ~/project/vendor/bundle
-      - save_cache:
-          key: v2-bundle-2.4.1-rails_4
-          paths:
-            - ~/project/vendor/bundle
-      - save_cache:
-          key: v2-bundle-2.4.1
-          paths:
-            - ~/project/vendor/bundle
-
-  build_2.3.4_rails_5:
-    docker:
-      - image: deliveroo/multiruby
-      - image: redis:3-alpine
-    steps:
-      - checkout
-
-      - run:
-          name: Select build variant (Ruby 2.3.4, rails_5)
-          command: |
-            rbenv local 2.3.4 ;
             gem install bundler -v '~> 1.17' ;
             bundle config --local gemfile $PWD/gemfiles/rails_5.gemfile
 
       - restore_cache:
           keys: 
-            - v2-bundle-2.3.4-rails_5-{{ .Branch }}
-            - v2-bundle-2.3.4-rails_5
-            - v2-bundle-2.3.4
+            - v3-bundle-2.5.0-rails_5-{{ .Branch }}
+            - v3-bundle-2.5.0-rails_5
+            - v3-bundle-2.5.0
 
       - run: 
           name: Install dependencies
@@ -172,37 +35,36 @@ jobs:
             bundle exec rspec
 
       - save_cache:
-          key: v2-bundle-2.3.4-rails_5-{{ .Branch }}
+          key: v3-bundle-2.5.0-rails_5-{{ .Branch }}
           paths:
             - ~/project/vendor/bundle
       - save_cache:
-          key: v2-bundle-2.3.4-rails_5
+          key: v3-bundle-2.5.0-rails_5
           paths:
             - ~/project/vendor/bundle
       - save_cache:
-          key: v2-bundle-2.3.4
+          key: v3-bundle-2.5.0
           paths:
             - ~/project/vendor/bundle
 
-  build_2.4.1_rails_5:
+  build_2.7_rails_6:
     docker:
-      - image: deliveroo/multiruby
-      - image: redis:3-alpine
+      - image: circleci/ruby:2.7.4
+      - image: redis:6-alpine
     steps:
       - checkout
 
       - run:
-          name: Select build variant (Ruby 2.4.1, rails_5)
+          name: Install bundler
           command: |
-            rbenv local 2.4.1 ;
-            gem install bundler -v '~> 1.17' ;
-            bundle config --local gemfile $PWD/gemfiles/rails_5.gemfile
+            gem install bundler -v '~> 2' ;
+            bundle config --local gemfile $PWD/gemfiles/rails_6.gemfile
 
       - restore_cache:
           keys: 
-            - v2-bundle-2.4.1-rails_5-{{ .Branch }}
-            - v2-bundle-2.4.1-rails_5
-            - v2-bundle-2.4.1
+            - bundle-2.7.4-rails_6-{{ .Branch }}
+            - bundle-2.7.4-rails_6
+            - bundle-2.7.4
 
       - run: 
           name: Install dependencies
@@ -217,31 +79,21 @@ jobs:
             bundle exec rspec
 
       - save_cache:
-          key: v2-bundle-2.4.1-rails_5-{{ .Branch }}
+          key: bundle-2.7.4-rails_6-{{ .Branch }}
           paths:
             - ~/project/vendor/bundle
       - save_cache:
-          key: v2-bundle-2.4.1-rails_5
+          key: bundle-2.7.4-rails_6
           paths:
             - ~/project/vendor/bundle
       - save_cache:
-          key: v2-bundle-2.4.1
+          key: bundle-2.7.4
           paths:
             - ~/project/vendor/bundle
 
-
 workflows:
   version: 2
   test:
     jobs:
-    
-      - build_2.3.4_rails_3
-    
-      - build_2.3.4_rails_4
-    
-      - build_2.4.1_rails_4
-    
-      - build_2.3.4_rails_5
-    
-      - build_2.4.1_rails_5
-    
+      - build_2.5_rails_5
+      - build_2.7_rails_6

data/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 _A description of your awesome changes here!_
 
+### 3.7.0
+
+Features:
+
+- Adds circuit breaker to PATCH PUT POST requests (#66)
+
+### 3.6.8
+
+Features:
+
+- Raises error on `502 Bad Gateway` [#94](https://github.com/deliveroo/routemaster-drain/pull/94)
+
+### 3.6.7 (2021-02-11)
+
+Features:
+
+- APIClient accepts timeout and open_timeout options
+
 ### 3.6.5 (2019-02-08)
 
 Bug fix:

data/gemfiles/rails_6.gemfile

@@ -0,0 +1,24 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "psych", :require => false
+gem "bundler", :require => false
+gem "rake", :require => false
+gem "webmock", :require => false
+gem "rack-test", :require => false
+gem "dotenv", :require => false
+gem "simplecov", :require => false
+gem "codecov", :require => false
+gem "resque", :require => false
+gem "sidekiq", :require => false
+gem "guard-rspec", :require => false
+gem "pry", :require => false
+gem "byebug", :require => false
+gem "rspec", :require => false
+gem "appraisal", :require => false
+gem "dogstatsd", :require => false
+gem "fork_break", :require => false
+gem "rails", "~> 6.0"
+
+gemspec :path => "../"

data/lib/routemaster/api_client.rb

@@ -45,6 +45,8 @@ module Routemaster
       @retry_attempts         = options.fetch :retry_attempts, 2
       @retry_methods          = options.fetch :retry_methods, Faraday::Request::Retry::IDEMPOTENT_METHODS
       @retry_exceptions       = options.fetch :retry_exceptions, Faraday::Request::Retry::Options.new.exceptions
+      @timeout                = options.fetch :timeout, nil
+      @open_timeout           = options.fetch :open_timeout, nil
 
       connection # warm up connection so Faraday does all it's magical file loading in the main thread
     end
@@ -97,11 +99,13 @@ module Routemaster
     private
 
     def patch_post_or_put(type, url, body, headers)
-      _wrapped_response _request(
-        type,
-        url: url,
-        body: body,
-        headers: headers)
+      APIClientCircuit.new(url).call do
+        _wrapped_response _request(
+          type,
+          url: url,
+          body: body,
+          headers: headers)
+      end
     end
 
     def _assert_uri(url)
@@ -147,8 +151,8 @@ module Routemaster
 
         f.adapter :typhoeus
 
-        f.options.timeout      = ENV.fetch('ROUTEMASTER_CACHE_TIMEOUT', 1).to_f
-        f.options.open_timeout = ENV.fetch('ROUTEMASTER_CACHE_TIMEOUT', 1).to_f
+        f.options.timeout      = (@timeout || ENV.fetch('ROUTEMASTER_CACHE_TIMEOUT', 1)).to_f
+        f.options.open_timeout = (@open_timeout || ENV.fetch('ROUTEMASTER_CACHE_TIMEOUT', 1)).to_f
         f.ssl.verify           = ENV.fetch('ROUTEMASTER_CACHE_VERIFY_SSL', 'false') == 'true'
       end
     end

data/lib/routemaster/api_client_circuit.rb

@@ -31,7 +31,7 @@ module Routemaster
         time_window: configuration_setting(@circuit_name, 'ROUTEMASTER_CIRCUIT_BREAKER_TIME_WINDOW', 120).to_i,
         volume_threshold: configuration_setting(@circuit_name, 'ROUTEMASTER_CIRCUIT_BREAKER_VOLUME_THRESHOLD', 50).to_i,
         error_threshold:  configuration_setting(@circuit_name, 'ROUTEMASTER_CIRCUIT_BREAKER_ERROR_THRESHOLD', 50).to_i,
-        cache: Moneta.new(:Redis, backend: Config.cache_redis),
+        cache: Moneta::Adapters::Redis.new(backend: Config.cache_redis),
         exceptions: [Routemaster::Errors::FatalResource, Faraday::TimeoutError]
       })
     end

data/lib/routemaster/drain.rb

@@ -1,5 +1,5 @@
 module Routemaster
   module Drain
-    VERSION = '3.6.5'.freeze
+    VERSION = '3.7.0'.freeze
   end
 end

data/lib/routemaster/errors.rb

@@ -82,6 +82,12 @@ module Routemaster
       end
     end
 
+    class BadGateway < BaseError
+      def message
+        "Bad Gateway"
+      end
+    end
+
     class ServiceNotAvailable < BaseError
       def message
         "Service Not Available"

data/lib/routemaster/middleware/error_handling.rb

@@ -16,6 +16,7 @@ module Routemaster
         (413..413) => Errors::InvalidResource,
         (429..429) => Errors::ResourceThrottling,
         (407..500) => Errors::FatalResource,
+        (502..502) => Errors::BadGateway,
         (503..503) => Errors::ServiceNotAvailable
       }.freeze
 

data/routemaster-drain.gemspec

@@ -26,4 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency     'redis-namespace'
   spec.add_runtime_dependency     'concurrent-ruby'
   spec.add_runtime_dependency     'circuitbox'
+  spec.add_runtime_dependency     'moneta', '1.0.0'
 end

data/spec/core_ext/forwardable_spec.rb

@@ -1,17 +1,19 @@
 require 'core_ext/forwardable'
 
-describe Forwardable do
-  class Foo
-    extend Forwardable
+if RUBY_VERSION == '2.4.0'
+  describe Forwardable do
+    class Foo
+      extend Forwardable
 
-    def initialize
-      @bar = :bar
-    end
+      def initialize
+        @bar = :bar
+      end
 
-    def_delegator :@bar, :to_s, :qux
-  end
+      def_delegator :@bar, :to_s, :qux
+    end
 
-  it 'expect delegation to work' do
-    expect(Foo.new.qux).to eq 'bar'
+    it 'expect delegation to work' do
+      expect(Foo.new.qux).to eq 'bar'
+    end
   end
 end

data/spec/routemaster/api_client_circuit_spec.rb

@@ -12,7 +12,10 @@ describe Routemaster::APIClientCircuit do
   context "when enabled" do
     before do
       sb_req
-      allow_any_instance_of(described_class).to receive(:enabled?){ true }
+      allow(ENV).to receive(:fetch).and_call_original
+      allow(ENV)
+        .to receive(:fetch)
+        .with('ROUTEMASTER_ENABLE_API_CLIENT_CIRCUIT', 'NO').and_return('YES')
     end
 
     let(:url){ 'http://example.com/foobar' }

data/spec/routemaster/api_client_spec.rb

@@ -109,10 +109,38 @@ describe Routemaster::APIClient do
     end
   end
 
+  shared_examples 'a circuit breaker wrapped request' do
+    let(:fetcher) { described_class.new(retry_attempts: 0) }
+    let(:url)     { 'https://circuit.example.com/circuit/132' }
+    let(:method)  { :get }
+
+    before do
+      allow(ENV).to receive(:fetch).and_call_original
+      allow(ENV)
+        .to receive(:fetch)
+        .with('ROUTEMASTER_ENABLE_API_CLIENT_CIRCUIT', 'NO').and_return('YES')
+      allow(ENV)
+        .to receive(:fetch)
+        .with('ROUTEMASTER_CIRCUIT_BREAKER_ERROR_THRESHOLD', 50).and_return('1')
+      allow(ENV)
+        .to receive(:fetch)
+        .with('ROUTEMASTER_CIRCUIT_BREAKER_VOLUME_THRESHOLD', 50).and_return('1')
+
+      stub_request(method, url).to_timeout
+    end
+
+    it 'trips after the second request' do
+      5.times { expect { subject }.to raise_error StandardError }
+      expect(a_request(method, url)).to have_been_made.at_most_times(2)
+    end
+  end
+
   describe '#get' do
     subject { fetcher.get(url, headers: headers) }
+
     it_behaves_like 'a GET requester'
     it_behaves_like 'a wrappable response'
+    it_behaves_like 'a circuit breaker wrapped request'
   end
 
   describe '#fget' do
@@ -183,6 +211,9 @@ describe Routemaster::APIClient do
     end
 
     it_behaves_like 'a wrappable response'
+    it_behaves_like 'a circuit breaker wrapped request' do
+      let(:method) { :post }
+    end
   end
 
   describe '#put' do
@@ -206,6 +237,9 @@ describe Routemaster::APIClient do
       end
 
       it_behaves_like 'a wrappable response'
+      it_behaves_like 'a circuit breaker wrapped request' do
+        let(:method) { :put }
+      end
     end
 
     context 'when request times out' do
@@ -282,6 +316,9 @@ describe Routemaster::APIClient do
       end
 
       it_behaves_like 'a wrappable response'
+      it_behaves_like 'a circuit breaker wrapped request' do
+        let(:method) { :patch }
+      end
     end
 
     context 'when request times out' do

data/spec/routemaster/integration/api_client_spec.rb

@@ -21,7 +21,7 @@ describe Routemaster::APIClient do
   let(:port) { 8080 }
   let(:service) do
     TestServer.new(port) do |server|
-      [400, 401, 403, 404, 405, 409, 412, 413, 429, 500, 503].each do |status_code|
+      [400, 401, 403, 404, 405, 409, 412, 413, 429, 500, 502, 503].each do |status_code|
         server.mount_proc "/#{status_code}" do |req, res|
           res.status = status_code
           res.body = { field: 'test' }.to_json
@@ -163,6 +163,10 @@ describe Routemaster::APIClient do
         expect { perform.(host + '/500') }.to raise_error(Routemaster::Errors::FatalResource)
       end
 
+      it 'raises a BadGateway on 502' do
+        expect { perform.(host + '/502') }.to raise_error(Routemaster::Errors::BadGateway)
+      end
+
       it 'raises a ServiceNotAvailable on 503' do
         expect { perform.(host + '/503') }.to raise_error(Routemaster::Errors::ServiceNotAvailable)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-drain
 version: !ruby/object:Gem::Version
-  version: 3.6.5
+  version: 3.7.0
 platform: ruby
 authors:
 - Julien Letessier
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-02-08 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -150,7 +150,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+- !ruby/object:Gem::Dependency
+  name: moneta
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description:
 email:
 - julien.letessier@gmail.com
 executables: []
@@ -179,6 +193,7 @@ files:
 - gemfiles/rails_3.gemfile
 - gemfiles/rails_4.gemfile
 - gemfiles/rails_5.gemfile
+- gemfiles/rails_6.gemfile
 - lib/core_ext/forwardable.rb
 - lib/routemaster/api_client.rb
 - lib/routemaster/api_client_circuit.rb
@@ -271,7 +286,7 @@ homepage: http://github.com/deliveroo/routemaster-drain
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -286,8 +301,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
-signing_key: 
+rubygems_version: 3.0.9
+signing_key:
 specification_version: 4
 summary: Event receiver for the Routemaster bus
 test_files: