nuntius 0.1.1 → 1.0.27

data/app/services/nuntius/aws_sns_processor_service.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+###
+# Process feedback from the amazon mail delivery service. Feedback looks like this:
+#  {"Type"=>"Notification", "MessageId"=>"a00966b6-51a5-53f7-a966-35d0e8f878ce", "TopicArn"=>"arn:aws:sns:eu-west-1:218893591873:localexpress-email-feedback",
+#  "Message"=>"{\"notificationType\":\"Delivery\",\"mail\":{\"timestamp\":\"2018-05-04T19:40:12.637Z\",\"source\":\"do_not_reply@localexpress.nl\",\
+# "sourceArn\":\"arn:aws:ses:eu-west-1:218893591873:identity/localexpress.nl\",\"sourceIp\":\"52.59.100.253\",\"sendingAccountId\":\"218893591873\",
+# \"messageId\":\"010201632cab47dd-924f80f8-4ae2-4ba0-9c8b-050db003711a-000000\",\"destination\":[\"mercedes.tuin@gmail.com\"],
+# \"headersTruncated\":false,\"headers\":[{\"name\":\"Received\",\"value\":\"from localhost.localdomain (ec2-52-59-100-253.eu-central-1.compute.amazonaws.com [52.59.100.253]) by email-smtp.amazonaws.com with SMTP (SimpleEmailService-2762311919) id 4AtiQr5QXc6CZ3uJYW4D for mercedes.tuin@gmail.com; Fri, 04 May 2018 19:40:12 +0000 (UTC)\"},{\"nam
+#
+#
+
+# See: https://docs.aws.amazon.com/ses/latest/dg/notification-examples.html
+module Nuntius
+  class AwsSnsProcessorService < ApplicationService
+    context do
+      attribute :notification, typecaster: lambda { |value|
+                                             value.with_indifferent_access
+                                           }
+    end
+
+    def perform
+      if context.notification['Type'] == 'SubscriptionConfirmation'
+        Nuntius.config.logger.info('Confirming SNS subscription')
+        HTTPClient.get(body['SubscribeURL'])
+        return
+      end
+
+      type = context.notification['notificationType']
+
+      unless message_id
+        Nuntius.config.logger.warn("SNS / SES message could not determine message id: #{context.notification}")
+        return false
+      end
+      unless message
+        Nuntius.config.logger.warn("SNS / SES message for unknown message with message id: #{message_id}")
+        return false
+      end
+      Nuntius.config.logger.info("SNS /SES updating message #{message.id} for #{type}")
+
+      case type
+      when 'Delivery'
+        process_delivery
+      when 'Bounce'
+        process_bounce
+      when 'Complaint'
+        process_complaint
+      else
+        false
+      end
+    end
+
+    private
+
+    def process_delivery
+      message.status = :delivered
+      message.metadata[:feedback] = { 'type': 'delivery', 'info': context.notification['delivery'] }
+      message.save!
+    end
+
+    def process_bounce
+      message.status = :bounced
+      message.metadata[:feedback] = { 'type': 'bounce', 'info': context.notification['bounce'] }
+      message.save!
+    end
+
+    def process_complaint
+      message.status = :complaint
+      message.metadata[:feedback] = { 'type': 'complaint', 'info': context.notification['complaint'] }
+      message.save!
+    end
+
+    def message_id
+      @message_id ||= context.notification.dig('mail', 'commonHeaders', 'messageId')&.[](1...-1)
+    end
+
+    def message
+      @message ||= Nuntius::Message.find_by(provider_id: message_id)
+    end
+  end
+end

data/app/services/nuntius/deliver_inbound_message_service.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class DeliverInboundMessageService < ApplicationService
+    context do
+      attribute :inbound_message
+    end
+
+    def perform
+      context.inbound_message.update(status: 'delivered')
+      Nuntius::BaseMessageBox.deliver(context.inbound_message)
+    end
+  end
+end

data/app/services/nuntius/retrieve_inbound_mail_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class RetrieveInboundMailService < ApplicationService
+    context do
+      attribute :settings
+    end
+
+    def perform
+      Mail::IMAP.new(context.settings).all do |message, imap, uid|
+        inbound_message = Nuntius::InboundMessage.find_or_create_by!(transport: 'mail', provider: 'imap', provider_id: message.message_id,
+                                                                     digest: Digest::SHA256.hexdigest(message.to_s), status: 'pending')
+        inbound_message.from = message.from
+        inbound_message.to = message.to
+        inbound_message.text = message.body
+        # inbound_message.metadata = params
+        inbound_message.save!
+
+        if inbound_message.raw_message.attached?
+          if Digest::SHA256.hexdigest(message.to_s) == Digest::SHA256.hexdigest(inbound_message.raw_message.download)
+            # Only if we have an attachment and it's digest is the same as we find in the mailbox, delete!
+            # This never happens on the first round of fetching it.
+            imap.store(uid, '+FLAGS', [Net::IMAP::DELETED])
+            imap.expunge
+          end
+        else
+          si = StringIO.new
+          si.write(message.to_s)
+          si.rewind
+          inbound_message.raw_message.attach(io: si, filename: message.message_id)
+          Nuntius::ProcessInboundMessageJob.perform_later(inbound_message)
+        end
+      end
+    end
+  end
+end

data/app/tables/nuntius_campaigns_table.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+class NuntiusCampaignsTable < ActionTable::ActionTable
+  model Nuntius::Campaign
+
+  column(:name)
+  column(:metadata) { |campaign| Nuntius.config.metadata_humanize(campaign.metadata) }
+  column(:transport)
+  column(:state)
+  column(:list) { |campaign| campaign.list.name }
+
+  initial_order :name, :asc
+
+  row_link { |campaign| nuntius.edit_admin_campaign_path(campaign) }
+
+  private
+
+  def scope
+    @scope = Nuntius::Campaign.visible
+  end
+end

data/app/tables/nuntius_layouts_table.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class NuntiusLayoutsTable < ActionTable::ActionTable
+  model Nuntius::Layout
+
+  column(:name) { |layout| layout.name }
+  column(:metadata) { |layout| Nuntius.config.metadata_humanize(layout.metadata) }
+
+  column :actions, title: '', sortable: false do |layout|
+    content_tag(:span, class: 'btn-group btn-group-xs') do
+      concat link_to(content_tag(:i, nil, class: 'fa fa-trash'), nuntius.admin_layout_url(layout), data: { turbo_confirm: 'Are you sure you want to delete the layout?', turbo_method: :delete }, class: 'btn btn-xs btn-danger')
+    end
+  end
+
+  initial_order :name, :asc
+
+  row_link { |layout| nuntius.edit_admin_layout_path(layout) }
+
+  private
+
+  def scope
+    @scope = Nuntius::Layout.visible
+  end
+end

data/app/tables/nuntius_lists_table.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class NuntiusListsTable < ActionTable::ActionTable
+  model Nuntius::List
+
+  column(:name)
+  column(:metadata) { |list| Nuntius.config.metadata_humanize(list.metadata) }
+  column(:subscribers) { |list| list.subscribers.count || '-' }
+
+  initial_order :name, :asc
+
+  row_link { |list| nuntius.edit_admin_list_path(list) }
+
+  private
+
+  def scope
+    @scope = Nuntius::List.visible
+  end
+end

data/app/tables/nuntius_locales_table.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class NuntiusLocalesTable < ActionTable::ActionTable
+  model Nuntius::Locale
+
+  column(:key)
+  column(:metadata) { |locale| Nuntius.config.metadata_humanize(locale.metadata) }
+
+  initial_order :mkey, :asc
+
+  row_link { |locale| nuntius.edit_admin_locale_path(locale) }
+
+  private
+
+  def scope
+    @scope = Nuntius::Locale.visible
+  end
+end

