routemaster-client 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17d6f2b6dd28fd082771df65f57fd41f8cbbc2f6
-  data.tar.gz: a97e8c84d7c1a193e64fefbf2a55a18805d65aec
+  metadata.gz: cd1e1f24e8d625dbdd9824f986e1c3fe57107575
+  data.tar.gz: ea838ffeb71a05fca351a41b00075bad143ec31f
 SHA512:
-  metadata.gz: 2b8fa2d106cc69d3cb0edc75eb430d8c659a81b2686b92b6501b3789f006dbf0e92a7e4900361f2461090cb4f2560267db2d016b0f6c3d554c1171e94127e897
-  data.tar.gz: 66d7c256ae0ada32ea8afed4590bcd4a99df183791a8193a08249ea97f76d9586be067bc322f47b435bde09f90d5f88779a711121c1dc29b1df84746cec532ef
+  metadata.gz: 8f08a91701b5d8984fe51fe40f0c9c659647f0648a9ef432422e471b821c5c4fd7092efe4db5a8cf5e2d030438ab4f67c92e89669d6a509ae47531d02254c6b6
+  data.tar.gz: bbc44b01fed6ecb14932da518d67bbff9c9b38823bc8a98cf77de6f124d9868c496eea1f4f7d26924e320544e793cebf61609846910eaf52a024467cdeb09ae7

data/.travis.yml

@@ -3,9 +3,14 @@ cache: bundler
 rvm:
   - 2.2.5
   - 2.3.1
+  - 2.4.0
+  - ruby-head
 script:
-- bundle exec rspec
-- bundle exec codeclimate-test-reporter
+  - bundle exec rspec
+  - bundle exec codeclimate-test-reporter
 addons:
   code_climate:
     repo_token: b1d80c686f42ee5eb66895c4b0ac5c0d978e964d4700eae35aa0138f5a650c02
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# v3.1.0 (2017-03-28) 
+
+Features: 
+
+- Adds support for event payloads (#16)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    routemaster-client (3.0.0)
+    routemaster-client (3.1.0)
       faraday (>= 0.9.0)
       oj (~> 2.17)
       typhoeus (~> 1.1)
@@ -13,22 +13,22 @@ GEM
     addressable (2.5.0)
       public_suffix (~> 2.0, >= 2.0.2)
     byebug (9.0.6)
-    codeclimate-test-reporter (1.0.3)
-      simplecov
+    codeclimate-test-reporter (1.0.8)
+      simplecov (<= 0.13)
     coderay (1.1.1)
-    concurrent-ruby (1.0.2)
+    concurrent-ruby (1.0.5)
     connection_pool (2.2.1)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
+    diff-lcs (1.3)
     docile (1.1.5)
     ethon (0.10.1)
       ffi (>= 1.3.0)
-    faraday (0.10.0)
+    faraday (0.11.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.14)
+    ffi (1.9.18)
     formatador (0.2.5)
-    guard (2.14.0)
+    guard (2.14.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (~> 1.0)
@@ -42,39 +42,39 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    hashdiff (0.3.1)
-    json (2.0.2)
+    hashdiff (0.3.2)
+    json (2.0.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)
+    lumberjack (1.0.11)
     method_source (0.8.2)
     multipart-post (2.0.0)
     nenv (0.3.0)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    oj (2.18.0)
+    oj (2.18.3)
     pry (0.10.4)
       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)
+    psych (2.2.4)
+    public_suffix (2.0.5)
     rack (2.0.1)
     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)
+    rb-inotify (0.9.8)
       ffi (>= 0.5.0)
-    redis (3.3.2)
+    redis (3.3.3)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -91,12 +91,12 @@ GEM
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
-    sidekiq (4.2.1)
+    sidekiq (4.2.10)
       concurrent-ruby (~> 1.0)
       connection_pool (~> 2.2, >= 2.2.0)
-      rack-protection (~> 1.5)
+      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)
@@ -105,7 +105,7 @@ GEM
     thor (0.19.4)
     typhoeus (1.1.2)
       ethon (>= 0.9.0)
-    webmock (2.3.1)
+    webmock (2.3.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff
@@ -128,4 +128,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.13.6
+   1.14.5

data/README.md

@@ -26,18 +26,9 @@ Or install it yourself as:
 ```ruby
 require 'routemaster/client'
 Routemaster::Client.configure do |config|
-  config.url = 'https://bs.example.com'
-  config.uuid = 'demo'
-end
-```
-
-You can also specify a timeout value in seconds if you like with the ```timeout``` option.
-
-```ruby
-Routemaster::Client.configure do |config|
-  config.url = 'https://bs.example.com'
-  config.uuid = 'demo'
-  config.timeout = 2
+  config.url = 'https://bus.example.com'
+  config.uuid = 'demo' # HTTP Basic token used to talk to the bus
+  config.timeout = 2 # in seconds
 end
 ```
 
@@ -45,9 +36,7 @@ If you are using Sidekiq in your project, you can specify the usage of a Sidekiq
 
 ```ruby
 Routemaster::Client.configure do |config|
-  config.url = 'https://bs.example.com'
-  config.uuid = 'demo'
-  config.timeout = 2
+  # ...
   config.async_backend = Routemaster::Client::Backends::Sidekiq.configure do |sidekiq|
   	sidekiq.queue = :realtime
   	sidekiq.retry = false
@@ -74,18 +63,23 @@ A timestamp argument may be passed (it will be set by the bus automatically
 otherwise); it must be an integer number of milliseconds since the UNIX Epoch:
 
 ```ruby
-Routemaster::Client.created('widgets', 'https://app.example.com/widgets/1', 1473080555409)
+Routemaster::Client.created('widgets', 'https://app.example.com/widgets/1', t: 1473080555409)
 ```
 
-**Async**
-You can also push events asynchronously if you have an async backend defined, for each
-event method there is a corresponding `event_async` method. eg
+You can also push events asynchronously if you have configured a backend that
+supports this (otherwise an error will be raised):
+
 ```ruby
-   Routemaster::Client.updated_async('widgets', 'https://app.example.com/widgets/2')
+Routemaster::Client.updated('widgets', 'https://app.example.com/widgets/2', async: true)
 ```
 
-You cannot use these methods without defining an async backend, if you try then an error will
-be raised.
+A data payload can be sent alongside the event. It is strongly discouraged to do
+this except extrame circumstances (particularly as schema migrations become very
+painful):
+
+```ruby
+Routemaster::Client.created('cats', 'https://app.example.com/cats/42', data: { 'color' => 'teal' })
+```
 
 **Subscribe** to be notified about `widgets` and `kitten` at most 60 seconds after
 events, in batches of at most 500 events, to a given callback URL:
@@ -100,30 +94,6 @@ Routemaster::Client.subscribe(
 ```
 
 
-**Receive** events at path `/events` using a Rack middleware:
-
-```ruby
-require 'routemaster/receiver'
-
-class Listener
-  def on_events_received(batch)
-    batch.each do |event|
-      puts event['url']
-    end
-  end
-end
-
-Wisper.subscribe(Listener.new, :prefix => true)
-
-use Routemaster::Receiver, {
-  path:    '/events',
-  uuid:    'demo'
-}
-```
-
-This relies on the excellent event bus from the [wisper
-gem](https://github.com/krisleech/wisper#wisper).
-
 **Unsubscribe** from a single topic:
 
 ```ruby

data/routemaster/client.rb

@@ -30,36 +30,48 @@ module Routemaster
         end
       end
 
-      def created(topic, callback, timestamp = nil)
-        _send_event('create', topic, callback, timestamp)
+      def created(topic, callback, timestamp = nil, t: nil, async: false, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _send_event('create', topic, callback, t: t || timestamp, async: async, data: data)
       end
 
-      def created_async(topic, callback, timestamp = nil)
-        _send_event('create', topic, callback, timestamp, async: true)
+      def created_async(topic, callback, timestamp = nil, t: nil, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _warn_async_deprecation
+        _send_event('create', topic, callback, t: t || timestamp, async: true, data: data)
       end
 
-      def updated(topic, callback, timestamp = nil)
-        _send_event('update', topic, callback, timestamp)
+      def updated(topic, callback, timestamp = nil, t: nil, async: false, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _send_event('update', topic, callback, t: t || timestamp, async: async, data: data)
       end
 
-      def updated_async(topic, callback, timestamp = nil)
-        _send_event('update', topic, callback, timestamp, async: true)
+      def updated_async(topic, callback, timestamp = nil, t: nil, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _warn_async_deprecation
+        _send_event('update', topic, callback, t: t || timestamp, async: true, data: data)
       end
 
-      def deleted(topic, callback, timestamp = nil)
-        _send_event('delete', topic, callback, timestamp)
+      def deleted(topic, callback, timestamp = nil, t: nil, async: false, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _send_event('delete', topic, callback, t: t || timestamp, async: async, data: data)
       end
 
-      def deleted_async(topic, callback, timestamp = nil)
-        _send_event('delete', topic, callback, timestamp, async: true)
+      def deleted_async(topic, callback, timestamp = nil, t: nil, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _warn_async_deprecation
+        _send_event('delete', topic, callback, t: t || timestamp, async: true, data: data)
       end
 
-      def noop(topic, callback, timestamp = nil)
-        _send_event('noop', topic, callback, timestamp)
+      def noop(topic, callback, timestamp = nil, t: nil, async: false, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _send_event('noop', topic, callback, t: t || timestamp, async: async, data: data)
       end
 
-      def noop_async(topic, callback, timestamp = nil)
-        _send_event('noop', topic, callback, timestamp, async: true)
+      def noop_async(topic, callback, timestamp = nil, t: nil, data: nil)
+        _warn_timestamp_deprecation(timestamp)
+        _warn_async_deprecation
+        _send_event('noop', topic, callback, t: t || timestamp, async: true, data: data)
       end
 
       def subscribe(topics:, callback:, **options)
@@ -165,13 +177,20 @@ module Routemaster
         end
       end
 
-      def _send_event(event, topic, callback, timestamp = nil, async: false)
+      def _assert_valid_data(value)
+        !! Oj.dump(value, mode: :strict)
+      rescue TypeError => e
+        raise InvalidArgumentError, e
+      end
+
+      def _send_event(event, topic, callback, t: nil, async: false, data: nil)
         _assert_valid_url!(callback)
         _assert_valid_topic!(topic)
-        _assert_valid_timestamp!(timestamp) if timestamp
+        _assert_valid_timestamp!(t) if t
+        _assert_valid_data(data) if data
 
         backend = async ? async_backend : _synchronous_backend
-        backend.send_event(event, topic, callback, timestamp)
+        backend.send_event(event, topic, callback, t: t, data: data)
       end
 
       def _check_pulse!
@@ -180,6 +199,17 @@ module Routemaster
         end
       end
 
+      def _warn_async_deprecation
+        warn 'routemaster-client: The _*_async event-sending methods are deprecated. Use async: true instead.'
+        warn "(in #{caller(2,1).first})"
+      end
+
+      def _warn_timestamp_deprecation(value)
+        return if value.nil?
+        warn 'routemaster-client: Passing timestamps as positional parameters is deprecated. Use the t: key instead.'
+        warn "(in #{caller(2,1).first})"
+      end
+
       private :async_backend, :lazy
     end
   end

data/routemaster/client/backends/sidekiq/worker.rb

@@ -6,12 +6,13 @@ module Routemaster
       class Sidekiq
         class Worker
           include ::Sidekiq::Worker
-          extend Forwardable
 
-          def_delegator :'Routemaster::Client::Connection', :send_event
-          alias :perform :send_event
-
-          private :send_event
+          def perform(*args)
+            # Sidekiq does not have transparent argument serialization.
+            # This extracts the options so they can be passed on properly.
+            options = args.last.kind_of?(Hash) ? args.pop.symbolize_keys : {}
+            Routemaster::Client::Connection.send_event(*args, **options)
+          end
         end
       end
     end

data/routemaster/client/connection.rb

@@ -22,12 +22,13 @@ module Routemaster
           _conn.send(method, path, &block)
         end
 
-        def send_event(event, topic, callback, timestamp = nil)
-          data = { type: event, url: callback, timestamp: timestamp }
+        def send_event(event, topic, callback, t: nil, data: nil)
+          payload = { 'type' => event, 'url' => callback, 'timestamp' => t }
+          payload['data'] = data unless data.nil?
 
           response = post("/topics/#{topic}") do |r|
             r.headers['Content-Type'] = 'application/json'
-            r.body = Oj.dump(_stringify_keys data)
+            r.body = Oj.dump(payload, mode: :strict)
           end
           fail "event rejected (#{response.status})" unless response.success?
 

data/routemaster/client/version.rb

@@ -1,5 +1,5 @@
 module Routemaster
   module Client
-    VERSION = '3.0.0'
+    VERSION = '3.1.0'
   end
 end

data/routemaster/receiver.rb

@@ -8,14 +8,13 @@ module Routemaster
     include Wisper::Publisher
 
     def initialize(app, options = {})
+      warn 'Routemaster::Receiver is deprecated, use Routemaster::Drain::Basic instead'
+      warn "(at #{caller(2,1).first})"
+
       @app     = app
       @path    = options[:path]
       @uuid    = options[:uuid]
-
-      if options[:handler]
-        warn 'the :handler option is deprecated, listen to the :events_received event instead'
-        @handler = options[:handler]
-      end
+      @handler = options[:handler] if options[:handler]
     end
 
     def call(env)

data/spec/client_spec.rb

@@ -61,7 +61,7 @@ describe Routemaster::Client do
   shared_examples 'an unconfigured async event sender' do
     let(:callback) { 'https://app.example.com/widgets/123' }
     let(:topic)    { 'widgets' }
-    let(:perform)  { subject.send(method, topic, callback) }
+    let(:perform)  { subject.send(method, topic, callback, **flags) }
     let(:http_status) { nil }
 
     it 'raises an error' do
@@ -72,7 +72,7 @@ describe Routemaster::Client do
   shared_examples 'an event sender' do
     let(:callback) { 'https://app.example.com/widgets/123' }
     let(:topic)    { 'widgets' }
-    let(:perform)  { subject.send(event, topic, callback) }
+    let(:perform)  { subject.send(event, topic, callback, **flags) }
     let(:http_status) { nil }
 
     before do
@@ -136,7 +136,7 @@ describe Routemaster::Client do
 
     context 'with explicit timestamp' do
       let(:timestamp) { (Time.now.to_f * 1e3).to_i }
-      let(:perform)   { subject.send(event, topic, callback, timestamp) }
+      let(:perform)   { subject.send(event, topic, callback, t: timestamp) }
 
       before do
         @stub = stub_request(:post, 'https://@bus.example.com/topics/widgets').
@@ -168,106 +168,116 @@ describe Routemaster::Client do
         end
       end
     end
-  end
 
-  context "With no background worker specified" do
-    describe '#created' do
-      let(:event) { 'created' }
-      it_behaves_like 'an event sender'
-    end
+    context 'with a data payload' do
+      let(:timestamp) { (Time.now.to_f * 1e3).to_i }
+      let(:perform)   { subject.send(event, topic, callback, data: data) }
+      let(:data) {{ 'foo' => 'bar' }}
 
-    describe '#created_async' do
-      let(:method) { 'created_async' }
-      it_behaves_like 'an unconfigured async event sender'
-    end
+      before do
+        @stub = stub_request(:post, 'https://@bus.example.com/topics/widgets').
+          with(
+            body: hash_including(data: data),
+            basic_auth: [options[:uuid], 'x'],
+          ).
+          to_return(status: 200)
+      end
 
-    describe '#updated' do
-      let(:event) { 'updated' }
-      it_behaves_like 'an event sender'
-    end
+      it 'sends the event' do
+        perform
+        expect(@stub).to have_been_requested
+      end
 
-    describe '#updated_async' do
-      let(:method) { 'updated_async' }
-      it_behaves_like 'an unconfigured async event sender'
-    end
+      context 'with non-serializable data' do
+        let(:data) { [:foo, 'bar'] }
 
-    describe '#deleted' do
-      let(:event) { 'deleted' }
-      it_behaves_like 'an event sender'
+        it 'fails' do
+          expect { perform }.to raise_error(Routemaster::Client::InvalidArgumentError)
+        end
+      end
     end
+  end
 
-    describe '#deleted_async' do
-      let(:method) { 'deleted_async' }
-      it_behaves_like 'an unconfigured async event sender'
+  context 'without a background worker specified' do
+    context 'with default flags' do
+      %w[created updated deleted noop].each do |m|
+        describe "##{m}" do
+          let(:event) { m.to_sym }
+          let(:flags) { {} }
+          it_behaves_like 'an event sender'
+        end
+      end
     end
 
-    describe '#noop' do
-      let(:event) { 'noop' }
-      it_behaves_like 'an event sender'
+    context 'with the :async flag' do
+      %w[created updated deleted noop].each do |m|
+        describe "##{m}" do
+          let(:method) { m }
+          let(:flags) { { async: true } }
+          it_behaves_like 'an unconfigured async event sender'
+        end
+      end
     end
 
-    describe '#noop_async' do
-      let(:method) { 'noop_async' }
-      it_behaves_like 'an unconfigured async event sender'
+    describe 'deprecated *_async methods' do
+      %w[created updated deleted noop].each do |m|
+        describe "##{m}_async" do
+          let(:method) { "#{m}_async" }
+          let(:flags) { {} }
+          it_behaves_like 'an unconfigured async event sender'
+        end
+      end
     end
   end
 
- context "With the sidekiq back end" do
-   reset_sidekiq_config_between_tests!
-
-   before do
-     options[:async_backend] = Routemaster::Client::Backends::Sidekiq.configure do |config|
-       config.queue = :realtime
-       config.retry = true
-     end
-   end
-
-   around do |example|
-     Sidekiq::Testing.inline! do
-       example.run
-     end
-   end
-
-   describe '#created' do
-     let(:event) { 'created' }
-     it_behaves_like 'an event sender'
-   end
-
-    describe '#created_async' do
-      let(:event) { 'created_async' }
-      it_behaves_like 'an event sender'
-    end
-
-   describe '#updated' do
-     let(:event) { 'updated' }
-     it_behaves_like 'an event sender'
-   end
-
-   describe '#updated_async' do
-     let(:event) { 'updated_async' }
-     it_behaves_like 'an event sender'
-   end
-
-   describe '#deleted' do
-     let(:event) { 'deleted' }
-     it_behaves_like 'an event sender'
-   end
-
-   describe '#deleted_async' do
-     let(:event) { 'deleted_async' }
-     it_behaves_like 'an event sender'
-   end
-
-   describe '#noop' do
-     let(:event) { 'noop' }
-     it_behaves_like 'an event sender'
-   end
-
-   describe '#noop_async' do
-     let(:event) { 'noop_async' }
-     it_behaves_like 'an event sender'
-   end
- end
+  context 'with the sidekiq async back end configured' do
+    reset_sidekiq_config_between_tests!
+ 
+    before do
+      options[:async_backend] = Routemaster::Client::Backends::Sidekiq.configure do |config|
+        config.queue = :realtime
+        config.retry = true
+      end
+    end
+ 
+    around do |example|
+      Sidekiq::Testing.inline! do
+        example.run
+      end
+    end
+ 
+    context 'with default options' do
+      let(:flags) { {} }
+ 
+      %w[created updated deleted noop].each do |m|
+        describe "##{m}" do
+          let(:event) { m }
+          it_behaves_like 'an event sender'
+        end
+      end
+    end
+ 
+    context 'with :async option' do
+      let(:flags) { { async: true } }
+ 
+      %w[created updated deleted noop].each do |m|
+        describe "##{m}" do
+          let(:event) { m }
+          it_behaves_like 'an event sender'
+        end
+      end
+    end
+ 
+    describe 'deprecated *_async methods' do
+      %w[created updated deleted noop].each do |m|
+        describe "##{m}_async" do
+          let(:event) { "#{m}_async" }
+          let(:flags) { {} }
+          it_behaves_like 'an event sender'
+        end
+      end
+    end
+  end
 
   describe '#subscribe' do
     let(:perform) { subject.subscribe(subscribe_options) }

data/spec/receiver_spec.rb

@@ -77,11 +77,6 @@ describe Routemaster::Receiver do
       expect(handler).to receive(:on_events).exactly(3).times
       3.times { perform }
     end
-    
-    it 'warns about deprecation' do
-      expect_any_instance_of(described_class).to receive(:warn).with(/deprecated/)
-      app
-    end
   end
 
   context 'with a listener' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-04 00:00:00.000000000 Z
+date: 2017-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -78,6 +78,7 @@ files:
 - ".rspec"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - Guardfile