routemaster-drain 2.4.0 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73102259aa43b2f83ca3360e1d9a9659b8cf5519
-  data.tar.gz: e2359d7ed7eccb19930bbd9dbfaa0759613cca16
+  metadata.gz: 8b2b697edbd498992119a65a84728e882d7887f4
+  data.tar.gz: becfe51f7378b6ef526f30df85cc0ba99e988506
 SHA512:
-  metadata.gz: 4c167270163604c730e57ad352a655b2d842f6a0fae1b00a40c655aad1f45acea1c49be34b0f48abf7edd7bfc8ad64a40a59556403fedf0afbe853e3f2168c1c
-  data.tar.gz: 23b913aa89238c7b0a1d3550f66370629f0576374dd596470ddc0feba1e7032703eb82ef5e27a922d6048bd315503c817cc3f2664e9481ce5df2ca16239516c0
+  metadata.gz: 97304f92aca0207ed65ebed6448f16da4a95c35b220be95a4397e85642a244fce6ae299cbd613859245b09d3e892b4c60e7c8c4d0ae2a6b2f54bd7bb1ebdccb9
+  data.tar.gz: 5e8b39950919c0d6df02399a1579940a0b8f0c88c7e2c5cd332193e01f683b9201253a267b17a0ecd19e18d050a749ba0f832e37f863e27b74ea8ae526c412d7

data/.codecov.yml

@@ -0,0 +1,29 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project:
+      default:
+        enabled: yes
+        threshold: 1%
+    patch:
+      default:
+        enabled: yes
+        threshold: 5%
+    changes: no
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment: off

data/.travis.yml

@@ -12,11 +12,9 @@ gemfile:
   - gemfiles/rails_4.gemfile
   - gemfiles/rails_5.gemfile
 script:
-- bundle exec rspec
-- bundle exec codeclimate-test-reporter
+  - bundle exec rspec
 matrix:
   allow_failures:
     - rvm: ruby-head
     - rvm: 2.4.0
       gemfile: gemfiles/rails_3.gemfile
-

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+### 2.4.1 (2017-03-15)
+
+Features:
+
+- API Client now exposes promises instead of simple futures (#34)
+
 ### 2.4.0 (2017-03-03)
 
 Features:

data/Gemfile

@@ -12,10 +12,10 @@ gem 'rake',                       require: false
 gem 'webmock',                    require: false
 gem 'rack-test',                  require: false
 gem 'dotenv',                     require: false
-gem 'codeclimate-test-reporter',  require: false
-gem 'simplecov'
-gem 'resque'
-gem 'sidekiq'
+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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    routemaster-drain (2.4.0)
+    routemaster-drain (2.4.1)
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -21,8 +21,10 @@ GEM
       rake
       thor (>= 0.14.0)
     byebug (9.0.6)
-    codeclimate-test-reporter (1.0.3)
+    codecov (0.1.9)
+      json
       simplecov
+      url
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
@@ -58,8 +60,8 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.3.2)
-    hashie (3.4.6)
-    json (2.0.2)
+    hashie (3.5.5)
+    json (2.0.3)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
       rb-inotify (~> 0.9, >= 0.9.7)
