sinatra-pubsub 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e533484ef0150bb3ec9c2aef6dee5e4513fd652a
+  data.tar.gz: 3a667d352c4f4d3e59f5079bbb843135a0db541d
+SHA512:
+  metadata.gz: 9f355f18937e08c6b2291a2cd5a9a06f6ff5b1d336219ce504a66f6e6db98e739b8283998abecf43af84016c5519887d176f06b44c19e905ec974dba3f20dd9c
+  data.tar.gz: 16d2087cfc55c7e8ab42dfe3b30322c959a59803e76a0b88e0769c7a233bf8af7090920932569d39d8ff0b9abca2cbd56265f2a80cd4b6cc7a573669d534f2f5

data/README.md

@@ -1,6 +1,32 @@
-# Sinatra::Pubsub
+# Sinatra::PubSub
 
-TODO: Write a gem description
+PubSub is a little extension to Sinatra that adds basic publish/subscribe streaming
+using HTML5 Server Sent Events.
+
+For example, clients can subscribe to events like this:
+
+    var es = new EventSource('/subscribe');
+    es.onmessage = function(e) {
+      console.log(JSON.parse(e.data));
+    };
+
+And then you can broadcast events to them like this:
+
+    Sinatra::PubSub.publish_all(type: 'tick')
+
+You can subscribe to specific channels:
+
+    var es = new EventSource('/subscribe/sites/123');
+
+And publish to them:
+
+    Sinatra::PubSub.publish('sites/123', data: 'hi')
+
+## Requirements
+
+* An evented server, such as Thin
+* Redis
+* Sinatra
 
 ## Installation
 
@@ -18,7 +44,18 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Include it in your Sinatra application like so:
+
+    require 'sinatra/pubsub'
+    register Sinatra::PubSub
+
+This creates a `/subscribe/*` endpoint, which clients can use with `EventSource`.
+
+You can publish to channels using the `Sinatra::PubSub.publish_all(msg)` or
+`Sinatra::publish(channel, msg)` methods.
+
+Messages will be automatically serialized to JSON - you'll need to parse them on the client.
+See the `./examples` dir for more use-cases.
 
 ## Contributing
 

data/lib/sinatra/pubsub.rb

@@ -14,5 +14,9 @@ module Sinatra
       app.helpers Helpers
       subscribe
     end
+
+    def self.set(*args)
+      App.set(*args)
+    end
   end
 end

data/lib/sinatra/pubsub/app.rb

@@ -1,6 +1,31 @@
 module Sinatra
   module PubSub
     class App < Sinatra::Base
+      configure do
+        set :cors, false
+        set :origin, '*'
+      end
+
+      helpers do
+        def http_origin
+          env['HTTP_ORIGIN']
+        end
+      end
+
+      before do
+        return unless settings.cors
+
+        origin = http_origin || ''
+        secure = origin =~ /\Ahttps/
+
+        allow  = settings.origin
+        allow.gsub!(/\Ahttp:\/\//, 'https://') if secure
+
+        headers['Access-Control-Allow-Origin']      = allow
+        headers['Access-Control-Allow-Methods']     = 'GET'
+        headers['Access-Control-Allow-Credentials'] = 'true'
+      end
+
       get '/subscribe/?*', :provides => 'text/event-stream' do
         error 402 unless Stream.enabled?
 

data/lib/sinatra/pubsub/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module PubSub
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Alex MacCaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-16 00:00:00.000000000 Z
+date: 2013-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,39 +27,34 @@ dependencies:
 - !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: thin
   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: sinatra
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -117,32 +106,25 @@ files:
 homepage: http://github.com/maccman/sinatra-pubsub
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2677468794755988610
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2677468794755988610
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Sinatra PubSub
 test_files: []