nuntius 1.3.7 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9b687606f90025f60156f83577dbc1b9d4d2edecdc70f84e497141ff37476965
-  data.tar.gz: 8f17f799c7d5c991bb8141cb29dd0e026651dc24993ab67e1fe5ed77f47aebfd
+  metadata.gz: af9d9733e3d00160f1bc577fcfebcf92ce187f5ec1c24f0275234db388c73a6e
+  data.tar.gz: fedc019067d2fa07b1d870efc98c37201b38994246f2458a8d6fa9b42f54f0c9
 SHA512:
-  metadata.gz: 27c5d73a3fc860ecb126e2967f75c8d985faf47af0900d59b704be4cf8a00821525344570e1bd611d92fa3ea33689ed1d0420c6edc46d9d69fa2aae58b3b605a
-  data.tar.gz: 1152e80c5e52d47adc53ac5519e328852874495534daf54b4e96491acd911bbdba9e0001f61b30a1491506432b3accd0bf49971487709ee36240d525c2a5026e
+  metadata.gz: 3df6eee0f723825cdbfa9d6b32ed96e5f51eb95169022138f0dd51cd1ae930eb3e6855ae8cb3c2d958d9720ac5edae2868c12693107bff7b7ebda893665e7c72
+  data.tar.gz: ac2e65dad9eba341791de05f4f921b4568924c8fc5e14d2b832c114cb8625e19868a29b60ac9414ba698a93595349fc0630f39b2ebedf59ccdc0dba39226efaf

data/README.md

@@ -55,7 +55,7 @@ class Car < ApplicationRecord
 end
 ```
 
-Additionally you need to define an extension of the Nuntius::BaseMessenger for the same model with a matching name (in app/messengers):
+Additionally you need to define an extension of the Nuntius::BaseMessenger for the same model with a matching name (in app/messengers). Messengers can set extra parameters, but also manipulate templates selected.
 
 ```ruby
 class CarMessenger < Nuntius::BaseMessenger
@@ -105,6 +105,11 @@ timebased_scope class method like so:
 class CarMessenger < Nuntius::BaseMessenger
   # time_range is a range, for a before scope the time_range the interval is added to the current
   # time, the end of the range is 1 hour from the start.
+  # 
+  # So say the interval is "10 days", the timerange will be: 
+  # from: today +  10 days - 1 hour 
+  # until: today + 10 days
+  # So it basically selects all Car's with a tuneup_at within 10 days from now (in a 1 hour window)
   timebased_scope :before_tuneup do |time_range, metadata|
     cars = Car.where(tuneup_at: time_range)
     cars = cars.where(color: metadata['color']) if metadata['color'].present?
@@ -113,6 +118,11 @@ class CarMessenger < Nuntius::BaseMessenger
 
   # For an after scope the time_range the interval is taken from the current time, the end of the
   # range is 1 hour from its start.
+  #
+  # So say the interval is "10 days", the timerange will be: 
+  # from: today -  10 days - 1 hour 
+  # until: today - 10 days
+  # So it basically selects all Car's with a tuneup_at 10 days since now (in a 1 hour window)
   timebased_scope :after_tuneup do |time_range, metadata|
     cars = Car.where(tuneup_at: time_range)
     cars = cars.where(color: metadata['color']) if metadata['color'].present?
@@ -131,8 +141,9 @@ following formats:
 - N week(s)
 - N month(s)
 
-To send timebased messages you need to execute Nuntius::TimestampBasedMessagesRunner.call, you could do this
-in a cronjob every 5 minutes with "bundle exec rails runner Nuntius::TimestampBasedMessagesRunner.call"
+To send timebased messages you need to execute Nuntius::TimebasedEventsJob.perform, you could do this
+in a cronjob every 5 minutes with "bundle exec rails runner 'Nuntius::TimebasedEventsJob.perform'".
+Beter even is using Sidekiq::Cron or GoodJob
 
 ### Direct
 

data/app/{runners/nuntius/timebased_events_runner.rb → jobs/nuntius/timebased_events_job.rb}

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Nuntius
-  class TimebasedEventsRunner < ApplicationRunner
+  class TimebasedEventsJob < ApplicationJob
     def perform
       Nuntius::Template.where.not(interval: nil).each do |template|
         messenger = Nuntius::BaseMessenger.messenger_for_class(template.klass)

data/app/messengers/nuntius/base_messenger.rb

@@ -9,7 +9,8 @@ module Nuntius
 
     define_callbacks :action, terminator: ->(_target, result_lambda) { result_lambda.call == false }
 
-    attr_reader :templates, :attachments, :event, :object, :params
+    attr_reader :attachments, :event, :object, :params
+    attr_accessor :templates
 
     def initialize(object, event, params = {})
       @object = object

data/app/presenters/template_presenter.rb

@@ -9,7 +9,7 @@ class TemplatePresenter < ApplicationPresenter
       messenger = Nuntius::BaseMessenger.messenger_for_class(class_name)
       messenger.instance_methods(false).each do |m|
         events << [m, m, {"data-chain": class_name,
-                          "data-timebased": messenger.timebased_scopes.include?(m)}]
+                          "data-timebased": messenger.timebased_scopes.include?(m) ? "Y" : "N"}]
       end
     end
     events.sort_by(&:first)

data/app/views/nuntius/admin/templates/edit.html.slim

@@ -21,12 +21,12 @@
           .col-span-6 data-toggle-target="insertion"
 
           template data-toggle-target='toggleable' data-toggle-not-value='Custom'
-            .col-span-6.deze data-controller='toggle' data-toggle-attr='data-timebased'
+            .col-span-6 data-controller='toggle' data-toggle-attr='data-timebased'
               .grid.grid-cols-12.gap-4
                 .col-span-6
                   = f.input :event, collection: template.all_events, include_blank: false, chain_to: 'template[klass]', input_html: { data: { 'toggle-target' => 'input' } }, as: :dropdown
                 .col-span-6 data-toggle-target="insertion"
-              template data-toggle-target='toggleable' data-toggle-value='true'
+              template data-toggle-target='toggleable' data-toggle-value='Y'
                 = f.input :interval
 
           template data-toggle-target='toggleable' data-toggle-value='Custom'

data/lib/nuntius/configuration.rb

@@ -41,7 +41,6 @@ module Nuntius
     option :logger, default: -> { Rails.logger }, proc: true
     option :admin_authentication_module, default: "Auxilium::Concerns::AdminAuthenticated"
     option :base_controller, default: "::ApplicationController"
-    option :base_runner, default: "Nuntius::BasicApplicationRunner"
     option :layout, default: "application"
     option :admin_layout, default: "application"
     option :jobs_queue_name, default: "message"

data/lib/nuntius/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nuntius
-  VERSION = "1.3.7"
+  VERSION = "1.3.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nuntius
 version: !ruby/object:Gem::Version
-  version: 1.3.7
+  version: 1.3.8
 platform: ruby
 authors:
 - Tom de Grunt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-27 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apnotic
@@ -459,6 +459,7 @@ files:
 - app/jobs/nuntius/messenger_job.rb
 - app/jobs/nuntius/purge_message_job.rb
 - app/jobs/nuntius/retrieve_mail_job.rb
+- app/jobs/nuntius/timebased_events_job.rb
 - app/jobs/nuntius/transport_delivery_job.rb
 - app/jobs/nuntius/transport_refresh_job.rb
 - app/message_boxes/nuntius/base_message_box.rb
@@ -488,9 +489,6 @@ files:
 - app/providers/nuntius/teams_teams_provider.rb
 - app/providers/nuntius/twilio_sms_provider.rb
 - app/providers/nuntius/twilio_voice_provider.rb
-- app/runners/nuntius/application_runner.rb
-- app/runners/nuntius/basic_application_runner.rb
-- app/runners/nuntius/timebased_events_runner.rb
 - app/services/nuntius/application_service.rb
 - app/services/nuntius/aws_sns_processor_service.rb
 - app/services/nuntius/deliver_campaign_service.rb

data/app/runners/nuntius/application_runner.rb

@@ -1,6 +0,0 @@
-# frozen_string_literal: true
-
-module Nuntius
-  class ApplicationRunner < Nuntius.config.base_runner.constantize
-  end
-end

data/app/runners/nuntius/basic_application_runner.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-module Nuntius
-  # This is the default runner used for runners in Nuntius, you can insert your
-  # own in the Nuntius configuration in your Rails Nuntius initializer.
-  class BasicApplicationRunner
-    def call
-      perform
-    end
-
-    class << self
-      delegate :call, to: :new
-    end
-  end
-end