nuntius 1.0.27 → 1.1.4

data/config/locales/en.yml

@@ -1,4 +1,3 @@
-en:
   nuntius:
     flash:
       error: There were problems saving the %{model}
@@ -11,6 +10,103 @@ en:
         resend:
           resend_success: Resent message
           resend_error: Failed to resend message
+        index:
+          card:
+            nuntius_admin_messages:
+              title: Messages
+              tab:
+                Nuntius messages: Messages
+        show:
+          message: Message
+          card:
+            nuntius_admin_messages:
+              tab:
+                preview: Preview
+                details: Details
+          info_item:
+            main:
+              status: Status
+              transport: Transport
+              provider: Provider
+              provider_id: Provider ID
+              request_id: Request ID
+              refreshes: Refreshes
+              last_sent_at: Last Sent At
+              created_at: Created At
+      templates:
+        index:
+          card:
+            nuntius_admin_templates:
+              title: Templates
+              tab:
+                Nuntius templates: Templates
+        edit:
+          card:
+            nuntius_admin_templates:
+              title: Templates
+              tab:
+                edit: Edit
+                nuntius_messages: Messages
+          metadata: Metadata
+      layouts:
+        index:
+          card:
+            nuntius_admin_layouts:
+              title: Layouts
+              tab:
+                Nuntius layouts: Layouts
+        edit:
+          card:
+            nuntius_admin_layouts:
+              title: Layouts
+              tab:
+                edit: Edit
+                metadata: Metadata
+                media: Media
+          metadata: Metadata
+      locales:
+        index:
+          card:
+            nuntius_admin_locales:
+              title: Locales
+              tab:
+                Nuntius locales: Locales
+        edit:
+          card:
+            nuntius_admin_locales:
+              title: Locales
+          data: Data
+          metadata: Metadata
+      campaigns:
+        index:
+          card:
+            nuntius_admin_campaigns:
+              title: Campaigns
+              tab:
+                Nuntius campaigns: Campaigns
+        edit:
+          card:
+            nuntius_admin_campaigns:
+              title: Campaigns
+      lists:
+        subscribers:
+          edit:
+            subscribers: Subscribers
+        index:
+          card:
+            nuntius_admin_lists:
+              title: Lists
+              tab:
+                Nuntius lists: Lists
+        edit:
+          description: List description
+          description_hint: Describe the list in detail for the subscibers, explain if they can unsubscribe, how often they will receive messages, etc.
+          card:
+            nuntius_admin_lists:
+              title: Lists
+              tab:
+                edit: Edit
+                nuntius_subscribers: Subscribers
     breadcrumbs:
       nuntius: Nuntius
       dashboard: Dashboard

data/config/routes.rb

@@ -5,34 +5,44 @@ Nuntius::Engine.routes.draw do
     resource :twilio_inbound_smses
   end
 
-  get 'callbacks/:message_id(/*path)', to: 'callbacks#create', as: :callback
-  post 'callbacks/:message_id(/*path)', to: 'callbacks#create'
+  get "callbacks/:message_id(/*path)", to: "callbacks#create", as: :callback
+  post "callbacks/:message_id(/*path)", to: "callbacks#create"
 
-  post 'feedback/awssns' => 'feedback#awssns'
+  post "feedback/awssns" => "feedback#awssns"
 
   resources :messages
   resources :campaigns
+  resources :subscribers do
+    member do
+      post :unsubscribe
+      post :subscribe
+    end
+  end
 
   namespace :api do
     resources :events
   end
 
   namespace :admin do
-    resources :campaigns
+    resources :campaigns do
+      member do
+        post "publish", action: "publish"
+      end
+    end
     resources :layouts do
-      resources :attachments, controller: 'layouts/attachments'
+      resources :attachments, controller: "layouts/attachments"
     end
     resources :lists do
-      resources :subscribers, controller: 'lists/subscribers'
+      resources :subscribers, controller: "lists/subscribers"
     end
     resources :messages do
       member do
-        post 'resend', action: 'resend'
+        post "resend", action: "resend"
       end
     end
     resources :layouts
     resources :locales
     resources :templates
   end
-  root to: 'dashboard#show'
+  root to: "dashboard#show"
 end

data/db/migrate/20190301201541_create_nuntius_templates.rb

@@ -2,7 +2,7 @@
 
 class CreateNuntiusTemplates < ActiveRecord::Migration[5.1]
   def change
-    enable_extension 'pgcrypto'
+    enable_extension "pgcrypto"
 
     create_table :nuntius_templates, id: :uuid do |t|
       t.string :klass
@@ -12,14 +12,14 @@ class CreateNuntiusTemplates < ActiveRecord::Migration[5.1]
       t.string :description
       t.jsonb :metadata, null: false, default: {}
 
-      t.references :layout, index: true, type: :uuid, foreign_key: { to_table: :nuntius_templates }
+      t.references :layout, index: true, type: :uuid, foreign_key: {to_table: :nuntius_templates}
 
       t.string :from
       t.string :to
       t.string :subject
-      t.text   :html
-      t.text   :text
-      t.jsonb  :payload
+      t.text :html
+      t.text :text
+      t.jsonb :payload
 
       t.timestamps
     end

data/db/migrate/20190301202436_create_nuntius_messages.rb

@@ -2,16 +2,16 @@
 
 class CreateNuntiusMessages < ActiveRecord::Migration[5.1]
   def change
-    enable_extension 'uuid-ossp'
+    enable_extension "uuid-ossp"
 
     create_table :nuntius_messages, id: :uuid do |t|
-      t.references :template, index: true, type: :uuid, foreign_key: { to_table: :nuntius_templates }
-      t.references :parent_message, index: true, type: :uuid, foreign_key: { to_table: :nuntius_messages }
+      t.references :template, index: true, type: :uuid, foreign_key: {to_table: :nuntius_templates}
+      t.references :parent_message, index: true, type: :uuid, foreign_key: {to_table: :nuntius_messages}
       t.references :nuntiable, polymorphic: true, index: true, type: :uuid
 
       t.integer :refreshes, default: 0
 
-      t.string :status, default: 'draft'
+      t.string :status, default: "draft"
       t.string :transport
       t.string :provider
       t.string :provider_id

data/db/migrate/20190322114340_create_nuntius_campaigns.rb

@@ -4,8 +4,8 @@ class CreateNuntiusCampaigns < ActiveRecord::Migration[5.2]
   def change
     create_table :nuntius_campaigns, id: :uuid do |t|
       t.string :name
-      t.string :transport, default: 'mail'
-      t.references :list, index: true, type: :uuid, foreign_key: { to_table: :nuntius_lists }
+      t.string :transport, default: "mail"
+      t.references :list, index: true, type: :uuid, foreign_key: {to_table: :nuntius_lists}
 
       t.string :from
       t.string :subject

data/db/migrate/20190322121338_create_nuntius_subscribers.rb

@@ -3,7 +3,7 @@
 class CreateNuntiusSubscribers < ActiveRecord::Migration[5.2]
   def change
     create_table :nuntius_subscribers, id: :uuid do |t|
-      t.references :list, index: true, type: :uuid, foreign_key: { to_table: :nuntius_lists }
+      t.references :list, index: true, type: :uuid, foreign_key: {to_table: :nuntius_lists}
 
       t.string :first_name
       t.string :last_name

data/db/migrate/20190327124407_create_nuntius_layouts.rb

@@ -11,14 +11,14 @@ class CreateNuntiusLayouts < ActiveRecord::Migration[5.2]
       t.timestamps
     end
 
-    remove_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: { to_table: :nuntius_templates }
-    add_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: { to_table: :nuntius_layouts }
-    add_reference :nuntius_campaigns, :layout, index: true, type: :uuid, foreign_key: { to_table: :nuntius_layouts }
+    remove_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: {to_table: :nuntius_templates}
+    add_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: {to_table: :nuntius_layouts}
+    add_reference :nuntius_campaigns, :layout, index: true, type: :uuid, foreign_key: {to_table: :nuntius_layouts}
   end
 
   def down
     drop_table :nuntius_layouts
-    remove_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: { to_table: :nuntius_layouts }
-    add_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: { to_table: :nuntius_templates }
+    remove_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: {to_table: :nuntius_layouts}
+    add_reference :nuntius_templates, :layout, index: true, type: :uuid, foreign_key: {to_table: :nuntius_templates}
   end
 end

data/db/migrate/20190327143921_add_campaign_to_message.rb

@@ -2,6 +2,6 @@
 
 class AddCampaignToMessage < ActiveRecord::Migration[5.2]
   def change
-    add_reference :nuntius_messages, :campaign, type: :uuid, foreign_key: { to_table: :nuntius_campaigns }
+    add_reference :nuntius_messages, :campaign, type: :uuid, foreign_key: {to_table: :nuntius_campaigns}
   end
 end

data/db/migrate/20190417125153_change_message_status_default.rb

@@ -2,8 +2,8 @@
 
 class ChangeMessageStatusDefault < ActiveRecord::Migration[5.2]
   def change
