nuntius 1.0.27 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 736ed78b3a455b90aad20c47ba9bf6c3946cb7d45dc064c33d689a622ac40f18
-  data.tar.gz: c2f9abeeffe69fe5f28df8af6b0ff1c72c3c73d743b9156f0a12ed6daca3d1a9
+  metadata.gz: aa439d75f1be61c5122338f9d0c2c74b68d016e91208756d9ad2be119845ad51
+  data.tar.gz: 164ff8b68eb4912eaabade99a3ee39e593d5c2274345211601dccf14d6bb11c1
 SHA512:
-  metadata.gz: a6fe800fc712a05dc2a35166a28a6d3c0d41f248365ca1cdb3f529f1430e77ca11553342cc0681490b1aaad952de6f87b89412f8329501e79765c556efa3428f
-  data.tar.gz: 4e79093e36ffeb8967aa5568a064b41828c33dcd3da32bf87ff0a5ed3504f5c3dc2794560c237254e63ed042a521442d3c51e57ca54690f209057e5bc29b73a5
+  metadata.gz: 3f40c494fc93610eee81a49f8b648b7cb3dafa8be578b051d24cfa8a052536ce69f6eb252df05eb98c5367bd28fe10c5109ad668b10efde3b015355282293e92
+  data.tar.gz: 65088baae2f8f957ac6dab1c14d9945d43e594149c9074d257d4a1db5f6f582a02801642c4348c3cd8b2a5c02c93ade63599d61d474869e30920a06e2d75cbd6

data/README.md

@@ -159,14 +159,12 @@ Nuntius.event('packed', packing: {smurrefluts: 'hatseflats'})
 
 The main key of the hash passed will also be the liquid variable.
 
-### Inbound
-
-Inbound messages are also possible, currently mail/IMAP and Twilio inbound SMS are supported.
-
 ## Transports
 
 ### Mail
 
+Outbound mail is handled through SMTP. We've only exposed the HTML of mail, we can create text-versions based on sanitized HTML. HTML allows for [Foundation for Emails](https://get.foundation/emails/docs/index.html). You will have to include the CSS in the layouts.
+
 #### AWS SES
 
 In case you use AWS SES, you can use the SNS Feedback Notifications to automatically mark messages as read, or deal with complaints and bounces. Create a AWS SNS topic, with a HTTPS subscription with the following URL (pattern):
@@ -179,27 +177,47 @@ The subscription will automatically be confirmed.
 
 Next in AWS SES, configure the SNS topic to receive feedback notifications for Bounce, Complaint and Delivery and include original headers.
 
