message_bus 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7add5c68e797a080452032f17f17930bd2d28092
-  data.tar.gz: 15b55cad8b5dc0599d92fb88c74a83271703f46a
+  metadata.gz: 00b86d8f7631445d13999cf03c8474c94a5c6df0
+  data.tar.gz: da3f677b77b8695d27cb5d6997c22894ea33bd5b
 SHA512:
-  metadata.gz: 3385147eb91410e0606e95d32183f017cf218b86d2c51f2cfed7fd8ec7b15394c64fa6b64bcc9e3862e61781030b7c8f4d8fbd640f4c3e698dc28e2dd784e3ed
-  data.tar.gz: afcd0a5014c1c1f9ae229565d7dc7574f76eb1eecf544066acbed7b47db9d134b656a4bbc772ecf7285928f0e74b16a8c2e0f26cffa31aa252b55a86120066ef
+  metadata.gz: 7bba577513285f36a95898d524e2cc60f832be1e1c7bb92d63313fe82b5862dd3ddeb48930fff071bde92d85be03eea102836af19513633f23e0962c645e8d1d
+  data.tar.gz: bbb1d8c326c2e8c85ddacce97a37aabdf0562ac15b0bd7153ce1fec6ebebbd7c7d68d14a36ec45e1afaa2a1b911ca2e01facf4a86da521669251bf86e97143e2

data/CHANGELOG

@@ -1,3 +1,10 @@
+09-12-2015
+
+- Version 1.1.1
+- Fix: In multisite config there was no way to specify site for last_id or backlog
+   to resolve overrides were added to #last_id and #backlog, MessageBus::Client now
+   uses the new overrides
+
 07-12-2015
 
 - Version 1.1.0

data/README.md

@@ -4,6 +4,10 @@ A reliable, robust messaging bus for Ruby processes and web clients built on Red
 
 MessageBus implements a Server to Server channel based protocol and Server to Web Client protocol (using polling or long-polling)
 
+Long-polling is implemented using Rack Hijack and Thin::Async, all common Ruby web server can run MessageBus (Thin, Puma, Unicorn) and handle a large amount of concurrent connections that wait on messages.
+
+MessageBus is implemented as Rack middleware and can be used by and Rails / Sinatra or pure Rack application.
+
 
 ## Installation
 
@@ -78,8 +82,14 @@ MessageBus.publish "/channel", "some message"
 
 # you may publish messages to ALL sites using the /global/ prefix
 MessageBus.publish "/global/channel", "will go to all sites"
+
 ```
 
+### Client support
+
+MessageBus ships a simple ~300 line JavaScript library which provides an API to interact with the server.
+
+
 JavaScript can listen on any channel (and receive notification via polling or long polling):
 
 ```html
@@ -96,9 +106,41 @@ MessageBus.subscribe("/channel", function(data){
   // data shipped from server
 });
 
-
 ```
 
+**Client settings**:
+
+
+All client settings are settable via `MessageBus.OPTION`
+
+Setting|Default|
+----|---|---|
+enableLongPolling|true|Allow long-polling (provided it is enable by the server)
+callbackInterval|15000|Safeguard to ensure background polling does not exceed this interval (in milliseconds)
+backgroundCallbackInterval|60000|Interval to poll when long polling is disabled (either explicitly or due to browser being in backgroud)
+maxPollInterval|180000|If request to the server start failing, MessageBus will backoff, this is the upper limit of the backoff.
+alwaysLongPoll|false|For debugging you may want to disable the "is browser in background" check and always long-poll
+baseUrl|/|If message bus is mounted in a subdirectory of different domain, you may configure it to perform requests there
+ajax|$.ajax|The only dependency on jQuery, you may set up a custom ajax function here
+
+**API**:
+
+`MessageBus.diagnostics()` : Returns a log that may be used for diagnostics on the status of message bus
+
+`MessageBus.pause()` : Pause all MessageBus activity
+
+`MessageBus.resume()` : Resume MessageBus activity
+
+`MessageBus.stop()` : Stop all MessageBus activity
+
+`MessageBus.start()` : Must be called to startup the MessageBus poller
+
+`MessageBus.subscribe(channel,func,lastId)` : Subscribe to a channel, optionally you may specify the id of the last message you received in the channel.
+
+`MessageBus.unsubscribe(channel,func)` : Unsubscribe callback from a particular channel
+
+
+
 ## Configuration
 
 ### Redis
@@ -145,14 +187,13 @@ after_fork do |server, worker|
 end
 ```
 
-## Similar projects
+## Want to help?
+
+If you are looking to contribute to this project here are some ideas
 
-Faye - http://faye.jcoglan.com/
+- Build an in-memory storage backend to ease testing and for very simple deployments
+- Build a PostgreSQL backend using NOTIFY and LISTEN
+- Improve general documentation
+- Port the test suite to MiniTest
 
-## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request

data/assets/message-bus.js

