noticed 2.1.3 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4481f215fcf7bde433f273ff7e3b7df9a0af5971eae6827e108f667fb21e57f4
-  data.tar.gz: 67360b14ce530e2ad2433ee8271c8c0e231220908d8c4014b817517eb3d9185a
+  metadata.gz: 7df6a0c9d61e67b03bdb4fa83ac6cf3ef46b1b79b23ac98f1b0acdf1b02b336a
+  data.tar.gz: f457d0616b83add859fb1660cc53f2bf321f3631c25e6d9403bf52d84246be43
 SHA512:
-  metadata.gz: a9a5d6e6b500e8e4ce297951058f46abf4e3b5c23f42b5e904cfd3a2a7dce6b4f4d933e12731fbde524e70d2339d1a698375eabdd4ba6fd26898e0a0910d2ac8
-  data.tar.gz: 9b4b44dcb8d1fe3fc540e2cdea0ff039846ce56b3b0e1bf709b98f484ee58e7f4ab0ad6566fdbccf2eec1a28297ad511db00ed87b3825a5eaac0d1e532086173
+  metadata.gz: cc114600b94adafc1fb4c01034cfd31e70acda183e5734a31f5ea1d5408272b93b5545dad3861394e0af2944aa2f95765a14689130d8f49479925e3a17f35c2b
+  data.tar.gz: a5e8cc9353874c01f45c286ced403446196be57d241ca1c534b365df1869a560fe08e6c65655e8bb246e672728dd2edb8a394de68111c94b0446513e93b52f9c

data/README.md

@@ -71,7 +71,7 @@ Noticed operates with a few constructs: Notifiers, delivery methods, and Notific
 
 To start, generate a Notifier:
 
-```sh
+```bash
 rails generate noticed:notifier NewCommentNotifier
 ```
 
@@ -202,12 +202,12 @@ class CommentNotifier < Noticed::Event
   end
 end
 
-class Recipent < ApplicationRecord # or whatever your recipient model is
+class Recipient < ApplicationRecord # or whatever your recipient model is
   has_many :ios_device_tokens
 
-    def send_ios_notification?
-        # some logic
-    end
+  def send_ios_notification?
+    # some logic
+  end
 end
 ```
 </details>
@@ -297,16 +297,16 @@ Will look for the following translation path:
 
 en:
   notifiers:
-  	new_comment_notifier:
-  	  notification:
-            message: "Someone posted a new comment!"
+    new_comment_notifier:
+      notification:
+        message: "Someone posted a new comment!"
 ```
 
 Or, if you have your Notifier within another module, such as `Admin::NewCommentNotifier`, the resulting lookup path will be `en.notifiers.admin.new_comment_notifier.notification.message` (modules become nesting steps).
 
 #### Tip: Capture User Preferences
 
-You can use the `if:` and `unless: ` options on your delivery methods to check the user's preferences and skip processing if they have disabled that type of notification.
+You can use the `if:` and `unless:` options on your delivery methods to check the user's preferences and skip processing if they have disabled that type of notification.
 
 For example:
 
@@ -319,6 +319,19 @@ class CommentNotifier < Noticed::Event
   end
 end
 ```