+### Slack
+
+Slack uses the [postMessage](https://api.slack.com/methods/chat.postMessage) method to send messages. It will also upload any attachment the message has prior to sending the message itself.
+
+The message body is specified using `text` and additionally supports the `payload` parameter.
+
+The payload is merged with the `text`, `to` (channel or user) and `from`.
+
+### Teams
+
+For Microsoft Teams you need to have the webhook URL for a channel. You right-click the channel (not the team) and click "Manage channel". 
+Then on the settings click "Edit" under "Manage the connectors that post to this channel", then search for "Incoming Webhook" and add it and configure it.
+You can give it a name and an image.
+
+See [Create Incoming Webhooks](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook?tabs=newteams%2Cdotnet) for details.
+
 ### SMS
 
-### Push
+SMS just support the `from` (name or phone number), `to` (the phone) and `text` attribute.
+
+Only MessageBird allows for names when sending SMS messages. Messagebird does not support a hypen in the name, just alphabetical characters (A-Za-z).
 
 ### Voice
 
-#### Twilio
+Currently only Twilio voice is supported in the voice transport.
+
+Information on voice TWIML is here: https://www.twilio.com/docs/voice/twiml
+You can try voices here: https://www.twilio.com/docs/voice/twiml/say/text-speech
 
-Information on voice TWIML is here: https://www.twilio.com/docs/voice/twiml/gather
-You can try voices here: https://www.twilio.com/console/voice/twiml/text-to-speech
+The Voice transport is particularly nice, because you can define whole paths in the message body, for example:
 
 ```
 <?xml version="1.0" encoding="UTF-8"?>
 <Response>
-    <Say language="nl-NL">
-        Hallo, dit is een bericht van Boxture!
+    <Say language="en-US">
+        Hello Earthling, this is a message from your Robot Overlords!
         <break strength="x-weak" time="100ms"/>
-        <p>We geven je zo je wachtwoord-herstel-code, dus pak een pen en schrijf mee.</p>
+        <p>We will soon give you your escape-hatch-code, so grab a pen and write it down.</p>
     </Say>
     <Gather input="dtmf" numDigits="1" action="{%raw%}{{url}}{%endraw%}/code">
-       <Say language="nl-NL">Druk een toets om verder te gaan.</Say>
+       <Say language="en-US">Press any key to continue.</Say>
     </Gather>
     <Redirect>{%raw%}{{url}}{%endraw%}/code</Redirect>
 </Response>
@@ -210,20 +228,61 @@ path: /code
 <?xml version="1.0" encoding="UTF-8"?>
 <Response>
   <Gather input="dtmf" numDigits="1">
-     <Say language="nl-NL">
-      <s>Je code is:</s>
+     <Say language="en-US">
+      <s>Your code is:</s>
       <break strength="x-weak" time="100ms"/>
-      <prosody rate="x-slow"><say-as interpret-as="character">1 n a x d 8 b</say-as></prosody>
+      <prosody rate="x-slow"><say-as interpret-as="character">s e n d h e l p</say-as></prosody>
       <break strength="x-weak" time="1s"/>
-      Druk een toets om te herhalen, of hang op.
+      Press any key to continue, or just hang up.
      </Say>
   </Gather>
   <Redirect>{%raw%}{{url}}{%endraw%}/code</Redirect>
 </Response>
 ```
 
-## Testing
+### Inbound
+
+Inbound messages are also possible, currently mail/IMAP and Twilio inbound SMS are supported.
+This is done using message-boxes, for this to work you need to add a `message_boxes` folder to your `app` folder.
+
+#### SMS
+
+Twilio is currently the only supported inbound SMS provider.
+Point Twilio to you nuntius mount path (/messaging/inbound_messages/twilio_inbound_smses)
+
+```ruby
+class FooMessageBox < Nuntius::BaseMessageBox
+  transport :sms
+  provider :twilio
 
+  route /\+31.+/, to: :dutchies
+end
 ```
-bundle exec sidekiq -C test/dummy/config/sidekiq.yml -r test/dummy
+
+#### Mail
+Nuntius will look at a mailbox and for each of the mails will check whether it can find a route for it in any of the message-boxes. 
+After delivery, on the next round of fetching mail, nuntius will move processed message to the Archive folder 
+
+```ruby
+class BarMessageBox < Nuntius::BaseMessageBox
+  transport :mail
+  provider :imap
+
+  settings({
+    address: 'imap.gmail.com',
+    port: 993,
+    user_name: '',
+    password: '',
+    authentication: '',
+    enable_ssl: false,
+    enable_starttls: false
+  })
+  
+  route to: :process
+  
+  def process
+    puts message.status # Message is Nuntius's inbound message.
+    puts mail.to 
+  end
+end
 ```

data/Rakefile

@@ -1,62 +1,35 @@
 # frozen_string_literal: true
 
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Nuntius'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title = "Nuntius"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
-load 'rails/tasks/engine.rake'
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
 
-load 'rails/tasks/statistics.rake'
+load "rails/tasks/statistics.rake"
 
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rake/testtask'
+require "rake/testtask"
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
   t.verbose = false
   t.warning = false
 end
 
 task default: :test
-
-# Adds the Auxilium semver task
-spec = Gem::Specification.find_by_name 'auxilium'
-load "#{spec.gem_dir}/lib/tasks/semver.rake"
-
-namespace :nuntius do
-  namespace :webpacker do
-    desc 'Install deps with yarn'
-    task :yarn_install do
-      Dir.chdir(File.join(__dir__, '../..')) do
-        system 'yarn install --no-progress --production'
-      end
-    end
-
-    desc 'Compile JavaScript packs using webpack for production with digests'
-    task compile: %i[yarn_install environment] do
-      Webpacker.with_node_env('production') do
-        if Nuntius.webpacker.commands.compile
-          # Successful compilation!
-        else
-          # Failed compilation
-          exit!
-        end
-      end
-    end
-  end
-end

data/app/controllers/nuntius/admin/campaigns_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   module Admin
@@ -24,17 +24,19 @@ module Nuntius
         redirect_to :edit_admin_campaign, status: :see_other
       end
 
-      def edit; end
+      def edit
+      end
 
       def update
-        saved = @campaign.update(campaign_params)
-
-        if saved && params[:commit] == 'send'
-          @campaign.publish! if @campaign.can_publish?
-          redirect_to :edit_admin_campaign, status: :see_other
-        else
-          respond_with :admin, @campaign
-        end
+        @campaign.update(campaign_params)
+
+        respond_with :admin, @campaign
+      end
+
+      def publish
+        @campaign.publish! if @campaign.can_publish?
+
+        redirect_to :admin_campaigns, status: :see_other
       end
 
       private

data/app/controllers/nuntius/admin/layouts/attachments_controller.rb

@@ -6,7 +6,8 @@ module Nuntius
       class AttachmentsController < ApplicationController
         before_action :set_objects
 
-        def index; end
+        def index
+        end
 
         def create
           params[:attachments].each do |file|

data/app/controllers/nuntius/admin/layouts_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   module Admin

data/app/controllers/nuntius/admin/lists/subscribers_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   module Admin

data/app/controllers/nuntius/admin/lists_controller.rb

@@ -1,11 +1,10 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   module Admin
     class ListsController < ApplicationAdminController
-
       def index
         @lists = Nuntius::List.visible.order(:name)
       end
@@ -36,10 +35,11 @@ module Nuntius
 
       private
 
-      def set_objects; end
+      def set_objects
+      end
 
       def list_params
-        params.require(:list).permit(:name)
+        params.require(:list).permit(:name, :slug, :allow_unsubscribe, :description, :metadata_yaml)
       end
     end
   end

data/app/controllers/nuntius/admin/locales_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   module Admin
@@ -36,7 +36,8 @@ module Nuntius
 
       private
 
-      def set_objects; end
+      def set_objects
+      end
 
       def locale_params
         params.require(:locale).permit(:key, :data, :metadata_yaml, :data_yaml)

data/app/controllers/nuntius/admin/messages_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   module Admin
@@ -17,7 +17,7 @@ module Nuntius
       def resend
         @message = Nuntius::Message.visible.find(params[:id])
         @message.resend
-        respond_with @message, success: t('.resend_success'), error: t('.resend_error')
+        respond_with @message, success: t(".resend_success"), error: t(".resend_error")
       end
     end
   end

data/app/controllers/nuntius/admin/templates_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   module Admin

data/app/controllers/nuntius/api/events_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_controller'
+require_dependency "nuntius/application_controller"
 
 module Nuntius
   class Api::EventsController < ApplicationController
@@ -10,7 +10,7 @@ module Nuntius
 
     def create
       nuntius_params = params.except(:scope, :event, :context, :controller, :action).permit!.to_h
-      Nuntius.event(params[:event], { params[:scope] => params[:context].permit!.to_h }, nuntius_params)
+      Nuntius.event(params[:event], {params[:scope] => params[:context].permit!.to_h}, nuntius_params)
     end
   end
 end

data/app/controllers/nuntius/application_admin_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_controller'
+require_dependency "nuntius/application_controller"
 
 module Nuntius
   class ApplicationAdminController < ApplicationController

data/app/controllers/nuntius/callbacks_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_controller'
-require 'preamble'
+require_dependency "nuntius/application_controller"
+require "preamble"
 
 module Nuntius
   class CallbacksController < ApplicationController
@@ -14,8 +14,8 @@ module Nuntius
       response = message.nuntius_provider(message).callback(params)
 
       render body: response[2].first,
-             content_type: response[1]['Content-Type'],
-             layout: false
+        content_type: response[1]["Content-Type"],
+        layout: false
     end
   end
 end

data/app/controllers/nuntius/dashboard_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_admin_controller'
+require_dependency "nuntius/application_admin_controller"
 
 module Nuntius
   class DashboardController < ApplicationAdminController

data/app/controllers/nuntius/feedback_controller.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_controller'
-require 'httpclient'
+require_dependency "nuntius/application_controller"
 
 module Nuntius
   class FeedbackController < ApplicationController

data/app/controllers/nuntius/inbound_messages/twilio_inbound_smses_controller.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_controller'
-require 'twilio-ruby'
+require_dependency "nuntius/application_controller"
+require "twilio-ruby"
 
 module Nuntius
   module InboundMessages
@@ -29,27 +29,27 @@ module Nuntius
       #   'NumSegments' => '1',
       #   'MessageSid' => 'SMb711289e438f577f230f5837e9c74a08',
       #   'AccountSid' => 'ACf54dd7a47a8011d65b54d472a7190549',
-      #   'From' => '+31641085630',
+      #   'From' => '+31612345678',
       #   'ApiVersion' => '2010-04-01',
       #   'controller' => 'nuntius/inbound_messages/twilio_inbound_smses',
       #   'action' => 'create' }
       def create
-        inbound_message = Nuntius::InboundMessage.find_or_create_by!(transport: 'sms', provider: 'twilio', provider_id: params[:SmsSid])
+        inbound_message = Nuntius::InboundMessage.find_or_create_by!(transport: "sms", provider: "twilio", provider_id: params[:SmsSid])
         inbound_message.from = params[:From]
         inbound_message.to = params[:To]
         inbound_message.text = params[:Body]
         inbound_message.metadata = params
         inbound_message.save!
 
-        twiml = Nuntius::DeliverInboundMessageService.new(inbound_message).call
+        twiml = Nuntius::DeliverInboundMessageService.perform(inbound_message: inbound_message)
 
         # twiml = Twilio::TwiML::MessagingResponse.new do |resp|
         #   resp.message body: 'The Robots are coming! Head for the hills!'
         # end
 
         render body: twiml.to_s,
-               content_type: 'text/xml',
-               layout: false
+          content_type: "text/xml",
+          layout: false
       end
     end
   end

data/app/controllers/nuntius/messages_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require_dependency 'nuntius/application_controller'
+require_dependency "nuntius/application_controller"
 
 module Nuntius
   class MessagesController < ApplicationController

data/app/controllers/nuntius/subscribers_controller.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_dependency "nuntius/application_controller"
+
+module Nuntius
+  class SubscribersController < ApplicationController
+    # skip_before_action :authenticate_user!, only: %i[show destroy]
+
+    def show
+      @subscriber = Nuntius::Subscriber.find_by(id: params[:id])
+      if @subscriber
+        @list = @subscriber.list
+      else
+        flash[:notice] = "Subscription not found."
+        redirect_to root_path, status: :see_other
+      end
+    end
+
+    def subscribe
+      @subscriber = Nuntius::Subscriber.find(params[:id])
+      @subscriber.update(unsubscribed_at: nil)
+      flash[:notice] = "Subscription has been restored."
+      redirect_to nuntius.subscriber_path(@subscriber), status: :see_other
+    end
+
+    def unsubscribe
+      @subscriber = Nuntius::Subscriber.find(params[:id])
+      @subscriber.touch(:unsubscribed_at)
+      flash[:notice] = "Subscription has been removed."
+      redirect_to nuntius.subscriber_path(@subscriber), status: :see_other
+    end
+  end
+end

data/app/drops/nuntius/list_drop.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class ListDrop < ApplicationDrop
+    delegate :id, :name, :allow_unsubscribe, to: :@object
+  end
+end

data/app/drops/nuntius/subscriber_drop.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Nuntius
+  class SubscriberDrop < ApplicationDrop
+    delegate :id, :first_name, :last_name, :name, :list, to: :@object
+  end
+end

data/app/exceptions/nuntius/base_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nuntius
   class BaseException < StandardError
   end

data/app/exceptions/nuntius/missing_messenger_exception.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Nuntius
   class MissingMessengerException < BaseException
   end

data/app/helpers/nuntius/application_helper.rb

@@ -4,11 +4,12 @@ module Nuntius
   module ApplicationHelper
     def nuntius_dashboard_menu
       Satis::Menus::Builder.build(:dashboard) do |m|
-        m.item :templates, link: nuntius.admin_templates_path, icon: 'fal fa-file'
-        m.item :layouts, link: nuntius.admin_layouts_path, icon: 'fal fa-table-layout'
-        m.item :locales, link: nuntius.admin_locales_path, icon: 'fal fa-language'
-        m.item :campaigns, link: nuntius.admin_campaigns_path, icon: 'fal fa-megaphone'
-        m.item :lists, link: nuntius.admin_lists_path, icon: 'fal fa-address-book'
+        m.item :messages, link: nuntius.admin_messages_path, icon: "fal fa-envelope"
+        m.item :templates, link: nuntius.admin_templates_path, icon: "fal fa-file"
+        m.item :layouts, link: nuntius.admin_layouts_path, icon: "fal fa-table-layout"
+        m.item :locales, link: nuntius.admin_locales_path, icon: "fal fa-language"
+        m.item :campaigns, link: nuntius.admin_campaigns_path, icon: "fal fa-megaphone"
+        m.item :lists, link: nuntius.admin_lists_path, icon: "fal fa-address-book"
       end
     end
 
@@ -18,12 +19,6 @@ module Nuntius
       end
     end
 
-    def nuntius_messages_menu
-      Satis::Menus::Builder.build(:messages) do |m|
-        m.item :new, link: nuntius.new_admin_message_path
-      end
-    end
-
     def nuntius_layouts_menu
       Satis::Menus::Builder.build(:layouts) do |m|
         m.item :new, link: nuntius.new_admin_layout_path

data/app/jobs/nuntius/deliver_inbound_message_job.rb

@@ -4,7 +4,7 @@
 module Nuntius
   class DeliverInboundMessageJob < ApplicationJob
     def perform(inbound_message)
-      Nuntius::DeliverInboundMessageService.new(inbound_message).call
+      Nuntius::DeliverInboundMessageService.perform(inbound_message: inbound_message)
     end
   end
 end

data/app/jobs/nuntius/purge_message_job.rb

@@ -2,8 +2,8 @@ module Nuntius
   class PurgeMessageJob < ApplicationJob
     def perform(account_id, months)
       messages = Nuntius::Message.distinct.select(:id).where("metadata ->> 'account_id' = :account", account: account_id)
-      .where(created_at: ..months.months.ago.beginning_of_day)
-      .where.not(status: %w[complaint bounced])
+        .where(created_at: ..months.months.ago.beginning_of_day)
+        .where.not(status: %w[complaint bounced])
 
       Nuntius::Message.where(parent_message_id: messages.pluck(:id)).in_batches.update_all(parent_message_id: nil)
 

data/app/jobs/nuntius/retrieve_mail_job.rb

@@ -7,10 +7,10 @@ module Nuntius
       klasses = Nuntius::BaseMessageBox.message_box_for(transport: :mail)
 
       klasses.each do |klass|
-        RetrieveInboundMailService.new(klass.settings).call
+        RetrieveInboundMailService.perform(settings: klass.settings)
       end
 
-      Nuntius::InboundMessage.where(status: 'pending').each do |message|
+      Nuntius::InboundMessage.where(status: "pending").each do |message|
         Nuntius::DeliverInboundMessageJob.perform_later(message)
       end
     end

data/app/jobs/nuntius/transport_delivery_job.rb

@@ -11,8 +11,8 @@ module Nuntius
         original_message = message
         message = message.dup
         message.parent_message = original_message
-        message.status = 'pending'
-        message.provider_id = ''
+        message.status = "pending"
+        message.provider_id = ""
       end
       message.provider = provider_name
       message.save!