code_corps v0.0.1 CodeCorps.GitHub.Sync.Comment View Source

In charge of syncing CodeCorps.Comment records with a GitHub comment payload.

A single GitHub comment always matches a single CodeCorps.GithubComment, but it can match multiple CodeCorps.Comment records. This module handles creating or updating all those records.

Link to this section Summary

Types

commit_result()

commit_result_aggregate()

Functions

delete(github_id)

Deletes CodeCorps.Comment records associated to CodeCorps.GithubComment with specified github_id

sync(task, github_comment, user)

Creates or updates a CodeCorps.Comment for the specified CodeCorps.Task

sync_github_repo(github_repo)

Creates or updates CodeCorps.Comment records for the specified CodeCorps.GithubRepo

Link to this section Types

commit_result()

commit_result() ::
  {:ok, CodeCorps.Comment.t()} |
  {:error, Ecto.Changeset.t()}

commit_result_aggregate()

commit_result_aggregate() ::
  {:ok, [CodeCorps.Comment.t()]} |
  {:error, {[CodeCorps.Comment.t()], [Ecto.Changeset.t()]}}

Link to this section Functions

delete(github_id)

delete(String.t()) :: {:ok, [CodeCorps.Comment.t()]}

Deletes CodeCorps.Comment records associated to CodeCorps.GithubComment with specified github_id

Since there can be 0 or 1 such records, returns {:ok, results} where results is a 1-element or blank list of deleted records.

sync(task, github_comment, user)

sync(CodeCorps.Task.t(), CodeCorps.GithubComment.t(), CodeCorps.User.t()) :: commit_result()

Creates or updates a CodeCorps.Comment for the specified CodeCorps.Task.

When provided a CodeCorps.Task, a CodeCorps.GithubComment, a CodeCorps.User, and a GitHub API payload, it creates or updates a CodeCorps.Comment record, using the provided GitHub API payload, associated to the specified CodeCorps.GithubComment, CodeCorps.Task and CodeCorps.User

sync_github_repo(github_repo)

sync_github_repo(CodeCorps.GithubRepo.t()) :: commit_result_aggregate()

Creates or updates CodeCorps.Comment records for the specified CodeCorps.GithubRepo.

For each CodeCorps.GithubComment record that relates to the CodeCorps.GithubRepo for a given CodeCorps.GithubRepo:

Find the related CodeCorps.Task record
Create or update the related CodeCorps.Comment record
Associate the CodeCorps.Comment record with the CodeCorps.User that relates to the CodeCorps.GithubUser for the CodeCorps.GithubComment