Merge pull request #1075 from code-corps/928-add-info-to-github-issue-when-codecorps-user-created-via-bot

Add info to GitHub issue when codecorps user created via bot

Author: joshsmith

lib/code_corps/comment/service.ex

@@ -17,7 +17,23 @@ defmodule CodeCorps.Comment.Service do
 
   require Logger
 
-  @preloads [:user, :github_comment, task: [:github_issue, github_repo: :github_app_installation]]
+  # :user, :github_issue and :github_repo are required for connecting to github
+  # :project and :organization are required in order to add a header to the
+  # github comment body when the user themselves are not connected to github,
+  # but the parent task is
+  #
+  # Right now, all of these preloads are loaded at once. If there are
+  # performance issues, we can split them up according the the information
+  # provided here.
+  @preloads [
+    :github_comment,
+    :user,
+    task: [
+      :github_issue,
+      [github_repo: :github_app_installation],
+      [project: :organization]
+    ]
+  ]
 
   @doc ~S"""
   Creates a `Comment` record using the provided parameters
@@ -55,8 +71,6 @@ defmodule CodeCorps.Comment.Service do
     {:error, :github}
   end
 
-  @preloads [task: [:github_issue, github_repo: :github_app_installation]]
-
   @spec create_on_github(Comment.t) :: {:ok, Comment.t} :: {:error, GitHub.api_error_struct}
   defp create_on_github(%Comment{task: %Task{github_issue_id: nil}} = comment), do: {:ok, comment}
   defp create_on_github(%Comment{task: %Task{github_issue: github_issue}} = comment) do

lib/code_corps/emails/forgot_password_email.ex

@@ -2,7 +2,7 @@ defmodule CodeCorps.Emails.ForgotPasswordEmail do
   import Bamboo.Email
   import Bamboo.PostmarkHelper
 
-  alias CodeCorps.Emails.BaseEmail
+  alias CodeCorps.{Emails.BaseEmail, WebClient}
 
   def create(user, token) do
     BaseEmail.create
@@ -13,8 +13,7 @@ defmodule CodeCorps.Emails.ForgotPasswordEmail do
   defp template_id, do: Application.get_env(:code_corps, :postmark_forgot_password_template)
 
   defp link(token) do
-    :code_corps
-    |> Application.get_env(:site_url)
+    WebClient.url()
     |> URI.merge("password/reset?token=#{token}")
     |> URI.to_string
   end

lib/code_corps/emails/organization_invite_email.ex

@@ -2,7 +2,7 @@ defmodule CodeCorps.Emails.OrganizationInviteEmail do
     import Bamboo.Email
     import Bamboo.PostmarkHelper
 
-    alias CodeCorps.{Emails.BaseEmail, OrganizationInvite}
+    alias CodeCorps.{Emails.BaseEmail, OrganizationInvite, WebClient}
 
     def create(%OrganizationInvite{} = invite) do
       BaseEmail.create
@@ -19,7 +19,7 @@ defmodule CodeCorps.Emails.OrganizationInviteEmail do
     end
 
     defp invite_url(code, organization_name) do
-      Application.get_env(:code_corps, :site_url)
+      WebClient.url()
       |> URI.merge("/invites/organization" <> "?" <> set_params(code, organization_name))
       |> URI.to_string
     end

lib/code_corps/emails/project_user_acceptance_email.ex

@@ -2,7 +2,7 @@ defmodule CodeCorps.Emails.ProjectUserAcceptanceEmail do
   import Bamboo.Email
   import Bamboo.PostmarkHelper
 
-  alias CodeCorps.{Project, ProjectUser, Repo, User}
+  alias CodeCorps.{Project, ProjectUser, Repo, User, WebClient}
   alias CodeCorps.Emails.BaseEmail
   alias CodeCorps.Presenters.ImagePresenter
 
@@ -26,8 +26,7 @@ defmodule CodeCorps.Emails.ProjectUserAcceptanceEmail do
   defp preload(%Project{} = project), do: project |> Repo.preload(:organization)
 
   defp url(project) do
-    :code_corps
-    |> Application.get_env(:site_url)
+    WebClient.url()
     |> URI.merge(project.organization.slug <> "/" <> project.slug)
     |> URI.to_string
   end

lib/code_corps/emails/receipt_email.ex

@@ -3,7 +3,7 @@ defmodule CodeCorps.Emails.ReceiptEmail do
   import Bamboo.PostmarkHelper
 
   alias CodeCorps.Emails.BaseEmail
-  alias CodeCorps.{DonationGoal, Project, Repo, StripeConnectCharge, StripeConnectSubscription}
+  alias CodeCorps.{DonationGoal, Project, Repo, StripeConnectCharge, StripeConnectSubscription, WebClient}
 
   def create(%StripeConnectCharge{} = charge, %Stripe.Invoice{} = invoice) do
     with %StripeConnectCharge{} = charge <- preload(charge),
@@ -77,8 +77,7 @@ defmodule CodeCorps.Emails.ReceiptEmail do
   end
 
   defp url(project) do
-    :code_corps
-    |> Application.get_env(:site_url)
+    WebClient.url()
     |> URI.merge(project.organization.slug <> "/" <> project.slug)
     |> URI.to_string
   end

lib/code_corps/github/adapters/comment.ex

@@ -1,12 +1,13 @@
 defmodule CodeCorps.GitHub.Adapters.Comment do
-  @moduledoc """
-  Adapts a GitHub payload into attributes for creating or updating a
-  `CodeCorps.GithubComment` record.
+  @moduledoc ~S"""
+  Used to convert between  GitHub data which represents a GitHub Issue Comment
+  and `CodeCorps.Comment` as well as `CodeCorps.GithubComment` attributes.
   """
 
   alias CodeCorps.{
     Adapter.MapTransformer,
-    Comment
+    Comment,
+    GitHub.Adapters.Utils.BodyDecorator
   }
 
   @mapping [
@@ -15,19 +16,15 @@ defmodule CodeCorps.GitHub.Adapters.Comment do
     {:modified_at, ["updated_at"]}
   ]
 