-    change_column_default(:nuntius_messages, :status, from: 'draft', to: 'pending')
+    change_column_default(:nuntius_messages, :status, from: "draft", to: "pending")
 
-    Nuntius::Message.where(status: 'draft').update(status: 'pending')
+    Nuntius::Message.where(status: "draft").update(status: "pending")
   end
 end

data/db/migrate/20190825080757_update_nuntius_message_sending_to_sent.rb

@@ -2,10 +2,10 @@
 
 class UpdateNuntiusMessageSendingToSent < ActiveRecord::Migration[5.2]
   def up
-    Nuntius::Message.where(status: 'sending').update_all(status: 'sent')
+    Nuntius::Message.where(status: "sending").update_all(status: "sent")
   end
 
   def down
-    Nuntius::Message.where(status: 'sent').update_all(status: 'sending')
+    Nuntius::Message.where(status: "sent").update_all(status: "sending")
   end
 end

data/db/migrate/20200220154927_change_nuntius_templates_payload_type.rb

@@ -2,6 +2,6 @@
 
 class ChangeNuntiusTemplatesPayloadType < ActiveRecord::Migration[5.2]
   def change
-    execute 'ALTER TABLE nuntius_templates ALTER COLUMN payload TYPE TEXT USING payload::text;'
+    execute "ALTER TABLE nuntius_templates ALTER COLUMN payload TYPE TEXT USING payload::text;"
   end
 end

data/db/migrate/20200318095339_create_nuntius_attachments.rb

@@ -5,8 +5,8 @@ class CreateNuntiusAttachments < ActiveRecord::Migration[5.2]
     end
 
     create_table :nuntius_attachments_messages, id: false do |t|
-      t.belongs_to :message, type: :uuid, foreign_key: { to_table: :nuntius_messages }
-      t.belongs_to :attachment, type: :uuid, foreign_key: { to_table: :nuntius_attachments }
+      t.belongs_to :message, type: :uuid, foreign_key: {to_table: :nuntius_messages}
+      t.belongs_to :attachment, type: :uuid, foreign_key: {to_table: :nuntius_attachments}
     end
   end
 end

data/db/migrate/20201121185718_create_nuntius_inbound_messages.rb

@@ -1,7 +1,7 @@
 class CreateNuntiusInboundMessages < ActiveRecord::Migration[6.0]
   def change
     create_table :nuntius_inbound_messages, id: :uuid do |t|
-      t.string :status, default: 'pending'
+      t.string :status, default: "pending"
       t.string :transport
       t.string :provider
       t.string :provider_id

data/db/migrate/20240205204719_add_description_to_list.rb

@@ -0,0 +1,5 @@
+class AddDescriptionToList < ActiveRecord::Migration[7.0]
+  def change
+    add_column :nuntius_lists, :description, :text
+  end
+end

data/db/migrate/20240206203019_add_slug_to_nuntius_list.rb

@@ -0,0 +1,9 @@
+class AddSlugToNuntiusList < ActiveRecord::Migration[7.1]
+  def change
+    add_column :nuntius_lists, :slug, :string
+    add_index :nuntius_lists, :slug, unique: true
+    add_column :nuntius_lists, :allow_unsubscribe, :boolean, default: true, null: false
+
+    add_column :nuntius_subscribers, :unsubscribed_at, :timestamp
+  end
+end

data/lib/nuntius/active_record_helpers.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'nuntiable'
-require_relative 'devise'
-require_relative 'state_machine'
-require_relative 'transactio'
+require_relative "nuntiable"
+require_relative "devise"
+require_relative "state_machine"
+require_relative "transactio"
 
 module Nuntius::ActiveRecordHelpers
   extend ActiveSupport::Concern

data/lib/nuntius/configuration.rb

@@ -1,40 +1,60 @@
 # frozen_string_literal: true
 
 module Nuntius
+  module Options
+    module ClassMethods
+      def option(name, default: nil)
+        attr_accessor(name)
+        schema[name] = default
+      end
+
+      def schema
+        @schema ||= {}
+      end
+    end
+
+    def set_defaults!
+      self.class.schema.each do |name, default|
+        instance_variable_set(:"@#{name}", default)
+      end
+    end
+
+    def self.included(cls)
+      cls.extend(ClassMethods)
+    end
+  end
+
   class Configuration
-    attr_accessor :admin_authentication_module, :base_controller, :base_runner, :layout, :admin_layout, :jobs_queue_name, :visible_scope, :add_metadata, :metadata_fields, :default_template_scope, :allow_custom_events, :active_storage_service
-    attr_writer :logger, :host, :metadata_humanize, :default_params
+    include Options
+
+    option :logger, default: -> { Rails.logger }
+    option :admin_authentication_module, default: "Auxilium::Concerns::AdminAuthenticated"
+    option :base_controller, default: "::ApplicationController"
+    option :base_runner, default: "Nuntius::BasicApplicationRunner"
+    option :layout, default: "application"
+    option :admin_layout, default: "application"
+    option :jobs_queue_name, default: "message"
+    option :allow_custom_events, default: false
+    option :active_storage_service
+    option :host, default: ->(message) {}
+
+    attr_accessor :visible_scope, :add_metadata, :metadata_fields, :default_template_scope
+    attr_writer :metadata_humanize, :default_params, :flow_color
 
     attr_reader :transports, :providers
 
     def initialize
-      @logger = Logger.new(STDOUT)
-      @logger.level = Logger::INFO
-      @base_controller = '::ApplicationController'
-      @base_runner = 'Nuntius::BasicApplicationRunner'
+      set_defaults!
+
       @nuntiable_classes = []
       @nuntiable_class_names = []
       @transports = []
       @providers = {}
-      @jobs_queue_name = :message
       @visible_scope = -> { all }
       @add_metadata = -> {}
       @metadata_fields = {}
       @metadata_humanize = ->(data) { data.inspect }
       @default_template_scope = ->(_object) { all }
-      @allow_custom_events = false
-      @layout = 'application'
-      @admin_layout = 'application'
-      @active_storage_service = nil
-    end
-
-    # logger [Object].
-    def logger
-      @logger.is_a?(Proc) ? instance_exec(&@logger) : @logger
-    end
-
-    def host(message)
-      @host.is_a?(Proc) ? instance_exec(message, &@host) : @host
     end
 
     # Make the part that is important for visible readable for humans
@@ -42,11 +62,6 @@ module Nuntius
       @metadata_humanize.is_a?(Proc) ? instance_exec(metadata, &@metadata_humanize) : @metadata_humanize
     end
 
-    # admin_mount_point [String].
-    def admin_mount_point
-      @admin_mount_point ||= '/nuntius'
-    end
-
     def add_nuntiable_class(klass)
       @nuntiable_class_names = []
       @nuntiable_classes << klass.to_s unless @nuntiable_classes.include?(klass.to_s)
@@ -63,7 +78,7 @@ module Nuntius
         @providers[transport.to_sym] ||= []
         @providers[transport.to_sym].push(provider: provider, priority: priority, timeout: timeout, settings: settings)
       else
-        Nuntius.logger.warn "provider #{provider} not enabled as transport #{transport} is not enabled"
+        Nuntius.config.logger.call.warn "provider #{provider} not enabled as transport #{transport} is not enabled"
       end
     end
 
@@ -75,11 +90,15 @@ module Nuntius
       @default_params.is_a?(Proc) ? instance_exec(transaction_log_entry, &@default_params) : @default_params
     end
 
+    def flow_color(template_id)
+      @flow_color.is_a?(Proc) ? instance_exec(template_id, &@flow_color) : @flow_color
+    end
+
     private
 
     def compile_nuntiable_class_names
       names = []
-      names << 'Custom' if allow_custom_events
+      names << "Custom" if allow_custom_events
 
       @nuntiable_classes.each do |klass_name|
         klass = klass_name.constantize
@@ -94,4 +113,22 @@ module Nuntius
       @nuntiable_class_names = compile_nuntiable_class_names
     end
   end
+
+  module Configurable
+    attr_writer :config
+
+    def config
+      @config ||= Configuration.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    alias_method :setup, :configure
+
+    def reset_config!
+      @config = Configuration.new
+    end
+  end
 end

data/lib/nuntius/deprecator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nuntius
   class Deprecator
     def deprecation_warning(deprecated_method_name, message, _caller_backtrace = nil)

data/lib/nuntius/devise.rb

@@ -12,7 +12,7 @@ module Nuntius
 
       orchestrator.override_devise_notification do |notification, *devise_params|
         # All notifications have either a token as the first param, or nothing
-        Nuntius.event(notification, self, { token: devise_params.first })
+        Nuntius.event(notification, self, {token: devise_params.first})
       end
     end
   end

data/lib/nuntius/engine.rb

@@ -1,46 +1,32 @@
 # frozen_string_literal: true
 
+require "auxilium"
+require "evento"
+require "inky"
+require "faraday"
+require "faraday/follow_redirects"
+require "liquidum"
+require "premailer"
+require "state_machines-activerecord"
+require "servitium"
+
 module Nuntius
   class Engine < ::Rails::Engine
     isolate_namespace Nuntius
 
-    initializer 'nuntius.config' do |_app|
-      path = File.expand_path(File.join(File.dirname(__FILE__), '.', 'liquid', '{tags,filters}', '*.rb'))
+    initializer "nuntius.config" do |_app|
+      path = File.expand_path(File.join(File.dirname(__FILE__), ".", "liquid", "{tags,filters}", "*.rb"))
       Dir.glob(path).each do |c|
         require_dependency(c)
       end
     end
 
-    initializer :append_migrations do |app|
-      unless app.root.to_s.match? root.to_s
-        config.paths['db/migrate'].expanded.each do |expanded_path|
-          app.config.paths['db/migrate'] << expanded_path
-        end
-      end
-    end
-
-    initializer 'active_storage.attached' do
+    initializer "active_storage.attached" do
       config.after_initialize do
         ActiveSupport.on_load(:active_record) do
           Nuntius::Attachment.include(Nuntius::ActiveStorageHelpers)
         end
       end
     end
-
-    #
-    # initializer "webpacker.proxy" do |app|
-    #   insert_middleware = begin
-    #     Nuntius.webpacker.config.dev_server.present?
-    #   rescue
-    #     nil
-    #   end
-    #   next unless insert_middleware
-    #
-    #   app.middleware.insert_before(
-    #     0, Webpacker::DevServerProxy, # "Webpacker::DevServerProxy" if Rails version < 5
-    #     ssl_verify_none: true,
-    #     webpacker: Nuntius.webpacker
-    #   )
-    # end
   end
 end

data/lib/nuntius/i18n_store.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require 'i18n/core_ext/hash'
+require "i18n/core_ext/hash"
 
 module Nuntius
   begin
-    require 'oj'
+    require "oj"
     class JSON
       class << self
         def encode(value)
@@ -17,12 +17,13 @@ module Nuntius
       end
     end
   rescue LoadError
-    require 'active_support/json'
+    require "active_support/json"
     JSON = ActiveSupport::JSON
   end
 
   class I18nStore
-    def initialize; end
+    def initialize
+    end
 
     def keys
       return [] unless template
@@ -82,7 +83,7 @@ module Nuntius
 
     def flat_hash(hash = {})
       (hash || {}).reduce({}) do |a, (k, v)|
-        tmp = v.is_a?(Hash) ? flat_hash(v).map { |k2, v2| ["#{k}.#{k2}", v2] }.to_h : { k => v }
+        tmp = v.is_a?(Hash) ? flat_hash(v).transform_keys { |k2| "#{k}.#{k2}" } : {k => v}
         a.merge(tmp)
       end
     end

data/lib/nuntius/liquid/tags/attach_tag.rb

@@ -11,10 +11,10 @@ class AttachTag < LiquidumTag
 
     return unless argv1
 
-    message = context.registers['message']
+    message = context.registers["message"]
 
     if argv1.is_a? String
-      message.add_attachment({ url: argv1 })
+      message.add_attachment({url: argv1})
     elsif argv1.instance_of?(ActiveStorageAttachedOneDrop) || argv1.instance_of?(ActiveStorage::AttachmentDrop)
 
       io = StringIO.new(argv1.download)
@@ -22,23 +22,23 @@ class AttachTag < LiquidumTag
       content_type = argv1.content_type
       filename = argv1.filename
 
-      if arg(:convert) == 'pdf' && content_type != 'application/pdf'
-        content_type = 'application/pdf'
+      if arg(:convert) == "pdf" && content_type != "application/pdf"
+        content_type = "application/pdf"
         pdf = Labelary::Label.render(zpl: io.read,
-                                     content_type: content_type,
-                                     dpmm: 8,
-                                     width: arg(:width).blank? ? 4 : arg(:width),
-                                     height: arg(:height).blank? ? 6 : arg(:height))
+          content_type: content_type,
+          dpmm: 8,
+          width: arg(:width).blank? ? 4 : arg(:width),
+          height: arg(:height).blank? ? 6 : arg(:height))
 
         io = StringIO.new(pdf)
         filename = "#{filename}.pdf"
       end
 
-      message.add_attachment({ content: io, filename: filename, content_type: content_type })
+      message.add_attachment({content: io, filename: filename, content_type: content_type})
     end
 
-    ''
+    ""
   end
 end
 
-Liquid::Template.register_tag('attach', AttachTag)
+Liquid::Template.register_tag("attach", AttachTag)