noticed 1.6.3 → 2.0.1

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.6.3"
+  VERSION = "2.0.1"
 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.1
 platform: ruby
 authors:
 - Chris Oliver
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2024-01-17 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

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-require_relative "base_generator"
-
-module Noticed
-  module Generators
-    module Model
-      class MysqlGenerator < BaseGenerator
-        private
-
-        def json_column_type
-          "json"
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-require_relative "base_generator"
-
-module Noticed
-  module Generators
-    module Model
-      class PostgresqlGenerator < BaseGenerator
-        private
-
-        def json_column_type
-          "jsonb"
-        end
-      end
-    end
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-require_relative "base_generator"
-
-module Noticed
-  module Generators
-    module Model
-      class Sqlite3Generator < BaseGenerator
-        private
-
-        def json_column_type
-          "json"
-        end
-      end
-    end
-  end
-end

data/lib/generators/noticed/model_generator.rb

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/generators/named_base"
-
-module Noticed
-  module Generators
-    class ModelGenerator < 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_column, "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
-
-      def params_column
-        case current_adapter
-        when "postgresql", "postgis"
-          "params:jsonb"
-        else
-          # MySQL and SQLite both support json
-          "params:json"
-        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
-end

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

@@ -1,27 +0,0 @@
-# To deliver this notification:
-#
-# <%= class_name %>.with(post: @post).deliver_later(current_user)
-# <%= class_name %>.with(post: @post).deliver(current_user)
-
-class <%= class_name %> < Noticed::Base
-  # Add your delivery methods
-  #
-  # deliver_by :database
-  # deliver_by :email, mailer: "UserMailer"
-  # deliver_by :slack
-  # deliver_by :custom, class: "MyDeliveryMethod"
-
-  # Add required params
-  #
-  # param :post
-
-  # Define helper methods to make rendering easier.
-  #
-  # def message
-  #   t(".message")
-  # end
-  #
-  # def url
-  #   post_path(params[:post])
-  # end
-end

data/lib/noticed/base.rb

@@ -1,160 +0,0 @@
-module Noticed
-  class Base
-    include Translation
-    include Rails.application.routes.url_helpers
-
-    extend ActiveModel::Callbacks
-    define_model_callbacks :deliver
-
-    class_attribute :delivery_methods, instance_writer: false, default: []
-    class_attribute :param_names, instance_writer: false, default: []
-
-    # Gives notifications access to the record and recipient during delivery
-    attr_accessor :record, :recipient
-
-    delegate :read?, :unread?, to: :record
-
-    class << self
-      def deliver_by(name, options = {})
-        delivery_methods.push(name: name, options: options)
-        define_model_callbacks(name)
-      end
-
-      # Copy delivery methods from parent
-      def inherited(base) # :nodoc:
-        base.delivery_methods = delivery_methods.dup
-        base.param_names = param_names.dup
-        super
-      end
-
-      def with(params)
-        new(params)
-      end
-
-      # Shortcut for delivering without params
-      def deliver(recipients)
-        new.deliver(recipients)
-      end
-
-      # Shortcut for delivering later without params
-      def deliver_later(recipients)
-        new.deliver_later(recipients)
-      end
-
-      def params(*names)
-        param_names.concat Array.wrap(names)
-      end
-      alias_method :param, :params
-    end
-
-    def initialize(params = {})
-      @params = params
-    end
-
-    def deliver(recipients)
-      validate!
-
-      run_callbacks :deliver do
-        Array.wrap(recipients).uniq.each do |recipient|
-          run_delivery(recipient, enqueue: false)
-        end
-      end
-    end
-
-    def deliver_later(recipients)
-      validate!
-
-      run_callbacks :deliver do
-        Array.wrap(recipients).uniq.each do |recipient|
-          run_delivery(recipient, enqueue: true)
-        end
-      end
-    end
-
-    def params
-      @params || {}
-    end
-
-    def clear_recipient
-      self.recipient = nil
-    end
-
-    private
-
-    # Runs all delivery methods for a notification
-    def run_delivery(recipient, enqueue: true)
-      delivery_methods = self.class.delivery_methods.dup
-
-      self.recipient = recipient
-
-      # Run database delivery inline first if it exists so other methods have access to the record
-      if (index = delivery_methods.find_index { |m| m[:name] == :database })
-        delivery_method = delivery_methods.delete_at(index)
-        self.record = run_delivery_method(delivery_method, recipient: recipient, enqueue: false, record: nil)
-      end
-
-      delivery_methods.each do |delivery_method|
-        run_delivery_method(delivery_method, recipient: recipient, enqueue: enqueue, record: record)
-      end
-    end
-
-    # Actually runs an individual delivery
-    def run_delivery_method(delivery_method, recipient:, enqueue:, record:)
-      args = {
-        notification_class: self.class.name,
-        options: delivery_method[:options],
-        params: params,
-        recipient: recipient,
-        record: record
-      }
-
-      run_callbacks delivery_method[:name] do
-        method = delivery_method_for(delivery_method[:name], delivery_method[:options])
-
-        # If the queue is `nil`, ActiveJob will use a default queue name.
-        queue = delivery_method.dig(:options, :queue)
-
-        # Always perfrom later if a delay is present
-        if (delay = delivery_method.dig(:options, :delay))
-          # Dynamic delays with metho calls or
-          delay = send(delay) if delay.is_a? Symbol
-
-          method.set(wait: delay, queue: queue).perform_later(args)
-        elsif enqueue
-          method.set(queue: queue).perform_later(args)
-        else
-          method.perform_now(args)
-        end
-      end
-    end
-
-    def delivery_method_for(name, options)
-      if options[:class]
-        options[:class].constantize
-      else
-        "Noticed::DeliveryMethods::#{name.to_s.camelize}".constantize
-      end
-    end
-
-    def validate!
-      validate_params_present!
-      validate_options_of_delivery_methods!
-    end
-
-    # Validates that all params are present
-    def validate_params_present!
-      self.class.param_names.each do |param_name|
-        if params[param_name].nil?
-          raise ValidationError, "#{param_name} is missing."
-        end
-      end
-    end
-
-    def validate_options_of_delivery_methods!
-      delivery_methods.each do |delivery_method|
-        method = delivery_method_for(delivery_method[:name], delivery_method[:options])
-        method.validate!(delivery_method[:options])
-      end
-    end
-  end
-end

data/lib/noticed/delivery_methods/base.rb

@@ -1,95 +0,0 @@
-module Noticed
-  module DeliveryMethods
-    class Base < Noticed.parent_class.constantize
-      extend ActiveModel::Callbacks
-      define_model_callbacks :deliver
-
-      class_attribute :option_names, instance_writer: false, default: []
-
-      attr_reader :notification, :options, :params, :recipient, :record, :logger
-
-      class << self
-        # Copy option names from parent
-        def inherited(base) # :nodoc:
-          base.option_names = option_names.dup
-          super
-        end
-
-        def options(*names)
-          option_names.concat Array.wrap(names)
-        end
-        alias_method :option, :options
-
-        def validate!(delivery_method_options)
-          option_names.each do |option_name|
-            unless delivery_method_options.key? option_name
-              raise ValidationError, "option `#{option_name}` must be set for #{name}"
-            end
-          end
-        end
-      end
-
-      def assign_args(args)
-        @notification = args.fetch(:notification_class).constantize.new(args[:params])
-        @options = args[:options] || {}
-        @params = args[:params]
-        @recipient = args[:recipient]
-        @record = args[:record]
-
-        # Set the default logger
-        @logger = @options.fetch(:logger, Rails.logger)
-
-        # Make notification aware of database record and recipient during delivery
-        @notification.record = args[:record]
-        @notification.recipient = args[:recipient]
-        self
-      end
-
-      def perform(args)
-        assign_args(args)
-
-        return if (condition = @options[:if]) && !@notification.send(condition)
-        return if (condition = @options[:unless]) && @notification.send(condition)
-
-        run_callbacks :deliver do
-          deliver
-        end
-      end
-
-      def deliver
-        raise NotImplementedError, "Delivery methods must implement a deliver method"
-      end
-
-      private
-
-      # Helper method for making POST requests from delivery methods
-      #
-      # Usage:
-      #   post("http://example.com", basic_auth: {user:, pass:}, headers: {}, json: {}, form: {})
-      #
-      def post(url, args = {})
-        basic_auth = args.delete(:basic_auth)
-        headers = args.delete(:headers)
-
-        request = HTTP
-        request = request.basic_auth(user: basic_auth[:user], pass: basic_auth[:pass]) if basic_auth
-        request = request.headers(headers) if headers
-
-        response = request.post(url, args)
-
-        if options[:debug]
-          logger.debug("POST #{url}")
-          logger.debug("Response: #{response.code}: #{response}")
-        end
-
-        if !options[:ignore_failure] && !response.status.success?
-          puts response.status
-          puts response.body
-          raise ResponseUnsuccessful.new(response)
-        end
-
-        response
-      end
-    end
-  end
-end

data/lib/noticed/delivery_methods/database.rb

@@ -1,34 +0,0 @@
-module Noticed
-  module DeliveryMethods
-    class Database < Base
-      # Must return the database record
-      def deliver
-        recipient.send(association_name).create!(attributes)
-      end
-
-      def self.validate!(options)
-        super
-
-        # Must be executed right away so the other deliveries can access the db record
-        raise ArgumentError, "database delivery cannot be delayed" if options.key?(:delay)
-      end
-
-      private
-
-      def association_name
-        options[:association] || :notifications
-      end
-
-      def attributes
-        if (method = options[:format])
-          notification.send(method)
-        else
-          {
-            type: notification.class.name,
-            params: notification.params
-          }
-        end
-      end
-    end
-  end
-end