tolliver 2.0.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e7ab72e7ba150c2828de6e3f3defebf06f50bbf09495b9f3bafcc32d4858cf0
-  data.tar.gz: 4dd7b0a65c105f2f11fcf336675a515d41cac6cc278580fd24951891073b60dc
+  metadata.gz: 1c0fa6672c057ce36fec360bddd1f1a7360dcdecb6198678838a6150978a8b12
+  data.tar.gz: 13ddc4dba78f936159bc825f4cee588d66941a9ff296d5fe0abd70b6ae02cbf0
 SHA512:
-  metadata.gz: 4c538087c0161c0968e4f2f4fa31c8ce6ad1a54ea1ee0b924b851f81aa537ed631c839cadb0e258b86a5ba24dee3affa2b5b6dc46983c1f5d16960b91cf562a4
-  data.tar.gz: 05fa597679610a2694f6397992040c4463b9bb9d9458e7f1193431e302c7e2446c67c096838273b5c4fcc42e714f0d53a61d0612abc3a114e6f1ab1b6af06eab
+  metadata.gz: 4e2ddef5141f52daf5bdfb4d648c2420dad063f2ba1fd06d2753eca7f8e56e66184bfa72a60124ab7203e0821119796a398508df86a555d9fa2d7f77ac289736
+  data.tar.gz: 23a5b86b0b8daac5a8f334e3d2bf53fb42b380fda433550c4742216d7631cd408920436467d85224d07c872b8fb3cb80f7db62d2d1403338e99456d6f4d73372

data/README.md

@@ -7,7 +7,7 @@ send it in a batch with different delivery methods:
 - SMS with Plivo provider
 - Whatever custom delivery method
 
-## Installation
+## 1. Installation
 
 Add gem to your Gemfile:
 
@@ -20,7 +20,7 @@ Add database migrations to you application (you can modify DB structure accordin
     $ rake tolliver:install:migrations
     $ rake db:migrate
 
-### Plivo support
+### 1.1. Plivo support
 
 Add gem to your Gemfile:
 
@@ -28,7 +28,7 @@ Add gem to your Gemfile:
 gem 'plivo'
 ```
 
-### Mailgun support
+### 1.2. Mailgun support
 
 Add gem to your Gemfile:
 
@@ -36,7 +36,7 @@ Add gem to your Gemfile:
 gem 'mailgun-ruby'
 ```
 
-## Configuration
+## 2. Configuration
 
 You can configure module through `config/initializers/tolliver.rb` file:
 
@@ -65,7 +65,7 @@ Available options:
 - sms_provider_params
 - delivery_methods
 
-### Plivo support
+### 2.1. Plivo support
 
 Set Plivo as SMS provider and add Plivo auth ID and token into Tolliver configuration file:
 
@@ -80,7 +80,7 @@ Tolliver.setup do |config|
 end
 ```
 
-### Mailgun support
+### 2.2. Mailgun support
 
 Set Mailgun as e-mail provider and add Mailgun API key and domain into Tolliver configuration file:
 
@@ -95,7 +95,7 @@ Tolliver.setup do |config|
 end
 ```
  
-## Usage
+## 3. Usage
 
 To enter new notification into the system, just call `notify` method:
 
@@ -107,8 +107,8 @@ Tolliver.notify(
     {key: :key_2, value: :value_2}
   ], 
   receivers: [
-    {ref: :receiver_1, contact: "receiver_1@domain.tld"},
-    {ref: :receiver_2, contact: "receiver_2@domain.tld"}, 
+    {ref: :receiver_1, email: "receiver_1@domain.tld"},
+    {ref: :receiver_2, email: "receiver_2@domain.tld"}, 
   ]
 )
 ```

data/db/migrate/20210415120000_add_notification_attachments_url.rb

@@ -0,0 +1,6 @@
+class AddNotificationAttachmentsUrl < ActiveRecord::Migration[6.0]
+  def change
+    change_column :notification_attachments, :attachment, :text
+    add_column :notification_attachments, :url, :string
+  end
+end

data/db/migrate/20210528120000_add_short_message_and_phone.rb

@@ -0,0 +1,12 @@
+class AddShortMessageAndPhone < ActiveRecord::Migration[6.0]
+  def change
+    add_column :notification_templates, :short_message, :string
+    add_column :notifications, :short_message, :string
+
+    rename_column :notification_deliveries, :sender_contact, :sender_email
+    add_column :notification_deliveries, :sender_phone, :string
+
+    rename_column :notification_receivers, :receiver_contact, :receiver_email
+    add_column :notification_receivers, :receiver_phone, :string
+  end
+end

data/lib/tolliver.rb

@@ -20,8 +20,8 @@ require "tolliver/models/notification_receiver"
 require "tolliver/models/notification_template"
 
 # Services
-require "tolliver/services/notification"
-require "tolliver/services/delivery"
+require "tolliver/services/notification_service"
+require "tolliver/services/delivery_service"
 require "tolliver/services/policies/batch"
 require "tolliver/services/policies/instantly"
 require "tolliver/services/methods/email"
@@ -30,6 +30,10 @@ require "tolliver/services/methods/email/mailgun"
 require "tolliver/services/methods/sms"
 require "tolliver/services/methods/sms/plivo"
 
+# Jobs
+require "tolliver/jobs/delivery_job"
+require "tolliver/jobs/batch_policy_job"
+
 # Mailers
 require "tolliver/mailers/notification_mailer"
 
@@ -52,19 +56,19 @@ module Tolliver
   # *************************************************************************
 
   def self.notify(options)
-    Tolliver::Services::Notification.instance.notify(options)
+    Tolliver::Services::NotificationService.instance.notify(options)
   end
 
   def self.deliver(notification)
-    Tolliver::Services::Delivery.instance.deliver(notification)
+    Tolliver::Services::DeliveryService.instance.deliver(notification)
   end
 
   def self.enqueue_for_delivery(notification)
-    Tolliver::Services::Delivery.instance.enqueue_for_delivery(notification)
+    Tolliver::Services::DeliveryService.instance.enqueue_for_delivery(notification)
   end
 
   def self.reset_delivery(notification)
-    Tolliver::Services::Delivery.instance.reset_delivery(notification)
+    Tolliver::Services::DeliveryService.instance.reset_delivery(notification)
   end
 
   # *************************************************************************

data/lib/tolliver/jobs/batch_policy_job.rb

@@ -0,0 +1,19 @@
+module Tolliver
+  module Jobs
+    class BatchPolicyJob < ActiveJob::Base
+      queue_as :default
+
+      def perform(notification_delivery_id, batch_size)
+
+        # Instantiate notification delivery object
+        notification_delivery = Tolliver.notification_delivery_model.find_by_id(notification_delivery_id)
+        return nil if notification_delivery.nil? || notification_delivery.policy != :batch
+
+        # Call policy logic
+        policy_service = Tolliver::Services::Policies::Batch.new
+        policy_service.deliver_batch_and_enqueue(notification_delivery, batch_size)
+
+      end
+    end
+  end
+end

data/lib/tolliver/jobs/delivery_job.rb

@@ -0,0 +1,18 @@
+module Tolliver
+  module Jobs
+    class DeliveryJob < ActiveJob::Base
+      queue_as :default
+
+      def perform(notification_id)
+
+        # Instantiate notification object
+        notification = Tolliver.notification_model.find_by_id(notification_id)
+        return nil if notification.nil?
+
+        # Call standard API
+        Tolliver::Services::DeliveryService.instance.deliver(notification)
+
+      end
+    end
+  end
+end

data/lib/tolliver/mailers/notification_mailer.rb

@@ -29,11 +29,11 @@ module Tolliver
 
         # Attachments
         notification.notification_attachments.each do |notification_attachment|
-          attachments[notification_attachment.name] = notification_attachment.attachment
+          attachments[notification_attachment.name] = notification_attachment.read if notification_attachment.read
         end
 
         # Mail
-        mail(from: @sender_email, to: @notification_receiver.receiver_contact.to_s, subject: @notification.subject)
+        mail(from: @sender_email, to: @notification_receiver.receiver_email.to_s, subject: @notification.subject)
       end
 
     end

data/lib/tolliver/models/notification.rb

@@ -52,15 +52,15 @@ module Tolliver
       # ***********************************************************************
 
       def deliver
-        Tolliver::Services::Delivery.instance.deliver(self)
+        Tolliver::Services::DeliveryService.instance.deliver(self)
       end
 
       def enqueue_for_delivery
-        Tolliver::Services::Delivery.instance.enqueue_for_delivery(self)
+        Tolliver::Services::DeliveryService.instance.enqueue_for_delivery(self)
       end
 
       def reset_delivery
-        Tolliver::Services::Delivery.instance.reset_delivery(self)
+        Tolliver::Services::DeliveryService.instance.reset_delivery(self)
       end
 
     end

data/lib/tolliver/models/notification_attachment.rb

@@ -30,6 +30,18 @@ module Tolliver
 
       end
 
+      def read
+        if @data.nil?
+          unless self.attachment.blank?
+            @data = Base64.strict_decode64(self.attachment) rescue nil
+          end
+          unless self.url.blank?
+            @data = open(self.url) { |f| f.read }
+          end
+        end
+        @data
+      end
+
     end
   end
 end

data/lib/tolliver/models/notification_receiver.rb

@@ -26,7 +26,7 @@ module Tolliver
         # Validators
         # *********************************************************************
 
-        validates_presence_of :notification_delivery_id, :receiver_ref, :receiver_contact
+        validates_presence_of :notification_delivery_id, :receiver_ref
 
         # *********************************************************************
         # State

data/lib/tolliver/services/{delivery.rb → delivery_service.rb}

@@ -13,23 +13,12 @@ require 'singleton'
 
 module Tolliver
   module Services
-    class Delivery
+    class DeliveryService
       include Singleton
 
       def enqueue_for_delivery(notification)
         return nil if notification.nil?
-        QC.enqueue("#{self.class.to_s}.deliver", notification.id)
-      end
-
-      # Entry point for QC
-      def self.deliver(notification_id)
-
-        # Instantiate notification object
-        notification = Tolliver.notification_model.find_by_id(notification_id)
-        return nil if notification.nil?
-
-        # Call standard API
-        self.instance.deliver(notification)
+        Tolliver::Jobs::DeliveryJob.perform_later(notification.id)
       end
 
       # Deliver notification to receivers by all configured methods

data/lib/tolliver/services/methods/email.rb

@@ -14,6 +14,23 @@ module Tolliver
     module Methods
       class Email
 
+        def is_notification_valid?(notification)
+          return false if notification.subject.blank?
+          return false if notification.message.blank?
+          true
+        end
+
+        def is_notification_delivery_valid?(notification_delivery)
+          return false if !notification_delivery.sender_email.blank? && !(notification_delivery.sender_email =~ URI::MailTo::EMAIL_REGEXP)
+          true
+        end
+
+        def is_notification_receiver_valid?(notification_receiver)
+          return false if notification_receiver.receiver_email.blank?
+          return false unless notification_receiver.receiver_email =~ URI::MailTo::EMAIL_REGEXP
+          true
+        end
+
         def deliver(notification_receiver)
           return false if provider.nil?
 

data/lib/tolliver/services/methods/email/mailgun.rb

@@ -29,17 +29,19 @@ module Tolliver
             # Sender
             raise Tolliver::Errors::StandardError.new("Please specify e-mail sender.") if Tolliver.email_sender.nil?
 
-            # Message builder
+            # Build message
             message = ::Mailgun::MessageBuilder.new
             message.from(Tolliver.email_sender, {'full_name' => Tolliver.email_sender_name})
-            message.add_recipient(:to, notification_receiver.receiver_contact.to_s)
-            message.reply_to(notification_receiver.notification_delivery.sender_contact.to_s) unless notification_receiver.notification_delivery.sender_contact.blank?
+            message.add_recipient(:to, notification_receiver.receiver_email.to_s)
+            message.reply_to(notification_receiver.notification_delivery.sender_email.to_s) unless notification_receiver.notification_delivery.sender_email.blank?
             message.subject(notification.subject)
             message.body_text(ActionController::Base.helpers.strip_tags(notification.message.to_s))
             message.body_html(notification.message)
             notification.notification_attachments.each do |notification_attachment|
-              message.add_attachment(StringIO.new(notification_attachment.attachment), notification_attachment.name)
+              message.add_attachment(StringIO.new(notification_attachment.read), notification_attachment.name) if notification_attachment.read
             end
+
+            # Request API
             response = @client.send_message(@domain, message)
             if response.code != 200
               raise Tolliver::Errors::StandardError.new(response.body)

data/lib/tolliver/services/methods/sms.rb

@@ -14,6 +14,20 @@ module Tolliver
     module Methods
       class Sms
 
+        def is_notification_valid?(notification)
+          return false if notification.short_message.blank?
+          true
+        end
+
+        def is_notification_delivery_valid?(_)
+          true
+        end
+
+        def is_notification_receiver_valid?(notification_receiver)
+          return false if notification_receiver.receiver_phone.blank?
+          true
+        end
+
         def deliver(notification_receiver)
           return false if provider.nil?
 

data/lib/tolliver/services/methods/sms/plivo.rb

@@ -22,23 +22,18 @@ module Tolliver
             end
             @auth_id = params[:auth_id]
             @auth_token = params[:auth_token]
-            @api = ::Plivo::RestAPI.new(@auth_id, @auth_token)
+            @client = ::Plivo::RestClient.new(@auth_id, @auth_token)
           end
 
           def deliver(notification, notification_receiver)
 
-            # Check message length.
-            if message.bytesize > 200
-              raise 'Message too long.'
-            end
+            # Sender
+            raise Tolliver::Errors::StandardError.new("Please specify SMS sender.") if Tolliver.sms_sender.nil?
 
             # Request API
-            response = @api.send_message({
-                                             'src' => Tolliver.sms_sender, # TODO: This should be improved to take sender from number pool and remember number / message mapping
-                                             'dst' => notification_receiver.receiver_contact.to_s,
-                                             'text' => ActionController::Base.helpers.strip_tags(notification.message.to_s),
-                                             'method' => 'POST'
-                                         })
+            @client.message.create(Tolliver.sms_sender, # TODO: This should be improved to take sender from number pool and remember number / message mapping
+                                   [notification_receiver.receiver_phone.to_s],
+                                   ActionController::Base.helpers.strip_tags(notification.short_message.to_s))
 
             true
           end

data/lib/tolliver/services/{notification.rb → notification_service.rb}

@@ -13,7 +13,7 @@ require 'singleton'
 
 module Tolliver
   module Services
-    class Notification
+    class NotificationService
       include Singleton
 
       def notify(options)
@@ -29,17 +29,23 @@ module Tolliver
           raise Tolliver::Errors::BadRequest.new('Missing template.') if template.blank?
           notification_template = Tolliver.notification_template_model.where(ref: template).first
           notification_template = Tolliver.notification_template_model.where(id: template).first if notification_template.nil?
+          if notification_template.nil? && template.to_s == 'common'
+            notification_template = Tolliver.notification_template_model.new(subject: '%{subject}',
+                                                                             message: '%{message}', short_message: '%{message}',
+                                                                             is_disabled: false, is_dry: false)
+          end
           raise Tolliver::Errors::NotFound.new("Template #{template.to_s} not found.") if notification_template.nil?
 
-          if !notification_template.is_disabled && !notification_template.message.blank?
+          if !notification_template.is_disabled
 
             # Interpret params and store it in DB
             params = map_params(options[:params] || {})
-            notification.message = interpret_named_params(notification_template.message, params)
-            notification.subject = interpret_named_params(notification_template.subject, params)
+            notification.subject = eval_expressions(interpret_named_params(notification_template.subject.to_s, params))
+            notification.message = eval_expressions(interpret_named_params(notification_template.message.to_s, params))
+            notification.short_message = eval_expressions(interpret_named_params(notification_template.short_message.to_s, params))
 
             # Notification template
-            notification.notification_template = notification_template
+            notification.notification_template = notification_template unless notification_template.new_record?
 
             # Signature
             unless options[:signature].blank?
@@ -55,8 +61,10 @@ module Tolliver
               attachments = [attachments] unless attachments.is_a?(Array)
               attachments.each do |attachment|
                 raise Tolliver::Errors::BadRequest.new('Missing attachment name.') if attachment[:name].blank?
-                raise Tolliver::Errors::BadRequest.new('Missing attachment data.') if attachment[:attachment].blank?
-                notification.notification_attachments.create(name: attachment[:name], attachment: attachment[:attachment])
+                if attachment[:attachment].blank? && attachment[:url].blank?
+                  raise Tolliver::Errors::BadRequest.new('Missing attachment data or URL.')
+                end
+                notification.notification_attachments.create(name: attachment[:name], attachment: attachment[:attachment], url: attachment[:url])
               end
             end
 
@@ -75,7 +83,10 @@ module Tolliver
               methods.each do |method|
 
                 # Delivery object
-                notification_delivery = notification.notification_deliveries.create(method: method)
+                notification_delivery = notification.notification_deliveries.build(method: method)
+
+                # Validate notification suitability for the selected method
+                next unless notification_delivery.method_service.is_notification_valid?(notification)
 
                 # Is postponed
                 if options[:is_postponed]
@@ -84,26 +95,38 @@ module Tolliver
 
                 # Sender
                 unless options[:sender].blank?
-                  raise Tolliver::Errors::BadRequest.new('Missing sender ref.') if options[:sender][:ref].blank?
-                  raise Tolliver::Errors::BadRequest.new('Missing sender contact.') if options[:sender][:contact].blank?
                   notification_delivery.sender_ref = options[:sender][:ref]
-                  notification_delivery.sender_contact = options[:sender][:contact]
+                  notification_delivery.sender_email = options[:sender][:email]
+                  notification_delivery.sender_phone = options[:sender][:phone]
+                  raise Tolliver::Errors::BadRequest.new('Missing sender ref.') if notification_delivery.sender_ref.blank?
+                  unless notification_delivery.method_service.is_notification_delivery_valid?(notification_delivery) # throw exception if sender not valid
+                    raise Tolliver::Errors::BadRequest.new('Sender contact not valid.')
+                  end
                 end
 
+                # Must be persisted in DB before receiver created
+                notification_delivery.save
+
                 # Receivers
                 receivers = options[:receivers] || []
                 raise Tolliver::Errors::BadRequest.new('Missing receivers.') if receivers.blank? || receivers.empty?
                 receivers = [receivers] unless receivers.is_a?(Array)
-                filtered_receivers = receivers.dup # TODO contact validation based on method and filter
 
-                # Save to DB
-                filtered_receivers.each do |receiver|
-                  raise Tolliver::Errors::BadRequest.new('Missing sender ref.') if receiver[:ref].blank?
-                  raise Tolliver::Errors::BadRequest.new('Missing sender contact.') if receiver[:contact].blank?
-                  notification_delivery.notification_receivers.create(receiver_ref: receiver[:ref], receiver_contact: receiver[:contact])
+                # Save to DB if valid for the selected method
+                receivers_count = 0
+                receivers.each do |receiver|
+                  notification_receiver = notification_delivery.notification_receivers.build
+                  notification_receiver.receiver_ref = receiver[:ref]
+                  notification_receiver.receiver_email = receiver[:email]
+                  notification_receiver.receiver_phone = receiver[:phone]
+                  raise Tolliver::Errors::BadRequest.new('Missing receiver ref.') if notification_receiver.receiver_ref.blank?
+                  if notification_delivery.method_service.is_notification_receiver_valid?(notification_receiver) # ignore receiver if not valid
+                    notification_receiver.save
+                    receivers_count += 1
+                  end
                 end
                 notification_delivery.sent_count = 0
-                notification_delivery.receivers_count = filtered_receivers.size
+                notification_delivery.receivers_count = receivers_count
                 notification_delivery.save
 
               end
@@ -111,7 +134,7 @@ module Tolliver
             end
 
           else
-            notification = nil # Do not create notification with empty message
+            notification = nil # Do not create disabled notification
           end
 
         end
@@ -147,7 +170,19 @@ module Tolliver
         end
       end
 
-      def interpret_positional_params(text, params)
+      def eval_expressions(text)
+        text.gsub(/%{[^{}]+}/) do |match|
+          template_to_eval = match[2..-2].to_s.strip
+          begin
+            evaluated_match = eval(template_to_eval) # evaluate match
+          rescue
+            evaluated_match = ""
+          end
+          evaluated_match
+        end
+      end
+
+      def interpret_positional_params_and_eval_expressions(text, params)
         text.gsub(/%{[^{}]+}/) do |match|
           template_to_eval = match[2..-2].gsub(/%([0-9]+)/, "params[\\1]") # substitute all %1, %2, %3, ... to a form which can be evaluated
           begin

data/lib/tolliver/services/policies/batch.rb

@@ -19,26 +19,15 @@ module Tolliver
           # Input validation
           return nil if notification_delivery.nil? || notification_delivery.policy != :batch
 
-          # Enqueue in QC
-          QC.enqueue("#{self.class.to_s}.deliver", notification_delivery.id, batch_size)
+          # Enqueue
+          Tolliver::Jobs::BatchPolicyJob.perform_later(notification_delivery.id, batch_size)
         end
 
-        # Entry point for QC
-        def self.deliver(notification_delivery_id, batch_size = 10)
+        def deliver_batch_and_enqueue(notification_delivery, batch_size = 10)
 
-          # Instantiate notification delivery object
-          notification_delivery = Tolliver.notification_delivery_model.find_by_id(notification_delivery_id)
+          # Input validation
           return nil if notification_delivery.nil? || notification_delivery.policy != :batch
 
-          # Call internal logic
-          policy_service = self.new
-          policy_service.send(:deliver_batch_and_enqueue, notification_delivery, batch_size)
-        end
-
-        protected
-
-        def deliver_batch_and_enqueue(notification_delivery, batch_size = 10)
-
           # Send single batch
           remaining = deliver_batch(notification_delivery, batch_size)
 
@@ -59,6 +48,9 @@ module Tolliver
 
         def deliver_batch(notification_delivery, batch_size = 10)
 
+          # Input validation
+          return nil if notification_delivery.nil? || notification_delivery.policy != :batch
+
           # Nothing to do
           return 0 if notification_delivery.sent_count == notification_delivery.receivers_count
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tolliver
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Matěj Outlý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-03 00:00:00.000000000 Z
+date: 2021-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,24 +50,28 @@ files:
 - db/migrate/20160509144238_create_notification_templates.rb
 - db/migrate/20170630190600_create_notification_deliveries.rb
 - db/migrate/20201027150000_create_notification_attachments.rb
+- db/migrate/20210415120000_add_notification_attachments_url.rb
+- db/migrate/20210528120000_add_short_message_and_phone.rb
 - lib/tolliver.rb
 - lib/tolliver/engine.rb
 - lib/tolliver/errors/bad_request.rb
 - lib/tolliver/errors/not_found.rb
 - lib/tolliver/errors/standard_error.rb
+- lib/tolliver/jobs/batch_policy_job.rb
+- lib/tolliver/jobs/delivery_job.rb
 - lib/tolliver/mailers/notification_mailer.rb
 - lib/tolliver/models/notification.rb
 - lib/tolliver/models/notification_attachment.rb
 - lib/tolliver/models/notification_delivery.rb
 - lib/tolliver/models/notification_receiver.rb
 - lib/tolliver/models/notification_template.rb
-- lib/tolliver/services/delivery.rb
+- lib/tolliver/services/delivery_service.rb
 - lib/tolliver/services/methods/email.rb
 - lib/tolliver/services/methods/email/mailgun.rb
 - lib/tolliver/services/methods/email/smtp.rb
 - lib/tolliver/services/methods/sms.rb
 - lib/tolliver/services/methods/sms/plivo.rb
-- lib/tolliver/services/notification.rb
+- lib/tolliver/services/notification_service.rb
 - lib/tolliver/services/policies/batch.rb
 - lib/tolliver/services/policies/instantly.rb
 - lib/tolliver/utils/enum.rb