captainu-tincan 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 069f61ac75dc1f4915231c6b9d7f5ac591f0b1ea
-  data.tar.gz: 732881f5ff1c6a4cc1bde3219b020c4359b1699d
+  metadata.gz: d1131a74590ccc72507072e98e99b76dc664b3b9
+  data.tar.gz: b54e1fae869ce79d00b979bee13db4a3196c7056
 SHA512:
-  metadata.gz: 1a25d23fc9bdd43b026c99e8bf9edb71432d8bae5b7fa35c16b6b323d4d0e71f32ad66e8f13602bae472eb35303fc2a7384ef805400face6454fd4a7608d8800
-  data.tar.gz: 3a8639d81a241835ad46119fe7fc34bf6e34793f19105e38c179fc158aceedbf765edc422d185b1d80a7d6ce12d521f8b715a4754a135ac830bff86aa59b8bb1
+  metadata.gz: 828686330455c64a8272530833d7e571cedf158ef0bab6a77d30fe090ced1c9a34f4c3cf73092a8ef69d13a45d77187cfd868f223272ed04f7a8c04ce035261c
+  data.tar.gz: 7180089c5bbc803b8fe0ebadd9ee9f6d4ce4578ea80bf993864d813cc3c218c12d2c3e615eeb4c0aa912566160bbae467db70d3e316abbe1012c0366e44049f8

data/lib/tincan/sender.rb

@@ -37,11 +37,15 @@ module Tincan
 
     # Asks Redis for the set of all active receivers and generates string
     # keys for all of them. Formatted like "namespace:object:client:messages".
+    # @param [String] object_name The name of the object, used in formulating
+    #                 which receiver list keys to return.
+    # @param [Array] exclude An optional array of client names to exclude
+    #                from the returned list of receiver list keys.
     # @return [Array] An array of keys identifying all receiver pointer lists.
-    def keys_for_receivers(object_name)
+    def keys_for_receivers(object_name, exclude: [])
       receiver_list_key = key_for_elements(object_name, 'receivers')
       receivers = redis_client.smembers(receiver_list_key)
-      receivers.map do |receiver|
+      receivers.reject { |r| exclude.include?(r) }.map do |receiver|
         key_for_elements(object_name, receiver, 'messages')
       end
     end
@@ -61,14 +65,14 @@ module Tincan
     # Bundles up an object in a message object and publishes it to the Redis
     # host.
     # @param [Tincan::Message] message The message to publish.
-    # @param [Symbol] change_type :create, :modify, or :delete.
+    # @param [Array] exclude An optional array of client names to exclude
+    #                from getting the published message.
     # @return [Boolean] true if the operation was a success.
-    def publish(message)
+    def publish(message, exclude: [])
       identifier = identifier_for_message(message)
       redis_client.set(primary_key_for_message(message), message.to_json)
-      keys_for_receivers(message.object_name.downcase).each do |key|
-        redis_client.rpush(key, identifier)
-      end
+      keys = keys_for_receivers(message.object_name.downcase, exclude: exclude)
+      keys.each { |key| redis_client.rpush(key, identifier) }
       true
     end
 

data/lib/tincan/version.rb

@@ -1,3 +1,3 @@
 module Tincan
-  VERSION = '0.7.1'
+  VERSION = '0.7.2'
 end

data/spec/sender_spec.rb

@@ -51,6 +51,12 @@ describe Tincan::Sender do
         result = sender.keys_for_receivers('object')
         expect(result).to eq(%w(data:object:some_client:messages))
       end
+
+      it 'can handle an optional list of clients to exclude' do
+        redis.sadd('data:object:receivers', 'bork')
+        result = sender.keys_for_receivers('object', exclude: 'bork')
+        expect(result).to eq(%w(data:object:some_client:messages))
+      end
     end
 
     describe :flush_all_queues_for_object do
@@ -84,22 +90,47 @@ describe Tincan::Sender do
       end
 
       before do
-        redis.sadd('data:dummy_class:receivers', 'some_client')
-        sender.publish(message)
-        @timestamp = Time.now.to_i
+        %w(some_client bork).each do |name|
+          redis.sadd('data:dummy_class:receivers', name)
+        end
       end
 
-      it 'publishes a message to Redis at a specific key' do
-        message = redis.get("data:dummy_class:messages:#{@timestamp}")
-        expect(message).to be_a(String)
-        expected = '{"object_name":"dummy_class","change_type":"create",'
-        expected += '"object_data":{"name":"Some Idiot"},"published_at":'
-        expect(message).to start_with(expected)
+      context 'posting to all clients' do
+        before do
+          sender.publish(message)
+          @timestamp = Time.now.to_i
+        end
+
+        it 'publishes a message to Redis at a specific key' do
+          message = redis.get("data:dummy_class:messages:#{@timestamp}")
+          expect(message).to be_a(String)
+          expected = '{"object_name":"dummy_class","change_type":"create",'
+          expected += '"object_data":{"name":"Some Idiot"},"published_at":'
+          expect(message).to start_with(expected)
+        end
+
+        it 'also publishes a message ID to client-specific receiver lists' do
+          identifier = redis.lpop('data:dummy_class:some_client:messages')
+          expect(identifier).to eq(@timestamp.to_s)
+
+          identifier = redis.lpop('data:dummy_class:bork:messages')
+          expect(identifier).to eq(@timestamp.to_s)
+        end
       end
 
-      it 'also publishes a message ID to client-specific receiver lists' do
-        identifier = redis.lpop('data:dummy_class:some_client:messages')
-        expect(identifier).to eq(@timestamp.to_s)
+      context 'posting to non-excluded clients' do
+        before do
+          sender.publish(message, exclude: %w(bork))
+          @timestamp = Time.now.to_i
+        end
+
+        it 'publishes message IDs to client-specific receivers, non-excluded' do
+          identifier = redis.lpop('data:dummy_class:some_client:messages')
+          expect(identifier).to eq(@timestamp.to_s)
+
+          identifier = redis.lpop('data:dummy_class:bork:messages')
+          expect(identifier).to be_nil
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: captainu-tincan
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Ben Kreeger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-18 00:00:00.000000000 Z
+date: 2014-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -196,7 +196,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.3.0
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
 summary: A simple implementation of reliable Redis messaging.