noticed 2.7.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409bc0222c2ca902d1cf99a7015cfe24ca3f0c9b1e765ff97af2ae327ce8598f
-  data.tar.gz: 022f80d4007f6026d874cf1ba68898028e294989d84204db476c53864ffd43aa
+  metadata.gz: dec070db3dc9527a542e8f4cb57edc6dd61397c8cb870dd3efbb4dccd905b410
+  data.tar.gz: 9ca50907997ea442ff27c305d679aa7ed4e02d80658938bc7f5b75e4888ce95d
 SHA512:
-  metadata.gz: 7229791c39a6edb4ae4abff40a8bbbb6f727167235714b1b8ecaab2769ab9770771059ddccbe1f8f8372ac233ad2cb6ca55679dadd328d19795934305f8f35ca
-  data.tar.gz: ddf2c02c68f2310845067f73596dbc504083e94be646acf5ce7e98f2c67e0a98d794672358abc019d4565302b5140bbd036959f13ab3e5590f904e65d5715c29
+  metadata.gz: 9539c8bc4303864682d8270eebb39b0e1e79b0db7e50b8674e0cdae9c5bb1ec59b5ae556309162e91c74e678bcfb37369414edbeeaebb081a1822395de79e561
+  data.tar.gz: 67190713e1fefee0a28458659e04dd5a4d3984b620e7ccb080e1e6e5dc6d49ec06b63d6c74ae8ab1a6b4dda99e1a2dc4bfb43a0495b9271015e45762c378ad21

data/README.md

@@ -493,6 +493,27 @@ module MyApp
 end
 ```
 
+#### Tip: Custom properties on a notification per recipient
+
+In order to have recipient-specific settings on the notification, override the `recipient_attributes_for(recipient)` method in your notifier:
+
+```ruby
+class CommentNotifier < ApplicationNotifier
+  #...
+  def recipient_attributes_for(recipient)
+    data = super
+    data[:priority] = if recipient.participant?
+      "high"
+    else
+      "low"
+    end
+    data
+  end
+end
+```
+
+Assuming you have a `priority` column in the `noticed_notifications` table, it will be set to the value from the hash here. The default properties of the hash are `recipient_type` and `recipient_id`.
+
 ## ✅ Best Practices
 
 ### Renaming Notifiers
@@ -573,7 +594,9 @@ You can mix and match the options and delivery methods to suit your application
 
 If you want to build your own delivery method to deliver notifications to a specific service or medium that Noticed doesn’t (or doesn’t _yet_) support, you’re welcome to do so! To generate a custom delivery method, simply run
 
-`rails generate noticed:delivery_method Discord`
+```bash
+rails generate noticed:delivery_method Discord
+```
 
 This will generate a new `ApplicationDeliveryMethod` and `DeliveryMethods::Discord` class inside the `app/notifiers/delivery_methods` folder, which can be used to deliver notifications to Discord.
 
@@ -586,7 +609,6 @@ class DeliveryMethods::Discord < ApplicationDeliveryMethod
     # Logic for sending the notification
   end
 end
-
 ```
 
 You can use the custom delivery method thus created by adding a `deliver_by` line with a unique name and `class` option in your notification class.
@@ -597,6 +619,12 @@ class MyNotifier < Noticed::Event
 end
 ```
 
+You can also generate bulk delivery methods with the `--bulk` flag:
+
+```bash
+rails generate noticed:delivery_method Discord --bulk
+```
+
 <details>
 <summary>Turbo Stream Custom Delivery Method Example</summary>
 

data/app/models/concerns/noticed/deliverable.rb

@@ -118,9 +118,9 @@ module Noticed
     def evaluate_recipients
       return unless _recipients
 
-      if _recipients.respond_to?(:call)
+      if _recipients.respond_to?(:call, true)
         instance_exec(&_recipients)
-      elsif _recipients.is_a?(Symbol) && respond_to?(_recipients)
+      elsif _recipients.is_a?(Symbol) && respond_to?(_recipients, true)
         send(_recipients)
       end
     end

data/lib/generators/noticed/delivery_method_generator.rb

@@ -11,9 +11,16 @@ module Noticed
 
       desc "Generates a class for a custom delivery method with the given NAME."
 
+      class_option :bulk, desc: "Generate as a bulk delivery method", type: :boolean, default: false
+
       def generate_notification
-        template "application_delivery_method.rb", "app/notifiers/application_delivery_method.rb"
-        template "delivery_method.rb", "app/notifiers/delivery_methods/#{singular_name}.rb"
+        if options[:bulk]
+          template "application_bulk_delivery_method.rb", "app/notifiers/application_bulk_delivery_method.rb"
+          template "bulk_delivery_method.rb", "app/notifiers/bulk_delivery_methods/#{singular_name}.rb"
+        else
+          template "application_delivery_method.rb", "app/notifiers/application_delivery_method.rb"
+          template "delivery_method.rb", "app/notifiers/delivery_methods/#{singular_name}.rb"
+        end
       end
     end
   end

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

@@ -0,0 +1,2 @@
+class ApplicationBulkDeliveryMethod < Noticed::BulkDeliveryMethod
+end

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

@@ -0,0 +1,14 @@
+class BulkDeliveryMethods::<%= class_name %> < ApplicationBulkDeliveryMethod
+  # To use this delivery method, specify the class option in your notifier.
+  #
+  #   class MyNotifer < ApplicationNotifier
+  #     bulk_deliver_by :<%= file_path %>, class: "<%= class_name %>"
+  #   end
+
+  # Specify the config options your delivery method requires in its config block
+  required_options # :foo, :bar
+
+  def deliver
+    # Logic for sending the notification
+  end
+end

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

@@ -1,4 +1,10 @@
 class DeliveryMethods::<%= class_name %> < ApplicationDeliveryMethod
+  # To use this delivery method, specify the class option in your notifier.
+  #
+  #   class MyNotifer < ApplicationNotifier
+  #     deliver_by :<%= file_path %>, class: "<%= class_name %>"
+  #   end
+
   # Specify the config options your delivery method requires in its config block
   required_options # :foo, :bar
 

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

@@ -21,4 +21,10 @@ class <%= class_name %>Notifier < ApplicationNotifier
   # Add required params
   #
   # required_param :message
+
+  # Compute recipients without having to pass them in
+  #
+  # recipients do
+  #   params[:record].thread.all_authors
+  # end
 end

data/lib/noticed/delivery_methods/fcm.rb

@@ -18,6 +18,8 @@ module Noticed
       rescue Noticed::ResponseUnsuccessful => exception
         if bad_token?(exception.response) && config[:invalid_token]
           notification.instance_exec(device_token, &config[:invalid_token])
+        elsif config[:error_handler]
+          notification.instance_exec(exception.response, &config[:error_handler])
         else
           raise
         end

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "2.7.0"
+  VERSION = "2.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 2.8.0
 platform: ruby
 authors:
 - Chris Oliver
@@ -50,8 +50,10 @@ files:
 - lib/generators/noticed/install_generator.rb
 - lib/generators/noticed/notifier_generator.rb
 - lib/generators/noticed/templates/README
+- lib/generators/noticed/templates/application_bulk_delivery_method.rb.tt
 - lib/generators/noticed/templates/application_delivery_method.rb.tt
 - lib/generators/noticed/templates/application_notifier.rb.tt
+- lib/generators/noticed/templates/bulk_delivery_method.rb.tt
 - lib/generators/noticed/templates/delivery_method.rb.tt
 - lib/generators/noticed/templates/notifier.rb.tt
 - lib/noticed.rb
@@ -99,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.0
 specification_version: 4
 summary: Notifications for Ruby on Rails applications
 test_files: []