effective_messaging 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 100add48efce4abb6b4604310d8adfc37df3edae84bd69f2dc350f2239488f65
-  data.tar.gz: fc5e27126372377ea850672ebb9db003698795a63b896773ffc992686e61ed5a
+  metadata.gz: 562e0f1c733ddda4bc2100b12ba84500090e89136a0318d00915d3518b775b52
+  data.tar.gz: 5f3d887a18529c663ff520a0b992bd96c0bbd545e47db08e6031c5fa56837c3e
 SHA512:
-  metadata.gz: 52e97742d99e634c3dbfb3c723c0767386fec0f63e52c3d78215b4fdcbb01863f34a6848aa9ff291141358d0fa075e0a95f3bb6221390220900796d907344e19
-  data.tar.gz: c980d9cc678826ae1f8ea2c94b5e603b3a13de884dac5159eca6f2481c8aa5377054f1d3be8b145a24978bc99762e27bb281bc40377aad147ed8c74e0a3da6d4
+  metadata.gz: 5b438f053eff518e167b3ccd39b90472a35879c07f2b650257cc3fbe21b160dd96cfba455c2bcaf80ce857da92e05e78920a159b6cc8a7f66f2b193d609f1033
+  data.tar.gz: a76f710b600e910220e3406d9e055e6a2f77f69478ccf58fcd8c7953eb053374d1569804995152d73b3ead14a74e254157a41039de4bb8aa12147c78e2b1efef

data/README.md

@@ -2,6 +2,8 @@
 
 Centralize all communications between one or more users.
 
+Works with effective_reports to schedule notifications to report results containing emails.
+
 ## Getting Started
 
 This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.
@@ -69,6 +71,9 @@ Add a link to the admin menu:
 
 - if can?(:admin, :effective_messaging) && can?(:index, Effective::ChatMessage)
   = nav_link_to 'Chat Messages', effective_messaging.admin_chat_messages_path
+
+- if can?(:admin, :effective_messaging) && can?(:index, Effective::Notification)
+  = nav_link_to 'Chat Messages', effective_messaging.admin_notifications_path
 ```
 
 ## Authorization
@@ -89,6 +94,8 @@ if user.admin?
   can(crud, Effective::Chat)
   can(crud, Effective::ChatUser)
   can(crud - [:new, :create], Effective::ChatMessage)
+
+  can(crud + [:create_notification_job], Effective::Notification)
 end
 ```
 
@@ -109,6 +116,12 @@ and you can just render it *outside of a form*:
 = render('effective/chats/chat', chat: chat)
 ```
 
+## Creating a notification
+
+First create an effective report with an email column in the results.
+
+Then visit /admin/notifications to schedule a notification with a From, Subject and Body
+
 ## License
 
 MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)

data/app/controllers/admin/notifications_controller.rb

@@ -0,0 +1,17 @@
+module Admin
+  class NotificationsController < ApplicationController
+    before_action(:authenticate_user!) if defined?(Devise)
+    before_action { EffectiveResources.authorize!(self, :admin, :effective_messaging) }
+
+    include Effective::CrudController
+
+    submit :create_notification_job, 'Send Now'
+
+    private
+
+    def permitted_params
+      params.require(:effective_notification).permit!
+    end
+
+  end
+end

data/app/datatables/admin/effective_notifications_datatable.rb

@@ -0,0 +1,37 @@
+module Admin
+  class EffectiveNotificationsDatatable < Effective::Datatable
+    filters do
+      scope :all
+      scope :notifiable, label: 'Upcoming'
+      scope :completed, label: 'Past'
+    end
+
+    datatable do
+      order :updated_at
+
+      col :updated_at, visible: false
+      col :created_at, visible: false
+      col :id, visible: false
+
+      col :send_at
+      col :report, search: Effective::Report.emails.sorted
+
+      col :subject
+      col :body, visible: false
+
+      col :from, visible: false, search: Array(EffectiveMessaging.froms).presence
+      col :cc, visible: false
+      col :bcc, visible: false
+
+      col :started_at, visible: false
+      col :completed_at
+      col :notifications_sent, visible: false
+
+      actions_col
+    end
+
+    collection do
+      Effective::Notification.deep.all
+    end
+  end
+end

data/app/jobs/effective/notification_job.rb

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

data/app/mailers/effective/messaging_mailer.rb

@@ -1,8 +1,7 @@
 module Effective
   class MessagingMailer < EffectiveMessaging.parent_mailer_class
-
     include EffectiveMailer
-    include EffectiveEmailTemplatesMailer if EffectiveMessaging.use_effective_email_templates
+    include EffectiveEmailTemplatesMailer
 
     def chat_new_message(chat, chat_user, opts = {})
       raise('expected a chat') unless chat.kind_of?(Chat)

data/app/mailers/effective/notifications_mailer.rb

@@ -0,0 +1,37 @@
+module Effective
+  class NotificationsMailer < EffectiveReports.parent_mailer_class
+    include EffectiveMailer
+
+    # Does not use effective_email_templates mailer
+
+    def notification(notification, resource, opts = {})
+      raise('expected an Effective::Notification') unless notification.kind_of?(Effective::Notification)
+      raise('expected a resource') unless resource.present?
+
+      # Returns a Hash of params to pass to mail()
+      # Includes a :to, :from, etc
+      rendered = notification.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')
+      end
+
+      # Calls effective_resources subject proc, so we can prepend [LETTERS]
+      subject = subject_for(__method__, rendered.fetch(:subject), resource, opts)
+
+      # Pass everything to mail
+      mail(rendered.merge(headers).merge(subject: subject))
+    end
+
+    private
+
+    def mailer_settings
+      EffectiveMessaging
+    end
+
+  end
+end

data/app/models/effective/notification.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module Effective
+  class Notification < ActiveRecord::Base
+    self.table_name = EffectiveMessaging.notifications_table_name.to_s
+
+    attr_accessor :current_user
+    attr_accessor :current_resource
+
+    log_changes if respond_to?(:log_changes)
+
+    # Unused. If we want to use notifications in a has_many way
+    belongs_to :parent, polymorphic: true, optional: true
+
+    # Unused. When the notification belongs to one user
+    belongs_to :user, polymorphic: true, optional: true
+
+    # Effective namespace
+    belongs_to :report, class_name: 'Effective::Report'
+
+    CONTENT_TYPES = ['text/plain', 'text/html']
+
+    effective_resource do
+      send_at           :datetime
+
+      subject           :string
+      body              :text
+
+      from              :string
+      cc                :string
+      bcc               :string
+
+      # Tracking background jobs email send out
+      started_at         :datetime
+      completed_at       :datetime
+      notifications_sent :integer
+
+      timestamps
+    end
+
+    scope :sorted, -> { order(:id) }
+    scope :deep, -> { includes(report: :report_columns) }
+
+    scope :upcoming, -> { where('send_at > ?', Time.zone.now) }
+    scope :started, -> { where.not(started_at: nil) }
+    scope :completed, -> { where.not(completed_at: nil) }
+
+    # Called by the notifier rake task
+    scope :notifiable, -> { where(started_at: nil) }
+
+    before_validation(if: -> { send_at_changed? }) do
+      assign_attributes(started_at: nil, completed_at: nil, notifications_sent: nil)
+    end
+
+    validates :send_at, presence: true
+    validates :from, presence: true, email: true
+    validates :subject, presence: true, liquid: true
+    validates :body, presence: true, liquid: true
+
+    validate(if: -> { report.present? }) do
+      self.errors.add(:report, 'must include an email column') unless report.email_report_column.present?
+    end
+
+    validate(if: -> { report.present? && subject.present? }) do
+      if(invalid = template_variables(body: false) - report_variables).present?
+        self.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?
+        self.errors.add(:body, "Invalid variable: #{invalid.to_sentence}")
+      end
+    end
+
+    def to_s
+      subject.presence || 'notification'
+    end
+
+    def template_subject
+      Liquid::Template.parse(subject)
+    end
+
+    def template_body
+      Liquid::Template.parse(body)
+    end
+
+    def report_variables
+      Array(report&.report_columns).map(&:name)
+    end
+
+    def rows_count
+      @rows_count ||= report.collection().count if report
+    end
+
+    def in_progress?
+      started_at.present? && completed_at.blank?
+    end
+
+    def notifiable?
+      started_at.blank? && completed_at.blank?
+    end
+
+    def notify_now?
+      notifiable? && Time.zone.now >= send_at
+    end
+
+    def notify!(force: false, limit: nil)
+      return false unless (notify_now? || force)
+
+      update!(started_at: Time.zone.now, completed_at: nil, notifications_sent: nil)
+
+      index = 0
+
+      report.collection().find_each do |resource|
+        print('.')
+
+        assign_attributes(current_resource: resource)
+        Effective::NotificationsMailer.notification(self, resource).deliver_now
+
+        index += 1
+        break if limit && index >= limit
+
+        GC.start if (index % 250) == 0
+      end
+
+      update!(current_resource: nil, completed_at: Time.zone.now, notifications_sent: index)
+    end
+
+    # The 'Send Now' action on admin. Enqueues a job that calls notify!(force: true)
+    def create_notification_job!
+      update!(started_at: Time.zone.now, completed_at: nil, notifications_sent: nil)
+
+      NotificationJob.perform_later(id, true) # force = true
+      true
+    end
+
+    def render_email(resource)
+      raise('expected a resource') unless resource.present?
+
+      assigns = assigns_for(resource)
+      to = assigns.fetch(report.email_report_column.name) || raise('expected an email assigns')
+
+      {
+        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
+    end
+
+    def assigns_for(resource)
+      Array(report&.report_columns).inject({}) do |h, column|
+        value = resource.send(column.name)
+        h[column.name] = column.format(value); h
+      end
+    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
+    end
+
+  end
+end

data/app/views/admin/chats/_form.html.haml

@@ -3,6 +3,6 @@
     = render 'admin/chats/form_chat', chat: chat
 
   - if chat.persisted?
-    - if chat.respond_to?(:log_changes_datatable)
+    - if chat.respond_to?(:logs_datatable)
       = tab "Logs" do
-        = render_inline_datatable(chat.log_changes_datatable)
+        = render_inline_datatable(chat.logs_datatable)

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

@@ -0,0 +1,7 @@
+= tabs do
+  = tab 'Notification' do
+    = render 'admin/notifications/form_notification', notification: notification
+
+  - if notification.persisted? && notification.respond_to?(:logs_datatable)
+    = tab 'Logs' do
+      = render_datatable(notification.logs_datatable)

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

@@ -0,0 +1,60 @@
+= effective_form_with(model: [:admin, notification], engine: true) do |f|
+  %h2 Data Source
+  %p
+    Please select a
+    = link_to 'report', effective_reports.admin_reports_path, target: '_blank'
+    with an email report column to use as the data source.
+
+  %p Each result from the report will be sent a notification.
+
+  .row
+    .col-md-6
+      = f.select :report_id, Effective::Report.sorted.emails.all, label: 'Report with email column',
+        'data-load-ajax-url': effective_messaging.new_admin_notification_path,
+        'data-load-ajax-div': '#effective-messaging-ajax'
+
+  %h2 Schedule
+  %p Please select a date when the notifications should be sent
+
+  .row
+    .col-md-6
+      - minDate = [f.object.created_at, Time.zone.now].compact.min
+
+      = f.datetime_field :send_at, label: 'Send the notification at', input_js: { minDate: minDate.strftime('%F %H:%M:%S') },
+        hint: 'A future date. Changing this value will reset the started_at and completed_at dates so this notification can be sent again.'
+    .col-md-6
+      - if f.object.completed_at.present?
+        = f.static_field :completed_at
+      - elsif f.object.started_at.present?
+        = f.static_field :started_at
+
+  %h2 Notification
+  %p The following notification will be sent to each row in the data source
+
+  - froms = Array(EffectiveMessaging.froms)
+
+  - if froms.present?
+    - f.object.from ||= froms.first
+    = f.select :from, Array(froms)
+  - else
+    = f.email_field :from
+
+  = f.text_field :subject
+  = f.text_area :body
+
+  #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} }}
+
+  = f.submit do
+    = f.save 'Save'
+
+    - if f.object.persisted? && !f.object.in_progress?
+      = f.save 'Send Now', class: 'btn btn-warning', 'data-confirm': "Really send #{pluralize(notification.rows_count, 'notification')} now?"
+
+    = f.save 'Add New', class: 'btn btn-secondary'
+    = f.save 'Continue', class: 'btn btn-secondary'

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

@@ -0,0 +1,67 @@
+%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 Currently there are #{pluralize(notification.rows_count, 'rows')} that would be notified.
+
+= card(notification) do
+  %table.table
+    %tbody
+      %tr
+        %th Send At
+        %td= notification.send_at.strftime('%F %H:%M')
+
+      %tr
+        %th Report
+        %td= link_to(notification.report, effective_reports.admin_report_path(notification.report), target: '_blank')
+
+      %tr
+        %th Current rows count
+        %td= notification.rows_count
+
+      %tr
+        %th Started At
+        %td= notification.started_at&.strftime('%F %H:%M') || 'Never'
+
+      %tr
+        %th Completed At
+        %td= notification.completed_at&.strftime('%F %H:%M') || 'Never'
+
+      %tr
+        %th Notifications Sent
+        %td= notification.notifications_sent.presence || 'None'
+
+- 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.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/effective_messaging.rb

@@ -2,11 +2,16 @@ EffectiveMessaging.setup do |config|
   config.chats_table_name = :chats
   config.chat_users_table_name = :chat_users
   config.chat_messages_table_name = :chat_messages
+  config.notifications_table_name = :notifications
 
   # Layout Settings
   # Configure the Layout per controller, or all at once
   # config.layout = { application: 'application', admin: 'admin' }
 
+  # From Settings
+  # For the Admin new notification form. Set to an array to use a select, or nil to use a freeform text entry
+  config.froms = ['noreply@example.com']
+
   # Mailer Settings
   # Please see config/initializers/effective_messaging.rb for default effective_* gem mailer settings
   #
@@ -22,6 +27,4 @@ EffectiveMessaging.setup do |config|
   # config.mailer_admin = nil       # Default To value for Admin correspondence
   # config.mailer_subject = nil     # Proc.new method used to customize Subject
 
-  # Will work with effective_email_templates gem
-  config.use_effective_email_templates = true
 end

data/config/routes.rb

@@ -13,6 +13,7 @@ EffectiveMessaging::Engine.routes.draw do
   namespace :admin do
     resources :chats
     resources :chat_messages, only: [:index, :show, :destroy]
+    resources :notifications
   end
 
 end

data/db/migrate/01_create_effective_messaging.rb.erb

@@ -40,5 +40,30 @@ class CreateEffectiveMessaging < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
+    create_table <%= @notifications_table_name %> do |t|
+      t.integer :parent_id
+      t.string :parent_type
+
+      t.integer :user_id
+      t.string :user_type
+
+      t.integer :report_id
+
+      t.datetime :send_at
+
+      t.string :subject
+      t.text :body
+
+      t.string :from
+      t.string :cc
+      t.string :bcc
+
+      t.datetime :started_at
+      t.datetime :completed_at
+      t.integer :notifications_sent
+
+      t.timestamps
+    end
+
   end
 end

data/lib/effective_messaging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMessaging
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.1.4'.freeze
 end

data/lib/effective_messaging.rb

@@ -7,9 +7,10 @@ module EffectiveMessaging
 
   def self.config_keys
     [
-      :chats_table_name, :chat_users_table_name, :chat_messages_table_name,
+      :chats_table_name, :chat_users_table_name, :chat_messages_table_name, :notifications_table_name,
       :layout,
-      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates
+      :froms,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject
     ]
   end
 

data/lib/generators/effective_messaging/install_generator.rb

@@ -23,6 +23,7 @@ module EffectiveMessaging
         @chats_table_name  = ':' + EffectiveMessaging.chats_table_name.to_s
         @chat_users_table_name  = ':' + EffectiveMessaging.chat_users_table_name.to_s
         @chat_messages_table_name  = ':' + EffectiveMessaging.chat_messages_table_name.to_s
+        @notifications_table_name  = ':' + EffectiveMessaging.notifications_table_name.to_s
 
         migration_template ('../' * 3) + 'db/migrate/01_create_effective_messaging.rb.erb', 'db/migrate/create_effective_messaging.rb'
       end

data/lib/tasks/effective_messaging_tasks.rake

@@ -1,8 +1,25 @@
+# rake effective_messaging:notify
 namespace :effective_messaging do
+  desc 'Sends scheduled notifications for effective messaging'
+  task notify: :environment do
+    puts 'Sending notifications'
 
-  # bundle exec rake effective_messaging:seed
-  task seed: :environment do
-    load "#{__dir__}/../../db/seeds.rb"
-  end
+    notifications = Effective::Notification.all.deep.notifiable
+
+    notifications.find_each do |notification|
+      begin
+        notified = notification.notify!
+        Rails.logger.info "Sent notifications for #{notification.report}" if notified
+      rescue => e
+        if defined?(ExceptionNotifier)
+          data = { notification_id: notification.id, report_id: notification.report_id, resource_id: notification.current_resource&.id }
+          ExceptionNotifier.notify_exception(e, data: data)
+        end
 
+        puts "Error with effective_messaging #{notification.id} resource #{notification.current_resource&.id}: #{e.errors.inspect}"
+      end
+    end
+
+    puts 'All done'
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_messaging
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-27 00:00:00.000000000 Z
+date: 2023-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 4.0.0
 - !ruby/object:Gem::Dependency
-  name: effective_orders
+  name: effective_email_templates
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: effective_roles
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: wicked
+  name: effective_reports
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -192,20 +178,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: effective_email_templates
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Centralize the communication between one or more users.
 email:
 - info@codeandeffect.com
@@ -223,22 +195,30 @@ files:
 - app/assets/stylesheets/effective_messaging/base.scss
 - app/controllers/admin/chat_messages_controller.rb
 - app/controllers/admin/chats_controller.rb
+- app/controllers/admin/notifications_controller.rb
 - app/controllers/effective/chats_controller.rb
 - app/datatables/admin/effective_chat_messages_datatable.rb
 - app/datatables/admin/effective_chats_datatable.rb
+- app/datatables/admin/effective_notifications_datatable.rb
 - app/datatables/effective_chats_datatable.rb
 - app/helpers/effective_messaging_helper.rb
+- app/jobs/effective/notification_job.rb
 - app/mailers/effective/messaging_mailer.rb
+- app/mailers/effective/notifications_mailer.rb
 - app/models/concerns/effective_messaging_parent.rb
 - app/models/concerns/effective_messaging_user.rb
 - app/models/effective/chat.rb
 - app/models/effective/chat_message.rb
 - app/models/effective/chat_user.rb
+- app/models/effective/notification.rb
 - app/views/admin/chat_messages/_chat_message.html.haml
 - app/views/admin/chats/_chat.html.haml
 - app/views/admin/chats/_form.html.haml
 - app/views/admin/chats/_form_chat.html.haml
 - app/views/admin/chats/_layout.html.haml
+- app/views/admin/notifications/_form.html.haml
+- app/views/admin/notifications/_form_notification.html.haml
+- app/views/admin/notifications/_notification.html.haml
 - app/views/effective/chats/_chat.html.haml
 - app/views/effective/chats/_chat_message.html.haml
 - app/views/effective/chats/_form.html.haml