Merge pull request #175 from joyofrails/feat/welcome

Add welcome email for new subscribers

Author: rossta

app/controllers/users/confirmations_controller.rb

@@ -53,6 +53,8 @@ def update
     if @user.confirm!
       warden.set_user(@user, scope: :user)
 
+      WelcomeNotifier.deliver_to(@user)
+
       redirect_to users_dashboard_path, notice: "Thank you for confirming your email address"
     else
       redirect_to new_users_confirmation_path, alert: "Something went wrong"

app/controllers/users/newsletter_subscriptions_controller.rb

@@ -65,29 +65,42 @@ def subscribe
   end
 
   def unsubscribe
-    if params[:token]
-      subscription = NewsletterSubscription.find_by_token_for(:unsubscribe, params[:token]) or raise ActiveRecord::RecordNotFound
-      subscription.destroy
-    elsif current_user
-      # Even though we model the subscription as a has_one, we should destroy
-      # all because has_one is not enforced as a constraint
-      NewsletterSubscription.where(subscriber: current_user).destroy_all
-    else
-      not_found!
-    end
+    subscriber = find_subscriber
+
+    # Even though we model the subscription as a has_one, we should destroy
+    # all because has_one is not enforced as a constraint
+    NewsletterSubscription.where(subscriber: subscriber).destroy_all
+
+    notice = "You have been unsubscribed from the Joy of Rails newsletter"
 
     if request.post? && params["List-Unsubscribe"] == "One-Click"
       # must not redirect according to RFC 8058
       # could render show action instead
-      render plain: "You have been unsubscribed", status: :ok
+      render plain: notice, status: :ok
     else
       respond_to do |format|
-        format.html { redirect_to root_path, notice: "You have been unsubscribed" }
+        format.html { redirect_to root_path, notice: notice }
         format.turbo_stream {
           redirect_path = current_user ? users_newsletter_subscriptions_path : new_users_newsletter_subscription_path
           redirect_to redirect_path
         }
       end
     end
   end
+
+  private
+
+  def find_subscriber
+    subscriber = if params[:token]
+      subscription = NewsletterSubscription.find_by_token_for!(:unsubscribe, params[:token])
+      subscription&.subscriber
+    else
+      current_user
+    end
+
+    subscriber or raise ActiveRecord::RecordNotFound
+  rescue ActiveSupport::MessageVerifier::InvalidSignature
+    Honeybadger.event("invalid_token", {path: request.path, controller: self.class.name, action: action_name})
+    raise ActiveRecord::RecordNotFound
+  end
 end

app/jobs/notifications/event_job.rb

@@ -4,7 +4,10 @@ class Notifications::EventJob < ApplicationJob
   def perform(event)
     # Enqueue individual deliveries
     event.notifications.each do |notification|
-      event.deliver_notification(notification)
+      notification.transaction do
+        event.deliver_notification(notification)
+        notification.touch(:processed_at)
+      end
     end
   end
 end

app/lib/warden_extensions/setup.rb

@@ -22,6 +22,7 @@ def configure_manager
         case auth.winning_strategy&.key
         when :magic_session
           user.confirm!
+          WelcomeNotifier.deliver_to(user)
         when :password
           # no op
         else # nil, as with test helpers

app/mailers/emails/user_mailer.rb

@@ -19,4 +19,11 @@ def password_reset(user, password_reset_token)
 
     mail to: @user.email, subject: "Reset your password"
   end
+
+  def welcome(user, unsubscribe_token = :no_token)
+    @user = user
+    @unsubscribe_token = unsubscribe_token
+
+    mail to: @user.email, subject: "Welcome to Joy of Rails!"
+  end
 end

app/models/notification.rb

@@ -5,4 +5,6 @@ class Notification < ApplicationRecord
   scope :newest_first, -> { order(created_at: :desc) }
 
   delegate :params, :record, to: :event
+
+  scope :processed, -> { where.not(processed_at: nil) }
 end

app/models/notification_event.rb

@@ -29,16 +29,22 @@ def self.inherited(notifier)
     notifier.const_set :Notification, Class.new(Notification)
   end
 
+  def deliver_to?(recipient)
+    true
+  end
+
   # CommentNotifier.deliver(User.all)
   # CommentNotifier.deliver(User.all, priority: 10)
   # CommentNotifier.deliver(User.all, queue: :low_priority)
   # CommentNotifier.deliver(User.all, wait: 5.minutes)
   # CommentNotifier.deliver(User.all, wait_until: 1.hour.from_now)
-  def deliver(recipients = nil, enqueue_job: true, **options)
+  def deliver(given_recipients = nil, enqueue_job: true, **options)
     validate!
 
+    recipients = Array.wrap(given_recipients)
+
     transaction do
-      recipients_attributes = Array.wrap(recipients).map do |recipient|
+      recipients_attributes = recipients.map do |recipient|
         recipient_attributes_for(recipient)
       end
 

app/models/user.rb

@@ -8,6 +8,8 @@ class User < ApplicationRecord
 
   has_one :newsletter_subscription, as: :subscriber, dependent: :destroy
 
+  scope :recently_confirmed, -> { where("confirmed_at > ?", 2.weeks.ago) }
+
   accepts_nested_attributes_for :email_exchanges, limit: 1
 
   validates :email, presence: true, uniqueness: true, format: {with: URI::MailTo::EMAIL_REGEXP}

app/notifiers/welcome_notifier.rb

@@ -0,0 +1,22 @@
+class WelcomeNotifier < NotificationEvent
+  def self.deliver_to(user, **)
+    new(params: {user: user}).deliver(user, **)
+  end
+
+  def deliver_notification(notification)
+    user = notification.recipient
+    unsubscribe_token = user&.newsletter_subscription&.generate_token_for(:unsubscribe) || :no_token
+
+    if !deliver_to?(user)
+      Rails.logger.info "#[#{self.class}] Skipping delivery for: #{user.class.name}##{user.id}"
+      Honeybadger.event("empty_notification", notifier: self.class.name, recipient: "#{user.class.name}##{user.id}")
+      return false
+    end
+
+    Emails::UserMailer.welcome(user, unsubscribe_token).deliver_later
+  end
+
+  def deliver_to?(recipient)
+    Notification.processed.joins(:notification_event).where(recipient: recipient, notification_event: {type: self.class.name}).count < 1
+  end
+end

app/views/emails/magic_session_mailer/no_account_found.text.erb

@@ -1,4 +1,4 @@
-Is this the right email?
+# Is this the right email?
 
 It looks like there isn’t an account on test tied to this email address.