tolliver 1.0.0

data/db/migrate/20170630190600_create_notification_deliveries.rb

@@ -0,0 +1,20 @@
+class CreateNotificationDeliveries < ActiveRecord::Migration
+  def change
+    create_table :notification_deliveries do |t|
+
+      # Timestamps
+      t.timestamps null: true
+      t.datetime :sent_at
+
+      # Relations
+      t.integer :notification_id, index: true
+
+      # Delivery kind (email, SMS, mailboxer, ...)
+      t.string :kind
+
+      # Statistics
+      t.integer :receivers_count
+      t.integer :sent_count
+    end
+  end
+end

data/lib/tolliver.rb

@@ -0,0 +1,167 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Tolliver engine
+# *
+# * Author: Matěj Outlý
+# * Date  : 9. 6. 2015
+# *
+# *****************************************************************************
+
+# Engine
+require "tolliver/engine"
+
+# Models
+require "tolliver/models/notification"
+require "tolliver/models/notification_delivery"
+require "tolliver/models/notification_delivery/batch"
+require "tolliver/models/notification_delivery/instantly"
+require "tolliver/models/notification_receiver"
+require "tolliver/models/notification_receiver/email"
+require "tolliver/models/notification_receiver/sms"
+require "tolliver/models/notification_template"
+
+# Services
+require "tolliver/services/notification"
+require "tolliver/services/delivery"
+
+# Mailers
+require "tolliver/mailers/notification_mailer"
+
+# Utils
+require "tolliver/utils/enum"
+
+module Tolliver
+
+  # This will keep Rails Engine from generating all table prefixes with the engines name
+  def self.table_name_prefix
+  end
+
+  # *************************************************************************
+  # Services
+  # *************************************************************************
+
+  include Tolliver::Services::Notification
+  include Tolliver::Services::Delivery
+
+  # *************************************************************************
+  # Configuration
+  # *************************************************************************
+
+  # Default way to setup module
+  def self.setup
+    yield self
+  end
+
+  # *************************************************************************
+  # SMS
+  # *************************************************************************
+
+  def self.sms_provider_obj
+    if @sms_provider_obj.nil?
+      sms_provider_class_name = "Tolliver::Services::Sms::#{Tolliver.sms_provider.to_s.to_camel}"
+      @sms_provider_obj = sms_provider_class_name.constantize.new(Tolliver.sms_provider_params)
+    end
+    return @sms_provider_obj
+  end
+
+  # *************************************************************************
+  # Config options
+  # *************************************************************************
+
+  # Notification model
+  mattr_accessor :notification_model
+
+  def self.notification_model
+    return @@notification_model.constantize
+  end
+
+  @@notification_model = "Tolliver::Notification"
+
+  # Notification delivery model
+  mattr_accessor :notification_delivery_model
+
+  def self.notification_delivery_model
+    return @@notification_delivery_model.constantize
+  end
+
+  @@notification_delivery_model = "Tolliver::NotificationDelivery"
+
+  # Notification receiver model
+  mattr_accessor :notification_receiver_model
+
+  def self.notification_receiver_model
+    return @@notification_receiver_model.constantize
+  end
+
+  @@notification_receiver_model = "Tolliver::NotificationReceiver"
+
+  # Notification template model
+  mattr_accessor :notification_template_model
+
+  def self.notification_template_model
+    return @@notification_template_model.constantize
+  end
+
+  @@notification_template_model = "Tolliver::NotificationTemplate"
+
+  # People selector model
+  mattr_accessor :people_selector_model
+
+  def self.people_selector_model
+    return @@people_selector_model.constantize
+  end
+
+  @@people_selector_model = nil
+
+  # Available notification template refs. For each defined ref there will be
+  # an automatically created record in the notification_templates table.
+  # System administrator can define content of this template via admin
+  # interface.
+  mattr_accessor :template_refs
+  @@template_refs = [
+#		:some_notification_ref_1,
+#		:some_notification_ref_2,
+  ]
+
+  # Delivery kinds
+  #
+  # Available kinds:
+  # - email
+  # - sms
+  # - whatever
+  mattr_accessor :delivery_kinds
+  @@delivery_kinds = [
+      :email
+  ]
+
+  # Load balancer defined in minutes
+  #
+  # If another notification have been delivered in last X minutes, delivery
+  # will be postponed. It should prevent delivery service overloading in case
+  # of some mistake or security problem.
+  mattr_accessor :load_balance
+  @@load_balance = nil
+
+  # Mailer sender
+  mattr_accessor :mailer_sender
+  #@@mailer_sender = "test@domain.com" to be set in module initializer if needed
+
+  # Mailer sender name
+  mattr_accessor :mailer_sender_name
+  #@@mailer_sender_name = "Test sender" to be set in module initializer if needed
+
+  # Used SMS provider
+  mattr_accessor :sms_provider
+  @@sms_provider = :plivo
+
+  # 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/engine.rb

@@ -0,0 +1,17 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Engine
+# *
+# * Author: Matěj Outlý
+# * Date  : 9. 6. 2015
+# *
+# *****************************************************************************
+
+module Tolliver
+  class Engine < ::Rails::Engine
+    isolate_namespace Tolliver
+  end
+end
+

data/lib/tolliver/mailers/notification_mailer.rb

@@ -0,0 +1,44 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification mailer
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Mailers
+    module NotificationMailer
+      extend ActiveSupport::Concern
+
+      def notify(notification, receiver)
+
+        # Sender
+        @sender = Tolliver.mailer_sender
+        raise "Please specify sender." if @sender.nil?
+        if !Tolliver.mailer_sender_name.blank?
+          @sender = "#{Tolliver.mailer_sender_name} <#{@sender}>"
+        end
+
+        # Other view data
+        @notification = notification
+        @receiver = receiver
+
+        # Subject
+        subject = !@notification.subject.blank? ? @notification.subject : I18n.t("activerecord.mailers.tolliver.notification.notify.default_subject", url: main_app.root_url)
+
+        # Attachment
+        if !notification.attachment.blank?
+          attachments[File.basename(notification.attachment)] = File.read(notification.attachment)
+        end
+
+        # Mail
+        mail(from: @sender, to: receiver.email, subject: subject)
+      end
+
+    end
+  end
+end

data/lib/tolliver/models/notification.rb

@@ -0,0 +1,121 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module Notification
+      extend ActiveSupport::Concern
+
+      included do
+
+        # *********************************************************************
+        # Structure
+        # *********************************************************************
+
+        has_many :notification_deliveries, class_name: Tolliver.notification_delivery_model.to_s, dependent: :destroy
+        belongs_to :sender, polymorphic: true
+        belongs_to :notification_template, class_name: Tolliver.notification_template_model.to_s
+
+        # *********************************************************************
+        # Kind
+        # *********************************************************************
+
+        enum_column :kind, [:notice, :alert, :warning], default: :notice
+
+      end
+
+      # ***********************************************************************
+      # Progress
+      # ***********************************************************************
+
+      def done
+        sent_count = 0
+        receivers_count = 0
+        self.notification_deliveries.each do |notification_delivery|
+          sent_count += notification_delivery.sent_count.to_i
+          receivers_count += notification_delivery.receivers_count.to_i
+        end
+        return sent_count.to_s + "/" + receivers_count.to_s
+      end
+
+      # ***********************************************************************
+      # Sender
+      # ***********************************************************************
+
+      # Get name or email in case name is not set
+      def sender_name_or_email
+        if self.sender
+          if self.sender.respond_to?(:name_formatted) && !self.sender.name_formatted.blank?
+            return self.sender.name_formatted
+          elsif self.sender.respond_to?(:name) && !self.sender.name.blank?
+            return self.sender.name
+          else
+            return self.sender.email
+          end
+        else
+          return nil
+        end
+      end
+
+      # ***********************************************************************
+      # Delivery
+      # ***********************************************************************
+
+      # Enqueue for delivery
+      def enqueue_for_delivery
+        QC.enqueue("#{self.class.to_s}.deliver", self.id)
+      end
+
+      # Deliver notification to receivers by all configured methods
+      def deliver
+        self.notification_deliveries.each do |notification_delivery|
+          notification_delivery.deliver
+        end
+      end
+
+      module ClassMethods
+
+        # Deliver notification (defined by ID) to receivers by all configured methods
+        def deliver(notification_id)
+
+          # Find notification object
+          notification = Tolliver.notification_model.find_by_id(notification_id)
+          return nil if notification.nil?
+
+          # Load balance
+          if !Tolliver.load_balance.blank?
+            notifications_sent_in_protected_time_window = Tolliver.notification_model
+                                                              .joins(:notification_deliveries)
+                                                              .where.not(id: notification.id)
+                                                              .where("notification_deliveries.sent_at > ?", Time.current - Tolliver.load_balance.minutes).distinct
+            if notifications_sent_in_protected_time_window.count > 0
+
+              # Sleep for given amount of time
+              sleep(Tolliver.load_balance * 60) # seconds
+
+              # Then try again
+              notification.enqueue_for_delivery
+
+              return notification
+            end
+          end
+
+          # Deliver
+          notification.deliver
+
+          return notification
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tolliver/models/notification_delivery.rb

@@ -0,0 +1,112 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationDelivery
+      extend ActiveSupport::Concern
+
+      included do
+
+        # *********************************************************************
+        # Structure
+        # *********************************************************************
+
+        belongs_to :notification, class_name: Tolliver.notification_model.to_s
+        has_many :notification_receivers, class_name: Tolliver.notification_receiver_model.to_s, dependent: :destroy
+
+        # *********************************************************************
+        # Validators
+        # *********************************************************************
+
+        validates_presence_of :notification_id, :kind
+
+        # *********************************************************************
+        # Kind
+        # *********************************************************************
+
+        enum_column :kind, Tolliver.delivery_kinds
+
+        # *********************************************************************
+        # Queue kind
+        # *********************************************************************
+
+        enum_column :policy, [
+            :instantly,
+            :batch
+        ]
+
+      end
+
+      # ***********************************************************************
+      # Policy
+      # ***********************************************************************
+
+      def policy
+        return case self.kind.to_sym
+               when :email then
+                 :batch
+               when :sms then
+                 :batch
+               else
+                 :instantly
+               end
+      end
+
+      # ***********************************************************************
+      # Progress
+      # ***********************************************************************
+
+      def done
+        if self.sent_count && self.receivers_count
+          return self.sent_count.to_s + "/" + self.receivers_count.to_s
+        else
+          return nil
+        end
+      end
+
+      # ***********************************************************************
+      # Service
+      # ***********************************************************************
+
+      # Deliver by correct policy
+      def deliver
+        self.class.deliver(self.id)
+      end
+
+      module ClassMethods
+
+        # Deliver by correct policy
+        def deliver(notification_delivery_id)
+
+          # Find notification delivery object
+          notification_delivery = Tolliver.notification_delivery_model.find_by_id(notification_delivery_id)
+          return nil if notification_delivery.nil?
+
+          # "Instanly" policy
+          if notification_delivery.policy == :instantly
+            self.deliver_instantly(notification_delivery_id)
+
+            # "Batch" policy
+          elsif notification_delivery.policy == :batch
+            QC.enqueue("#{self.to_s}.deliver_batch_and_enqueue", notification_delivery_id)
+          else
+            return nil
+          end
+
+          return notification_delivery
+        end
+
+      end
+
+    end
+  end
+end