tolliver 2.1.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a1110eda739a5bb9763c51608a6a251c356962bc02690b2b5b81d06239d0893
-  data.tar.gz: 4ab466afccc3086a66c4d50ecc7c87214b89aa734553f64b8e7f73c93ec491a5
+  metadata.gz: 071baa1e13612b56607c74a22057e7a35dff214916a5cb6f8cf2a7640a54facf
+  data.tar.gz: d1b9e7e25cc83abc2ca03e2382dfd965fa8eb2bebd872696aa0e2f578247a7ef
 SHA512:
-  metadata.gz: 5901317de7117ceca9fcc6396706d018d62d99ebaf69b7361fe2118766c9bf87a6ac684c8169815818b9ac66fe06e9cd6c0326d86ea6f46202abc6352f7d9365
-  data.tar.gz: 65913171587f3632ed28e43a00827b109a84b8497ffd39651f1002da4ce7cc0a57a8ccaa43982ecf1ef949e3e0e45f7b9fc85328009784c2b88e51a29d2a6d3f
+  metadata.gz: 165fb812806151315d58b2482ac909d06dfbff0796d6d35eb19640b736988547f89dae17c71aadbfc01603cff4cdbdc82c2f7d9ee94a6d3c9f7a2439858a4f5b
+  data.tar.gz: 7d2ae9b7a4117cffa8f8baa260e338a890d3f9fc6b1a16a046a1b8d803369390179e12263cd46138a653758acf9cd873a31ee3d88100a0c02f3a4518f6cfada7

data/README.md

@@ -5,9 +5,10 @@ send it in a batch with different delivery methods:
 
 - E-mail with SMTP aor Mailgun provider
 - SMS with Plivo provider
+- Slack
 - Whatever custom delivery method
 
-## Installation
+## 1. Installation
 
 Add gem to your Gemfile:
 
@@ -20,23 +21,29 @@ 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:
 
 ```ruby
 gem 'plivo'
 ```
-
-### Mailgun support
+### 1.2. Mailgun support
 
 Add gem to your Gemfile:
 
 ```ruby
 gem 'mailgun-ruby'
 ```
+### 1.3. Slack support
+
+Add gem to your Gemfile:
+
+```ruby
+gem 'slack-ruby-client'
+````
 
-## Configuration
+## 2. Configuration
 
 You can configure module through `config/initializers/tolliver.rb` file:
 
@@ -63,9 +70,10 @@ Available options:
 - sms_sender
 - sms_provider
 - sms_provider_params
+- slack_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 +88,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 +103,7 @@ Tolliver.setup do |config|
 end
 ```
  
-## Usage
+## 3. Usage
 
 To enter new notification into the system, just call `notify` method:
 
@@ -107,8 +115,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/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/db/migrate/20220805120000_add_slack_id.rb

@@ -0,0 +1,5 @@
+class AddSlackId < ActiveRecord::Migration[6.0]
+  def change
+    add_column :notification_receivers, :receiver_slack_id, :string
+  end
+end

data/lib/tolliver/mailers/notification_mailer.rb

@@ -33,7 +33,7 @@ module Tolliver
         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

@@ -23,13 +23,7 @@ module Tolliver
         has_many :notification_deliveries, class_name: Tolliver.notification_delivery_model.to_s, dependent: :destroy
         has_many :notification_receivers, class_name: Tolliver.notification_receiver_model.to_s, through: :notification_deliveries
         has_many :notification_attachments, class_name: Tolliver.notification_attachment_model.to_s, dependent: :destroy
-        belongs_to :notification_template, class_name: Tolliver.notification_template_model.to_s
-
-        # *********************************************************************
-        # Validators
-        # *********************************************************************
-
-        validates_presence_of :subject
+        belongs_to :notification_template, class_name: Tolliver.notification_template_model.to_s, optional: true
 
       end
 

data/lib/tolliver/models/notification_attachment.rb

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

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/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.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/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/slack.rb

@@ -0,0 +1,90 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification method - Slack
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Methods
+      class Slack
+
+        def is_notification_valid?(notification)
+          return false if notification.message.blank?
+          true
+        end
+
+        def is_notification_delivery_valid?(_)
+          true
+        end
+
+        def is_notification_receiver_valid?(notification_receiver)
+          return false if notification_receiver.receiver_slack_id.blank? && notification_receiver.receiver_email.blank?
+          true
+        end
+
+        def deliver(notification_receiver)
+
+          # Prepare notification
+          notification = notification_receiver.notification_delivery.notification
+
+          # Send message
+          begin
+            ensure_slack_id(notification_receiver)
+            client.chat_postMessage(channel: notification_receiver.receiver_slack_id, text: notification.message)
+            notification_receiver.status = 'sent'
+          rescue StandardError => e
+            notification_receiver.status = 'error'
+            notification_receiver.error_message = e.message
+          end
+
+          # Mark as sent
+          notification_receiver.sent_at = Time.current
+
+          # Save
+          notification_receiver.save
+
+          true
+        end
+
+        private
+
+        def ensure_slack_id(notification_receiver)
+          if notification_receiver.receiver_slack_id.blank?
+            unless notification_receiver.receiver_email.blank?
+              response = client.users_lookupByEmail(email: notification_receiver.receiver_email)
+              if response.ok
+                notification_receiver.receiver_slack_id = response.user.id
+                notification_receiver.save(validate: false)
+              end
+            end
+          end
+          if notification_receiver.receiver_slack_id.blank?
+            raise Tolliver::Errors::StandardError.new('Receiver Slack ID not recognized.')
+          end
+        end
+
+        def client
+          if @client.nil?
+            require 'slack'
+            api_token = Tolliver.slack_params[:api_token]
+            if api_token.blank?
+              raise Tolliver::Errors::StandardError.new('Please provide API Token in Slack params.')
+            end
+            ::Slack.configure do |config|
+              config.token = api_token
+            end
+            @client = ::Slack::Web::Client.new
+          end
+          @client
+        end
+
+      end
+    end
+  end
+end

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/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/notification_service.rb

@@ -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 = eval_expressions(interpret_named_params(notification_template.message, params))
-            notification.subject = eval_expressions(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?
@@ -47,7 +53,7 @@ module Tolliver
             end
 
             # Save to DB
-            notification.save
+            notification.save!
 
             # Attachments
             unless options[:attachments].blank?
@@ -77,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]
@@ -86,34 +95,46 @@ 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 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])
+                # 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.save
+                notification_delivery.receivers_count = receivers_count
+                notification_delivery.save!
 
               end
 
             end
 
           else
-            notification = nil # Do not create notification with empty message
+            notification = nil # Do not create disabled notification
           end
 
         end

data/lib/tolliver.rb

@@ -29,6 +29,7 @@ require "tolliver/services/methods/email/smtp"
 require "tolliver/services/methods/email/mailgun"
 require "tolliver/services/methods/sms"
 require "tolliver/services/methods/sms/plivo"
+require "tolliver/services/methods/slack"
 
 # Jobs
 require "tolliver/jobs/delivery_job"
@@ -134,6 +135,7 @@ module Tolliver
   # Available methods:
   # - email
   # - sms
+  # - slack
   # - whatever
   mattr_accessor :delivery_methods
   @@delivery_methods = [
@@ -170,10 +172,14 @@ module Tolliver
 
   # Used SMS provider
   mattr_accessor :sms_provider
-  @@sms_provider = nil
+  @@sms_provider = :plivo
 
   # SMS provider params
   mattr_accessor :sms_provider_params
   @@sms_provider_params = {}
 
+  # Slack provider params
+  mattr_accessor :slack_params
+  @@slack_params = {}
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tolliver
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Matěj Outlý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-14 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -51,6 +51,8 @@ files:
 - 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
+- db/migrate/20220805120000_add_slack_id.rb
 - lib/tolliver.rb
 - lib/tolliver/engine.rb
 - lib/tolliver/errors/bad_request.rb
@@ -68,6 +70,7 @@ files:
 - lib/tolliver/services/methods/email.rb
 - lib/tolliver/services/methods/email/mailgun.rb
 - lib/tolliver/services/methods/email/smtp.rb
+- lib/tolliver/services/methods/slack.rb
 - lib/tolliver/services/methods/sms.rb
 - lib/tolliver/services/methods/sms/plivo.rb
 - lib/tolliver/services/notification_service.rb