@@ -118,7 +120,7 @@ GEM
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (~> 3.2, >= 3.2.1)
-    simplecov (0.12.0)
+    simplecov (0.13.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -132,6 +134,7 @@ GEM
     tilt (2.0.5)
     typhoeus (1.1.2)
       ethon (>= 0.9.0)
+    url (0.3.2)
     vegas (0.1.11)
       rack (>= 1.0.0)
     webmock (2.3.2)
@@ -147,7 +150,7 @@ DEPENDENCIES
   appraisal
   bundler
   byebug
-  codeclimate-test-reporter
+  codecov
   dogstatsd
   dotenv
   fork_break
@@ -164,4 +167,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.14.5
+   1.14.6

data/README.md

@@ -1,15 +1,8 @@
-# routemaster-drain
+# routemaster-drain [![Version](https://badge.fury.io/rb/routemaster-drain.svg)](https://rubygems.org/gems/routemaster-drain) [![Build](https://travis-ci.org/deliveroo/routemaster-drain.svg?branch=master)](https://travis-ci.org/deliveroo/routemaster-drain) [![Code Climate](https://codeclimate.com/github/deliveroo/routemaster-drain/badges/gpa.svg)](https://codeclimate.com/github/deliveroo/routemaster-drain) [![codecov](https://codecov.io/gh/deliveroo/routemaster-drain/branch/master/graph/badge.svg)](https://codecov.io/gh/deliveroo/routemaster-drain) [![Docs](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/deliveroo/routemaster-drain)
 
 A Rack-based event receiver for the
 [Routemaster](https://github.com/deliveroo/routemaster) event bus.
 
-[![Version](https://badge.fury.io/rb/routemaster-drain.svg)](https://rubygems.org/gems/routemaster-drain)
- 
-[![Build](https://travis-ci.org/deliveroo/routemaster-drain.svg?branch=master)](https://travis-ci.org/deliveroo/routemaster-drain)
- 
-[![Code Climate](https://codeclimate.com/github/deliveroo/routemaster-drain/badges/gpa.svg)](https://codeclimate.com/github/deliveroo/routemaster-drain)
-[![Test Coverage](https://codeclimate.com/github/deliveroo/routemaster-drain/badges/coverage.svg)](https://codeclimate.com/github/deliveroo/routemaster-drain/coverage)
-[![Docs](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/deliveroo/routemaster-drain)
 
 `routemaster-drain` is a collection of Rack middleware to receive and
 parse Routemaster events, filter them, and preemptively cache the corresponding

data/gemfiles/rails_3.gemfile

@@ -8,10 +8,10 @@ gem "rake", :require => false
 gem "webmock", :require => false
 gem "rack-test", :require => false
 gem "dotenv", :require => false
-gem "codeclimate-test-reporter", :require => false
-gem "simplecov"
-gem "resque"
-gem "sidekiq"
+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

data/gemfiles/rails_3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.4.0)
+    routemaster-drain (2.4.1)
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -50,8 +50,10 @@ GEM
     arel (3.0.3)
     builder (3.0.4)
     byebug (9.0.6)
-    codeclimate-test-reporter (1.0.6)
+    codecov (0.1.9)
+      json
       simplecov
+      url
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
@@ -88,7 +90,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.3.2)
-    hashie (3.4.6)
+    hashie (3.5.5)
     hike (1.2.3)
     i18n (0.8.1)
     journey (1.0.4)
@@ -200,6 +202,7 @@ GEM
     typhoeus (1.1.2)
       ethon (>= 0.9.0)
     tzinfo (0.3.52)
+    url (0.3.2)
     vegas (0.1.11)
       rack (>= 1.0.0)
     webmock (2.3.2)
@@ -215,7 +218,7 @@ DEPENDENCIES
   appraisal
   bundler
   byebug
-  codeclimate-test-reporter
+  codecov
   dogstatsd
   dotenv
   fork_break

data/gemfiles/rails_4.gemfile

@@ -8,10 +8,10 @@ gem "rake", :require => false
 gem "webmock", :require => false
 gem "rack-test", :require => false
 gem "dotenv", :require => false
-gem "codeclimate-test-reporter", :require => false
-gem "simplecov"
-gem "resque"
-gem "sidekiq"
+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

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.4.0)
+    routemaster-drain (2.4.1)
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -57,8 +57,10 @@ GEM
     arel (6.0.4)
     builder (3.2.3)
     byebug (9.0.6)
-    codeclimate-test-reporter (1.0.6)
+    codecov (0.1.9)
+      json
       simplecov
+      url
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
@@ -97,7 +99,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.3.2)
-    hashie (3.4.6)
+    hashie (3.5.5)
     i18n (0.8.1)
     json (2.0.3)
     listen (3.1.5)
@@ -217,6 +219,7 @@ GEM
       ethon (>= 0.9.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    url (0.3.2)
     vegas (0.1.11)
       rack (>= 1.0.0)
     webmock (2.3.2)
@@ -232,7 +235,7 @@ DEPENDENCIES
   appraisal
   bundler
   byebug
-  codeclimate-test-reporter
+  codecov
   dogstatsd
   dotenv
   fork_break

data/gemfiles/rails_5.gemfile

@@ -8,10 +8,10 @@ gem "rake", :require => false
 gem "webmock", :require => false
 gem "rack-test", :require => false
 gem "dotenv", :require => false
-gem "codeclimate-test-reporter", :require => false
-gem "simplecov"
-gem "resque"
-gem "sidekiq"
+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

data/gemfiles/rails_5.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.4.0)
+    routemaster-drain (2.4.1)
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -60,8 +60,10 @@ GEM
     arel (7.1.4)
     builder (3.2.3)
     byebug (9.0.6)
-    codeclimate-test-reporter (1.0.6)
+    codecov (0.1.9)
+      json
       simplecov
+      url
     coderay (1.1.1)
     concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
@@ -100,7 +102,7 @@ GEM
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
     hashdiff (0.3.2)
-    hashie (3.4.6)
+    hashie (3.5.5)
     i18n (0.8.1)
     json (2.0.3)
     listen (3.1.5)
@@ -217,6 +219,7 @@ GEM
       ethon (>= 0.9.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
+    url (0.3.2)
     vegas (0.1.11)
       rack (>= 1.0.0)
     webmock (2.3.2)
@@ -235,7 +238,7 @@ DEPENDENCIES
   appraisal
   bundler
   byebug
-  codeclimate-test-reporter
+  codecov
   dogstatsd
   dotenv
   fork_break

data/lib/routemaster/api_client.rb

@@ -7,7 +7,7 @@ require 'routemaster/config'
 require 'routemaster/middleware/response_caching'
 require 'routemaster/middleware/error_handling'
 require 'routemaster/middleware/metrics'
-require 'routemaster/responses/future_response'
+require 'routemaster/responses/response_promise'
 
 # Loading the Faraday adapter for Typhoeus requires a little dance
 require 'faraday/adapter/typhoeus'
@@ -49,16 +49,16 @@ module Routemaster
       enable_caching = options.fetch(:enable_caching, true)
 
       _wrapped_response _request(
-        :get, 
+        :get,
         url: url,
         params: params,
         headers: headers.merge(response_cache_opt_headers(enable_caching)))
     end
 
-    # Same as {{get}}, except with 
+    # Same as {{get}}, except with
     def fget(url, **options)
       uri = _assert_uri(url)
-      Responses::FutureResponse.new { get(uri, options) }
+      Responses::ResponsePromise.new { get(uri, options) }
     end
 
     def post(url, body: {}, headers: {})

data/lib/routemaster/cache.rb

@@ -55,7 +55,7 @@ module Routemaster
     # Like {#get}, but schedules any request in the background using a thread
     # pool. Handy to issue lots of requests in parallel.
     #
-    # @return [FutureResponse], which responds to `status`, `headers`, and `body`
+    # @return [ResponsePromise], which responds to `status`, `headers`, and `body`
     # like [Response].
     def fget(url, version: nil, locale: nil)
       @client.fget(url, headers: headers(version: version, locale: locale))

data/lib/routemaster/drain.rb

@@ -1,5 +1,5 @@
 module Routemaster
   module Drain
-    VERSION = '2.4.0'
+    VERSION = '2.4.1'
   end
 end

data/lib/routemaster/responses/{future_response.rb → response_promise.rb}

@@ -1,16 +1,16 @@
-require 'concurrent/future'
+require 'concurrent/promise'
 require 'concurrent/executor/cached_thread_pool'
 require 'singleton'
 require 'delegate'
 
 module Routemaster
   module Responses
-    class FutureResponse
+    class ResponsePromise
       extend Forwardable
 
       # The `block` is expected to return a {Response}
       def initialize(&block)
-        @future = Concurrent::Future.execute(executor: Pool.current, &block)
+        @promise = Concurrent::Promise.execute(executor: Pool.current, &block)
       end
 
       # @!attribute status
@@ -24,18 +24,18 @@ module Routemaster
       # @!attribute body
       # @return [Hashie::Mash]
       # Delegated to the `block`'s return value.
-
-      delegate :value => :@future
       delegate %i(status headers body) => :value
+      delegate %i(on_success on_error execute state) => :@promise
+
       delegate :respond_to_missing? => :value
-      
+
       def method_missing(m, *args, &block)
         value.public_send(m, *args, &block)
       end
 
       def value
-        @future.value.tap do
-          raise @future.reason if @future.rejected?
+        @promise.value.tap do
+          raise @promise.reason if @promise.rejected?
         end
       end
 

data/spec/routemaster/api_client_spec.rb

@@ -80,6 +80,54 @@ describe Routemaster::APIClient do
   describe '#fget' do
     subject { fetcher.fget(url, headers: headers) }
     it_behaves_like 'a GET requester'
+
+    context "when setting callbacks" do
+      before do
+        stub_request(:get, /example\.com/).to_return(
+          status:   status,
+          body:     { id: 132, type: 'widget' }.to_json,
+          headers:  {
+            'content-type' => 'application/json;v=1'
+          }
+        )
+      end
+
+      let(:callback_spy) { spy('callback_spy') }
+
+      subject do
+        fetcher.fget(url, headers: headers)
+      end
+
+      let(:callback){
+        subject.on_success do
+          callback_spy.success
+        end
+        subject.on_error do
+          callback_spy.error
+        end
+      }
+
+      context "when successful" do
+        let(:status){ 200 }
+        it "calls on_success" do
+          expect(subject.status).to eq 200
+          callback.value #We need to wait before testing if the spy was called
+          expect(callback_spy).to have_received(:success)
+          expect(callback_spy).not_to have_received(:error)
+
+        end
+      end
+
+      context "when not successful" do
+        let(:status){ 500 }
+        it "calls on_error" do
+          expect{subject.value}.to raise_error { Routemaster::Errors::FatalResource }
+          callback.value #We need to wait before testing if the spy was called
+          expect(callback_spy).to have_received(:error)
+          expect(callback_spy).not_to have_received(:success)
+        end
+      end
+    end
   end
 
   describe '#post' do

data/spec/routemaster/integration/api_client_spec.rb

@@ -158,7 +158,7 @@ describe Routemaster::APIClient do
         expect { perform.(host + '/500') }.to raise_error(Routemaster::Errors::FatalResource)
       end
     end
-  
+
     describe '#get' do
       let(:perform) { ->(uri) { subject.get(uri) } }
       include_examples 'exception raiser'

data/spec/routemaster/responses/hateoas_enumerable_response_spec.rb

@@ -18,9 +18,9 @@ describe Routemaster::Responses::HateoasEnumerableResponse do
 
   before do
     @resource_stub = stub_request(:get, resource_tpl).to_return do |req|
-      { 
-        status: 200, 
-        headers: { 'Content-Type' => 'application/json' }, 
+      {
+        status: 200,
+        headers: { 'Content-Type' => 'application/json' },
         body: {
           id: req.uri.path.split('/').last.to_i,
           _links: {
@@ -59,7 +59,7 @@ describe Routemaster::Responses::HateoasEnumerableResponse do
   subject { described_class.new(client.get(index_url)) }
 
   # so we don't pollute future specs with pending requests:
-  after { Routemaster::Responses::FutureResponse::Pool.reset }
+  after { Routemaster::Responses::ResponsePromise::Pool.reset }
 
   describe '#each' do
     it 'is enumerable' do

data/spec/routemaster/responses/response_promise_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+require 'hashie/mash'
+require 'routemaster/responses/response_promise'
+
+describe Routemaster::Responses::ResponsePromise do
+  %i[status headers body].each do |method|
+    it "passes through '#{method}'" do
+      promise = described_class.new { Hashie::Mash.new(method => 'foobar') }
+      promise.execute
+      expect(promise.public_send(method)).to eq('foobar')
+    end
+  end
+
+  it "can have callbacks set" do
+    passing_spy = spy('passing spy')
+    promise = described_class.new { }
+    success_promise = promise.on_success { passing_spy.on_success }
+    promise.execute
+    promise.value
+    success_promise.value
+    expect(passing_spy).to have_received(:on_success)
+  end
+
+  it 're-raises exceptions' do
+    promise = described_class.new { raise 'foobar' }
+    promise.execute
+    expect { promise.status }.to raise_error(RuntimeError, 'foobar')
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'simplecov'
 SimpleCov.start
 
+require 'codecov'
+SimpleCov.formatter = SimpleCov::Formatter::Codecov if ENV['CI']
+
 require 'sidekiq/testing'
 require 'dotenv'
 require 'pry'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-drain
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.4.1
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-03 00:00:00.000000000 Z
+date: 2017-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -130,6 +130,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".codecov.yml"
 - ".env.test"
 - ".gitignore"
 - ".gitmodules"
@@ -187,9 +188,9 @@ files:
 - lib/routemaster/null_logger.rb
 - lib/routemaster/redis_broker.rb
 - lib/routemaster/resources/rest_resource.rb
-- lib/routemaster/responses/future_response.rb
 - lib/routemaster/responses/hateoas_enumerable_response.rb
 - lib/routemaster/responses/hateoas_response.rb
+- lib/routemaster/responses/response_promise.rb
 - routemaster-drain.gemspec
 - spec/routemaster/api_client_spec.rb
 - spec/routemaster/cache_spec.rb
@@ -215,9 +216,9 @@ files:
 - spec/routemaster/middleware/root_post_only_spec.rb
 - spec/routemaster/redis_broker_spec.rb
 - spec/routemaster/resources/rest_resource_spec.rb
-- spec/routemaster/responses/future_response_spec.rb
 - spec/routemaster/responses/hateoas_enumerable_response_spec.rb
 - spec/routemaster/responses/hateoas_response_spec.rb
+- spec/routemaster/responses/response_promise_spec.rb
 - spec/spec_helper.rb
 - spec/support/breakpoint_class.rb
 - spec/support/events.rb
@@ -246,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Event receiver for the Routemaster bus
@@ -275,9 +276,9 @@ test_files:
 - spec/routemaster/middleware/root_post_only_spec.rb
 - spec/routemaster/redis_broker_spec.rb
 - spec/routemaster/resources/rest_resource_spec.rb
-- spec/routemaster/responses/future_response_spec.rb
 - spec/routemaster/responses/hateoas_enumerable_response_spec.rb
 - spec/routemaster/responses/hateoas_response_spec.rb
+- spec/routemaster/responses/response_promise_spec.rb
 - spec/spec_helper.rb
 - spec/support/breakpoint_class.rb
 - spec/support/events.rb

data/spec/routemaster/responses/future_response_spec.rb

@@ -1,18 +0,0 @@
-require 'spec_helper'
-require 'hashie/mash'
-require 'routemaster/responses/future_response'
-
-describe Routemaster::Responses::FutureResponse do
-  %i[status headers body].each do |method|
-    it "passes through '#{method}'" do
-      future = described_class.new { Hashie::Mash.new(method => 'foobar') }
-      expect(future.public_send(method)).to eq('foobar')
-    end
-  end
-
-  it 're-raises exceptions' do
-    future = described_class.new { raise 'foobar' }
-
-    expect { future.status }.to raise_error(RuntimeError, 'foobar')
-  end
-end