R/get-an-organization.R

In gitear: Client to the 'gitea' API

#' @import httr
#' @import jsonlite
#'
#' @title Returns an organization
#' @description Get information from an organization
#'
#' @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 org Name of the organization
#'
#' @export
#'
#' @examples
#' \dontrun{
#' get_an_organization(base_url = "https://example.gitea.service.com",
#'                     api_key = "ccaf5c9a22e854856d0c5b1b96c81e851bafb288",
#'                     org = "company")
#' }
get_an_organization <- function(base_url, api_key, org){
    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(org)) {
        stop("Please add a valid name of the organization")
    }
      base_url <- sub("/$", "", base_url)
      gitea_url <- file.path(base_url, "api/v1",
                               sub("^/", "", "/orgs"), org)

       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_an_organization <- fromJSON(content(r, as = "text"))
        content_an_organization <- as.data.frame(content_an_organization)

        return(content_an_organization)

}