housetrip/routemaster-client

Ruby client API for the Routemaster event bus

routemaster-client's Issues

Add option to connect lazily (not on #initialize)

Fix Faraday compatibility

Faraday 0.8.9 and 0.8.4 have incompatibilities. #9 is not acceptable (locks old Faraday version).

Make the client code work with both, use appraisal to test.

Add cache priming

When receiving an event, call the endpoint to get data, and cache the results (forever as the next event should bust the cache).

Use Faraday + caching for this.

Add dirty map management on the receiver side

Make this an optional feature.

Keep a mapping of the latest known state of all known entities.
In a contingency (lost events, full refresh) they can all be marked as dirty.

The dirty map should take timestamps into account, to honour out-of-order events being received.

This can be implemented as a replacement middleware (that doesn't need to take a block) and an extra class that lets users work form the dirty map directly (instead of being event-driven).

When subscribing should raise error if callback is not properly formatted

I think the gem should raise an error if the URL is malformed: for example if not https. Or else it fails silently - does not subscribe.

documented methods missing?

These methods in the README are not implimented yet:

client.monitor_topics
client.monitor_subscriptions

Maybe we can remove or add a "TODO" to the docs? (happy to submit a PR for either)

Receivers should be Rack apps, not middleware

.. and be used with map /events .. run instead.

Making this backwards-compatible should be interesting.

OpenSsl warning due to monkey patch

OpenSSL::SSL::VERIFY_PEER == OpenSSL::SSL::VERIFY_NONE
This dangerous monkey patch leaves you open to MITM attacks!
Try passing :verify_ssl => false instead.

Can we possibly get rid of routemaster/client/openssl.rb?

Redirect non-HTTPs connections

And add a warning message to suggest using Rack::SSL.

SSL warning on development env's

client/openssl.rb#L15 (https://github.com/HouseTrip/routemaster_client/blob/master/routemaster/client/openssl.rb#L15) triggers a warning when booting the main application.

/Users/jesper/Code/HouseTrip/gems/ruby/1.9.1/bundler/gems/routemaster_client-c3f88668c158/routemaster/client/openssl.rb:15: warning: already initialized constant VERIFY_PEER

Add optional buffering on the sender side

In case of bus failure, events can be retried through the buffer.
The buffer should keep timestamps.