-  @spec from_api(map) :: map
-  def from_api(%{} = payload) do
-    payload |> MapTransformer.transform(@mapping)
-  end
-
-  @autogenerated_github_keys ~w(created_at id updated_at)
-
-  @spec to_api(Comment.t) :: map
-  def to_api(%Comment{} = comment) do
-    comment
-    |> Map.from_struct
-    |> MapTransformer.transform_inverse(@mapping)
-    |> Map.drop(@autogenerated_github_keys)
+  @doc ~S"""
+  Converts a Github Issue Comment payload into a set of attributes suitable to
+  create or update a `CodeCorps.Comment`
+  """
+  @spec to_comment(map) :: map
+  def to_comment(%{} = payload) do
+    payload
+    |> BodyDecorator.remove_code_corps_header()
+    |> MapTransformer.transform(@mapping)
   end
 
   @github_comment_mapping [
@@ -40,11 +37,26 @@ defmodule CodeCorps.GitHub.Adapters.Comment do
   ]
 
   @doc ~S"""
-  Adapts the GitHub payload into attributes for creating or updating a
-  `CodeCorps.GithubComment` record.
+  Converts a GitHub Issue Comment payload into a set of attributes suitable for
+  creating or updating a `CodeCorps.GithubComment`
   """
   @spec to_github_comment(map) :: map
   def to_github_comment(%{} = payload) do
     payload |> MapTransformer.transform(@github_comment_mapping)
   end
+
+  @autogenerated_github_keys ~w(created_at id updated_at)
+
+  @doc ~S"""
+  Converts a `CodeCorps.Comment` into a set of attributes suitable to create or
+  update an GitHub Issue Comment through the GitHub API.
+  """
+  @spec to_api(Comment.t) :: map
+  def to_api(%Comment{} = comment) do
+    comment
+    |> Map.from_struct
+    |> MapTransformer.transform_inverse(@mapping)
+    |> Map.drop(@autogenerated_github_keys)
+    |> BodyDecorator.add_code_corps_header(comment)
+  end
 end

lib/code_corps/github/adapters/issue.ex

@@ -6,10 +6,12 @@ defmodule CodeCorps.GitHub.Adapters.Issue do
 
   alias CodeCorps.{
     Adapter.MapTransformer,
-    GithubIssue
+    GitHub.Adapters.Utils.BodyDecorator,
+    GithubIssue,
+    Task
   }
 
-  @mapping [
+  @issue_mapping [
     {:body, ["body"]},
     {:closed_at, ["closed_at"]},
     {:comments_url, ["comments_url"]},
@@ -27,25 +29,50 @@ defmodule CodeCorps.GitHub.Adapters.Issue do
   ]
 
   @doc ~S"""
-  Converts a GitHub Issue payload into a set of attributes used to update or
-  create a `GithubIssue` record.
+  Converts a GitHub Issue payload into a set of attributes used to create or
+  update a `GithubIssue` record.
   """
-  @spec from_api(map) :: map
-  def from_api(%{} = payload) do
-    payload |> MapTransformer.transform(@mapping)
+  @spec to_issue(map) :: map
+  def to_issue(%{} = payload) do
+    payload |> MapTransformer.transform(@issue_mapping)
+  end
+
+  @task_mapping [
+    {:created_at, ["created_at"]},
+    {:markdown, ["body"]},
+    {:modified_at, ["updated_at"]},
+    {:status, ["state"]},
+    {:title, ["title"]}
+  ]
+
+  @doc ~S"""
+  Converts a GitHub Issue payload into a set of attributes used to create or
+  update a `Task` record.
+  """
+  @spec to_task(map) :: map
+  def to_task(%{} = payload) do
+    payload |> MapTransformer.transform(@task_mapping)
   end
 
   @autogenerated_github_keys ~w(closed_at comments_url created_at events_url html_url id labels_url number updated_at url)
 
   @doc ~S"""
-  Converts a `GithubIssue` into a set of attributes used to update or create an
-  associated GitHub Issue.
+  Converts a `GithubIssue` or `Task` into a set of attributes used to create or
+  update an associated GitHub Issue on the GitHub API.
   """
-  @spec to_api(GithubIssue.t) :: map
+  @spec to_api(GithubIssue.t | Task.t) :: map
   def to_api(%GithubIssue{} = github_issue) do
     github_issue
     |> Map.from_struct
-    |> MapTransformer.transform_inverse(@mapping)
+    |> MapTransformer.transform_inverse(@issue_mapping)
+    |> Map.drop(@autogenerated_github_keys)
+    |> BodyDecorator.add_code_corps_header(github_issue)
+  end
+  def to_api(%Task{} = task) do
+    task
+    |> Map.from_struct
+    |> MapTransformer.transform_inverse(@task_mapping)
     |> Map.drop(@autogenerated_github_keys)
+    |> BodyDecorator.add_code_corps_header(task)
   end
 end

lib/code_corps/github/adapters/task.ex

@@ -0,0 +1,46 @@
+defmodule CodeCorps.GitHub.Adapters.Utils.BodyDecorator do
+  @moduledoc ~S"""
+  Decorates and undecorates the body of GitHub issues and comments as needed.
+  """
+
+  alias CodeCorps.{
+    Comment,
+    Task,
+    User,
+    WebClient
+  }
+
+  @separator "\r\n\r\n[//]: # (Please type your edits below this line)\r\n\r\n---"
+  @linebreak "\r\n\r\n"
+
+  @spec add_code_corps_header(map, Comment.t | Task.t) :: map
+  def add_code_corps_header(%{"body" => body} = attrs, %Comment{user: %User{github_id: nil}} = comment) do
+    modified_body = build_header(comment) <> @separator <> @linebreak <> body
+    attrs |> Map.put("body", modified_body)
+  end
+  def add_code_corps_header(%{"body" => body} = attrs, %Task{user: %User{github_id: nil}} = task) do
+    modified_body = build_header(task) <> @separator <> @linebreak <> body
+    attrs |> Map.put("body", modified_body)
+  end
+  def add_code_corps_header(%{} = attrs, _), do: attrs
+
+  @spec build_header(Comment.t | Task.t) :: String.t
+  defp build_header(%Comment{task: %Task{} = task, user: %User{} = user}), do: do_build_header(task, user)
+  defp build_header(%Task{user: %User{} = user} = task), do: do_build_header(task, user)
+
+
+  @spec do_build_header(Task.t, User.t) :: String.t
+  defp do_build_header(%Task{} = task, %User{username: username} = user) do
+    "Posted by [**#{username}**](#{user |> WebClient.url}) from [Code Corps](#{task |> WebClient.url})"
+  end
+
+  @spec remove_code_corps_header(map) :: map
+  def remove_code_corps_header(%{"body" => body} = attrs) when is_binary(body) do
+    clean_body = case body |> String.split(@separator) do
+      ["Posted by" <> _rest | tail] -> tail |> Enum.join |> String.trim_leading
+      _ -> body
+    end
+    attrs |> Map.put("body", clean_body)
+  end
+  def remove_code_corps_header(%{} = attrs), do: attrs
+end

lib/code_corps/github/adapters/utils/body_decorator.ex

@@ -43,7 +43,7 @@ defmodule CodeCorps.GitHub.Event.IssueComment.ChangesetBuilder do
     %User{} = user) do
 
     comment
-    |> Changeset.cast(CommentAdapter.from_api(attrs), @create_attrs)
+    |> Changeset.cast(CommentAdapter.to_comment(attrs), @create_attrs)
     |> MarkdownRendererService.render_markdown_to_html(:markdown, :body)
     |> Changeset.put_change(:created_from, "github")
     |> Changeset.put_change(:modified_from, "github")
@@ -57,7 +57,7 @@ defmodule CodeCorps.GitHub.Event.IssueComment.ChangesetBuilder do
   @spec update_changeset(Comment.t, map) :: Changeset.t
   defp update_changeset(%Comment{} = comment, %{} = attrs) do
     comment
-    |> Changeset.cast(CommentAdapter.from_api(attrs), @update_attrs)
+    |> Changeset.cast(CommentAdapter.to_comment(attrs), @update_attrs)
     |> MarkdownRendererService.render_markdown_to_html(:markdown, :body)
     |> Changeset.put_change(:modified_from, "github")
     |> TimeValidator.validate_time_after(:modified_at)

lib/code_corps/github/event/issue_comment/changeset_builder.ex

@@ -14,7 +14,7 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilder do
     User,
     Validators.TimeValidator
   }
-  alias CodeCorps.GitHub.Adapters.Task, as: TaskAdapter
+  alias CodeCorps.GitHub.Adapters.Issue, as: IssueAdapter
   alias Ecto.Changeset
 
   @doc ~S"""
@@ -50,7 +50,7 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilder do
       TaskList |> Repo.get_by(project_id: project_id, inbox: true)
 
     task
-    |> Changeset.cast(TaskAdapter.from_api(issue_attrs), @create_attrs)
+    |> Changeset.cast(IssueAdapter.to_task(issue_attrs), @create_attrs)
     |> MarkdownRendererService.render_markdown_to_html(:markdown, :body)
     |> Changeset.put_change(:created_from, "github")
     |> Changeset.put_change(:modified_from, "github")
@@ -71,7 +71,7 @@ defmodule CodeCorps.GitHub.Event.Issues.ChangesetBuilder do
   @spec update_changeset(Task.t, map) :: Changeset.t
   defp update_changeset(%Task{} = task, %{} = issue_attrs) do
     task
-    |> Changeset.cast(TaskAdapter.from_api(issue_attrs), @update_attrs)
+    |> Changeset.cast(IssueAdapter.to_task(issue_attrs), @update_attrs)
     |> MarkdownRendererService.render_markdown_to_html(:markdown, :body)
     |> Changeset.put_change(:modified_from, "github")
     |> TimeValidator.validate_time_after(:modified_at)