effective_messaging 0.12.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7122fe35acd896e24f84b7fd65ba9514fb9a1dff0de6e50f0ac5af6d507f643b
-  data.tar.gz: a997df0342bbd6fa50f0ec0e87911f8518d00e5538d2f69f3686bba3c1e15923
+  metadata.gz: b067851235561d03267380eeaf0e8c4f734c635e7c28689c0cc67830a4a84b6f
+  data.tar.gz: 9d21a71ec1dbc58dd46a174342c8eadd37eb0fb7c7042d1ed8106b785ba4a4fd
 SHA512:
-  metadata.gz: 84bd8c6a88b84dccd311c582a52648d1b2c0763e7575ef558274dd94d28ba5c56e4cae26eaa9e23cb0527e5c33af6035e691ced6d6184cae9ef35ff4b6228050
-  data.tar.gz: d6091da483e055c52b6f5fb60fa4b76b31759e986d90af906b8a43624129bc4067ccb2fc533fef2c4aaa34411588c9d2fe3b0f83fb9778d24e6788350d9df17a
+  metadata.gz: 596dedbf28e9c3fc0cfa5f0d592f61d309992833a71c7c483e5ba3488dd7094626d77a7ce77833bd96203f116dfdd61c3eeceb160b28624cd7eeed184d777d53
+  data.tar.gz: faccebd0025d5fe3b2815d69d6ddafbec4a4aa5a7177b945c4c21decd9fa92b63192d220840f91194f22688e240e913ad0fa302048ce496ac6bd6c982f63ccea

data/README.md

@@ -4,6 +4,15 @@ Centralize all communications between one or more users.
 
 Works with effective_reports to schedule notifications to report results containing emails.
 
+`notification.delivery_status` provides a read-only forecast using the same `notifiable?`
+checks as `notifiable_tomorrow_rows_count` and the sender. It returns `:next_on`, `:status`,
+the last recorded send date, and counts of current recipients pending, finished, or blocked.
+Resource notifications also respect same-day delivery logs and delivery errors. Skipped
+logs count toward a course, as they do when sending. A completed course applies only to
+the current report recipients; new matches may still receive notifications. Fixed-address
+scheduled emails follow their configured dates even when the report is empty. This method
+does not send email, write logs, or predict changes to the report audience or server cron.
+
 ## Getting Started
 
 This requires Rails 6+ and Twitter Bootstrap 4 and just works with Devise.
@@ -142,3 +151,14 @@ rails test
 4. Push to the branch (`git push origin my-new-feature`)
 5. Bonus points for test coverage
 6. Create new Pull Request
+
+## Chat documents
+
+Documents are disabled by default. Enable them in the host initializer:
+
+```ruby
+config.chat_attachments_enabled = true
+```
+
+Messages still require text. Documents remain with their message and downloads
+require permission to view the chat. Disabling the toggle hides documents and blocks downloads without deleting files. The host needs Active Storage configured and migrated.

data/app/controllers/admin/chat_messages_controller.rb

@@ -8,6 +8,5 @@ module Admin
     def permitted_params
       params.require(:effective_chat_message).permit!
     end
-
   end
 end

data/app/controllers/admin/chats_controller.rb

@@ -8,6 +8,5 @@ module Admin
     def permitted_params
       params.require(:effective_chat).permit!
     end
-
   end
 end

data/app/controllers/admin/notification_logs_controller.rb

@@ -10,6 +10,5 @@ module Admin
     def permitted_params
       params.require(:effective_notification_log).permit!
     end
-
   end
 end

data/app/controllers/admin/notifications_controller.rb

@@ -10,6 +10,5 @@ module Admin
     def permitted_params
       params.require(:effective_notification).permit!
     end
-
   end
 end

data/app/controllers/effective/chats_controller.rb

@@ -6,11 +6,21 @@ module Effective
 
     resource_scope -> { Effective::Chat.all.deep }
 
+    def download
+      raise ActiveRecord::RecordNotFound unless EffectiveMessaging.chat_attachments_enabled
+      chat = Effective::Chat.find(params[:id])
+      EffectiveResources.authorize!(self, :show, chat)
+      attachment = chat.chat_messages.find(params[:chat_message_id]).files.find(params[:file_id])
+      send_data attachment.download, filename: attachment.filename.to_s,
+        type: attachment.content_type, disposition: 'attachment'
+    end
+
     private
 
     def permitted_params
-      params.require(:effective_chat).except(:user_type).permit(chat_messages_attributes: [:body])
+      message_attributes = [:body]
+      message_attributes << { files: [] } if EffectiveMessaging.chat_attachments_enabled
+      params.require(:effective_chat).except(:user_type).permit(chat_messages_attributes: message_attributes)
     end
-
   end
 end

data/app/datatables/admin/effective_chat_messages_datatable.rb

