[feature] Configure remaining automated emails from UI (#148)

sman591 · web-flow · commit c79b76d5bf33 · 2019-05-16T23:20:53.000-04:00
* [feature] Configure remaining automated emails from UI

* Raise error for bad triggers
diff --git a/app/controllers/manage/bus_lists_controller.rb b/app/controllers/manage/bus_lists_controller.rb
@@ -44,15 +44,22 @@ def toggle_bus_captain
     is_bus_captain = params[:bus_captain] == "1"
     @questionnaire.update_attribute(:is_bus_captain, is_bus_captain)
     if @questionnaire.reload.is_bus_captain
-      Mailer.delay.bus_captain_confirmation_email(@bus_list.id, @questionnaire.user.id)
+      Message.queue_for_trigger("bus_list.new_captain_confirmation", @questionnaire.user.id)
     end
     redirect_to [:manage, @bus_list]
   end
 
   def send_update_email
+    if Message.for_trigger("bus_list.notes_update").empty?
+      flash[:error] = 'Error: No automated message is configured for bus note updates!'
+      redirect_to [:manage, @bus_list]
+      return
+    end
+
     @bus_list.passengers.each do |passenger|
-      Mailer.delay.bus_list_update_email(passenger.id)
+      Message.queue_for_trigger("bus_list.notes_update", passenger.id).count
     end
+    flash[:notice] = 'Bus notes update emails have been sent'
     redirect_to [:manage, @bus_list]
   end
 
diff --git a/app/mailers/mail_preview.rb b/app/mailers/mail_preview.rb
@@ -4,18 +4,5 @@ def bulk_message_email
       message = Message.first
       Mailer.bulk_message_email(message, User.first.id)
     end
-
-    def incomplete_reminder_email
-      Mailer.incomplete_reminder_email(User.without_questionnaire.first.id)
-    end
-
-    def bus_captain_confirmation_email
-      buslist = BusList.first
-      Mailer.bus_captain_confirmation_email(buslist.id, buslist.captains.first.id)
-    end
-
-    def bus_list_update_email
-      Mailer.bus_list_update_email(BusList.first.passengers.first.id)
-    end
   end
 end
diff --git a/app/mailers/mailer.rb b/app/mailers/mailer.rb
@@ -9,6 +9,7 @@ def bulk_message_email(message_id, user_id, message = nil, use_examples = false)
     @user         = User.find_by_id(user_id)
     @use_examples = use_examples
     return if @user.blank? || @message.blank?
+
     mail(
       to: pretty_email(@user.full_name, @user.email),
       subject: @message.subject
@@ -18,31 +19,15 @@ def bulk_message_email(message_id, user_id, message = nil, use_examples = false)
   def incomplete_reminder_email(user_id)
     @user = User.find_by_id(user_id)
     return if @user.blank? || @user.admin? || @user.questionnaire || Time.now.to_date > Date.parse(HackathonConfig['last_day_to_apply'])
-    mail(
-      to: @user.email,
-      subject: "Incomplete Application"
-    )
-  end
 
-  def bus_captain_confirmation_email(bus_list_id, user_id)
-    @user = User.find_by_id(user_id)
-    @questionnaire = @user.questionnaire
-    @bus_list = BusList.find_by_id(bus_list_id)
-    return if @user.blank? || @user.questionnaire.blank? || !@user.questionnaire.is_bus_captain? || @bus_list.blank?
-    mail_questionnaire("You're a bus captain!")
-  end
-
-  def bus_list_update_email(questionnaire_id)
-    @questionnaire = Questionnaire.find_by_id(questionnaire_id)
-    @bus_list = @questionnaire.bus_list
-    return if @questionnaire.blank? || @questionnaire.user.blank? || @bus_list.blank?
-    mail_questionnaire("Bus Update")
+    Message.queue_for_trigger("user.24hr_incomplete_application", @user.id)
   end
 
   private
 
   def pretty_email(name, email)
     return email if name.blank?
+
     "\"#{name}\" <#{email}>"
   end
 
diff --git a/app/models/message.rb b/app/models/message.rb
@@ -13,28 +13,31 @@ class Message < ApplicationRecord
   POSSIBLE_TYPES = ["bulk", "automated"].freeze
 
   POSSIBLE_SIMPLE_RECIPIENTS = {
-    "all"                              => "Everyone",
-    "incomplete"                       => "Incomplete Applications",
-    "complete"                         => "Complete Applications",
-    "accepted"                         => "Accepted Applications",
-    "denied"                           => "Denied Applications",
-    "waitlisted"                       => "Waitlisted Applications",
-    "late-waitlisted"                  => "Late, Waitlisted Applications",
-    "rsvp-confirmed"                   => "RSVP Confirmed Attendees",
-    "rsvp-denied"                      => "RSVP Denied Attendees",
-    "checked-in"                       => "Checked-In Attendees",
-    "non-checked-in"                   => "Non-Checked-In, Accepted & RSVP'd Applications",
-    "non-checked-in-excluding"         => "Non-Checked-In Applications, Excluding Accepted & RSVP'd"
+    "all" => "Everyone",
+    "incomplete" => "Incomplete Applications",
+    "complete" => "Complete Applications",
+    "accepted" => "Accepted Applications",
+    "denied" => "Denied Applications",
+    "waitlisted" => "Waitlisted Applications",
+    "late-waitlisted" => "Late, Waitlisted Applications",
+    "rsvp-confirmed" => "RSVP Confirmed Attendees",
+    "rsvp-denied" => "RSVP Denied Attendees",
+    "checked-in" => "Checked-In Attendees",
+    "non-checked-in" => "Non-Checked-In, Accepted & RSVP'd Applications",
+    "non-checked-in-excluding" => "Non-Checked-In Applications, Excluding Accepted & RSVP'd"
   }.freeze
 
   POSSIBLE_TRIGGERS = {
-    "questionnaire.pending"        => "Questionnaire Status: Pending Review (new application)",
-    "questionnaire.accepted"       => "Questionnaire Status: Accepted",
-    "questionnaire.waitlist"       => "Questionnaire Status: Waitlisted",
-    "questionnaire.denied"         => "Questionnaire Status: Denied",
-    "questionnaire.late_waitlist"  => "Questionnaire Status: Waitlisted, Late",
+    "questionnaire.pending" => "Questionnaire Status: Pending Review (new application)",
+    "questionnaire.accepted" => "Questionnaire Status: Accepted",
+    "questionnaire.waitlist" => "Questionnaire Status: Waitlisted",
+    "questionnaire.denied" => "Questionnaire Status: Denied",
+    "questionnaire.late_waitlist" => "Questionnaire Status: Waitlisted, Late",
     "questionnaire.rsvp_confirmed" => "Questionnaire Status: RSVP Confirmed",
-    "questionnaire.rsvp_denied"    => "Questionnaire Status: RSVP Denied"
+    "questionnaire.rsvp_denied" => "Questionnaire Status: RSVP Denied",
+    "user.24hr_incomplete_application" => "User: Incomplete application (24 hours later)",
+    "bus_list.new_captain_confirmation" => "Bus List: New captain confirmation",
+    "bus_list.notes_update" => "Bus List: Updated notes (manually triggered)"
   }.freeze
 
   serialize :recipients, Array
@@ -107,6 +110,7 @@ def status
     return "delivered" if delivered?
     return "started" if started?
     return "queued" if queued?
+
     "drafted"
   end
 
@@ -160,9 +164,14 @@ def possible_recipients
     recipients
   end
 
+  def self.for_trigger(trigger)
+    raise ArgumentError, "Unknown trigger: #{trigger}" unless POSSIBLE_TRIGGERS.include?(trigger)
+
+    Message.where(trigger: trigger)
+  end
+
   def self.queue_for_trigger(trigger, user_id)
-    messages_to_queue = Message.where(trigger: trigger)
-    messages_to_queue.map { |message| Mailer.delay.bulk_message_email(message.id, user_id) }
+    for_trigger(trigger).map { |message| Mailer.delay.bulk_message_email(message.id, user_id) }
   end
 
   def self.bulk
diff --git a/app/views/mailer/bus_captain_confirmation_email.html.erb b/app/views/mailer/bus_captain_confirmation_email.html.erb
diff --git a/app/views/mailer/bus_list_update_email.html.erb b/app/views/mailer/bus_list_update_email.html.erb
diff --git a/app/views/mailer/incomplete_reminder_email.html.erb b/app/views/mailer/incomplete_reminder_email.html.erb
diff --git a/config/template_variables.yml b/config/template_variables.yml
@@ -50,3 +50,7 @@ variables:
     description: Full URL to the RSVP denial page. Useful for a one-click RSVP link.
     use_value_as_example: true
     value: Rails.application.routes.url_helpers.deny_rsvp_url(Rails.application.config.action_mailer.default_url_options)
+  bus_captain_url:
+    description: Full URL to the Bus Captain page. Useful for bus captains to view & check-in passengers.
+    use_value_as_example: True
+    value: Rails.application.routes.url_helpers.bus_list_url(Rails.application.config.action_mailer.default_url_options)
diff --git a/db/seed_messages/bus_list--new_captain_confirmation.md b/db/seed_messages/bus_list--new_captain_confirmation.md
@@ -0,0 +1,16 @@
+## You're a bus captain!
+
+Hey {{first_name}},
+
+Thanks for volunteering to be a bus captain! We know most people just want to hop on &amp; off the bus, but coordinating busses isn't that easy. Thanks to you, this bus to {{hackathon_name}} can be a success!
+
+We've provided a portal to view all bus passengers for your bus, as well as provide important information about being a captain. <strong>Please take a look!</strong>
+
+<a href="{{bus_captain_url}}" class="button">Bus List »</a><br />
+<small><i>Link not working? Go to {{bus_captain_url}}</i></small>
+
+This will be the central source of truth for passengers &amp; bus information, in addition to anything you hear from our travel director.
+
+This also means your <strong>name, email, and phone number</strong> are visible to everyone riding the bus. This information is taken straight from your {{hackathon_name}} application, so please make sure it is up to date! You can check this at [{{apply_url}}]({{apply_url}})
+
+Again, thank you so much for being a bus captain! If you have any questions at all, feel free to reach out. We can't wait to see you at {{hackathon_name}}!
diff --git a/db/seed_messages/bus_list--notes_update.md b/db/seed_messages/bus_list--notes_update.md
@@ -0,0 +1,11 @@
+# Bus Update
+
+Hey {{first_name}},
+
+There's been an update to your bus - see below!
+
+As always, up-to-date bus info &amp; captains are available at [{{rsvp_url}}]({{rsvp_url}})
+
+<hr />
+
+{{bus_list_notes}}
diff --git a/db/seed_messages/user--24hr_incomplete_application.md b/db/seed_messages/user--24hr_incomplete_application.md
@@ -0,0 +1,11 @@
+## Finish Your Application
+
+You're almost there! You completed the My MLH part of the application, but didn't finish the additional {{hackathon_name}}-specific questions.
+
+<strong>Your application will not be considered until it is completed.</strong>
+
+Not to worry! Just [head on back to the website]({{apply_url}}), sign in with your existing My MLH account (if necessary), and complete the application.
+
+<a href="{{apply_url}}" class="button">Finish Application »</a>
+
+Happy hacking!<br> - The {{hackathon_name}} Team
diff --git a/db/seeds.rb b/db/seeds.rb
@@ -14,14 +14,20 @@
   "questionnaire.pending" => "Application Received",
   "questionnaire.accepted" => "You've been accepted!",
   "questionnaire.denied" => "Your application status",
-  "questionnaire.rsvp_confirmed" => "RSVP Confirmation"
+  "questionnaire.rsvp_confirmed" => "RSVP Confirmation",
+  "user.24hr_incomplete_application" => "Incomplete application",
+  "bus_list.new_captain_confirmation" => "You're a bus captain!",
+  "bus_list.update_notes" => "Bus Update"
 }
 
 name_mapping = {
   "questionnaire.pending" => "Application Received",
   "questionnaire.accepted" => "Accepted email",
   "questionnaire.denied" => "Denied email",
-  "questionnaire.rsvp_confirmed" => "RSVP confirmed email"
+  "questionnaire.rsvp_confirmed" => "RSVP confirmed email",
+  "user.24hr_incomplete_application" => "Incomplete application (24-hour reminder)",
+  "bus_list.new_captain_confirmation" => "New bus captain confirmation",
+  "bus_list.update_notes" => "Bus list update"
 }
 
 path = File.join(File.dirname(__FILE__), 'seed_messages/*.md')
diff --git a/test/controllers/mailer_test.rb b/test/controllers/mailer_test.rb
@@ -21,41 +21,25 @@ class MailerTest < ActionMailer::TestCase
   context "upon scheduled incomplete reminder email" do
     setup do
       @user = create(:user, email: "test@example.com")
+      @message = create(:message, subject: "Incomplete Application", type: 'automated', trigger: 'user.24hr_incomplete_application')
     end
 
-    should "deliver reminder email" do
-      email = Mailer.incomplete_reminder_email(@user.id).deliver_now
-
-      assert_equal ["test@example.com"],     email.to
-      assert_equal "Incomplete Application", email.subject
-      assert_match %r{example.com\/apply}, email.encoded
-    end
-  end
-
-  context "upon scheduled bus update email" do
-    setup do
-      @bus_list = create(:bus_list)
-      @questionnaire = create(:questionnaire, acc_status: 'rsvp_confirmed', bus_list_id: @bus_list.id)
-      @questionnaire.user.update_attribute(:email, "test@example.com")
-    end
-
-    should "deliver update email" do
-      email = Mailer.bus_list_update_email(@questionnaire.id).deliver_now
-
-      assert_equal ["test@example.com"], email.to
-      assert_equal "Bus Update", email.subject
-      assert_match %r{example.com\/rsvp}, email.encoded
+    should "queue reminder bulk message" do
+      assert_difference 'Sidekiq::Extensions::DelayedMailer.jobs.size', 1 do
+        Mailer.incomplete_reminder_email(@user.id).deliver_now
+      end
     end
   end
 
   context "with customized HackathonConfig" do
     setup do
       @user = create(:user, email: "test@example.com")
+      @message = create(:message, subject: "Example Subject", body: "Hello World!")
       HackathonConfig['email_from'] = 'This is a test <test@custom.example.com>'
     end
 
     should "use customized email_from" do
-      email = Mailer.incomplete_reminder_email(@user.id).deliver_now
+      email = Mailer.bulk_message_email(@message.id, @user.id).deliver_now
 
       assert_equal ["test@custom.example.com"], email.from
     end
diff --git a/test/controllers/manage/bus_lists_controller_test.rb b/test/controllers/manage/bus_lists_controller_test.rb
@@ -255,14 +255,20 @@ class Manage::BusListsControllerTest < ActionController::TestCase
 
     should "make questionnaire a bus captain" do
       questionnaire = create(:questionnaire)
-      assert_difference 'Sidekiq::Extensions::DelayedMailer.jobs.size', 1 do
-        patch :toggle_bus_captain, params: { id: @bus_list, questionnaire_id: questionnaire.id, bus_captain: '1' }
-      end
+      patch :toggle_bus_captain, params: { id: @bus_list, questionnaire_id: questionnaire.id, bus_captain: '1' }
       assert_equal true, questionnaire.reload.is_bus_captain
       assert_response :redirect
       assert_redirected_to manage_bus_list_path(@bus_list)
     end
 
+    should "send message to notify bus captain" do
+      questionnaire = create(:questionnaire)
+      create(:message, type: 'automated', trigger: 'bus_list.new_captain_confirmation')
+      assert_difference 'Sidekiq::Extensions::DelayedMailer.jobs.size', 1 do
+        patch :toggle_bus_captain, params: { id: @bus_list, questionnaire_id: questionnaire.id, bus_captain: '1' }
+      end
+    end
+
     should "remove questionnaire from being a bus captain" do
       questionnaire = create(:questionnaire)
       assert_difference 'Sidekiq::Extensions::DelayedMailer.jobs.size', 0 do
@@ -275,6 +281,7 @@ class Manage::BusListsControllerTest < ActionController::TestCase
 
     should "send email upon manage_bus_lists#send_update_email" do
       create(:questionnaire, acc_status: 'rsvp_confirmed', bus_list_id: @bus_list.id)
+      create(:message, type: 'automated', trigger: 'bus_list.notes_update')
       assert_difference 'Sidekiq::Extensions::DelayedMailer.jobs.size', 1 do
         patch :send_update_email, params: { id: @bus_list }
       end
diff --git a/test/models/message_test.rb b/test/models/message_test.rb
@@ -188,4 +188,21 @@ class MessageTest < ActiveSupport::TestCase
       assert !message.using_default_template?
     end
   end
+
+  context "for_trigger" do
+    should "return automated messages matching a given trigger" do
+      create(:message, trigger: "questionnaire.pending", subject: "Pending 1")
+      create(:message, trigger: "questionnaire.pending", subject: "Pending 2")
+      create(:message, trigger: "questionnaire.accepted", subject: "Accepted")
+      assert_equal 2, Message.for_trigger("questionnaire.pending").count
+      assert_equal 1, Message.for_trigger("questionnaire.accepted").count
+      assert_equal 0, Message.for_trigger("questionnaire.denied").count
+    end
+
+    should "raise exception for unknown triggers" do
+      assert_raise ArgumentError, "Unknowna trigger: foo" do
+        Message.for_trigger("foo")
+      end
+    end
+  end
 end
diff --git a/test/models/questionnaire_test.rb b/test/models/questionnaire_test.rb
@@ -339,10 +339,10 @@ class QuestionnaireTest < ActiveSupport::TestCase
 
     should "send triggered email for other statuses" do
       questionnaire = create(:questionnaire, acc_status: 'rsvp_denied')
-      Questionnaire::POSSIBLE_ACC_STATUS.each do |acc_status|
+      Questionnaire::POSSIBLE_ACC_STATUS.each do |acc_status, _|
         create(:message, trigger: "questionnaire.#{acc_status}")
       end
-      Questionnaire::POSSIBLE_ACC_STATUS.each do |acc_status|
+      Questionnaire::POSSIBLE_ACC_STATUS.each do |acc_status, _|
         assert_difference 'Sidekiq::Extensions::DelayedMailer.jobs.size', 1 do
           questionnaire.update_attribute(:acc_status, acc_status)
         end
