web47core 2.2.18 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2634a258267965ef476e8d35fa47a04ab43e0dcb0690d12496cdd1155b8c9c86
-  data.tar.gz: a1f897abb8a68208537fd18d25f460ce2ec48156e05993d3b2627f46dcd462c7
+  metadata.gz: 7147715aefdef70511603bf5ddb8afa017da40ef51c54d4c14e10edd7c15d21d
+  data.tar.gz: 0fca6d931d158a0900121ed7f22983fc13322375fc1e3acccd18fd2062a2cdfe
 SHA512:
-  metadata.gz: be313d46de430a646d0d0e847ab32a865a11b3c34455da3a6a327ee598680cde337e99e280506f507e07fe1a7a4cba57e9542d830107245ef5252643f1a411f0
-  data.tar.gz: d024aafb910e644fffd3ac4615d30968703ad3d8a9b270f64f4e52f91f4dc6f0ebab9812781043dd346ae816035a7162764afa7478fb677469be1c663cf71b7e
+  metadata.gz: 05d7ded51da1a605dadd22666a988a2cd77dea9c320a187fa57ab7259d345a1f9910fdf31d674b8b0dac511895f721313e3ef068e0be9b7ae745b37b426fb122
+  data.tar.gz: ffc6a842ae0142f3cd4c0ba63813e4fb685a21208a84aba45a79dd5fe9b65507f6318ffdb6b74a81d28fdca8b06cccde584df7fea7fa1cd647b776e4a84654a8

data/lib/app/models/concerns/aws_configuration.rb

@@ -40,15 +40,18 @@ module AwsConfiguration
     aws_configured? && aws_auto_scaling_group_name.present?
   end
 
+  def aws_credentials
+    @aws_credentials ||= Aws::Credentials.new(aws_access_key_id,
+                                              aws_secret_access_key)
+  end
+
   #
   # AWS client.
   #
   def aws_ec2_client
     return nil unless aws_configured?
 
-    @aws_ec2_client ||= Aws::EC2::Client.new(region: aws_region,
-                                             credentials: Aws::Credentials.new(aws_access_key_id,
-                                                                               aws_secret_access_key))
+    @aws_ec2_client ||= Aws::EC2::Client.new(region: aws_region, credentials: aws_credentials);
   end
 
   #

data/lib/app/models/concerns/core_system_configuration.rb

@@ -14,6 +14,11 @@
 #
 module CoreSystemConfiguration
   extend ActiveSupport::Concern
+  EMAIL_PROVIDER_SMTP_TYPE = 'smtp'.freeze unless defined? EMAIL_PROVIDER_SMTP_TYPE
+  EMAIL_PROVIDER_SES_TYPE = 'ses'.freeze unless defined? EMAIL_PROVIDER_SES_TYPE
+  unless defined? ALL_EMAIL_PROVIDER_TYPES
+    ALL_EMAIL_PROVIDER_TYPES = [EMAIL_PROVIDER_SMTP_TYPE, EMAIL_PROVIDER_SES_TYPE].freeze
+  end
 
   def self.included(base)
     base.class_eval do
@@ -30,6 +35,7 @@ module CoreSystemConfiguration
       field :short_cache, { type: Integer, default: 1 }
       field :medium_cache, { type: Integer, default: 5 }
       field :long_cache, { type: Integer, default: 15 }
+      field :stack_email_provider, type: String, default: EMAIL_PROVIDER_SMTP_TYPE
       # URLs
       field :base_url, type: String
       field :cdn_url, type: String
@@ -43,6 +49,7 @@ module CoreSystemConfiguration
       #
       validates :environment, presence: true, uniqueness: true
       validates :default_time_zone, presence: true
+      validates :stack_email_provider, inclusion: { in: ALL_EMAIL_PROVIDER_TYPES }
     end
     base.extend ClassMethods
   end
@@ -75,6 +82,14 @@ module CoreSystemConfiguration
     end
   end
 
+  def stack_ses_provider?
+    EMAIL_PROVIDER_SES_TYPE.eql?(stack_email_provider)
+  end
+
+  def stack_smtp_provider?
+    EMAIL_PROVIDER_SMTP_TYPE.eql?(stack_email_provider)
+  end
+
   #
   # Cache times in minutes
   #

data/lib/app/models/concerns/ses_configuration.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+#
+# AWS SES SSO Configuration
+#
+module SesConfiguration
+  extend ActiveSupport::Concern
+
+  def self.included(base)
+    base.class_eval do
+      #
+      # Fields
+      #
+      field :ses_source, type: String
+      field :ses_source_arn_prefix, type: String
+      field :ses_bounce_queue_name, type: String
+      field :ses_region, type: String
+    end
+  end
+
+  #
+  # Determine if AWS is configured
+  #
+  def ses_configured?
+    aws_configured? &&
+      ses_source.present? &&
+      ses_source_arn_prefix.present? &&
+      (ses_region.present? || aws_region.present?)
+  end
+
+  def ses_source_arn(source = ses_source)
+    [ses_source_arn_prefix, source].compact.join('/')
+  end
+
+  #
+  # SES Client
+  #
+  def aws_ses_client
+    return nil unless ses_configured?
+
+    # We want this to remake itself each time because it is possible that the
+    # => user would change the access keys in between actions. Huh?
+    @aws_ses_client ||= Aws::SES::Client.new(region: ses_region.presence || aws_region, credentials: aws_credentials)
+  end
+end

data/lib/app/models/email_notification.rb

@@ -36,60 +36,63 @@ class EmailNotification < Notification
   field :cc, type: String
   # The subject
   field :subject, type: String
+  field :message_id, type: String
   #
   # Validations
   #
   validates :subject, presence: true
   validates :to, presence: true
-
-  # has_many :attachments, class_name: 'EmailNotificationAttachment', dependent: :destroy
+  # Callbacks
+  before_save :ensure_headers
 
   def from_template(template_name, locals = {})
     super
     self.subject = subject_from_template(template_name, locals)
   end
 
-  #
-  # Add a file as an attachment to this email notification.
-  #
-  # Expecting a path to the file, not the file or data itself.
-  # TODO consider how to handle a file object or data object.
-  #
-  # Once you have called this method, the file is stored via PaperClip and
-  # does not need to stay persistant through email delivery.
-  # You can delete it after telling the EmailNotification to send
-  # the notification.
-  #
-  # def add_file(file)
-  #   # Make sure we are saved
-  #   save! unless persisted?
-  #   attachment = EmailNotificationAttachment.new email_notification: self
-  #   attachment.file = open(file)
-  #   attachment.save!
-  # end
   def deliver_message!
+    if account.present? && account.fetch_smtp_configuration.use?
+      deliver_smtp_message!
+    elsif SystemConfiguration.stack_smtp_provider?
+      deliver_smtp_message!
+    elsif SystemConfiguration.ses_configured?
+      deliver_ses_message!
+    else
+      fail "Invalid configuration in stack for sending emails"
+    end
+  end
+
+  def deliver_ses_message!
+    config = SystemConfiguration.configuration
+    client = config.aws_ses_client
+    payload = { destination: { to_addresses: [to] },
+                message: {
+                  body: { html: { data: build_message } },
+                  subject: { data: subject } },
+                source: from,
+                source_arn: config.ses_source_arn(from) }
+    payload[:reply_to_addresses] = [reply_to] if reply_to.present?
+    resp = client.send_email(payload)
+    self.message_id = resp[:message_id]
+  end
+
+  def deliver_smtp_message!
     mail = Mail.new
     # Set the from line
-    address = from_address
-    mail.from = address
-    self.from = address
+    mail.from = from
     # Set the sender line
-    address = sender_address
-    mail.sender = address
-    self.sender = address
+    mail.sender = sender
     # Set the reply to
-    address = reply_to_address
-    if address.present?
-      self.reply_to = address
-      mail.reply_to = address
-      mail.sender = address
+    if reply_to_address.present?
+      mail.reply_to = reply_to_address
+      mail.sender = reply_to_address
     end
 
     # Set the to address
     mail.to = to
 
     # Set the cc line
-    mail.cc = cc unless cc.nil?
+    mail.cc = cc if cc.present?
 
     # Set the subject line
     mail.subject = subject
@@ -101,9 +104,6 @@ class EmailNotification < Notification
       body html_message
     end
 
-    # Add the attachments, if there are any. If not, none are added.
-    add_attachments(attachments) if defined?(attachments)
-
     # Setup the delivery method for this message only.
     if 'test'.eql?(ENV['RAILS_ENV'])
       mail.delivery_method :test
@@ -121,19 +121,12 @@ class EmailNotification < Notification
     FileUtils.remove_entry_secure(tmp_dir) if defined?(tmp_dir) && tmp_dir.present?
   end
 
-  def add_attachments(attachments = nil)
-    tmp_dir = Dir.mktmpdir
-    attachments.each do |attachment|
-      # Create a temp directory, it'll get cleaned up in the rescue.
-      tmp_file_path = "#{tmp_dir}/#{attachment.file_file_name}"
-      File.open(tmp_file_path, 'w') do |f|
-        f.write(URI.parse(attachment.file_url).open.read.force_encoding('utf-16').encode)
-      end
-      mail.attachments[attachment.file_file_name] = {
-        mime_type: attachment.file_content_type,
-        content: File.open(tmp_file_path).read.force_encoding('utf-16').encode
-      }
-    end
+  # @abstract Ensure the headers of the message are set regardless if we are using
+  # ses or smtp
+  def ensure_headers
+    self.from = from_address
+    self.sender = sender_address
+    self.reply_to = reply_to_address
   end
 
   #

data/lib/web47core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Web47core
-  VERSION = '2.2.18'
+  VERSION = '2.3.0'
 end

data/lib/web47core.rb

@@ -10,6 +10,7 @@ require 'app/models/concerns/delayed_job_configuration'
 require 'app/models/concerns/email_able'
 require 'app/models/concerns/encrypted_password'
 require 'app/models/concerns/google_sso_configuration'
+require 'app/models/concerns/ses_configuration'
 require 'app/models/concerns/search_able'
 require 'app/models/concerns/role_able'
 require 'app/models/concerns/time_zone_able'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: web47core
 version: !ruby/object:Gem::Version
-  version: 2.2.18
+  version: 2.3.0
 platform: ruby
 authors:
 - Chris Schroeder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-17 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -58,6 +58,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-ses
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.55'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.55'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
@@ -767,6 +787,7 @@ files:
 - lib/app/models/concerns/search_able.rb
 - lib/app/models/concerns/secure_fields.rb
 - lib/app/models/concerns/server_process_able.rb
+- lib/app/models/concerns/ses_configuration.rb
 - lib/app/models/concerns/slack_configuration.rb
 - lib/app/models/concerns/standard_model.rb
 - lib/app/models/concerns/switchboard_able.rb