noticed 1.6.3 → 2.0.0

data/lib/noticed/delivery_methods/ios.rb

@@ -2,26 +2,24 @@ require "apnotic"
 
 module Noticed
   module DeliveryMethods
-    class Ios < Base
-      cattr_accessor :connection_pool
+    class Ios < DeliveryMethod
+      cattr_accessor :development_connection_pool, :production_connection_pool
+
+      required_options :bundle_identifier, :key_id, :team_id, :apns_key, :device_tokens
 
       def deliver
-        raise ArgumentError, "bundle_identifier is missing" if bundle_identifier.blank?
-        raise ArgumentError, "key_id is missing" if key_id.blank?
-        raise ArgumentError, "team_id is missing" if team_id.blank?
-        raise ArgumentError, "Could not find APN cert at '#{cert_path}'" unless valid_cert_path?
+        evaluate_option(:device_tokens).each do |device_token|
+          apn = Apnotic::Notification.new(device_token)
+          format_notification(apn)
 
-        device_tokens.each do |device_token|
+          connection_pool = (!!evaluate_option(:development)) ? development_pool : production_pool
           connection_pool.with do |connection|
-            apn = Apnotic::Notification.new(device_token)
-            format_notification(apn)
-
             response = connection.push(apn)
             raise "Timeout sending iOS push notification" unless response
 
-            if bad_token?(response)
+            if bad_token?(response) && config[:invalid_token]
               # Allow notification to cleanup invalid iOS device tokens
-              cleanup_invalid_token(device_token)
+              notification.instance_exec(device_token, &config[:invalid_token])
             elsif !response.ok?
               raise "Request failed #{response.body}"
             end
@@ -32,53 +30,37 @@ module Noticed
       private
 
       def format_notification(apn)
-        apn.topic = bundle_identifier
+        apn.topic = evaluate_option(:bundle_identifier)
 
-        if (method = options[:format])
-          notification.send(method, apn)
-        elsif params[:message].present?
-          apn.alert = params[:message]
+        if (method = config[:format])
+          notification.instance_exec(apn, &method)
+        elsif notification.params.try(:has_key?, :message)
+          apn.alert = notification.params[:message]
         else
           raise ArgumentError, "No message for iOS delivery. Either include message in params or add the 'format' option in 'deliver_by :ios'."
         end
       end
 
-      def device_tokens
-        if notification.respond_to?(:ios_device_tokens)
-          Array.wrap(notification.ios_device_tokens(recipient))
-        else
-          raise NoMethodError, <<~MESSAGE
-            You must implement `ios_device_tokens` to send iOS notifications
-
-            # This must return an Array of iOS device tokens
-            def ios_device_tokens(recipient)
-              recipient.ios_device_tokens.pluck(:token)
-            end
-          MESSAGE
-        end
-      end
-
       def bad_token?(response)
         response.status == "410" || (response.status == "400" && response.body["reason"] == "BadDeviceToken")
       end
 
-      def cleanup_invalid_token(token)
-        return unless notification.respond_to?(:cleanup_device_token)
-        notification.send(:cleanup_device_token, token: token, platform: "iOS")
+      def development_pool
+        self.class.development_connection_pool ||= new_connection_pool(development: true)
       end
 
-      def connection_pool
-        self.class.connection_pool ||= new_connection_pool
+      def production_pool
+        self.class.production_connection_pool ||= new_connection_pool(development: false)
       end
 
-      def new_connection_pool
+      def new_connection_pool(development:)
         handler = proc do |connection|
           connection.on(:error) do |exception|
             Rails.logger.info "Apnotic exception raised: #{exception}"
           end
         end
 
-        if development?
+        if development
           Apnotic::ConnectionPool.development(connection_pool_options, pool_options, &handler)
         else
           Apnotic::ConnectionPool.new(connection_pool_options, pool_options, &handler)
@@ -88,83 +70,14 @@ module Noticed
       def connection_pool_options
         {
           auth_method: :token,
-          cert_path: cert_path,
-          key_id: key_id,
-          team_id: team_id
+          cert_path: StringIO.new(config.fetch(:apns_key)),
+          key_id: config.fetch(:key_id),
+          team_id: config.fetch(:team_id)
         }
       end
 
-      def bundle_identifier
-        option = options[:bundle_identifier]
-        case option
-        when String
-          option
-        when Symbol
-          notification.send(option)
-        else
-          Rails.application.credentials.dig(:ios, :bundle_identifier)
-        end
-      end
-
-      def cert_path
-        option = options[:cert_path]
-        case option
-        when String
-          option
-        when Symbol
-          notification.send(option)
-        else
-          Rails.root.join("config/certs/ios/apns.p8")
-        end
-      end
-
-      def key_id
-        option = options[:key_id]
-        case option
-        when String
-          option
-        when Symbol
-          notification.send(option)
-        else
-          Rails.application.credentials.dig(:ios, :key_id)
-        end
-      end
-
-      def team_id
-        option = options[:team_id]
-        case option
-        when String
-          option
-        when Symbol
-          notification.send(option)
-        else
-          Rails.application.credentials.dig(:ios, :team_id)
-        end
-      end
-
-      def development?
-        option = options[:development]
-        case option
-        when Symbol
-          !!notification.send(option)
-        else
-          !!option
-        end
-      end
-
-      def valid_cert_path?
-        case cert_path
-        when File, StringIO
-          cert_path.size > 0
-        else
-          File.exist?(cert_path)
-        end
-      end
-
       def pool_options
-        {
-          size: options.fetch(:pool_size, 5)
-        }
+        {size: evaluate_option(:pool_size) || 5}
       end
     end
   end

data/lib/noticed/delivery_methods/microsoft_teams.rb

@@ -1,31 +1,14 @@
 module Noticed
   module DeliveryMethods
-    class MicrosoftTeams < Base
-      def deliver
-        post(url, json: format)
-      end
+    class MicrosoftTeams < DeliveryMethod
+      required_options :json
 
-      private
-
-      def format
-        if (method = options[:format])
-          notification.send(method)
-        else
-          {
-            title: notification.params[:title],
-            text: notification.params[:text],
-            sections: notification.params[:sections],
-            potentialAction: notification.params[:notification_action]
-          }
-        end
+      def deliver
+        post_request url, headers: evaluate_option(:headers), json: evaluate_option(:json)
       end
 
       def url
-        if (method = options[:url])
-          notification.send(method)
-        else
-          Rails.application.credentials.microsoft_teams[:notification_url]
-        end
+        evaluate_option(:url) || Rails.application.credentials.dig(:microsoft_teams, :notification_url)
       end
     end
   end

data/lib/noticed/delivery_methods/slack.rb

@@ -1,26 +1,16 @@
 module Noticed
   module DeliveryMethods
-    class Slack < Base
-      def deliver
-        post(url, json: format)
-      end
+    class Slack < DeliveryMethod
+      DEFAULT_URL = "https://slack.com/api/chat.postMessage"
 
-      private
+      required_options :json
 
-      def format
-        if (method = options[:format])
-          notification.send(method)
-        else
-          notification.params
-        end
+      def deliver
+        post_request url, headers: evaluate_option(:headers), json: evaluate_option(:json)
       end
 
       def url
-        if (method = options[:url])
-          notification.send(method)
-        else
-          Rails.application.credentials.slack[:notification_url]
-        end
+        evaluate_option(:url) || DEFAULT_URL
       end
     end
   end

data/lib/noticed/delivery_methods/test.rb

@@ -1,20 +1,10 @@
 module Noticed
   module DeliveryMethods
-    class Test < Base
+    class Test < DeliveryMethod
       class_attribute :delivered, default: []
-      class_attribute :callbacks, default: []
-
-      after_deliver do
-        self.class.callbacks << :after
-      end
-
-      def self.clear!
-        delivered.clear
-        callbacks.clear
-      end
 
       def deliver
-        self.class.delivered << notification
+        delivered << notification
       end
     end
   end

data/lib/noticed/delivery_methods/twilio_messaging.rb

@@ -0,0 +1,37 @@
+module Noticed
+  module DeliveryMethods
+    class TwilioMessaging < DeliveryMethod
+      def deliver
+        post_request url, basic_auth: {user: account_sid, pass: auth_token}, form: json
+      end
+
+      def json
+        evaluate_option(:json) || {
+          From: phone_number,
+          To: recipient.phone_number,
+          Body: params.fetch(:message)
+        }
+      end
+
+      def url
+        evaluate_option(:url) || "https://api.twilio.com/2010-04-01/Accounts/#{account_sid}/Messages.json"
+      end
+
+      def account_sid
+        evaluate_option(:account_sid) || credentials.fetch(:account_sid)
+      end
+
+      def auth_token
+        evaluate_option(:auth_token) || credentials.fetch(:auth_token)
+      end
+
+      def phone_number
+        evaluate_option(:phone_number) || credentials.fetch(:phone_number)
+      end
+
+      def credentials
+        evaluate_option(:credentials) || Rails.application.credentials.twilio
+      end
+    end
+  end
+end

data/lib/noticed/delivery_methods/vonage_sms.rb

@@ -0,0 +1,20 @@
+module Noticed
+  module DeliveryMethods
+    class VonageSms < DeliveryMethod
+      DEFAULT_URL = "https://rest.nexmo.com/sms/json"
+
+      required_options :json
+
+      def deliver
+        headers = evaluate_option(:headers)
+        json = evaluate_option(:json)
+        response = post_request url, headers: headers, json: json
+        raise ResponseUnsuccessful.new(response, url, headers: headers, json: json) if JSON.parse(response.body).dig("messages", 0, "status") != "0"
+      end
+
+      def url
+        evaluate_option(:url) || DEFAULT_URL
+      end
+    end
+  end
+end

data/lib/noticed/delivery_methods/webhook.rb

@@ -0,0 +1,17 @@
+module Noticed
+  module DeliveryMethods
+    class Webhook < DeliveryMethod
+      required_options :url
+
+      def deliver
+        post_request(
+          evaluate_option(:url),
+          basic_auth: evaluate_option(:basic_auth),
+          headers: evaluate_option(:headers),
+          json: evaluate_option(:json),
+          form: evaluate_option(:form)
+        )
+      end
+    end
+  end
+end

data/lib/noticed/engine.rb

@@ -1,13 +1,5 @@
 module Noticed
   class Engine < ::Rails::Engine
-    initializer "noticed.has_notifications" do
-      ActiveSupport.on_load(:active_record) do
-        include Noticed::HasNotifications
-      end
-    end
-
-    initializer "noticed.rails_5_2_support" do
-      require "rails_6_polyfills/base" if Rails::VERSION::MAJOR < 6
-    end
+    isolate_namespace Noticed
   end
 end

data/lib/noticed/required_options.rb

@@ -0,0 +1,21 @@
+module Noticed
+  module RequiredOptions
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :required_option_names, instance_writer: false, default: []
+    end
+
+    class_methods do
+      def inherited(base)
+        base.required_option_names = required_option_names.dup
+        super
+      end
+
+      def required_options(*names)
+        required_option_names.concat names
+      end
+      alias_method :required_option, :required_options
+    end
+  end
+end

data/lib/noticed/translation.rb

@@ -4,7 +4,7 @@ module Noticed
 
     # Returns the +i18n_scope+ for the class. Overwrite if you want custom lookup.
     def i18n_scope
-      :notifications
+      :notifiers
     end
 
     def class_scope
@@ -12,13 +12,17 @@ module Noticed
     end
 
     def translate(key, **options)
-      I18n.translate(scope_translation_key(key), **options)
+      if defined?(::ActiveSupport::HtmlSafeTranslation)
+        ActiveSupport::HtmlSafeTranslation.translate scope_translation_key(key), **options
+      else
+        I18n.translate scope_translation_key(key), **options
+      end
     end
     alias_method :t, :translate
 
     def scope_translation_key(key)
       if key.to_s.start_with?(".")
-        "#{i18n_scope}.#{class_scope}#{key}"
+        [i18n_scope, class_scope].compact.join(".") + key
       else
         key
       end

data/lib/noticed/version.rb

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

data/lib/noticed.rb

@@ -1,41 +1,56 @@
-require "active_job/arguments"
-require "http"
+require "noticed/version"
 require "noticed/engine"
 
 module Noticed
-  autoload :Base, "noticed/base"
+  include ActiveSupport::Deprecation::DeprecatedConstantAccessor
+
+  def self.deprecator # :nodoc:
+    @deprecator ||= ActiveSupport::Deprecation.new
+  end
+
+  deprecate_constant :Base, "Noticed::Event", deprecator: deprecator
+
+  autoload :ApiClient, "noticed/api_client"
+  autoload :BulkDeliveryMethod, "noticed/bulk_delivery_method"
   autoload :Coder, "noticed/coder"
-  autoload :HasNotifications, "noticed/has_notifications"
-  autoload :Model, "noticed/model"
-  autoload :TextCoder, "noticed/text_coder"
+  autoload :DeliveryMethod, "noticed/delivery_method"
+  autoload :RequiredOptions, "noticed/required_options"
   autoload :Translation, "noticed/translation"
-  autoload :NotificationChannel, "noticed/notification_channel"
+
+  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 :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 :TwilioMessaging, "noticed/delivery_methods/twilio_messaging"
+    autoload :VonageSms, "noticed/delivery_methods/vonage_sms"
+    autoload :Webhook, "noticed/delivery_methods/webhook"
   end
 
-  mattr_accessor :parent_class
-  @@parent_class = "ApplicationJob"
-
   class ValidationError < StandardError
   end
 
   class ResponseUnsuccessful < StandardError
     attr_reader :response
 
-    def initialize(response)
+    def initialize(response, url, args)
       @response = response
+      @url = url
+      @args = args
+
+      super("POST request to #{url} returned #{response.code} response:\n#{response.body.inspect}")
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.6.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2024-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -16,28 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
+        version: 6.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.0
-- !ruby/object:Gem::Dependency
-  name: http
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.0.0
+        version: 6.1.0
 description: Database, browser, realtime ActionCable, Email, SMS, Slack notifications,
   and more for Rails apps
 email:
@@ -49,42 +35,45 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/jobs/noticed/application_job.rb
+- app/jobs/noticed/event_job.rb
+- app/models/concerns/noticed/deliverable.rb
+- app/models/concerns/noticed/notification_methods.rb
+- app/models/concerns/noticed/readable.rb
+- app/models/noticed/application_record.rb
+- app/models/noticed/deliverable/deliver_by.rb
+- app/models/noticed/event.rb
+- app/models/noticed/notification.rb
+- db/migrate/20231215190233_create_noticed_tables.rb
 - lib/generators/noticed/delivery_method_generator.rb
-- lib/generators/noticed/model/base_generator.rb
-- lib/generators/noticed/model/mysql_generator.rb
-- lib/generators/noticed/model/postgresql_generator.rb
-- lib/generators/noticed/model/sqlite3_generator.rb
-- lib/generators/noticed/model_generator.rb
-- lib/generators/noticed/notification_generator.rb
+- lib/generators/noticed/install_generator.rb
+- lib/generators/noticed/notifier_generator.rb
 - lib/generators/noticed/templates/README
 - lib/generators/noticed/templates/delivery_method.rb.tt
-- lib/generators/noticed/templates/notification.rb.tt
+- lib/generators/noticed/templates/notifier.rb.tt
 - lib/noticed.rb
-- lib/noticed/base.rb
+- lib/noticed/api_client.rb
+- lib/noticed/bulk_delivery_method.rb
+- lib/noticed/bulk_delivery_methods/discord.rb
+- lib/noticed/bulk_delivery_methods/slack.rb
+- lib/noticed/bulk_delivery_methods/webhook.rb
 - lib/noticed/coder.rb
+- lib/noticed/delivery_method.rb
 - lib/noticed/delivery_methods/action_cable.rb
-- lib/noticed/delivery_methods/base.rb
-- lib/noticed/delivery_methods/database.rb
+- lib/noticed/delivery_methods/discord.rb
 - lib/noticed/delivery_methods/email.rb
 - lib/noticed/delivery_methods/fcm.rb
 - lib/noticed/delivery_methods/ios.rb
 - lib/noticed/delivery_methods/microsoft_teams.rb
 - lib/noticed/delivery_methods/slack.rb
 - lib/noticed/delivery_methods/test.rb
-- lib/noticed/delivery_methods/twilio.rb
-- lib/noticed/delivery_methods/vonage.rb
+- lib/noticed/delivery_methods/twilio_messaging.rb
+- lib/noticed/delivery_methods/vonage_sms.rb
+- lib/noticed/delivery_methods/webhook.rb
 - lib/noticed/engine.rb
-- lib/noticed/has_notifications.rb
-- lib/noticed/model.rb
-- lib/noticed/notification_channel.rb
-- lib/noticed/text_coder.rb
+- lib/noticed/required_options.rb
 - lib/noticed/translation.rb
 - lib/noticed/version.rb
-- lib/rails_6_polyfills/actioncable/test_adapter.rb
-- lib/rails_6_polyfills/actioncable/test_helper.rb
-- lib/rails_6_polyfills/activejob/serializers.rb
-- lib/rails_6_polyfills/base.rb
-- lib/tasks/noticed_tasks.rake
 homepage: https://github.com/excid3/noticed
 licenses:
 - MIT
@@ -104,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.12
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Notifications for Ruby on Rails applications

data/lib/generators/noticed/model/base_generator.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-
-module Noticed
-  module Generators
-    module Model
-      class BaseGenerator < Rails::Generators::NamedBase
-        include Rails::Generators::ResourceHelpers
-
-        source_root File.expand_path("../templates", __FILE__)
-
-        desc "Generates a Notification model for storing notifications."
-
-        argument :name, type: :string, default: "Notification", banner: "Notification"
-        argument :attributes, type: :array, default: [], banner: "field:type field:type"
-
-        def generate_notification
-          generate :model, name, "recipient:references{polymorphic}", "type", "params:#{json_column_type}", "read_at:datetime:index", *attributes
-        end
-
-        def add_noticed_model
-          inject_into_class model_path, class_name, "  include Noticed::Model\n"
-        end
-
-        def add_not_nullable
-          migration_path = Dir.glob(Rails.root.join("db/migrate/*")).max_by { |f| File.mtime(f) }
-
-          # Force is required because null: false already exists in the file and Thor isn't smart enough to tell the difference
-          insert_into_file migration_path, after: "t.string :type", force: true do
-            ", null: false"
-          end
-        end
-
-        def done
-          readme "README" if behavior == :invoke
-        end
-
-        private
-
-        def model_path
-          @model_path ||= File.join("app", "models", "#{file_path}.rb")
-        end
-      end
-    end
-  end
-end