effective_cpd 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814bc46856da481c1463852a7bcf2070e48fb494fd107f28e11385b8e4c6a4a5
-  data.tar.gz: e304434f2182696dcd63a7ccefb8f06191230ec023988950c3efca2f74ccf23d
+  metadata.gz: 9940c548d939b8c1a285db0e19877bd4ed2147001fbebc947aaf6e02d548def6
+  data.tar.gz: 0547a9982f49587cbe07f2d3b65b6ab0da31be1728d7a55541cebd48cb560dde
 SHA512:
-  metadata.gz: d691015664b852d423d7dffe069b3ce96a3ad966918034cb1313325bcc0665a4a05b3bef44d205beccf0223cbc25429f0b806109f65579d62b13feddeed7c165
-  data.tar.gz: 732028a6c199f87be5e9cb3934ae9ba87b1d8a56b142ea2adddbec68f29b914535d79fe2a84e5603f402976dc4877dd46b0b5eecb5f56ccefc9cf735388907ba
+  metadata.gz: bc621cc69009ae0a6629d11f07b8fcabcbf9aafe011649b441d096e90754938104b24c5633b0b7374f298b005d4e558a2f6ebcdca1c19b2b442883d4a7e3e018
+  data.tar.gz: dca45ea584ab120514a7fb2d4231d2d19bcd373f84066e16ad57af2d05b46e605e7692d22e6e18c46913a3af233022dbac597672cacf337d7d350e80ae0b9030

data/app/mailers/effective/cpd_mailer.rb

@@ -1,122 +1,194 @@
 module Effective
   class CpdMailer < EffectiveCpd.parent_mailer_class
-    default from: -> { EffectiveCpd.mailer_sender }
-    layout -> { EffectiveCpd.mailer_layout || 'effective_cpd_mailer_layout' }
+
+    include EffectiveMailer
+    include EffectiveEmailTemplatesMailer if EffectiveCpd.use_effective_email_templates
 
     # CPD Audit
