R/ping.R

In PecanProject/rpecanapi: R Library that interacts with the PEcAn API

##' Pings the PEcAn API server (using the URL passed in the server object)
##' to see if it is live or not. Hits the `/api/ping` API endpoint
##'
##' @name ping
##' @title Pings the PEcAn API server to see if it is live
##' @param server Server object obtained using the connect() function 
##' @return Response obtained from the `/api/ping` endpoint
##' @author Tezan Sahu
##' @export
##' @examples
##' server <- connect(url="http://pecan.localhost:80", username="carya", password="illinois")
##' res <- ping(server)

ping <- function(server){
  tryCatch(
    expr = {
      res <- httr::GET(paste0(server$url, "/api/ping"))
      if(res$status_code == 200){
        return(jsonlite::fromJSON(rawToChar(res$content)))
      }
      else{
        stop("Sorry! Server not responding.")
      }
    },
    error = function(e) {
      message('Sorry! Server not responding.')
    }
  )
}