tolliver 1.0.0

data/lib/tolliver/models/notification_delivery/batch.rb

@@ -0,0 +1,77 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationDelivery
+      module Batch
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          protected
+
+          def deliver_batch(notification_delivery_id, batch_size = 10)
+
+            # Find 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
+
+            # Nothing to do
+            return 0 if notification_delivery.sent_count == notification_delivery.receivers_count
+
+            # Get batch of receivers prepared for send
+            notification_receivers = notification_delivery.notification_receivers.where(sent_at: nil).limit(batch_size)
+
+            # Send entire batch
+            sent_counter = 0
+            notification_receivers.each do |notification_receiver|
+              sent_counter += 1 if notification_receiver.deliver
+            end
+
+            # Update statistics
+            notification_delivery.sent_count += sent_counter
+            notification_delivery.sent_at = Time.current if notification_delivery.sent_count == notification_delivery.receivers_count
+
+            # Save
+            notification_delivery.save
+
+            return (notification_delivery.receivers_count - notification_delivery.sent_count)
+
+          end
+
+          def deliver_batch_and_enqueue(notification_delivery_id, batch_size = 10)
+
+            # Send single batch
+            remaining = deliver_batch(notification_delivery_id, batch_size)
+            return nil if remaining.nil?
+
+            # If still some receivers remaining, enqueue next batch
+            if remaining > 0
+
+              # Sleep for a while to prevent SMTP/SMS service overflow
+              sleep 5 # seconds
+
+              # Queue next batch
+              QC.enqueue("#{self.to_s}.deliver_batch_and_enqueue", notification_delivery_id, batch_size)
+              return false
+            else
+              return true
+            end
+
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/tolliver/models/notification_delivery/instantly.rb

@@ -0,0 +1,55 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationDelivery
+      module Instantly
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+          protected
+
+          def deliver_instantly(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? || notification_delivery.policy != :instantly
+
+            # Nothing to do
+            return 0 if notification_delivery.sent_count == notification_delivery.receivers_count
+
+            # Get batch of receivers prepared for send
+            notification_receivers = notification_delivery.notification_receivers #.where(sent_at: nil)
+
+            # Send entire batch
+            sent_counter = 0
+            notification_receivers.each do |notification_receiver|
+              sent_counter += 1 if notification_receiver.deliver
+            end
+
+            # Update statistics
+            notification_delivery.sent_count += sent_counter
+            notification_delivery.sent_at = Time.current if notification_delivery.sent_count == notification_delivery.receivers_count
+
+            # Save
+            notification_delivery.save
+
+            return (notification_delivery.receivers_count - notification_delivery.sent_count)
+          end
+
+        end
+
+      end
+    end
+  end
+end

data/lib/tolliver/models/notification_receiver.rb

@@ -0,0 +1,76 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationReceiver
+      extend ActiveSupport::Concern
+
+      included do
+
+        # *********************************************************************
+        # Structure
+        # *********************************************************************
+
+        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
+
+        # *********************************************************************
+        # State
+        # *********************************************************************
+
+        enum_column :state, [
+            :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}")
+      end
+
+    end
+  end
+end

data/lib/tolliver/models/notification_receiver/email.rb

@@ -0,0 +1,46 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationReceiver
+      module Email
+        extend ActiveSupport::Concern
+
+        protected
+
+        # Send notification by e-mail
+        def deliver_by_email
+          notification = self.notification_delivery.notification
+
+          # Send email
+          begin
+            Tolliver::NotificationMailer.notify(notification, self.receiver).deliver_now
+            self.state = "sent"
+              #rescue Net::SMTPFatalError, Net::SMTPSyntaxError
+          rescue StandardError => e
+            self.state = "error"
+            self.error_message = e.message
+          end
+
+          # Mark as sent
+          self.sent_at = Time.current
+
+          # Save
+          self.save
+
+          return true
+        end
+
+      end
+    end
+  end
+end

data/lib/tolliver/models/notification_receiver/sms.rb

@@ -0,0 +1,45 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationReceiver
+      module Sms
+        extend ActiveSupport::Concern
+
+        protected
+
+        # Send notification by SMS
+        def deliver_by_sms
+          notification = self.notification_delivery.notification
+
+          # Send SMS
+          begin
+            Tolliver.sms_provider_obj.deliver(self.receiver.phone, notification.message.strip_tags)
+            self.state = "sent"
+          rescue StandardError => e
+            self.state = "error"
+            self.error_message = e.message
+          end
+
+          # Mark as sent
+          self.sent_at = Time.current
+
+          # Save
+          self.save
+
+          return true
+        end
+
+      end
+    end
+  end
+end

data/lib/tolliver/models/notification_template.rb

@@ -0,0 +1,54 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification template
+# *
+# * Author: Matěj Outlý
+# * Date  : 9. 5. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Models
+    module NotificationTemplate
+      extend ActiveSupport::Concern
+
+      included do
+
+        # *********************************************************************
+        # Structure
+        # *********************************************************************
+
+        has_many :notification_templates, class_name: Tolliver.notification_template_model.to_s, dependent: :nullify
+
+        # *********************************************************************
+        # Validators
+        # *********************************************************************
+
+        validates_presence_of :ref
+
+        # *********************************************************************
+        # Ref
+        # *********************************************************************
+
+        enum_column :ref, Tolliver.template_refs
+
+      end
+
+      module ClassMethods
+
+        def permitted_columns
+          [
+              :subject,
+              :message,
+              :disabled,
+              :dry
+          ]
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tolliver/services/delivery.rb

@@ -0,0 +1,30 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Common delivery service
+# *
+# * Author: Matěj Outlý
+# * Date  : 19. 4. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Delivery
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        #
+        # Deliver notification (defined by ID) to receivers by all configured methods
+        #
+        def deliver(notification_id)
+          Tolliver.notification_model.deliver(notification_id)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/tolliver/services/notification.rb

@@ -0,0 +1,234 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification service
+# *
+# * Author: Matěj Outlý
+# * Date  : 19. 4. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Notification
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+
+        def notify(content, receivers, options = {})
+
+          # Object
+          notification = Tolliver.notification_model.new
+
+          Tolliver.notification_model.transaction do
+
+            # Get subject, message and params
+            subject, message, params, notification_template = parse_content(content)
+
+            if !message.blank?
+
+              # Interpret params and store it in DB
+              notification.message = interpret_params(message, params)
+              notification.subject = interpret_params(subject, params)
+
+              # Notification template
+              notification.notification_template = notification_template
+
+              # Kind
+              if options[:kind]
+                notification.kind = options[:kind]
+              end
+
+              # Sender
+              if options[:sender]
+                notification.sender = options[:sender]
+              end
+
+              # URL
+              if options[:url]
+                notification.url = options[:url]
+              end
+
+              # Attachment
+              if options[:attachment]
+                notification.attachment = options[:attachment]
+              end
+
+              # Signature
+              if !options[:signature].blank?
+                notification.message += options[:signature].to_s
+              end
+
+              # Save to DB
+              notification.save
+
+              if !notification_template || notification_template.dry != true
+
+                # Delivery kinds
+                if options[:delivery_kinds] # Select only wanted delivery kinds, but valid according to module config
+                  delivery_kinds = options[:delivery_kinds]
+                  delivery_kinds = delivery_kinds.delete_if { |delivery_kind| !Tolliver.delivery_kinds.include?(delivery_kind.to_sym) }
+                else
+                  delivery_kinds = Tolliver.delivery_kinds
+                end
+
+                # Get valid receivers
+                receivers = parse_receivers(receivers)
+
+                delivery_kinds.each do |delivery_kind|
+
+                  # Delivery object
+                  notification_delivery = notification.notification_deliveries.create(kind: delivery_kind)
+
+                  # Filter out receivers not valid for this delivery kind
+                  if delivery_kind == :email
+                    filtered_receivers = receivers.delete_if { |receiver| !receiver.respond_to?(:email) }
+                  elsif delivery_kind == :sms
+                    filtered_receivers = receivers.delete_if { |receiver| !receiver.respond_to?(:phone) }
+                  else
+                    filtered_receivers = receivers.dup
+                  end
+
+                  # Save to DB
+                  filtered_receivers.each do |receiver|
+                    notification_delivery.notification_receivers.create(receiver: receiver)
+                  end
+                  notification_delivery.sent_count = 0
+                  notification_delivery.receivers_count = filtered_receivers.size
+                  notification_delivery.save
+
+                end
+
+              end
+
+            else
+              notification = nil # Do not create notification with empty message
+            end
+
+          end
+
+          # Enqueue for delivery
+          notification.enqueue_for_delivery if !notification.nil?
+
+          return notification
+        end
+
+        def parse_content(content)
+
+          # Arrayize
+          if !content.is_a?(Array)
+            content = [content]
+          end
+
+          # Check for empty
+          if content.length == 0
+            raise "Notification is incorrectly defined."
+          end
+
+          # Extract content definition and params
+          content_def = content.shift
+
+          # Preset
+          params = content
+          subject = nil
+          message = nil
+          notification_template = nil
+
+          if content_def.is_a?(Symbol)
+
+            notification_template = Tolliver.notification_template_model.where(ref: content_def.to_s).first
+            if notification_template.nil?
+              raise "Notification template #{content_def.to_s} not found."
+            end
+            if notification_template.disabled != true
+              message = notification_template.message
+              subject = notification_template.subject
+            end
+
+          elsif content_def.is_a?(Hash) # Defined by hash containing subject and message
+
+            subject = content_def[:subject]
+            message = content_def[:message]
+
+          elsif content_def.is_a?(String)
+
+            message = content_def
+
+          else
+            raise "Notification is incorrectly defined."
+          end
+
+          # First parameter is message (all other parameters are indexed from 1)
+          params.unshift(message)
+
+          return [subject, message, params, notification_template]
+        end
+
+        def parse_receivers(receivers)
+
+          # Arrayize
+          if !receivers.is_a?(Array)
+            receivers = [receivers]
+          end
+
+          # Automatic receivers defined by string
+          new_receivers = []
+          receivers.each do |receiver|
+            if receiver.is_a?(String) || receiver.is_a?(Symbol)
+              if Tolliver.people_selector_model && Tolliver.people_selector_model.respond_to?(:decode_value) && Tolliver.people_selector_model.respond_to?(:people)
+                ref, params = Tolliver.people_selector_model.decode_value(receiver.to_s)
+                new_receivers.concat(Tolliver.people_selector_model.people(ref, params).to_a) # Use people selector to generate receivers
+              end
+            else
+              new_receivers << receiver
+            end
+          end
+          receivers = new_receivers
+
+          # Receivers responding to email or users
+          new_receivers = []
+          receivers.each do |receiver|
+            if receiver.respond_to?(:email)
+              new_receivers << receiver
+            else
+              if receiver.respond_to?(:user)
+                new_receivers << receiver.user
+              else
+                if receiver.respond_to?(:users)
+                  new_receivers.concat(receiver.users.to_a)
+                end
+              end
+            end
+          end
+          receivers = new_receivers
+
+          return receivers
+        end
+
+        #
+        # Interpret params into given text
+        #
+        def interpret_params(text, params)
+          return text.gsub(/%{[^{}]+}/) do |match|
+
+            # Substitude all %1, %2, %3, ... to a form which can be evaluated
+            template_to_eval = match[2..-2].gsub(/%([0-9]+)/, "params[\\1]")
+
+            # Evaluate match
+            begin
+              evaluated_match = eval(template_to_eval)
+            rescue
+              evaluated_match = ""
+            end
+
+            # Result
+            evaluated_match
+          end
+        end
+
+      end
+
+    end
+  end
+end