data/app/tables/nuntius_messages_table.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class NuntiusMessagesTable < ActionTable::ActionTable
+  model Nuntius::Message
+
+  column(:to)
+  column(:created_at) { |message| ln(message.created_at) }
+  column(:last_sent_at) { |message| ln(message.last_sent_at) }
+  column(:origin) do |message|
+    link_to message.campaign&.name, nuntius.edit_admin_campaign_path(message.campaign) if message.campaign
+    link_to message.template&.description, nuntius.edit_admin_template_path(message.template) if message.template
+  end
+  column(:subject) do |message|
+    if message.nuntiable
+      link_to "#{message.nuntiable_type} [#{message.nuntiable}]", begin
+        url_for(message.nuntiable)
+      rescue StandardError
+        '#'
+      end
+    end
+  end
+  column(:status)
+
+  initial_order :created_at, :desc
+
+  row_link { |message| nuntius.admin_message_path(message) }
+
+  private
+
+  def scope
+    @scope = Nuntius::Message.visible
+    @scope = @scope.where(nuntiable_id: params[:nuntiable_id], nuntiable_type: params[:nuntiable_type]) if params[:nuntiable_id]
+    @scope = @scope.where(template_id: params[:template_id]) if params[:template_id]
+    @scope
+  end
+end

data/app/tables/nuntius_subscribers_table.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+class NuntiusSubscribersTable < ActionTable::ActionTable
+  model Nuntius::Subscriber
+
+  column(:name, sortable: false) { |subscriber| subscriber.name }
+  column(:email)
+  column(:phonenumber)
+
+  initial_order :name, :asc
+
+  row_link { |subscriber| nuntius.edit_admin_list_subscriber_path(params[:list_id], subscriber) }
+
+  private
+
+  def scope
+    @scope = Nuntius::Subscriber.where(list_id: params[:list_id])
+  end
+end

data/app/tables/nuntius_templates_table.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+class NuntiusTemplatesTable < ActionTable::ActionTable
+  model Nuntius::Template
+
+  column(:description)
+  column(:enabled, as: :boolean)
+  column(:klass)
+  column(:event)
+  column(:"# messages") { |template| link_to template.messages.count, nuntius.admin_messages_path(template_id: template.id) }
+
+  column(:metadata) { |template| Nuntius.config.metadata_humanize(template.metadata) }
+  column(:created_at) { |flow| ln(flow.created_at) }
+
+  column :actions, title: '', sortable: false do |template|
+    content_tag(:span, class: 'btn-group btn-group-xs') do
+      concat link_to(content_tag(:i, nil, class: 'fa fa-trash'), nuntius.admin_template_path(template), data: { turbo_confirm: 'Are you sure you want to delete the template?', turbo_method: :delete }, class: 'btn btn-xs btn-danger')
+    end
+  end
+
+  initial_order :description, :asc
+
+  row_link { |template| nuntius.edit_admin_template_path(template) }
+
+  private
+
+  def scope
+    @scope = Nuntius::Template.visible
+  end
+end

data/app/transports/nuntius/base_transport.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class BaseTransport
+    def kind
+      self.class.name.demodulize.gsub(/Transport$/, '').underscore.to_sym
+    end
+
+    def deliver(message)
+      priority = 1
+      wait_time = 0
+      message.update(transport: kind.to_s) if message.transport.blank?
+      while (providers_for_priority = providers(priority)).present?
+        time_out = 0
+        providers_for_priority.each do |hash|
+          message.update(provider: hash[:provider].to_s) if message.provider.blank?
+
+          Nuntius::TransportDeliveryJob.set(wait: !Rails.env.development? && wait_time).perform_later(hash[:provider].to_s, message)
+          time_out += hash[:timeout].seconds if hash[:timeout].positive?
+        end
+        wait_time += time_out
+        priority += 1
+      end
+    end
+
+    def providers(priority = nil)
+      results = Nuntius.config.providers[kind].to_a
+      results = results.select { |provider| provider[:priority] == priority } if priority
+      results
+    end
+
+    def self.class_from_name(name)
+      Nuntius.const_get("#{name}_transport".camelize)
+    end
+  end
+end

