simple_notifications 1.1.8 → 1.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac34511b2c3da57df59fcf6a5d31d4a3e108d45a93b56d78acae05b032303311
-  data.tar.gz: 3daf3195e073ed5117b8bda4f5cc14fa00b404b68934fbb7ff7348bea357c308
+  metadata.gz: 734d3ac28915b2e74210cc06566ddeed980696f65f36300cc63925a684a56ca5
+  data.tar.gz: 739123957632324deb2cffe1d8edc9bff3826af6946fbd981b3b60e757d449ab
 SHA512:
-  metadata.gz: 4571f8e0080aa3592c5c30a22b09fe6a0f3d4336144268616bd3b922e6ecec64ffa3b71049628ac5faa6ee35c286876e7295aebe0f732a467d72f42c006a8360
-  data.tar.gz: eef1b1bbe353c76239379b739c73763b794c455e0388a10d233961a081a8a69b68870eede03f0bbdc39bd6995ee7ad2c349e6e26e92dcd5cd46a8944c2be09c8
+  metadata.gz: a366d2e14de8e59c6456e4d3827b846cde3485c21d062ba30db017b16661e33986962f06eef1540f19014b65da0c24b2d6b5749ffaf4246d4b0920e4518e120c
+  data.tar.gz: e190dcf5be3dd5b4f567f6ab3c0e41dee297938aa64cc5227a295dd49214a098c24d18791ba0fe4f3ec3bdb2eaef7cf50ad41237138f80f6cb121f404c317ab6

data/README.md

@@ -1,6 +1,9 @@
 # Simple Notifications
 
 A very simple gem providing the notifications functionality to any model in a Rails application.
+It does not provide the push notifications. 
+
+It creates all the models/migrations/associations/callbacks for you.
 
 ### Installation
 
@@ -20,46 +23,47 @@ Or install it yourself as:
 
 ### Usage
 
-Run the simple notifications generator
+* First run the simple notifications generator to generate two files in your rails project
+
+    * simple_notifications.rb - An initializer file.
+    * Migration files - Required for recording notifications.
 
 ```ruby
 rails generate simple_notifications:install
 ```
-This will generate two files in your rails project
-
-* simple_notifications.rb - An initializer file.
-* Migration files - Required for recording notifications.
 
-Then run
+* Migrate Database
 
 ```ruby
 rails db:migrate
 ``` 
 
-Add following line to the model for which notifications functionality is required. Here [Post] is the model which is the base for notification to happen i.e Event is performed on Post. 
+Add the following line to the model for which notifications functionality is required.
+Here [Post] is the model which is the base for notification to happen i.e Event is performed on Post. 
 
 ```ruby
-notify sender: :author,
-       receivers: :followers,
-       actions: [:follow, :unfollow, :update, :create, :destroy],
-       notify_message: :message_method,
-       before_notify: :before_notify_method,
-       after_notify: :after_notify_method,
-       before_delivered: :before_delivered_method,
-       after_delivered: :after_delivered_method,
-       before_read: :before_read_method,
-       after_read: :after_read_method
+acts_as_notifier   sender: :author,
+                   receivers: :followers,
+                   actions: [:follow, :unfollow, :update, :create, :destroy],
+                   notify_message: :message_method,
+                   before_notify: :before_notify_method,
+                   after_notify: :after_notify_method,
+                   before_delivered: :before_delivered_method,
+                   after_delivered: :after_delivered_method,
+                   before_read: :before_read_method,
+                   after_read: :after_read_method
 ``` 
 Here [receivers] will be notified that an event was done by [sender] on [post] entity with a message that is configurable.
 
 You can also provide ActiveRecord::Base object or ActiveRecord::Relation objects as 
 
 ```ruby
-notify sender: :author, receivers: User.all
-notify sender: User.first, receivers: [:followers, User.all]
+acts_as_notifier sender: :author, receivers: User.all, actions: [:create]
+acts_as_notifier sender: User.first, receivers: [:followers, User.all], actions: [:create]
 ```
 
-Here [:sender] is the [belongs_to] association with [:post] while :followers is the [:has_many] associations for the [:post] model through [:sender] model which needs to be notified.
+Here [:sender] is the [belongs_to] association with [:post] while :followers is the [:has_many] associations for the 
+[:post] model through [:sender] model which needs to be notified.
 
 ### Notification Models
 
@@ -67,7 +71,8 @@ Here [:sender] is the [belongs_to] association with [:post] while :followers is
 SimpleNotifications::Record
 SimpleNotifications::Delivery
 ```
-Here assumption is that one event performed by [:sender] on entity [:post] will have one type of notification and it needs to be delivered to many [:receivers].
+Here assumption is that one event performed by [:sender] on entity [:post] will have one type of notification 
+and it needs to be delivered to many [:receivers].
 
 ### Scopes
 

data/lib/simple_notifications/version.rb

@@ -1,3 +1,3 @@
 module SimpleNotifications
-  VERSION = '1.1.8'
+  VERSION = '1.1.9'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_notifications
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.9
 platform: ruby
 authors:
 - Ashish Garg