message_bus 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: caef3d7766089e6196e8a42f2829edf6aebbd7bf70ef38210db050007edcd865
-  data.tar.gz: da3fd2dd2e2111802ddeffb4d8a0981f62fb4fdd8fd3fe249a36acbbd66298a1
+  metadata.gz: fe33cef07b7712b1bbcc2ab444e123fd1121665a5ecf1db7fb24dba190e48b38
+  data.tar.gz: 325300ad20aeb221d468326247c7755022dc8e594e8de1311601dec89b4a2c2b
 SHA512:
-  metadata.gz: 6a3e6b63fe2448577ab4e099ba0135130b14731f017f669f28fa720e00412e14997dca92091ab5b84faaefa3443aa87f8cc0159d21b454199d287156e267c998
-  data.tar.gz: fb65941d890beb25a2a0a2e743d9d2176a2ec7f7d26609ccab4aacc3aefc6f783c5de5b498c69fedb4c774e329506d638038dc21cde77107b6bade4efd90aa76
+  metadata.gz: 216a6156aad68865beb14a519bda4f709e10d96bcc8c58fa4bc042ef596fd7563926517f5b5c82d547f4ff26ce7bd3ac0a74998ce9cf7b4b2d66c792f049c602
+  data.tar.gz: fb521cf6b6928586f7ba1f2da19a8def8d3f77acc0d6cb1c417fe03d8a36f0af8a470c29cc26ce400c12ba8648223ded2de43109a4616b5c89b967ed4e6a67aa

data/CHANGELOG

@@ -1,3 +1,9 @@
+28-04-2020
+
+- Version 3.1.0
+
+  - FEATURE: `MessageBus#register_client_message_filter` to register a custom filter so that messages can be inspected and filtered away from clients.
+
 27-04-2020
 
 - Version 3.0.0

data/README.md

@@ -129,6 +129,20 @@ MessageBus.publish "/channel", "hello", client_ids: ["XXX", "YYY"], user_ids: [1
 
 Passing `nil` or `[]` to either `client_ids`, `user_ids` or `group_ids` is equivalent to allowing all values on each option.
 
+### Filtering Client Messages
+
+Custom client message filters can be registered via `MessageBus#register_client_message_filter`. This can be useful for filtering away messages from the client based on the message's payload.
+
+For example, ensuring that only messages seen by the server in the last 20 seconds are published to the client:
+
+```
+MessageBus.register_client_message_filter('/test') do |message|
+  (Time.now.to_i - message.data[:published_at]) <= 20
+end
+
+MessageBus.publish('/test/5', { data: "somedata", published_at: Time.now.to_i })
+```
+
 ### Error handling
 
 ```ruby

data/lib/message_bus.rb

@@ -554,6 +554,26 @@ module MessageBus::Implementation
     @config[:keepalive_interval] || 60
   end
 
+  # Registers a client message filter that allows messages to be filtered from the client.
+  #
+  # @param [String,Regexp] channel_prefix channel prefix to match against a message's channel
+  #
+  # @yieldparam [MessageBus::Message] message published to the channel that matched the prefix provided
+  # @yieldreturn [Boolean] whether the message should be published to the client
+  # @return [void]
+  def register_client_message_filter(channel_prefix, &blk)
+    if blk
+      configure(client_message_filters: []) if !@config[:client_message_filters]
+      @config[:client_message_filters] << [channel_prefix, blk]
+    end
+  end
+
+  # @return [Array] returns a hash of message filters that have been registered
+  def client_message_filters
+    configure(client_message_filters: []) if !@config[:client_message_filters]
+    @config[:client_message_filters]
+  end
+
   private
 
   ENCODE_SITE_TOKEN = "$|$"

data/lib/message_bus/client.rb

@@ -147,7 +147,24 @@ class MessageBus::Client
       ).length < msg.group_ids.length
     end
 
-    client_allowed && (user_allowed || group_allowed || (!has_users && !has_groups))
+    has_permission = client_allowed && (user_allowed || group_allowed || (!has_users && !has_groups))
+
+    return has_permission if !has_permission
+
+    filters_allowed = true
+
+    len = @bus.client_message_filters.length
+    while len > 0
+      len -= 1
+      channel_prefix, blk = @bus.client_message_filters[len]
+
+      if msg.channel.start_with?(channel_prefix)
+        filters_allowed = blk.call(msg)
+        break if !filters_allowed
+      end
+    end
+
+    filters_allowed
   end
 
   # @return [Array<MessageBus::Message>] the set of messages the client is due

data/lib/message_bus/version.rb

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

data/spec/lib/message_bus/client_spec.rb

@@ -350,6 +350,39 @@ describe MessageBus::Client do
           @client.allowed?(@message).must_equal(false)
         end
       end
+
+      describe 'when MessageBus#client_message_filters has been configured' do
+
+        it 'filters messages correctly' do
+          message = MessageBus::Message.new(1, 2, '/test/5', 'hello')
+          @client.allowed?(message).must_equal(true)
+
+          @bus.register_client_message_filter('/test') do |m|
+            m.data != 'hello'
+          end
+
+          @client.allowed?(message).must_equal(false)
+        end
+
+        it 'filters messages correctly when multiple filters have been configured' do
+
+          bob_message = MessageBus::Message.new(1, 2, '/test/5', 'bob')
+          fred_message = MessageBus::Message.new(1, 2, '/test/5', 'fred')
+          random_message = MessageBus::Message.new(1, 2, '/test/77', 'random')
+
+          @bus.register_client_message_filter('/test') do |message|
+            message.data == 'bob' || message.data == 'fred'
+          end
+
+          @bus.register_client_message_filter('/test') do |message|
+            message.data == 'fred'
+          end
+
+          @client.allowed?(fred_message).must_equal(true)
+          @client.allowed?(bob_message).must_equal(false)
+          @client.allowed?(random_message).must_equal(false)
+        end
+      end
     end
   end
 end

data/spec/lib/message_bus_spec.rb

@@ -292,4 +292,19 @@ describe MessageBus do
 
     data.must_equal(["pre-fork", "from-fork", "continuation"])
   end
+
+  describe '#register_client_message_filter' do
+    it 'should register the message filter correctly' do
+      @bus.register_client_message_filter('/test')
+
+      @bus.client_message_filters.must_equal([])
+
+      @bus.register_client_message_filter('/test') { puts "hello world" }
+
+      channel, blk = @bus.client_message_filters[0]
+
+      blk.must_respond_to(:call)
+      channel.must_equal('/test')
+    end
+  end
 end

metadata

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