R/api_status.R

In ropensci/ropensciToolkit: Helper functions for rOpenSci suite of packages

# This is required for evalWithTimeout
suppressPackageStartupMessages(library(R.utils))

#'Function to test whether an API is down and if so, throw an error.
#'
#'
#' @importFrom R.utils evalWithTimeout
#' @param test_fn The function call to test
#' @param  tlimit = 120 A timeout in seconds
#' @return logical - TRUE if API is up, FALSE if the API is down
#' @examples \dontrun{
#' library(taxize)
#' api_status(eol_search('Salix'))
#' }

api_status <- function(test_fn, tlimit = 120) {
  results <- tryCatch(expr = evalWithTimeout(test_fn, timeout = tlimit), 
                      TimeoutException = function(ex) "TimedOut")
  status <- ifelse(is(results, "TimedOut"), FALSE, TRUE)
  return( status )
}