message_bus 2.0.9 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 558fcebb3ac3abe9031039c73f996264da91cf27
-  data.tar.gz: f1bc3ef44e127a51952a8f27acf33e0980494a51
+  metadata.gz: 6609e7158e64715d6113ffb1c2d61d99c919d16b
+  data.tar.gz: d561cb2c1342bc50cca592676f7f45c6eb50326e
 SHA512:
-  metadata.gz: 64fde0c29746bd402f04c9502aa304b700ea8b27eff505a9385f88de11f054cdb84f12f006478b6efcc4de9b897dbaf2c0d4e0ac485497ce32fa7e47ead9caae
-  data.tar.gz: 3f8dd7191ef89cdf0ec82211098a5a310382d91525c9ea39006d326f13e2e61b5b59dac4ddc6b77b60e1fd74973d00d0d7a12eb9913c772abc2b3cc4091dd740
+  metadata.gz: 9f42d527e19b5a9e15edabb29198a860447fb2e57697b2d946aa1bac26e5d2c8eec860a8839ff6fede461e61a050c806ae9fbfba39ff6e2ae0a945238d3921e6
+  data.tar.gz: 271dc3f565aa0dde4f2e513f5fb9cddaf4e59680bbe5b87136708c042020de47c9469cdf56d8f9d5025ce1272138e9ac7b4adfde5713ed896b7a9002bf8cbc42

data/CHANGELOG

@@ -1,3 +1,10 @@
+18-12-2017
+
+- Version 2.1.0
+
+- FEATURE: you can now lookup last N messages on channel on subscribe from JavaScript
+   Subscribe at position (-1 - numberOfMessages) from the client
+
 24-11-2017
 
 - Version 2.0.9

data/README.md

@@ -196,10 +196,28 @@ MessageBus.start(); // call once at startup
 
 // how often do you want the callback to fire in ms
 MessageBus.callbackInterval = 500;
+
+// you will get all new messages sent to channel
 MessageBus.subscribe("/channel", function(data){
   // data shipped from server
 });
 
