active_delivery 0.4.4 → 1.0.0.rc2

data/README.md

@@ -4,7 +4,9 @@
 
 # Active Delivery
 
-Framework providing an entry point (single _interface_) for all types of notifications: mailers, push notifications, whatever you want.
+Active Delivery is a framework providing an entry point (single _interface_ or _abstraction_) for all types of notifications: mailers, push notifications, whatever you want.
+
+Since v1.0, Active Delivery is bundled with [Abstract Notifier](https://github.com/palkan/abstract_notifier). See the docs on how to create custom notifiers [below](#abstract-notifier).
 
 📖 Read the introduction post: ["Crafting user notifications in Rails with Active Delivery"](https://evilmartians.com/chronicles/crafting-user-notifications-in-rails-with-active-delivery)
 
@@ -13,7 +15,8 @@ Framework providing an entry point (single _interface_) for all types of notific
 
 Requirements:
 
-- Ruby ~> 2.5
+- Ruby ~> 2.7
+- Rails 6+ (optional).
 
 **NOTE**: although most of the examples in this readme are Rails-specific, this gem could be used without Rails/ActiveSupport.
 
@@ -21,7 +24,7 @@ Requirements:
 
 We need a way to handle different notifications _channel_ (mail, push) in one place.
 
-From the business-logic point of view we want to _notify_ a user, hence we need a _separate abstraction layer_ as an entry point to different types of notifications.
+From the business-logic point of view, we want to _notify_ a user, hence we need a _separate abstraction layer_ as an entry point to different types of notifications.
 
 ## The solution
 
@@ -31,18 +34,18 @@ In the simplest case when we have only mailers Active Delivery is just a wrapper
 
 Motivations behind Active Delivery:
 
-- Organize notifications related logic:
+- Organize notifications-related logic:
 
 ```ruby
 # Before
 def after_some_action
-  MyMailer.with(user: user).some_action.deliver_later if user.receive_emails?
+  MyMailer.with(user: user).some_action(resource).deliver_later if user.receive_emails?
   NotifyService.send_notification(user, "action") if whatever_else?
 end
 
 # After
 def after_some_action
-  MyDelivery.with(user: user).notify(:some_action)
+  MyDelivery.with(user: user).some_action(resource).deliver_later
 end
 ```
 
@@ -53,48 +56,126 @@ end
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "active_delivery"
+gem "active_delivery", "1.0.0.rc2"
 ```
 
 And then execute:
 
 ```sh
-bundle
+bundle install
 ```
 
 ## Usage
 
-The _Delivery_ class is used to trigger notifications. It describes how to notify a user (e.g., via email or push notification or both):
+The _Delivery_ class is used to trigger notifications. It describes how to notify a user (e.g., via email or push notification or both).
+
+First, it's recommended to create a base class for all deliveries with the configuration of the lines:
 
 ```ruby
-class PostsDelivery < ActiveDelivery::Base
-  # in most cases you don't have to specify anything in this class,
-  # 'cause default transport-level classes (such as mailers)
+# In the base class, you configure delivery lines
+class ApplicationDelivery < ActiveDelivery::Base
+  self.abstract_class = true
+
+  # Mailers are enabled by default, everything else must be declared explicitly
+
+  # For example, you can use a notifier line (see below) with a custom resolver
+  register_line :sms, ActiveDelivery::Lines::Notifier,
+    resolver: -> { _1.name.gsub(/Delivery$/, "SMSNotifier").safe_constantize }
+
+  register_line :cable, ActionCableDeliveryLine
+  # and more
 end
 ```
 
-It acts as a proxy in front of the different delivery channels (i.e., mailers, notifiers). That means that calling a method on delivery class invokes the same method on the corresponding _sender_ class, e.g.:
+Then, you can create a delivery class for a specific notification type. We follow Action Mailer conventions, and create a delivery class per resource:
+
+```ruby
+class PostsDelivery < ApplicationDelivery
+end
+```
+
+In most cases, you just leave this class blank. The corresponding mailers, notifiers, etc., will be inferred automatically using the naming convention.
+
+You don't need to define notification methods explicitly. Whenever you invoke a method on a delivery class, it will be proxied to the underlying _line handlers_ (mailers, notifiers, etc.):
+
+```ruby
+PostsDelivery.published(user, post).deliver_later
+
+# Under the hood it calls
+PostsMailer.published(user, post).deliver_later
+PostsSMSNotifier.published(user, post).notify_later
+
+# and whaterver your ActionCableDeliveryLine does
+# under the hood.
+```
+
+Alternatively, you call the `#notify` method with the notification name and the arguments:
 
 ```ruby
 PostsDelivery.notify(:published, user, post)
 
-# under the hood it calls
+# Under the hood it calls
 PostsMailer.published(user, post).deliver_later
+PostsSMSNotifier.published(user, post).notify_later
+# ...
+```
+
+You can also define a notification method explicitly if you want to add some logic:
+
+```ruby
+class PostsDelivery < ApplicationDelivery
+  def published(user, post)
+    # do something
+
+    # return a delivery object (to chain #deliver_later, etc.)
+    delivery(
+      notification: :published,
+      params: [user, post],
+      # For kwargs, you options
+      options: {},
+      # Metadata that can be used by line handlers
+      metadata: {}
+    )
+  end
+end
+```
+
+Finally, you can disable the default automatic proxying behaviour via the `ActiveDelivery.deliver_actions_required = true` configuration option. Then, in each delivery class, you can specify the available actions via the `.delivers` method:
 
-# and if you have a notifier (or any other line, see below)
-PostsNotifier.published(user, post).notify_later
+```ruby
+class PostDelivery < ApplicationDelivery
+  delivers :published
+end
+
+ActiveDelivery.deliver_actions_required = true
+
+PostDelivery.published(post) #=> ok
+PostDelivery.whatever(post) #=> raises NoMethodError
 ```
 
-P.S. Naming ("delivery") is inspired by Basecamp: https://www.youtube.com/watch?v=m1jOWu7woKM.
+### Customizing delivery handlers
+
+You can specify a mailer class explicitly:
 
-**NOTE**: You could specify Mailer class explicitly or by custom pattern, using resolver:
+```ruby
+class PostsDelivery < ActiveDelivery::Base
+  # You can pass a class name or a class itself
+  mailer "CustomPostsMailer"
+  # For other lines, you the line name as well
+  # sms "MyPostsSMSNotifier"
+end
+```
+
+Or you can provide a custom resolver by re-registering the line:
 
 ```ruby
 class PostsDelivery < ActiveDelivery::Base
-  register_line :custom_mailer, ActiveDelivery::Lines::Mailer, resolver: ->(name) { CustomMailer }
+  register_line :mailer, ActiveDelivery::Lines::Mailer, resolver: ->(_delivery_class) { CustomMailer }
 end
 ```
 
+### Parameterized deliveries
+
 Delivery also supports _parameterized_ calling:
 
 ```ruby
@@ -103,17 +184,19 @@ PostsDelivery.with(user: user).notify(:published, post)
 
 The parameters could be accessed through the `params` instance method (e.g., to implement guard-like logic).
 
-**NOTE**: When params are presents the parameterized mailer is used, i.e.:
+**NOTE**: When params are present, the parameterized mailer is used, i.e.:
 
 ```ruby
 PostsMailer.with(user: user).published(post)
 ```
 
+Other line implementations **MUST** also have the `#with` method in their public interface.
+
 See [Rails docs](https://api.rubyonrails.org/classes/ActionMailer/Parameterized.html) for more information on parameterized mailers.
 
-## Callbacks support
+### Callbacks support
 
-**NOTE:** callbacks are only available if ActiveSupport is present in the app's runtime.
+**NOTE:** callbacks are only available if ActiveSupport is present in the application's runtime.
 
 ```ruby
 # Run method before delivering notification
@@ -133,6 +216,12 @@ after_notify :mark_user_as_notified, if: -> { params[:user].present? }
 after_notify :cleanup
 
 around_notify :set_context
+
+# You can also skip callbacks in sub-classes
+skip_before_notify :do_something, only: %i[some_reminder]
+
+# NOTE: Specify `on` option for line-specific callbacks is required to skip them
+skip_after_notify :do_mail_something, on: :mailer
 ```
 
 Example:
@@ -141,7 +230,7 @@ Example:
 # Let's log notifications
 class MyDelivery < ActiveDelivery::Base
   after_notify do
-    # You can access the notificaion name within the instance
+    # You can access the notification name within the instance
     MyLogger.info "Delivery triggered: #{notification_name}"
   end
 end
@@ -152,7 +241,9 @@ MyDeliver.notify(:something_wicked_this_way_comes)
 
 ## Testing
 
-**NOTE:** RSpec only for the time being.
+**NOTE:** Currently, only RSpec matchers are provided.
+
+### Deliveries
 
 Active Delivery provides an elegant way to test deliveries in your code (i.e., when you want to check whether a notification has been sent) through a `have_delivered_to` matcher:
 
@@ -163,7 +254,7 @@ it "delivers notification" do
 end
 ```
 
-You can also use such RSpec features as [compound expectations](https://relishapp.com/rspec/rspec-expectations/docs/compound-expectations) and [composed matchers](https://relishapp.com/rspec/rspec-expectations/v/3-8/docs/composing-matchers):
+You can also use such RSpec features as compound expectations and composed matchers:
 
 ```ruby
 it "delivers to RSVPed members via .notify" do
@@ -186,7 +277,7 @@ specify "when event is not found" do
 end
 ```
 
-or use matcher
+or use the `#have_not_delivered_to` matcher:
 
 ```ruby
 specify "when event is not found" do
@@ -196,7 +287,57 @@ specify "when event is not found" do
 end
 ```
 
-**NOTE:** test mode activated automatically if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". Otherwise add `require "active_delivery/testing/rspec"` to your `spec_helper.rb` / `rails_helper.rb` manually. This is also required if you're using Spring in test environment (e.g. with help of [spring-commands-rspec](https://github.com/jonleighton/spring-commands-rspec)).
+### Delivery classes
+
+You can test Delivery classes as regular Ruby classes:
+
+```ruby
+describe PostsDelivery do
+  let(:user) { build_stubbed(:user) }
+  let(:post) { build_stubbed(:post) }
+
+  describe "#published" do
+    it "sends a mail" do
+      expect {
+        described_class.published(user, post).deliver_now
+      }.to change { ActionMailer::Base.deliveries.count }.by(1)
+
+      mail = ActionMailer::Base.deliveries.last
+      expect(mail.to).to eq([user.email])
+      expect(mail.subject).to eq("New post published")
+    end
+  end
+end
+```
+
+You can also use the `#deliver_via` matchers as follows:
+
+```ruby
+describe PostsDelivery, type: :delivery do
+  let(:user) { build_stubbed(:user) }
+  let(:post) { build_stubbed(:post) }
+
+  describe "#published" do
+    it "delivers to mailer and sms" do
+      expect {
+        described_class.published(user, post).deliver_later
+      }.to deliver_via(:mailer, :sms)
+    end
+
+    context "when user is not subscribed to SMS notifications" do
+      let(:user) { build_stubbed(:user, sms_notifications: false) }
+
+      it "delivers to mailer only" do
+        expect {
+          described_class.published(user, post).deliver_now
+        }.to deliver_via(:mailer)
+      end
+    end
+  end
+end
+```
+
+**NOTE:** test mode activated automatically if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". Otherwise, add `require "active_delivery/testing/rspec"` to your `spec_helper.rb` / `rails_helper.rb` manually. This is also required if you're using Spring in the test environment (e.g. with help of [spring-commands-rspec](https://github.com/jonleighton/spring-commands-rspec)).
 
 ## Custom "lines"
 
@@ -208,13 +349,15 @@ A line connects _delivery_ to the _sender_ class responsible for sending notific
 
 If you want to use parameterized deliveries, your _sender_ class must respond to `.with(params)` method.
 
+### A full-featured line example: pigeons 🐦
+
 Assume that we want to send messages via _pigeons_ and we have the following sender class:
 
 ```ruby
 class EventPigeon
   class << self
     # Add `.with`  method as an alias
-    alias with new
+    alias_method :with, :new
 
     # delegate delivery action to the instance
     def message_arrived(*args)
@@ -271,7 +414,50 @@ class PigeonLine < ActiveDelivery::Lines::Base
 end
 ```
 
-**NOTE**: we fallback to superclass's sender class if `resolve_class` returns nil.
+In the case of parameterized calling, some update needs to be done on the new Line. Here is an example:
+
+```ruby
+class EventPigeon
+  attr_reader :params
+
+  class << self
+    # Add `.with`  method as an alias
+    alias_method :with, :new
+
+    # delegate delivery action to the instance
+    def message_arrived(*args)
+      new.message_arrived(*args)
+    end
+  end
+
+  def initialize(params = {})
+    @params = params
+    # do smth with params
+  end
+
+  def message_arrived(msg)
+    # send a pigeon with the message
+  end
+end
+
+class PigeonLine < ActiveDelivery::Lines::Base
+  def notify_later(sender, delivery_action, *args, **kwargs)
+    # `to_s` is important for serialization. Unless you might have error
+    PigeonLaunchJob.perform_later sender.class.to_s, delivery_action, *args, **kwargs.merge(params: line.params)
+  end
+end
+
+class PigeonLaunchJob < ActiveJob::Base
+  def perform(sender, delivery_action, *args, params: nil, **kwargs)
+    klass = sender.safe_constantize
+    handler = params ? klass.with(**params) : klass.new
+
+    handler.public_send(delivery_action, *args, **kwargs)
+  end
+end
+```
+
+**NOTE**: we fall back to the superclass's sender class if `resolve_class` returns nil.
 You can disable automatic inference of sender classes by marking delivery as _abstract_:
 
 ```ruby
@@ -295,7 +481,7 @@ class EventDelivery < ActiveDelivery::Base
   # register_line :pigeon, PigeonLine, namespace: "AngryPigeons"
   #
   # now you can explicitly specify pigeon class
-  # pigeon MyCustomPigeon
+  # pigeon "MyCustomPigeon"
   #
   # or define pigeon specific callbacks
   #
@@ -303,7 +489,7 @@ class EventDelivery < ActiveDelivery::Base
 end
 ```
 
-You can also _unregister_ a line.  For example, when subclassing another `Delivery` class or to remove any of the automatically added lines (e.g., `mailer`):
+You can also _unregister_ a line:
 
 ```ruby
 class NonMailerDelivery < ActiveDelivery::Base
@@ -312,9 +498,285 @@ class NonMailerDelivery < ActiveDelivery::Base
 end
 ```
 
-## Related projects
+### An example of a universal sender: Action Cable
+
+Although Active Delivery is designed to work with Action Mailer-like abstraction, it's flexible enough to support other use cases.
+
+For example, for some notification channels, we don't need to create a separate class for each resource or context; we can send the payload right to the communication channel. Let's consider an Action Cable line as an example.
+
+For every delivery, we want to broadcast a message via Action Cable to the stream corresponding to the delivery class name. For example:
+
+```ruby
+# Our PostsDelivery example from the beginning
+PostsDelivery.with(user:).notify(:published, post)
+
+# Will results in the following Action Cable broadcast:
+DeliveryChannel.broadcast_to user, {event: "posts.published", post_id: post.id}
+```
+
+The `ActionCableDeliveryLine` class can be implemented as follows:
+
+```ruby
+class ActionCableDeliveryLine < ActiveDelivery::Line::Base
+  # Context is our universal sender.
+  class Context
+    attr_reader :user
+
+    def initialize(scope)
+      @scope = scope
+    end
+
+    # User is required for this line
+    def with(user:, **)
+      @user = user
+      self
+    end
+  end
+
+  # The result of this callback is passed further to the `notify_now` method
+  def resolve_class(name)
+    Context.new(name.sub(/Delivery$/, "").underscore)
+  end
+
+  # We want to broadcast all notifications
+  def notify?(...) = true
+
+  def notify_now(context, delivery_action, *args, **kwargs)
+    # Skip if no user provided
+    return unless context.user
+
+    payload = {event: [context.scope, delivery_action].join(".")}
+    payload.merge!(serialized_args(*args, **kwargs))
+
+    DeliveryChannel.broadcast_to context.user, payload
+  end
+
+  # Broadcasts are asynchronous by nature, so we can just use `notify_now`
+  alias_method :notify_later, :notify_now
+
+  private
+
+  def serialized_args(*args, **kwargs)
+    # Code that convers AR objects into IDs, etc.
+  end
+end
+```
+
+## Abstract Notifier
+
+Abstract Notifier is a tool that allows you to describe/model any text-based notifications (such as Push Notifications) the same way Action Mailer does for email notifications.
+
+Abstract Notifier (as the name states) doesn't provide any specific implementation for sending notifications. Instead, it offers tools to organize your notification-specific code and make it easily testable.
+
+### Notifier classes
+
+A **notifier object** is very similar to an Action Mailer's mailer with  the `#notification` method used instead of the `#mail` method:
+
+```ruby
+class EventsNotifier < ApplicationNotifier
+  def canceled(profile, event)
+    notification(
+      # the only required option is `body`
+      body: "Event #{event.title} has been canceled",
+      # all other options are passed to delivery driver
+      identity: profile.notification_service_id
+    )
+  end
+end
+
+# send notification later
+EventsNotifier.canceled(profile, event).notify_later
+
+# or immediately
+EventsNotifier.canceled(profile, event).notify_now
+```
+
+### Delivery drivers
+
+To perform actual deliveries you **must** configure a _delivery driver_:
+
+```ruby
+class ApplicationNotifier < AbstractNotifier::Base
+  self.driver = MyFancySender.new
+end
+```
+
+A driver could be any callable Ruby object (i.e., anything that responds to `#call`).
+
+That's the developer's responsibility to implement the driver (we do not provide any drivers out-of-the-box; at least yet).
+
+You can set different drivers for different notifiers.
+
+### Parameterized notifiers
+
+Abstract Notifier supports parameterization the same way as [Action Mailer](https://api.rubyonrails.org/classes/ActionMailer/Parameterized.html):
+
+```ruby
+class EventsNotifier < ApplicationNotifier
+  def canceled(event)
+    notification(
+      body: "Event #{event.title} has been canceled",
+      identity: params[:profile].notification_service_id
+    )
+  end
+end
+
+EventsNotifier.with(profile: profile).canceled(event).notify_later
+```
+
+### Defaults
+
+You can specify default notification fields at a class level:
+
+```ruby
+class EventsNotifier < ApplicationNotifier
+  # `category` field will be added to the notification
+  # if missing
+  default category: "EVENTS"
+
+  # ...
+end
+```
+
+**NOTE**: when subclassing notifiers, default parameters are merged.
+
+You can also specify a block or a method name as the default params _generator_.
+This could be useful in combination with the `#notification_name` method to generate dynamic payloads:
+
+```ruby
+class ApplicationNotifier < AbstractNotifier::Base
+  default :build_defaults_from_locale
 
-- [`abstract_notifier`](https://github.com/palkan/abstract_notifier) – Action Mailer-like interface for text-based notifications.
+  private
+
+  def build_defaults_from_locale
+    {
+      subject: I18n.t(notification_name, scope: [:notifiers, self.class.name.underscore])
+    }
+  end
+end
+```
+
+### Background jobs / async notifications
+
+To use `#notify_later` you **must** configure an async adapter for Abstract Notifier.
+
+We provide an Active Job adapter out of the box and enable it if Active Job is found.
+
+A custom async adapter must implement the `#enqueue` method:
+
+```ruby
+class MyAsyncAdapter
+  # adapters may accept options
+  def initialize(options = {})
+  end
+
+  # `enqueue` method accepts notifier class and notification
+  # payload.
+  # We need to know notifier class to use its driver.
+  def enqueue(notifier_class, payload)
+    # your implementation here
+  end
+end
+
+# Configure globally
+AbstractNotifier.async_adapter = MyAsyncAdapter.new
+
+# or per-notifier
+class EventsNotifier < AbstractNotifier::Base
+  self.async_adapter = MyAsyncAdapter.new
+end
+```
+
+### Delivery modes
+
+For test/development purposes there are two special _global_ delivery modes:
+
+```ruby
+# Track all sent notifications without peforming real actions.
+# Required for using RSpec matchers.
+#
+# config/environments/test.rb
+AbstractNotifier.delivery_mode = :test
+
+# If you don't want to trigger notifications in development,
+# you can make Abstract Notifier no-op.
+#
+# config/environments/development.rb
+AbstractNotifier.delivery_mode = :noop
+
+# Default delivery mode is "normal"
+AbstractNotifier.delivery_mode = :normal
+```
+
+**NOTE:** we set `delivery_mode = :test` if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test".
+Otherwise add `require "abstract_notifier/testing"` to your `spec_helper.rb` / `rails_helper.rb` manually.
+
+**NOTE:** delivery mode affects all drivers.
+
+### Testing notifier deliveries
+
+Abstract Notifier provides two convenient RSpec matchers:
+
+```ruby
+# for testing sync notifications (sent with `notify_now`)
+expect { EventsNotifier.with(profile: profile).canceled(event).notify_now }
+  .to have_sent_notification(identify: "123", body: "Alarma!")
+
+# for testing async notifications (sent with `notify_later`)
+expect { EventsNotifier.with(profile: profile).canceled(event).notify_later }
+  .to have_enqueued_notification(via: EventNotifier, identify: "123", body: "Alarma!")
+
+# you can also specify the expected notifier class (useful when ypu have multiple notifier lines)
+expect { EventsNotifier.with(profile: profile).canceled(event).notify_now }
+  .to have_sent_notification(via: EventsNotifier, identify: "123", body: "Alarma!")
+```
+
+Abstract Notifier also provides Minitest assertions:
+
+```ruby
+require "abstract_notifier/testing/minitest"
+
+class EventsNotifierTestCase < Minitest::Test
+  include AbstractNotifier::TestHelper
+
+  test "canceled" do
+    assert_notifications_sent 1, identify: "321", body: "Alarma!" do
+      EventsNotifier.with(profile: profile).canceled(event).notify_now
+    end
+
+    assert_notifications_sent 1, via: EventNofitier, identify: "123", body: "Alarma!" do
+      EventsNotifier.with(profile: profile).canceled(event).notify_now
+    end
+
+    assert_notifications_enqueued 1, via: EventNofitier, identify: "123", body: "Alarma!" do
+      EventsNotifier.with(profile: profile).canceled(event).notify_later
+    end
+  end
+end
+```
+
+**NOTE:** test mode activated automatically if `RAILS_ENV` or `RACK_ENV` env variable is equal to "test". Otherwise, add `require "abstract_notifier/testing/rspec"` to your `spec_helper.rb` / `rails_helper.rb` manually. This is also required if you're using Spring in a test environment (e.g. with help of [spring-commands-rspec](https://github.com/jonleighton/spring-commands-rspec)).
+
+### Notifier lines for Active Delivery
+
+Abstract Notifier provides a _notifier_ line for Active Delivery:
+
+```ruby
+class ApplicationDelivery < ActiveDelivery::Base
+  # Add notifier line to you delivery
+  # By default, we use `*Delivery` -> `*Notifier` resolution mechanism
+  register_line :notifier, notifier: true
+
+  # You can define a custom suffix to use for notifier classes:
+  #   `*Delivery` -> `*CustomNotifier`
+  register_line :custom_notifier, notifier: true, suffix: "CustomNotifier"
+
+  # Or you can specify a Proc object to do custom resolution:
+  register_line :some_notifier, notifier: true,
+    resolver: ->(delivery_class) { resolve_somehow(delivery_class) }
+end
+```
 
 ## Contributing