data/app/transports/nuntius/mail_transport.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class MailTransport < BaseTransport
+    # We split per email address, to allow easy resends
+    def deliver(message)
+      message.html = Inky::Core.new.release_the_kraken(message.html)
+
+      premailer = Premailer.new(message.html, with_html_string: true)
+      message.html = premailer.to_inline_css
+      message.text = premailer.to_plain_text
+
+      message.request_id = SecureRandom.uuid
+
+      tos = message.to.split(/[\s;,]+/)
+
+      messages = []
+      message.to = tos.first
+      messages << message
+
+      tos[1..-1].each do |to|
+        # FIXME: Sadly this also duplicates the attachments
+        new_message = message.deep_dup
+        new_message.to = to
+        new_message.attachments = message.attachments if message.attachments.present?
+
+        messages << new_message
+      end
+
+      messages.each { |m| super(m) }
+
+      messages.first
+    end
+  end
+end

data/app/transports/nuntius/push_transport.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class PushTransport < BaseTransport
+    # We split per email address, to allow easy resends
+    def deliver(message)
+      message.request_id = SecureRandom.uuid
+      message.to.split(',').each do |to|
+        new_message = message.dup
+        new_message.to = to
+        super(new_message)
+      end
+    end
+  end
+end

data/app/transports/nuntius/slack_transport.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class SlackTransport < BaseTransport
+  end
+end

data/app/transports/nuntius/sms_transport.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class SmsTransport < BaseTransport
+  end
+end

data/app/transports/nuntius/voice_transport.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class VoiceTransport < BaseTransport
+  end
+end

data/app/validators/liquid_validator.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class LiquidValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.blank?
+
+    Liquid::Template.parse(value)
+  rescue Liquid::SyntaxError => e
+    record.errors[attribute] << (options[:message] || "is not valid liquid: #{e.message}")
+  end
+end

data/app/views/nuntius/admin/campaigns/edit.html.slim

@@ -0,0 +1,49 @@
+- if @campaign.draft?
+  = sts.form_for [:admin, @campaign] do |f|
+    = sts.card title: t('.campaign'), icon: 'fal fa-megaphone' do |card|
+      - card.action
+        = f.submit
+
+      .grid.grid-cols-12.gap-4 data-controller="toggle"
+        .col-span-12
+          = f.input :name
+
+        .col-span-4
+          = f.input :transport, collection: Nuntius.config.transports, include_blank: false, input_html: {data: { 'toggle-target' => 'input'}}
+        .col-span-4
+          = f.association :layout, collection: @layouts
+        .col-span-4
+          = f.association :list, collection: @lists
+
+        .col-span-12
+          = f.input :from, hint: 'You can leave this blank, only fill this in if you want to override the default'
+
+        .col-span-12
+          .grid.grid-cols-12.gap-4 data-toggle-target="insertion"
+
+        template data-toggle-target='toggleable' data-toggle-value='mail'
+          .col-span-12
+            = f.input :subject
+          .col-span-12
+            = f.input :html, as: :hidden
+            trix-editor input="campaign_html" style="background-color: #fff; height: 400px; margin-bottom: 20px;"
+
+        template data-toggle-target='toggleable' data-toggle-value='voice'
+          .col-span-12
+            = f.input :text, as: :editor, mode: 'text/plain'
+
+
+- else
+  h2 = @campaign.name
+  p We're sending this campaign, you can no longer make any changes. This is the audience we're sending it to:
+
+  table.table
+    thead
+      tr
+        th Status
+        th To
+    tbody
+      - for message in @messages
+        tr
+          td = link_to message.status, admin_message_path(message)
+          td = message.to

data/app/views/nuntius/admin/campaigns/index.html.slim

@@ -0,0 +1,2 @@
+= sts.card title: t('.campaigns'), icon: 'fad fa-megaphone', content_padding: false, menu: nuntius_campaigns_menu do |card|
+  = sts.table :nuntius_campaigns

data/app/views/nuntius/admin/layouts/attachments/_attachments.html.slim

@@ -0,0 +1,28 @@
+- attachments.each do |attachment|
+  li.relative
+    /! Current: "ring-2 ring-offset-2 ring-indigo-500", Default: "focus-within:ring-2 focus-within:ring-offset-2 focus-within:ring-offset-gray-100 focus-within:ring-indigo-500"
+    .group.block.w-full.aspect-w-10.aspect-h-7.rounded-lg.bg-gray-100.overflow-hidden
+      /! Current: "", Default: "group-hover:opacity-75"
+      - if attachment.previewable?
+        = image_tag attachment.preview(resize_to_limit: [500, 500]).url, class: 'object-cover pointer-events-none'
+      - elsif attachment.image?
+        = image_tag main_app.url_for(attachment.variant(resize_to_limit: [500, 500])), class: 'object-cover pointer-events-none'
+    p.mt-2.block.text-sm.font-medium.text-gray-900.truncate.pointer-events-none = attachment.filename
+    p.block.text-sm.font-medium.text-gray-500
+      = (attachment.blob.byte_size / 1048576.0).round(2)
+      ' MB
+      = link_to admin_layout_attachment_path(@layout, attachment.id), data: { controller: 'attachment-delete', 'action': 'attachment-delete#delete' } do
+          i.fal.fa-xmark
+      =< link_to(main_app.rails_blob_path(attachment, disposition: 'attachment'),
+            title: attachment.filename)
+          i.fal.fa-download
+
+/ This controller comes from papyrus
+li.relative.attachment-upload data-controller="attachment-upload" data-attachment-upload-url="#{upload_url}" data-attachment-upload-param-name="attachments[]" data-attachment-upload-extra-data='{}'
+  .group.block.w-full.aspect-w-10.aspect-h-7.rounded-lg.bg-gray-100.overflow-hidden.text-center.align-middle style="height: 200px;"
+    span.icon.upload
+      i.fal.fa-4x.fa-upload.pt-16
+    span.icon.uploading
+      i.fal.fa-4x.fa-circle-notch.fa-spin.pt-16
+
+  p.mt-2.block.text-sm.font-medium.text-gray-500.truncate.pointer-events-none Drag or click to attach files

data/app/views/nuntius/admin/layouts/attachments/_index.html.slim

@@ -0,0 +1,2 @@
+ul.attachments.grid.grid-cols-2.gap-x-4.gap-y-8.sm:grid-cols-3.sm:gap-x-6.md:grid-cols-4.lg:grid-cols-3.xl:grid-cols-4.xl:gap-x-8 role="list"
+  = render partial: 'nuntius/admin/layouts/attachments/attachments', locals: { attachments: @layout.attachments, upload_url: admin_layout_attachments_path(@layout) }

data/app/views/nuntius/admin/layouts/attachments/create.json.jbuilder

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+json.selector 'ul.attachments'
+json.html render partial: 'nuntius/admin/layouts/attachments/attachments', layout: false, formats: [:html],
+                 locals: { attachments: @layout.attachments, upload_url: admin_layout_attachments_path(@layout) }

data/app/views/nuntius/admin/layouts/edit.html.slim

