routemaster-client 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ee29c57b725f321cc404fba4ac361d7ba277d1a
-  data.tar.gz: 707c11f90c92de25d0b7a40ed6b452e61b2016af
+  metadata.gz: 4ab7db72b3f45ca016af6ddfcd31727c08448d04
+  data.tar.gz: 864cc421186071bf194c01c230f778016ab4011c
 SHA512:
-  metadata.gz: b63264e4bf56e517980d49716a4f7b4f5e7abfd0f8a0c6ccb0c95d22284e7ce13263182483ac9cac081e4f4fcc70c4fa7325c19d1660ac4aec47fea59c3ec195
-  data.tar.gz: 8d67555f4b949ba7245340ac46a4ad85d9fb307a6f829755e783f20e83018db0d218aedd34db719998522009e787ca1b910fcb77ff01f7a1ad1a2703fed80df4
+  metadata.gz: d48921d988693488e7aed1b03b22526a88cd320eb85ce97976c32b0b0458fd79703043a0ef9f3e82971a9afcc3712f6427ce55c7aacc3ce5b00af81dd15ca24e
+  data.tar.gz: 856f4e0a2f340dbbe9d5c8b13e39fea9026b94ce48f53ec81bbca6da1ba5d860fd4460339cbd5fefdf3f43129cc51bc63130b81aa5e4132a2a84ee350bd34573

data/Gemfile

@@ -15,4 +15,5 @@ gem 'pry-byebug'
 gem 'rack-test'
 gem 'simplecov'
 gem 'codeclimate-test-reporter', require: nil
+gem 'sidekiq'
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    routemaster-client (2.0.0)
+    routemaster-client (2.1.0)
       faraday (>= 0.9.0)
       oj (~> 2.17)
       typhoeus (~> 1.1)
@@ -16,6 +16,8 @@ GEM
     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)
@@ -64,12 +66,15 @@ GEM
     psych (2.2.1)
     public_suffix (2.0.4)
     rack (2.0.1)
+    rack-protection (1.5.3)
+      rack
     rack-test (0.6.3)
       rack (>= 1.0)
     rake (11.3.0)
     rb-fsevent (0.9.8)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
+    redis (3.3.2)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -86,6 +91,11 @@ GEM
     ruby_dep (1.5.0)
     safe_yaml (1.0.4)
     shellany (0.0.1)
+    sidekiq (4.2.1)
+      concurrent-ruby (~> 1.0)
+      connection_pool (~> 2.2, >= 2.2.0)
+      rack-protection (~> 1.5)
+      redis (~> 3.2, >= 3.2.1)
     simplecov (0.12.0)
       docile (~> 1.1.0)
       json (>= 1.8, < 3)
@@ -113,6 +123,7 @@ DEPENDENCIES
   rack-test
   rake
   routemaster-client!
+  sidekiq
   simplecov
   webmock
 

data/README.md

@@ -34,6 +34,11 @@ You can also specify a timeout value in seconds if you like with the ```timeout`
 Routemaster::Client.new(url: 'https://bus.example.com', uuid: 'demo', timeout: 2)
 ```
 
+If you are using Sidekiq in your project, you can specify the usage of a Sidekiq backend, where event sending will be processed asynchronously.
+
+```ruby
+Routemaster::Client.new(url, 'https://bus.example.com', uuid: 'demo', backend_type: Routemaster::Client::Backends::Sidekiq)
+```
 
 **Push** an event about an entity in the topic `widgets` with a callback URL:
 

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

@@ -0,0 +1,24 @@
+require 'routemaster/client/connection'
+
+module Routemaster
+  class Client
+    module Backends
+      class Sidekiq
+        class Worker
+          include ::Sidekiq::Worker
+
+          def perform(event, topic, callback, timestamp, options)
+            conn = Routemaster::Client::Connection.new(_symbolize_keys(options))
+            conn.send_event(event, topic, callback, timestamp)
+          end
+
+          private
+
+          def _symbolize_keys(hash)
+            Hash[hash.map{|(k,v)| [k.to_sym,v]}]
+          end
+        end
+      end
+    end
+  end
+end

data/routemaster/client/backends/sidekiq.rb

@@ -0,0 +1,26 @@
+require 'sidekiq'
+require 'routemaster/client/backends/sidekiq/worker'
+
+module Routemaster
+  class Client
+    module Backends
+      class Sidekiq
+        @queue = :realtime
+
+        class << self
+          def configure(options)
+            new(options)
+          end
+        end
+
+        def initialize(options)
+          @_options = options
+        end
+
+        def send_event(event, topic, callback, timestamp = nil)
+          Worker.perform_async(event, topic, callback, timestamp, @_options)
+        end
+      end
+    end
+  end
+end

data/routemaster/client/backends/synchronous.rb

@@ -0,0 +1,24 @@
+require 'routemaster/client/connection'
+
+module Routemaster
+  class Client
+    module Backends
+      class Synchronous
+
+        class << self
+          def configure(options)
+            new(options)
+          end
+        end
+
+        def initialize(options)
+          @conn = Routemaster::Client::Connection.new(options)
+        end
+
+        def send_event(event, topic, callback, timestamp = nil)
+          @conn.send_event(event, topic, callback, timestamp)
+        end
+      end
+    end
+  end
+end

data/routemaster/client/backends.rb

@@ -0,0 +1,10 @@
+module Routemaster
+  class Client
+    module Backends
+      NAMES = ["Routemaster::Client::Backends::Synchronous", "Routemaster::Client::Backends::Sidekiq"]
+
+      autoload 'Synchronous', 'routemaster/client/backends/synchronous'
+      autoload 'Sidekiq',     'routemaster/client/backends/sidekiq'
+    end
+  end
+end

data/routemaster/client/connection.rb

@@ -0,0 +1,75 @@
+require 'forwardable'
+
+# Internal class used by Routemaster::Client
+
+module Routemaster
+  class Client
+    class Connection
+
+      def initialize(options)
+        @_url = options[:url]
+        @_uuid = options[:uuid]
+        @_timeout = options.fetch(:timeout, 1)
+        @_verify_ssl = options.fetch(:verify_ssl, true)
+      end
+
+      def http(method, path, &block)
+        _conn.send(method, path, &block)
+      end
+
+      def post(path, &block)
+        http(:post, path, &block)
+      end
+
+      def get(path, &block)
+        http(:get, path, &block)
+      end
+
+      def delete(path, &block)
+        http(:delete, path, &block)
+      end
+
+      def send_event(event, topic, callback, timestamp = nil)
+        data = { type: event, url: callback, timestamp: timestamp }
+
+        response = post("/topics/#{topic}") do |r|
+          r.headers['Content-Type'] = 'application/json'
+          r.body = Oj.dump(_stringify_keys data)
+        end
+        fail "event rejected (#{response.status})" unless response.success?
+      end
+
+      def subscribe(options)
+        response = post('/subscription') do |r|
+          r.headers['Content-Type'] = 'application/json'
+          r.body = Oj.dump(_stringify_keys options)
+        end
+
+        unless response.success?
+          raise 'subscribe rejected'
+        end
+      end
+
+      private
+
+      def _stringify_keys(hash)
+        hash.dup.tap do |h|
+          h.keys.each do |k|
+            h[k.to_s] = h.delete(k)
+          end
+        end
+      end
+
+      def _conn
+        @_conn ||= Faraday.new(@_url, ssl: { verify: @_verify_ssl }) do |f|
+          f.request :retry, max: 2, interval: 100e-3, backoff_factor: 2
+          f.request :basic_auth, @_uuid, 'x'
+          f.adapter :typhoeus
+
+          f.options.timeout      = @_timeout
+          f.options.open_timeout = @_timeout
+        end
+      end
+    end
+  end
+end

data/routemaster/client/version.rb

@@ -1,5 +1,5 @@
 module Routemaster
   class Client
-    VERSION = '2.0.0'
+    VERSION = '2.1.0'
   end
 end

data/routemaster/client.rb

@@ -1,3 +1,5 @@
+require 'routemaster/client/backends'
+require 'routemaster/client/connection'
 require 'routemaster/client/version'
 require 'routemaster/topic'
 require 'uri'
@@ -9,17 +11,22 @@ require 'oj'
 
 module Routemaster
   class Client
-    
+
     def initialize(options = {})
-      @_url = _assert_valid_url(options[:url])
-      @_uuid = options[:uuid]
-      @_timeout = options.fetch(:timeout, 1)
-      @_verify_ssl = options.fetch(:verify_ssl, true)
+      @_options = options.tap do |o|
+        o[:timeout] ||= 1
+        o[:backend_type] ||= Backends::Synchronous
+      end
+
+      @_backend_type = @_options.fetch(:backend_type)
+
+      _assert_valid_url(@_options[:url])
+      _assert_valid_backend_type(@_backend_type)
+      _assert (@_options[:uuid] =~ /^[a-z0-9_-]{1,64}$/), 'uuid should be alpha'
+      _assert_valid_timeout(@_options[:timeout])
 
-      _assert (options[:uuid] =~ /^[a-z0-9_-]{1,64}$/), 'uuid should be alpha'
-      _assert_valid_timeout(@_timeout)
 
-      unless options[:lazy]
+      unless @_options[:lazy]
         _conn.get('/pulse').tap do |response|
           raise 'cannot connect to bus' unless response.success?
         end
@@ -53,22 +60,14 @@ module Routemaster
 
       options[:topics].each { |t| _assert_valid_topic(t) }
       _assert_valid_url(options[:callback])
-
-      response = _post('/subscription') do |r|
-        r.headers['Content-Type'] = 'application/json'
-        r.body = Oj.dump(_stringify_keys options)
-      end
-
-      unless response.success?
-        raise 'subscribe rejected'
-      end
+      _conn.subscribe(options)
     end
 
     def unsubscribe(*topics)
       topics.each { |t| _assert_valid_topic(t) }
 
       topics.each do |t|
-        response = _delete("/subscriber/topics/#{t}")
+        response = _conn.delete("/subscriber/topics/#{t}")
 
         unless response.success?
           raise 'unsubscribe rejected'
@@ -77,7 +76,7 @@ module Routemaster
     end
 
     def unsubscribe_all
-      response = _delete('/subscriber')
+      response = _conn.delete('/subscriber')
 
       unless response.success?
         raise 'unsubscribe all rejected'
@@ -87,7 +86,7 @@ module Routemaster
     def delete_topic(topic)
       _assert_valid_topic(topic)
 
-      response = _delete("/topics/#{topic}")
+      response = _conn.delete("/topics/#{topic}")
 
       unless response.success?
         raise 'failed to delete topic'
@@ -95,7 +94,7 @@ module Routemaster
     end
 
     def monitor_topics
-      response = _get('/topics') do |r|
+      response = _conn.get('/topics') do |r|
         r.headers['Content-Type'] = 'application/json'
       end
 
@@ -108,17 +107,8 @@ module Routemaster
       end
     end
 
-
     private
 
-    def _stringify_keys(hash)
-      hash.dup.tap do |h|
-        h.keys.each do |k|
-          h[k.to_s] = h.delete(k)
-        end
-      end
-    end
-
     def _assert_valid_timeout(timeout)
       _assert (0..3_600_000).include?(timeout), 'bad timeout'
     end
@@ -141,49 +131,29 @@ module Routemaster
       _assert timestamp.kind_of?(Integer), 'not an integer'
     end
 
+    def _assert_valid_backend_type(backend_type)
+      backends = Backends::NAMES
+      _assert backends.include?(backend_type.to_s), "unknown backend type, must be one of #{backends.map{ |w| "Routemaster::Backends::#{w}" }.join(", ")}"
+      backend_type
+    end
+
     def _send_event(event, topic, callback, timestamp = nil)
       _assert_valid_url(callback)
       _assert_valid_topic(topic)
       _assert_valid_timestamp(timestamp) if timestamp
-
-      data = { type: event, url: callback, timestamp: timestamp }
-
-      response = _post("/topics/#{topic}") do |r|
-        r.headers['Content-Type'] = 'application/json'
-        r.body = Oj.dump(_stringify_keys data)
-      end
-      fail "event rejected (#{response.status})" unless response.success?
+      _backend.send_event(event, topic, callback, timestamp)
     end
 
     def _assert(condition, message)
       condition or raise ArgumentError.new(message)
     end
 
-    def _http(method, path, &block)
-      _conn.send(method, path, &block)
-    end
-
-    def _post(path, &block)
-      _http(:post, path, &block)
-    end
-
-    def _get(path, &block)
-      _http(:get, path, &block)
-    end
-
-    def _delete(path, &block)
-      _http(:delete, path, &block)
-    end
-
     def _conn
-      @_conn ||= Faraday.new(@_url, ssl: { verify: @_verify_ssl }) do |f|
-        f.request :retry, max: 2, interval: 100e-3, backoff_factor: 2
-        f.request :basic_auth, @_uuid, 'x'
-        f.adapter :typhoeus
+      @_conn ||= Client::Connection.new(@_options)
+    end
 
-        f.options.timeout      = @_timeout
-        f.options.open_timeout = @_timeout
-      end
+    def _backend
+      @_worker ||= @_backend_type.configure(@_options)
     end
   end
 end

data/spec/client_spec.rb

@@ -2,6 +2,7 @@ require 'spec_helper'
 require 'routemaster/client'
 require 'routemaster/topic'
 require 'webmock/rspec'
+require 'sidekiq/testing'
 
 describe Routemaster::Client do
   let(:options) {{
@@ -39,6 +40,12 @@ describe Routemaster::Client do
       expect { subject }.to raise_error(ArgumentError)
     end
 
+    it 'fails with an invalid worker_type' do
+      Jeff = double
+      options[:backend_type] = Jeff
+      expect { subject }.to raise_error(ArgumentError)
+    end
+
     context 'when connection fails' do
       before do
         stub_request(:any, %r{^https://bus.example.com}).
@@ -167,24 +174,58 @@ describe Routemaster::Client do
     end
   end
 
-  describe '#created' do
-    let(:event) { 'created' }
-    it_behaves_like 'an event sender'
-  end
+  context "With no background worker specified" do
+    describe '#created' do
+      let(:event) { 'created' }
+      it_behaves_like 'an event sender'
+    end
 
-  describe '#updated' do
-    let(:event) { 'updated' }
-    it_behaves_like 'an event sender'
-  end
+    describe '#updated' do
+      let(:event) { 'updated' }
+      it_behaves_like 'an event sender'
+    end
+
+    describe '#deleted' do
+      let(:event) { 'deleted' }
+      it_behaves_like 'an event sender'
+    end
 
-  describe '#deleted' do
-    let(:event) { 'deleted' }
-    it_behaves_like 'an event sender'
+    describe '#noop' do
+      let(:event) { 'noop' }
+      it_behaves_like 'an event sender'
+    end
   end
 
-  describe '#noop' do
-    let(:event) { 'noop' }
-    it_behaves_like 'an event sender'
+  context "With the sidekiq back end" do
+    before do
+      options[:backend_type] = Routemaster::Client::Backends::Sidekiq
+    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 '#updated' do
+      let(:event) { 'updated' }
+      it_behaves_like 'an event sender'
+    end
+
+    describe '#deleted' do
+      let(:event) { 'deleted' }
+      it_behaves_like 'an event sender'
+    end
+
+    describe '#noop' do
+      let(:event) { 'noop' }
+      it_behaves_like 'an event sender'
+    end
   end
 
   describe '#subscribe' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Julien Letessier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-07 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -86,6 +86,11 @@ files:
 - Rakefile
 - routemaster-client.gemspec
 - routemaster/client.rb
+- routemaster/client/backends.rb
+- routemaster/client/backends/sidekiq.rb
+- routemaster/client/backends/sidekiq/worker.rb
+- routemaster/client/backends/synchronous.rb
+- routemaster/client/connection.rb
 - routemaster/client/version.rb
 - routemaster/receiver.rb
 - routemaster/topic.rb