effective_postmark 0.1.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa5fb599ef1e178681b95d7853d6215ea51446851e6ea2fed4087b3927a6832f
-  data.tar.gz: 804b2ffcd11bc5f6a20df339b0ab4aa4bb5d3370eff443fbf807e71262846a6e
+  metadata.gz: 3c865f268155269e90bfab82beaca405a2adfed8b20c7156214f5b95574986c3
+  data.tar.gz: 183783ce5068b9b1abfdba98551d1a812a070f414a56f0fe787826a0855dd680
 SHA512:
-  metadata.gz: dbe67ada0c62f056d6b1c8c5a373cee8470f7ad811409b4c25c5026a37ef66e0c879b1b9efd3386191f1ed8b565bb380228ea2e1feee9c5dd5f69ce37c5d4d68
-  data.tar.gz: 68f60078392756c29eefe54e43ecdd8e437d7b885b1ec3c3f101c641228d73a9cddd091a0c158537a7bec4797d676e0c876b5299e90e1c25ea26d46517863857
+  metadata.gz: d927becf5cb36887f8a3093975e6b5cf543d9fe34d73fa11900372ec9807d484a5b40ae7e7d7e5ed30fb3e01f702f765b582a038526d8151309e965c674694db
+  data.tar.gz: bf2041254c685af6d7c2dbe5f64c2ba3ecf9ae62a5fbee7dd0fafe319992361a8842fbe2a19b2f2cf746d1691050f1b5feaaca92ec75ac1f036a9617575b7d65

data/README.md

@@ -38,8 +38,8 @@ And add two database fields to your user model:
 ```ruby
 class AddEffectivePostmarkFieldsToUsers < ActiveRecord::Migration[7.0]
   def change
-    add_column :users, :postmark_error, :string
-    add_column :users, :postmark_error_at, :datetime
+    add_column :users, :email_delivery_error, :string
+    add_column :users, :email_delivery_error_at, :datetime
   end
 end
 ```
@@ -73,9 +73,9 @@ If you want to include the inactive alert on the devise reset password page:
 ```ruby
 class Users::PasswordsController < Devise::PasswordsController
   after_action(only: :create) do
-    if resource.try(:postmark_invalid?)
+    if resource.email_delivery_error.present?
       flash.delete(:notice)
-      flash[:danger] = view_context.effective_postmark_alert(resource, from: 'MyARTA', html_class: '')
+      flash[:danger] = view_context.effective_postmark_alert(resource, from: 'My Site', html_class: '')
     end
   end
 end
@@ -86,7 +86,7 @@ end
 Add a link to the admin report:
 
 ```ruby
-= nav_link_to 'Inactive Recipients', effective_postmark.inactive_recipients_admin_postmark_reports_path
+= nav_link_to 'Email Delivery Errors', effective_postmark.email_delivery_errors_admin_postmark_reports_path
 ```
 
 ### Permissions
@@ -95,8 +95,8 @@ Give the following permissions to your admin user:
 
 ```ruby
 can :admin, :effective_postmark
-can(:postmark_reactivate, User) { |user| user.postmark_invalid? }
-can(:index, Admin::ReportInactiveRecipientsDatatable)
+can(:postmark_reactivate, User) { |user| user.email_delivery_error.present? }
+can(:index, Admin::ReportEmailDeliveryErrorsDatatable)
 ```
 
 ## License

data/app/controllers/admin/postmark_reports_controller.rb

@@ -3,8 +3,10 @@ module Admin
     before_action(:authenticate_user!) if defined?(Devise)
     before_action { EffectiveResources.authorize!(self, :admin, :effective_postmark) }
 
-    def inactive_recipients
-      @datatable = Admin::ReportInactiveRecipientsDatatable.new
+    include Effective::CrudController
+
+    def email_delivery_errors
+      @datatable = Admin::ReportEmailDeliveryErrorsDatatable.new
       @page_title = @datatable.datatable_name
 
       authorize! :index, @datatable

data/app/datatables/admin/{report_inactive_recipients_datatable.rb → report_email_delivery_errors_datatable.rb}

@@ -1,7 +1,6 @@
 # Postmark: Inactive Recipients
-
 module Admin
-  class ReportInactiveRecipientsDatatable < Effective::Datatable
+  class ReportEmailDeliveryErrorsDatatable < Effective::Datatable
     datatable do
       col :id, visible: false
 
@@ -16,8 +15,8 @@ module Admin
       col :first_name, visible: false
       col :last_name, visible: false
 
-      col :postmark_error
-      col :postmark_error_at
+      col :email_delivery_error
+      col :email_delivery_error_at
 
       actions_col(actions: []) do |user|
         dropdown_link_to('Reactivate', effective_postmark.postmark_reactivate_admin_postmark_path(user), remote: true, method: :post)
@@ -26,7 +25,7 @@ module Admin
     end
 
     collection do
-      current_user.class.postmark_inactive_recipients
+      current_user.class.with_email_delivery_errors
     end
   end
 end

data/app/helpers/effective_postmark_helper.rb

@@ -1,9 +1,9 @@
 module EffectivePostmarkHelper
 
   # For use on the regular user alerts and forgot password pages
-  def effective_postmark_alert(user, from: nil, html_class: 'alert alert-danger')
+  def effective_postmark_alert(user, from: nil, html_class: 'alert alert-danger mb-4')
     raise('expected an effective_postmark_user') unless user.class.try(:effective_postmark_user?)
-    return unless user.postmark_invalid?
+    return unless user.email_delivery_error.present?
 
     content_tag(:div, class: html_class) do
       [
@@ -19,9 +19,9 @@ module EffectivePostmarkHelper
   end
 
   # For use on the admin/users#edit page
-  def effective_postmark_admin_alert(user, from: nil, html_class: 'alert alert-danger')
+  def effective_postmark_admin_alert(user, from: nil, html_class: 'alert alert-danger mb-4')
     raise('expected an effective_postmark_user') unless user.class.try(:effective_postmark_user?)
-    return unless user.postmark_invalid?
+    return unless user.email_delivery_error.present?
 
     content_tag(:div, class: html_class) do
       [
@@ -29,7 +29,7 @@ module EffectivePostmarkHelper
         "They will not receive any emails",
         ("from #{from}" if from),
         "while inactive.",
-        "Please update their email address, or" +
+        "Please update their email address, or " +
         link_to('reactivate their email', effective_postmark.postmark_reactivate_admin_postmark_path(user), 'data-method': :post),
         "and automatically attempt an email delivery."
       ].compact.join(' ').html_safe

data/app/models/concerns/effective_postmark_user.rb

@@ -15,15 +15,16 @@ module EffectivePostmarkUser
 
   included do
     effective_resource do
-      postmark_error      :string
-      postmark_error_at   :datetime
+      email_delivery_error      :string
+      email_delivery_error_at   :datetime
     end
 
-    before_validation(if: -> { email_changed? && postmark_invalid? }) do
-      assign_attributes(postmark_error: nil, postmark_error_at: nil)
+    # Clear any email errors if they change their email
+    before_validation(if: -> { email_changed? && email_delivery_error.present? }) do
+      assign_attributes(email_delivery_error: nil, email_delivery_error_at: nil)
     end
 
-    scope :postmark_inactive_recipients, -> { where.not(postmark_error_at: nil) }
+    scope :with_email_delivery_errors, -> { where.not(email_delivery_error: nil) }
   end
 
   module ClassMethods
@@ -32,9 +33,9 @@ module EffectivePostmarkUser
 
   # Triggered by the EffectivePostmarkMailer concern when a Postmark::InactiveRecipientError is raised
   def postmark_inactive_recipient!
-    return unless postmark_valid? # If we already marked invalid, don't mark again
+    return if email_delivery_error.present? # If we already marked invalid, don't mark again
 
-    update_columns(postmark_error: 'Inactive Recipient', postmark_error_at: Time.zone.now)
+    update_columns(email_delivery_error: 'Inactive Recipient', email_delivery_error_at: Time.zone.now)
   end
 
   # Triggered by an admin to reactivate the email address
@@ -48,15 +49,7 @@ module EffectivePostmarkUser
     return false if message.kind_of?(Exception)
 
     # This worked. We've been reactivated. Clear the error
-    update_columns(postmark_error: nil, postmark_error_at: nil)
-  end
-
-  def postmark_valid?
-    postmark_error.blank?
-  end
-
-  def postmark_invalid?
-    postmark_error.present?
+    update_columns(email_delivery_error: nil, email_delivery_error_at: nil)
   end
 
 end

data/app/views/admin/postmark_reports/index.html.haml

@@ -0,0 +1,4 @@
+%h1.effective-admin-heading= @page_title
+
+= card do
+  = render_datatable(@datatable)

data/config/effective_postmark.rb

@@ -10,7 +10,7 @@ EffectivePostmark.setup do |config|
   # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
   #
   # Configure the class responsible to send e-mails.
-  # config.mailer = 'Effective::ClassifiedsMailer'
+  # config.mailer = 'Effective::PostmarkMailer'
   #
   # Override effective_resource mailer defaults
   #

data/config/locales/effective_postmark.en.yml

@@ -0,0 +1,8 @@
+en:
+  effective_postmark:
+    name: 'Effective Postmark'
+    acronym: 'Postmark'
+
+  datatables:
+    admin/report_email_delivery_errors_datatable: 'Report: Email Delivery Errors'
+

data/config/routes.rb

@@ -6,7 +6,7 @@ EffectivePostmark::Engine.routes.draw do
 
     resources :postmark_reports, only: [] do
       collection do
-        get :inactive_recipients
+        get :email_delivery_errors
       end
     end
   end

data/lib/effective_postmark/version.rb

@@ -1,3 +1,3 @@
 module EffectivePostmark
-  VERSION = '0.1.3'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_postmark
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-13 00:00:00.000000000 Z
+date: 2024-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -218,14 +218,16 @@ files:
 - README.md
 - app/controllers/admin/postmark_controller.rb
 - app/controllers/admin/postmark_reports_controller.rb
-- app/datatables/admin/report_inactive_recipients_datatable.rb
+- app/datatables/admin/report_email_delivery_errors_datatable.rb
 - app/helpers/effective_postmark_helper.rb
 - app/mailers/concerns/effective_postmark_mailer.rb
 - app/mailers/effective/postmark_mailer.rb
 - app/models/concerns/effective_postmark_user.rb
 - app/models/effective/postmark_api.rb
+- app/views/admin/postmark_reports/index.html.haml
 - app/views/effective/postmark_mailer/reactivated.html.haml
 - config/effective_postmark.rb
+- config/locales/effective_postmark.en.yml
 - config/routes.rb
 - db/migrate/101_create_effective_postmark.rb
 - db/seeds.rb