noticed 1.2.17 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dc2e5f50621a5b5da4f901c472621c2fce03d5f0f4db7c5a00a42de527e3128
-  data.tar.gz: 1e07d7ea3599b7999d9a252a062ab38641cf6553c8392bf54d70ec9fbc164050
+  metadata.gz: 83635d722a21df622c90c4e8ded293206242be768b30b2139c41f13bc4d6712c
+  data.tar.gz: 707ff4e0e8d09ed4c1fa1b0a7228353de637b070e849e7eb234b58b6fb491e40
 SHA512:
-  metadata.gz: 5f2dc0a1735bea8161241f7b384f722fd0a0d5bf1bac80424d63647d39cf9ef727839f3ba8320474c57da327e381daa46c533a788ca7d3ea1978c5eee10dcbfc
-  data.tar.gz: 44eb3c5472b947d416d6f14bb2fa1b6a6d9ed26e853eb5d5ca559c0467c0dea9b83634fb1aac72a691b8fbd7805103e3029562e0800d0f433d2ecd9ab5a4e4d1
+  metadata.gz: 85ddb6e11858df2b21b4dc098096c78465f7ac3dcb7a804037f3cf1855735b954cccb1cb0ad3227d1ebd89cb98e2e6e5d0138af27e73e52d2feeb35ac85ccdec
+  data.tar.gz: 80d3485a086e8203397f83bf3269e057ec63c9da89b3016d29a8395499447419336d89e7d01daff911a838159b963423dd45f6161b80c0dfab608f2f4e11c662

data/README.md

@@ -106,6 +106,7 @@ end
 
 * `if: :method_name`  - Calls `method_name`and cancels delivery method if `false` is returned
 * `unless: :method_name`  - Calls `method_name`and cancels delivery method if `true` is returned
+* `delay: ActiveSupport::Duration` - Delays the delivery for the given duration of time
 
 ##### Helper Methods
 
@@ -186,7 +187,7 @@ Writes notification to the database.
 
 `deliver_by :database`
 
-**Note:** Database notifications are special in that they will run before the other delivery methods. We do this so you can reference the database record ID in other delivery methods.
+**Note:** Database notifications are special in that they will run before the other delivery methods. We do this so you can reference the database record ID in other delivery methods. For that same reason, the delivery can't be delayed (via the `delay` option) or an error will be raised.
 
 ##### Options
 
@@ -264,7 +265,7 @@ Sends a Teams notification via webhook.
 
 * `format: :format_for_teams` - *Optional*
 
-  Use a custom method to define the payload sent to slack. Method should return a Hash.
+  Use a custom method to define the payload sent to Microsoft Teams. Method should return a Hash.
   Documentation for posting via Webhooks available at: https://docs.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook
 
   ```ruby
@@ -353,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
@@ -463,10 +491,19 @@ Sorting notifications by newest first:
 user.notifications.newest_first
 ```
 
-Marking all notifications as read:
+Query for read or unread notifications:
+
+```ruby
+user.notifications.read
+user.notifications.unread
+```
+
+
+Marking all notifications as read or unread:
 
 ```ruby
 user.notifications.mark_as_read!
+user.notifications.mark_as_unread!
 ```
 
 #### Instance methods
@@ -497,53 +534,43 @@ Adding notification associations to your models makes querying and deleting noti
 
 For example, in most cases, you'll want to delete notifications for records that are destroyed.
 
-##### JSON Columns
+We'll need two associations for this:
 
-If you're using MySQL or Postgresql, the `params` column on the notifications table is in `json` or `jsonb` format and can be queried against directly.
+1. Notifications where the record is the recipient
+2. Notifications where the record is in the notification params
 
 For example,  we can query the notifications and delete them on destroy like so:
 
 ```ruby
 class Post < ApplicationRecord
-  def notifications
-    # Exact match
-    @notifications ||= Notification.where(params: { post: self })
-
-    # Or Postgres syntax to query the post key in the JSON column
-    # @notifications ||= Notification.where("params->'post' = ?", Noticed::Coder.dump(self).to_json)
-  end
+  # Standard association for deleting notifications when you're the recipient
+  has_many :notifications, as: :recipient, dependent: :destroy
 
-  before_destroy :destroy_notifications
+  # Helper for associating and destroying Notification records where(params: {post: self})
+  has_noticed_notifications
 
-  def destroy_notifications
-    notifications.destroy_all
-  end
+  # You can override the param_name, the notification model name, or disable the before_destroy callback
+  has_noticed_notifications param_name: :parent, destroy: false, model: "Notification"
 end
-```
-
-##### Polymorphic Assocation
 
-If your notification is only associated with one model or you're using a `text` column for your params column , then a polymorphic association is what you'll want to use.
+# Create a CommentNotification with a post param
+CommentNotification.with(post: @post).deliver(user)
+# Lookup Notifications where params: {post: @post}
+@post.notifications_as_post
 
-1. Add a polymorphic association to the Notification model. `rails g migration AddNotifiableToNotifications notifiable:belongs_to{polymorphic}`
-
-2. Add `has_many :notifications, as: :notifiable, dependent: :destroy` to each model
+CommentNotification.with(parent: @post).deliver(user)
+@post.notifications_as_parent
+```
 
-3. Customize database `format: ` option to write the `notifiable` attribute(s) when saving the notification
+#### Handling Deleted Records
 
-   ```ruby
-   class ExampleNotification < Noticed::Base
-     deliver_by :database, format: :format_for_database
+If you create a notification but delete the associated record and forgot `has_noticed_notifications` on the model, the jobs for sending the notification will not be able to find the record when ActiveJob deserializes. You can discord the job on these errors by adding the following to `ApplicationJob`:
 
-     def format_for_database
-       {
-         notifiable: params.delete(:post),
-         type: self.class.name,
-         params: params
-       }
-     end
-   end
-   ```
+```ruby
+class ApplicationJob < ActiveJob::Base
+  discard_on ActiveJob::DeserializationError
+end
+```
 
 ## 🙏 Contributing
 

data/lib/generators/noticed/model_generator.rb

@@ -43,12 +43,11 @@ module Noticed
 
       def params_column
         case ActiveRecord::Base.configurations.configs_for(spec_name: "primary").config["adapter"]
-        when "mysql2"
-          "params:json"
         when "postgresql"
           "params:jsonb"
         else
-          "params:text"
+          # MySQL and SQLite both support json
+          "params:json"
         end
       end
     end

data/lib/noticed.rb

@@ -5,6 +5,7 @@ require "noticed/engine"
 module Noticed
   autoload :Base, "noticed/base"
   autoload :Coder, "noticed/coder"
+  autoload :HasNotifications, "noticed/has_notifications"
   autoload :Model, "noticed/model"
   autoload :TextCoder, "noticed/text_coder"
   autoload :Translation, "noticed/translation"

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)
@@ -85,9 +87,6 @@ module Noticed
 
     # Actually runs an individual delivery
     def run_delivery_method(delivery_method, recipient:, enqueue:)
-      return if (delivery_method_name = delivery_method.dig(:options, :if)) && !send(delivery_method_name)
-      return if (delivery_method_name = delivery_method.dig(:options, :unless)) && send(delivery_method_name)
-
       args = {
         notification_class: self.class.name,
         options: delivery_method[:options],
@@ -98,7 +97,15 @@ module Noticed
 
       run_callbacks delivery_method[:name] do
         method = delivery_method_for(delivery_method[:name], delivery_method[:options])
-        enqueue ? method.perform_later(args) : method.perform_now(args)
+
+        # Always perfrom later if a delay is present
+        if (delay = delivery_method.dig(:options, :delay))
+          method.set(wait: delay).perform_later(args)
+        elsif enqueue
+          method.perform_later(args)
+        else
+          method.perform_now(args)
+        end
       end
     end
 

data/lib/noticed/delivery_methods/base.rb

@@ -40,6 +40,9 @@ module Noticed
         @notification.record = args[:record]
         @notification.recipient = args[:recipient]
 
+        return if (condition = @options[:if]) && !@notification.send(condition)
+        return if (condition = @options[:unless]) && @notification.send(condition)
+
         run_callbacks :deliver do
           deliver
         end

data/lib/noticed/delivery_methods/database.rb

@@ -6,6 +6,13 @@ module Noticed
         recipient.send(association_name).create!(attributes)
       end
 
+      def self.validate!(options)
+        super
+
+        # Must be executed right away so the other deliveries can access the db record
+        raise ArgumentError, "database delivery cannot be delayed" if options.key?(:delay)
+      end
+
       private
 
       def association_name

data/lib/noticed/delivery_methods/email.rb

@@ -4,7 +4,7 @@ module Noticed
       option :mailer
 
       def deliver
-        mailer.with(format).send(method.to_sym).deliver_later
+        mailer.with(format).send(method.to_sym).deliver_now
       end
 
       private
@@ -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/delivery_methods/vonage.rb

@@ -7,6 +7,8 @@ module Noticed
         if !options[:ignore_failure] && status != "0"
           raise ResponseUnsuccessful.new(response)
         end
+
+        response
       end
 
       private

data/lib/noticed/engine.rb

@@ -1,4 +1,9 @@
 module Noticed
   class Engine < ::Rails::Engine
+    initializer "noticed.has_notifications" do
+      ActiveSupport.on_load(:active_record) do
+        include Noticed::HasNotifications
+      end
+    end
   end
 end

data/lib/noticed/has_notifications.rb

@@ -0,0 +1,32 @@
+module Noticed
+  module HasNotifications
+    # Defines a method for the association and a before_destory callback to remove notifications
+    # where this record is a param
+    #
+    #    class User < ApplicationRecord
+    #      has_noticed_notifications
+    #      has_noticed_notifications param_name: :owner, destroy: false, model: "Notification"
+    #    end
+    #
+    #    @user.notifications_as_user
+    #    @user.notifications_as_owner
+
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def has_noticed_notifications(param_name: model_name.singular, **options)
+        model = options.fetch(:model_name, "Notification").constantize
+
+        define_method "notifications_as_#{param_name}" do
+          model.where(params: {param_name.to_sym => self})
+        end
+
+        if options.fetch(:destroy, true)
+          before_destroy do
+            send("notifications_as_#{param_name}").destroy_all
+          end
+        end
+      end
+    end
+  end
+end

data/lib/noticed/model.rb

@@ -14,11 +14,15 @@ module Noticed
       scope :read, -> { where.not(read_at: nil) }
     end
 
-    module ClassMethods
+    class_methods do
       def mark_as_read!
         update_all(read_at: Time.current, updated_at: Time.current)
       end
 
+      def mark_as_unread!
+        update_all(read_at: nil, updated_at: Time.current)
+      end
+
       def noticed_coder
         case attribute_types["params"].type
         when :json, :jsonb

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.2.17"
+  VERSION = "1.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.2.17
+  version: 1.3.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-27 00:00:00.000000000 Z
+date: 2021-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -67,7 +67,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -110,6 +138,7 @@ files:
 - lib/noticed/delivery_methods/twilio.rb
 - lib/noticed/delivery_methods/vonage.rb
 - lib/noticed/engine.rb
+- lib/noticed/has_notifications.rb
 - lib/noticed/model.rb
 - lib/noticed/notification_channel.rb
 - lib/noticed/text_coder.rb
@@ -135,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications