queue-bus 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4f35ec72b2a6256350aabd9f2f6fa6591a1b625f404a3013ea73fb24876fb9e3
-  data.tar.gz: 00eb73580e6160d3932f43110c182832163ab5d3f9db34d44980b831cf4f7fdc
+  metadata.gz: 315c7263eb40e8d6165b96b8f50738ff5861127f35f1ce282f7b1d8a20914290
+  data.tar.gz: 067034c67ce6232de23fe552c1fc3bac50ca64dd898dec9b4958009ce6067fe9
 SHA512:
-  metadata.gz: 887ddce8443a1c17bc4db578a8d6b51d1a81906287db94ccd1f47681f30032cf485e1ed30e1a0feb56cc05b17162fae8f2ce28d07bad4b943a6dce7b40302c40
-  data.tar.gz: 34394be52205690b867bc2402563a9e970fa899250009481ed460f4b4909b8b8f3782bb4c5915d33eaccf6bebf2eebcedf8961628e539af6cde08646517f792f
+  metadata.gz: dfea248252d2b17eca07eb5dae5e7feb4e32ac8673f154f959f0a622221dd466470f0b243f2e8c07191c951897b646c8341e5df3933556361dc1fd831de483a6
+  data.tar.gz: 6585cc65f3bb494161fc18e45d421203278db133b3471747caa8d526da7a551b524a6ba6289320f4a6f7fe80566f6bb7436dadda267d69d96497c7e2f14e64a2

data/CHANGELOG.md

@@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.10.0]
+
+### Added
+- Ability to unsubscribe from specific queues in an application (`Application#unsubscribe_queue`).
+- `rake queuebus:unsubscribe` can now take two parameters to unsubscribe from specific queues, e.g. `rake queuebus:unsubscribe[my_app_key, my_queue_name]`.
+
 ## [0.9.1]
 
 ### Added

data/lib/queue_bus/application.rb

@@ -32,6 +32,7 @@ module QueueBus
 
       ::QueueBus.redis do |redis|
         redis_hash = subscription_list.to_redis
+
         redis_hash.each do |key, hash|
           redis.hset(temp_key, key, QueueBus::Util.encode(hash))
         end
@@ -46,8 +47,17 @@ module QueueBus
       true
     end
 
+    def unsubscribe_queue(queue)
+      # Filters out all subscriptions that match the supplied queue name.
+      ::QueueBus.redis do |redis|
+        read_redis_hash.each do |key, hash_details|
+          redis.hdel(redis_key, key) if queue == hash_details["queue_name"]
+        end
+      end
+    end
+
     def unsubscribe
-      # TODO: clean up known queues?
+      # Remove everything.
       ::QueueBus.redis do |redis|
         redis.srem(self.class.app_list_key, app_key)
         redis.del(redis_key)

data/lib/queue_bus/task_manager.rb

@@ -24,6 +24,13 @@ module QueueBus
       count
     end
 
+    def unsubscribe_queue!(app_key, queue)
+      log "Unsubcribing #{queue} from #{app_key}"
+      app = ::QueueBus::Application.new(app_key)
+      app.unsubscribe_queue(queue)
+      log "  ...done"
+    end
+
     def unsubscribe!
       count = 0
       ::QueueBus.dispatchers.each do |dispatcher|

data/lib/queue_bus/tasks.rb

@@ -12,11 +12,19 @@ namespace :queuebus do
     raise 'No subscriptions created' if count == 0
   end
 
-  desc 'Unsubscribes this application from QueueBus events'
-  task unsubscribe: [:preload] do
+  desc "Unsubscribes this application from QueueBus events"
+  task :unsubscribe, [:app_key, :queue] => [ :preload ] do |task, args|
+    app_key = args[:app_key]
+    queue = args[:queue]
     manager = ::QueueBus::TaskManager.new(true)
-    count = manager.unsubscribe!
-    puts 'No subscriptions unsubscribed' if count == 0
+
+    if app_key && queue
+      manager.unsubscribe_queue!(app_key, queue)
+    else
+      manager = ::QueueBus::TaskManager.new(true)
+      count = manager.unsubscribe!
+      puts "No subscriptions unsubscribed" if count == 0
+    end
   end
 
   desc 'List QueueBus queues that need worked'

data/lib/queue_bus/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module QueueBus
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 end

data/spec/application_spec.rb

@@ -102,16 +102,58 @@ module QueueBus
       end
     end
 
-    describe '#unsubscribe' do
-      it 'should remove items' do
-        QueueBus.redis { |redis| redis.sadd('bus_apps', 'myapp') }
-        QueueBus.redis { |redis| redis.sadd('bus_apps', 'other') }
-        QueueBus.redis { |redis| redis.hset('bus_app:myapp', 'event_one', 'myapp_default') }
+    describe "#unsubscribe" do
+      context "when a queue is not specified" do
+        it "removes all subscriptions" do
+          myapp_list = SubscriptionList.new
+          other_list = SubscriptionList.new
+
+          subscription_1 = Subscription.new("myapp_default", "key1", "MyClass1", {"bus_event_type" => "event_one"})
+          subscription_2 = Subscription.new("myapp_default", "key2", "MyClass2", {"bus_event_type" => "event_two"})
+          subscription_3 = Subscription.new("myapp_other_queue", "key1", "MyClass1", {"bus_event_type" => "event_one"})
+
+          myapp_list.add(subscription_1)
+          myapp_list.add(subscription_2)
+          other_list.add(subscription_3)
+
+          Application.new("myapp").subscribe(myapp_list)
+          Application.new("other").subscribe(other_list)
+
+          expect(QueueBus.redis { |redis| redis.hgetall("bus_app:myapp") }).to eq({
+            "key1" => "{\"queue_name\":\"myapp_default\",\"key\":\"key1\",\"class\":\"MyClass1\",\"matcher\":{\"bus_event_type\":\"event_one\"}}",
+            "key2" => "{\"queue_name\":\"myapp_default\",\"key\":\"key2\",\"class\":\"MyClass2\",\"matcher\":{\"bus_event_type\":\"event_two\"}}"
+          })
+
+          Application.new("myapp").unsubscribe
+
+          expect(QueueBus.redis { |redis| redis.smembers("bus_apps") }).to eq(["other"])
+          expect(QueueBus.redis { |redis| redis.hlen("bus_app:myapp") }).to eq(0)
+          expect(QueueBus.redis { |redis| redis.hlen("bus_app:other") }).to eq(1)
+        end
+      end
 
-        Application.new('myapp').unsubscribe
+      context "when a queue is specified" do
+        it "removes only that key" do
+          list = SubscriptionList.new
 
-        expect(QueueBus.redis { |redis| redis.smembers('bus_apps') }).to eq(['other'])
-        expect(QueueBus.redis { |redis| redis.get('bus_app:myapp') }).to be_nil
+          subscription_1 = Subscription.new("myapp_default", "key1", "MyClass1", {"bus_event_type" => "event_one"})
+          subscription_2 = Subscription.new("myapp_other_queue", "key2", "MyClass2", {"bus_event_type" => "event_two"})
+
+          list.add(subscription_1)
+          list.add(subscription_2)
+
+          Application.new("myapp").subscribe(list)
+
+          expect(QueueBus.redis { |redis| redis.hgetall("bus_app:myapp") }).to eq({
+            "key1" => "{\"queue_name\":\"myapp_default\",\"key\":\"key1\",\"class\":\"MyClass1\",\"matcher\":{\"bus_event_type\":\"event_one\"}}",
+            "key2" => "{\"queue_name\":\"myapp_other_queue\",\"key\":\"key2\",\"class\":\"MyClass2\",\"matcher\":{\"bus_event_type\":\"event_two\"}}"
+          })
+
+          Application.new("myapp").unsubscribe_queue("myapp_default")
+
+          expect(QueueBus.redis { |redis| redis.smembers("bus_apps") }).to eq(["myapp"])
+          expect(QueueBus.redis { |redis| redis.hgetall("bus_app:myapp") }).to eq({"key2" => "{\"queue_name\":\"myapp_other_queue\",\"key\":\"key2\",\"class\":\"MyClass2\",\"matcher\":{\"bus_event_type\":\"event_two\"}}"})
+        end
       end
     end
 

data/spec/subscription_list_spec.rb

@@ -48,5 +48,31 @@ module QueueBus
                            'key2' => { 'queue_name' => 'else_ok', 'key' => 'key2', 'class' => 'MyClass', 'matcher' => { 'bus_event_type' => 'event_two' } })
       end
     end
+
+    context "when modifying the subscription" do
+      let(:list) { SubscriptionList.new }
+      let(:subscription_1) { Subscription.new("default", "key1", "MyClass", {"bus_event_type" => "event_one"}) }
+      let(:subscription_2) { Subscription.new("else_ok", "key2", "MyClass", {"bus_event_type" => "event_two"}) }
+
+      context "when adding subscriptions" do
+        it "adds the subscription successfully" do
+          list.add(subscription_1)
+          list.add(subscription_2)
+
+          expect(list.to_redis).to eq(
+            {
+              "key1" => {"queue_name" => "default", "key" => "key1", "class" => "MyClass", "matcher" => {"bus_event_type" => "event_one"}},
+              "key2" => {"queue_name" => "else_ok", "key" => "key2", "class" => "MyClass", "matcher" => {"bus_event_type" => "event_two"}}
+            }
+          )
+        end
+
+        it "errors if the subscription already exists" do
+          list.add(subscription_1)
+
+          expect { list.add(subscription_1) }.to raise_exception(RuntimeError, /Duplicate key/)
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue-bus
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Brian Leonard
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json