rgithub: github API

#' get all issues across all the authenticated user's visible repositories including owned repositories, member repositories, and organization repositories
#
#' @param ... extra parameters. See \url{http://developer.github.com/v3/issues/} for details
#'
#' @param ctx the github context object
#'
#' @return the list of issues
get.all.my.issues <- function(..., ctx = get.github.context())
  .api.get.request(ctx, c("issues"), params=list(...))

#' List all issues across owned and member repositories for the authenticated user:
#
#' @param ... extra parameters. See \url{http://developer.github.com/v3/issues/} for details
#'
#' @param ctx the github context object
#'
#' @return the list of issues
get.my.issues <- function(..., ctx = get.github.context())
  .api.get.request(ctx, c("user", "issues"), params=list(...))

#' List all issues across an organization of the authenticated user:
#'
#' @param org the organization
#'
#' @param ... extra parameters. See \url{http://developer.github.com/v3/issues/} for details
#'
#' @param ctx the github context object
#'
#' @return the list of issues
get.organization.issues <- function(org, ..., ctx = get.github.context())
  .api.get.request(ctx, c("orgs", org, "issues"), params=list(...))

#' List all issues for a repo
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param ... extra parameters. See \url{http://developer.github.com/v3/issues/} for details
#'
#' @param ctx the github context object
#'
#' @return the list of issues
get.repository.issues <- function(owner, repo, ..., ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "issues"), params=list(...))

#' Create issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param content the JSON object with the issue content. See \url{http://developer.github.com/v3/issues/#create-an-issue} for details
#'
#' @param ctx the github context object
#'
#' @return the list of issues
create.issue <- function(owner, repo, content, ctx = get.github.context())
  .api.post.request(ctx, c("repos", owner, repo, "issues"), body=content)

#' Modify issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param number the issue number
#'
#' @param content the JSON object with the issue content. See \url{http://developer.github.com/v3/issues/#edit-an-issue} for details
#'
#' @param ctx the github context object
#'
#' @return the list of issues
modify.issue <- function(owner, repo, number, content, ctx = get.github.context())
  .api.patch.request(ctx, c("repos", owner, repo, "issues", number), body=content)

################################################################################
# assignees

#' Get list of assignees for a repo
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param ctx the github context object
#'
#' @return the list of assignees
get.assignees <- function(owner, repo, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "assignees"))

#' Test if user is assignee in a repo
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param assignee the user to check
#'
#' @param ctx the github context object
#'
#' @return TRUE if user is assignee
is.assignee <- function(owner, repo, assignee, ctx = get.github.context())
  .api.test.request(ctx, c("repos", owner, repo, "assignees", assignee))

################################################################################
# comments

#' Get list of comments for an issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param number the issue number
#'
#' @param ctx the github context object
#'
#' @return the list of comments
get.issue.comments <- function(owner, repo, number, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "issues", number, "comments"))

#' Get list of comments for an issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param ... extra parameters. See \url{http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository} for details.
#'
#' @param ctx the github context object
#'
#' @return the list of comments
get.all.repository.issues.comments <- function(owner, repo, ..., ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "issues", "comments"), params=list(...))

#' Get specific comment
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the issue number
#'
#' @param comment.number the comment number
#'
#' @param ctx the github context object
#'
#' @return the comment
get.issue.comment <- function(owner, repo, issue.number, comment.number, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "issues", issue.number, "comments", comment.number))

#' Create issue comment
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the issue number
#'
#' @param content the JSON object describing the issue comment. See \url{http://developer.github.com/v3/issues/comments/#create-a-comment} for details.
#'
#' @param ctx the github context object
#'
#' @return the comment
create.issue.comment <- function(owner, repo, issue.number, content, ctx = get.github.context())
  .api.post.request(ctx, c("repos", owner, repo, "issues", issue.number, "comments"), body=content)

#' Modify issue comment
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the issue number
#'
#' @param comment.number the comment number
#'
#' @param content the JSON object describing the issue comment. See \url{http://developer.github.com/v3/issues/comments/#edit-a-comment} for details.
#'
#' @param ctx the github context object
#'
#' @return the comment
modify.issue.comment <- function(owner, repo, issue.number, comment.number, content, ctx = get.github.context())
  .api.patch.request(ctx, c("repos", owner, repo, "issues", issue.number, "comments", comment.number), body=content)

#' Delete issue comment
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the issue number
#'
#' @param comment.number the issue number
#'
#' @param ctx the github context object
#'
#' @return None
delete.issue.comment <- function(owner, repo, issue.number, comment.number, ctx = get.github.context())
  .api.delete.request(ctx, c("repos", owner, repo, "issues", issue.number, "comments", comment.number))

################################################################################
# events

#' List events for an issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the issue number
#'
#' @param ctx the github context object
#'
#' @return The event list
get.issue.events <- function(owner, repo, issue.number, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "issues", issue.number, "events"))

#' List a single event for a repository issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param event.number the event number
#'
#' @param ctx the github context object
#'
#' @return The chosen event
get.repository.issue.event <- function(owner, repo, event.number, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "issues", "events", event.number))

################################################################################
# labels

#' List all labels for a repository
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param ctx the github context object
#'
#' @return The list of labels
get.repository.labels <- function(owner, repo, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "labels"))

#' get a specific label for a repository
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param name the label name
#'
#' @param ctx the github context object
#'
#' @return The given label
get.repository.label <- function(owner, repo, name, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "labels", name))

#' create a label for a repository
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param content the JSON object describing the label. See \url{http://developer.github.com/v3/issues/labels/#create-a-label} for details.
#'
#' @param ctx the github context object
#'
#' @return The given label
create.repository.label <- function(owner, repo, content, ctx = get.github.context())
  .api.post.request(ctx, c("repos", owner, repo, "labels"), body=content)

#' edit a specific label for a repository
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param name the label name
#'
#' @param content the JSON object describing the label. See \url{http://developer.github.com/v3/issues/labels/#create-a-label} for details.
#'
#' @param ctx the github context object
#'
#' @return The given label
modify.repository.label <- function(owner, repo, name, content, ctx = get.github.context())
  .api.patch.request(ctx, c("repos", owner, repo, "labels", name), body=content)

#' delete a label from a repository
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param name the label name
#'
#' @param ctx the github context object
#'
#' @return None
delete.repository.label <- function(owner, repo, name, ctx = get.github.context())
  .api.delete.request(ctx, c("repos", owner, repo, "labels", name))

#' List all labels for an issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the number of the issue
#'
#' @param ctx the github context object
#'
#' @return The list of labels
get.issue.labels <- function(owner, repo, issue.number, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "issues", issue.number, "labels"))

#' Add labels to an issue
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the number of the issue
#'
#' @param content the list of labels
#'
#' @param ctx the github context object
#'
#' @return The list of labels
add.issue.labels <- function(owner, repo, issue.number, content, ctx = get.github.context())
  .api.post.request(ctx, c("repos", owner, repo, "issues", issue.number, "labels"), expect.code=200, body=content)

#' Delete an issue from a label
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the number of the issue
#'
#' @param name the label name
#'
#' @param ctx the github context object
#'
#' @return None
delete.issue.label <- function(owner, repo, issue.number, name, ctx = get.github.context())
  .api.delete.request(ctx, c("repos", owner, repo, "issues", issue.number, "labels", name))

#' Replace all issue labels
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the number of the issue
#'
#' @param content the new list of labels
#'
#' @param ctx the github context object
#'
#' @return The new list of labels
replace.issue.labels <- function(owner, repo, issue.number, content, ctx = get.github.context())
  .api.put.request(ctx, c("repos", owner, repo, "issues", issue.number, "labels"), body=content)

#' Delete all issue labels
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param issue.number the number of the issue
#'
#' @param ctx the github context object
#'
#' @return None
delete.all.issue.labels <- function(owner, repo, issue.number, ctx = get.github.context())
  .api.delete.request(ctx, c("repos", owner, repo, "issues", issue.number, "labels"))

#' Get labels for every issue in a milestone
#' 
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param milestone.number the number of the milestone
#'
#' @param ctx the github context object
#'
#' @return All labels for that milestone
get.milestone.labels <- function(owner, repo, milestone.number, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "milestones", milestone.number, "labels"))

################################################################################
# milestones

#' List milestones for a repository
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param ... other parameters. See \url{http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository} for details.
#'
#' @param ctx the github context object
#'
#' @return the milestone list
get.milestones <- function(owner, repo, ..., ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "milestones"), params = list(...))

#' Get specific milestone from a repository
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param milestone.number the milestone number
#'
#' @param ctx the github context object
#'
#' @return the milestone list
get.milestone <- function(owner, repo, milestone.number, ctx = get.github.context())
  .api.get.request(ctx, c("repos", owner, repo, "milestones", milestone.number))

#' Create milestone
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param content the JSON object describing the milestone. See \url{http://developer.github.com/v3/issues/milestones/#create-a-milestone} for details.
#'
#' @param ctx the github context object
#'
#' @return the created milestone
create.milestone <- function(owner, repo, content, ctx = get.github.context())
  .api.post.request(ctx, c("repos", owner, repo, "milestones"), body=content)

#' Edit milestone
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param milestone.number the milestone number
#'
#' @param content the JSON object describing the milestone. See \url{http://developer.github.com/v3/issues/milestones/#update-a-milestone} for details.
#'
#' @param ctx the github context object
#'
#' @return the created milestone
modify.milestone <- function(owner, repo, milestone.number, content, ctx = get.github.context())
  .api.patch.request(ctx, c("repos", owner, repo, "milestones", milestone.number), body=content)

#' Delete milestone
#'
#' @param owner the repo owner
#'
#' @param repo the repo name
#'
#' @param milestone.number the milestone number
#'
#' @param ctx the github context object
#'
#' @return None
delete.milestone <- function(owner, repo, milestone.number, ctx = get.github.context())
  .api.delete.request(ctx, c("repos", owner, repo, "milestones", milestone.number))