simple_notifications 1.0.4 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 637fcdccc7f7369aee6e40e286087ac074f5a373fcea81268620e110405542a8
-  data.tar.gz: 04046a239fffa98a0dc094cf5efeaed8cb259b5459e234ab1fa54c5e26f78834
+  metadata.gz: 901a82711bccfaa4b7eb9294b84eddb4e9cc4a439660b3bdbd9103aace8c919a
+  data.tar.gz: 89b3175be328a334f75ebb585ec61019f16dab74f366072f3d1003c005d0a00b
 SHA512:
-  metadata.gz: 8c95d4692facc8a87180ccbdeaff38cefc1e418c36974fef15a07815ecf729eff29f67a8411c66a88ec5263e8dcbf98b0a5ce169c7ddbb7d51d956b75a8f0663
-  data.tar.gz: d91290995506e71974a2aead19fe7f30c46cf9c2f63c5729974dbb4a35f8be61020f9945d115fd52a36d829a733159c4d3e0542123acffac6d842cee11aabf3c
+  metadata.gz: 3c12be42028d7096e859733f290cdf12b5050b5103c70d7d8e7b94af2e338f69e2e1f1deccd05405dacf675c05d1f435561307263ed55768a60f5850f3d14bee
+  data.tar.gz: 14f6988d25a32dc032e7c40a5b8a131127ebd42741719aaa1f9ac07cb6ea04d47bcfc313c525e35758a7b56c7c56b5a87944e0f545645a017def7f27e3f38b9c

data/README.md

@@ -42,7 +42,9 @@ Add following line to the model for which notifications functionality is require
 notify sender: :author, 
        receivers: :followers, 
        before_notify: proc {puts 'Before Notifications actions'},
