message_bus 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e596a5f9146a82e6197f01287502006f9330f9b
-  data.tar.gz: bb698d73ba25f0681cdda865b6f09a348a9f2b17
+  metadata.gz: 9edd8ca36b455984824a1b9841e626352f04751e
+  data.tar.gz: 4f9069b34ea6823a316d20079ec698444f0c6e43
 SHA512:
-  metadata.gz: 061915a68b0301e7d86d4f40fcd4f9f40b2d34f362350dfd89c881e73b1bddf245eaa1ecf7ad7e53cff82c3f35ab280361d7d80a9481416f3dd6df1352f2f623
-  data.tar.gz: bdc6d8c4c2e822c9835ed73237eadfd5da825481ac3c0e15245e90b1fd3a8e704199e2fd08250aa73c830f94ad705767f9543894f8815cb07e6b1aeef4a0106c
+  metadata.gz: 6fcc39d57dc21800df3e6fee29ec9bcf95285a44588e6b05e4746693cd070c7f6492e86fdc852351bfde59b209f7d21780912927d0bf20a290f6d4c4ebfb2ebd
+  data.tar.gz: 408932aae79880e94ac15d65c2a5d6fa75eb46eacc2a6fda8eb45f704daac3e7cc1322e4ea5dbe5653b548cfa6b8299a15e157dce46d7bc00d288e45a4d2ef3a

data/CHANGELOG

@@ -1,3 +1,7 @@
+28-05-2015
+- Version 1.0.12
+- Feature: Support client_id targetted message
+
 06-05-2015
 - Version 1.0.11
 - Fix: race condition in TimerThread

data/README.md

@@ -39,6 +39,9 @@ MessageBus.backlog "/channel", id
 # messages can be targetted at particular users or groups
 MessageBus.publish "/channel", user_ids: [1,2,3], group_ids: [4,5,6]
 
+# messages can be targetted at particular clients (using MessageBus.clientId)
+MessageBus.publish "/channel", client_ids: ["XXX","YYY"]
+
 # message bus determines the user ids and groups based on env
 
 MessageBus.user_id_lookup do |env|

data/lib/message_bus.rb

@@ -2,13 +2,13 @@ require "monitor"
 require "set"
 require "message_bus/version"
 require "message_bus/message"
-require "message_bus/reliable_pub_sub"
 require "message_bus/client"
 require "message_bus/connection_manager"
 require "message_bus/message_handler"
 require "message_bus/diagnostics"
 require "message_bus/rack/middleware"
 require "message_bus/rack/diagnostics"
+require "message_bus/redis/reliable_pub_sub"
 
 # we still need to take care of the logger
 if defined?(::Rails)
@@ -177,10 +177,14 @@ module MessageBus::Implementation
       end
   end
 
+  def reliable_pub_sub=(pub_sub)
+    @reliable_pub_sub = pub_sub
+  end
+
   def reliable_pub_sub
     @mutex.synchronize do
       return nil if @destroyed
-      @reliable_pub_sub ||= MessageBus::ReliablePubSub.new redis_config
+      @reliable_pub_sub ||= MessageBus::Redis::ReliablePubSub.new redis_config
     end
   end
 
@@ -196,9 +200,12 @@ module MessageBus::Implementation
 
     user_ids = nil
     group_ids = nil
+    client_ids = nil
+
     if opts
       user_ids = opts[:user_ids]
       group_ids = opts[:group_ids]
+      client_ids = opts[:client_ids]
     end
 
     raise ::MessageBus::InvalidMessage if (user_ids || group_ids) && global?(channel)
@@ -206,7 +213,8 @@ module MessageBus::Implementation
     encoded_data = JSON.dump({
       data: data,
       user_ids: user_ids,
-      group_ids: group_ids
+      group_ids: group_ids,
+      client_ids: client_ids
     })
 
     reliable_pub_sub.publish(encode_channel_name(channel), encoded_data)
@@ -319,6 +327,7 @@ module MessageBus::Implementation
     msg.data = parsed["data"]
     msg.user_ids = parsed["user_ids"]
     msg.group_ids = parsed["group_ids"]
+    msg.client_ids = parsed["client_ids"]
   end
 
   def subscribe_impl(channel, site_id, &blk)

data/lib/message_bus/client.rb

@@ -55,6 +55,7 @@ class MessageBus::Client
 
   def allowed?(msg)
     allowed = !msg.user_ids || msg.user_ids.include?(self.user_id)
+    allowed &&= !msg.client_ids || msg.client_ids.include?(self.client_id)
     allowed && (
       msg.group_ids.nil? ||
       msg.group_ids.length == 0 ||

data/lib/message_bus/message.rb

@@ -1,13 +1,14 @@
 class MessageBus::Message < Struct.new(:global_id, :message_id, :channel , :data)
 
-  attr_accessor :site_id, :user_ids, :group_ids
+  attr_accessor :site_id, :user_ids, :group_ids, :client_ids
 
   def self.decode(encoded)
     s1 = encoded.index("|")
     s2 = encoded.index("|", s1+1)
     s3 = encoded.index("|", s2+1)
 
-    MessageBus::Message.new encoded[0..s1].to_i, encoded[s1+1..s2].to_i, encoded[s2+1..s3-1].gsub("$$123$$", "|"), encoded[s3+1..-1]
+    MessageBus::Message.new(encoded[0..s1].to_i, encoded[s1+1..s2].to_i,
+                            encoded[s2+1..s3-1].gsub("$$123$$", "|"), encoded[s3+1..-1])
   end
 
   # only tricky thing to encode is pipes in a channel name ... do a straight replace

data/lib/message_bus/rack/middleware.rb

@@ -88,7 +88,8 @@ class MessageBus::Rack::Middleware
     # close db connection as early as possible
     close_db_connection!
 
-    client = MessageBus::Client.new(message_bus: @bus, client_id: client_id, user_id: user_id, site_id: site_id, group_ids: group_ids)
+    client = MessageBus::Client.new(message_bus: @bus, client_id: client_id,
+                                    user_id: user_id, site_id: site_id, group_ids: group_ids)
 
     request = Rack::Request.new(env)
     request.POST.each do |k,v|

data/lib/message_bus/{reliable_pub_sub.rb → redis/reliable_pub_sub.rb}

@@ -7,8 +7,8 @@ require 'redis'
 # ids are all sequencially increasing numbers starting at 0
 #
 
-
-class MessageBus::ReliablePubSub
+module MessageBus::Redis; end
+class MessageBus::Redis::ReliablePubSub
   attr_reader :subscribed
   attr_accessor :max_publish_retries, :max_publish_wait, :max_backlog_size,
                 :max_global_backlog_size, :max_in_memory_publish_backlog
@@ -27,7 +27,7 @@ class MessageBus::ReliablePubSub
   # max_backlog_size is per multiplexed channel
   def initialize(redis_config = {}, max_backlog_size = 1000)
     @redis_config = redis_config
-    @max_backlog_size = 1000
+    @max_backlog_size = max_backlog_size
     # we can store a lot of messages, since only one queue
     @max_global_backlog_size = 100000
     @max_publish_retries = 10

data/lib/message_bus/version.rb

@@ -1,3 +1,3 @@
 module MessageBus
-  VERSION = "1.0.11"
+  VERSION = "1.0.12"
 end

data/spec/lib/client_spec.rb

@@ -29,6 +29,16 @@ describe MessageBus::Client do
       log[0].data.should == 'world'
     end
 
+    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"]
+      @client.client_id = "2"
+      @client.allowed?(@message).should == true
+
+      @client.client_id = "3"
+      @client.allowed?(@message).should == false
+    end
+
     context "targetted at group" do
       before do
         @message = MessageBus::Message.new(1,2,'/test', 'hello')
@@ -50,6 +60,7 @@ describe MessageBus::Client do
         @client.group_ids = [77,0,10]
         @client.allowed?(@message).should == true
       end
+
     end
   end
 

data/spec/lib/message_bus_spec.rb

@@ -18,6 +18,21 @@ describe MessageBus do
     @bus.destroy
   end
 
+  it "can transmit client_ids" do
+    client_ids = nil
+
+    @bus.subscribe("/chuck") do |msg|
+      client_ids = msg.client_ids
+    end
+
+    @bus.publish("/chuck", {:yeager => true}, client_ids: ['a','b'])
+
+    wait_for(2000){ client_ids}
+
+    client_ids.should == ['a', 'b']
+
+  end
+
   it "should recover from a redis flush" do
 
     data = nil

data/spec/lib/multi_process_spec.rb

@@ -1,10 +1,10 @@
 require 'spec_helper'
 require 'message_bus'
 
-describe MessageBus::ReliablePubSub do
+describe MessageBus::Redis::ReliablePubSub do
 
   def new_bus
-    MessageBus::ReliablePubSub.new(:db => 10)
+    MessageBus::Redis::ReliablePubSub.new(:db => 10)
   end
 
   def work_it
@@ -31,7 +31,7 @@ describe MessageBus::ReliablePubSub do
     begin
       pids = (1..10).map{spawn_child}
       responses = []
-      bus = MessageBus::ReliablePubSub.new(:db => 10)
+      bus = MessageBus::Redis::ReliablePubSub.new(:db => 10)
       Thread.new do
         bus.subscribe("/response", 0) do |msg|
           responses << msg if pids.include? msg.data.to_i

data/spec/lib/{reliable_pub_sub_spec.rb → redis/reliable_pub_sub_spec.rb}

@@ -1,10 +1,10 @@
 require 'spec_helper'
 require 'message_bus'
 
-describe MessageBus::ReliablePubSub do
+describe MessageBus::Redis::ReliablePubSub do
 
   def new_test_bus
-    MessageBus::ReliablePubSub.new(:db => 10)
+    MessageBus::Redis::ReliablePubSub.new(:db => 10)
   end
 
   before do
@@ -47,6 +47,10 @@ describe MessageBus::ReliablePubSub do
     ]
   end
 
+  it "should initialize with max_backlog_size" do
+    MessageBus::Redis::ReliablePubSub.new({},2000).max_backlog_size.should == 2000
+  end
+
   it "should truncate channels correctly" do
     @bus.max_backlog_size = 2
     4.times do |t|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -81,7 +81,7 @@ files:
 - lib/message_bus/rack/middleware.rb
 - lib/message_bus/rack/thin_ext.rb
 - lib/message_bus/rails/railtie.rb
-- lib/message_bus/reliable_pub_sub.rb
+- lib/message_bus/redis/reliable_pub_sub.rb
 - lib/message_bus/timer_thread.rb
 - lib/message_bus/version.rb
 - message_bus.gemspec
@@ -94,7 +94,7 @@ files:
 - spec/lib/message_handler_spec.rb
 - spec/lib/middleware_spec.rb
 - spec/lib/multi_process_spec.rb
-- spec/lib/reliable_pub_sub_spec.rb
+- spec/lib/redis/reliable_pub_sub_spec.rb
 - spec/lib/timer_thread_spec.rb
 - spec/spec_helper.rb
 - vendor/assets/javascripts/message-bus.js
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: ''
@@ -132,6 +132,6 @@ test_files:
 - spec/lib/message_handler_spec.rb
 - spec/lib/middleware_spec.rb
 - spec/lib/multi_process_spec.rb
-- spec/lib/reliable_pub_sub_spec.rb
+- spec/lib/redis/reliable_pub_sub_spec.rb
 - spec/lib/timer_thread_spec.rb
 - spec/spec_helper.rb