+
+If you would like to skip the delivery job altogether, for example if you know that a user doesn't support the platform and you would like to save resources by not enqueuing the job, you can use `before_enqueue`.
+
+For example:
+
+```ruby
+class IosNotifier < Noticed::Event
+  deliver_by :ios do |config|
+    # ...
+    config.before_enqueue = ->{ throw(:abort) unless recipient.registered_ios? }
+  end
+end
+
 #### Tip: Extracting Delivery Method Configurations
 
 If you want to reuse delivery method configurations across multiple Notifiers, you can extract them into a module and include them in your Notifiers.
@@ -348,7 +361,7 @@ module IosNotifier
       config.key_id = Rails.application.credentials.dig(:ios, :key_id)
       config.team_id = Rails.application.credentials.dig(:ios, :team_id)
       config.apns_key = Rails.application.credentials.dig(:ios, :apns_key)
-      config.if = ->(recipient) { recipient.ios_notifications? }
+      config.if = -> { recipient.ios_notifications? }
     end
   end
 end
@@ -361,8 +374,8 @@ Each of these options are available for every delivery method (individual or bul
 * `config.if` — Intended for a lambda or method; runs after the `wait` if configured; cancels the delivery method if returns falsey
 * `config.unless`  — Intended for a lambda or method; runs after the `wait` if configured; cancels the delivery method if returns truthy
 * `config.wait` — (Should yield an `ActiveSupport::Duration`) Delays the job that runs this delivery method for the given duration of time
-* `config.wait_until` — (Should yield a specific time object) Delays the job that runs this delivery method until the specific time specified
-* `config.queue` — Sets the ActiveJob queue name to be used for the job that runs this delivery method
+* `config.wait_until` — (Should yield a specific time object) Delays the job that runs this delivery method until the specific time specified
+* `config.queue` — Sets the ActiveJob queue name to be used for the job that runs this delivery method
 
 ### 📨 Sending Notifications
 
@@ -387,7 +400,7 @@ This invocation will create a single `Noticed::Event` record and a `Noticed::Not
 
 ### Custom Noticed Model Methods
 
-In order to extend the Noticed models you'll need to use a concern an a to_prepare block:
+In order to extend the Noticed models you'll need to use a concern and a to_prepare block:
 
 ```ruby
 # config/initializers/noticed.rb
@@ -395,7 +408,7 @@ module NotificationExtensions
   extend ActiveSupport::Concern
 
   included do
-    belongs_to :organisation
+    belongs_to :organization
 
     scope :filter_by_type, ->(type) { where(type:) }
     scope :exclude_type, ->(type) { where.not(type:) }
@@ -489,7 +502,7 @@ Sending a notification is entirely an internal-to-your-app function. Delivery me
 A common pattern is to deliver a notification via a real (or real-ish)-time service, 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 `wait` option, and the conditional `if` / `unless` option.
 
 ```ruby
-class NewCommentNotifier< Noticed::Event
+class NewCommentNotifier < Noticed::Event
   deliver_by :action_cable
   deliver_by :email do |config|
     config.mailer = "CommentMailer"
@@ -544,6 +557,7 @@ See the [Custom Noticed Model Methods](#custom-noticed-model-methods) section fo
 
 ```ruby
 # app/notifiers/delivery_methods/turbo_stream.rb
+
 class DeliveryMethods::TurboStream < ApplicationDeliveryMethod
   def deliver
     return unless recipient.is_a?(User)
@@ -557,6 +571,7 @@ end
 
 ```ruby
 # app/models/concerns/noticed/notification_extensions.rb
+
 module Noticed::NotificationExtensions
   extend ActiveSupport::Concern
 
@@ -592,12 +607,12 @@ end
 
 Delivery methods have access to the following methods and attributes:
 
-* `event` — The `Noticed::Event` record that spawned the notification object currently being delivered
-* `record` — The object originally passed into the Notifier as the `record:` param (see the ✨ note above)
-* `notification` — The `Noticed::Notification` instance being delivered. All notification helper methods are available on this object
-* `recipient` — The individual recipient object being delivered to for this notification (remember that each recipient gets their own instance of the Delivery Method `#deliver`)
-* `config` — The hash of configuration options declared by the Notifier that generated this notification and delivery
-* `params` — The parameters given to the Notifier in the invocation (via `.with()`)
+* `event` — The `Noticed::Event` record that spawned the notification object currently being delivered
+* `record` — The object originally passed into the Notifier as the `record:` param (see the ✨ note above)
+* `notification` — The `Noticed::Notification` instance being delivered. All notification helper methods are available on this object
+* `recipient` — The individual recipient object being delivered to for this notification (remember that each recipient gets their own instance of the Delivery Method `#deliver`)
+* `config` — The hash of configuration options declared by the Notifier that generated this notification and delivery
+* `params` — The parameters given to the Notifier in the invocation (via `.with()`)
 
 #### Validating config options passed to Custom Delivery methods
 
@@ -628,7 +643,7 @@ class DeliveryMethods::WhatsApp < Noticed::DeliveryMethod
 
   def deliver
     # ...
-		config.day #=> #<Proc:0x000f7c8 (lambda)>
+    config.day #=> #<Proc:0x000f7c8 (lambda)>
     evaluate_option(config.day) #=> "Tuesday"
   end
 end
@@ -766,7 +781,7 @@ class CreateNoticedTables < ActiveRecord::Migration[7.1]
       t.jsonb :params
 
       # Custom Fields
-      t.string :organisation_id, type: :uuid, as: "((params ->> 'organisation_id')::uuid)", stored: true
+      t.string :organization_id, type: :uuid, as: "((params ->> 'organization_id')::uuid)", stored: true
       t.virtual :action_type, type: :string, as: "((params ->> 'action_type'))", stored: true
       t.virtual :url, type: :string, as: "((params ->> 'url'))", stored: true
 
@@ -803,4 +818,5 @@ DATABASE_URL=postgres://127.0.0.1/noticed_test rails test
 ```
 
 ## 📝 License
+
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/app/jobs/noticed/event_job.rb

@@ -4,14 +4,14 @@ module Noticed
 
     def perform(event)
       # Enqueue bulk deliveries
-      event.bulk_delivery_methods.each do |_, deliver_by|
+      event.bulk_delivery_methods.each_value do |deliver_by|
         deliver_by.perform_later(event)
       end
 
       # Enqueue individual deliveries
       event.notifications.each do |notification|
-        event.delivery_methods.each do |_, deliver_by|
-          deliver_by.perform_later(notification)
+        event.delivery_methods.each_value do |deliver_by|
+          deliver_by.perform_later(notification) if deliver_by.perform?(notification)
         end
       end
     end

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

@@ -138,5 +138,10 @@ module Noticed
       bulk_delivery_methods.values.each(&:validate!)
       delivery_methods.values.each(&:validate!)
     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/app/models/noticed/deliverable/deliver_by.rb

@@ -19,27 +19,18 @@ module Noticed
       end
 
       def perform_later(event_or_notification, options = {})
-        options[:wait] ||= evaluate_option(:wait, event_or_notification) if config.has_key?(:wait)
-        options[:wait_until] ||= evaluate_option(:wait_until, event_or_notification) if config.has_key?(:wait_until)
-        options[:queue] ||= evaluate_option(:queue, event_or_notification) if config.has_key?(:queue)
-        options[:priority] ||= evaluate_option(:priority, event_or_notification) if config.has_key?(:priority)
-
-        constant.set(options).perform_later(name, event_or_notification)
+        constant.set(computed_options(options, event_or_notification)).perform_later(name, event_or_notification)
       end
 
       def ephemeral_perform_later(notifier, recipient, params, options = {})
-        options[:wait] ||= evaluate_option(:wait, recipient) if config.has_key?(:wait)
-        options[:wait_until] ||= evaluate_option(:wait_until, recipient) if config.has_key?(:wait_until)
-        options[:queue] ||= evaluate_option(:queue, recipient) if config.has_key?(:queue)
-        options[:priority] ||= evaluate_option(:priority, recipient) if config.has_key?(:priority)
-
-        constant.set(options).perform_later(name, "#{notifier}::Notification", recipient: recipient, params: params)
+        constant.set(computed_options(options, recipient))
+          .perform_later(name, "#{notifier}::Notification", recipient: recipient, params: params)
       end
 
       def evaluate_option(name, context)
         option = config[name]
 
-        if option&.respond_to?(:call)
+        if option.respond_to?(:call)
           context.instance_exec(&option)
         elsif option.is_a?(Symbol) && context.respond_to?(option)
           context.send(option)
@@ -47,6 +38,27 @@ module Noticed
           option
         end
       end
+
+      def perform?(notification)
+        return true unless config.key?(:before_enqueue)
+
+        perform = false
+        catch(:abort) {
+          evaluate_option(:before_enqueue, notification)
+          perform = true
+        }
+        perform
+      end
+
+      private
+
+      def computed_options(options, recipient)
+        options[:wait] ||= evaluate_option(:wait, recipient) if config.has_key?(:wait)
+        options[:wait_until] ||= evaluate_option(:wait_until, recipient) if config.has_key?(:wait_until)
+        options[:queue] ||= evaluate_option(:queue, recipient) if config.has_key?(:queue)
+        options[:priority] ||= evaluate_option(:priority, recipient) if config.has_key?(:priority)
+        options
+      end
     end
   end
 end

data/app/models/noticed/ephemeral.rb

@@ -29,6 +29,10 @@ module Noticed
       notifier.const_set :Notification, Class.new(Noticed::Ephemeral::Notification)
     end
 
+    def self.notification_methods(&block)
+      const_get(:Notification).class_eval(&block)
+    end
+
     def deliver(recipients)
       recipients = Array.wrap(recipients)
       bulk_delivery_methods.each do |_, deliver_by|
@@ -45,9 +49,5 @@ module Noticed
     def record
       params[:record]
     end
-
-    def notification_methods(&block)
-      const_get(:Notification).class_eval(&block)
-    end
   end
 end

data/db/migrate/20231215190233_create_noticed_tables.rb

@@ -1,8 +1,9 @@
 class CreateNoticedTables < ActiveRecord::Migration[6.1]
   def change
-    create_table :noticed_events do |t|
+    primary_key_type, foreign_key_type = primary_and_foreign_key_types
+    create_table :noticed_events, id: primary_key_type do |t|
       t.string :type
-      t.belongs_to :record, polymorphic: true
+      t.belongs_to :record, polymorphic: true, type: foreign_key_type
       if t.respond_to?(:jsonb)
         t.jsonb :params
       else
@@ -12,14 +13,24 @@ class CreateNoticedTables < ActiveRecord::Migration[6.1]
       t.timestamps
     end
 
-    create_table :noticed_notifications do |t|
+    create_table :noticed_notifications, id: primary_key_type do |t|
       t.string :type
-      t.belongs_to :event, null: false
-      t.belongs_to :recipient, polymorphic: true, null: false
+      t.belongs_to :event, null: false, type: foreign_key_type
+      t.belongs_to :recipient, polymorphic: true, null: false, type: foreign_key_type
       t.datetime :read_at
       t.datetime :seen_at
 
       t.timestamps
     end
   end
+
+  private
+
+  def primary_and_foreign_key_types
+    config = Rails.configuration.generators
+    setting = config.options[config.orm][:primary_key_type]
+    primary_key_type = setting || :primary_key
+    foreign_key_type = setting || :bigint
+    [primary_key_type, foreign_key_type]
+  end
 end

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

@@ -1,6 +1,6 @@
 # To deliver this notification:
 #
-# <%= class_name %>.with(record: @post, message: "New post").deliver(User.all)
+# <%= class_name %>Notifier.with(record: @post, message: "New post").deliver(User.all)
 
 class <%= class_name %>Notifier < ApplicationNotifier
   # Add your delivery methods

data/lib/noticed/api_client.rb

@@ -28,7 +28,7 @@ module Noticed
       if (json = args.delete(:json))
         request.body = json.to_json
       elsif (form = args.delete(:form))
-        request.set_form(form, "multipart/form-data")
+        request.form_data = form
       end
 
       logger.debug("POST #{url}")

data/lib/noticed/delivery_methods/ios.rb

@@ -35,7 +35,7 @@ module Noticed
         method = config[:format]
         # Call method on Notifier if defined
         if method&.is_a?(Symbol) && event.respond_to?(method)
-          event.send(method, apn)
+          event.send(method, notification, apn)
         # If Proc, evaluate it on the Notification
         elsif method&.respond_to?(:call)
           notification.instance_exec(apn, &method)

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "2.1.3"
+  VERSION = "2.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 2.1.3
+  version: 2.2.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-01 00:00:00.000000000 Z
+date: 2024-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails