routemaster-drain 2.4.4 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbb67c5fb3fc8aec8fe43fb6035f99672eb3ce87
-  data.tar.gz: bb35752a729017d5e15d3189ce60f93ef60abd60
+  metadata.gz: 174d544b122fdee4b52eb706ce2d1324e416eea4
+  data.tar.gz: 2d33ba614a48f0e613adc1941a2126d17354b2a0
 SHA512:
-  metadata.gz: b611d4238abac43c10ccd52413541cf272edd293694b42618084bc7393b63f2ca4e27d78e33cf71f4193369c54ae3916a0fca49b376eb99b86d220d7b8dae008
-  data.tar.gz: 004e39f85620152ae1c6275e1edbaa4867badf20b5adda669207079740bc2da746531c86eaf43d0e83da11765b6a5803aff1b4da1fd09cd8bc3ff5a8883446ed
+  metadata.gz: 0b3cc42bfe4e62e6ecc2b60e71c69525d669447c0601ea5bf06a1b79c1fdab7b6c1e20e1494acb980ac5097615231b2b22fda210cca1fc43b5fd87875667d453
+  data.tar.gz: 4688fb67eb80241cf5fe28e5eed11be1617d083f8625fe378de960ee2506d45f105666ab556e69adb0944d592755d2ec9b302c31b6c8864ebdcc23070e02734d

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+### 2.5.0 (2017-04-11)
+
+Features:
+
+- Allow template urls to be defined in services (#38)
+- Adds the `Siphon` middleware (#39, #44)
+- Adds `CacheBusting` middleware (#40)
+
+Bug fixes:
+
+- Caching middleware always busts the cache on events - preventing stale events being cached in some circumstances (#40)
+
 ### 2.4.4 (2017-03-27)
 
 Features:

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    routemaster-drain (2.4.4)
+    routemaster-drain (2.5.0)
+      addressable
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -36,7 +37,7 @@ GEM
     dotenv (2.1.1)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    faraday (0.11.0)
+    faraday (0.12.0.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.11.0.1)
       faraday (>= 0.7.4, < 1.0)

data/README.md

@@ -199,7 +199,7 @@ response = @cache.fget('https://example.com/widgets/123')
 puts response.body.id
 ```
 
-In this example, is your app was notified by Routemaster about Widget #123, the
+In this example, if your app was notified by Routemaster about Widget #123, the
 cache will be very likely to be hit; and it will be invalidated automatically
 whenever the drain gets notified about a change on that widget.
 
@@ -210,6 +210,17 @@ See
 [rubydoc](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Cache)
 for more details on `Cache`.
 
+### Expire Cache data for all notified resources
+
+You may wish to maintain a coherent cache but don't need the cache to be warmed
+before you process incoming events. In that case, use the cache as detailed above
+but swap the `Caching` drain out for `CachingBusting`
+
+```ruby
+require 'routemaster/drain/machine'
+$app = Routemaster::Drain::CachingBusting.new
+```
+
 ## 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.
@@ -277,9 +288,10 @@ response.user.show(1)
 
 The more elaborate drains are built with two components which can also be used
 independently,
-[`Dirty::Map`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Map)
-and
-[`Dirty::Filter`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Filter).
+[`Dirty::Map`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Map),
+[`Dirty::Filter`](http://rubydoc.info/github/deliveroo/routemaster-drain/Routemaster/Dirty/Filter) and
+[`Middleware::Siphon`](http://www.rubydoc.info/github/deliveroo/routemaster-drain/master/Routemaster/Middleware/Siphon).
+
 
 ### Dirty map
 
@@ -314,6 +326,11 @@ It stores transient state in Redis and will emit `:entity_changed` events
 whenever an entity has changed. This event can usefully be fed into a dirty map,
 as in `Receiver::Filter` for instance.
 
+### Siphon
+
+[`Middleware::Siphon`](http://www.rubydoc.info/github/deliveroo/routemaster-drain/master/Routemaster/Middleware/Siphon) extracts
+payloads from the middleware chain, allowing them to be processed separately. This is useful for event topics where the update frequency is not well suited
+to frequent caching. For example, a location update event which you'd expect to receive every few seconds.
 
 ## Contributing
 
@@ -327,3 +344,5 @@ Do not bump version numbers on branches (a maintainer will do this when cutting
 a release); but please do describe your changes in the `CHANGELOG` (at the top,
 without a version number).
 
+If you have changed dependencies, you need to run `appraisal update` to make
+sure the various version specific gemfiles are updated.

data/gemfiles/rails_3.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.4.4)
+    routemaster-drain (2.5.0)
+      addressable
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -41,7 +42,7 @@ GEM
     activesupport (3.2.22.5)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
     appraisal (2.1.0)
       bundler
@@ -50,7 +51,7 @@ GEM
     arel (3.0.3)
     builder (3.0.4)
     byebug (9.0.6)
-    codecov (0.1.9)
+    codecov (0.1.10)
       json
       simplecov
       url
@@ -66,11 +67,11 @@ GEM
     erubis (2.7.0)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    faraday (0.11.0)
+    faraday (0.12.0.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.11.0.1)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.17)
+    ffi (1.9.18)
     fork (1.0.1)
     fork_break (0.1.4)
       fork (= 1.0.1)
@@ -174,12 +175,12 @@ GEM
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
-    sidekiq (4.2.9)
+    sidekiq (4.2.10)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (~> 3.2, >= 3.2.1)
-    simplecov (0.13.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -201,7 +202,7 @@ GEM
       polyglot (>= 0.3.1)
     typhoeus (1.1.2)
       ethon (>= 0.9.0)
-    tzinfo (0.3.52)
+    tzinfo (0.3.53)
     url (0.3.2)
     vegas (0.1.11)
       rack (>= 1.0.0)

data/gemfiles/rails_4.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.4.4)
+    routemaster-drain (2.5.0)
+      addressable
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -48,7 +49,7 @@ GEM
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
     appraisal (2.1.0)
       bundler
@@ -57,7 +58,7 @@ GEM
     arel (6.0.4)
     builder (3.2.3)
     byebug (9.0.6)
-    codecov (0.1.9)
+    codecov (0.1.10)
       json
       simplecov
       url
@@ -73,11 +74,11 @@ GEM
     erubis (2.7.0)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    faraday (0.11.0)
+    faraday (0.12.0.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.11.0.1)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.17)
+    ffi (1.9.18)
     fork (1.0.1)
     fork_break (0.1.4)
       fork (= 1.0.1)
@@ -121,7 +122,7 @@ GEM
     multi_json (1.12.1)
     multipart-post (2.0.0)
     nenv (0.3.0)
-    nokogiri (1.7.0.1)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -190,12 +191,12 @@ GEM
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
-    sidekiq (4.2.9)
+    sidekiq (4.2.10)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (~> 3.2, >= 3.2.1)
-    simplecov (0.13.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -214,10 +215,10 @@ GEM
       sprockets (>= 3.0.0)
     thor (0.19.4)
     thread_safe (0.3.6)
-    tilt (2.0.6)
+    tilt (2.0.7)
     typhoeus (1.1.2)
       ethon (>= 0.9.0)
-    tzinfo (1.2.2)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
     url (0.3.2)
     vegas (0.1.11)

data/gemfiles/rails_5.gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: ..
   specs:
-    routemaster-drain (2.4.4)
+    routemaster-drain (2.5.0)
+      addressable
       concurrent-ruby
       faraday (>= 0.9.0)
       faraday_middleware
@@ -14,44 +15,44 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.0.1)
-      actionpack (= 5.0.1)
-      nio4r (~> 1.2)
+    actioncable (5.0.2)
+      actionpack (= 5.0.2)
+      nio4r (>= 1.2, < 3.0)
       websocket-driver (~> 0.6.1)
-    actionmailer (5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
+    actionmailer (5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.0.1)
-      actionview (= 5.0.1)
-      activesupport (= 5.0.1)
+    actionpack (5.0.2)
+      actionview (= 5.0.2)
+      activesupport (= 5.0.2)
       rack (~> 2.0)
       rack-test (~> 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.0.1)
-      activesupport (= 5.0.1)
+    actionview (5.0.2)
+      activesupport (= 5.0.2)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 2.0)
-      rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    activejob (5.0.1)
-      activesupport (= 5.0.1)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.0.2)
+      activesupport (= 5.0.2)
       globalid (>= 0.3.6)
-    activemodel (5.0.1)
-      activesupport (= 5.0.1)
-    activerecord (5.0.1)
-      activemodel (= 5.0.1)
-      activesupport (= 5.0.1)
+    activemodel (5.0.2)
+      activesupport (= 5.0.2)
+    activerecord (5.0.2)
+      activemodel (= 5.0.2)
+      activesupport (= 5.0.2)
       arel (~> 7.0)
-    activesupport (5.0.1)
+    activesupport (5.0.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (~> 0.7)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.0)
+    addressable (2.5.1)
       public_suffix (~> 2.0, >= 2.0.2)
     appraisal (2.1.0)
       bundler
@@ -60,7 +61,7 @@ GEM
     arel (7.1.4)
     builder (3.2.3)
     byebug (9.0.6)
-    codecov (0.1.9)
+    codecov (0.1.10)
       json
       simplecov
       url
@@ -76,11 +77,11 @@ GEM
     erubis (2.7.0)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    faraday (0.11.0)
+    faraday (0.12.0.1)
       multipart-post (>= 1.2, < 3)
     faraday_middleware (0.11.0.1)
       faraday (>= 0.7.4, < 1.0)
-    ffi (1.9.17)
+    ffi (1.9.18)
     fork (1.0.1)
     fork_break (0.1.4)
       fork (= 1.0.1)
@@ -124,8 +125,8 @@ GEM
     multi_json (1.12.1)
     multipart-post (2.0.0)
     nenv (0.3.0)
-    nio4r (1.2.1)
-    nokogiri (1.7.0.1)
+    nio4r (2.0.0)
+    nokogiri (1.7.1)
       mini_portile2 (~> 2.1.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
@@ -141,26 +142,26 @@ GEM
       rack
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (5.0.1)
-      actioncable (= 5.0.1)
-      actionmailer (= 5.0.1)
-      actionpack (= 5.0.1)
-      actionview (= 5.0.1)
-      activejob (= 5.0.1)
-      activemodel (= 5.0.1)
-      activerecord (= 5.0.1)
-      activesupport (= 5.0.1)
+    rails (5.0.2)
+      actioncable (= 5.0.2)
+      actionmailer (= 5.0.2)
+      actionpack (= 5.0.2)
+      actionview (= 5.0.2)
+      activejob (= 5.0.2)
+      activemodel (= 5.0.2)
+      activerecord (= 5.0.2)
+      activesupport (= 5.0.2)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 5.0.1)
+      railties (= 5.0.2)
       sprockets-rails (>= 2.0.0)
     rails-dom-testing (2.0.2)
       activesupport (>= 4.2.0, < 6.0)
       nokogiri (~> 1.6)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (5.0.1)
-      actionpack (= 5.0.1)
-      activesupport (= 5.0.1)
+    railties (5.0.2)
+      actionpack (= 5.0.2)
+      activesupport (= 5.0.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
@@ -193,12 +194,12 @@ GEM
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
-    sidekiq (4.2.9)
+    sidekiq (4.2.10)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
       rack-protection (>= 1.5.0)
       redis (~> 3.2, >= 3.2.1)
-    simplecov (0.13.0)
+    simplecov (0.14.1)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -217,7 +218,7 @@ GEM
     thread_safe (0.3.6)
     typhoeus (1.1.2)
       ethon (>= 0.9.0)
-    tzinfo (1.2.2)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
     url (0.3.2)
     vegas (0.1.11)

data/lib/routemaster/drain/basic.rb

@@ -37,4 +37,3 @@ module Routemaster
     end
   end
 end
-

data/lib/routemaster/drain/cache_busting.rb

@@ -0,0 +1,38 @@
+require 'routemaster/middleware/root_post_only'
+require 'routemaster/middleware/authenticate'
+require 'routemaster/middleware/parse'
+require 'routemaster/middleware/expire_cache'
+require 'routemaster/middleware/payload_filter'
+require 'routemaster/middleware/filter'
+require 'routemaster/drain/terminator'
+require 'rack/builder'
+require 'delegate'
+
+module Routemaster
+  module Drain
+    # Rack application which authenticates, parses, filters duplicates in this request
+    # and invalidates the cache for all updated or new items.
+    #
+    # See the various corresponding middleware for details on operation:
+    # {Middleware::RootPostOnly}, {Middleware::Authenticate},
+    # {Middleware::Parse}, {Middleware::ExpireCache} and {Terminator}.
+    class CacheBusting
+      extend Forwardable
+
+      def initialize(options = {})
+        @terminator = terminator = Terminator.new
+        @app = ::Rack::Builder.new do
+          use Middleware::RootPostOnly
+          use Middleware::Authenticate, options
+          use Middleware::Parse
+          use Middleware::Filter, { filter: Routemaster::Middleware::PayloadFilter.new }.merge(options)
+          use Middleware::ExpireCache
+          run terminator
+        end
+      end
+
+      delegate :call => :@app
+      delegate [:on, :subscribe] => :@terminator
+    end
+  end
+end

data/lib/routemaster/drain/caching.rb

@@ -1,9 +1,11 @@
 require 'routemaster/middleware/root_post_only'
 require 'routemaster/middleware/authenticate'
 require 'routemaster/middleware/parse'
+require 'routemaster/middleware/siphon'
 require 'routemaster/middleware/filter'
 require 'routemaster/middleware/dirty'
 require 'routemaster/middleware/cache'
+require 'routemaster/middleware/expire_cache'
 require 'routemaster/drain/terminator'
 require 'rack/builder'
 require 'delegate'
@@ -28,6 +30,8 @@ module Routemaster
           use Middleware::RootPostOnly
           use Middleware::Authenticate, options
           use Middleware::Parse
+          use Middleware::ExpireCache,  options
+          use Middleware::Siphon,       options
           use Middleware::Filter,       options
           use Middleware::Dirty,        options
           use Middleware::Cache,        options
@@ -40,4 +44,3 @@ module Routemaster
     end
   end
 end
-

data/lib/routemaster/drain/mapping.rb

@@ -1,6 +1,7 @@
 require 'routemaster/middleware/root_post_only'
 require 'routemaster/middleware/authenticate'
 require 'routemaster/middleware/parse'
+require 'routemaster/middleware/siphon'
 require 'routemaster/middleware/filter'
 require 'routemaster/middleware/dirty'
 require 'routemaster/drain/terminator'
@@ -29,6 +30,7 @@ module Routemaster
           use Middleware::RootPostOnly
           use Middleware::Authenticate, options
           use Middleware::Parse
+          use Middleware::Siphon,       options
           use Middleware::Filter,       options
           use Middleware::Dirty,        options
           run terminator
@@ -40,4 +42,3 @@ module Routemaster
     end
   end
 end
-

data/lib/routemaster/drain.rb

@@ -1,5 +1,5 @@
 module Routemaster
   module Drain
-    VERSION = '2.4.4'
+    VERSION = '2.5.0'
   end
 end

data/lib/routemaster/middleware/authenticate.rb

@@ -17,7 +17,7 @@ module Routemaster
       include Wisper::Publisher
 
       # @param uuid [Enumerable] a set of accepted authentication tokens
-      def initialize(app, uuid: nil)
+      def initialize(app, uuid: nil, **_)
         @app  = app
         @uuid = uuid || Config.drain_tokens
 
@@ -56,4 +56,3 @@ module Routemaster
     end
   end
 end
-

data/lib/routemaster/middleware/cache.rb

@@ -7,7 +7,7 @@ require 'routemaster/event_index'
 module Routemaster
   module Middleware
     class Cache
-      def initialize(app, cache:nil, client:nil, queue:nil)
+      def initialize(app, cache:nil, client:nil, queue:nil, **_)
         @app    = app
         @cache  = cache || Routemaster::Cache.new
         @client = client || Routemaster::Jobs::Client.new
@@ -16,7 +16,6 @@ module Routemaster
 
       def call(env)
         env.fetch('routemaster.dirty', []).each do |url|
-          @cache.invalidate(url)
           @client.enqueue(@queue, Routemaster::Jobs::CacheAndSweep, url)
         end
         @app.call(env)

data/lib/routemaster/middleware/dirty.rb

@@ -11,7 +11,7 @@ module Routemaster
     # The dirty map is passed as `:map` to the constructor and must respond to
     # `#mark` (like `Routemaster::Dirty::Map`).
     class Dirty
-      def initialize(app, dirty_map:nil)
+      def initialize(app, dirty_map: nil, **_)
         @app = app
         @map = dirty_map || Routemaster::Dirty::Map.new
       end
@@ -28,6 +28,3 @@ module Routemaster
     end
   end
 end
-
-
-

data/lib/routemaster/middleware/expire_cache.rb

@@ -0,0 +1,20 @@
+require 'routemaster/cache'
+
+module Routemaster
+  module Middleware
+    class ExpireCache
+      def initialize(app, cache:nil, **_)
+        @app    = app
+        @cache  = cache || Routemaster::Cache.new
+      end
+
+      def call(env)
+        env.fetch('routemaster.payload', []).each do |event|
+          next if event['type'] == 'noop'
+          @cache.invalidate(event['url'])
+        end
+        @app.call(env)
+      end
+    end
+  end
+end

data/lib/routemaster/middleware/filter.rb

@@ -9,7 +9,7 @@ module Routemaster
     class Filter
       # @param filter [Routemaster::Dirty::Filter] an event filter (optional;
       # will be created using the `redis` and `expiry` options if not provided)
-      def initialize(app, filter:nil)
+      def initialize(app, filter:nil, **_)
         @app    = app
         @filter = filter || Routemaster::Dirty::Filter.new
       end
@@ -19,7 +19,7 @@ module Routemaster
         if payload && payload.any?
           env['routemaster.payload'] = @filter.run(payload)
         end
-        @app.call(env) 
+        @app.call(env)
       end
     end
   end

data/lib/routemaster/middleware/payload_filter.rb

@@ -0,0 +1,10 @@
+module Routemaster
+  module Middleware
+    class PayloadFilter
+      # Filters duplicate events by url and type in a single payload.
+      def run(payload)
+        payload.group_by { |event| [event['url'], event['type']] }.map { |_, events| events.last }
+      end
+    end
+  end
+end

data/lib/routemaster/middleware/siphon.rb

@@ -0,0 +1,32 @@
+module Routemaster
+  module Middleware
+    # Filters out events based on their topic and passes them to a handling class
+    #
+    # `use Middleware::Siphon, 'some_topic' => SomeTopicHandler`
+    #
+    #  Topic handlers are initialized with the full event payload and must respond to `#call`
+    class Siphon
+      def initialize(app, siphon_events: nil)
+        @app = app
+        @processors = siphon_events || {}
+      end
+
+      def call(env)
+        siphoned, non_siphoned = env.fetch('routemaster.payload', []).partition do |event|
+          topics_to_siphon.include? event['topic']
+        end
+        siphoned.each do |event|
+          @processors[event['topic']].new(event).call
+        end
+        env['routemaster.payload'] = non_siphoned
+        @app.call(env)
+      end
+
+      private
+
+      def topics_to_siphon
+        @topics_to_siphon ||= @processors.keys.map(&:to_s)
+      end
+    end
+  end
+end

data/lib/routemaster/resources/rest_resource.rb

@@ -1,3 +1,5 @@
+require 'addressable/template'
+
 require 'routemaster/api_client'
 require 'routemaster/responses/hateoas_enumerable_response'
 require 'routemaster/responses/hateoas_response'
@@ -5,40 +7,48 @@ require 'routemaster/responses/hateoas_response'
 module Routemaster
   module Resources
     class RestResource
-      attr_reader :url
-
       def initialize(url, client: nil)
-        @url = url
+        @url_template = Addressable::Template.new(url)
         @client = client || Routemaster::APIClient.new
       end
 
       def create(params)
         @client.with_response(Responses::HateoasResponse) do
-          @client.post(@url, body: params)
+          @client.post(expanded_url, body: params)
         end
       end
 
       def show(id=nil, enable_caching: true)
         @client.with_response(Responses::HateoasResponse) do
-          @client.get(@url.gsub('{id}', id.to_s), options: { enable_caching: enable_caching })
+          @client.get(expanded_url(id: id), options: { enable_caching: enable_caching })
         end
       end
 
       def index(params: {}, filters: {}, enable_caching: false)
         @client.with_response(Responses::HateoasEnumerableResponse) do
-          @client.get(@url, params: params.merge(filters), options: { enable_caching: enable_caching })
+          @client.get(expanded_url, params: params.merge(filters), options: { enable_caching: enable_caching })
         end
       end
 
       def update(id=nil, params)
         @client.with_response(Responses::HateoasResponse) do
-          @client.patch(@url.gsub('{id}', id.to_s), body: params)
+          @client.patch(expanded_url(id: id), body: params)
         end
       end
 
       def destroy(id=nil)
         # no response wrapping as DELETE is supposed to 204.
-        @client.delete(@url.gsub('{id}', id.to_s))
+        @client.delete(expanded_url(id: id))
+      end
+
+      def url
+        @url_template.pattern
+      end
+
+      private
+
+      def expanded_url(**params)
+        @url_template.expand(params).to_s
       end
     end
   end

data/routemaster-drain.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = %w(lib)
 
+  spec.add_runtime_dependency     'addressable'
   spec.add_runtime_dependency     'faraday', '>= 0.9.0'
   spec.add_runtime_dependency     'faraday_middleware'
   spec.add_runtime_dependency     'typhoeus', '~> 1.1'

data/spec/routemaster/api_client_spec.rb

@@ -111,12 +111,7 @@ describe Routemaster::APIClient do
       end
 
       let(:callback){
-        subject.on_success do
-          callback_spy.success
-        end
-        subject.on_error do
-          callback_spy.error
-        end
+        subject.on_success { callback_spy.success }.zip(subject.on_error { callback_spy.error })
       }
 
       context "when successful" do

data/spec/routemaster/drain/cache_busting_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'spec/support/rack_test'
+require 'spec/support/uses_redis'
+require 'spec/support/uses_dotenv'
+require 'spec/support/events'
+require 'routemaster/drain/cache_busting'
+require 'json'
+
+describe Routemaster::Drain::CacheBusting do
+  uses_dotenv
+  uses_redis
+
+  let(:app) { described_class.new }
+  let(:listener) { double 'listener' }
+
+  before { app.subscribe(listener, prefix: true) }
+
+  let(:path)    { '/' }
+  let(:payload) { [1,2,3,1].map { |idx| make_event(idx) }.to_json }
+  let(:environment) {{ 'CONTENT_TYPE' => 'application/json' }}
+  let(:perform) { post path, payload, environment }
+
+  before { authorize 'd3m0', 'x' }
+
+  it 'succeeds' do
+    perform
+    expect(last_response.status).to eq(204)
+  end
+
+  it 'emits events' do
+    expect(listener).to receive(:on_events_received) do |payload|
+      expect(payload.size).to eq(3)
+    end
+    perform
+  end
+
+  it 'increments the event index' do
+    ei_double = double(increment: 1)
+    allow(Routemaster::EventIndex).to receive(:new).and_return(ei_double)
+    expect(ei_double).to receive(:increment).exactly(3).times
+    perform
+  end
+end

data/spec/routemaster/drain/caching_spec.rb

@@ -3,25 +3,31 @@ require 'spec/support/rack_test'
 require 'spec/support/uses_redis'
 require 'spec/support/uses_dotenv'
 require 'spec/support/events'
+require 'spec/support/siphon'
+
 require 'routemaster/drain/caching'
+
 require 'json'
 
 describe Routemaster::Drain::Caching do
   uses_dotenv
   uses_redis
 
-  let(:app) { described_class.new }
+  let(:app) { described_class.new options}
   let(:listener) { double 'listener' }
+  let(:options) { {} }
 
   before { app.subscribe(listener, prefix: true) }
 
   let(:path)    { '/' }
-  let(:payload) { [1,2,3,1].map { |idx| make_event(idx) }.to_json }
+  let(:payload) { [1,2,3,1].map { |idx| make_event(idx) } }
   let(:environment) {{ 'CONTENT_TYPE' => 'application/json' }}
-  let(:perform) { post path, payload, environment }
+  let(:perform) { post path, payload.to_json, environment }
 
   before { authorize 'd3m0', 'x' }
 
+  include_examples 'supports siphon'
+
   it 'succeeds' do
     perform
     expect(last_response.status).to eq(204)
@@ -37,7 +43,7 @@ describe Routemaster::Drain::Caching do
   it 'increments the event index' do
     ei_double = double(increment: 1)
     allow(Routemaster::EventIndex).to receive(:new).and_return(ei_double)
-    expect(ei_double).to receive(:increment).exactly(3).times
+    expect(ei_double).to receive(:increment).exactly(4).times
     perform
   end
 

data/spec/routemaster/drain/mapping_spec.rb

@@ -3,6 +3,7 @@ require 'spec/support/rack_test'
 require 'spec/support/uses_redis'
 require 'spec/support/uses_dotenv'
 require 'spec/support/events'
+require 'spec/support/siphon'
 require 'routemaster/drain/mapping'
 require 'json'
 
@@ -10,18 +11,21 @@ describe Routemaster::Drain::Mapping do
   uses_dotenv
   uses_redis
 
-  let(:app) { described_class.new }
+  let(:app) { described_class.new(options) }
+  let(:options) { {} }
   let(:listener) { double 'listener' }
-  
+
   before { app.subscribe(listener, prefix: true) }
 
   let(:path)    { '/' }
-  let(:payload) { [1,2,3,1].map { |idx| make_event(idx) }.to_json }
+  let(:payload) { [1,2,3,1].map { |idx| make_event(idx) } }
   let(:environment) {{ 'CONTENT_TYPE' => 'application/json' }}
-  let(:perform) { post path, payload, environment }
+  let(:perform) { post path, payload.to_json, environment }
 
   before { authorize 'd3m0', 'x' }
 
+  include_examples 'supports siphon'
+
   it 'succeeds' do
     perform
     expect(last_response.status).to eq(204)
@@ -35,11 +39,11 @@ describe Routemaster::Drain::Mapping do
   end
 
   let(:map) { Routemaster::Dirty::Map.new }
-  
+
   it 'uses dirty map' do
     payload1 = [1,2,3,1].map { |idx| make_event(idx) }.to_json
     payload2 = [1,4,5,2].map { |idx| make_event(idx) }.to_json
-    
+
     post path, payload1, environment
     expect(map.count).to eq(3)
     map.sweep_one("https://example.com/stuff/1") { true }
@@ -48,4 +52,3 @@ describe Routemaster::Drain::Mapping do
     expect(map.count).to eq(4) # 2, 3, 4, 5 (1 is a repeat event, filtered out)
   end
 end
-

data/spec/routemaster/middleware/cache_spec.rb

@@ -19,11 +19,6 @@ RSpec.describe Routemaster::Middleware::Cache do
   describe '#call' do
     let(:payload) { ['https://example.com/1'] }
 
-    it 'increments the event_index' do
-      expect(cache).to receive(:invalidate)
-      perform
-    end
-
     it 'queues a fetch job' do
       expect(client).to receive(:enqueue).with('routemaster', Routemaster::Jobs::CacheAndSweep, 'https://example.com/1')
       perform

data/spec/routemaster/middleware/root_post_only_spec.rb

@@ -40,7 +40,3 @@ describe Routemaster::Middleware::RootPostOnly do
     end
   end
 end
-
-
-
-

data/spec/routemaster/middleware/siphon_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+require 'spec/support/rack_test'
+require 'spec/support/events'
+require 'routemaster/middleware/siphon'
+require 'json'
+
+describe Routemaster::Middleware::Siphon do
+  let(:terminator) { ErrorRackApp.new }
+  let(:app) { described_class.new(terminator, options) }
+
+  let(:perform) do
+    post '/whatever', '', 'routemaster.payload' => payload
+  end
+
+  describe '#call' do
+
+    let(:options) { { filter:filter } }
+    let(:payload) { [ make_event(1), make_event(1).merge({'topic' => 'notstuff'})] }
+
+    context "if no siphon is defined" do
+      let(:options) { {} }
+
+      it "passes all to the terminator"  do
+        perform
+        expect(terminator.last_env['routemaster.payload']).to eq payload
+      end
+    end
+
+    context "if a 'stuff' siphon is defined" do
+      let(:siphon_double) { double(new: siphon_instance) }
+      let(:siphon_instance) { double(call: nil) }
+      let(:options) { { siphon_events: { 'stuff' => siphon_double } } } 
+
+      it "calls the siphon with the event" do
+        perform
+        expect(siphon_double).to have_received(:new).with(payload[0])
+        expect(siphon_instance).to have_received(:call)
+      end
+
+      it "passes 'notstuff' to the terminator"  do
+        perform
+        expect(terminator.last_env['routemaster.payload']).to eq [payload[1]]
+      end
+    end
+  end
+end

data/spec/routemaster/resources/rest_resource_spec.rb

@@ -4,46 +4,55 @@ require 'routemaster/resources/rest_resource'
 module Routemaster
   module Resources
     RSpec.describe RestResource do
-      let(:url) { 'test_url' }
       let(:client) { double('Client') }
       let(:params) { {} }
 
-      subject { described_class.new(url, client: client) }
-
       before { allow(client).to receive(:with_response).and_yield }
 
-      describe '#create' do
-        it 'posts to the given url' do
-          expect(client).to receive(:post).with(url, body: params)
-          subject.create(params)
+      describe "singular resource" do
+        let(:url) { '/resources/1' }
+
+        subject { described_class.new('/resources/{id}', client: client) }
+
+        describe '#show' do
+          it 'gets to the given url' do
+            expect(client).to receive(:get).with(url, options: { enable_caching: true })
+            subject.show(1)
+          end
         end
-      end
 
-      describe '#show' do
-        it 'gets to the given url' do
-          expect(client).to receive(:get).with(url, options: { enable_caching: true })
-          subject.show(1)
+        describe '#update' do
+          it 'updates the given resource' do
+            expect(client).to receive(:patch).with(url, body: params)
+            subject.update(1, params)
+          end
         end
-      end
 
-      describe '#index' do
-        it 'gets to the given url' do
-          expect(client).to receive(:get).with(url, params: {}, options: { enable_caching: false })
-          subject.index
+        describe '#destroy' do
+          it 'destroys the given resource' do
+            expect(client).to receive(:delete).with(url)
+            subject.destroy(1)
+          end
         end
       end
 
-      describe '#update' do
-        it 'updates the given resource' do
-          expect(client).to receive(:patch).with(url, body: params)
-          subject.update(1, params)
+      describe "collection resource" do
+        let(:url) { '/resources' }
+
+        subject { described_class.new('/resources{?page,per_page}', client: client) }
+
+        describe '#create' do
+          it 'posts to the given url' do
+            expect(client).to receive(:post).with(url, body: params)
+            subject.create(params)
+          end
         end
-      end
 
-      describe '#destroy' do
-        it 'destroys the given resource' do
-          expect(client).to receive(:delete).with(url)
-          subject.destroy(1)
+        describe '#index' do
+          it 'gets to the given url' do
+            expect(client).to receive(:get).with(url, params: {}, options: { enable_caching: false })
+            subject.index
+          end
         end
       end
     end

data/spec/support/siphon.rb

@@ -0,0 +1,13 @@
+RSpec.shared_examples 'supports siphon' do
+  context "if a siphon is defined" do
+    let(:siphon_double) { double(new: siphon_instance) }
+    let(:siphon_instance) { double(call: nil) }
+    let(:options){ { siphon_events: { payload[0]['topic'] => siphon_double } } }
+
+    it "calls the siphon with the event" do
+      perform
+      expect(siphon_double).to have_received(:new).with(payload[0]).at_least(:once)
+      expect(siphon_instance).to have_received(:call).at_least(:once)
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-drain
 version: !ruby/object:Gem::Version
-  version: 2.4.4
+  version: 2.5.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 2017-04-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +178,7 @@ files:
 - lib/routemaster/dirty/state.rb
 - lib/routemaster/drain.rb
 - lib/routemaster/drain/basic.rb
+- lib/routemaster/drain/cache_busting.rb
 - lib/routemaster/drain/caching.rb
 - lib/routemaster/drain/mapping.rb
 - lib/routemaster/drain/terminator.rb
@@ -180,11 +195,14 @@ files:
 - lib/routemaster/middleware/cache.rb
 - lib/routemaster/middleware/dirty.rb
 - lib/routemaster/middleware/error_handling.rb
+- lib/routemaster/middleware/expire_cache.rb
 - lib/routemaster/middleware/filter.rb
 - lib/routemaster/middleware/metrics.rb
 - lib/routemaster/middleware/parse.rb
+- lib/routemaster/middleware/payload_filter.rb
 - lib/routemaster/middleware/response_caching.rb
 - lib/routemaster/middleware/root_post_only.rb
+- lib/routemaster/middleware/siphon.rb
 - lib/routemaster/null_logger.rb
 - lib/routemaster/redis_broker.rb
 - lib/routemaster/resources/rest_resource.rb
@@ -198,6 +216,7 @@ files:
 - spec/routemaster/dirty/map_spec.rb
 - spec/routemaster/dirty/state_spec.rb
 - spec/routemaster/drain/basic_spec.rb
+- spec/routemaster/drain/cache_busting_spec.rb
 - spec/routemaster/drain/caching_spec.rb
 - spec/routemaster/drain/mapping_spec.rb
 - spec/routemaster/drain/terminator_spec.rb
@@ -214,6 +233,7 @@ files:
 - spec/routemaster/middleware/filter_spec.rb
 - spec/routemaster/middleware/parse_spec.rb
 - spec/routemaster/middleware/root_post_only_spec.rb
+- spec/routemaster/middleware/siphon_spec.rb
 - spec/routemaster/redis_broker_spec.rb
 - spec/routemaster/resources/rest_resource_spec.rb
 - spec/routemaster/responses/hateoas_enumerable_response_spec.rb
@@ -224,6 +244,7 @@ files:
 - spec/support/events.rb
 - spec/support/rack_test.rb
 - spec/support/server.rb
+- spec/support/siphon.rb
 - spec/support/uses_dotenv.rb
 - spec/support/uses_redis.rb
 - spec/support/uses_webmock.rb
@@ -258,6 +279,7 @@ test_files:
 - spec/routemaster/dirty/map_spec.rb
 - spec/routemaster/dirty/state_spec.rb
 - spec/routemaster/drain/basic_spec.rb
+- spec/routemaster/drain/cache_busting_spec.rb
 - spec/routemaster/drain/caching_spec.rb
 - spec/routemaster/drain/mapping_spec.rb
 - spec/routemaster/drain/terminator_spec.rb
@@ -274,6 +296,7 @@ test_files:
 - spec/routemaster/middleware/filter_spec.rb
 - spec/routemaster/middleware/parse_spec.rb
 - spec/routemaster/middleware/root_post_only_spec.rb
+- spec/routemaster/middleware/siphon_spec.rb
 - spec/routemaster/redis_broker_spec.rb
 - spec/routemaster/resources/rest_resource_spec.rb
 - spec/routemaster/responses/hateoas_enumerable_response_spec.rb
@@ -284,6 +307,7 @@ test_files:
 - spec/support/events.rb
 - spec/support/rack_test.rb
 - spec/support/server.rb
+- spec/support/siphon.rb
 - spec/support/uses_dotenv.rb
 - spec/support/uses_redis.rb
 - spec/support/uses_webmock.rb