-    def cpd_audit_opened(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.cpd_audit_url(cpd_audit))
+    def cpd_audit_opened(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Opened', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: cpd_audit.user.email, **headers_for(cpd_audit, opts))
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    def cpd_audit_conflicted(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.edit_admin_cpd_audit_url(cpd_audit))
+    def cpd_audit_conflicted(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.edit_admin_cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Conflicted', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: EffectiveCpd.mailer_admin, **headers_for(cpd_audit, opts))
+      mail(to: mailer_admin, subject: subject, **headers)
     end
 
-    def cpd_audit_conflict_resolved(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.cpd_audit_url(cpd_audit))
+    def cpd_audit_conflict_resolved(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
 
-      mail(to: cpd_audit.user.email, **headers_for(cpd_audit, opts))
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Conflict Resolved', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    def cpd_audit_exemption_request(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.edit_admin_cpd_audit_url(cpd_audit))
+    def cpd_audit_exemption_request(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.edit_admin_cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Exemption Request', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: EffectiveCpd.mailer_admin, **headers_for(cpd_audit, opts))
+      mail(to: mailer_admin, subject: subject, **headers)
     end
 
-    def cpd_audit_exemption_denied(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.cpd_audit_url(cpd_audit))
+    def cpd_audit_exemption_denied(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
 
-      mail(to: cpd_audit.user.email, **headers_for(cpd_audit, opts))
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Exemption Denied', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    def cpd_audit_exemption_granted(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.cpd_audit_url(cpd_audit))
+    def cpd_audit_exemption_granted(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Exemption Granted', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: cpd_audit.user.email, **headers_for(cpd_audit, opts))
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    def cpd_audit_extension_request(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.edit_admin_cpd_audit_url(cpd_audit))
+    def cpd_audit_extension_request(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
 
-      mail(to: EffectiveCpd.mailer_admin, **headers_for(cpd_audit, opts))
+      @assigns = assigns_for(resource).merge(url: effective_cpd.edit_admin_cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Extension Request', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: mailer_admin, subject: subject, **headers)
     end
 
-    def cpd_audit_extension_denied(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.cpd_audit_url(cpd_audit))
+    def cpd_audit_extension_denied(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Extension Denied', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: cpd_audit.user.email, **headers_for(cpd_audit, opts))
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    def cpd_audit_extension_granted(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.cpd_audit_url(cpd_audit))
+    def cpd_audit_extension_granted(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
 
-      mail(to: cpd_audit.user.email, **headers_for(cpd_audit, opts))
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Extension Granted', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    def cpd_audit_submitted(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.edit_admin_cpd_audit_url(cpd_audit))
+    def cpd_audit_submitted(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.edit_admin_cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Submitted', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: EffectiveCpd.mailer_admin, **headers_for(cpd_audit, opts))
+      mail(to: mailer_admin, subject: subject, **headers)
     end
 
-    def cpd_audit_reviewed(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.edit_admin_cpd_audit_url(cpd_audit))
+    def cpd_audit_reviewed(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
 
-      mail(to: EffectiveCpd.mailer_admin, **headers_for(cpd_audit, opts))
+      @assigns = assigns_for(resource).merge(url: effective_cpd.edit_admin_cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Reviewed', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: mailer_admin, subject: subject, **headers)
     end
 
-    def cpd_audit_closed(cpd_audit, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit)
-      @assigns.merge!(url: effective_cpd.cpd_audit_url(cpd_audit))
+    def cpd_audit_closed(resource, opts = {})
+      raise('expected an Effective::CpdAudit') unless resource.kind_of?(Effective::CpdAudit)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_url(resource))
+      @cpd_audit = resource
+
+      subject = subject_for(__method__, 'CPD Audit Closed', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: cpd_audit.user.email, **headers_for(cpd_audit, opts))
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
     # CPD Audit Review
-    def cpd_audit_review_opened(cpd_audit_review, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit_review)
-      @assigns.merge!(url: effective_cpd.cpd_audit_review_url(cpd_audit_review))
+    def cpd_audit_review_opened(resource, opts = {})
+      raise('expected an Effective::CpdAuditReview') unless resource.kind_of?(Effective::CpdAuditReview)
 
-      mail(to: cpd_audit_review.user.email, **headers_for(cpd_audit_review, opts))
-    end
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_review_url(resource))
+      @cpd_audit_review = resource
 
-    def cpd_audit_review_ready(cpd_audit_review, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit_review)
-      @assigns.merge!(url: effective_cpd.cpd_audit_review_url(cpd_audit_review))
+      subject = subject_for(__method__, 'CPD Audit Review Opened', resource, opts)
+      headers = headers_for(resource, opts)
 
-      mail(to: cpd_audit_review.user.email, **headers_for(cpd_audit_review, opts))
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    def cpd_audit_review_submitted(cpd_audit_review, opts = {})
-      @assigns = effective_cpd_email_assigns(cpd_audit_review)
-      @assigns.merge!(url: effective_cpd.edit_admin_cpd_audit_url(cpd_audit_review.cpd_audit))
+    def cpd_audit_review_ready(resource, opts = {})
+      raise('expected an Effective::CpdAuditReview') unless resource.kind_of?(Effective::CpdAuditReview)
+
+      @assigns = assigns_for(resource).merge(url: effective_cpd.cpd_audit_review_url(resource))
+      @cpd_audit_review = resource
 
-      mail(to: EffectiveCpd.mailer_admin, **headers_for(cpd_audit_review, opts))
+      subject = subject_for(__method__, 'CPD Audit Review Ready', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: resource.user.email, subject: subject, **headers)
     end
 
-    protected
+    def cpd_audit_review_submitted(resource, opts = {})
+      raise('expected an Effective::CpdAuditReview') unless resource.kind_of?(Effective::CpdAuditReview)
 
-    def headers_for(resource, opts = {})
-      resource.respond_to?(:log_changes_datatable) ? opts.merge(log: resource) : opts
+      @assigns = assigns_for(resource).merge(url: effective_cpd.edit_admin_cpd_audit_url(resource.cpd_audit))
+      @cpd_audit_review = resource
+
+      subject = subject_for(__method__, 'CPD Audit Review Submitted', resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: mailer_admin, subject: subject, **headers)
     end
 
-    def effective_cpd_email_assigns(resource)
+    protected
+
+    def assigns_for(resource)
       unless resource.kind_of?(Effective::CpdAudit) || resource.kind_of?(Effective::CpdAuditReview)
         raise('expected an Effective::CpdAudit or Effective::CpdAuditReview')
       end

data/config/effective_cpd.rb

@@ -42,27 +42,21 @@ EffectiveCpd.setup do |config|
   # Audit Reviewer Scope Collection
   config.audit_reviewer_user_scope = :all
 
-  # Mailer Configuration
+  # 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::CpdMailer'
-
-  # Configure the parent class responsible to send e-mails.
-  # config.parent_mailer = 'ActionMailer::Base'
-
-  # Default deliver method
-  # config.deliver_method = :deliver_later
-
-  # Default layout
-  config.mailer_layout = 'effective_cpd_mailer_layout'
-
-  # Default From
-  config.mailer_sender = "no-reply@example.com"
-
-  # Send Admin correspondence To
-  config.mailer_admin = "admin@example.com"
-
-  # Will work with effective_email_templates gem:
-  # - The audit and audit review email content will be preopulated based off the template
-  # - Uses an EmailTemplatesMailer mailer instead of ActionMailer::Base for default parent_mailer
-  config.use_effective_email_templates = false
+  # config.mailer = 'Effective::EventsMailer'
+  #
+  # Override effective_resource mailer defaults
+  #
+  # config.parent_mailer = nil      # The parent class responsible for sending emails
+  # config.deliver_method = nil     # The deliver method, deliver_later or deliver_now
+  # config.mailer_layout = nil      # Default mailer layout
+  # config.mailer_sender = nil      # Default From value
+  # config.mailer_admin = nil       # Default To value for Admin correspondence
+  # config.mailer_subject = nil     # Proc.new method used to customize Subject
+
+  # Use effective email templates for event notifications
+  config.use_effective_email_templates = true
 end

data/lib/effective_cpd/version.rb

@@ -1,3 +1,3 @@
 module EffectiveCpd
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/effective_cpd.rb

@@ -15,43 +15,14 @@ module EffectiveCpd
       :cpd_audits_table_name, :cpd_audit_responses_table_name, :cpd_audit_response_options_table_name,
       :cpd_audit_reviews_table_name, :cpd_audit_review_items_table_name,
       :cycle_label, :credit_label, :layout, :auditee_user_scope, :audit_reviewer_user_scope,
-      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :use_effective_email_templates
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject, :use_effective_email_templates
     ]
   end
 
   include EffectiveGem
 
   def self.mailer_class
-    return mailer.constantize if mailer.present?
-    Effective::CpdMailer
-  end
-
-  def self.parent_mailer_class
-    return parent_mailer.constantize if parent_mailer.present?
-
-    if use_effective_email_templates
-      require 'effective_email_templates'
-      Effective::EmailTemplatesMailer
-    else
-      ActionMailer::Base
-    end
-  end
-
-  def self.send_email(email, *args)
-    raise('expected args to be an Array') unless args.kind_of?(Array)
-
-    if defined?(Tenant)
-      tenant = Tenant.current || raise('expected a current tenant')
-      args << { tenant: tenant }
-    end
-
-    deliver_method = EffectiveCpd.deliver_method || EffectiveResources.deliver_method
-
-    begin
-      EffectiveCpd.mailer_class.send(email, *args).send(deliver_method)
-    rescue => e
-      raise if Rails.env.development? || Rails.env.test?
-    end
+    mailer&.constantize || Effective::CpdMailer
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_cpd
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -364,7 +364,6 @@ files:
 - app/views/effective/cpd_statements/complete.html.haml
 - app/views/effective/cpd_statements/start.html.haml
 - app/views/effective/cpd_statements/submit.html.haml
-- app/views/layouts/effective_cpd_mailer_layout.html.haml
 - config/effective_cpd.rb
 - config/routes.rb
 - db/migrate/01_create_effective_cpd.rb.erb

data/app/views/layouts/effective_cpd_mailer_layout.html.haml

@@ -1,7 +0,0 @@
-!!!
-%html{style: 'background: #fff;'}
-  %head
-    %meta{:content => 'text/html; charset=UTF-8', 'http-equiv' => 'Content-Type'}
-
-  %body{style: 'background: #fff;'}
-    = yield