tolliver 1.0.0 → 2.0.0

data/lib/tolliver/errors/standard_error.rb

@@ -0,0 +1,17 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Standard error
+# *
+# * Author: Matěj Outlý
+# * Date  : 19. 4. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Errors
+    class StandardError < ::StandardError
+    end
+  end
+end

data/lib/tolliver/mailers/notification_mailer.rb

@@ -14,29 +14,26 @@ module Tolliver
     module NotificationMailer
       extend ActiveSupport::Concern
 
-      def notify(notification, receiver)
+      def notify(notification, 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}>"
+        @sender_email = Tolliver.email_sender
+        raise Tolliver::Errors::StandardError.new("Please specify sender.") if @sender_email.nil?
+        unless Tolliver.email_sender_name.blank?
+          @sender_email = "#{Tolliver.email_sender_name} <#{@sender_email}>"
         end
 
         # Other view data
         @notification = notification
-        @receiver = receiver
+        @notification_receiver = notification_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)
+        # Attachments
+        notification.notification_attachments.each do |notification_attachment|
+          attachments[notification_attachment.name] = notification_attachment.attachment
         end
 
         # Mail
-        mail(from: @sender, to: receiver.email, subject: subject)
+        mail(from: @sender_email, to: @notification_receiver.receiver_contact, subject: @notification.subject)
       end
 
     end

data/lib/tolliver/models/notification.rb

@@ -21,14 +21,15 @@ module Tolliver
         # *********************************************************************
 
         has_many :notification_deliveries, class_name: Tolliver.notification_delivery_model.to_s, dependent: :destroy
-        belongs_to :sender, polymorphic: true
+        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
 
         # *********************************************************************
-        # Kind
+        # Validators
         # *********************************************************************
 
-        enum_column :kind, [:notice, :alert, :warning], default: :notice
+        validates_presence_of :subject
 
       end
 
@@ -43,77 +44,23 @@ module Tolliver
           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
+        sent_count.to_s + "/" + receivers_count.to_s
       end
 
       # ***********************************************************************
-      # Sender
+      # Service
       # ***********************************************************************
 
-      # 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
+      def deliver
+        Tolliver::Services::Delivery.instance.deliver(self)
       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
+        Tolliver::Services::Delivery.instance.enqueue_for_delivery(self)
       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
-
+      def reset_delivery
+        Tolliver::Services::Delivery.instance.reset_delivery(self)
       end
 
     end

data/lib/tolliver/models/notification_attachment.rb

@@ -0,0 +1,35 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification attachment
+# *
+# * Author: Matěj Outlý
+# * Date  : 27. 10. 2020
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationAttachment
+      extend ActiveSupport::Concern
+
+      included do
+
+        # *********************************************************************
+        # Structure
+        # *********************************************************************
+
+        belongs_to :notification, class_name: Tolliver.notification_model.to_s
+
+        # *********************************************************************
+        # Validators
+        # *********************************************************************
+
+        validates_presence_of :notification_id
+
+      end
+
+    end
+  end
+end

data/lib/tolliver/models/notification_delivery.rb

@@ -27,13 +27,13 @@ module Tolliver
         # Validators
         # *********************************************************************
 
-        validates_presence_of :notification_id, :kind
+        validates_presence_of :notification_id, :method
 
         # *********************************************************************
-        # Kind
+        # Delivery method
         # *********************************************************************
 
-        enum_column :kind, Tolliver.delivery_kinds
+        enum_column :method, Tolliver.delivery_methods
 
         # *********************************************************************
         # Queue kind
@@ -46,19 +46,37 @@ module Tolliver
 
       end
 
+      # ***********************************************************************
+      # Delivery method
+      # ***********************************************************************
+
+      def method_service
+        if @method_service.nil?
+          @method_service = "Tolliver::Services::Methods::#{self.method.to_s.capitalize}".constantize.new
+        end
+        @method_service
+      end
+
       # ***********************************************************************
       # Policy
       # ***********************************************************************
 
       def policy
-        return case self.kind.to_sym
-               when :email then
-                 :batch
-               when :sms then
-                 :batch
-               else
-                 :instantly
-               end
+        case self.method.to_sym
+        when :email then
+          :batch
+        when :sms then
+          :batch
+        else
+          :instantly
+        end
+      end
+
+      def policy_service
+        if @policy_service.nil?
+          @policy_service = "Tolliver::Services::Policies::#{self.policy.to_s.capitalize}".constantize.new
+        end
+        @policy_service
       end
 
       # ***********************************************************************
@@ -67,9 +85,9 @@ module Tolliver
 
       def done
         if self.sent_count && self.receivers_count
-          return self.sent_count.to_s + "/" + self.receivers_count.to_s
+          self.sent_count.to_s + "/" + self.receivers_count.to_s
         else
-          return nil
+          nil
         end
       end
 
@@ -77,34 +95,8 @@ module Tolliver
       # 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
-
+        self.policy_service.deliver(self)
       end
 
     end

data/lib/tolliver/models/notification_receiver.rb

@@ -21,54 +21,32 @@ module Tolliver
         # *********************************************************************
 
         belongs_to :notification_delivery, class_name: Tolliver.notification_delivery_model.to_s
-        belongs_to :receiver, polymorphic: true
 
         # *********************************************************************
         # Validators
         # *********************************************************************
 
-        validates_presence_of :notification_delivery_id, :receiver_id, :receiver_type
+        validates_presence_of :notification_delivery_id, :receiver_ref, :receiver_contact
 
         # *********************************************************************
         # State
         # *********************************************************************
 
-        enum_column :state, [
+        enum_column :status, [
             :created,
             :sent,
             :received,
-            :accepted,
             :error
         ], default: :created
 
       end
 
-      # ***********************************************************************
-      # Receiver
-      # ***********************************************************************
-
-      # Get name or email in case name is not set
-      def receiver_name_or_email
-        if self.receiver
-          if self.receiver.respond_to?(:name_formatted) && !self.receiver.name_formatted.blank?
-            return self.receiver.name_formatted
-          elsif self.receiver.respond_to?(:name) && !self.receiver.name.blank?
-            return self.receiver.name
-          else
-            return self.receiver.email
-          end
-        else
-          return nil
-        end
-      end
-
       # ***********************************************************************
       # Delivery
       # ***********************************************************************
 
-      # Deliver notification by correct delivery kind
       def deliver
-        return self.send("deliver_by_#{self.notification_delivery.kind}")
+        self.notification_delivery.method_service.deliver(self)
       end
 
     end

data/lib/tolliver/models/notification_template.rb

@@ -20,19 +20,14 @@ module Tolliver
         # Structure
         # *********************************************************************
 
-        has_many :notification_templates, class_name: Tolliver.notification_template_model.to_s, dependent: :nullify
+        has_many :notifications, class_name: Tolliver.notification_model.to_s, dependent: :nullify
 
         # *********************************************************************
         # Validators
         # *********************************************************************
 
-        validates_presence_of :ref
-
-        # *********************************************************************
-        # Ref
-        # *********************************************************************
-
-        enum_column :ref, Tolliver.template_refs
+        validates_presence_of :ref, :subject
+        validates :ref, uniqueness: true
 
       end
 
@@ -40,10 +35,11 @@ module Tolliver
 
         def permitted_columns
           [
+              :ref,
               :subject,
               :message,
-              :disabled,
-              :dry
+              :is_disabled,
+              :is_dry
           ]
         end
 

data/lib/tolliver/services/delivery.rb

@@ -9,20 +9,64 @@
 # *
 # *****************************************************************************
 
+require 'singleton'
+
 module Tolliver
   module Services
-    module Delivery
-      extend ActiveSupport::Concern
+    class Delivery
+      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)
+      end
 
-      module ClassMethods
+      # Deliver notification to receivers by all configured methods
+      def deliver(notification)
+        return nil if notification.nil?
 
-        #
-        # Deliver notification (defined by ID) to receivers by all configured methods
-        #
-        def deliver(notification_id)
-          Tolliver.notification_model.deliver(notification_id)
+        # Load balancing
+        unless 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
+            enqueue_for_delivery(notification)
+
+            return false
+          end
         end
 
+        # Process all notification deliveries
+        notification.notification_deliveries.each do |notification_delivery|
+          notification_delivery.policy_service.deliver(notification_delivery)
+        end
+
+        true
+      end
+
+      def reset_delivery(notification)
+        return nil if notification.nil?
+        notification.notification_deliveries.update_all(sent_count: 0, sent_at: nil)
+        notification.notification_receivers.update_all(sent_at: nil, received_at: nil, status: :created, error_message: nil)
+        true
       end
 
     end