R/api-path.R

In MTES-MCT/didor: Tools to Explore and Download CGDD/SDES Opendata

default_api_base_path <-
  "https://data.statistiques.developpement-durable.gouv.fr/dido/api/v1"

#' Get API base path
#'
#' @description
#'
#' Get the API base path. Can be configured with `set_api_base_path` and with
#'    `DIDOLITE_API_BASE_PATH` env var. Order is :
#' 1. if set_api_base_path has been used
#' 2. `DIDOLITE_API_BASE_PATH`
#' 3. the default default_api_base_path
#'
#' @return the api base path
#' @export
#'
#' @examples
#' get_api_base_path()
get_api_base_path <- function() {
  if (exists("api_base_path", envir = .dido_env)) {
    return(get("api_base_path", envir = .dido_env))
  }

  base_path <- Sys.getenv("DIDOLITE_API_BASE_PATH")
  if (base_path != "") {
    return(base_path)
  }

  default_api_base_path
}

#' Set API base path
#'
#' @description
#'
#' set a new API base path to use
#'
#' @param path or NULL the path to set or NULL to use to default path.
#'  * if set to non `NULL`, set the value as path
#'  * if `NULL` set the default path
#'  `https://data.statistiques.developpement-durable.gouv.fr/dido/api/v1`
#'
#'  @details this function delete the cache.
#'
#' @return the previous path
#' @export
#'
#' @examples
#' # to set some new path
#' set_api_base_path("http://localhost/api/v1")
set_api_base_path <- function(path = NULL) {
  old_path <- get_api_base_path()
  clean_dido_env()

  if (!is.null(path)) {
    assign("api_base_path", path, envir = .dido_env)
  }
  invisible(old_path)
}

clean_dido_env <- function() {
  rm(list = ls(envir = .dido_env), envir = .dido_env)
}