effective_messaging 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee0fc8653681a36c4de9e9756c348c2438e376bff57409b584a5d7e514a1e596
-  data.tar.gz: bf10b4a5f6641193eac7f0da6300d6851b3d51417fe72b36095e6702823936f9
+  metadata.gz: 1061a51a0950e3c322de72f007ce0380e2b9fa6d0089d85bbd905b1cad9a8acd
+  data.tar.gz: 5f1dcb71f399a6d94fb49ba3284bbec7f007c6f8f7494e05aa1bf8f4cde618cf
 SHA512:
-  metadata.gz: 6fdbe70ef0e37d29dc8126ac9416361e4cfd87929f20975dcff60d4281d2804b96c3def8d0a2303be2210e98985310a1858beddaeeb332366ec33bb0bfe69fb6
-  data.tar.gz: 22dafc2abd52b17461126ceafc84164c6d9446f8fe2ff8f997da2b29ff8db5cdc959a1c59123f75ad45499df19057cc04cfd98a03074f12ce6a4958a4406d77e
+  metadata.gz: e4facce29949bb6bfd8a56fcea0029c09da098da22aedcef8c018209c3091e87fcc8a53123cf56ea26b99735cb0d83119a135930428d672129125f3459e0debe
+  data.tar.gz: d97ffe863b7cb1d14829f49ddf012723d79a99b3c1b2038dbd48e99bf8caf1193388ff8fcd5813dad9b25168d9118d3c3abae5d790126d10ba916e6cb66fa278

data/app/controllers/admin/notifications_controller.rb

@@ -5,8 +5,6 @@ module Admin
 
     include Effective::CrudController
 
-    submit :send_now, 'Send Now'
-
     private
 
     def permitted_params

data/app/datatables/admin/effective_notification_logs_datatable.rb

@@ -8,9 +8,10 @@ module Admin
 
       col :notification
       col :report, visible: !attributes[:inline]
-      col :resource
-      col :user
-      col :email, visible: false
+      col :resource, search: :string
+      col :user, search: :string
+      col :email
+      col :skipped
 
       actions_col
     end

data/app/datatables/admin/effective_notifications_datatable.rb

@@ -34,6 +34,8 @@ module Admin
 
       col :report, search: Effective::Report.notifiable.sorted, action: :show
 
+      col :notifiable_tomorrow_rows_count, label: 'Tomorrow'
+
       col(:rows_count) do |notification|
         notification.report.collection().count
       end

data/app/jobs/effective/notification_job.rb

@@ -1,8 +1,8 @@
 module Effective
   class NotificationJob < ApplicationJob
 
-    def perform(id)
-      Notification.find(id).notify!
+    def perform(id, force:)
+      Notification.find(id).notify!(force: force)
     end
 
   end

data/app/mailers/effective/notifications_mailer.rb

@@ -11,6 +11,7 @@ module Effective
 
       # 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)

data/app/models/effective/notification.rb

@@ -102,6 +102,10 @@ module Effective
       validates :immediate_times, presence: true, numericality: { greater_than_or_equal_to: 1 }
     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
+    end
+
     # Scheduled
     validates :scheduled_method, presence: true, inclusion: { in: SCHEDULED_METHODS.map(&:last) }, if: -> { scheduled? }
 
@@ -154,6 +158,8 @@ module Effective
       end
     end
 
+    # This operates on each row of the resource.
+    # We track the number of notifications total to see if we should notify again or not
     def immediate?
       schedule_type == 'immediate'
     end
@@ -210,24 +216,63 @@ module Effective
       @rows_count ||= report.collection().count if report
     end
 
-    # Button on the Admin interface. Enqueues the job to send right away.
+    def notifiable_rows_count
+      report.collection().select { |resource| notifiable?(resource) }.count if report
+    end
+
+    def notifiable_tomorrow_rows_count
+      report.collection().select { |resource| notifiable_tomorrow?(resource) }.count if report
+    end
+
+    def enable!
+      update!(enabled: true)
+    end
+
+    def disable!
+      update!(enabled: false)
+    end
+
+    # Enqueues this notification to send right away.
+    # Only applies to scheduled_email? notifications
     def send_now!
       raise('expected to be persisted') unless persisted?
-      NotificationJob.perform_later(id)
+      NotificationJob.perform_later(id, force: true)
       true
     end
 
-    # The main function
-    def notify!
-      scheduled_email? ? notify_by_schedule! : notify_by_resources!
+    # Only applies to immedate? notifications
+    # Skips over one notification on the immediate notifications
+    def skip_once!
+      notified = 0
+
+      report.collection().find_each do |resource|
+        print('.')
+
+        # For logging
+        assign_attributes(current_resource: resource)
+
+        # Send the resource email
+        build_notification_log(resource: resource, skipped: true).save!
+
+        notified += 1
+
+        GC.start if (notified % 250) == 0
+      end
+
+      touch
+    end
+
+    # The main function to send this thing
+    def notify!(force: false)
+      scheduled_email? ? notify_by_schedule!(force: force) : notify_by_resources!(force: force)
     end
 
     # Operates on every resource in the data source. Sends one email for each row
-    def notify_by_resources!
+    def notify_by_resources!(force: false)
       notified = 0
 
       report.collection().find_each do |resource|
-        next unless notifiable?(resource)
+        next unless notifiable?(resource) || force
         print('.')
 
         # For logging
@@ -245,10 +290,10 @@ module Effective
       notified > 0 ? update!(last_notified_at: Time.zone.now, last_notified_count: notified) : touch
     end
 
-    def notify_by_schedule!
+    def notify_by_schedule!(force: false)
       notified = 0
 
-      if notifiable_scheduled?
+      if notifiable_scheduled? || force
         build_notification_log(resource: nil).save!
         Effective::NotificationsMailer.notify(self).deliver_now
         notified += 1
@@ -257,22 +302,27 @@ module Effective
       notified > 0 ? update!(last_notified_at: Time.zone.now, last_notified_count: notified) : touch
     end
 
-    def notifiable?(resource)
+    def notifiable?(resource, date: nil)
       raise('expected an acts_as_reportable resource') unless resource.class.try(:acts_as_reportable?)
 
       if schedule_type == 'immediate'
-        notifiable_immediate?(resource: resource)
+        notifiable_immediate?(resource: resource, date: date)
       elsif schedule_type == 'scheduled'
-        notifiable_scheduled?(date: nil)
+        notifiable_scheduled?(date: date)
       else
         raise("unsupported schedule_type")
       end
     end
 
+    def notifiable_tomorrow?(resource)
+      date = Time.zone.now.beginning_of_day.advance(days: 1)
+      notifiable?(resource, date: date)
+    end
+
     # Consider the notification logs which track how many and how long ago this notification was sent
     # It's notifiable? when first time or if it's been immediate_days since last notification
-    def notifiable_immediate?(resource:)
-      raise('expected an immexiate? notification') unless immediate?
+    def notifiable_immediate?(resource:, date: nil)
+      raise('expected an immediate? notification') unless immediate?
 
       email = resource_email(resource) || resource_user(resource).try(:email)
       raise("expected an email for #{report} #{report&.id} and #{resource} #{resource&.id}") unless email.present?
@@ -283,8 +333,8 @@ module Effective
         true # This is the first time. We should send.
       elsif logs.count < immediate_times
         # We still have to send it but consider dates.
-        last_sent_days_ago = logs.map(&:days_ago).min || 0
-        last_sent_days_ago >= immediate_days
+        last_sent_days_ago = logs.map { |log| log.days_ago(date: date) }.min || 0
+        (last_sent_days_ago >= immediate_days)
       else
         false # We've already sent enough times
       end
@@ -348,13 +398,13 @@ module Effective
       report_assigns.merge(reportable_view_assigns)
     end
 
-    def build_notification_log(resource: nil)
+    def build_notification_log(resource: nil, skipped: false)
       user = resource_user(resource)
 
       email = resource_email(resource) || user.try(:email)
       email ||= audience_emails_to_s if scheduled_email?
 
-      notification_logs.build(email: email, report: report, resource: resource, user: user)
+      notification_logs.build(email: email, report: report, resource: resource, user: user, skipped: skipped)
     end
 
     private

data/app/models/effective/notification_log.rb

@@ -12,6 +12,7 @@ module Effective
 
     effective_resource do
       email        :string
+      skipped      :boolean
 
       timestamps
     end
@@ -25,8 +26,8 @@ module Effective
       model_name.human
     end
 
-    def days_ago
-      now = Time.zone.now.to_date
+    def days_ago(date: nil)
+      now = (date || Time.zone.now).to_date
       (now - (created_at&.to_date || now)).to_i
     end
 

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

@@ -76,9 +76,5 @@
 
   = f.submit do
     = f.save 'Save'
-
-    - if EffectiveResources.authorized?(self, :send_now, f.object)
-      = f.save 'Send Now', class: 'btn btn-warning', 'data-confirm': "Really send now?"
-
     = f.save 'Add New', class: 'btn btn-secondary'
     = f.save 'Continue', class: 'btn btn-secondary'

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

