R/get-list-comments-issue.R

In gitear: Client to the 'gitea' API

#' @import httr
#' @import jsonlite
#'
#' @title Returns all comments on an issue
#' @description Returns a list of all comments on an issue
#'
#' @param base_url The base URL for your gitea server (no trailing '/')
#' @param api_key The user's API token key for the gitea service
#'
#' @param owner The owner of the repository
#' @param repo The name of the repository
#' @param id_issue Index of the issue to get comments
#'
#' @export
#'
#' @examples
#' \dontrun{
#' get_list_comments_issue(base_url = "https://example.gitea.service.com",
#'                         api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288",
#'                         owner = "company",
#'                         repo = "test_repo",
#'                         id_issue = 3)
#' }
get_list_comments_issue <- function(base_url, api_key, owner, repo, id_issue){
    if (missing(base_url)) {
        stop("Please add a valid URL")
    } else if (missing(api_key)) {
        stop("Please add a valid API token")
    } else if (missing(owner)) {
        stop("Please add a valid owner")
    } else if (missing(repo)) {
        stop("Please add a valid repository")
    } else if (missing(id_issue)) {
        stop("Please add a index of the issue")
    }

    base_url <- sub("/$", "", base_url)
    gitea_url <- file.path(base_url, "api/v1", sub("^/", "", "/repos"),
                           owner, repo, "issues", id_issue, "comments")

    authorization <- paste("token", api_key)
    r <- tryCatch(
        GET(
            gitea_url,
            add_headers(Authorization = authorization),
            accept_json()
        ),
        error = function(cond) {
            "Failure"
        }
    )

    if (class(r) != "response") {
        stop(paste0("Error consulting the url: ", gitea_url))
    }

    # To convert http errors to R errors
    stop_for_status(r)

    content_list_comments_issue <- fromJSON(content(r, as = "text"))

    return(content_list_comments_issue)

}