@@ -1,6 +1,5 @@
 module Admin
   class EffectiveChatMessagesDatatable < Effective::Datatable
-
     datatable do
       col :id, visible: false
       col :token, visible: false
@@ -23,8 +22,6 @@ module Admin
       end
 
       scope
-
     end
-
   end
 end

data/app/datatables/admin/effective_chats_datatable.rb

@@ -1,6 +1,5 @@
 module Admin
   class EffectiveChatsDatatable < Effective::Datatable
-
     datatable do
       col :id, visible: false
       col :token, visible: false
@@ -46,6 +45,5 @@ module Admin
 
       scope
     end
-
   end
 end

data/app/datatables/effective_chats_datatable.rb

@@ -23,5 +23,4 @@ class EffectiveChatsDatatable < Effective::Datatable
 
     chats
   end
-
 end

data/app/jobs/effective/notification_job.rb

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

data/app/mailers/effective/messaging_mailer.rb

@@ -53,6 +53,5 @@ module Effective
 
       { user: values }
     end
-
   end
 end

data/app/mailers/effective/notifications_mailer.rb

@@ -76,6 +76,5 @@ module Effective
     def authorize!(action, resource)
       true
     end
-
   end
 end

data/app/models/concerns/effective_messaging_parent.rb

@@ -39,5 +39,4 @@ module EffectiveMessagingParent
   def chat_url(chat:, user:, root_url:)
     nil
   end
-
 end

data/app/models/concerns/effective_messaging_user.rb

@@ -43,5 +43,4 @@ module EffectiveMessagingUser
   # def build_chat_user(chat:)
   #   chat_user(chat: chat) || chat_users.build(chat: chat)
   # end
-
 end

data/app/models/effective/chat.rb

@@ -34,8 +34,8 @@ module Effective
     scope :sorted, -> { order(id: :desc) }
     scope :deep, -> { includes(:chat_users, :chat_messages) }
 
-    scope :for_user, -> (user) { where(id: ChatUser.where(user: user).select(:chat_id)) }
-    scope :search_by_chat_user_name, -> (name) { where(id: ChatUser.with_name(name).select(:chat_id)) }
+    scope :for_user, ->(user) { where(id: ChatUser.where(user: user).select(:chat_id)) }
+    scope :search_by_chat_user_name, ->(name) { where(id: ChatUser.with_name(name).select(:chat_id)) }
 
     validates :title, presence: true, length: { maximum: 255 }
 
@@ -65,7 +65,6 @@ module Effective
 
       # Notify everyone in the chat except the user that created this message
       notified = (chat_users - [except]).map do |chat_user|
-
         # Only notify once every 5 minutes unless force
         if chat_user.last_notified_at.present? && !force
           next if (Time.zone.now - chat_user.last_notified_at) < NOTIFY_AFTER
@@ -130,6 +129,5 @@ module Effective
       # Return users
       users
     end
-
   end
 end

data/app/models/effective/chat_message.rb

@@ -6,6 +6,14 @@ module Effective
 
     log_changes(to: :chat) if respond_to?(:log_changes)
 
+    has_many_attached :files
+
+    validate do
+      if attachment_changes['files'].present? && !EffectiveMessaging.chat_attachments_enabled
+        errors.add(:files, 'are disabled for chats')
+      end
+    end
+
     belongs_to :chat, counter_cache: true
 
     # Who sent this message
@@ -43,6 +51,5 @@ module Effective
     def truncate(value)
       value.length > 100 ? (value.first(100) + '...') : value
     end
-
   end
 end

data/app/models/effective/chat_user.rb

@@ -9,7 +9,7 @@ module Effective
     belongs_to :chat
     belongs_to :user, polymorphic: true
 
-    scope :with_name, -> (name) {
+    scope :with_name, ->(name) {
       anonymous = where(chat_id: Chat.where(anonymous: true)).where('anonymous_name ILIKE ?', "%#{name}%")
       displayed = where(chat_id: Chat.where(anonymous: false)).where('display_name ILIKE ?', "%#{name}%")
 
@@ -43,6 +43,5 @@ module Effective
     def name
       chat&.anonymous? ? anonymous_name : display_name
     end
-
   end
 end

data/app/models/effective/notification.rb

@@ -38,7 +38,7 @@ module Effective
 
     # TODO: ['Send once', 'Send daily', 'Send weekly', 'Send monthly', 'Send quarterly', 'Send yearly', 'Send now']
     SCHEDULED_METHODS = [
-      ['The following dates...', 'dates'],
+      ['The following dates...', 'dates']
     ]
 
     CONTENT_TYPES = ['text/plain', 'text/html']
@@ -208,6 +208,65 @@ module Effective
       report.collection().select { |resource| notifiable_tomorrow?(resource) }.count if report
     end
 
+    # Read-only forecast using the same eligibility checks as the sender.
+    # A completed immediate course applies to the current report recipients only.
+    def delivery_status(date: Time.zone.today)
+      return { status: :disabled, next_on: nil } unless enabled?
+
+      date = date.to_date
+      logs = notification_logs.to_a
+      result = { next_on: nil, last_sent_on: logs.reject(&:skipped?).map { |log| log.created_at&.to_date }.compact.max }
+      dates = nil
+
+      if scheduled?
+        dates = scheduled_dates.map { |value| Date.iso8601(value) rescue nil }.compact.uniq.sort
+          .select { |day| day >= date && notifiable_scheduled?(date: day) }
+        result[:next_scheduled_on] = dates.first
+        return result.merge(status: :finished) if dates.empty?
+
+        # These send once to the configured addresses, regardless of report membership.
+        # The sender does not deduplicate repeated task runs on the same scheduled day.
+        if scheduled_email?
+          status = dates.first == date ? :due : :scheduled
+          result[:sent_today] = result[:last_sent_on] == date
+          return result.merge(status: status, next_on: dates.first)
+        end
+      end
+
+      recipients = report.collection.find_each.group_by { |resource| resource_emails_to_s(resource) }
+      missing = recipients.delete(nil).to_a.size
+      logs_by_email = logs.group_by(&:email)
+      pending_dates = []
+      completed = blocked = 0
+
+      recipients.each do |email, resources|
+        # Duplicate email keys share a course; prefer a row without delivery errors.
+        resource = resources.find { |row| !email_delivery_error?(row) } || resources.first
+        next_on = next_delivery_on(resource, date: date, logs: logs_by_email.fetch(email, []), dates: dates)
+        if next_on.nil?
+          completed += 1
+        elsif email_delivery_error?(resource)
+          blocked += 1
+        else
+          pending_dates << next_on
+        end
+      end
+
+      next_on = pending_dates.min
+      status = if next_on
+        next_on == date ? :due : :scheduled
+      elsif blocked > 0 || missing > 0
+        :blocked
+      elsif completed > 0
+        :complete
+      else
+        :waiting
+      end
+
+      result.merge(status: status, next_on: next_on, pending_count: pending_dates.length,
+        completed_count: completed, blocked_count: blocked, missing_email_count: missing)
+    end
+
     def enable!
       update!(enabled: true)
     end
@@ -327,11 +386,12 @@ module Effective
       notified > 0 ? update!(last_notified_at: Time.zone.now, last_notified_count: notified) : touch
     end
 
-    def notifiable?(resource, date: nil)
+    # Forecasts can supply logs already filtered to the resource's email key.
+    def notifiable?(resource, date: nil, logs: nil)
       raise('expected an acts_as_reportable resource') unless resource.class.try(:acts_as_reportable?)
 
       if schedule_type == 'immediate'
-        notifiable_immediate?(resource: resource, date: date)
+        notifiable_immediate?(resource: resource, date: date, logs: logs)
       elsif schedule_type == 'scheduled'
         notifiable_scheduled?(date: date)
       else
@@ -357,13 +417,13 @@ module Effective
 
     # 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:, date: nil)
+    def notifiable_immediate?(resource:, date: nil, logs: nil)
       raise('expected an immediate? notification') unless immediate?
 
       email = resource_emails_to_s(resource)
       return false if email.blank?
 
-      logs = notification_logs.select { |log| log.email == email }
+      logs ||= notification_logs.select { |log| log.email == email }
 
       if logs.count == 0
         true # This is the first time. We should send.
@@ -425,6 +485,17 @@ module Effective
 
     private
 
+    def next_delivery_on(resource, date:, logs:, dates:)
+      unless dates
+        last_on = logs.map { |log| log.created_at&.to_date || date }.max
+        dates = [last_on ? [date, last_on + immediate_days].max : date]
+      end
+
+      dates.find do |day|
+        notifiable?(resource, date: day, logs: logs) && logs.none? { |log| log.created_at&.to_date == day }
+      end
+    end
+
     def audience_emails_to_s
       audience_emails.presence&.join(', ')
     end
@@ -466,6 +537,5 @@ module Effective
 
       resource.public_send(column.name)
     end
-
   end
 end

data/app/models/effective/notification_log.rb

@@ -30,6 +30,5 @@ module Effective
       now = (date || Time.zone.now).to_date
       (now - (created_at&.to_date || now)).to_i
     end
-
   end
 end

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

@@ -7,5 +7,5 @@
       = render_inline_datatable(Admin::EffectiveChatMessagesDatatable.new(chat: chat))
 
     - if chat.respond_to?(:logs_datatable)
-      = tab "Logs" do
+      = tab "Logs", lazy: true do
         = render_inline_datatable(chat.logs_datatable)

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

@@ -7,5 +7,5 @@
       - datatable = Admin::EffectiveNotificationLogsDatatable.new(notification: notification)
       = render_inline_datatable(datatable)
 
-    = tab 'Logs' do
+    = tab 'Logs', lazy: true do
       = render_inline_datatable(notification.logs_datatable)

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

@@ -7,5 +7,5 @@
       - datatable = Admin::EffectiveNotificationLogsDatatable.new(notification: notification)
       = render_inline_datatable(datatable)
 
-    = tab 'Logs' do
+    = tab 'Logs', lazy: true do
       = render_inline_datatable(notification.logs_datatable)

data/app/views/effective/chats/_chat_message.html.haml

@@ -7,3 +7,6 @@
         .col.text-right= chat_message.created_at.strftime("%b %e, %Y %k:%M")
     .card-body
       = simple_format(chat_message.body)
+      - if EffectiveMessaging.chat_attachments_enabled
+        - chat_message.files.each do |file|
+          %p= link_to file.filename.to_s, effective_messaging.download_chat_path(chat_message.chat, chat_message_id: chat_message.id, file_id: file.id)

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

@@ -14,5 +14,7 @@
       = f.fields_for :chat_messages, chat_message do |fcm|
         - # The user and name are set by controller's current_user
         = fcm.text_area :body, required: true, label: 'Message'
+        - if EffectiveMessaging.chat_attachments_enabled
+          = fcm.file_field :files, label: 'Documents'
 
       = f.submit et('effective_messaging.send'), border: false

data/config/effective_messaging.rb

@@ -1,10 +1,13 @@
 EffectiveMessaging.setup do |config|
+  # Allow documents on chat messages. Disabled unless explicitly enabled.
+  config.chat_attachments_enabled = false
+
   # Layout Settings
   # Configure the Layout per controller, or all at once
   # config.layout = { application: 'application', admin: 'admin' }
 
   # Mailer Settings
-  # Please see config/initializers/effective_messaging.rb for default effective_* gem mailer settings
+  # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
   #
   # Configure the class responsible to send e-mails.
   # config.mailer = 'Effective::MessagingMailer'
@@ -18,5 +21,4 @@ EffectiveMessaging.setup do |config|
   # config.mailer_froms = nil       # Default Froms collection
   # config.mailer_admin = nil       # Default To value for Admin correspondence
   # config.mailer_subject = nil     # Proc.new method used to customize Subject
-
 end

data/config/routes.rb

@@ -7,7 +7,9 @@ end
 EffectiveMessaging::Engine.routes.draw do
   # Public routes
   scope module: 'effective' do
-    resources :chats, only: [:show, :update]
+    resources :chats, only: [:show, :update] do
+      get :download, on: :member
+    end
   end
 
   namespace :admin do
@@ -24,5 +26,4 @@ EffectiveMessaging::Engine.routes.draw do
 
     resources :notification_logs, only: [:index, :destroy]
   end
-
 end

data/db/migrate/101_create_effective_messaging.rb

@@ -92,6 +92,5 @@ class CreateEffectiveMessaging < ActiveRecord::Migration[6.0]
 
       t.timestamps
     end
-
   end
 end

data/lib/effective_messaging/engine.rb

@@ -14,6 +14,5 @@ module EffectiveMessaging
         ActiveRecord::Base.extend(EffectiveMessagingUser::Base)
       end
     end
-
   end
 end

data/lib/effective_messaging/version.rb

@@ -1,3 +1,3 @@
 module EffectiveMessaging
-  VERSION = '0.12.3'.freeze
+  VERSION = '0.13.0'.freeze
 end

data/lib/effective_messaging.rb

@@ -4,11 +4,10 @@ require 'effective_messaging/engine'
 require 'effective_messaging/version'
 
 module EffectiveMessaging
-
   def self.config_keys
     [
       :chats_table_name, :chat_users_table_name, :chat_messages_table_name, :notifications_table_name, :notification_logs_table_name,
-      :layout,
+      :layout, :chat_attachments_enabled,
       :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_froms, :mailer_admin, :mailer_subject
     ]
   end
@@ -22,5 +21,4 @@ module EffectiveMessaging
   def self.Notification
     Effective::Notification
   end
-
 end

data/lib/generators/effective_messaging/install_generator.rb

@@ -22,7 +22,6 @@ module EffectiveMessaging
       def create_migration_file
         migration_template ('../' * 3) + 'db/migrate/101_create_effective_messaging.rb', 'db/migrate/create_effective_messaging.rb'
       end
-
     end
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: effective_messaging
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.13.0
 platform: ruby
 authors:
 - Code and Effect
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -276,7 +275,6 @@ homepage: https://github.com/code-and-effect/effective_messaging
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -291,8 +289,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 4.0.17
 specification_version: 4
 summary: Centralize the communication between one or more users.
 test_files: []