@@ -1,43 +1,11 @@
-%p
-  This notification will be sent to all rows from the
-  = link_to(notification.report, effective_reports.admin_report_path(notification.report), target: '_blank')
-  report at the time of sending.
+= tabs do
+  = tab 'Notification' do
+    = render 'admin/notifications/summary', notification: notification
 
-%p Currently there are #{pluralize(notification.rows_count, 'rows')} that would be notified.
+  - if notification.persisted? && notification.respond_to?(:logs_datatable)
+    = tab 'Email Logs' do
+      - datatable = Admin::EffectiveNotificationLogsDatatable.new(notification: notification)
+      = render_inline_datatable(datatable)
 
-= card(notification) do
-  = effective_table_with(notification)
-
-- if notification.rows_count > 0
-  %p Using a random row from the data source, a preview of the notification follows:
-
-  = card('Preview of Notification') do
-    - resource = notification.report.collection.order('RANDOM()').first
-    - rendered = notification.assign_renderer(self).render_email(resource)
-
-    %table.table
-      %tbody
-        %tr
-          %th To
-          %td= rendered.fetch(:to)
-        %tr
-          %th From
-          %td= rendered.fetch(:from)
-
-        - if (cc = rendered[:cc]).present?
-          %tr
-            %th CC
-            %td= cc
-
-        - if (bcc = rendered[:bcc]).present?
-          %tr
-            %th BCC
-            %td= bcc
-
-        %tr
-          %th Subject
-          %td= rendered.fetch(:subject)
-
-        %tr
-          %td{colspan: 2}
-            = simple_format(rendered.fetch(:body).to_s)
+    = tab 'Logs' do
+      = render_inline_datatable(notification.logs_datatable)

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

@@ -0,0 +1,49 @@
+%p
+  This notification will be sent to all rows from the
+  = link_to(notification.report, effective_reports.admin_report_path(notification.report), target: '_blank')
+  report at the time of sending.
+
+%p Tomorrow morning, #{pluralize(notification.notifiable_tomorrow_rows_count, 'rows')} notifications will be sent.
+
+.mb-2
+  = collapse('Show notification details') do
+    = effective_table_with(notification)
+
+.mb-2
+  = collapse("Show report data") do
+    %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:
+
+  = card('Preview') do
+    - resource = notification.report.collection.order('RANDOM()').first
+    - rendered = notification.assign_renderer(self).render_email(resource)
+
+    %table.table
+      %tbody
+        %tr
+          %th To
+          %td= rendered.fetch(:to)
+        %tr
+          %th From
+          %td= rendered.fetch(:from)
+
+        - if (cc = rendered[:cc]).present?
+          %tr
+            %th CC
+            %td= cc
+
+        - if (bcc = rendered[:bcc]).present?
+          %tr
+            %th BCC
+            %td= bcc
+
+        %tr
+          %th Subject
+          %td= rendered.fetch(:subject)
+
+        %tr
+          %td{colspan: 2}
+            = simple_format(rendered.fetch(:body).to_s)

data/config/routes.rb

@@ -13,7 +13,15 @@ EffectiveMessaging::Engine.routes.draw do
   namespace :admin do
     resources :chats
     resources :chat_messages, only: [:index, :show, :destroy]
-    resources :notifications
+
+    resources :notifications do
+      post :enable, on: :member
+      post :disable, on: :member
+
+      post :send_now, on: :member
+      post :skip_once, on: :member
+    end
+
     resources :notification_logs, only: [:index, :destroy]
   end
 

data/db/migrate/101_create_effective_messaging.rb

@@ -87,6 +87,7 @@ class CreateEffectiveMessaging < ActiveRecord::Migration[6.0]
       t.string :resource_type
 
       t.string :email
+      t.boolean :skipped, default: false
 
       t.timestamps
     end

data/lib/effective_messaging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMessaging
-  VERSION = '0.4.2'.freeze
+  VERSION = '0.5.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_messaging
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-26 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -237,6 +237,7 @@ files:
 - app/views/admin/notifications/_form.html.haml
 - app/views/admin/notifications/_form_notification.html.haml
 - app/views/admin/notifications/_notification.html.haml
+- app/views/admin/notifications/_summary.html.haml
 - app/views/effective/chats/_chat.html.haml
 - app/views/effective/chats/_chat_message.html.haml
 - app/views/effective/chats/_form.html.haml