@@ -0,0 +1,24 @@
+= sts.form_for([:admin, @layout]) do |f|
+  = sts.card title: t('.layout'), icon: 'fal fa-table-layout' do |card|
+    - card.action
+      = f.submit
+
+    = sts.tabs do |tabs|
+      - tabs.tab :edit
+        .grid.grid-cols-12.gap-4
+          .col-span-12
+            = f.input :name
+          .col-span-12
+            = f.input :data, as: :editor, mode: 'text/html', height: '400px'
+      - tabs.tab :metadata
+        .grid.grid-cols-12.gap-4
+          .col-span-12
+            = f.input :metadata_yaml, as: :editor, mode: 'application/yaml', label: t('.metadata')
+
+      - if @layout.persisted?
+        - tabs.tab :media
+          = render partial: 'nuntius/admin/layouts/attachments/index', locals: { attachments: @layout.attachments, upload_url: nuntius.admin_layout_attachments_path(@layout) }
+
+      - if @layout.templates.size.positive?
+        - tabs.tab :templates
+          = sts.table :nuntius_templates, parameters: { layout_id: @layout.id }

data/app/views/nuntius/admin/layouts/index.html.slim

@@ -0,0 +1,2 @@
+= sts.card title: t('.layouts'), icon: 'fad fa-table-layout', content_padding: false, menu: nuntius_layouts_menu do |card|
+  = sts.table :nuntius_layouts

data/app/views/nuntius/admin/lists/edit.html.slim

@@ -0,0 +1,14 @@
+= sts.form_for([:admin, @list]) do |f|
+  = sts.card title: t('.list'), icon: 'fad fa-address-book', menu: nuntius_list_menu do |card|
+    - card.action
+      = f.continue
+    - card.action
+      = f.submit
+
+    .grid.grid-cols-12.gap-4
+      .col-span-12
+        = f.input :name
+
+br
+- if @list.subscribers.present?
+  = sts.table :nuntius_subscribers, parameters: { list_id: @list.id }

data/app/views/nuntius/admin/lists/index.html.slim

@@ -0,0 +1,2 @@
+= sts.card title: t('.lists'), icon: 'fad fa-address-book', content_padding: false, menu: nuntius_lists_menu do |card|
+  = sts.table :nuntius_lists

data/app/views/nuntius/admin/lists/subscribers/edit.html.slim

@@ -0,0 +1,14 @@
+= sts.form_for(@subscriber, url: @subscriber.new_record? ? admin_list_subscribers_path(@list) : admin_list_subscriber_path(@list, @subscriber), html: {multipart: true}) do |f|
+  = sts.card title: t('.subscribers'), icon: 'fad fa-address-card' do |card|
+    - card.action
+      = f.submit
+
+    .grid.grid-cols-12.gap-4
+      .col-span-6
+        = f.input :first_name
+      .col-span-6
+        = f.input :last_name
+      .col-span-12
+        = f.input :phone_number
+      .col-span-12
+        = f.input :email

data/app/views/nuntius/admin/locales/edit.html.slim

@@ -0,0 +1,14 @@
+= sts.form_for([:admin, @locale]) do |f|
+  = sts.card title: t('.locale'), icon: 'fal fa-language' do |card|
+    - card.action
+      = f.continue
+    - card.action
+      = f.submit
+
+    .grid.grid-cols-12.gap-4
+      .col-span-12
+        = f.input :key
+      .col-span-12
+        = f.input :data_yaml, as: :editor, mode: 'application/yaml', label: t('.data')
+      .col-span-12
+        = f.input :metadata_yaml, as: :editor, mode: 'application/yaml', label: t('.metadata')

data/app/views/nuntius/admin/locales/index.html.slim

@@ -0,0 +1,2 @@
+= sts.card title: t('.locales'), icon: 'fad fa-language', content_padding: false, menu: nuntius_locales_menu do |card|
+  = sts.table :nuntius_locales

data/app/views/nuntius/admin/messages/index.html.slim

@@ -0,0 +1,2 @@
+= sts.card title: t('.messages'), icon: 'fad fa-envelope', content_padding: false, menu: nuntius_messages_menu do |card|
+  = sts.table :nuntius_messages, parameters: { template_id: params[:template_id] }