noticed 1.5.9 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 367ce1b20a44bfc15ebf8aeaa0328ef90ad0673edd076e977d0e647a3a1b13b7
-  data.tar.gz: 437627e876b7e42243626bab168b9fd37d7da49c54309e2f8f9ef91dfb5e541b
+  metadata.gz: eade1cdb53653ae77fa61a1348340402ea37625188677a16baddda26bc42bd49
+  data.tar.gz: 11d1d9ba60517005306714fc028fd312bbee7bef489d19218e7ba5c6938e22eb
 SHA512:
-  metadata.gz: 5991aa837054391b01f5614617db15951279d4015c96eab52194ad7a0ab05cf3d586353cb5968bb04584246b23682c75365858464062c852b70f9553f0be8ad5
-  data.tar.gz: ff4adba6ae61a08bf8dab9a4b27899c3e5dd3dea8e1475fa7f1da589db85ce17b264d02ed523ea38d905bd53016f2e1d483cf4a7c18ea9461e1b12ef056868e6
+  metadata.gz: '08b57a6181fa23484fa7c21eb7153a75c2bb05750532d2c649a8bc46e30b57be8041039802396167e639fede5595c64bb09d683eaeb1f23a0b0d346f2e76ca5e'
+  data.tar.gz: cc01ee47a638c02f1e5311c1433735607052130be9b4beaf61ced7482fd31910ab8c8a17915ff9c60a50bccddbc86bcb14f44519d8119632a95a1eba214f22a4

data/README.md

@@ -194,6 +194,8 @@ deliver_by :slack, debug: true
 
 ## ✅ Best Practices
 
+### Creating a notification from an Active Record callback
+
 A common use case is to trigger a notification when a record is created. For example,
 
 ```ruby
@@ -217,6 +219,23 @@ A common symptom of this problem is undelivered notifications and the following
 
 > `Discarded Noticed::DeliveryMethods::Email due to a ActiveJob::DeserializationError.`
 
+### Renaming notifications
+
+If you rename the class of a notification object your existing queries can break. This is because Noticed serializes the class name and sets it to the `type` column on the `Notification` record.
+
+You can catch these errors at runtime by using `YourNotificationClassName.name` instead of hardcoding the string when performing a query.
+
+```ruby
+Notification.where(type: YourNotificationClassName.name) # good
+Notification.where(type: "YourNotificationClassName") # bad
+```
+
+When renaming a notification class you will need to backfill existing notifications to reference the new name.
+
+```ruby
+Notification.where(type: "OldNotificationClassName").update_all(type: NewNotificationClassName.name)
+```
+
 ## 🚛 Delivery Methods
 
 The delivery methods are designed to be modular so you can customize the way each type gets delivered.
@@ -351,22 +370,6 @@ class DeliveryMethods::Discord < Noticed::DeliveryMethods::Base
 end
 ```
 
-#### Limitations
-
-Rails 6.1+ can serialize Class and Module objects as arguments to ActiveJob. The following syntax should work for Rails 6.1+:
-
-```ruby
-  deliver_by DeliveryMethods::Discord
-```
-
-For Rails 5.2 and 6.0, you must pass strings of the class names in the `deliver_by` options.
-
-```ruby
-  deliver_by :discord, class: "DeliveryMethods::Discord"
-```
-
-We recommend using a string in order to prevent confusion.
-
 ### 📦 Database Model
 
 The Notification database model includes several helpful features to make working with database notifications easier.

data/lib/generators/noticed/templates/README

@@ -3,5 +3,5 @@
 
 Next steps:
 1. Run "rails db:migrate"
-2. Add "has_many :notifications, as: :recipient" to your User model(s).
+2. Add "has_many :notifications, as: :recipient, dependent: :destroy" to your User model(s).
 3. Generate notifications with "rails g noticed:notification"

data/lib/noticed/base.rb

@@ -75,6 +75,10 @@ module Noticed
       @params || {}
     end
 
+    def clear_recipient
+      self.recipient = nil
+    end
+
     private
 
     # Runs all delivery methods for a notification

data/lib/noticed/coder.rb

@@ -3,6 +3,8 @@ module Noticed
     def self.load(data)
       return if data.nil?
       ActiveJob::Arguments.send(:deserialize_argument, data)
+    rescue ActiveRecord::RecordNotFound => error
+      {noticed_error: error.message, original_params: data}
     end
 
     def self.dump(data)

data/lib/noticed/model.rb

@@ -72,5 +72,10 @@ module Noticed
     def read?
       read_at?
     end
+
+    # If a GlobalID record in params is no longer found, the params will default with a noticed_error key
+    def deserialize_error?
+      !!params[:noticed_error]
+    end
   end
 end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.5.9"
+  VERSION = "1.6.0"
 end

data/lib/noticed.rb

@@ -16,22 +16,13 @@ module Noticed
     autoload :Base, "noticed/delivery_methods/base"
     autoload :Database, "noticed/delivery_methods/database"
     autoload :Email, "noticed/delivery_methods/email"
+    autoload :Fcm, "noticed/delivery_methods/fcm"
     autoload :Ios, "noticed/delivery_methods/ios"
     autoload :MicrosoftTeams, "noticed/delivery_methods/microsoft_teams"
     autoload :Slack, "noticed/delivery_methods/slack"
     autoload :Test, "noticed/delivery_methods/test"
     autoload :Twilio, "noticed/delivery_methods/twilio"
     autoload :Vonage, "noticed/delivery_methods/vonage"
-    autoload :Fcm, "noticed/delivery_methods/fcm"
-  end
-
-  def self.notify(recipients:, notification:)
-    recipients.each do |recipient|
-      notification.notify(recipient)
-    end
-
-    # Clear the recipient after sending to the group
-    notification.recipient = nil
   end
 
   mattr_accessor :parent_class

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.5.9
+  version: 1.6.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -170,7 +170,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications