Manage subscriptions and unsubscribe from all (#85)

Author: garyhtou

app/controllers/hackathon/subscriptions/bulk_controller.rb

@@ -0,0 +1,35 @@
+class Hackathon::Subscriptions::BulkController < ApplicationController
+  skip_before_action :redirect_if_unauthenticated, only: [:update, :destroy]
+
+  before_action :set_user
+  before_action :set_subscriptions
+
+  # Marking subscriptions as active. Used for undoing an "Unsubscribe from all".
+  # PUT /users/:user_id/subscriptions/bulk
+  def update
+    @count = @subscriptions.map(&:resubscribe!).count(true)
+
+    redirect_to Hackathon::Subscription.manage_subscriptions_url_for(@user),
+      notice: "Resubscribed to #{@count} #{"locations".pluralize(@count)}."
+  end
+
+  # Marking subscriptions as inactive.
+  # DELETE /users/:user_id/subscriptions/bulk
+  def destroy
+    @count = @subscriptions.map(&:unsubscribe!).count(true)
+
+    redirect_to Hackathon::Subscription.manage_subscriptions_url_for(@user),
+      notice: "Unsubscribed from #{@count} #{"locations".pluralize(@count)}."
+  end
+
+  private
+
+  def set_user
+    # We're using signed ids here to avoid the need for authentication.
+    @user = User.find_signed!(params[:user_id], purpose: :manage_subscriptions)
+  end
+
+  def set_subscriptions
+    @subscriptions = @user.subscriptions.where(id: params[:ids])
+  end
+end

app/controllers/hackathon/subscriptions_controller.rb

@@ -0,0 +1,31 @@
+class Hackathon::SubscriptionsController < ApplicationController
+  skip_before_action :redirect_if_unauthenticated, only: [:index, :unsubscribe_all]
+  before_action :set_user, only: [:index, :unsubscribe_all]
+
+  # Manage subscriptions for a user.
+  # GET /users/:user_id/subscriptions
+  def index
+    return if @expired
+
+    @subscriptions = @user.subscriptions.active
+  end
+
+  # Unsubscribe from all subscriptions for a user.
+  # GET /users/:user_id/subscriptions/unsubscribe_all
+  def unsubscribe_all
+    return if @expired
+
+    @subscriptions = @user.subscriptions.active
+
+    @unsubscribed_ids = @subscriptions.pluck(:id)
+    @unsubscribe_count = @subscriptions.map(&:unsubscribe!).count(true)
+  end
+
+  private
+
+  def set_user
+    # We're using signed ids here to avoid the need for authentication.
+    @user = User.find_signed(params[:user_id], purpose: :manage_subscriptions)
+    @expired = @user.nil?
+  end
+end

app/javascript/controllers/forms/required_checkboxes_controller.js

@@ -0,0 +1,35 @@
+import {Controller} from "@hotwired/stimulus"
+
+export default class extends Controller {
+    /* Prevent form submission unless required checkboxes are checked.
+
+       This controller may require all or some depending on the `require` value.
+       - `every`: All checkboxes must be checked
+       - `some`: At least one checkbox must be checked
+
+       USAGE:
+       1. Add the `data-controller` attribute to the form and set the `require`
+          value to either `every` or `some`.
+       2. Place the `button` target on the submit button that should be disabled.
+       3. And place the `input` target and `changed` action on every checkbox
+          that should be checked.
+     */
+    static targets = ["button", "input"]
+    static values = {require: String}
+
+    connect() {
+        this.changed()
+    }
+
+    changed() {
+        const message = {
+            every: "Please select all options",
+            some: "Please select at least one option",
+        }[this.requireValue]
+
+        let metRequirements = this.inputTargets[this.requireValue]((input) => input.checked)
+
+        this.buttonTarget.disabled = !metRequirements
+        this.buttonTarget.title = metRequirements ? null : message
+    }
+}

app/mailers/application_mailer.rb

@@ -9,6 +9,11 @@ class ApplicationMailer < ActionMailer::Base
 
   private
 
+  def set_unsubscribe_urls_for(user)
+    @unsubscribe_url = Hackathon::Subscription.unsubscribe_all_url_for user
+    @email_preferences_url = Hackathon::Subscription.manage_subscriptions_url_for user
+  end
+
   def set_default_unsubscribe_urls
     @unsubscribe_url = root_url
     @email_preferences_url = root_url

app/mailers/hackathons/digest_mailer.rb

@@ -7,6 +7,7 @@ def digest
       .includes(:subscription, hackathon: {logo_attachment: :blob})
       .group_by(&:subscription)
 
+    set_unsubscribe_urls_for @recipient
     mail to: @recipient.email_address, subject: "Hackathons near you"
   end
 end

app/models/hackathon/subscription/status.rb

@@ -9,15 +9,36 @@ module Hackathon::Subscription::Status
     scope :active_for, ->(user) { active.where(subscriber: user) }
   end
 
-  private
+  # Unsubscribe URLs must be valid for at least 30 days.
+  # https://www.ftc.gov/business-guidance/resources/can-spam-act-compliance-guide-business
+  UNSUBSCRIBE_EXPIRATION = 2.months
 
-  def track_changes
-    if changed_to_inactive?
-      record(:disabled)
+  class_methods do
+    def manage_subscriptions_url_for(user)
+      user_signature = user.signed_id purpose: :manage_subscriptions, expires_in: UNSUBSCRIBE_EXPIRATION
+      Rails.application.routes.url_helpers.user_subscriptions_url(user_signature)
+    end
+
+    def unsubscribe_all_url_for(user)
+      user_signature = user.signed_id purpose: :manage_subscriptions, expires_in: UNSUBSCRIBE_EXPIRATION
+      Rails.application.routes.url_helpers.unsubscribe_all_user_subscriptions_url(user_signature)
     end
   end
 
-  def changed_to_inactive?
-    saved_change_to_status? && inactive?
+  def unsubscribe
+    update(status: :inactive)
+  end
+
+  def resubscribe
+    update(status: :active)
+  end
+
+  private
+
+  def track_changes
+    return unless saved_change_to_status?
+
+    record(:enabled) if active?
+    record(:disabled) if inactive?
   end
 end

app/views/hackathon/subscriptions/_manage.html.erb

@@ -0,0 +1,27 @@
+<% if subscriptions.present? %>
+  <%= form_with url: user_subscriptions_bulk_path, method: :delete,
+    data: {
+      controller: "forms--required-checkboxes",
+      "forms--required-checkboxes-require-value": "some"
+    } do |form| %>
+
+    <% subscriptions.each do |subscription| %>
+      <div class="subscription">
+        <%= check_box_tag "ids[]", subscription.id, false, data: {
+          action: "change->forms--required-checkboxes#changed",
+          "forms--required-checkboxes-target": "input"
+        }, id: dom_id(subscription) %>
+        <%= form.label dom_id(subscription), subscription.location %>
+      </div>
+    <% end %>
+
+    <div>
+      <%= form.submit "Unsubscribe", data: {"forms--required-checkboxes-target": "button"}, disabled: true %>
+      or
+      <%= link_to "unsubscribe from all", unsubscribe_all_user_subscriptions_url %>
+    </div>
+  <% end %>
+
+<% else %>
+  <p>You are not subscribed to any locations.</p>
+<% end %>

app/views/hackathon/subscriptions/index.html.erb

@@ -0,0 +1,16 @@
+<% content_for :title, "Manage Subscriptions" %>
+
+<h1>Manage Subscriptions</h1>
+
+<% if @expired %>
+  <p>This link has expired.</p>
+<% else %>
+
+  <p>
+    Hey there, <b><%= @user.first_name || @user.email_address %></b>!
+    <br/>
+    You are currently subscribed to the following locations.
+  </p>
+
+  <%= render "manage", subscriptions: @subscriptions %>
+<% end %>

app/views/hackathon/subscriptions/unsubscribe_all.html.erb

@@ -0,0 +1,34 @@
+<% content_for :title, "Unsubscribe" %>
+
+<h1>Unsubscribe</h1>
+
+<% if @expired %>
+  <p>This link has expired.</p>
+<% else %>
+
+  <p>
+    Hey there, <b><%= @user.name || @user.email_address %></b>!
+  </p>
+
+  <p>
+    You have unsubscribed from all emails.
+    <% unless @unsubscribe_count.zero? %>
+      You were previous subscribed to
+      <%= @unsubscribe_count %> <%= "location".pluralize(@unsubscribe_count) %>.
+    <% end %>
+
+    <br/>
+    <i>Sad to see you go. :(</i>
+  </p>
+
+  <%# Button for undo-ing unsubscribe all %>
+  <% unless @unsubscribe_count.zero? %>
+    <%= form_with url: user_subscriptions_bulk_path, method: :put do |form| %>
+      <% @unsubscribed_ids.each do |id| %>
+        <%= form.hidden_field "ids[]", value: id %>
+      <% end %>
+
+      <%= form.button "Undo" %>
+    <% end %>
+  <% end %>
+<% end %>

app/views/layouts/application.html.erb

@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html>
   <head>
-    <title>Hackathons</title>
+    <title><%= yield(:title).presence&.+(" — ") %> High School Hackathons</title>
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <%= csrf_meta_tags %>
     <%= csp_meta_tag %>