R/get_domain.R

In AdamCottrill/glfishr: Fetch fisheries assessment data from the FN Portal

#' Internal func to get the domain for the GLIS api's
#'
#' This function is intended to be used by all of the functions that call an
#' api endpoint exposed by GLIS.
#' Each of the apis are likely to have slightly different urls (tfat/api/v1,
#' fn_portal/api/v1, etc), but a common domain. If the api domain changes in
#' the future, (ie - the domain name changes or the #' version changes) we just
#' need to update the value returned by this function.
#'
#' To use a local version of GLIS api's during development of this
#' r-package, set the local environment variable GLIS_DOMAIN to the
#' complete base url (including the trailing slash) where the local
#' version of GLIS is running before calling any glfishr
#' functions. For example:
#'
#'     >  Sys.setenv(GLIS_DOMAIN="http://127.0.0.1:8000/")
#'
#' @author Adam Cottrill \email{adam.cottrill@@ontario.ca}
#'
#' @return string
#'
get_domain <- function() {
  domain <- Sys.getenv("GLIS_DOMAIN")
  if (domain == "") {
    domain <- "https://intra.glis.mnr.gov.on.ca/"
  }
  if (!grepl('^https?://.*/$', domain)) {
      msg <- sprintf("GLIS_DOMAIN:'%s' is not a valid domain. API calls will not work.",
                    domain)
      stop(msg)
  }
  return(domain)
}