noticed 2.7.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 409bc0222c2ca902d1cf99a7015cfe24ca3f0c9b1e765ff97af2ae327ce8598f
-  data.tar.gz: 022f80d4007f6026d874cf1ba68898028e294989d84204db476c53864ffd43aa
+  metadata.gz: 10b19f81b81ae5471493e73857b55fbb1086545cca11f58cd40935597a39b5a1
+  data.tar.gz: 6a3e5502295f8152f0d05b4150a7c272ec48595adb986c81112aea3d09fce891
 SHA512:
-  metadata.gz: 7229791c39a6edb4ae4abff40a8bbbb6f727167235714b1b8ecaab2769ab9770771059ddccbe1f8f8372ac233ad2cb6ca55679dadd328d19795934305f8f35ca
-  data.tar.gz: ddf2c02c68f2310845067f73596dbc504083e94be646acf5ce7e98f2c67e0a98d794672358abc019d4565302b5140bbd036959f13ab3e5590f904e65d5715c29
+  metadata.gz: ca14522f41fbbc56b6764fb818a7d283a49d94e31d1dfcddbe8042429612d6a7f41e42df53867bfc4175fd66fc7aa5079c116db3b62707b5f87ea884c5dd5a5f
+  data.tar.gz: c0b7e78c47afa9df9a642f18717aa15c9c37a1823110b05c9c6b82987f6de0791ca82437f4b7e552ced05c38274b16d90478b9af29999791c2bc66ddd29fe37b

data/README.md

@@ -4,9 +4,6 @@
 
 [![Build Status](https://github.com/excid3/noticed/workflows/Tests/badge.svg)](https://github.com/excid3/noticed/actions) [![Gem Version](https://badge.fury.io/rb/noticed.svg)](https://badge.fury.io/rb/noticed)
 
-> [!IMPORTANT]
-> **⚠️ Upgrading from V1? Read the [Upgrade Guide](https://github.com/excid3/noticed/blob/main/UPGRADE.md)!**
-
 Noticed is a gem that allows your application to send notifications of varying types, over various mediums, to various recipients. Be it a Slack notification to your own team when some internal event occurs or a notification to your user, sent as a text message, email, and real-time UI element in the browser, Noticed supports all of the above (at the same time)!
 
 Noticed implements two top-level types of delivery methods:
@@ -30,6 +27,7 @@ Bulk deliveries are typically used to push notifications to other platforms wher
 Delivery methods we officially support:
 
 * [ActionCable](docs/delivery_methods/action_cable.md)
+* [Action Push Native](docs/delivery_methods/action_push_native.md)
 * [Apple Push Notification Service](docs/delivery_methods/ios.md)
 * [Email](docs/delivery_methods/email.md)
 * [Firebase Cloud Messaging](docs/delivery_methods/fcm.md) (iOS, Android, and web clients)
@@ -493,6 +491,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 +592,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 +607,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 +617,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 required options for the deliver_by 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,6 +1,12 @@
 class DeliveryMethods::<%= class_name %> < ApplicationDeliveryMethod
-  # Specify the config options your delivery method requires in its config block
-  required_options # :foo, :bar
+  # To use this delivery method, specify the class option in your notifier.
+  #
+  #   class MyNotifer < ApplicationNotifier
+  #     deliver_by :<%= file_path %>, class: "<%= class_name %>"
+  #   end
+
+  # Specify required options for the deliver_by config block
+  # required_options :foo, :bar
 
   def deliver
     # Logic for sending the notification

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/api_client.rb

@@ -29,6 +29,8 @@ module Noticed
         request.body = json.to_json
       elsif (form = args.delete(:form))
         request.form_data = form
+      elsif (body = args.delete(:body))
+        request.body = body
       end
 
       logger.debug("POST #{url}")

data/lib/noticed/bulk_delivery_method.rb

@@ -4,6 +4,7 @@ module Noticed
     include RequiredOptions
 
     extend ActiveModel::Callbacks
+
     define_model_callbacks :deliver
 
     class_attribute :logger, default: Rails.logger

data/lib/noticed/bulk_delivery_methods/webhook.rb

@@ -10,7 +10,8 @@ module Noticed
           basic_auth: evaluate_option(:basic_auth),
           headers: evaluate_option(:headers),
           json: evaluate_option(:json),
-          form: evaluate_option(:form)
+          form: evaluate_option(:form),
+          body: evaluate_option(:body)
         )
       end
     end

data/lib/noticed/coder.rb

@@ -11,7 +11,11 @@ module Noticed
 
     def self.dump(data)
       return if data.nil?
-      ActiveJob::Arguments.send(:serialize_argument, data)
+      if ActiveJob::Arguments.respond_to?(:serialize_argument, true)
+        ActiveJob::Arguments.send(:serialize_argument, data)
+      else
+        ActiveJob::Arguments.serialize(data)
+      end
     end
   end
 end

data/lib/noticed/delivery_method.rb

@@ -4,6 +4,7 @@ module Noticed
     include RequiredOptions
 
     extend ActiveModel::Callbacks
+
     define_model_callbacks :deliver
 
     class_attribute :logger, default: Rails.logger

data/lib/noticed/delivery_methods/action_push_native.rb

@@ -0,0 +1,24 @@
+module Noticed
+  module DeliveryMethods
+    class ActionPushNative < DeliveryMethod
+      required_options :devices, :format
+
+      def deliver
+        notification = (!!evaluate_option(:silent)) ? notification_class.silent : notification_class
+
+        notification
+          .with_apple(evaluate_option(:with_apple))
+          .with_google(evaluate_option(:with_google))
+          .with_data(evaluate_option(:with_data))
+          .new(**evaluate_option(:format))
+          .deliver_later_to(evaluate_option(:devices))
+      end
+
+      def notification_class
+        fetch_constant(:class) || ApplicationPushNotification
+      end
+    end
+  end
+end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_action_push_native, Noticed::DeliveryMethods::ActionPushNative

data/lib/noticed/delivery_methods/email.rb

@@ -7,7 +7,9 @@ module Noticed
         mailer = fetch_constant(:mailer)
         email = evaluate_option(:method)
         args = evaluate_option(:args) || []
-        mail = mailer.with(params).public_send(email, *args)
+        kwargs = evaluate_option(:kwargs) || {}
+        mail = mailer.with(params).public_send(email, *args, **kwargs)
+
         (!!evaluate_option(:enqueue)) ? mail.deliver_later : mail.deliver_now
       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/delivery_methods/webhook.rb

@@ -9,7 +9,8 @@ module Noticed
           basic_auth: evaluate_option(:basic_auth),
           headers: evaluate_option(:headers),
           json: evaluate_option(:json),
-          form: evaluate_option(:form)
+          form: evaluate_option(:form),
+          body: evaluate_option(:body)
         )
       end
     end

data/lib/noticed/engine.rb

@@ -2,6 +2,10 @@ module Noticed
   class Engine < ::Rails::Engine
     isolate_namespace Noticed
 
+    initializer "noticed.deprecator" do |app|
+      app.deprecators[:noticed] = Noticed.deprecator if app.respond_to?(:deprecators)
+    end
+
     initializer "noticed.has_notifications" do
       ActiveSupport.on_load(:active_record) do
         include Noticed::HasNotifications

data/lib/noticed/version.rb

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

data/lib/noticed.rb

@@ -1,53 +1,34 @@
 require "noticed/version"
 require "noticed/engine"
 
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
+loader.ignore("#{__dir__}/generators")
+loader.do_not_eager_load("#{__dir__}/noticed/bulk_delivery_methods")
+loader.do_not_eager_load("#{__dir__}/noticed/delivery_methods")
+loader.do_not_eager_load("#{__dir__}/noticed/notification_channel.rb")
+loader.setup
+
 module Noticed
   include ActiveSupport::Deprecation::DeprecatedConstantAccessor
 
   def self.deprecator # :nodoc:
-    @deprecator ||= ActiveSupport::Deprecation.new
+    @deprecator ||= ActiveSupport::Deprecation.new("3.0", "Noticed")
   end
 
   deprecate_constant :Base, "Noticed::Event", deprecator: deprecator
 
-  autoload :ApiClient, "noticed/api_client"
-  autoload :BulkDeliveryMethod, "noticed/bulk_delivery_method"
-  autoload :Coder, "noticed/coder"
-  autoload :DeliveryMethod, "noticed/delivery_method"
-  autoload :HasNotifications, "noticed/has_notifications"
-  autoload :NotificationChannel, "noticed/notification_channel"
-  autoload :RequiredOptions, "noticed/required_options"
-  autoload :Translation, "noticed/translation"
-
-  module BulkDeliveryMethods
-    autoload :Bluesky, "noticed/bulk_delivery_methods/bluesky"
-    autoload :Discord, "noticed/bulk_delivery_methods/discord"
-    autoload :Slack, "noticed/bulk_delivery_methods/slack"
-    autoload :Test, "noticed/bulk_delivery_methods/test"
-    autoload :Webhook, "noticed/bulk_delivery_methods/webhook"
-  end
-
   module DeliveryMethods
     include ActiveSupport::Deprecation::DeprecatedConstantAccessor
-    deprecate_constant :Base, "Noticed::DeliveryMethod", deprecator: Noticed.deprecator
 
-    autoload :ActionCable, "noticed/delivery_methods/action_cable"
-    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 :TwilioMessaging, "noticed/delivery_methods/twilio_messaging"
-    autoload :VonageSms, "noticed/delivery_methods/vonage_sms"
-    autoload :Webhook, "noticed/delivery_methods/webhook"
+    deprecate_constant :Base, "Noticed::DeliveryMethod", deprecator: Noticed.deprecator
   end
 
   mattr_accessor :parent_class
   @@parent_class = "Noticed::ApplicationJob"
 
-  class ValidationError < StandardError
-  end
+  class ValidationError < StandardError; end
 
   class ResponseUnsuccessful < StandardError
     attr_reader :response

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 2.7.0
+  version: 3.0.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
@@ -65,6 +67,7 @@ files:
 - lib/noticed/coder.rb
 - lib/noticed/delivery_method.rb
 - lib/noticed/delivery_methods/action_cable.rb
+- lib/noticed/delivery_methods/action_push_native.rb
 - lib/noticed/delivery_methods/discord.rb
 - lib/noticed/delivery_methods/email.rb
 - lib/noticed/delivery_methods/fcm.rb
@@ -99,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Notifications for Ruby on Rails applications
 test_files: []