simple_notifications 1.1.6 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b68bdfc2e75a052f2ee8fb130cf00ab4b12ab311c4fd05a64765cb693083b214
-  data.tar.gz: 8497e5c83f7a11f8ca096f3c21e04da5eea965d353289dbc3dc2332a5bc0e01d
+  metadata.gz: 90315568f413c25998d564ad043f6895501daa5b727aff493d455ac5e26161af
+  data.tar.gz: fa75064e52508aca390b5e27b3fb2240b01852e77d8bd7aaac4cb4caac7f9e50
 SHA512:
-  metadata.gz: 54a9962147cfacea84a7e8c03ee01472615e3cc178af61920365af53d4f4777d9327b1d16d679e51d63c946f706623599a9b06b6e1ffae2cc2dd40f3bb87195e
-  data.tar.gz: 80298c7efe237f9b8e5788b9b9d69aa214daed79a5859f70cd9d4ce0d2aa67f886f2c8a4e6290d887e5888c289129409a912ca3110ae59b4221b0e85a805b9f4
+  metadata.gz: b27dab03d2c9cd13721808afd29a97e1408cc2229621601fabeaa604d2cbb0bde72f71e9d8f45271ffa328cced8ed78302630dcf0e25d38508597ef6ddf9ddb6
+  data.tar.gz: e6950c143a3b4098ab13ffce25bef39e44e0a89a5334f12dc617b388b0117277da94f2d09898490baa2411485d88ed2065815c7f48b0a6b1e7112a38f661df44

data/README.md

@@ -1,4 +1,4 @@
-# SimpleNotifications
+# Simple Notifications
 
 A very simple gem providing the notifications functionality to any model in a Rails application.
 
@@ -36,12 +36,12 @@ Then run
 rails db:migrate
 ``` 
 
-Add following line to the model for which notifications functionality is required
+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. 
 
 ```ruby
 notify sender: :author,
        receivers: :followers,
-       actions: [:follow, :unfollow, :update],
+       actions: [:follow, :unfollow, :update, :create, :destroy],
        notify_message: :message_method,
        before_notify: :before_notify_method,
        after_notify: :after_notify_method,
@@ -50,14 +50,16 @@ notify sender: :author,
        before_read: :before_read_method,
        after_read: :after_read_method
 ``` 
-Or you can provide ActiveRecord::Base object or ActiveRecord::Relation objects as 
+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]
 ```
 
-Here :sender and :followers should be associations for the 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
 
@@ -65,6 +67,7 @@ Here :sender and :followers should be associations for the model which needs to
 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].
 
 ### Scopes
 
@@ -74,8 +77,7 @@ SimpleNotifications::Record.unread
 ```
 
 ### Methods
-Suppose **Post** is the notified model and **author** is the sender association and **followers** is the receiver association.
-Then following methods are available
+Following are the method available
 
 ```ruby
 Post.notified?

data/lib/simple_notifications/base.rb

@@ -93,7 +93,7 @@ module SimpleNotifications
             raise 'SimpleNotification::SenderReceiverError' unless @@options[:sender] && @@options[:receivers]
             @message = options[:message] if options[:message]
             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)}
+            [get_obj(options[:receivers])].flatten.each {|receiver| notification.deliveries.build(receiver: receiver)}
             notification.save
           end
         end

data/lib/simple_notifications/version.rb

@@ -1,3 +1,3 @@
 module SimpleNotifications
-  VERSION = "1.1.6"
+  VERSION = "1.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_notifications
 version: !ruby/object:Gem::Version
-  version: 1.1.6
+  version: 1.1.7
 platform: ruby
 authors:
 - Ashish Garg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-19 00:00:00.000000000 Z
+date: 2019-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -104,8 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A very simple gem providing the notifications functionality to any model