README.md in routemaster-drain-1.0.5 vs README.md in routemaster-drain-1.1.0

- old
+ new

@@ -1,15 +1,17 @@ # routemaster-drain A Rack-based event receiver for the -[Routemaster](https://github.com/HouseTrip/routemaster) event bus. +[Routemaster](https://github.com/mezis/routemaster) event bus. [![Version](https://badge.fury.io/rb/routemaster-drain.svg)](https://rubygems.org/gems/routemaster-drain)   -[![Build](https://travis-ci.org/HouseTrip/routemaster-drain.svg?branch=master)](https://travis-ci.org/HouseTrip/routemaster-drain) +[![Build](https://travis-ci.org/mezis/routemaster-drain.svg?branch=master)](https://travis-ci.org/mezis/routemaster-drain)   -[![Docs](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/HouseTrip/routemaster-drain/frames/file/README.md) +[![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) `routemaster-drain` is a collection of Rack middleware to receive and parse Routemaster events, filter them, and preemptively cache the corresponding resources. @@ -209,21 +211,21 @@ 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/HouseTrip/routemaster-drain/Routemaster/Cache) +[rubydoc](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Cache) for more details on `Cache`. ## Internals The more elaborate drains are built with two components which can also be used independently, -[`Dirty::Map`](http://rubydoc.info/github/HouseTrip/routemaster-drain/Routemaster/Dirty/Map) +[`Dirty::Map`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Map) and -[`Dirty::Filter`](http://rubydoc.info/github/HouseTrip/routemaster-drain/Routemaster/Dirty/Filter). +[`Dirty::Filter`](http://rubydoc.info/github/mezis/routemaster-drain/Routemaster/Dirty/Filter). ### Dirty map A dirty map collects entities that have been created, updated, or deleted (or rather, their URLs). It can be used to delay your service's reaction to events, @@ -231,36 +233,36 @@ 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/HouseTrip/routemaster-drain/Routemaster/Dirty/Map) +[`Routemaster::Dirty::Map`](http://rubydoc.info/github/mezis/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/HouseTrip/routemaster-drain/Routemaster/Dirty/Map#sweep_one-instance_method). +[`#sweep_one`](http://rubydoc.info/github/mezis/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/HouseTrip/routemaster-drain/Routemaster/Dirty/Map#sweep-instance_method) +[`#sweep`](http://rubydoc.info/github/mezis/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/HouseTrip/routemaster-drain/Routemaster/Dirty/Filter) is a simple event filter +[`Routemaster::Dirty::Filter`](http://rubydoc.info/github/mezis/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. 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. ## Contributing -1. Fork it ( http://github.com/HouseTrip/routemaster-drain/fork ) +1. Fork it ( http://github.com/mezis/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`) 5. Create new Pull Request