tolliver 2.0.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 560d3dcb05343bbf964e6a418c95bc4960d7cd9ba6e8e01698455a93077a99ed
-  data.tar.gz: 8365863b679d97581dbd9d2288dd4043f4040a283e4f649ce1b86ba4aa882454
+  metadata.gz: 45746e4382ed1970ae1a7dc297f096d0616c824d4bf319949931372845aeb74d
+  data.tar.gz: 2445b15788d28a73cbde7d0e2f3e28cf090a9c886e9c56d4c4acb2fa9a7edc42
 SHA512:
-  metadata.gz: 353704eedb8fd167d864ac1d19fd738eb81fd644bfe3072ee78d4b08087a0d04f699acbd3c75d2487505f399a95856cf5bfdd80ed49f10fbf42eb6d17eb60bd6
-  data.tar.gz: 719f0dc978ab83ecbb6eba6c0a1814d52318b3b3f18c5d415249ba475478767aaf75cea4b210666dc0f7eefa40c00657e86d6585f47076525aa094dd23011b5d
+  metadata.gz: 6693df6712589159a779c7eca498047d5a59f6db0992716622a821c0fc6d726739d32df94be7598a2b5705e3b45091e4f48744b06cdc2f4ff607b3359d3d8a7d
+  data.tar.gz: 0036c0fa396f8ace9fef5502b3a5984b47246fc6305dca95d9a45bcd10388e0057c85cef4d07adda19bc5fea738fa7b73b285e60fbc6f23d3ffeac086fe914e6

data/README.md

@@ -3,8 +3,8 @@ A long serving Junior Postman Tolliver Groat. With this gem you can create
 notifications based on templates defined by the system administrator and 
 send it in a batch with different delivery methods:
 
-- E-mail
-- SMS
+- E-mail with SMTP aor Mailgun provider
+- SMS with Plivo provider
 - Whatever custom delivery method
 
 ## Installation
@@ -20,13 +20,29 @@ Add database migrations to you application (you can modify DB structure accordin
     $ rake tolliver:install:migrations
     $ rake db:migrate
 
+### Plivo support
+
+Add gem to your Gemfile:
+
+```ruby
+gem 'plivo'
+```
+
+### Mailgun support
+
+Add gem to your Gemfile:
+
+```ruby
+gem 'mailgun-ruby'
+```
+
 ## Configuration
 
 You can configure module through `config/initializers/tolliver.rb` file:
 
 ```ruby
 Tolliver.setup do |config|
-  config.mailer_sender = 'no-reply@domain.com'
+  config.email_sender = 'no-reply@domain.com'
   config.delivery_methods = [
       :email
   ]
@@ -42,11 +58,43 @@ Available options:
 - notification_template_model
 - email_sender
 - email_sender_name
+- email_provider
+- email_provider_params
 - sms_sender
 - sms_provider
 - sms_provider_params
 - delivery_methods
 
+### Plivo support
+
+Set Plivo as SMS provider and add Plivo auth ID and token into Tolliver configuration file:
+
+```ruby
+Tolliver.setup do |config|
+  ...
+  config.sms_provider = :plivo
+  config.sms_provider_params = {
+    auth_id: 'secret',
+    auth_token: 'secret'
+  }
+end
+```
+
+### Mailgun support
+
+Set Mailgun as e-mail provider and add Mailgun API key and domain into Tolliver configuration file:
+
+```ruby
+Tolliver.setup do |config|
+  ...
+  config.email_provider = :mailgun
+  config.email_provider_params = {
+      api_key: 'key-secret',
+      domain: 'domain.tld'
+  }
+end
+```
+ 
 ## Usage
 
 To enter new notification into the system, just call `notify` method:

data/app/views/tolliver/notification_mailer/notify.html.erb

@@ -1 +1 @@
-<%= @notification.message.html_safe %>
+<%= @notification.message.to_s.html_safe %>

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/lib/tolliver.rb

@@ -20,12 +20,19 @@ 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"
+require "tolliver/services/methods/email/smtp"
+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"
@@ -49,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
 
   # *************************************************************************
@@ -149,16 +156,24 @@ module Tolliver
   mattr_accessor :email_sender_name
   #@@email_sender_name = "Test sender" to be set in module initializer if needed
 
+  # Used e-mail provider
+  mattr_accessor :email_provider
+  @@email_provider = :smtp
+
+  # E-mail provider params
+  mattr_accessor :email_provider_params
+  @@email_provider_params = {}
+
+  # Used SMS provider
+  mattr_accessor :sms_sender
+  #@@sms_sender = "+420 123 456 789" to be set in module initializer if needed
+
   # Used SMS provider
   mattr_accessor :sms_provider
-  @@sms_provider = :plivo
+  @@sms_provider = nil
 
   # SMS provider params
   mattr_accessor :sms_provider_params
   @@sms_provider_params = {}
 
-  # Used SMS provider
-  mattr_accessor :sms_sender
-  #@@sms_sender = "+420 123 456 789" to be set in module initializer if needed
-
 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

@@ -18,7 +18,7 @@ module Tolliver
 
         # Sender
         @sender_email = Tolliver.email_sender
-        raise Tolliver::Errors::StandardError.new("Please specify sender.") if @sender_email.nil?
+        raise Tolliver::Errors::StandardError.new("Please specify e-mail sender.") if @sender_email.nil?
         unless Tolliver.email_sender_name.blank?
           @sender_email = "#{Tolliver.email_sender_name} <#{@sender_email}>"
         end
@@ -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, subject: @notification.subject)
+        mail(from: @sender_email, to: @notification_receiver.receiver_contact.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/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

@@ -15,11 +15,14 @@ module Tolliver
       class Email
 
         def deliver(notification_receiver)
+          return false if provider.nil?
+
+          # Prepare notification
           notification = notification_receiver.notification_delivery.notification
 
           # Send email
           begin
-            Tolliver::NotificationMailer.notify(notification, notification_receiver).deliver_now
+            provider.deliver(notification, notification_receiver)
             notification_receiver.status = 'sent'
           #rescue Net::SMTPFatalError, Net::SMTPSyntaxError
           rescue StandardError => e
@@ -36,6 +39,16 @@ module Tolliver
           true
         end
 
+        protected
+
+        def provider
+          if @provider.nil? && Tolliver.email_provider
+            provider_class_name = "Tolliver::Services::Methods::Email::#{Tolliver.email_provider.to_s.camelize}"
+            @provider = provider_class_name.constantize.new(Tolliver.email_provider_params)
+          end
+          @provider
+        end
+
       end
     end
   end

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

@@ -0,0 +1,55 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Mailgun e-mail provider
+# *
+# * Author: Matěj Outlý
+# * Date  : 1. 12. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Methods
+      class Email
+        class Mailgun
+
+          def initialize(params = {})
+            require 'mailgun-ruby'
+            if params[:api_key].blank? || params[:domain].blank?
+              raise Tolliver::Errors::StandardError.new('Please provide API key and domain in e-mail provider params.')
+            end
+            @client = ::Mailgun::Client.new(params[:api_key])
+            @domain = params[:domain]
+          end
+
+          def deliver(notification, notification_receiver)
+
+            # Sender
+            raise Tolliver::Errors::StandardError.new("Please specify e-mail sender.") if Tolliver.email_sender.nil?
+
+            # Message builder
+            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.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.read), notification_attachment.name) if notification_attachment.read
+            end
+            response = @client.send_message(@domain, message)
+            if response.code != 200
+              raise Tolliver::Errors::StandardError.new(response.body)
+            end
+
+            true
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * SMTP e-mail provider
+# *
+# * Author: Matěj Outlý
+# * Date  : 1. 12. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Methods
+      class Email
+        class Smtp
+
+          def initialize(params = {}) end
+
+          def deliver(notification, notification_receiver)
+            Tolliver::NotificationMailer.notify(notification, notification_receiver).deliver_now
+          end
+
+        end
+      end
+    end
+  end
+end

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

@@ -15,11 +15,14 @@ module Tolliver
       class Sms
 
         def deliver(notification_receiver)
+          return false if provider.nil?
+
+          # Prepare notification
           notification = notification_receiver.notification_delivery.notification
 
           # Send SMS
           begin
-            provider.deliver(notification_receiver.receiver_contact, notification.message.strip_tags)
+            provider.deliver(notification, notification_receiver)
             notification_receiver.status = 'sent'
           rescue StandardError => e
             notification_receiver.status = 'error'
@@ -38,7 +41,7 @@ module Tolliver
         protected
 
         def provider
-          if @provider.nil?
+          if @provider.nil? && Tolliver.sms_provider
             provider_class_name = "Tolliver::Services::Methods::Sms::#{Tolliver.sms_provider.to_s.camelize}"
             @provider = provider_class_name.constantize.new(Tolliver.sms_provider_params)
           end

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

@@ -9,24 +9,23 @@
 # *
 # *****************************************************************************
 
-require 'plivo'
-
 module Tolliver
   module Services
     module Methods
-      module Sms
+      class Sms
         class Plivo
 
           def initialize(params = {})
+            require 'plivo'
             if params[:auth_id].blank? || params[:auth_token].blank?
-              raise Tolliver::Errors::StandardError.new('Please provide Auth ID and Auth Token in provider params.')
+              raise Tolliver::Errors::StandardError.new('Please provide Auth ID and Auth Token in SMS provider params.')
             end
             @auth_id = params[:auth_id]
             @auth_token = params[:auth_token]
             @api = ::Plivo::RestAPI.new(@auth_id, @auth_token)
           end
 
-          def deliver(receiver, message)
+          def deliver(notification, notification_receiver)
 
             # Check message length.
             if message.bytesize > 200
@@ -36,8 +35,8 @@ module Tolliver
             # 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' => receiver.to_s,
-                                             'text' => message.to_s,
+                                             'dst' => notification_receiver.receiver_contact.to_s,
+                                             'text' => ActionController::Base.helpers.strip_tags(notification.message.to_s),
                                              'method' => 'POST'
                                          })
 

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)
@@ -35,8 +35,8 @@ module Tolliver
 
             # 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.message = eval_expressions(interpret_named_params(notification_template.message, params))
+            notification.subject = eval_expressions(interpret_named_params(notification_template.subject, params))
 
             # Notification template
             notification.notification_template = notification_template
@@ -55,8 +55,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
 
@@ -98,8 +100,8 @@ module Tolliver
 
                 # 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?
+                  raise Tolliver::Errors::BadRequest.new('Missing receiver ref.') if receiver[:ref].blank?
+                  raise Tolliver::Errors::BadRequest.new('Missing receiver contact.') if receiver[:contact].blank?
                   notification_delivery.notification_receivers.create(receiver_ref: receiver[:ref], receiver_contact: receiver[:contact])
                 end
                 notification_delivery.sent_count = 0
@@ -147,7 +149,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.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Matěj Outlý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2021-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,22 +50,27 @@ 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
 - 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