Rework the logic for sending emails

joshsmith · joshsmith · commit 59a8674ae35f · 2017-12-20T12:54:09.000-08:00
diff --git a/config/dev.exs b/config/dev.exs
@@ -60,12 +60,14 @@ config :code_corps, CodeCorps.Mailer, adapter: Bamboo.LocalAdapter
 
 config :code_corps,
   postmark_forgot_password_template: "123",
+  postmark_message_initiated_by_project_template: "123",
   postmark_organization_invite_email_template: "123",
   postmark_project_approval_request_template: "123",
   postmark_project_approved_template: "123",
   postmark_project_user_acceptance_template: "123",
   postmark_project_user_request_template: "123",
-  postmark_receipt_template: "123"
+  postmark_receipt_template: "123",
+  postmark_reply_to_conversation_template: "123"
 
 # If the dev environment has no CLOUDEX_API_KEY set, we want the app
 # to still run, with cloudex in test API mode
diff --git a/config/prod.exs b/config/prod.exs
@@ -61,12 +61,14 @@ config :code_corps, CodeCorps.Mailer,
 
 config :code_corps,
   postmark_forgot_password_template: "1989483",
+  postmark_message_initiated_by_project_template: "4324242",
   postmark_organization_invite_email_template: "3441863",
   postmark_project_approval_request_template: "4105824",
   postmark_project_approved_template: "4105822",
   postmark_project_user_acceptance_template: "1447041",
   postmark_project_user_request_template: "4017262",
-  postmark_receipt_template: "1255222"
+  postmark_receipt_template: "1255222",
+  postmark_reply_to_conversation_template: "4324082"
 
 # ## SSL Support
 #
diff --git a/config/remote-development.exs b/config/remote-development.exs
@@ -44,12 +44,14 @@ config :code_corps, CodeCorps.Mailer,
 
 config :code_corps,
   postmark_forgot_password_template: "123",
+  postmark_message_initiated_by_project_template: "123",
   postmark_organization_invite_email_template: "123",
   postmark_project_approval_request_template: "123",
   postmark_project_approved_template: "123",
   postmark_project_user_acceptance_template: "123",
   postmark_project_user_request_template: "123",
-  postmark_receipt_template: "123"
+  postmark_receipt_template: "123",
+  postmark_reply_to_conversation_template: "123"
 
 # ## SSL Support
 #
diff --git a/config/staging.exs b/config/staging.exs
@@ -60,12 +60,14 @@ config :code_corps, CodeCorps.Mailer,
 
 config :code_corps,
   postmark_forgot_password_template: "1989481",
+  postmark_message_initiated_by_project_template: "4324241",
   postmark_organization_invite_email_template: "3442401",
   postmark_project_approval_request_template: "4105823",
   postmark_project_approved_template: "4105744",
   postmark_project_user_acceptance_template: "1447022",
   postmark_project_user_request_template: "4017261",
-  postmark_receipt_template: "1252361"
+  postmark_receipt_template: "1252361",
+  postmark_reply_to_conversation_template: "4324243"
 
 # ## SSL Support
 #
diff --git a/config/test.exs b/config/test.exs
@@ -66,12 +66,14 @@ config :code_corps, CodeCorps.Mailer,
 
 config :code_corps,
   postmark_forgot_password_template: "123",
+  postmark_message_initiated_by_project_template: "123",
   postmark_organization_invite_email_template: "123",
   postmark_project_approval_request_template: "123",
   postmark_project_approved_template: "123",
   postmark_project_user_acceptance_template: "123",
   postmark_project_user_request_template: "123",
-  postmark_receipt_template: "123"
+  postmark_receipt_template: "123",
+  postmark_reply_to_conversation_template: "123"
 
 config :code_corps, :cloudex, CloudexTest
 config :cloudex, api_key: "test_key", secret: "test_secret", cloud_name: "test_cloud_name"
diff --git a/emails/message_initiated_by_project.html b/emails/message_initiated_by_project.html
diff --git a/emails/reply_to_conversation.html b/emails/reply_to_conversation.html
@@ -3,7 +3,7 @@
   <head>
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-    <title>You have a new message from {{name}}.</title>
+    <title>{{author_name}} replied to your conversation in {{project_title}}.</title>
     <!--
     Make sure you copy the styles from styles.css into the email template in Postmark before saving there.
 
@@ -13,7 +13,7 @@
     <link rel="stylesheet" type="text/css" href="styles.css" media="screen" />
   </head>
   <body>
-    <span class="preheader">You have a new message from {{name}}.</span>
+    <span class="preheader">{{author_name}} replied to your conversation in {{project_title}}.</span>
     <table class="email-wrapper" width="100%" cellpadding="0" cellspacing="0">
       <tr>
         <td align="center">
@@ -44,9 +44,9 @@
                             <p class="center">
                               <img src="https://d3pgew4wbk2vb1.cloudfront.net/emails/images/message@2x.png" width="100" height="100" />
                             </p>
-                            <p>Hi {{project_title}} team,</p>
-                            <p>You have a new message from {{name}}.</p>
-                            <p><a class="button" href="{{conversation_url}}">See your message</a></p>
+                            <p>Hi {{name}},</p>
+                            <p>{{author_name}} replied to your conversation in {{project_title}}.</p>
+                            <p><a class="button" href="{{conversation_url}}">See your conversation</a></p>
                           </td>
                         </tr>
                       </table>
diff --git a/lib/code_corps/emails/message_initiated_by_project_email.ex b/lib/code_corps/emails/message_initiated_by_project_email.ex
@@ -1,4 +1,4 @@
-defmodule CodeCorps.Emails.MessageForUserEmail do
+defmodule CodeCorps.Emails.MessageInitiatedByProjectEmail do
   import Bamboo.Email, only: [to: 2]
   import Bamboo.PostmarkHelper
 
@@ -19,15 +19,15 @@ defmodule CodeCorps.Emails.MessageForUserEmail do
     BaseEmail.create
     |> to(user.email)
     |> template(template_id(), %{
-      conversation_url: conversation |> conversation_url,
-      project_title: project.title,
+      conversation_url: conversation |> conversation_url(),
       name: user.first_name,
+      project_title: project.title,
       subject: "You have a new message from #{project.title}"
     })
   end
 
   @spec template_id :: String.t
-  defp template_id, do: Application.get_env(:code_corps, :postmark_message_for_user_template)
+  defp template_id, do: Application.get_env(:code_corps, :postmark_message_initiated_by_project_template)
 
   @spec conversation_url(Conversation.t) :: String.t
   defp conversation_url(%Conversation{id: id}) do
diff --git a/lib/code_corps/emails/reply_to_conversation_email.ex b/lib/code_corps/emails/reply_to_conversation_email.ex
@@ -1,9 +1,10 @@
-defmodule CodeCorps.Emails.MessageForProjectEmail do
+defmodule CodeCorps.Emails.ReplyToConversationEmail do
   import Bamboo.Email, only: [to: 2]
   import Bamboo.PostmarkHelper
 
   alias CodeCorps.{
     Conversation,
+    ConversationPart,
     Emails.BaseEmail,
     Message,
     Organization,
@@ -12,24 +13,31 @@ defmodule CodeCorps.Emails.MessageForProjectEmail do
     WebClient
   }
 
-  @spec create(Message.t, Conversation.t, User.t) :: Bamboo.Email.t
+  @spec create(ConversationPart.t, User.t) :: Bamboo.Email.t
   def create(
-    %Message{project: %Project{} = project},
-    %Conversation{} = conversation,
+    %ConversationPart{
+      author: %User{} = author,
+      conversation: %Conversation{
+        message: %Message{
+          project: %Project{} = project
+        }
+      } = conversation
+    },
     %User{} = user) do
 
     BaseEmail.create
     |> to(user.email)
     |> template(template_id(), %{
+      author_name: author.first_name,
       conversation_url: project |> conversation_url(conversation),
       name: user.first_name,
       project_title: project.title,
-      subject: "#{user.first_name} has posted a reply on #{project.title}"
+      subject: "#{author.first_name} replied to your conversation in #{project.title}"
     })
   end
 
   @spec template_id :: String.t
-  defp template_id, do: Application.get_env(:code_corps, :postmark_message_for_project_template)
+  defp template_id, do: Application.get_env(:code_corps, :postmark_reply_to_conversation_template)
 
   @spec conversation_url(Project.t, Conversation.t) :: String.t
   defp conversation_url(
diff --git a/lib/code_corps/messages/emails.ex b/lib/code_corps/messages/emails.ex
@@ -3,7 +3,6 @@ defmodule CodeCorps.Messages.Emails do
   Handles email notifications used within the Messages context
   """
   alias CodeCorps.{
-    Conversation,
     ConversationPart,
     Emails,
     Mailer,
@@ -14,23 +13,23 @@ defmodule CodeCorps.Messages.Emails do
   @message_preloads [:project, [conversations: :user]]
 
   @doc ~S"""
-  Notifies all relevant users of a new `CodeCorps.Message` being created.
+  Notifies all the recipients of a new `CodeCorps.Message`.
 
-  We match against admin initiated messages only, because it's unclear who
-  message.author is for user-initiated messages, or who the email recipient
-  would be, assuming the message.author is the user who initiated the message.
+  Target recipients are found in the `user` relationship of each
+  `CodeCorps.Conversation`.
   """
-  @spec notify_of_new_message(Message.t) :: :ok
-  def notify_of_new_message(%Message{initiated_by: "admin"} = message) do
+  @spec notify_message_targets(Message.t) :: :ok
+  def notify_message_targets(%Message{initiated_by: "admin"} = message) do
     message = message |> Repo.preload(@message_preloads)
 
     message
     |> Map.get(:conversations)
-    |> Enum.map(&Emails.MessageForUserEmail.create(message, &1))
+    |> Enum.map(&Emails.MessageInitiatedByProjectEmail.create(message, &1))
     |> Enum.each(&Mailer.deliver_now/1)
   end
 
-  @part_preloads [
+  @cpart_preloads [
+    :author,
     conversation: [
       [conversation_parts: :author],
       [message: [:author, [project: :organization]]],
@@ -39,55 +38,36 @@ defmodule CodeCorps.Messages.Emails do
   ]
 
   @doc ~S"""
-  Notifies via email all relevant users when a new `CodeCorps.ConvrsationPart`
-  has been added to a `CodeCorps.Conversation`.
+  Notifies users via email when a `CodeCorps.ConversationPart` has been added
+  to a `CodeCorps.Conversation`.
+
+  Sends to users participating in the conversation, excluding the author of the
+  conversation part.
   """
-  @spec notify_of_new_reply(ConvrsationPart.t) :: :ok
+  @spec notify_of_new_reply(ConversationPart.t) :: :ok
   def notify_of_new_reply(%ConversationPart{} = part) do
-    part = part |> Repo.preload(@part_preloads)
-
-    part |> maybe_send_message_for_user_email()
-    part |> send_message_for_project_emails()
+    part = part |> Repo.preload(@cpart_preloads)
+    part |> send_reply_to_conversation_emails()
   end
 
   # we match against admin initiated only, because it's unclear who
   # message.author is for user-initiated messages, or who the email recipient
   # would be, assuming the message.author is the user who initiated the message
-  @spec send_message_for_project_emails(ConversationPart.t) :: :ok
-  defp send_message_for_project_emails(%ConversationPart{
-    conversation: %Conversation{
-      message: %Message{initiated_by: "admin"} = message
-      } = conversation
-  } = part) do
-
+  @spec send_reply_to_conversation_emails(ConversationPart.t) :: :ok
+  defp send_reply_to_conversation_emails(%ConversationPart{} = part) do
     part
-    |> get_project_participants()
-    |> Enum.map(&Emails.MessageForProjectEmail.create(message, conversation, &1))
+    |> get_conversation_participants()
+    |> Enum.map(&Emails.ReplyToConversationEmail.create(part, &1))
     |> Enum.each(&Mailer.deliver_now/1)
   end
 
-  # we match against admin initiated only, because it's unclear who
-  # message.author is for user-initiated messages, or who the email recipient
-  # would be, assuming the message.author is the user who initiated the message
-  @spec maybe_send_message_for_user_email(ConversationPart.t) :: Bambo.Email.t | nil
-  defp maybe_send_message_for_user_email(%ConversationPart{
-    author_id: replier_id,
-    conversation: %Conversation{
-      user_id: conversation_target_id,
-      message: %Message{initiated_by: "admin"} = message
-    } = conversation
-  }) when replier_id != conversation_target_id do
-
-    message
-    |> Emails.MessageForUserEmail.create(conversation)
-    |> Mailer.deliver_now
-  end
-  defp maybe_send_message_for_user_email(%ConversationPart{}), do: nil
-
-  @spec get_project_participants(ConversationPart.t) :: list(User.t)
-  defp get_project_participants(%ConversationPart{author_id: author_id} = part) do
-    part.conversation.conversation_parts |> Enum.map(&Map.get(&1, :author))
+  @spec get_conversation_participants(ConversationPart.t) :: list(User.t)
+  defp get_conversation_participants(%ConversationPart{author_id: author_id} = part) do
+    part.conversation.conversation_parts
+    |> Enum.map(&Map.get(&1, :author))
+    |> Enum.concat([part.conversation.user])
     |> Enum.concat([part.conversation.message.author])
     |> Enum.reject(fn u -> u.id == author_id end)
+    |> Enum.uniq()
   end
 end
diff --git a/lib/code_corps/messages/messages.ex b/lib/code_corps/messages/messages.ex
@@ -71,7 +71,7 @@ defmodule CodeCorps.Messages do
   @spec create(map) :: {:ok, Message.t} | {:error, Changeset.t}
   def create(%{} = params) do
     with {:ok, %Message{} = message} <- %Message{} |> create_changeset(params) |> Repo.insert() do
-      message |> Messages.Emails.notify_of_new_message
+      message |> Messages.Emails.notify_message_targets()
       {:ok, message}
     else
       {:error, %Changeset{} = changeset} -> {:error, changeset}
@@ -92,8 +92,7 @@ defmodule CodeCorps.Messages do
   @spec add_part(map) :: {:ok, ConversationPart.t} | {:error, Changeset.t}
   def add_part(%{} = params) do
     with {:ok, %ConversationPart{} = conversation_part} <- params |> Messages.ConversationParts.create do
-      conversation_part |> Messages.Emails.notify_of_new_reply
-
+      conversation_part |> Messages.Emails.notify_of_new_reply()
       {:ok, conversation_part}
     else
       {:error, %Changeset{} = changeset} -> {:error, changeset}
diff --git a/lib/code_corps/model/conversation.ex b/lib/code_corps/model/conversation.ex
@@ -27,7 +27,7 @@ defmodule CodeCorps.Conversation do
     timestamps()
   end
 
-  def update_changeset(struct, %{"status" => status} = params) do
+  def update_changeset(struct, %{} = params) do
     struct
     |> cast(params, [:status])
     |> validate_inclusion(:status, statuses())
diff --git a/priv/repo/structure.sql b/priv/repo/structure.sql
@@ -2,8 +2,8 @@
 -- PostgreSQL database dump
 --
 
--- Dumped from database version 10.0
--- Dumped by pg_dump version 10.0
+-- Dumped from database version 10.1
+-- Dumped by pg_dump version 10.1
 
 SET statement_timeout = 0;
 SET lock_timeout = 0;
diff --git a/test/lib/code_corps/emails/message_for_project_email_test.exs b/test/lib/code_corps/emails/message_for_project_email_test.exs
diff --git a/test/lib/code_corps/emails/message_initiated_by_project_email_test.exs b/test/lib/code_corps/emails/message_initiated_by_project_email_test.exs
@@ -1,15 +1,15 @@
-defmodule CodeCorps.Emails.MessageForUserEmailTest do
+defmodule CodeCorps.Emails.MessageInitiatedByProjectEmailTest do
   use CodeCorps.DbAccessCase
   use Bamboo.Test
 
-  alias CodeCorps.Emails.MessageForUserEmail
+  alias CodeCorps.Emails.MessageInitiatedByProjectEmail
 
   test "email works" do
     %{message: message} = conversation =
       insert(:conversation)
       |> Repo.preload([[message: :project], :user])
 
-    email = MessageForUserEmail.create(message, conversation)
+    email = MessageInitiatedByProjectEmail.create(message, conversation)
     assert email.from == "Code Corps<team@codecorps.org>"
     assert email.to == conversation.user.email
 
diff --git a/test/lib/code_corps/emails/reply_to_conversation_email_test.exs b/test/lib/code_corps/emails/reply_to_conversation_email_test.exs
diff --git a/test/lib/code_corps/messages/messages_test.exs b/test/lib/code_corps/messages/messages_test.exs
