R/get_colombia_regions.R

In ColombiAPI: Access Colombian Data via APIs and Curated Datasets

# ColombiAPI - Access Colombian Data via APIs and Curated Datasets
# Version 0.3.1
# Copyright (C) 2025 Renzo Caceres Rossi
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.

#' Get Colombia's Regions from API Colombia
#'
#' @description
#' Retrieves comprehensive information about Colombia's six natural regions from the API Colombia service.
#' This function fetches data including region names, descriptions, and identifiers for all Colombian regions:
#' Caribe, Pacífico, Orinoquía, Amazonía, Andina, and Insular.
#'
#' @return A tibble with the following columns:
#' \itemize{
#'   \item \code{id}: Region identifier (integer)
#'   \item \code{name}: Region name (character)
#'   \item \code{description}: Detailed description of the region (character)
#' }
#'
#' @details
#' This function sends a GET request to the API Colombia service.
#' If the API request fails or returns an error status code,
#' the function returns \code{NULL} with an informative message.
#'
#' @note Requires internet connection.
#'
#' @source API Colombia: \url{https://api-colombia.com/api/v1/Region}
#'
#' @examples
#' if (interactive()) {
#'   get_colombia_regions()
#' }
#'
#' @seealso \code{\link[httr]{GET}}, \code{\link[jsonlite]{fromJSON}}, \code{\link[dplyr]{as_tibble}}
#'
#' @importFrom httr GET content
#' @importFrom jsonlite fromJSON
#' @importFrom dplyr as_tibble
#'
#' @export
get_colombia_regions <- function() {
  url <- "https://api-colombia.com/api/v1/Region"

  res <- httr::GET(url)

  if (res$status_code != 200) {
    message(paste("Error: status", res$status_code))
    return(NULL)
  }

  content <- jsonlite::fromJSON(httr::content(res, "text", encoding = "UTF-8"))

  if (length(content) == 0 || is.null(content)) {
    message("No data returned from the API Colombia service.")
    return(NULL)
  }

  df <- dplyr::as_tibble(data.frame(
    id = content$id,
    name = content$name,
    description = content$description,
    stringsAsFactors = FALSE
  ))

  return(df)
}