nuntius 1.3.6 → 1.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11b30e0625c1b47a70a22803a0bdec45d92faf881b1e83ae72e00582d95b36f4
-  data.tar.gz: ec9251af770d4b3cd4ae58b75968bddc4e4917dc1ba01d8073eb73df56c9fe4e
+  metadata.gz: af9d9733e3d00160f1bc577fcfebcf92ce187f5ec1c24f0275234db388c73a6e
+  data.tar.gz: fedc019067d2fa07b1d870efc98c37201b38994246f2458a8d6fa9b42f54f0c9
 SHA512:
-  metadata.gz: a8dd4831dcbb7c4e8440e4a1ebf281a712959de7a47323e2590a24d71bf039c5a7c7b5899e3427832949a061f1bed2ac72b3f70acdc86b534aafe16f7d364689
-  data.tar.gz: 1c5e6ad9964622533dad4c91df0ff7bcdf05299bbaddcdf81efcfee6eeea02f9b50bc7ad662b174e8433e422d040dda57b8e9f627fd2c8360cc27575653735c8
+  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
 
@@ -165,6 +176,8 @@ The main key of the hash passed will also be the liquid variable.
 
 Outbound mail is handled through SMTP. We've only exposed the HTML of mail, we can create text-versions based on sanitized HTML. HTML allows for [Foundation for Emails](https://get.foundation/emails/docs/index.html). You will have to include the CSS in the layouts.
 
+In the layout you can add `<a href="{{message_url}}">Link to mail</a>` to provide a link to the online version of the message.
+
 #### AWS SES
 
 In case you use AWS SES, you can use the SNS Feedback Notifications to automatically mark messages as read, or deal with complaints and bounces. Create a AWS SNS topic, with a HTTPS subscription with the following URL (pattern):

data/app/controllers/nuntius/admin/campaigns_controller.rb

@@ -51,7 +51,7 @@ module Nuntius
       def campaign_params
         return unless params[:campaign]
 
-        params.require(:campaign).permit(:name, :transport, :layout_id, :list_id, :from, :subject, :text, :html)
+        params.require(:campaign).permit(:name, :transport, :layout_id, :list_id, :from, :subject, :text, :html, :metadata_yaml)
       end
     end
   end

data/app/controllers/nuntius/admin/layouts_controller.rb

@@ -31,6 +31,11 @@ module Nuntius
       def update
         @layout = Nuntius::Layout.visible.find(params[:id])
         @layout.update(layout_params)
+        if params[:layout][:attachments].present?
+          params[:layout][:attachments].each do |attachment|
+            @layout.attachments.attach(attachment)
+          end
+        end
         respond_with :admin, @layout
       end
 
@@ -44,7 +49,6 @@ module Nuntius
 
       def layout_params
         permitted = %i[name data metadata_yaml]
-        permitted += [attachments: []] if params[:layout][:attachments].compact_blank.present?
         params.require(:layout).permit(permitted)
       end
     end

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/models/nuntius/campaign.rb

@@ -3,6 +3,9 @@
 module Nuntius
   class Campaign < ApplicationRecord
     include Nuntius::Concerns::MetadataScoped
+    include Nuntius::Concerns::Yamlify
+
+    yamlify :metadata
 
     belongs_to :list
     accepts_nested_attributes_for :list, reject_if: :all_blank

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/providers/nuntius/smtp_mail_provider.rb

@@ -45,7 +45,7 @@ module Nuntius
           charset: "UTF-8"
         )
         if message.html.present?
-          message.html = message.html.gsub("%7B%7Bmessage_url%7D%7D") { message_url(message) }
+          message.html = message.html.gsub("{{message_url}}") { message_url(message) }
           p.html_part = Mail::Part.new(
             body: message.html,
             content_type: "text/html",
@@ -84,7 +84,7 @@ module Nuntius
     private
 
     def message_url(message)
-      Nuntius::Engine.routes.url_helpers.message_url(message.id, host: Nuntius.config.host.call(message))
+      Nuntius::Engine.routes.url_helpers.message_url(message.id, host: Nuntius.config.host(message))
     end
   end
 end

data/app/services/nuntius/deliver_campaign_service.rb

@@ -11,7 +11,7 @@ module Nuntius
 
     def perform
       deliver
-      campaign.sent!
+      # campaign.sent!
     end
 
     def deliver
@@ -22,6 +22,7 @@ module Nuntius
     end
 
     def new_message(subscriber, assigns = {})
+      assigns["campaign"] = context.campaign
       assigns["subscriber"] = subscriber
       if subscriber.nuntiable
         name = Nuntius::BaseMessenger.liquid_variable_name_for(subscriber.nuntiable)
@@ -29,8 +30,11 @@ module Nuntius
       end
       message = Nuntius::Message.new(transport: campaign.transport, campaign: campaign, nuntiable: subscriber.nuntiable, metadata: campaign.metadata)
 
-      locale_proc = Nuntius::BaseMessenger.messenger_for_obj(subscriber.nuntiable).locale
-      locale = instance_exec(subscriber.nuntiable, &locale_proc) if subscriber.nuntiable && locale_proc
+      locale = nil
+      if subscriber.nuntiable
+        locale_proc = Nuntius::BaseMessenger.messenger_for_obj(subscriber.nuntiable).locale
+        locale = instance_exec(subscriber.nuntiable, &locale_proc) if locale_proc
+      end
 
       message.from = render(:from, assigns, locale)
       message.to = case campaign.transport

data/app/tables/nuntius/campaign_messages_table.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class CampaignMessagesTable < Nuntius::ApplicationTable
+    definition do
+      model Nuntius::Message
+
+      column(:to)
+      column(:status)
+      column(:created_at)
+
+      order created_at: :desc
+
+      link { |message| nuntius.admin_message_path(message) }
+    end
+
+    private
+
+    def scope
+      @scope = Nuntius::Campaign.find_by(params[:campaign_id]).messages
+      @scope
+    end
+  end
+end

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

@@ -27,21 +27,13 @@
           .col-span-12
             = f.input :subject
           .col-span-12
-            = f.input :html, as: :hidden
-            trix-editor input="campaign_html" style="background-color: #fff; height: 400px; margin-bottom: 20px;"
+            = f.rich_text :html
+          .col-span-12
+            = f.input :metadata_yaml, as: :editor, mode: 'application/yaml', label: t('.metadata')
 
         template data-toggle-target='toggleable' data-toggle-value='voice'
           .col-span-12
             = f.input :text, as: :editor, mode: 'text/plain'
 - else
-  = sts.card :nuntius_admin_campaigns, title: @campaign.name, description: 'We are sending this campaign, you can no longer make any changes.', icon: 'fal fa-megaphone', content_padding: false do |card|
-    table.table
-      thead
-        tr
-          th Status
-          th To
-      tbody
-        - for message in @messages
-          tr
-            td = link_to message.status, admin_message_path(message)
-            td = message.to
+  = sts.card :nuntius_admin_campaigns, title: @campaign.name, description: 'We are sending or have sent this campaign, you can no longer make any changes.', icon: 'fal fa-megaphone', content_padding: false do |card|
+    = sts.table :"nuntius/campaign_messages", params: { campaign_id: @campaign.id }

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

@@ -32,10 +32,11 @@
                 = (attachment.blob.byte_size / 1048576.0).round(2)
                 ' MB
                 = link_to admin_layout_attachment_path(@layout, attachment.id), data: { controller: 'attachment-delete', 'action': 'attachment-delete#delete' } do
-                    i.fal.fa-xmark
+                    i.fas.fa-xmark
                 =< link_to(main_app.rails_blob_path(attachment, disposition: 'attachment'),
                       title: attachment.filename)
-                    i.fal.fa-download
+                    i.fas.fa-download
+                code.text-xs = sts.copyable main_app.rails_blob_url(attachment)
 
     - if @layout.templates.exists?
       - card.with_tab :templates, padding: false

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/config/locales/en.yml

@@ -55,6 +55,7 @@ en:
           card:
             nuntius_admin_campaigns:
               title: Campaigns
+          metadata: Metadata
         index:
           card:
             nuntius_admin_campaigns:

data/config/locales/nl.yml

@@ -55,6 +55,7 @@ nl:
           card:
             nuntius_admin_campaigns:
               title: Campagne
+          metadata: Metadata
         index:
           card:
             nuntius_admin_campaigns:

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.6"
+  VERSION = "1.3.8"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nuntius
 version: !ruby/object:Gem::Version
-  version: 1.3.6
+  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,15 +489,13 @@ 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
 - app/services/nuntius/deliver_inbound_message_service.rb
 - app/services/nuntius/retrieve_inbound_mail_service.rb
 - app/tables/nuntius/application_table.rb
+- app/tables/nuntius/campaign_messages_table.rb
 - app/tables/nuntius/campaigns_table.rb
 - app/tables/nuntius/layouts_table.rb
 - app/tables/nuntius/lists_table.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