routemaster-drain 1.1.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a38994768fac0a952e0072791c9318b2c87912be
-  data.tar.gz: 0e2acec86ae92448297a2ba916ef1ca61bdaefdb
+  metadata.gz: ced68b1893076a1cf8df7899e43afcf468487c74
+  data.tar.gz: 951f8e35d74922de878504e6487f64a689cea6f9
 SHA512:
-  metadata.gz: 76718e5f07d9c5616e626eafcddb19323398f756f47f177fc4f0c34fa50e711346cd993bf71c4ec161cce3b4eedbe43868b71e8a89902ebacc91412de4d9bea7
-  data.tar.gz: 0fa0392ec5962ffdc66023280e5503427609d9a2c3cefb827022d63acf4b29e1f55a3f838e7452f3bafa47f9dcb53f8555a596d401e469f0d538167fc0a89897
+  metadata.gz: 9d2be82bf2e1e3f4ad23687ee2a3b9d75ce1f49a9266f04e628da6608b4cdd18db86c06872f1685171d4bb61c98b465046ed75b84d6583dd53cc9edea02b1095
+  data.tar.gz: 12281b606df8070c1d97eee13c14ba75ee33fbbe3adf9c648fec2790e6cf7a2462fee51033c75e0828a16ddf05f4df03b3210c43e490361b7c1e647ef83114a4

data/.env.test

@@ -3,4 +3,3 @@ ROUTEMASTER_DRAIN_REDIS=redis://localhost/13
 ROUTEMASTER_CACHE_REDIS=redis://localhost/12
 ROUTEMASTER_CACHE_AUTH=example.com:username:s3cr3t
 ROUTEMASTER_DRAIN_TOKENS=d3m0
-

data/.travis.yml

@@ -5,6 +5,10 @@ services:
 rvm:
   - 2.2.5
   - 2.3.1
+gemfile:
+  - gemfiles/rails_3.gemfile
+  - gemfiles/rails_4.gemfile
+  - gemfiles/rails_5.gemfile
 script:
 - bundle exec rspec
 - bundle exec codeclimate-test-reporter

data/Appraisals

@@ -0,0 +1,11 @@
+appraise "rails-3" do
+  gem "rails", "3.2.14"
+end
+
+appraise "rails-4" do
+  gem "rails", "4.0.0"
+end
+
+appraise "rails-5" do
+  gem "rails", "5.0.0"
+end

data/Gemfile

@@ -9,13 +9,17 @@ gem 'psych',                      require: false
 # Used in builds and tests
 gem 'bundler',                    require: false
 gem 'rake',                       require: false
-gem 'guard-rspec',                require: false
 gem 'webmock',                    require: false
-gem 'pry-byebug',                 require: false
 gem 'rack-test',                  require: false
 gem 'dotenv',                     require: false
 gem 'codeclimate-test-reporter',  require: false
 gem 'simplecov'
-gem 'rspec'
 gem 'resque'
 gem 'sidekiq'
+
+group :development, :test do
+  gem 'guard-rspec',                require: false
+  gem 'pry-byebug',                 require: false
+  gem 'rspec'
+  gem 'appraisal'
+end

data/Gemfile.lock

@@ -1,12 +1,12 @@
 PATH
   remote: .
   specs:
-    routemaster-drain (1.1.0)
+    routemaster-drain (2.0.0)
       faraday (>= 0.9.0)
       faraday_middleware
       hashie
       net-http-persistent (< 3)
-      rack (>= 1.6.2)
+      rack (>= 1.4.5)
       redis-namespace
       thread
       wisper (~> 1.6.1)
@@ -16,6 +16,10 @@ GEM
   specs:
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
     byebug (9.0.6)
     codeclimate-test-reporter (1.0.3)
       simplecov
@@ -68,17 +72,17 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
-    pry-byebug (3.4.1)
+    pry-byebug (3.4.2)
       byebug (~> 9.0)
       pry (~> 0.10)
     psych (2.2.1)
     public_suffix (2.0.4)
-    rack (1.6.5)
+    rack (1.4.7)
     rack-protection (1.5.3)
       rack
     rack-test (0.6.3)
       rack (>= 1.0)
-    rake (11.3.0)
+    rake (12.0.0)
     rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
@@ -117,8 +121,8 @@ GEM
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
     simplecov-html (0.10.0)
-    sinatra (1.4.7)
-      rack (~> 1.5)
+    sinatra (1.4.6)
+      rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (>= 1.3, < 3)
     slop (3.6.0)
@@ -137,6 +141,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  appraisal
   bundler
   codeclimate-test-reporter
   dotenv

data/README.md