@@ -174,7 +174,7 @@ window.MessageBus = (function() {
     baseUrl: baseUrl,
     // TODO we can make the dependency on $ and jQuery conditional
     // all we really need is an implementation of ajax
-    ajax: $.ajax,
+    ajax: ($ && $.ajax),
 
     diagnostics: function(){
       console.log("Stopped: " + stopped + " Started: " + started);
@@ -200,15 +200,13 @@ window.MessageBus = (function() {
     },
 
     // Start polling
-    start: function(opts) {
+    start: function() {
       var poll, delayPollTimeout;
 
       if (started) return;
       started = true;
       stopped = false;
 
-      if (!opts) opts = {};
-
       poll = function() {
         var data;
 

data/lib/message_bus.rb

@@ -232,10 +232,10 @@ module MessageBus::Implementation
   ENCODE_SITE_TOKEN = "$|$"
 
   # encode channel name to include site
-  def encode_channel_name(channel)
-    if site_id_lookup && !global?(channel)
+  def encode_channel_name(channel, site_id=nil)
+    if (site_id || site_id_lookup) && !global?(channel)
       raise ArgumentError.new channel if channel.include? ENCODE_SITE_TOKEN
-      "#{channel}#{ENCODE_SITE_TOKEN}#{site_id_lookup.call}"
+      "#{channel}#{ENCODE_SITE_TOKEN}#{site_id || site_id_lookup.call}"
     else
       channel
     end
@@ -268,10 +268,10 @@ module MessageBus::Implementation
     backlog(nil, last_id)
   end
 
-  def backlog(channel=nil, last_id=nil)
+  def backlog(channel=nil, last_id=nil, site_id=nil)
     old =
       if channel
-        reliable_pub_sub.backlog(encode_channel_name(channel), last_id)
+        reliable_pub_sub.backlog(encode_channel_name(channel,site_id), last_id)
       else
         reliable_pub_sub.global_backlog(last_id)
       end
@@ -282,8 +282,8 @@ module MessageBus::Implementation
     old
   end
 
-  def last_id(channel)
-    reliable_pub_sub.last_id(encode_channel_name(channel))
+  def last_id(channel,site_id=nil)
+    reliable_pub_sub.last_id(encode_channel_name(channel,site_id))
   end
 
   def last_message(channel)

data/lib/message_bus/client.rb

@@ -89,7 +89,7 @@ class MessageBus::Client
     r = []
     @subscriptions.each do |k,v|
       next if v.to_i < 0
-      messages = @bus.backlog(k,v)
+      messages = @bus.backlog(k, v, site_id)
       messages.each do |msg|
         r << msg if allowed?(msg)
       end
@@ -99,7 +99,7 @@ class MessageBus::Client
     @subscriptions.each do |k,v|
       if v.to_i == -1
         status_message ||= {}
-        status_message[k] = @bus.last_id(k)
+        status_message[k] = @bus.last_id(k, site_id)
       end
     end
     r << MessageBus::Message.new(-1, -1, '/__status', status_message) if status_message

data/lib/message_bus/version.rb

@@ -1,3 +1,3 @@
 module MessageBus
-  VERSION = "1.1.0"
+  VERSION = "1.1.1"
 end

data/spec/lib/client_spec.rb

@@ -15,6 +15,31 @@ describe MessageBus::Client do
       @bus.destroy
     end
 
+    it "does not bleed data accross sites" do
+      @client.site_id = "test"
+
+      @client.subscribe('/hello', nil)
+      @bus.publish '/hello', 'world'
+      log = @client.backlog
+      log.length.should == 0
+    end
+
+    it "does not bleed status accross sites" do
+      @client.site_id = "test"
+
+      @client.subscribe('/hello', -1)
+      @bus.publish '/hello', 'world'
+      log = @client.backlog
+      log[0].data.should == {"/hello" => 0}
+    end
+
+    it "provides status" do
+      @client.subscribe('/hello', -1)
+      log = @client.backlog
+      log.length.should == 1
+      log[0].data.should == {"/hello" => 0}
+    end
+
     it "should provide a list of subscriptions" do
       @client.subscribe('/hello', nil)
       @client.subscriptions['/hello'].should_not be_nil

data/vendor/assets/javascripts/message-bus.js

@@ -174,7 +174,7 @@ window.MessageBus = (function() {
     baseUrl: baseUrl,
     // TODO we can make the dependency on $ and jQuery conditional
     // all we really need is an implementation of ajax
-    ajax: $.ajax,
+    ajax: ($ && $.ajax),
 
     diagnostics: function(){
       console.log("Stopped: " + stopped + " Started: " + started);
@@ -200,15 +200,13 @@ window.MessageBus = (function() {
     },
 
     // Start polling
-    start: function(opts) {
+    start: function() {
       var poll, delayPollTimeout;
 
       if (started) return;
       started = true;
       stopped = false;
 
-      if (!opts) opts = {};
-
       poll = function() {
         var data;
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2015-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack