message_bus 2.2.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 93e3bc28f1411da6037721acabab32fa504542bb68238afe6671f10bfccfa194
-  data.tar.gz: b25d3013be8f3a0efa180db29de0ac6a55e5ce08ea87f80c912f046b9548c821
+  metadata.gz: caef3d7766089e6196e8a42f2829edf6aebbd7bf70ef38210db050007edcd865
+  data.tar.gz: da3fd2dd2e2111802ddeffb4d8a0981f62fb4fdd8fd3fe249a36acbbd66298a1
 SHA512:
-  metadata.gz: c74493de8f9f2dc5305457696988d7f07dce56642a8796d3757a0e5bf4e14f6e9b011ed8bd9255e0d3dc197c290bbdafedcf47e2519f09ca085ec86f33848508
-  data.tar.gz: e4778edb5d540ef011ad29916dd8e4a374b04fb5dcd57ef80542b9f0b0985f5887609bf67b071455ebd15e59386eb0abc30698d015a4585f66a4d7afd217fc05
+  metadata.gz: 6a3e6b63fe2448577ab4e099ba0135130b14731f017f669f28fa720e00412e14997dca92091ab5b84faaefa3443aa87f8cc0159d21b454199d287156e267c998
+  data.tar.gz: fb65941d890beb25a2a0a2e743d9d2176a2ec7f7d26609ccab4aacc3aefc6f783c5de5b498c69fedb4c774e329506d638038dc21cde77107b6bade4efd90aa76

data/.rubocop.yml

@@ -1 +1,9 @@
-inherit_from: https://raw.githubusercontent.com/discourse/discourse/master/.rubocop.yml
+inherit_gem:
+  rubocop-discourse: .rubocop.yml
+
+AllCops:
+  Exclude:
+    - 'examples/**/*'
+
+RSpec:
+  Enabled: false

data/.travis.yml

@@ -1,9 +1,9 @@
 before_install: gem install bundler
 language: ruby
 rvm:
-  - 2.3
   - 2.4
   - 2.5
+  - 2.6
 gemfile:
   - Gemfile
 addons:

data/CHANGELOG

@@ -1,3 +1,10 @@
+27-04-2020
+
+- Version 3.0.0
+
+  - Drop support for Ruby 2.3
+  - FIX: Don't publish message to intersection of `user_ids` and `group_ids` - instead use the union, this is a behavior change, hence a new major release.
+
 26-03-2020
 
 - Version 2.2.4

data/Gemfile

@@ -20,8 +20,11 @@ group :test, :development do
   gem 'byebug'
 end
 
+group :development do
+  gem 'yard'
+  gem 'rubocop-discourse', require: false
+  gem 'rubocop-rspec', require: false
+end
+
 gem 'rack'
 gem 'concurrent-ruby' # for distributed-cache
-
-gem 'rubocop'
-gem 'yard'

data/README.md

@@ -74,32 +74,40 @@ id = MessageBus.last_id("/channel")
 MessageBus.backlog "/channel", id
 ```
 
-```ruby
-# messages can be targetted at particular users or groups
-MessageBus.publish "/channel", "hello", user_ids: [1,2,3], group_ids: [4,5,6]
+### Targetted messages
 
-# messages can be targetted at particular clients (using MessageBus.clientId)
-MessageBus.publish "/channel", "hello", client_ids: ["XXX","YYY"]
+Messages can be targetted to particular clients by supplying the `client_ids` option when publishing a message.
 
-# message bus determines the user ids and groups based on env
+```ruby
+MessageBus.publish "/channel", "hello", client_ids: ["XXX", "YYY"] # (using MessageBus.clientId)
+```
 
+By configuring the `user_id_lookup` and `group_ids_lookup` options with a Proc or Lambda which will be called with a [Rack specification environment](https://github.com/rack/rack/blob/master/SPEC.rdoc#the-environment-), messages can be targetted to particular clients users or groups by supplying either the `user_ids` or `group_ids` options when publishing a message.
+
+```ruby
 MessageBus.configure(user_id_lookup: proc do |env|
   # this lookup occurs on JS-client poolings, so that server can retrieve backlog
   # for the client considering/matching/filtering user_ids set on published messages
   # if user_id is not set on publish time, any user_id returned here will receive the message
-
   # return the user id here
 end)
 
+# Target user_ids when publishing a message
+MessageBus.publish "/channel", "hello", user_ids: [1, 2, 3]
+
 MessageBus.configure(group_ids_lookup: proc do |env|
   # return the group ids the user belongs to
   # can be nil or []
 end)
 
-# example of message bus to set user_ids from an initializer in Rails and Devise:
+# Target group_ids when publishing a message
+MessageBus.publish "/channel", "hello", group_ids: [1, 2, 3]
+
+# example of MessageBus to set user_ids from an initializer in Rails and Devise:
 # config/inializers/message_bus.rb
 MessageBus.user_id_lookup do |env|
   req = Rack::Request.new(env)
+
   if req.session && req.session["warden.user.user.key"] && req.session["warden.user.user.key"][0][0]
     user = User.find(req.session["warden.user.user.key"][0][0])
     user.id
@@ -107,6 +115,22 @@ MessageBus.user_id_lookup do |env|
 end
 ```
 
+If both `user_ids` and `group_ids` options are supplied when publishing a message, the message will be targetted at clients with lookup return values that  matches on either the `user_ids` **or** the `group_ids` options.
+
+```ruby
+MessageBus.publish "/channel", "hello", user_ids: [1, 2, 3], group_ids: [1, 2, 3]
+```
+
+If the `client_ids` option is supplied with either the `user_ids` or `group_ids` options when publising a message, the `client_ids` option will be applied unconditionally and messages will be filtered further using `user_id` or `group_id` clauses.
+
+```ruby
+MessageBus.publish "/channel", "hello", client_ids: ["XXX", "YYY"], user_ids: [1, 2, 3], group_ids: [1, 2, 3]
+```
+
+Passing `nil` or `[]` to either `client_ids`, `user_ids` or `group_ids` is equivalent to allowing all values on each option.
+
+### Error handling
+
 ```ruby
 MessageBus.configure(on_middleware_error: proc do |env, e|
    # If you wish to add special handling based on error

data/lib/message_bus/client.rb

@@ -128,15 +128,26 @@ class MessageBus::Client
   # @return [Boolean] whether or not the client has permission to receive the
   #   passed message
   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 ||
-      (
-        msg.group_ids - self.group_ids
+    client_allowed = !msg.client_ids || msg.client_ids.length == 0 || msg.client_ids.include?(self.client_id)
+
+    user_allowed = false
+    group_allowed = false
+
+    # this is an inconsistency we should fix anyway, publishing `user_ids: nil` should work same as groups
+    has_users = msg.user_ids && msg.user_ids.length > 0
+    has_groups = msg.group_ids && msg.group_ids.length > 0
+
+    if has_users
+      user_allowed = msg.user_ids.include?(self.user_id)
+    end
+
+    if has_groups
+      group_allowed = (
+        msg.group_ids - (self.group_ids || [])
       ).length < msg.group_ids.length
-    )
+    end
+
+    client_allowed && (user_allowed || group_allowed || (!has_users && !has_groups))
   end
 
   # @return [Array<MessageBus::Message>] the set of messages the client is due

data/lib/message_bus/diagnostics.rb

@@ -15,7 +15,6 @@ class MessageBus::Diagnostics
       #  process to process comms
       bus.subscribe('/_diagnostics/hup') do |msg|
         if Process.pid == msg.data["pid"] && hostname == msg.data["hostname"]
-          $shutdown = true
           sleep 4
           Process.kill("HUP", $$)
         end

data/lib/message_bus/rack/diagnostics.rb

@@ -45,7 +45,7 @@ class MessageBus::Rack::Diagnostics
       return [200, { 'Content-Type' => 'application/javascript;charset=UTF-8' }, [content]]
     end
 
-    return [404, {}, ['not found']]
+    [404, {}, ['not found']]
   end
 
   private
@@ -92,6 +92,7 @@ class MessageBus::Rack::Diagnostics
         </body>
       </html>
     HTML
-    return [200, { "content-type" => "text/html;" }, [html]]
+
+    [200, { "content-type" => "text/html;" }, [html]]
   end
 end

data/lib/message_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MessageBus
-  VERSION = "2.2.4"
+  VERSION = "3.0.0"
 end

data/spec/lib/message_bus/client_spec.rb

@@ -169,37 +169,187 @@ describe MessageBus::Client do
       log[0].data.must_equal '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).must_equal true
-
-      @client.client_id = "3"
-      @client.allowed?(@message).must_equal false
-    end
-
-    describe "targetted at group" do
-      before do
+    describe '#allowed?' do
+      it "allows only client_id in list if message contains client_ids" do
         @message = MessageBus::Message.new(1, 2, '/test', 'hello')
-        @message.group_ids = [1, 2, 3]
-      end
+        @message.client_ids = ["1", "2"]
+        @client.client_id = "2"
+        @client.allowed?(@message).must_equal true
 
-      it "denies users that are not members of group" do
-        @client.group_ids = [77, 0, 10]
+        @client.client_id = "3"
         @client.allowed?(@message).must_equal false
-      end
 
-      it "allows users that are members of group" do
-        @client.group_ids = [1, 2, 3]
+        @message.client_ids = []
+
+        @client.client_id = "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]
+        @message.client_ids = nil
+
+        @client.client_id = "3"
         @client.allowed?(@message).must_equal true
       end
+
+      describe 'targetted at user' do
+        before do
+          @message = MessageBus::Message.new(1, 2, '/test', 'hello')
+          @message.user_ids = [1, 2, 3]
+        end
+
+        it "allows client with user_id that is included in message's user_ids" do
+          @client.user_id = 1
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with user_id that is not included in message's user_ids" do
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "denies client with nil user_id" do
+          @client.user_id = nil
+
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client if message's user_ids is not set" do
+          @message.user_ids = nil
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "allows client if message's user_ids is empty" do
+          @message.user_ids = []
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "allows client with client_id that is included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "1"
+          @client.user_id = 1
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with client_id that is not included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "3"
+          @client.user_id = 1
+
+          @client.allowed?(@message).must_equal(false)
+        end
+      end
+
+      describe "targetted at group" do
+        before do
+          @message = MessageBus::Message.new(1, 2, '/test', 'hello')
+          @message.group_ids = [1, 2, 3]
+        end
+
+        it "denies client that are not members of group" do
+          @client.group_ids = [77, 0, 10]
+          @client.allowed?(@message).must_equal false
+        end
+
+        it 'denies client with nil group_ids' do
+          @client.group_ids = nil
+          @client.allowed?(@message).must_equal false
+        end
+
+        it "allows client that are members of group" do
+          @client.group_ids = [1, 2, 3]
+          @client.allowed?(@message).must_equal true
+        end
+
+        it "allows any client if message's group_ids is not set" do
+          @message.group_ids = nil
+          @client.group_ids = [77, 0, 10]
+          @client.allowed?(@message).must_equal true
+        end
+
+        it "allows any client if message's group_ids is empty" do
+          @message.group_ids = []
+          @client.group_ids = [77, 0, 10]
+          @client.allowed?(@message).must_equal true
+        end
+
+        it "allows client with client_id that is included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "1"
+          @client.group_ids = [1]
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with client_id that is not included in message's client_ids" do
+          @message.client_ids = ["1", "2"]
+          @client.client_id = "3"
+          @client.group_ids = [1]
+
+          @client.allowed?(@message).must_equal(false)
+        end
+      end
+
+      describe 'targetted at group and user' do
+        before do
+          @message = MessageBus::Message.new(1, 2, '/test', 'hello')
+          @message.group_ids = [1, 2, 3]
+          @message.user_ids = [4, 5, 6]
+        end
+
+        it "allows client with user_id that is included in message's user_ids" do
+          @client.user_id = 4
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with user_id that is not included in message's user_ids" do
+          @client.user_id = 1
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client with group_ids that is included in message's group_ids" do
+          @client.group_ids = [1, 0, 3]
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with group_ids that is not included in message's group_ids" do
+          @client.group_ids = [8, 9, 10]
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client with allowed client_id and user_id" do
+          @message.client_ids = ["1", "2"]
+          @client.user_id = 4
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with allowed client_id but disallowed user_id" do
+          @message.client_ids = ["1", "2"]
+          @client.user_id = 99
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(false)
+        end
+
+        it "allows client with allowed client_id and group_id" do
+          @message.client_ids = ["1", "2"]
+          @client.group_ids = [1]
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(true)
+        end
+
+        it "denies client with allowed client_id but disallowed group_id" do
+          @message.client_ids = ["1", "2"]
+          @client.group_ids = [99]
+          @client.client_id = "2"
+
+          @client.allowed?(@message).must_equal(false)
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: message_bus
 version: !ruby/object:Gem::Version
-  version: 2.2.4
+  version: 3.0.0
 platform: ruby
 authors:
 - Sam Saffron
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-26 00:00:00.000000000 Z
+date: 2020-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack