noticed 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a68b0a9d002890caff4346a36eac937e9efe9c759fa656586d7c23984f974593
-  data.tar.gz: 22f5537095dcb8fb2f0a09f558c7b277d9840611bc29fc263544cc6344edc7f8
+  metadata.gz: b8ce628657c8b6011616fbcf075869fe902ad33f19569acadf88e52aef89fb79
+  data.tar.gz: f92330969818566ce0d4080341f19631be41fd5bb4c45f94dfb3ab5714c3c663
 SHA512:
-  metadata.gz: a0a1fc6372bd1eb3f128eaecc8b05bbd37ee6a540f30ef05fafcd8b593dc01e00c53d4ecb135c93184c6d264940707b4513f0b33eeca4d57c52ee87b80870ca8
-  data.tar.gz: ee98827a78024e374126ad2f0f5fb9210320808fb244c4171ab543d27c2c875d6a05ca6045b4b3b2dab2fff17c9ec9ae514d3a7f98105d5b74642d0c6150bcec
+  metadata.gz: 8945414df8ed4cdf89bbf654171e686b8c655ae91542177207f134052d0d09794df146192694775f9e755a3b0a65fafbe180130d41590f186b53837c9f114961
+  data.tar.gz: c78d5048f9fb95b6982dc44edd7fa03d8f2cf8cf093884d059668fb2aed3258d9f2992b84b2843ac61e39d3e3ce42818fc48c583520d2097cb89bf8260b1aa30

data/README.md

@@ -42,6 +42,10 @@ class CommentNotification < Noticed::Base
   def email_notifications?
     !!recipient.preferences[:email]
   end
+  
+  after_deliver do
+    # Anything you want
+  end
 end
 ```
 
@@ -66,6 +70,35 @@ Each delivery method is able to transfrom this metadata that's best for the form
 * `if: :method_name`  - Calls `method_name`and cancels delivery method if `false` is returned
 * `unless: :method_name`  - Calls `method_name`and cancels delivery method if `true` is returned
 
+**Callbacks**
+
+Like ActiveRecord, notifications have several different types of callbacks.
+
+```ruby
+class CommentNotification < Noticed::Base
+  deliver_by :database
+  deliver_by :email
+  
+  # Callbacks for the entire delivery
+  before_deliver :whatever
+  around_deliver :whatever
+  after_deliver :whatever 
+
+  # Callbacks for each delivery method
+  before_database :whatever
+  around_database :whatever
+  after_database :whatever
+
+  before_email :whatever
+  around_email :whatever
+  after_email :whatever
+end
+```
+
+When using `deliver_later` callbacks will be run around queuing the delivery method jobs (not inside the jobs as they actually execute).
+
+Defining custom delivery methods allows you to add callbacks that run inside the background job as each individual delivery is executed. See the Custom Delivery Methods section for more information.
+
 ## Delivery Methods
 
 The delivery methods are designed to be overriden so that you can customi1ze the notification for each medium.
@@ -86,7 +119,7 @@ Sends an email notification. Emails will always be sent with `deliver_later`
 
 `deliver_by :email, mailer: "UserMailer"`
 
-**Options**
+##### Options
 
 * `mailer` - **Required**
 
@@ -102,7 +135,7 @@ Sends a notification to the browser via websockets (ActionCable channel by defau
 
 `deliver_by :action_cable`
 
-**Options**
+##### Options
 
 * `format: :format_for_action_cable` - *Optional*
 
@@ -120,7 +153,7 @@ Sends a Slack notification via webhook.
 
 `deliver_by :slack`
 
-**Options**
+##### Options
 
 * `format: :format_for_slack` - *Optional*
 
@@ -138,7 +171,7 @@ Sends an SMS notification via Twilio.
 
 `deliver_by :twilio`
 
-**Options**
+##### Options
 
 * `credentials: :get_twilio_credentials` - *Optional*
 
@@ -172,7 +205,7 @@ Sends an SMS notification vai Vonage / Nexmo.
 
 `deliver_by :vonage`
 
-**Options:**
+##### Options
 
 * `credentials: :get_credentials` - *Optional*
 
@@ -236,6 +269,18 @@ Delivery methods have access to the following methods and attributes:
 * `recipient` - The object who should receive the notification. This is typically a User, Account, or other ActiveRecord model.
 * `params` - The params passed into the notification. This is details about the event that happened. For example, a user commenting on a post would have params of `{ user: User.first }`
 
+#### Callbacks
+
+Callbacks for delivery methods wrap the *actual* delivery of the notification. You can use `before_deliver`, `around_deliver` and `after_deliver` in your custom delivery methods.
+
+```ruby
+class DiscordNotification < Noticed::DeliveryMethods::Base
+  after_deliver do
+    # Do whatever you want
+  end
+end
+```
+
 #### Limitations
 
 Rails 6.1+ can serialize Class and Module objects as arguments to ActiveJob. The following syntax should work for Rails 6.1+:

data/lib/noticed/base.rb

@@ -1,5 +1,8 @@
 module Noticed
   class Base
+    extend ActiveModel::Callbacks
+    define_model_callbacks :deliver
+
     class_attribute :delivery_methods, instance_writer: false, default: []
     class_attribute :param_names, instance_writer: false, default: []
 
@@ -7,10 +10,8 @@ module Noticed
 
     class << self
       def deliver_by(name, options = {})
-        delivery_methods.push(
-          name: name,
-          options: options
-        )
+        delivery_methods.push(name: name, options: options)
+        define_model_callbacks(name)
       end
 
       # Copy delivery methods from parent
@@ -51,16 +52,18 @@ module Noticed
 
     # Runs all delivery methods for a notification
     def run_delivery(recipient, enqueue: true)
-      delivery_methods = self.class.delivery_methods.dup
+      run_callbacks :deliver do
+        delivery_methods = self.class.delivery_methods.dup
 
-      # 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)
-        @record = run_delivery_method(delivery_method, recipient: recipient, enqueue: false)
-      end
+        # 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)
+          @record = run_delivery_method(delivery_method, recipient: recipient, enqueue: false)
+        end
 
-      delivery_methods.each do |delivery_method|
-        run_delivery_method(delivery_method, recipient: recipient, enqueue: enqueue)
+        delivery_methods.each do |delivery_method|
+          run_delivery_method(delivery_method, recipient: recipient, enqueue: enqueue)
+        end
       end
     end
 
@@ -77,15 +80,15 @@ module Noticed
         record: record
       }
 
-      klass = get_class(delivery_method[:name], delivery_method[:options])
-      enqueue ? klass.perform_later(args) : klass.perform_now(args)
+      run_callbacks delivery_method[:name] do
+        klass = get_class(delivery_method[:name], delivery_method[:options])
+        enqueue ? klass.perform_later(args) : klass.perform_now(args)
+      end
     end
 
     # Retrieves the correct class for a delivery method
     def get_class(name, options)
-      if name.is_a? Class
-        name
-      elsif options[:class]
+      if options[:class]
         options[:class].constantize
       else
         "Noticed::DeliveryMethods::#{name.to_s.classify}".constantize

data/lib/noticed/delivery_methods/base.rb

@@ -1,8 +1,10 @@
 module Noticed
   module DeliveryMethods
     class Base < Noticed.parent_class.constantize
+      extend ActiveModel::Callbacks
+      define_model_callbacks :deliver
+
       attr_reader :notification, :options, :recipient
-      delegate :params, to: :notification
 
       def perform(notification_class:, options:, params:, recipient:, record:)
         @notification = notification_class.constantize.new(params)
@@ -12,7 +14,9 @@ module Noticed
         # Keep track of the database record for rendering
         @notification.record = record
 
-        deliver
+        run_callbacks :deliver do
+          deliver
+        end
       end
 
       def deliver

data/lib/noticed/delivery_methods/database.rb

@@ -14,7 +14,7 @@ module Noticed
         else
           {
             type: notification.class.name,
-            params: params
+            params: notification.params
           }
         end
       end

data/lib/noticed/delivery_methods/test.rb

@@ -2,9 +2,15 @@ module Noticed
   module DeliveryMethods
     class Test < Base
       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

data/lib/noticed/version.rb

@@ -1,3 +1,3 @@
 module Noticed
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: noticed
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Chris Oliver