sinatra-pubsub 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88b49616fc359844b36324f48ef20e8b200c4688
-  data.tar.gz: 5111f02511e1e11e779fcb3f6abb8ae1dfaa55ac
+  metadata.gz: 678319b66eb37abf968fb94c42fb51f1afe76459
+  data.tar.gz: 2d9c574c2ca3bd5c8acc88f2810e8a3df79773b5
 SHA512:
-  metadata.gz: b8f3bea75fb2626c0c6997625fa67ab96fe3e1ca8cd3469b622f70c0ab4e196b5f94a1a6cbd49997f47a10de6adf808e2d6b94f63abb6c5b692e60747edc6df4
-  data.tar.gz: a37d54ba23e8ebad0177ba23412cd2c7e4f7a0d2ba6ac766c6b9ed605bde38555f93a06d01c836dae790a21e58c9f901be2cde786750396d69ee48fdf0b4974b
+  metadata.gz: baa43672e636cff9ae1def170106ec98b181dc39a9be8d0a355687c519995cfc054546eec0743ee3a0132b3e8c23be1de30e20d13c815b859a05bf6bcaf90976
+  data.tar.gz: 0990f6d4555f7689b19f3998c106ac14261e1855cae7cd93d20fcb0246768f97306b5a9c16b659d302cf1d7408689dc527dde1e3a01ed27fe985ed4c242af04a

data/.gitignore

@@ -15,3 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+examples/basic/Gemfile.lock
+examples/tick/Gemfile.lock

data/README.md

@@ -24,7 +24,7 @@ And publish to them:
 
 ## Requirements
 
-* An evented server, such as Thin
+* Thin
 * Redis
 * Sinatra
 
@@ -57,10 +57,39 @@ You can publish to channels using the `Sinatra::PubSub.publish_all(msg)` or
 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
+## Herkou 123
 
-1. Fork it
-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`)
-5. Create new Pull Request
+It's often a good idea to create a separate streaming server on a subdomain, rather than
+using your main application server for streaming. This gives you a bit more flexibility, like
+letting you use a Unicorn for your application server, and Thin for your streaming server.
+This is a quick guide to creating exactly that on Heroku.
+
+First create your streaming server from the 'basic' example.
+
+    git clone https://github.com/maccman/sinatra-pubsub.git
+    cp -r sinatra-pubsub/examples/basic myapp-stream
+    cd myapp-stream
+    bundle install
+    heroku create myapp-stream
+    git push heroku master
+
+Now the server is deployed, you need to setup Redis. If you already have Redis running
+on your main application server, just run:
+
+    heroku config -a myapp | grep REDIS
+    heroku config:set REDIS_URL=YOUR_REDIS_URL -a myapp-stream
+
+Otherwise install the Redis To Go addon:
+
+    heroku addons:add redis:basic -a myapp-stream
+
+And you're finished! You can subscribe to a channel from any browser like this:
+
+    var es = new EventSource('http://myapp-stream.herokuapp.com/subscribe');
+    es.onmessage = function(e) {
+      console.log(JSON.parse(e.data));
+    };
+
+And publish to the stream from any Ruby client connected to the same Redis server:
+
+    Sinatra::PubSub.publish_all('Hello World')

data/examples/basic/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+ruby "2.0.0"
+
+gem "sinatra"
+gem "sinatra-pubsub"
+gem "thin"

data/examples/basic/app.rb

@@ -0,0 +1,9 @@
+require 'sinatra'
+require 'sinatra/pubsub'
+
+register Sinatra::PubSub
+
+Sinatra::PubSub.set(
+  cors:   true,
+  origin: '*'
+)

data/examples/tick/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+ruby "2.0.0"
+
+gem "sinatra"
+gem "sinatra-pubsub"
+gem "thin"

data/examples/{app.rb → tick/app.rb}

@@ -1,11 +1,17 @@
-require 'sinatra'
-require 'sinatra/pubsub'
+require 'rubygems'
+require 'bundler'
+
+Bundler.require
 
 register Sinatra::PubSub
 
+Sinatra::PubSub.set(
+  cors: false
+)
+
 EventMachine.next_tick do
   EventMachine::PeriodicTimer.new(1) do
-    Sinatra::PubSub.publish_all(type: 'tick')
+    Sinatra::PubSub.publish('tick', type: 'tick')
   end
 end
 
@@ -21,6 +27,6 @@ __END__
 
 <script>
   // reading
-  var es = new EventSource('/subscribe');
+  var es = new EventSource('/subscribe/tick');
   es.onmessage = function(e) { log.innerHTML += "\n" + e.data };
 </script>

data/examples/tick/config.ru

@@ -0,0 +1,3 @@
+require File.expand_path('../app', __FILE__)
+
+run Sinatra::Application

data/lib/sinatra/pubsub/app.rb

@@ -4,6 +4,7 @@ module Sinatra
       configure do
         set :cors, true
         set :origin, '*'
+        set :server, 'thin'
       end
 
       helpers do
@@ -19,7 +20,7 @@ module Sinatra
         secure = origin =~ /\Ahttps/
 
         allow  = settings.origin
-        allow.gsub!(/\Ahttp:\/\//, 'https://') if secure
+        allow  = allow.gsub(/\Ahttp:\/\//, 'https://') if secure
 
         headers['Access-Control-Allow-Origin']      = allow
         headers['Access-Control-Allow-Methods']     = 'GET'
@@ -30,7 +31,7 @@ module Sinatra
         error 402 unless Stream.enabled?
 
         stream :keep_open do |out|
-          stream  = Stream.new(out)
+          stream = Stream.new(out)
 
           if channels = params[:splat]
             stream.subscribe(channels.join('/'))

data/lib/sinatra/pubsub/stream.rb

@@ -34,8 +34,8 @@ module Sinatra
       attr_reader :out, :id
 
       def initialize(out)
-        @id       = SecureRandom.uuid
-        @out      = out
+        @id  = SecureRandom.uuid
+        @out = out
 
         subscribe :all
 

data/lib/sinatra/pubsub/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module PubSub
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-pubsub
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Alex MacCaw
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-21 00:00:00.000000000 Z
+date: 2013-11-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -92,10 +92,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/app.rb
-- examples/config.ru
-- examples/events.module.coffee
-- examples/stream.module.coffee
+- examples/basic/Gemfile
+- examples/basic/app.rb
+- examples/basic/config.ru
+- examples/frontend/events.module.coffee
+- examples/frontend/stream.module.coffee
+- examples/tick/Gemfile
+- examples/tick/app.rb
+- examples/tick/config.ru
 - lib/sinatra/pubsub.rb
 - lib/sinatra/pubsub/app.rb
 - lib/sinatra/pubsub/helpers.rb