meerkat 0.3.2 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    meerkat (0.3.2)
+    meerkat (0.4.0)
       em-hiredis
       eventmachine
       pg

data/README.md

@@ -3,13 +3,18 @@ Meerkat
 
 Rack middleware for [Server-Sent Events (HTML5 SSE)](http://www.html5rocks.com/en/tutorials/eventsource/basics/).
 
-Requires an evented server, like [Thin](http://code.macournoyer.com/thin/).
+Requires an [EventMachine](https://github.com/eventmachine/eventmachine#readme) backed server, like [Thin](http://code.macournoyer.com/thin/) or [Rainbows](http://rainbows.rubyforge.org/) (with the EventMachine backend only).
 
 Supported backends: 
 
  * In memory, using [EventMachine Channels](http://eventmachine.rubyforge.org/EventMachine/Channel.html), good for single server usage.
  * Redis, using [em-hiredis](https://github.com/mloughran/em-hiredis#readme) and the [Pub/Sub API](http://redis.io/topics/pubsub). 
- * Postgres, using the [Notify/Listen API](http://www.postgresql.org/docs/9.1/static/sql-notify.html). Note, this is fully async, no polling. Although, it requires PostgreSQL 9.0 or higher, so unfortunately Heroku's Shared Database can't be used (8.3) but their dedicated database offerings can. 
+ * Postgres, using the [Notify/Listen API](http://www.postgresql.org/docs/9.1/static/sql-notify.html). 
+   * When a message is published the topic and json payload is inserted into the 'meerkat_pubsub' table, and then a NOTIFY is issued.
+   * Listening clients recivies the notification and reads the message from the table and writes it to the Event Stream of its clients.
+   * On the next publish all messages older than 5 seconds are deleted. 
+   * No polling is ever done.
+   * This works with PostgreSQL 8 and higher (tested with 8.3 and 9.1). 
 
 Usage
 -----
@@ -86,4 +91,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

data/lib/meerkat/backend/inmemory.rb

@@ -7,13 +7,15 @@ module Meerkat
         @channel = EventMachine::Channel.new
       end
 
-      def publish(route, json)
-        @channel.push({:route => route, :json => json})
+      def publish(topic, json)
+        @channel.push({:topic => topic, :json => json})
       end
 
-      def subscribe(route, &callback)
+      def subscribe(topic, &callback)
         @channel.subscribe do |msg|
-          callback.call(msg[:json]) if msg[:route] == route
+          if File.fnmatch? topic, msg[:topic]
+            callback.call msg[:topic], msg[:json]
+          end
         end
       end
 

data/lib/meerkat/backend/pg.rb

@@ -16,10 +16,10 @@ module Meerkat
 
       def publish(route, json)
         @pg.transaction do |conn|
-          conn.exec "DELETE FROM #{TABLENAME} WHERE timestamp < now() - interval '5 seconds'"
           conn.exec "INSERT INTO #{TABLENAME} (topic, json) VALUES ($1, $2)", [route, json]
           conn.exec "NOTIFY #{TABLENAME}"
         end
+        @pg.async_exec "DELETE FROM #{TABLENAME} WHERE timestamp < now() - interval '5 seconds'"
       end
 
       def subscribe(route, &callback)
@@ -56,8 +56,8 @@ module Meerkat
           rows.each do |row| 
             @last_check = row['timestamp']
             @subs.each do |topic, callbacks|
-              if topic == row['topic'] 
-                callbacks.each { |cb| cb.call row['json'] }
+              if File.fnmatch? topic, row['topic']
+                callbacks.each { |cb| cb.call row['topic'], row['json'] }
               end
             end
           end

data/lib/meerkat/backend/redis.rb

@@ -12,30 +12,34 @@ module Meerkat
         }
       end
 
-      def publish(route, json)
-        @pub.publish route, json
+      def publish(topic, json)
+        @pub.publish topic, json
       end
 
-      def subscribe(route, &callback)
-        if @subs[route]
-          @subs[route] << callback
+      def subscribe(topic, &callback)
+        if @subs[topic]
+          @subs[topic] << callback
         else
-          @subs[route] = [ callback ]
+          @subs[topic] = [ callback ]
           EM.next_tick {
-            @sub.subscribe route 
-            @sub.on :message do |channel, message|
-              @subs[route].each { |c| c.call message }
+            @sub.psubscribe topic 
+            @sub.on :pmessage do |topic, channel, message|
+              @subs[topic].each { |c| c.call channel, message }
             end
           }
         end
-        [route, callback]
+        [topic, callback]
       end
 
       def unsubscribe(sub)
-        @subs[sub[0]].delete sub[1]
-        EM.next_tick {
-          @sub.unsubscribe(sub[0]) if @subs[sub[0]].empty?
-        }
+        topic, cb = sub
+        @subs[topic].delete cb
+        if @subs[topic].empty?
+          EM.next_tick do
+            @subs.delete topic 
+            @sub.punsubscribe(topic) 
+          end
+        end
       end
     end
   end

data/lib/meerkat/rackadapter.rb

@@ -1,10 +1,13 @@
 module Meerkat
   class RackAdapter
-    attr_accessor :keep_alive
     attr_accessor :retry
     attr_accessor :timeout
+    attr_accessor :keep_alive
 
     def initialize(app = nil, &blk)
+      @retry = 3000
+      @timeout = false
+      @keep_alive = 20
       blk.call(self) if blk
     end
 
@@ -14,25 +17,19 @@ module Meerkat
       EM.next_tick { 
         env['async.callback'].call [200, {'Content-Type' => 'text/event-stream'}, body] 
       }
-
-      EM.next_tick {
-        body << "retry: #{@retry || 3000}\n"
-      }
+      EM.next_tick { body << "retry: #{@retry}\n" }
+      EM.add_periodic_timer(@keep_alive) { body << ":\n" }
+      EM.add_timer(@timeout) { body.succeed } if @timeout
 
       path_info = Rack::Utils.unescape env["PATH_INFO"]
-      sub = Meerkat.subscribe(path_info) do |message|
-        body << "data: #{message}\n\n"
+      sub = Meerkat.subscribe(path_info) do |topic, json|
+        body << "event: #{topic}\n"
+        body << "data: #{json}\n\n"
       end
-      body.errback {
+      env['async.close'].callback do
         Meerkat.unsubscribe sub
-      }
-
-      EM.add_periodic_timer(@keep_alive || 20) do
-        body << ":\n"
       end
 
-      EM.add_timer(@timeout) { body.succeed } if @timeout
-
       [-1, {}, []]
     end
 

data/lib/meerkat/version.rb

@@ -1,3 +1,3 @@
 module Meerkat
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/spec/backend/inmemory_spec.rb

@@ -5,26 +5,30 @@ require './lib/meerkat/backend/inmemory'
 describe 'The in memory backend' do
   include EM::MiniTest::Spec
 
+  before do
+    @im = Meerkat::Backend::InMemory.new
+  end
+
   it 'can publish and subscribe' do
-    im = Meerkat::Backend::InMemory.new
-    im.subscribe 'route' do |msg| 
-      @recivied = msg
+    @im.subscribe 'route' do |topic, msg| 
+      assert_equal 'route', topic
+      assert_equal 'foo', msg
+      done!
     end
-    im.publish 'route', 'messsage'
-    assert_equal 'messsage', @recivied 
+    @im.publish 'route', 'foo'
+    wait!
   end
-  it 'can does only subscribe to specific routes' do
-    im = Meerkat::Backend::InMemory.new
-    im.subscribe 'route' do |msg| 
-      @recivied = msg
+  it 'can subscribe to wildcards' do
+    @im.subscribe '/foo/*' do |topic, msg| 
+      assert_equal '/foo/bar', topic
+      assert_equal 'barfoo', msg
+      done!
     end
-    im.publish 'route2', 'messsage'
-    assert_equal nil, @recivied
+    @im.publish '/foo/bar', 'barfoo'
+    wait!
   end
   it 'can unbsubscribe' do
-    im = Meerkat::Backend::InMemory.new
-    sid = im.subscribe 'route' do |msg| 
-    end
-    im.unsubscribe sid
+    sid = @im.subscribe 'route' do |topic, msg| end
+    @im.unsubscribe sid
   end
 end

data/spec/backend/pg_spec.rb

@@ -5,34 +5,53 @@ require './lib/meerkat/backend/pg'
 describe 'Postgres backend' do
   include EM::MiniTest::Spec
 
+  before do
+    @b = Meerkat::Backend::PG.new :dbname => 'postgres'
+  end
+
+  it 'can subscribe to partial wildcard' do
+    @b.subscribe '/foo/*' do |topic, msg| 
+      assert_equal '/foo/bar', topic
+      assert_equal 'messsage', msg
+      done!
+    end
+    @b.publish '/foo/bar', 'messsage'
+    wait!
+  end
+
+  it 'can subscribe to wildcard' do
+    @b.subscribe '*' do |topic, msg| 
+      assert_equal 'messsage', msg
+      done!
+    end
+    @b.publish '/', 'messsage'
+    wait!
+  end
+
   it 'can publish and subscribe' do
-    b = Meerkat::Backend::PG.new :dbname => 'postgres'
-    b.subscribe '/' do |msg| 
+    @b.subscribe '/' do |topic, msg| 
       assert_equal 'messsage', msg
       done!
     end
-    b.publish '/', 'messsage'
+    @b.publish '/', 'messsage'
     wait!
   end
 
   it 'can publish and subscribe multiple messages' do
-    b = Meerkat::Backend::PG.new :dbname => 'postgres'
     i = 5
     j = 0
-    b.subscribe '/' do |msg| 
+    @b.subscribe '/' do |topic, msg| 
       j += 1
       assert_equal 'messsage', msg
       done! if j == i
     end
-    i.times { b.publish '/', 'messsage' }
+    i.times { @b.publish '/', 'messsage' }
     wait!
   end
 
   it 'can unsubscribe' do
-    b = Meerkat::Backend::PG.new :dbname => 'postgres'
-    sid = b.subscribe 'route' do |msg| 
-    end
-    b.unsubscribe sid
+    sid = @b.subscribe 'route' do |topic, msg| end
+    @b.unsubscribe sid
   end
 end
 

data/spec/backend/redis_spec.rb

@@ -5,9 +5,22 @@ require './lib/meerkat/backend/redis'
 describe 'Redis backend' do
   include EM::MiniTest::Spec
 
+  it 'can publish and subscribe to wildcards' do
+    b = Meerkat::Backend::Redis.new
+    b.subscribe '/foo/*' do |topic, msg| 
+      assert_equal '/foo/bar', topic
+      assert_equal 'messsage', msg
+      done!
+    end
+    EM.next_tick {
+      b.publish '/foo/bar', 'messsage'
+    }
+    wait!
+  end
+
   it 'can publish and subscribe' do
     b = Meerkat::Backend::Redis.new
-    b.subscribe '/' do |msg| 
+    b.subscribe '/' do |topic, msg| 
       assert_equal 'messsage', msg
       done!
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meerkat
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-10-25 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70298242914000 !ruby/object:Gem::Requirement
+  requirement: &70273991486880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70298242914000
+  version_requirements: *70273991486880
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70298242910980 !ruby/object:Gem::Requirement
+  requirement: &70273991486440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70298242910980
+  version_requirements: *70273991486440
 - !ruby/object:Gem::Dependency
   name: thin_async
-  requirement: &70298242907840 !ruby/object:Gem::Requirement
+  requirement: &70273991486000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70298242907840
+  version_requirements: *70273991486000
 - !ruby/object:Gem::Dependency
   name: thin-async-test
-  requirement: &70298242903320 !ruby/object:Gem::Requirement
+  requirement: &70273991485580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70298242903320
+  version_requirements: *70273991485580
 - !ruby/object:Gem::Dependency
   name: em-minitest-spec
-  requirement: &70298242899220 !ruby/object:Gem::Requirement
+  requirement: &70273991485160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70298242899220
+  version_requirements: *70273991485160
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70298242898200 !ruby/object:Gem::Requirement
+  requirement: &70273991484740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70298242898200
+  version_requirements: *70273991484740
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70298242896720 !ruby/object:Gem::Requirement
+  requirement: &70273991484320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70298242896720
+  version_requirements: *70273991484320
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: &70298242895440 !ruby/object:Gem::Requirement
+  requirement: &70273991483900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70298242895440
+  version_requirements: *70273991483900
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &70298242893980 !ruby/object:Gem::Requirement
+  requirement: &70273991483480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70298242893980
+  version_requirements: *70273991483480
 description: Requires an evented Ruby dispatcher, like Thin
 email:
 - carl.hoerberg@gmail.com
@@ -151,7 +151,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2476941847532448728
+      hash: -2704897263514401478
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -160,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2476941847532448728
+      hash: -2704897263514401478
 requirements: []
 rubyforge_project: meerkat
 rubygems_version: 1.8.6