meerkat 0.4.2 → 0.4.3

data/README.md

@@ -5,6 +5,13 @@ Rack middleware for [Server-Sent Events (HTML5 SSE)](http://www.html5rocks.com/e
 
 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).
 
+Features: 
+ * Subscribe for single events
+ * Subscribe for multiple events with patterns
+ * Low memory and CPU usage
+ * Works with all proxies (unlike WebSockets)
+ * Allows publishing from server side as well as from the client side (with POST request)
+
 Supported backends: 
 
  * In memory, using [EventMachine Channels](http://eventmachine.rubyforge.org/EventMachine/Channel.html), good for single server usage.
@@ -42,14 +49,24 @@ On the client:
 ```javascript
 var source = new EventSource('/stream/mychannel');
 var streamList = document.getElementById('stream');
-source.addEventListener('message', function(e) {
+// Use #onmessage if you only listen to one topic
+source.onmessage = function(e) {
   var li = document.createElement('li');
   li.innerHTML = JSON.parse(e.data);
   streamList.appendChild(li);
+}
+var multiSource = new EventSource('/my/event/*');
+// You have to add custom event listerns when you 
+// listen on multiple topics
+multiSource.addEventListener('/my/event/foo', function(e) {
+  // Do something
+}, false);
+multiSource.addEventListener('/my/event/bar', function(e) {
+  // Do something
 }, false);
 ```
 
-To push things:
+To push things from the client:
 
 ```ruby
 Meerkat.publish "/mychannel", {:any => hash}
@@ -59,6 +76,14 @@ Meerkat.publish "/mychannel/3", any_object
 
 The published objects will be JSON serialized (with [Yajl](https://github.com/brianmario/yajl-ruby)) before sent to the backend. Deserialize it in the client. 
 
+From the client:
+
+```javascript
+$.post('/stream/mychannel/2', { json: JSON.stringify(my_object) })
+```
+
+A simple POST request, with a parameter called 'json' containing a JSON string.
+
 Read more about Server-Sent Events and the EventSource API on [HTML5Rocks](http://www.html5rocks.com/en/tutorials/eventsource/basics/).
 
 Examples

data/lib/meerkat.rb

@@ -3,7 +3,6 @@ require_relative 'meerkat/rackadapter'
 require_relative 'meerkat/backend/inmemory'
 require_relative 'meerkat/backend/redis'
 require_relative 'meerkat/backend/pg'
-
 require 'yajl'
 
 module Meerkat
@@ -13,9 +12,9 @@ module Meerkat
     @backend = backend
   end
 
-  def publish(route, message)
-    json = Yajl::Encoder.encode message
-    @backend.publish(route, json)
+  def publish(route, message, is_json = false)
+    json = is_json ? message : Yajl::Encoder.encode(message)
+    @backend.publish(route, json) 
   end
 
   def subscribe(route, &callback)

data/lib/meerkat/rackadapter.rb

@@ -12,6 +12,30 @@ module Meerkat
     end
 
     def call(env)
+      case env['REQUEST_METHOD'] 
+      when 'GET'
+        listen(env)
+      when 'POST'
+        post(env)
+      else
+        [404, {}, []]
+      end
+    end
+
+    def post(env)
+      req = Rack::Request.new env
+      data = req.params['data'] || req.params['msg'] || req.params['json']
+      if data
+        Meerkat.publish(req.path_info, data, true)
+        [204, {}, []]
+      else 
+        [400, 
+          {'Content-Type' => 'text/plain'},
+          ['Required POST parameter "data", "msg" or "json" is missing']]
+      end
+    end
+
+    def listen(env)
       body = DeferrableBody.new
 
       headers = {

data/lib/meerkat/version.rb

@@ -1,3 +1,3 @@
 module Meerkat
-  VERSION = "0.4.2"
+  VERSION = "0.4.3"
 end

data/spec/meerkat_spec.rb

@@ -7,8 +7,11 @@ require './lib/meerkat'
 describe 'Meerkat' do
   include Rack::Test::Methods
 
-  def app
+  before do
     Meerkat.backend = Meerkat::Backend::InMemory.new
+  end
+
+  def app
     Rack::Builder.new {
       meerkat = Meerkat::RackAdapter.new do |m|
         m.keep_alive = 0.1
@@ -33,4 +36,35 @@ describe 'Meerkat' do
     get '/'
     assert_equal ":", last_response.body.split("\n")[1]
   end
+  
+  it 'should publish POST data and treat it like JSON' do
+    mock = MiniTest::Mock.new
+    mock.expect(:publish, nil, ['/foo', '"bar"'])
+    Meerkat.backend = mock
+    post '/foo', :json => '"bar"'
+
+    assert_equal 204, last_response.status
+    assert mock.verify
+  end
+
+  it 'should return error 400 when there is no "json" POST parameters' do
+    post '/', :foo => 'bar'
+    assert_equal 400, last_response.status
+  end
+
+  it 'should return error 400 when there is no POST data' do
+    post '/foo'
+    assert_equal 400, last_response.status
+  end
+
+  it 'should return 404 for anything but GET and POST requests' do
+    delete '/foo'
+    assert_equal 404, last_response.status
+    options '/foo'
+    assert_equal 404, last_response.status
+    head '/foo'
+    assert_equal 404, last_response.status
+    put '/foo'
+    assert_equal 404, last_response.status
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: meerkat
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-27 00:00:00.000000000Z
+date: 2011-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70174238921400 !ruby/object:Gem::Requirement
+  requirement: &70262532917760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174238921400
+  version_requirements: *70262532917760
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &70174238920780 !ruby/object:Gem::Requirement
+  requirement: &70262532917300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174238920780
+  version_requirements: *70262532917300
 - !ruby/object:Gem::Dependency
   name: thin_async
-  requirement: &70174238920140 !ruby/object:Gem::Requirement
+  requirement: &70262532916880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174238920140
+  version_requirements: *70262532916880
 - !ruby/object:Gem::Dependency
   name: thin-async-test
-  requirement: &70174238919320 !ruby/object:Gem::Requirement
+  requirement: &70262532916440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174238919320
+  version_requirements: *70262532916440
 - !ruby/object:Gem::Dependency
   name: em-minitest-spec
-  requirement: &70174238918880 !ruby/object:Gem::Requirement
+  requirement: &70262532916020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70174238918880
+  version_requirements: *70262532916020
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
-  requirement: &70174238918400 !ruby/object:Gem::Requirement
+  requirement: &70262532931940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70174238918400
+  version_requirements: *70262532931940
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70174238914700 !ruby/object:Gem::Requirement
+  requirement: &70262532931520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70174238914700
+  version_requirements: *70262532931520
 - !ruby/object:Gem::Dependency
   name: em-hiredis
-  requirement: &70174238914060 !ruby/object:Gem::Requirement
+  requirement: &70262532931080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70174238914060
+  version_requirements: *70262532931080
 - !ruby/object:Gem::Dependency
   name: pg
-  requirement: &70174238913360 !ruby/object:Gem::Requirement
+  requirement: &70262532930580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,7 +109,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70174238913360
+  version_requirements: *70262532930580
 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: 2628710167676549953
+      hash: -803937692324384329
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -160,10 +160,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2628710167676549953
+      hash: -803937692324384329
 requirements: []
 rubyforge_project: meerkat
-rubygems_version: 1.8.6
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Rack middleware for HTML5 Server-Sent Events, with swappable backends