@@ -1,15 +1,15 @@
 # routemaster-drain
 
 A Rack-based event receiver for the
-[Routemaster](https://github.com/mezis/routemaster) event bus.
+[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/mezis/routemaster-drain.svg?branch=master)](https://travis-ci.org/mezis/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/mezis/routemaster-drain/frames/file/README.md)
+[![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
@@ -28,6 +28,7 @@ combining middleware.
     - [Simply receive events from Routemaster](#simply-receive-events-from-routemaster)
     - [Receive change notifications without duplicates](#receive-change-notifications-without-duplicates)
     - [Cache data for all notified resources](#cache-data-for-all-notified-resources)
+  - [HTTP Client](#http-client)
   - [Internals](#internals)
     - [Dirty map](#dirty-map)
     - [Filter](#filter)
@@ -213,17 +214,65 @@ Note that `Cache#fget` is a future, so you can efficiently query many resources
 and have any `HTTP GET` requests (and cache queries) happen in parallel.
 
 See
-[rubydoc](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Cache)
+[rubydoc](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Cache)
 for more details on `Cache`.
 
+## HTTP Client
+The Drain is using a Faraday http client for communication between services. The client
+comes with a convenient caching mechanism as a default and supports custom response materialization.
+The Drain itself has the concept of "HATEOAS"(see below) response that provides a common way of addressing resources.
+
+** **In order for the client to discover the resources that you are interested in, you need to call the `#discover(service_url)`
+method first**
+
+Example:
+
+```ruby
+require 'routemaster/fetcher'
+require 'routemaster/responses/hateoas_response'
+
+client = Routemaster::APIClient.new(response_class: Routemaster::Responses::HateoasResponse)
+
+response = client.discover('https://identity.deliveroo.com.dev')
+session_create_response = response.sessions.create(email: 'test@test.com', password: 'sup3rs3cr3t')
+session_create_response.user.show(1)
+```
+
+### HATEOAS materialisation
+The client comes with optional HATEOAS response capabilities. They are optional, because drain itself doesn't need to use the HATEOAS
+response capabilities. Whenever the client is used outside of the drain it is **strongly** advised to be used with the HATEOAS response capabilities.
+The HATEOAS response will materialize methods based on the keys found under the `_links` key on the payload. The semantics are the following:
+
+
+```ruby
+# Given the following payload
+{
+  "_links" : {
+    "users" : { "href" : "https://identity.deliveroo.com.dev/users" },
+    "user"  : { "href" : "https://identity.deliveroo.com.dev/users/{id}", "templated" : true }
+  }
+}
+
+client = Routemaster::APIClient.new(response_class: Routemaster::Responses::HateoasResponse)
+response = client.discover('https://identity.deliveroo.com.dev')
+
+response.users.create(username: 'roo')
+#=> HateoasResponse
+response.users.index
+#=> HateoasResponse
+response.user.show(1)
+#=> HateoasResponse
+```
+
+
 
 ## Internals
 
 The more elaborate drains are built with two components which can also be used
 independently,
-[`Dirty::Map`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Map)
+[`Dirty::Map`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Map)
 and
-[`Dirty::Filter`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Filter).
+[`Dirty::Filter`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Filter).
 
 ### Dirty map
 
@@ -235,22 +284,22 @@ A dirty map map gets _marked_ when an event about en entity gets processed that
 indicates a state change, and _swept_ to process those changes.
 
 Practically, instances of
-[`Routemaster::Dirty::Map`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Map)
+[`Routemaster::Dirty::Map`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Map)
 will emit a `:dirty_entity` event when a URL is marked as dirty, and can be
 swept when an entity is "cleaned".  If a URL is marked multiple times before
 being swept (e.g. for very volatile entities), the event will only by broadcast
 once.
 
 To sweep the map, you can for instance listen to this event and call
-[`#sweep_one`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Map#sweep_one-instance_method).
+[`#sweep_one`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Map#sweep_one-instance_method).
 
 If you're not in a hurry and would rather run through batches you can call
-[`#sweep`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Map#sweep-instance_method)
+[`#sweep`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Map#sweep-instance_method)
 which will yield URLs until it runs out of dirty resources.
 
 ### Filter
 
-[`Routemaster::Dirty::Filter`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Filter) is a simple event filter
+[`Routemaster::Dirty::Filter`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Filter) is a simple event filter
 that performs reordering. It ignores events older than the latest known
 information on an entity.
 
@@ -261,7 +310,7 @@ as in `Receiver::Filter` for instance.
 
 ## Contributing
 
-1. Fork it ( http://github.com/mezis/routemaster-drain/fork )
+1. Fork it ( http://github.com/deliveroo/routemaster-drain/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/gemfiles/rails_3.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 "codeclimate-test-reporter", :require => false
+gem "simplecov"
+gem "resque"
+gem "sidekiq"
+gem "rails", "3.2.14"
+
+group :development, :test do
+  gem "guard-rspec", :require => false
+  gem "pry-byebug", :require => false
+  gem "rspec"
+  gem "appraisal"
+end
+
+gemspec :path => "../"

data/gemfiles/rails_3.gemfile.lock

@@ -0,0 +1,224 @@
+PATH
+  remote: ../
+  specs:
+    routemaster-drain (1.1.0)
+      faraday (>= 0.9.0)
+      faraday_middleware
+      hashie
+      net-http-persistent (< 3)
+      rack (>= 1.4.5)
+      redis-namespace
+      thread
+      wisper (~> 1.6.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (3.2.14)
+      actionpack (= 3.2.14)
+      mail (~> 2.5.4)
+    actionpack (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.14)
+      activesupport (= 3.2.14)
+      builder (~> 3.0.0)
+    activerecord (3.2.14)
+    activeresource (3.2.14)
+      activemodel (= 3.2.14)
+      activesupport (= 3.2.14)
+    activesupport (3.2.14)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    appraisal (2.1.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    builder (3.0.4)
+    byebug (9.0.6)
+    codeclimate-test-reporter (1.0.3)
+      simplecov
+    coderay (1.1.1)
+    concurrent-ruby (1.0.2)
+    connection_pool (2.2.1)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    dotenv (2.1.1)
+    erubis (2.7.0)
+    faraday (0.10.0)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.10.1)
+      faraday (>= 0.7.4, < 1.0)
+    ffi (1.9.14)
+    formatador (0.2.5)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (0.3.1)
+    hashie (3.4.6)
+    hike (1.2.3)
+    i18n (0.7.0)
+    journey (1.0.4)
+    json (1.8.3)
+    listen (3.1.5)
+      rb-fsevent (~> 0.9, >= 0.9.4)
+      rb-inotify (~> 0.9, >= 0.9.7)
+      ruby_dep (~> 1.2)
+    lumberjack (1.0.10)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    mono_logger (1.1.0)
+    multi_json (1.12.1)
+    multipart-post (2.0.0)
+    nenv (0.3.0)
+    net-http-persistent (2.9.4)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    polyglot (0.3.5)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-byebug (3.4.2)
+      byebug (~> 9.0)
+      pry (~> 0.10)
+    psych (2.2.1)
+    public_suffix (2.0.4)
+    rack (1.4.7)
+    rack-cache (1.6.1)
+      rack (>= 0.4)
+    rack-protection (1.5.3)
+      rack
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (3.2.14)
+      actionmailer (= 3.2.14)
+      actionpack (= 3.2.14)
+      activerecord (= 3.2.14)
+      activeresource (= 3.2.14)
+      activesupport (= 3.2.14)
+      bundler (~> 1.0)
+      railties (= 3.2.14)
+    railties (3.2.14)
+      actionpack (= 3.2.14)
+      activesupport (= 3.2.14)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (12.0.0)
+    rb-fsevent (0.9.8)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    redis (3.3.2)
+    redis-namespace (1.5.2)
+      redis (~> 3.0, >= 3.0.4)
+    resque (1.26.0)
+      mono_logger (~> 1.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.3)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    ruby_dep (1.5.0)
+    safe_yaml (1.0.4)
+    shellany (0.0.1)
+    sidekiq (4.2.7)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (>= 1.5.0)
+      redis (~> 3.2, >= 3.2.1)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    sinatra (1.4.6)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (>= 1.3, < 3)
+    slop (3.6.0)
+    sprockets (2.2.3)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.19.4)
+    thread (0.2.2)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+    webmock (2.3.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    wisper (1.6.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal
+  bundler
+  codeclimate-test-reporter
+  dotenv
+  guard-rspec
+  pry-byebug
+  psych
+  rack-test
+  rails (= 3.2.14)
+  rake
+  resque
+  routemaster-drain!
+  rspec
+  sidekiq
+  simplecov
+  webmock
+
+BUNDLED WITH
+   1.13.6

data/gemfiles/rails_4.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 "codeclimate-test-reporter", :require => false
+gem "simplecov"
+gem "resque"
+gem "sidekiq"
+gem "rails", "4.0.0"
+
+group :development, :test do
+  gem "guard-rspec", :require => false
+  gem "pry-byebug", :require => false
+  gem "rspec"
+  gem "appraisal"
+end
+
+gemspec :path => "../"