routemaster-client 0.0.2 → 0.0.3

data/Gemfile

@@ -5,3 +5,10 @@ gemspec
 
 # just here to avoid a safety warning
 gem 'psych'
+
+gem 'bundler'
+gem 'rake'
+gem 'guard-rspec'
+gem 'webmock'
+gem 'pry-nav'
+gem 'rack-test'

data/Gemfile.lock

@@ -1,10 +1,10 @@
 PATH
   remote: .
   specs:
-    routemaster-client (0.0.2)
+    routemaster-client (0.0.3)
       faraday
       net-http-persistent
-      sinatra
+      wisper (>= 1.4.0)
 
 GEM
   remote: http://eu.yarp.io/
@@ -26,14 +26,14 @@ GEM
       lumberjack (~> 1.0)
       pry (>= 0.9.12)
       thor (>= 0.18.1)
-    guard-rspec (4.2.10)
+    guard-rspec (4.3.1)
       guard (~> 2.1)
       rspec (>= 2.14, < 4.0)
-    listen (2.7.8)
+    listen (2.7.9)
       celluloid (>= 0.15.2)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9)
-    lumberjack (1.0.6)
+    lumberjack (1.0.9)
     method_source (0.8.2)
     multipart-post (2.0.0)
     net-http-persistent (2.9.4)
@@ -45,8 +45,6 @@ GEM
       pry (~> 0.9.10)
     psych (2.0.5)
     rack (1.5.2)
-    rack-protection (1.5.3)
-      rack
     rack-test (0.6.2)
       rack (>= 1.0)
     rake (10.3.2)
@@ -57,37 +55,32 @@ GEM
       rspec-core (~> 3.0.0)
       rspec-expectations (~> 3.0.0)
       rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.1)
+    rspec-core (3.0.3)
       rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.1)
+    rspec-expectations (3.0.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.1)
+    rspec-mocks (3.0.3)
       rspec-support (~> 3.0.0)
-    rspec-support (3.0.0)
+    rspec-support (3.0.3)
     safe_yaml (1.0.3)
-    sinatra (1.4.5)
-      rack (~> 1.4)
-      rack-protection (~> 1.4)
-      tilt (~> 1.3, >= 1.3.4)
-    slop (3.5.0)
+    slop (3.6.0)
     thor (0.19.1)
-    tilt (1.4.1)
     timers (1.1.0)
     webmock (1.18.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+    wisper (1.4.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.5)
+  bundler
   guard-rspec
   pry-nav
   psych
   rack-test
   rake
   routemaster-client!
-  rspec
   webmock

data/README.md

@@ -1,8 +1,15 @@
-# routemaster_client
+# routemaster-client
 
 A Ruby API for the [Routemaster](https://github.com/HouseTrip/routemaster) event
 bus.
 
+[![Version](https://badge.fury.io/rb/routemaster-client.svg)](https://rubygems.org/gems/routemaster-client)
+ 
+[![Build](https://travis-ci.org/HouseTrip/routemaster-client.svg?branch=master)](https://travis-ci.org/HouseTrip/routemaster-client)
+ 
+[![Docs](http://img.shields.io/badge/API%20docs-rubydoc.info-blue.svg)](http://rubydoc.info/github/HouseTrip/routemaster-client/frames/file/README.md)
+
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -67,21 +74,25 @@ client.subscribe(
 ```ruby
 require 'routemaster/receiver'
 
-class Handler
-  def on_events(batch)
+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',
-  handler: Handler.new
+  uuid:    'demo'
 }
 ```
 
+This relies on the excellent event bus from the [wisper
+gem](https://github.com/krisleech/wisper#wisper).
+
 
 **Monitor** the status of topics and subscriptions:
 
@@ -100,7 +111,7 @@ client.monitor_subscriptions
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/routemaster_client/fork )
+1. Fork it ( http://github.com/HouseTrip/routemaster-client/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`)

data/routemaster/client/version.rb

@@ -1,5 +1,5 @@
 module Routemaster
   class Client
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/routemaster/receiver.rb

@@ -1,15 +1,21 @@
-require 'sinatra'
 require 'rack/auth/basic'
 require 'base64'
 require 'json'
+require 'wisper'
 
 module Routemaster
   class Receiver
+    include Wisper::Publisher
+
     def initialize(app, options = {})
       @app     = app
       @path    = options[:path]
       @uuid    = options[:uuid]
-      @handler = options[:handler]
+
+      if options[:handler]
+        warn 'the :handler option is deprecated, listen to the :events_received event instead'
+        @handler = options[:handler]
+      end
     end
 
     def call(env)
@@ -19,7 +25,8 @@ module Routemaster
         return [403, {}, []] unless _valid_auth?(env)
         return [400, {}, []] unless payload = _extract_payload(env)
 
-        @handler.on_events(payload)
+        @handler.on_events(payload) if @handler
+        publish(:events_received, payload)
         return [204, {}, []]
       end
       @app.call(env)

data/routemaster-client.gemspec

@@ -16,15 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^spec/})
   spec.require_paths = %w(.)
 
-  spec.add_development_dependency 'bundler', '~> 1.5'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'webmock'
-  spec.add_development_dependency 'pry-nav'
-  spec.add_development_dependency 'rack-test'
-
   spec.add_runtime_dependency     'faraday'
   spec.add_runtime_dependency     'net-http-persistent'
-  spec.add_runtime_dependency     'sinatra'
+  spec.add_runtime_dependency     'wisper', '>= 1.4.0'
 end

data/spec/receiver_spec.rb

@@ -3,7 +3,7 @@ require 'spec/support/rack_test'
 require 'routemaster/receiver'
 
 describe Routemaster::Receiver do
-  let(:handler) { double 'handler', on_events: nil }
+  let(:handler) { double 'handler', on_events: nil, on_events_received: true }
   let(:app) { described_class.new(fake_app, options) }
   
   
@@ -14,8 +14,7 @@ describe Routemaster::Receiver do
   let(:options) do
     {
       path:     '/events',
-      uuid:     'demo',
-      handler:  handler
+      uuid:     'demo'
     }
   end
 
@@ -59,15 +58,51 @@ describe Routemaster::Receiver do
     expect(last_response.status).to eq(501)
   end
 
-  it 'calls the handler when receiving an avent' do
-    authorize 'demo', 'x'
-    expect(handler).to receive(:on_events).exactly(:once)
-    perform
+  context 'with the deprecated :handler option' do
+    let(:options) {{
+      path:     '/events',
+      uuid:     'demo',
+      handler:  handler
+    }}
+
+    it 'calls the handler when receiving an avent' do
+      authorize 'demo', 'x'
+      expect(handler).to receive(:on_events).exactly(:once)
+      perform
+    end
+
+    it 'calls the handler multiple times' do
+      authorize 'demo', 'x'
+      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
 
-  it 'calls the handler multiple times' do
-    authorize 'demo', 'x'
-    expect(handler).to receive(:on_events).exactly(3).times
-    3.times { perform }
+  context 'with a listener' do
+    let(:handler) { double }
+    before { Wisper.subscribe(handler, scope: 'Routemaster::Receiver', prefix: true) }
+    after { Wisper::GlobalListeners.clear }
+
+    it 'broadcasts :events_received' do
+      authorize 'demo', 'x'
+
+      expect(handler).to receive(:on_events_received).exactly(:once)
+      # TODO:
+      # we'll be able to say this with a more recent wisper (and skip the
+      # handler):
+      # expect(app).to publish_event(:events_received)
+      perform
+    end
+
+    it 'can broadcast multiple times' do
+      authorize 'demo', 'x'
+      expect(handler).to receive(:on_events_received).exactly(3).times
+      3.times { perform }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: routemaster-client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,120 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-24 00:00:00.000000000 Z
+date: 2014-09-17 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry-nav
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rack-test
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -156,13 +44,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: wisper
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -170,7 +58,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 description: 
 email:
 - julien.letessier@gmail.com
@@ -214,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3992781914019292519
+      hash: -2540830957177487143
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -223,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3992781914019292519
+      hash: -2540830957177487143
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23.2