noticed 2.0.0 → 3.0.0

data/lib/noticed/bulk_delivery_methods/bluesky.rb

@@ -0,0 +1,51 @@
+module Noticed
+  module BulkDeliveryMethods
+    class Bluesky < BulkDeliveryMethod
+      required_options :identifier, :password, :json
+
+      # bulk_deliver_by :bluesky do |config|
+      #   config.identifier = ENV["BLUESKY_ID"]
+      #   config.password = ENV["BLUESKY_PASSWORD"]
+      #   config.json = {text: "...", createdAt: "..."}
+      # end
+
+      def deliver
+        Rails.logger.debug(evaluate_option(:json))
+        post_request(
+          "https://#{host}/xrpc/com.atproto.repo.createRecord",
+          headers: {"Authorization" => "Bearer #{token}"},
+          json: {
+            repo: identifier,
+            collection: "app.bsky.feed.post",
+            record: evaluate_option(:json)
+          }
+        )
+      end
+
+      def token
+        start_session.dig("accessJwt")
+      end
+
+      def start_session
+        response = post_request(
+          "https://#{host}/xrpc/com.atproto.server.createSession",
+          json: {
+            identifier: identifier,
+            password: evaluate_option(:password)
+          }
+        )
+        JSON.parse(response.body)
+      end
+
+      def host
+        @host ||= evaluate_option(:host) || "bsky.social"
+      end
+
+      def identifier
+        @identifier ||= evaluate_option(:identifier)
+      end
+    end
+  end
+end
+
+ActiveSupport.run_load_hooks :noticed_bulk_delivery_methods_bluesky, Noticed::BulkDeliveryMethods::Bluesky

data/lib/noticed/bulk_delivery_methods/discord.rb

@@ -9,3 +9,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_bulk_delivery_methods_discord, Noticed::BulkDeliveryMethods::Discord

data/lib/noticed/bulk_delivery_methods/slack.rb

@@ -6,12 +6,36 @@ module Noticed
       required_options :json
 
       def deliver
-        post_request url, headers: evaluate_option(:headers), json: evaluate_option(:json)
+        headers = evaluate_option(:headers)
+        json = evaluate_option(:json)
+        response = post_request url, headers: headers, json: json
+
+        if raise_if_not_ok? && !success?(response)
+          raise ResponseUnsuccessful.new(response, url, {headers: headers, json: json})
+        end
+
+        response
       end
 
       def url
         evaluate_option(:url) || DEFAULT_URL
       end
+
+      def raise_if_not_ok?
+        value = evaluate_option(:raise_if_not_ok)
+        value.nil? || value
+      end
+
+      def success?(response)
+        if response.content_type == "application/json"
+          JSON.parse(response.body).dig("ok")
+        else
+          # https://api.slack.com/changelog/2016-05-17-changes-to-errors-for-incoming-webhooks
+          response.is_a?(Net::HTTPSuccess)
+        end
+      end
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_bulk_delivery_methods_slack, Noticed::BulkDeliveryMethods::Slack

data/lib/noticed/bulk_delivery_methods/test.rb

@@ -0,0 +1,13 @@
+module Noticed
+  module BulkDeliveryMethods
+    class Test < BulkDeliveryMethod
+      class_attribute :delivered, default: []
+
+      def deliver
+        delivered << event
+      end
+    end
+  end
+end
+
+ActiveSupport.run_load_hooks :noticed_bulk_delivery_methods_test, Noticed::BulkDeliveryMethods::Test

data/lib/noticed/bulk_delivery_methods/webhook.rb

@@ -10,9 +10,12 @@ 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
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_bulk_delivery_methods_webhook, Noticed::BulkDeliveryMethods::Webhook

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

@@ -1,16 +1,27 @@
 module Noticed
-  class DeliveryMethod < ApplicationJob
+  class DeliveryMethod < Noticed.parent_class.constantize
     include ApiClient
     include RequiredOptions
 
+    extend ActiveModel::Callbacks
+
+    define_model_callbacks :deliver
+
     class_attribute :logger, default: Rails.logger
 
     attr_reader :config, :event, :notification
     delegate :recipient, to: :notification
+    delegate :record, :params, to: :event
 
-    def perform(delivery_method_name, notification, overrides: {})
-      @notification = notification
-      @event = notification.event
+    def perform(delivery_method_name, notification, recipient: nil, params: {}, overrides: {})
+      # Ephemeral notifications
+      if notification.is_a? String
+        @notification = notification.constantize.new_with_params(recipient, params)
+        @event = @notification.event
+      else
+        @notification = notification
+        @event = notification.event
+      end
 
       # Look up config from Notifier and merge overrides
       @config = event.delivery_methods.fetch(delivery_method_name).config.merge(overrides)
@@ -18,7 +29,9 @@ module Noticed
       return false if config.has_key?(:if) && !evaluate_option(:if)
       return false if config.has_key?(:unless) && evaluate_option(:unless)
 
-      deliver
+      run_callbacks :deliver do
+        deliver
+      end
     end
 
     def deliver
@@ -26,7 +39,7 @@ module Noticed
     end
 
     def fetch_constant(name)
-      option = config[name]
+      option = evaluate_option(name)
       option.is_a?(String) ? option.constantize : option
     end
 
@@ -38,8 +51,8 @@ module Noticed
         notification.instance_exec(&option)
 
       # Call method if symbol and matching method on Notifier
-      elsif option.is_a?(Symbol) && event.respond_to?(option)
-        event.send(option, self)
+      elsif option.is_a?(Symbol) && event.respond_to?(option, true)
+        event.send(option, notification)
 
       # Return the value
       else

data/lib/noticed/delivery_methods/action_cable.rb

@@ -1,15 +1,21 @@
 module Noticed
   module DeliveryMethods
     class ActionCable < DeliveryMethod
-      required_options :channel, :stream, :message
+      required_options :message
 
       def deliver
-        channel = fetch_constant(:channel)
-        stream = evaluate_option(:stream)
-        message = evaluate_option(:message)
+        channel.broadcast_to stream, evaluate_option(:message)
+      end
+
+      def channel
+        fetch_constant(:channel) || Noticed::NotificationChannel
+      end
 
-        channel.broadcast_to stream, message
+      def stream
+        evaluate_option(:stream) || recipient
       end
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_action_cable, Noticed::DeliveryMethods::ActionCable

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

@@ -9,3 +9,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_discord, Noticed::DeliveryMethods::Discord

data/lib/noticed/delivery_methods/email.rb

@@ -6,14 +6,22 @@ module Noticed
       def deliver
         mailer = fetch_constant(:mailer)
         email = evaluate_option(:method)
-        params = (evaluate_option(:params) || notification&.params || {}).merge(record: notification&.record)
-        args = evaluate_option(:args)
-
-        mail = mailer.with(params)
-        mail = args.present? ? mail.send(email, *args) : mail.send(email)
+        args = evaluate_option(:args) || []
+        kwargs = evaluate_option(:kwargs) || {}
+        mail = mailer.with(params).public_send(email, *args, **kwargs)
 
         (!!evaluate_option(:enqueue)) ? mail.deliver_later : mail.deliver_now
       end
+
+      def params
+        (evaluate_option(:params) || notification&.params || {}).merge(
+          notification: notification,
+          record: notification&.record,
+          recipient: notification&.recipient
+        )
+      end
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_email, Noticed::DeliveryMethods::Email

data/lib/noticed/delivery_methods/fcm.rb

@@ -14,15 +14,30 @@ module Noticed
       def send_notification(device_token)
         post_request("https://fcm.googleapis.com/v1/projects/#{credentials[:project_id]}/messages:send",
           headers: {authorization: "Bearer #{access_token}"},
-          json: notification.instance_exec(device_token, &config[:json]))
+          json: format_notification(device_token))
       rescue Noticed::ResponseUnsuccessful => exception
-        if exception.response.code == "404" && config[:invalid_token]
+        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
       end
 
+      def format_notification(device_token)
+        method = config[:json]
+        if method.is_a?(Symbol) && event.respond_to?(method, true)
+          event.send(method, device_token)
+        else
+          notification.instance_exec(device_token, &method)
+        end
+      end
+
+      def bad_token?(response)
+        response.code == "404" || response.code == "400"
+      end
+
       def credentials
         @credentials ||= begin
           value = evaluate_option(:credentials)
@@ -53,3 +68,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_fcm, Noticed::DeliveryMethods::Fcm

data/lib/noticed/delivery_methods/ios.rb

@@ -16,6 +16,7 @@ module Noticed
           connection_pool.with do |connection|
             response = connection.push(apn)
             raise "Timeout sending iOS push notification" unless response
+            connection.close
 
             if bad_token?(response) && config[:invalid_token]
               # Allow notification to cleanup invalid iOS device tokens
@@ -32,7 +33,12 @@ module Noticed
       def format_notification(apn)
         apn.topic = evaluate_option(:bundle_identifier)
 
-        if (method = config[:format])
+        method = config[:format]
+        # Call method on Notifier if defined
+        if method&.is_a?(Symbol) && event.respond_to?(method, true)
+          event.send(method, notification, apn)
+        # If Proc, evaluate it on the Notification
+        elsif method&.respond_to?(:call)
           notification.instance_exec(apn, &method)
         elsif notification.params.try(:has_key?, :message)
           apn.alert = notification.params[:message]
@@ -57,6 +63,9 @@ module Noticed
         handler = proc do |connection|
           connection.on(:error) do |exception|
             Rails.logger.info "Apnotic exception raised: #{exception}"
+            if config[:error_handler].respond_to?(:call)
+              notification.instance_exec(exception, &config[:error_handler])
+            end
           end
         end
 
@@ -70,9 +79,9 @@ module Noticed
       def connection_pool_options
         {
           auth_method: :token,
-          cert_path: StringIO.new(config.fetch(:apns_key)),
-          key_id: config.fetch(:key_id),
-          team_id: config.fetch(:team_id)
+          cert_path: StringIO.new(evaluate_option(:apns_key)),
+          key_id: evaluate_option(:key_id),
+          team_id: evaluate_option(:team_id)
         }
       end
 
@@ -82,3 +91,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_ios, Noticed::DeliveryMethods::Ios

data/lib/noticed/delivery_methods/microsoft_teams.rb

@@ -13,3 +13,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_microsoft_teams, Noticed::DeliveryMethods::MicrosoftTeams

data/lib/noticed/delivery_methods/slack.rb

@@ -6,12 +6,36 @@ module Noticed
       required_options :json
 
       def deliver
-        post_request url, headers: evaluate_option(:headers), json: evaluate_option(:json)
+        headers = evaluate_option(:headers)
+        json = evaluate_option(:json)
+        response = post_request url, headers: headers, json: json
+
+        if raise_if_not_ok? && !success?(response)
+          raise ResponseUnsuccessful.new(response, url, {headers: headers, json: json})
+        end
+
+        response
       end
 
       def url
         evaluate_option(:url) || DEFAULT_URL
       end
+
+      def raise_if_not_ok?
+        value = evaluate_option(:raise_if_not_ok)
+        value.nil? || value
+      end
+
+      def success?(response)
+        if response.content_type == "application/json"
+          JSON.parse(response.body).dig("ok")
+        else
+          # https://api.slack.com/changelog/2016-05-17-changes-to-errors-for-incoming-webhooks
+          response.is_a?(Net::HTTPSuccess)
+        end
+      end
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_slack, Noticed::DeliveryMethods::Slack

data/lib/noticed/delivery_methods/test.rb

@@ -9,3 +9,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_test, Noticed::DeliveryMethods::Test

data/lib/noticed/delivery_methods/twilio_messaging.rb

@@ -2,7 +2,13 @@ module Noticed
   module DeliveryMethods
     class TwilioMessaging < DeliveryMethod
       def deliver
-        post_request url, basic_auth: {user: account_sid, pass: auth_token}, form: json
+        post_request url, basic_auth: {user: account_sid, pass: auth_token}, form: json.stringify_keys
+      rescue Noticed::ResponseUnsuccessful => exception
+        if exception.response.code.start_with?("4") && config[:error_handler]
+          notification.instance_exec(exception.response, &config[:error_handler])
+        else
+          raise
+        end
       end
 
       def json
@@ -35,3 +41,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_twilio_messaging, Noticed::DeliveryMethods::TwilioMessaging

data/lib/noticed/delivery_methods/vonage_sms.rb

@@ -18,3 +18,5 @@ module Noticed
     end
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_vonage_sms, Noticed::DeliveryMethods::VonageSms

data/lib/noticed/delivery_methods/webhook.rb

@@ -9,9 +9,12 @@ 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
   end
 end
+
+ActiveSupport.run_load_hooks :noticed_delivery_methods_webhook, Noticed::DeliveryMethods::Webhook

data/lib/noticed/engine.rb

@@ -1,5 +1,15 @@
 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
+      end
+    end
   end
 end

data/lib/noticed/has_notifications.rb

@@ -0,0 +1,49 @@
+module Noticed
+  module HasNotifications
+    # Defines a method for the association and a before_destroy 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)
+        define_method :"notifications_as_#{param_name}" do
+          model = options.fetch(:model_name, "Noticed::Event").constantize
+          case current_adapter
+          when "postgresql", "postgis"
+            model.where("params @> ?", Noticed::Coder.dump(param_name.to_sym => self).to_json)
+          when "mysql2", "trilogy"
+            model.where("JSON_CONTAINS(params, ?)", Noticed::Coder.dump(param_name.to_sym => self).to_json)
+          when "sqlite3"
+            model.where("json_extract(params, ?) = ?", "$.#{param_name}", Noticed::Coder.dump(self).to_json)
+          else
+            # This will perform an exact match which isn't ideal
+            model.where(params: {param_name.to_sym => self})
+          end
+        end
+
+        if options.fetch(:destroy, true)
+          before_destroy do
+            send(:"notifications_as_#{param_name}").destroy_all
+          end
+        end
+      end
+    end
+
+    def current_adapter
+      if ActiveRecord::Base.respond_to?(:connection_db_config)
+        ActiveRecord::Base.connection_db_config.adapter
+      else
+        ActiveRecord::Base.connection_config[:adapter]
+      end
+    end
+  end
+end

data/lib/noticed/notification_channel.rb

@@ -0,0 +1,19 @@
+module Noticed
+  class NotificationChannel < ApplicationCable::Channel
+    def subscribed
+      stream_for current_user
+    end
+
+    def unsubscribed
+      stop_all_streams
+    end
+
+    def mark_as_seen(data)
+      current_user.notifications.where(id: data["ids"]).mark_as_seen
+    end
+
+    def mark_as_read(data)
+      current_user.notifications.where(id: data["ids"]).mark_as_read
+    end
+  end
+end

data/lib/noticed/version.rb

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

data/lib/noticed.rb

@@ -1,46 +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 :RequiredOptions, "noticed/required_options"
-  autoload :Translation, "noticed/translation"
-
-  module BulkDeliveryMethods
-    autoload :Discord, "noticed/bulk_delivery_methods/discord"
-    autoload :Slack, "noticed/bulk_delivery_methods/slack"
-    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
 
-  class ValidationError < StandardError
-  end
+  mattr_accessor :parent_class
+  @@parent_class = "Noticed::ApplicationJob"
+
+  class ValidationError < StandardError; end
 
   class ResponseUnsuccessful < StandardError
     attr_reader :response