-       after_notify: proc {puts 'Deliver Push notifications'}
+       after_notify: proc {puts 'Deliver Push notifications'},
+       after_delivered: proc {puts 'Notification delivered'},
+       after_read: proc { puts 'Notification marked as read'}
 ``` 
 Or you can provide ActiveRecord::Base object or ActiveRecord::Relation objects as 
 

data/lib/simple_notifications.rb

@@ -1,5 +1,6 @@
 require 'simple_notifications/version'
 require 'simple_notifications/base'
+require 'simple_notifications/notification_actions'
 require_relative 'simple_notifications/app/models/simple_notification'
 require_relative 'simple_notifications/app/models/delivery'
 

data/lib/simple_notifications/app/models/delivery.rb

@@ -2,6 +2,9 @@ module SimpleNotifications
   class Delivery < ActiveRecord::Base
     self.table_name = 'deliveries'
 
+    # Class Attribute Accessors
+    cattr_accessor :after_delivered, :after_read
+
     # Associations
     belongs_to :simple_notification,
                class_name: 'SimpleNotifications::Record',
@@ -9,12 +12,18 @@ module SimpleNotifications
     belongs_to :receiver, polymorphic: true
 
     # Callbacks
-    after_create_commit :after_create_actions
+    after_update_commit :after_create_actions
 
     private
 
     def after_create_actions
+      if !!SimpleNotifications::Delivery.after_delivered && previous_changes['is_delivered'] == [false, true]
+        SimpleNotifications::Delivery.after_delivered.call
+      end
 
+      if !!SimpleNotifications::Delivery.after_read && previous_changes['is_read'] == [false, true]
+        SimpleNotifications::Delivery.after_read.call
+      end
     end
   end
 end

data/lib/simple_notifications/base.rb

@@ -1,28 +1,34 @@
 module SimpleNotifications
   module Base
-    mattr_accessor :notified_flag, :entity_class, :sender, :receivers
-
-    #Getter to check if model is enabled with notifications
-    def notified?
-      !!@@notified_flag
-    end
+    mattr_accessor :notified_flag, :entity_class, :sender, :receivers, :actions, :notify_message
 
     #Example
     #notify(sender: :author, receivers: :followers)
+    #notify sender: :product_class,
+    #       receivers: :variants,
+    #       action: [:follow, :update, :create, :destroy]
     def notify(options = {})
       @@entity_class = self
       @@sender = options[:sender]
       @@receivers = options[:receivers]
+      @@actions = options[:actions]
+      @@notify_message = options[:notify_message]
+
       SimpleNotifications::Record.before_notify = options[:before_notify] if !!options[:before_notify]
       SimpleNotifications::Record.after_notify = options[:after_notify] if !!options[:after_notify]
-
+      SimpleNotifications::Delivery.after_delivered = options[:after_delivered] if !!options[:after_delivered]
+      SimpleNotifications::Delivery.after_read = options[:after_read] if !!options[:after_read]
       open_sender_class
       open_receiver_class
       open_notified_class
-
       @@notified_flag = true
     end
 
+    #Getter to check if model is enabled with notifications
+    def notified?
+      !!@@notified_flag
+    end
+
     # Opening the class which is defined as sender.
     def open_sender_class
       # Define association for sender model
@@ -45,12 +51,12 @@ module SimpleNotifications
     # Opening the class on which the notify functionality is applied.
     def open_notified_class
       class_eval do
+        prepend NotificationActions
         attr_accessor :message, :notify
+
         # Define association for the notified model
         has_many :notifications, class_name: 'SimpleNotifications::Record', as: :entity
         has_many :notifiers, through: :notifications, source: :sender, source_type: sender_class(@@sender).to_s
-
-        # Opening the Notification class.
         SimpleNotifications::Record.class_eval do
           [@@entity_class.receivers_class(@@receivers)].flatten.each do |receiver_class|
             has_many "#{receiver_class.name.downcase}_receivers".to_sym,
@@ -59,13 +65,11 @@ module SimpleNotifications
                      source_type: receiver_class.name
           end
         end
-
         [receivers_class(@@receivers)].flatten.each do |receiver_class|
           has_many "#{receiver_class.name.downcase}_notificants".to_sym,
                    through: :notifications,
                    source: "#{receiver_class.name.downcase}_receivers".to_sym
         end
-
         has_many :read_deliveries, through: :notifications, source: :read_deliveries
         has_many :unread_deliveries, through: :notifications, source: :unread_deliveries
         # has_many :notificants, through: :notifications, source: :receivers
@@ -76,9 +80,27 @@ module SimpleNotifications
         after_create_commit :create_notification, if: proc {@notify.nil? || !!@notify}
         after_update_commit :update_notification, if: proc {@notify.nil? || !!@notify}
 
-        # Check if notifications has already been delivered.
-        def notified?
-          !notifications.blank?
+        NotificationActions.module_eval do
+          @@actions.each do |action|
+            define_method(action) do
+              run_callbacks action do
+                super()
+              end
+            end
+
+            define_method("before_#{action}") do
+            end
+
+            define_method("after_#{action}") do
+              self.notify(sender: @@sender, receivers: @@receivers, message: default_message(self, @@sender, action.to_s))
+            end
+          end
+        end
+
+        @@actions.each do |action|
+          define_model_callbacks action
+          send("before_#{action}", "before_#{action}".to_sym)
+          send("after_#{action}", "after_#{action}".to_sym)
         end
 
         #Example
@@ -87,12 +109,16 @@ module SimpleNotifications
         def notify(options = {})
           raise 'SimpleNotification::SenderReceiverError' unless options[:sender] && options[:receivers]
           @message = options[:message] if options[:message]
-          notification = notifications.build(entity: self, sender: options[:sender],
-                                             message: default_message(self, options[:sender], 'created'))
-          options[:receivers].each {|receiver| notification.deliveries.build(receiver: receiver)}
+          notification = notifications.build(entity: self, sender: get_obj(options[:sender]), message: default_message(self, get_obj(options[:sender]), 'created'))
+          get_obj(options[:receivers]).each {|receiver| notification.deliveries.build(receiver: receiver)}
           notification.save
         end
 
+        # Check if notifications has already been delivered.
+        def notified?
+          !notifications.blank?
+        end
+
         def notificants
           #TODO : Need to eager load
           SimpleNotifications::Record.where(entity: self).collect {|notification| notification.deliveries.collect(&:receiver)}.flatten
@@ -122,16 +148,16 @@ module SimpleNotifications
           (notificants ? read_deliveries.where(receiver: notificants) : read_deliveries).update_all(is_read: false)
         end
 
+        def default_message(entity, sender, action)
+          @message || (method(@@notify_message).call if !!@@notify_message) || "#{get_obj(sender).class.name} #{action} #{entity.class.name} #{entity.name}."
+        end
+
         private
 
         def get_obj(sender_or_receivers)
           sender_or_receivers.kind_of?(Symbol) ? send(sender_or_receivers) : sender_or_receivers
         end
 
-        def default_message(entity, sender, action)
-          @message || "#{entity.class.name} #{entity.name} #{action}."
-        end
-
         def create_notification
           notify({sender: get_obj(@@sender), receivers: get_obj(@@receivers), message: default_message(self, get_obj(@@sender), 'created')})
         end

data/lib/simple_notifications/notification_actions.rb

@@ -0,0 +1,7 @@
+module SimpleNotifications
+  module Base
+    module NotificationActions
+
+    end
+  end
+end

data/lib/simple_notifications/version.rb

@@ -1,3 +1,3 @@
 module SimpleNotifications
-  VERSION = "1.0.4"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_notifications
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.1.0
 platform: ruby
 authors:
 - Ashish Garg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-15 00:00:00.000000000 Z
+date: 2018-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - lib/simple_notifications/app/models/delivery.rb
 - lib/simple_notifications/app/models/simple_notification.rb
 - lib/simple_notifications/base.rb
+- lib/simple_notifications/notification_actions.rb
 - lib/simple_notifications/version.rb
 - simple_notifications.gemspec
 homepage: https://github.com/aashishgarg/simple_notifications