noticed 1.2.3 → 1.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a17ac9f27bd6d18637bb5f033f47bf19b452b33c77647729c27ad2f38239c9b6
-  data.tar.gz: ba7b0c12028132a9234ad32566dd005f870d8398db28287a7bdad6d53f59d79d
+  metadata.gz: 2936d217d3d881874888d8dd68280ecc9888f41fc1edf3f195e713bf863d2233
+  data.tar.gz: a73fba77cb4eebead7c3d343c501cbe7ca5b19db5a24b11b6d33e6674c41a1f9
 SHA512:
-  metadata.gz: af37b4d82f2f327d57cd0cc18271f8d84f7e38842f868c7ace8bb0c9a626161d4eec53e0c00363f1d4b21aaf8a8793eb197af88b76ab5630987366aa4e1c78e1
-  data.tar.gz: 733f9a0a51226f2ffce597c3f9e2ba36cb2befb62359c39f5f1b208e262d4900062753477bd5993f751db90e7c11218af050e1bd7c8295b9c7098eb0fb2907d7
+  metadata.gz: 67f055f8a05d3418caf3c21c2a3938341705752e6154284bbe596ac31563fd715c7d29d5651f690ce310433d762b7dca05e99ec8326b93d477a85db91cddfd10
+  data.tar.gz: 3fbaf13b4dd6f7f3fa9f50a52849ef0ff112268c730cdca202f2e421fd7f66cdc797147c549911addb2161ed2c40d7738d6d85e5d420427f46658eaef5b13b81

data/README.md

@@ -11,11 +11,20 @@ Currently, we support these notification delivery methods out of the box:
 * Database
 * Email
 * ActionCable channels
+* Slack
 * Twilio (SMS)
 * Vonage / Nexmo (SMS)
 
 And you can easily add new notification types for any other delivery methods.
 
+## 🎬 Screencast
+
+<div style="width:50%">
+  <a href="https://www.youtube.com/watch?v=Scffi4otlFc"><img src="https://i.imgur.com/UvVKWwD.png" title="How to add Notifications to Rails with Noticed" /></a>
+</div>
+
+[Watch Screencast](https://www.youtube.com/watch?v=Scffi4otlFc)
+
 ## 🚀 Installation
 Run the following command to add Noticed to your Gemfile
 
@@ -37,6 +46,28 @@ To generate a notification object, simply run:
 
 `rails generate noticed:notification CommentNotification`
 
+#### Sending Notifications
+
+To send a notification to a user:
+
+```ruby
+# Instantiate a new notification
+notification = CommentNotification.with(comment: @comment)
+
+# Deliver notification in background job
+notification.deliver_later(@comment.post.author)
+
+# Deliver notification immediately
+notification.deliver(@comment.post.author)
+
+# Deliver notification to multiple recipients
+notification.deliver_later(User.all)
+```
+
+This will instantiate a new notification with the `comment` stored in the notification's params.
+
+Each delivery method is able to transform this metadata that's best for the format. For example, the database may simply store the comment so it can be linked when rendering in the navbar. The websocket mechanism may transform this into a browser notification or insert it into the navbar.
+
 #### Notification Objects
 
 Notifications inherit from `Noticed::Base`. This provides all their functionality and allows them to be delivered.
@@ -49,10 +80,6 @@ class CommentNotification < Noticed::Base
   deliver_by :action_cable
   deliver_by :email, if: :email_notifications?
 
-  def email_notifications?
-    !!recipient.preferences[:email]
-  end
-
   # I18n helpers
   def message
     t(".message")
@@ -63,33 +90,16 @@ class CommentNotification < Noticed::Base
     post_path(params[:post])
   end
 
+  def email_notifications?
+    !!recipient.preferences[:email]
+  end
+
   after_deliver do
     # Anything you want
   end
 end
 ```
 
-#### Sending Notifications
-
-To send a notification to a user:
-
-```ruby
-notification = CommentNotification.with(comment: @comment.to_gid)
-
-# Deliver notification in background job
-notification.deliver_later(@comment.post.author)
-
-# Deliver notification immediately
-notification.deliver(@comment.post.author)
-
-# Deliver notification to multiple recipients
-notification.deliver_later(User.all)
-```
-
-This will instantiate a new notification with the `comment` stored in the notification's params.
-
-Each delivery method is able to transform this metadata that's best for the format. For example, the database may simply store the comment so it can be linked when rendering in the navbar. The websocket mechanism may transform this into a browser notification or insert it into the navbar.
-
 **Shared Options**
 
 * `if: :method_name`  - Calls `method_name`and cancels delivery method if `false` is returned
@@ -352,6 +362,45 @@ For Rails 6.0 and earlier, you must pass strings of the class names in the `deli
 
 We recommend the Rails 6.0 compatible options to prevent confusion.
 
+### 📦 Database Model
+
+The Notification database model includes several helpful features to make working with database notifications easier.
+
+#### Class methods
+
+Sorting notifications by newest first:
+
+```ruby
+user.notifications.newest_first
+```
+
+Marking all notifications as read:
+
+```ruby
+user.notifications.mark_as_read!
+```
+
+#### Instance methods
+
+Convert back into a Noticed notification object:
+
+```ruby
+@notification.to_notification
+```
+
+Mark notification as read:
+
+```ruby
+@notification.mark_as_read!
+```
+
+Check if read / unread:
+
+```ruby
+@notification.read?
+@notification.unread?
+```
+
 ## 🙏 Contributing
 
 This project uses [Standard](https://github.com/testdouble/standard) for formatting Ruby code. Please make sure to run `standardrb` before submitting pull requests.

data/lib/generators/noticed/templates/notification.rb.tt

@@ -22,6 +22,6 @@ class <%= class_name %> < Noticed::Base
   # end
   #
   # def url
-  #   posts_path(params[:post])
+  #   post_path(params[:post])
   # end
 end

data/lib/noticed.rb

@@ -1,3 +1,4 @@
+require "active_job/arguments"
 require "http"
 require "noticed/engine"
 

data/lib/noticed/delivery_methods/base.rb

@@ -4,12 +4,13 @@ module Noticed
       extend ActiveModel::Callbacks
       define_model_callbacks :deliver
 
-      attr_reader :notification, :options, :recipient
+      attr_reader :notification, :options, :recipient, :record
 
       def perform(notification_class:, options:, params:, recipient:, record:)
         @notification = notification_class.constantize.new(params)
         @options = options
         @recipient = recipient
+        @record = record
 
         # Make notification aware of database record and recipient during delivery
         @notification.record = record

data/lib/noticed/delivery_methods/email.rb

@@ -19,7 +19,10 @@ module Noticed
         if (method = options[:format])
           notification.send(method)
         else
-          notification.params.merge(recipient: recipient)
+          notification.params.merge(
+            recipient: recipient,
+            record: record
+          )
         end
       end
     end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.2.3"
+  VERSION = "1.2.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.2.4
 platform: ruby
 authors:
 - Chris Oliver