noticed 1.2.20 → 1.2.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5b998072ed72c9844842d8610a9ffcea75cf16f958296aa3d53e1a3c050b6db
-  data.tar.gz: 589f43985b3dc7740977730d10917d0b111706fe56c4daafedbacc08e7f2ce84
+  metadata.gz: e648889dba7414cf25efd56b6b39aeeef03c44febfd7bbfccf47151cb940736e
+  data.tar.gz: 0ecb213d7913181f686bbd5cd716e617f0cb6da58a87a4c3185d8e69dcf114c0
 SHA512:
-  metadata.gz: 9f4a336ed688008a5abc3f91099a5ecc4128361beffd216e0e2e0bc0a1670286e607577d2f4ce13f1e36c2fb2fff3d93fbab9a10914d0321a2d1e0c2449ea715
-  data.tar.gz: b4a67b79dcf34892dcd11b56ad83e2c393a2da49c3eb38e3e911411164b4150ec27a836e53d1d7875ea40141276a398878e8c23304c326287299b26bafebacba
+  metadata.gz: 65a6fdd5fa8ea6cea59201358b62a93c5b98af509d8edd0694afda809887367baf973173ecc1bf401e54cb9dc0700989cb7e6e8ff56aa0978b130a8c10b2250b
+  data.tar.gz: e873f202212c36f16b2a97ab7fc678498ded0383bc2ac0ca1af9c647806c0c827be8c85833199af34823202bb8b029fffd66d60903928377890bbcd1e0b4209f

data/README.md

@@ -354,6 +354,33 @@ Sends an SMS notification via Vonage / Nexmo.
   }
   ```
 
+### Fallback Notifications
+
+A common pattern is to deliver a notification via the database and then, after some time has passed, email the user if they have not yet read the notification. You can implement this functionality by combining multiple delivery methods, the `delay` option, and the conditional `if` / `unless` option.
+
+```ruby
+class CommentNotification < Noticed::Base
+  deliver_by :database
+  deliver_by :email, mailer: 'CommentMailer', delay: 15.minutes, unless: :read?
+end
+```
+
+Here a notification will be created immediately in the database (for display directly in your app). If the notification has not been read after 15 minutes, the email notification will be sent. If the notification has already been read in the app, the email will be skipped.
+
+You can also configure multiple fallback options:
+
+```ruby
+class CriticalSystemNotification < Noticed::Base
+  deliver_by :slack
+  deliver_by :email, mailer: 'CriticalSystemMailer', delay: 10.minutes, unless: :read?
+  deliver_by :twilio, delay: 20.minutes, unless: :read?
+end
+```
+
+In this scenario, you can create an escalating notification that starts with a ping in Slack, then emails the team, and then finally sends an SMS to the on-call phone.
+
+You can mix and match the options and delivery methods to suit your application specific needs. 
+
 ### 🚚 Custom Delivery Methods
 
 To generate a custom delivery method, simply run

data/lib/noticed/base.rb

@@ -12,6 +12,8 @@ module Noticed
     # Gives notifications access to the record and recipient when formatting for delivery
     attr_accessor :record, :recipient
 
+    delegate :read?, :unread?, to: :record
+
     class << self
       def deliver_by(name, options = {})
         delivery_methods.push(name: name, options: options)

data/lib/noticed/delivery_methods/email.rb

@@ -18,14 +18,12 @@ module Noticed
       end
 
       def format
-        if (method = options[:format])
+        params = if (method = options[:format])
           notification.send(method)
         else
-          notification.params.merge(
-            recipient: recipient,
-            record: record
-          )
+          notification.params
         end
+        params.merge(recipient: recipient, record: record)
       end
     end
   end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.2.20"
+  VERSION = "1.2.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.20
+  version: 1.2.21
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-23 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails