queue-bus 0.11.0 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 139511a2de01b9ffb7e58b63ecf62cbc01ae94fe38896282de2ae0dbb13178de
-  data.tar.gz: 0e481639105b4dceff9991ee448f378923fdb3ae5820294f954602e96a177243
+  metadata.gz: 48a236d7a44dafb099dc3d36e5f34e4a1f065d47fa76b3be1a7465ae8533773b
+  data.tar.gz: c2e6cffeba50ae36e13c8c417f43c7b9f18ff09772c4fd3ffd48e2784a80d5d9
 SHA512:
-  metadata.gz: 3ce3ebbeee0e6be7513af1ed093f5612877a6293a78bad68da502817c10f205ddf69bbc3071ef497f48baef2e66f2823311ef80e579805dbeedccec9b0794bef
-  data.tar.gz: 8b93e84ff4b5d6801d6b490560af46532c729eb7ff2b32b0d88e565bd620388d029f1a010027b9032e56731aef936945922bf7afc642453aeb9db9cbeacd0bcd
+  metadata.gz: 7c3ba54737925161ec4c658864a7badd08f58400e246f31ee31a2aef7a6347005f073f62c2a3874aaf4e64f11a3da7f0a2fff322997e0a99da9b7901079e320a
+  data.tar.gz: 26b7011be9db57d5f2c93f397fda77374f8aa34fa097efc93d3831ce1832a3c1e12913433e507cf2c8e5c1057178e71b08a3fdbcee68fe382597b8bd3828f603

data/CHANGELOG.md

@@ -6,6 +6,33 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.13.2]
+
+### Fixes
+
+- Properly passes the attributes down to the subscription when using `on_heartbeat`
+
+## [0.13.1]
+
+### Fixes
+
+- Allows matching on 0 via the `on_heartbeat` subscription
+
+### Added
+
+- Allows matching on `wday` via the `on_heartbeat` subscription
+
+## [0.13.0]
+
+### Added
+
+- Adds `Dispatch#on_heartbeat` which is a helper function for specifying heartbeat subscriptions.
+
+## [0.12.0]
+
+### Changed
+- Pipelines fetching all queue subscriptions when using `QueueBus::Application.all`
+
 ## [0.11.0]
 
 ### Added

data/README.mdown

@@ -63,6 +63,16 @@ QueueBus.dispatch("app_b") do
   subscribe "my_key", { "user_id" => :present, "page" => "homepage"} do
     Mixpanel.homepage_action!(attributes["action"])
   end
+
+  # You may also declare a subscription to heartbeat events. This is a helper function
+  # that works along with subscribe to make scheduling regular events easier.
+  #
+  #   minute_interval: Executes every n minutes
+  #   hour_interval:   Executes every n hours
+  #   minute:          Executes on this minute
+  #   hour:            Executes on this hour
+  on_heartbeat "my_heartbeat_event", minute_interval: 5 do |attributes|
+  end
 end
 ```
 

data/lib/queue_bus/application.rb

@@ -7,7 +7,22 @@ module QueueBus
     class << self
       def all
         # note the names arent the same as we started with
-        ::QueueBus.redis { |redis| redis.smembers(app_list_key).collect { |val| new(val) } }
+        ::QueueBus.redis do |redis|
+          app_keys = redis.smembers(app_list_key)
+          apps = app_keys.collect { |val| new(val) }
+
+          hashes = redis.pipelined do
+            apps.each do |app|
+              redis.hgetall(app.redis_key)
+            end
+          end
+
+          apps.zip(hashes).each do |app, hash|
+            app._hydrate_redis_hash(hash)
+          end
+
+          apps
+        end
       end
     end
 
@@ -90,6 +105,10 @@ module QueueBus
       out
     end
 
+    def _hydrate_redis_hash(hash)
+      @raw_redis_hash = hash
+    end
+
     protected
 
     def self.normalize(val)
@@ -114,16 +133,24 @@ module QueueBus
 
     def read_redis_hash
       out = {}
-      ::QueueBus.redis do |redis|
-        redis.hgetall(redis_key).each do |key, val|
-          begin
-            out[key] = ::QueueBus::Util.decode(val)
-          rescue ::QueueBus::Util::DecodeException
-            out[key] = val
-          end
+      raw_redis_hash.each do |key, val|
+        begin
+          out[key] = ::QueueBus::Util.decode(val)
+        rescue ::QueueBus::Util::DecodeException
+          out[key] = val
         end
       end
       out
     end
+
+    private
+
+    def raw_redis_hash
+      return @raw_redis_hash if @raw_redis_hash
+
+      ::QueueBus.redis do |redis|
+        redis.hgetall(redis_key)
+      end
+    end
   end
 end

data/lib/queue_bus/dispatch.rb

@@ -16,6 +16,45 @@ module QueueBus
       @subscriptions.size
     end
 
+    def on_heartbeat(key, minute: nil, hour: nil, wday: nil, minute_interval: nil, hour_interval: nil, &block) # rubocop:disable Metrics/PerceivedComplexity, Metrics/MethodLength, Metrics/ParameterLists, Metrics/CyclomaticComplexity, Metrics/AbcSize, Metrics/LineLength
+      if minute_interval && !minute_interval.positive?
+        raise ArgumentError, 'minute_interval must be a positive integer'
+      end
+
+      if hour_interval && !hour_interval.positive?
+        raise ArgumentError, 'hour_interval must be a positive integer'
+      end
+
+      matcher = { bus_event_type: :heartbeat_minutes }
+
+      if minute
+        raise ArgumentError, 'minute must not be negative' if minute.negative?
+
+        matcher['minute'] = minute
+      end
+
+      if hour
+        raise ArgumentError, 'hour must not be negative' if hour.negative?
+
+        matcher['hour'] = hour
+      end
+
+      if wday
+        raise ArgumentError, 'wday must not be negative' if wday.negative?
+
+        matcher['wday'] = wday
+      end
+
+      subscribe(key, matcher) do |event|
+        if (minute_interval.nil? || (event['minute'] % minute_interval).zero?) &&
+           (hour_interval.nil? || (event['hour'] % hour_interval).zero?)
+
+          # Yield the block passed in.
+          block.call(event)
+        end
+      end
+    end
+
     def subscribe(key, matcher_hash = nil, &block)
       dispatch_event('default', key, matcher_hash, block)
     end

data/lib/queue_bus/version.rb

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

data/spec/dispatch_spec.rb

@@ -28,6 +28,160 @@ module QueueBus
       end.not_to raise_error
     end
 
+    describe '#on_heartbeat' do
+      let(:dispatch) { Dispatch.new('heartbeat') }
+      let(:event) { { bus_event_type: :heartbeat_minutes } }
+      let(:event_name) { 'my-event' }
+
+      it 'passes on the event' do
+        dispatch.on_heartbeat event_name do |event|
+          expect(event).to match hash_including('hour' => 1, 'minute' => 0)
+        end
+
+        dispatch.execute(event_name, 'hour' => 1, 'minute' => 0)
+      end
+
+      context 'when not declaring anything' do
+        before do
+          dispatch.on_heartbeat event_name do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs on every heart beat' do
+          (0..24).each do |hour|
+            (0..60).each do |minute|
+              expect do
+                dispatch.execute(
+                  event_name, event.merge('hour' => hour, 'minute' => minute)
+                )
+              end.to change(Runner2, :value).by(1)
+            end
+          end
+        end
+      end
+
+      context 'when running on hour 8' do
+        before do
+          dispatch.on_heartbeat event_name, hour: 8 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to hour 8' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'hour' => '8')
+        end
+      end
+
+      context 'when running on minute 4' do
+        before do
+          dispatch.on_heartbeat event_name, minute: 4 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to minute 4' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'minute' => '4')
+        end
+      end
+
+      context 'when running on minute 4 and hour 8' do
+        before do
+          dispatch.on_heartbeat event_name, hour: 8, minute: 4 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to minute 4 and hour 8' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'minute' => '4', 'hour' => '8')
+        end
+      end
+
+      context 'when running on wday 2' do
+        before do
+          dispatch.on_heartbeat event_name, wday: 2 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'subscribes to wday 2' do
+          expect(dispatch.subscriptions.all.first.matcher.filters)
+            .to eq('bus_event_type' => 'heartbeat_minutes', 'wday' => '2')
+        end
+      end
+
+      context 'when declaring minute intervals' do
+        before do
+          dispatch.on_heartbeat event_name, minute_interval: 5 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs the runner when the minute buzzes (modulos to 5)' do
+          (0..60).each do |minute|
+            if minute % 5 == 0
+              expect { dispatch.execute(event_name, event.merge('minute' => minute)) }
+                .to change(Runner2, :value).by(1)
+            else
+              expect { dispatch.execute(event_name, event.merge('minute' => minute)) }
+                .not_to change(Runner2, :value)
+            end
+          end
+        end
+      end
+
+      context 'when declaring hour intervals' do
+        before do
+          dispatch.on_heartbeat event_name, hour_interval: 3 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs the runner when the hour fizzes (modulos to 3)' do
+          (0..60).each do |hour|
+            if hour % 3 == 0
+              expect { dispatch.execute(event_name, event.merge('hour' => hour)) }
+                .to change(Runner2, :value).by(1)
+            else
+              expect { dispatch.execute(event_name, event.merge('hour' => hour)) }
+                .not_to change(Runner2, :value)
+            end
+          end
+        end
+      end
+
+      context 'when declaring hour and minute intervals' do
+        before do
+          dispatch.on_heartbeat event_name, minute_interval: 5, hour_interval: 3 do |_event|
+            Runner2.run({})
+          end
+        end
+
+        it 'runs the runner when the time fizzbuzzes (modulos to 3 and 5)' do
+          (0..24).each do |hour|
+            (0..60).each do |minute|
+              if hour % 3 == 0 && minute % 5 == 0
+                expect do
+                  dispatch.execute(
+                    event_name, event.merge('hour' => hour, 'minute' => minute)
+                  )
+                end.to change(Runner2, :value).by(1)
+              else
+                expect do
+                  dispatch.execute(
+                    event_name, event.merge('hour' => hour, 'minute' => minute)
+                  )
+                end.not_to change(Runner2, :value)
+              end
+            end
+          end
+        end
+      end
+    end
+
     describe 'Top Level' do
       before(:each) do
         QueueBus.dispatch('testit') do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: queue-bus
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.13.2
 platform: ruby
 authors:
 - Brian Leonard
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-16 00:00:00.000000000 Z
+date: 2021-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -159,7 +159,7 @@ files:
 homepage: ''
 licenses: []
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -174,9 +174,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: queue-bus
-rubygems_version: 2.7.6.2
-signing_key:
+rubygems_version: 3.0.3
+signing_key: 
 specification_version: 4
 summary: A simple event bus on top of background queues
 test_files: