effective_messaging 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d5586319e69df10977387b8dde4f21c28b6c091ba2d013c0aa92356c5d64612
-  data.tar.gz: 30780a50e3482bf8f66492f9b965f3dba832c2ccfd237753517214536484bc6c
+  metadata.gz: 473c0318cc028c7e4eced72d90d9f257af48060615ab9368e267aefeb8912923
+  data.tar.gz: b113796bf1d6eb615d732817bfd1b773a7341255774b90fc4bc1a48d4074a3a1
 SHA512:
-  metadata.gz: 984b176a01cb8fb1e6935975f20fba184e0c4af16783faef38c6372dc76b85a9735b0b8d87723564026a22add1426c1a78b2c0d14c25f906d4b76470119a612e
-  data.tar.gz: 159df93437962685676e463ad350f91326de8d87efd440027b1da1e8f1b6061552a8d1bf307cdc8ba9fedc9faaf87574754421a2d3794a63410f7caf5518a27d
+  metadata.gz: 130940194d693e5dab80793b47a54ae2614f6e8df8ba80d986e20ac35fdd0071a017365807a076ad5ebf2f2e176582b6aa4eb5981fb1a8b0a491497bd062dc1f
+  data.tar.gz: '0356873babc77f9124b8164d179fe7852d19a70eb8e4a8fbf5e9966f017c71b69bd9588b61adcdc1b2784f38df6590f202636af690ccf17b71436e6f889118dc'

data/app/datatables/admin/effective_notification_logs_datatable.rb

@@ -9,7 +9,7 @@ module Admin
       col :notification
       col :report, visible: !attributes[:inline]
       col :resource, search: :string
-      col :user, search: :string
+      col :user, label: 'Source', search: :string
       col :email
       col :skipped
 

data/app/helpers/effective_messaging_helper.rb

@@ -1,3 +1,2 @@
 module EffectiveMessagingHelper
-
 end

data/app/mailers/effective/notifications_mailer.rb

@@ -1,63 +1,36 @@
 module Effective
   class NotificationsMailer < EffectiveMessaging.parent_mailer_class
     include EffectiveMailer
+    include EffectiveEmailTemplatesMailer
 
-    # This is not an EffectiveEmailTemplatesMailer
-
-    def notify(notification, opts = {})
+    def notification(notification, resource = nil, opts = {})
       raise('expected an Effective::Notification') unless notification.kind_of?(Effective::Notification)
 
-      # Returns a Hash of params to pass to mail()
-      # Includes a :to, :from, :subject and :body, etc
-      rendered = notification.assign_renderer(view_context).render_email
+      @assigns = assigns_for(notification, resource)
+
+      # Find the TO email address for this resource
+      to = notification.to_email(resource)
+      raise('expected a to email address') unless to.present?
 
       # Attach report
       attach_report!(notification)
-      rendered.delete(:content_type) if notification.attach_report?
-
-      # Works with effective_logging to associate this email with the notification
-      headers = headers_for(notification, opts)
+      opts.delete(:content_type) if notification.attach_report?
 
       # Use postmark broadcast-stream
       if defined?(Postmark)
-        headers.merge!(message_stream: 'broadcast-stream') 
-        attach_unsubscribe_link!(rendered)
+        opts.merge!(message_stream: 'broadcast-stream') 
+        append_unsubscribe_link!(notification, opts)
       end
 
-      # Calls effective_resources subject proc, so we can prepend [LETTERS]
-      subject = subject_for(__method__, rendered.fetch(:subject), notification, opts)
-
-      # Pass everything to mail
-      mail(rendered.merge(headers).merge(subject: subject))
+      mail(to: to, **headers_for(resource, opts))
     end
 
-    # Does not use effective_email_templates mailer
-    def notify_resource(notification, resource, opts = {})
-      raise('expected an Effective::Notification') unless notification.kind_of?(Effective::Notification)
-      raise('expected an acts_as_reportable resource') unless resource.class.try(:acts_as_reportable?)
-
-      # Returns a Hash of params to pass to mail()
-      # Includes a :to, :from, :subject and :body
-      rendered = notification.assign_renderer(view_context).render_email(resource)
-
-      # Works with effective_logging to associate this email with the notification
-      headers = headers_for(notification, opts)
-
-      # Use postmark broadcast-stream
-      if defined?(Postmark)
-        headers.merge!(message_stream: 'broadcast-stream') 
-        attach_unsubscribe_link!(rendered)
-      end
-
-      # Calls effective_resources subject proc, so we can prepend [LETTERS]
-      subject = subject_for(__method__, rendered.fetch(:subject), resource, opts)
+    private
 
-      # Pass everything to mail
-      mail(rendered.merge(headers).merge(subject: subject))
+    def assigns_for(notification, resource)
+      notification.assign_renderer(view_context).assigns_for(resource)
     end
 
-    private
-
     def attach_report!(notification)
       return unless notification.attach_report?
       raise("expected a scheduled email notification") unless notification.scheduled_email?
@@ -74,9 +47,9 @@ module Effective
       }
     end
 
-    def attach_unsubscribe_link!(rendered)
-      raise('expected a Hash') unless rendered.kind_of?(Hash)
-      raise('expected a Hash with a :body') unless rendered.key?(:body)
+    def append_unsubscribe_link!(notification, opts)
+      raise('expected a Hash') unless opts.kind_of?(Hash)
+      raise('expected a Hash with a :body') unless opts.key?(:body)
 
       name = EffectiveResources.et('acronym')
       url = view_context.root_url
@@ -87,10 +60,13 @@ module Effective
         "Please understand that unsubscribing means you will no longer receive mandatory messages and announcements."
       ].join(" ")
 
-      # Attach unsubscribe link
-      rendered[:body] = "#{rendered[:body]}\r\n\r\n#{unsubscribe}"
+      if notification.email_notification_html?
+        opts.merge!(body: "#{opts[:body]}\r\n<br/><p>#{unsubscribe}</p>")
+      else
+        opts.merge!(body: "#{opts[:body]}\r\n\r\n#{unsubscribe}")
+      end
 
-      rendered
+      true
     end
 
     def mailer_settings

data/app/models/effective/notification.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# This could be called ReportNotification. It only sends notifications for effective_reports right now.
+
 module Effective
   class Notification < ActiveRecord::Base
     self.table_name = (EffectiveMessaging.notifications_table_name || :notifications).to_s
@@ -8,6 +10,7 @@ module Effective
     attr_accessor :current_resource
     attr_accessor :view_context
 
+    acts_as_email_notification # effective_resources
     log_changes if respond_to?(:log_changes)
 
     # Unused. If we want to use notifications in a has_many way
@@ -17,7 +20,7 @@ module Effective
     belongs_to :user, polymorphic: true, optional: true
 
     # Effective namespace
-    belongs_to :report, class_name: 'Effective::Report', optional: true
+    belongs_to :report, class_name: 'Effective::Report'
 
     # Tracks the send outs
     has_many :notification_logs, dependent: :delete_all
@@ -65,6 +68,7 @@ module Effective
       from              :string
       cc                :string
       bcc               :string
+      content_type      :string
 
       # Background tracking
       last_notified_at      :datetime
@@ -108,7 +112,7 @@ module Effective
     end
 
     validate(if: -> { immediate? && immediate_days.present? && immediate_times.present? }) do
-      self.errors.add(:immediate_times, "must be 1 when when using every 0 days") if immediate_days == 0 && immediate_times != 1
+      errors.add(:immediate_times, "must be 1 when when using every 0 days") if immediate_days == 0 && immediate_times != 1
     end
 
     # Scheduled
@@ -125,28 +129,8 @@ module Effective
       end
     end
 
-    # Email
-    validates :from, presence: true, email: true
-    validates :subject, presence: true, liquid: true
-    validates :body, presence: true, liquid: true
-
-    # Report
-    validates :report, presence: true
-
     validate(if: -> { report.present? }) do
-      errors.add(:report, 'must include an email or user column') unless report.email_report_column || report.user_report_column
-    end
-
-    validate(if: -> { report.present? && subject.present? }) do
-      if(invalid = template_variables(body: false) - report_variables).present?
-        errors.add(:subject, "Invalid variable: #{invalid.to_sentence}")
-      end
-    end
-
-    validate(if: -> { report.present? && body.present? }) do
-      if(invalid = template_variables(subject: false) - report_variables).present?
-        errors.add(:body, "Invalid variable: #{invalid.to_sentence}")
-      end
+      errors.add(:report, 'must include an email, user, organization or owner column') unless report.email_report_column || report.emailable_report_column
     end
 
     def to_s
@@ -195,15 +179,11 @@ module Effective
       Array(self[:scheduled_dates]) - [nil, '']
     end
 
-    def template_subject
-      Liquid::Template.parse(subject)
-    end
-
-    def template_body
-      Liquid::Template.parse(body)
+    def email_template
+      :notification # We always use this email template
     end
 
-    def report_variables
+    def email_template_variables
       assigns_for().keys
     end
 
@@ -272,6 +252,20 @@ module Effective
       scheduled_email? ? notify_by_schedule!(force: force) : notify_by_resources!(force: force)
     end
 
+    # Returns a message. Do not call deliver.
+    def preview
+      return unless report.present?
+
+      if audience_emails?
+        # notify_by_schedule
+        Effective::NotificationsMailer.notification(self, nil, email_notification_params) 
+      else
+        # notify_by_resources
+        resource = report.collection.order('RANDOM()').first
+        Effective::NotificationsMailer.notification(self, resource, email_notification_params) if resource
+      end
+    end
+
     # Operates on every resource in the data source. Sends one email for each row
     def notify_by_resources!(force: false)
       notified = 0
@@ -280,7 +274,7 @@ module Effective
         next unless notifiable?(resource) || force
 
         # Send Now functionality. Don't duplicate if it's same day.
-        next if force && already_notified_today?(resource)
+        next if already_notified_today?(resource) && !force
 
         print('.')
 
@@ -289,7 +283,7 @@ module Effective
           assign_attributes(current_resource: resource)
 
           # Send the resource email
-          Effective::NotificationsMailer.notify_resource(self, resource).deliver_now
+          Effective::NotificationsMailer.notification(self, resource, email_notification_params).deliver_now
 
           # Log that it was sent
           build_notification_log(resource: resource).save!
@@ -299,6 +293,7 @@ module Effective
         rescue => e
           EffectiveLogger.error(e.message, associated: self) if defined?(EffectiveLogger)
           ExceptionNotifier.notify_exception(e, data: { notification_id: id, resource_id: resource.id, resource_type: resource.class.name }) if defined?(ExceptionNotifier)
+          raise(e) if Rails.env.test? || Rails.env.development?
         end
 
         GC.start if (notified % 250) == 0
@@ -312,7 +307,7 @@ module Effective
 
       if notifiable_scheduled? || force
         begin
-          Effective::NotificationsMailer.notify(self).deliver_now
+          Effective::NotificationsMailer.notification(self, nil, email_notification_params).deliver_now
 
           # Log that it was sent
           build_notification_log(resource: nil).save!
@@ -322,6 +317,7 @@ module Effective
         rescue => e
           EffectiveLogger.error(e.message, associated: self) if defined?(EffectiveLogger)
           ExceptionNotifier.notify_exception(e, data: { notification_id: id }) if defined?(ExceptionNotifier)
+          raise(e) if Rails.env.test? || Rails.env.development?
         end
 
       end
@@ -347,7 +343,7 @@ module Effective
     end
 
     def already_notified_today?(resource)
-      email = resource_email(resource) || resource_user(resource).try(:email)
+      email = resource_emails_to_s(resource)
       raise("expected an email for #{report} #{report&.id} and #{resource} #{resource&.id}") unless email.present?
 
       logs = notification_logs.select { |log| log.email == email }
@@ -362,7 +358,7 @@ module Effective
     def notifiable_immediate?(resource:, date: nil)
       raise('expected an immediate? notification') unless immediate?
 
-      email = resource_email(resource) || resource_user(resource).try(:email)
+      email = resource_emails_to_s(resource)
       raise("expected an email for #{report} #{report&.id} and #{resource} #{resource&.id}") unless email.present?
 
       logs = notification_logs.select { |log| log.email == email }
@@ -391,31 +387,11 @@ module Effective
       end
     end
 
-    def render_email(resource = nil)
-      raise('expected an acts_as_reportable resource') if resource.present? && !resource.class.try(:acts_as_reportable?)
-
-      to = if audience == 'emails'
-        audience_emails.presence
-      elsif audience == 'report'
-        resource_email(resource) || resource_user(resource).try(:email)
-      end
-
-      raise('expected a to email address') unless to.present?
-
-      assigns = assigns_for(resource)
-
-      {
-        to: to,
-        from: from,
-        cc: cc.presence,
-        bcc: bcc.presence,
-        content_type: CONTENT_TYPES.first,
-        subject: template_subject.render(assigns),
-        body: template_body.render(assigns)
-      }.compact
+    def to_email(resource)
+      audience == 'emails' ? audience_emails.presence : resource_emails_to_s(resource)
     end
 
-    # We pull the Assigns from 3 places:
+    # We pull the Assigns from 2 places:
     # 1. The report.report_columns
     # 2. The class's def reportable_view_assigns(view) method
     def assigns_for(resource = nil)
@@ -432,42 +408,47 @@ module Effective
       reportable_view_assigns = resource.reportable_view_assigns(renderer).deep_stringify_keys
       raise('expected notification assigns to return a Hash') unless reportable_view_assigns.kind_of?(Hash)
 
-      # Merge all 3
+      # Merge all assigns
       report_assigns.merge(reportable_view_assigns)
     end
 
     def build_notification_log(resource: nil, skipped: false)
-      user = resource_user(resource)
+      emailable = resource_emailable(resource)
 
-      email = resource_email(resource) || user.try(:email)
+      email = resource_emails_to_s(resource)
       email ||= audience_emails_to_s if scheduled_email?
 
-      notification_logs.build(email: email, report: report, resource: resource, user: user, skipped: skipped)
+      notification_logs.build(email: email, report: report, resource: resource, user: emailable, skipped: skipped)
     end
 
     private
 
-    def template_variables(body: true, subject: true)
-      [(template_body.presence if body), (template_subject.presence if subject)].compact.map do |template|
-        Liquid::ParseTreeVisitor.for(template.root).add_callback_for(Liquid::VariableLookup) do |node|
-          [node.name, *node.lookups].join('.')
-        end.visit
-      end.flatten.uniq.compact
+    def audience_emails_to_s
+      audience_emails.presence&.join(', ')
     end
 
-    def audience_emails_to_s
-      audience_emails.presence&.join(',')
+    # All emails for this emailable resource
+    def resource_emails_to_s(resource)
+      emails = Array(resource_email(resource)).map(&:presence).compact
+
+      if emails.blank? && (emailable = resource_emailable(resource)).present?
+        emails = Array(emailable.try(:reportable_emails) || emailable.try(:email)).map(&:presence).compact
+      end
+
+      emails.presence&.join(', ')
     end
 
-    def resource_user(resource)
+    # A user, owner, or organization column
+    def resource_emailable(resource)
       return unless resource.present?
 
-      column = report&.user_report_column
+      column = report&.emailable_report_column
       return unless column.present?
 
       resource.public_send(column.name) || (resource if resource.respond_to?(:email))
     end
 
+    # An email column
     def resource_email(resource)
       return unless resource.present?
 

data/app/models/effective/notification_log.rb

@@ -20,7 +20,7 @@ module Effective
     scope :sorted, -> { order(:id) }
     scope :deep, -> { includes(:notification, :report, :resource, :user) }
 
-    validates :email, presence: true, email: true
+    validates :email, presence: true
 
     def to_s
       model_name.human

data/app/views/admin/notifications/_form_notification.html.haml

@@ -1,7 +1,11 @@
 = effective_form_with(model: [:admin, notification], engine: true) do |f|
   %h2 Audience
   %p Please select who the notifications should be sent to
-  = f.radios :audience, Effective::Notification::AUDIENCES, label: false, buttons: true
+
+  = f.radios :audience, Effective::Notification::AUDIENCES, label: false, buttons: true,
+    'data-load-ajax-url': effective_messaging.new_admin_notification_path,
+    'data-load-ajax-div': '#effective-messaging-ajax',
+    'data-load-ajax-all': true
 
   = f.show_if(:audience, 'report') do
     %p The notification will be sent to the user or email from the report.
@@ -46,29 +50,30 @@
       = f.select :report_id, Effective::Report.sorted.notifiable.all,
         hint: "Please select a #{link_to 'report', effective_reports.admin_reports_path, target: '_blank'} with a user or email column to use as the data source",
         'data-load-ajax-url': effective_messaging.new_admin_notification_path,
-        'data-load-ajax-div': '#effective-messaging-ajax'
+        'data-load-ajax-div': '#effective-messaging-ajax',
+        'data-load-ajax-all': true
 
   = f.show_if(:audience, 'emails') do
     = f.show_if(:schedule_type, 'scheduled') do
       = f.check_box :attach_report, label: 'Yes, attach a .csv file with the report data', hint: 'only available to scheduled emails sent to specific addresses'
 
-  %h2 Notification
-  %p The following email notification will be sent
-
-  - f.object.from ||= EffectiveMessaging.mailer_froms.first
-  = f.select :from, mailer_froms_collection()
+  = f.show_if(:audience, 'report') do
+    = f.hidden_field :attach_report, value: false
 
-  = f.email_field :bcc
-  = f.text_field :subject
-  = f.text_area :body, rows: 20
+  %h2 Notification
+  = email_notification_fields(f, :notification)
 
   #effective-messaging-ajax
     - if f.object.report.present?
-      %p You can use the following variables in the subject and body:
-
-      %ul
-        - f.object.report_variables.each do |name|
-          %li {{ #{name} }}
+      = card do
+        - if f.object.audience == 'report'
+          %p You can use the following variables in the subject and body:
+
+          %ul
+            - f.object.email_template_variables.each do |name|
+              %li {{ #{name} }}
+        - elsif f.object.audience == 'emails'
+          %p No variables available for Send to specific address audience.
 
   = f.submit do
     = f.save 'Save'

data/app/views/admin/notifications/_summary.html.haml

@@ -14,36 +14,48 @@
     %h4= notification.report.to_s
     = render 'admin/reports/report', report: notification.report
 
-- if notification.rows_count > 0
-  %p Using a random row from the data source, a preview of the notification follows:
+- message = notification.preview()
+
+- if message.present?
+  - if notification.audience_emails?
+    %p A preview of the "Send to specific addresses" notification follows:
+  - else
+    %p Using a random row from the data source, a preview of the "Send to user or email from the report" notification follows:
 
   = card('Preview') do
-    - resource = notification.report.collection.order('RANDOM()').first
-    - rendered = notification.assign_renderer(self).render_email(resource)
+    - message = notification.preview()
 
     %table.table
       %tbody
         %tr
           %th To
-          %td= rendered.fetch(:to)
+          %td= Array(message.to).join(', ')
         %tr
           %th From
-          %td= rendered.fetch(:from)
+          %td= Array(message.from).join(', ')
+          
+        - if (content_type = message.content_type).present?
+          %tr
+            %th Content-Type
+            %td= content_type
 
-        - if (cc = rendered[:cc]).present?
+        - if (cc = message.cc).present?
           %tr
             %th CC
             %td= cc
 
-        - if (bcc = rendered[:bcc]).present?
+        - if (bcc = message.bcc).present?
           %tr
             %th BCC
             %td= bcc
 
         %tr
           %th Subject
-          %td= rendered.fetch(:subject)
+          %td= message.subject
 
         %tr
           %td{colspan: 2}
-            = simple_format(rendered.fetch(:body).to_s)
+            - if email_message_html?(message)
+              = iframe_srcdoc_tag(email_message_body(message))
+            - else
+              = simple_format(email_message_body(message))

data/app/views/effective/notifications_mailer/notification.liquid

@@ -0,0 +1,10 @@
+---
+subject: 'Subject of this notification'
+---
+Hello,
+
+You are receiving this notification for the following reason:
+
+TODO
+
+Thank you

data/db/migrate/101_create_effective_messaging.rb

@@ -69,6 +69,7 @@ class CreateEffectiveMessaging < ActiveRecord::Migration[6.0]
       t.string :from
       t.string :cc
       t.string :bcc
+      t.string :content_type
 
       t.datetime :last_notified_at
       t.integer :last_notified_count

data/lib/effective_messaging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMessaging
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.9.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_messaging
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-06-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -246,6 +246,7 @@ files:
 - app/views/effective/chats/_summary.html.haml
 - app/views/effective/messaging/_dashboard.html.haml
 - app/views/effective/messaging_mailer/chat_new_message.liquid
+- app/views/effective/notifications_mailer/notification.liquid
 - config/effective_messaging.rb
 - config/locales/effective_messaging.yml
 - config/routes.rb