+
+// you will get all new messages sent to channel (-1 is implicit)
+MessageBus.subscribe("/channel", function(data){
+  // data shipped from server
+}, -1);
+
+
+// all messages AFTER message id 7 AND all new messages
+MessageBus.subscribe("/channel", function(data){
+  // data shipped from server
+}, 7);
+
+// last 2 messages in channel AND all new messages
+MessageBus.subscribe("/channel", function(data){
+  // data shipped from server
+}, -3);
 ```
 
 There is also a Ruby implementation of the client library, at

data/assets/message-bus.js

@@ -365,15 +365,21 @@
     },
 
     // Subscribe to a channel
+    // if lastId is 0 or larger, it will recieve messages AFTER that id
+    // if lastId is nagative it will perform lookbehind"
+    // -1 will subscribe to all new messages
+    // -2 will recieve last message + all new messages
+    // -3 will recieve last 2 messages + all new messages
     subscribe: function(channel, func, lastId) {
 
       if(!started && !stopped){
         me.start();
       }
 
-      if (typeof(lastId) !== "number" || lastId < -1){
+      if (typeof(lastId) !== "number") {
         lastId = -1;
       }
+
       callbacks.push({
         channel: channel,
         func: func,

data/examples/chat/docker_container/chat.yml

@@ -1,4 +1,4 @@
-base_image: "discourse/base:1.0.15"
+base_image: "discourse/base:2.0.20171204"
 
 update_pups: false
 

data/lib/message_bus/client.rb

@@ -121,11 +121,19 @@ class MessageBus::Client
     new_message_ids = nil
 
     @subscriptions.each do |k, v|
-      next if v.to_i < 0
-      messages = @bus.backlog(k, v, site_id)
+      id = v.to_i
+
+      if id < -1
+        last_id = @bus.last_id(k, site_id)
+        id = last_id + id + 1
+        id = 0 if id < 0
+      end
+
+      next if id < 0
+      messages = @bus.backlog(k, id, site_id)
 
       if messages.length == 0
-        if v.to_i > @bus.last_id(k, site_id)
+        if id > @bus.last_id(k, site_id)
           @subscriptions[k] = -1
         end
       else

data/lib/message_bus/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module MessageBus
-  VERSION = "2.0.9"
+  VERSION = "2.1.0"
 end

data/spec/lib/message_bus/client_spec.rb

@@ -29,7 +29,7 @@ describe MessageBus::Client do
 
       while line = lines.shift
         break if line == ""
-        name,val = line.split(": ")
+        name, val = line.split(": ")
         headers[name] = val
       end
 
@@ -39,7 +39,7 @@ describe MessageBus::Client do
         break if length == 0
         rest = lines.join("\r\n")
         chunks << rest[0...length]
-        lines = (rest[length+2..-1] || "").split("\r\n")
+        lines = (rest[length + 2..-1] || "").split("\r\n")
       end
 
       # split/join gets tricky
@@ -49,15 +49,15 @@ describe MessageBus::Client do
     end
 
     def parse_chunk(data)
-      payload,_ = data.split(/\r\n\|\r\n/m)
+      payload, _ = data.split(/\r\n\|\r\n/m)
       JSON.parse(payload)
     end
 
     it "can chunk replies" do
       @client.use_chunked = true
-      r,w = IO.pipe
+      r, w = IO.pipe
       @client.io = w
-      @client.headers = {"Content-Type" => "application/json; charset=utf-8"}
+      @client.headers = { "Content-Type" => "application/json; charset=utf-8" }
       @client << MessageBus::Message.new(1, 1, '/test', 'test')
       @client << MessageBus::Message.new(2, 2, '/test', "a|\r\n|\r\n|b")
 
@@ -84,7 +84,7 @@ describe MessageBus::Client do
 
       data[-5..-1].must_equal "0\r\n\r\n"
 
-      _,_,chunks = http_parse("HTTP/1.1 200 OK\r\n\r\n" << data)
+      _, _, chunks = http_parse("HTTP/1.1 200 OK\r\n\r\n" << data)
 
       chunks.length.must_equal 2
 
@@ -116,6 +116,18 @@ describe MessageBus::Client do
       log[0].data.must_equal("/hello" => 0)
     end
 
+    it "allows negative subscribes to look behind" do
+
+      @bus.publish '/hello', 'world'
+      @bus.publish '/hello', 'sam'
+
+      @client.subscribe('/hello', -2)
+
+      log = @client.backlog
+      log.length.must_equal(1)
+      log[0].data.must_equal("sam")
+    end
+
     it "provides status" do
       @client.subscribe('/hello', -1)
       log = @client.backlog
@@ -139,7 +151,7 @@ describe MessageBus::Client do
       log = another_client.backlog
       log.length.must_equal 1
       log[0].channel.must_equal '/__status'
-      log[0].data.must_equal({ '/hello' => 1 })
+      log[0].data.must_equal('/hello' => 1)
     end
 
     it "should provide a list of subscriptions" do
@@ -158,7 +170,7 @@ describe MessageBus::Client do
 
     it "allows only client_id in list if message contains client_ids" do
       @message = MessageBus::Message.new(1, 2, '/test', 'hello')
-      @message.client_ids = ["1","2"]
+      @message.client_ids = ["1", "2"]
       @client.client_id = "2"
       @client.allowed?(@message).must_equal true
 
@@ -168,23 +180,23 @@ describe MessageBus::Client do
 
     describe "targetted at group" do
       before do
-        @message = MessageBus::Message.new(1,2,'/test', 'hello')
-        @message.group_ids = [1,2,3]
+        @message = MessageBus::Message.new(1, 2, '/test', 'hello')
+        @message.group_ids = [1, 2, 3]
       end
 
       it "denies users that are not members of group" do
-        @client.group_ids = [77,0,10]
+        @client.group_ids = [77, 0, 10]
         @client.allowed?(@message).must_equal false
       end
 
       it "allows users that are members of group" do
-        @client.group_ids = [1,2,3]
+        @client.group_ids = [1, 2, 3]
         @client.allowed?(@message).must_equal true
       end
 
       it "allows all users if groups not set" do
         @message.group_ids = nil
-        @client.group_ids = [77,0,10]
+        @client.group_ids = [77, 0, 10]
         @client.allowed?(@message).must_equal true
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.0.9
+  version: 2.1.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-23 00:00:00.000000000 Z
+date: 2017-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack