R/pxweb_parse_response.R

In pxweb: R Interface to PXWEB APIs

#' Parse the response from a PXWEB API (advanced)
#' 
#' @description  
#' The function parses the response from a call made to a PXWEB API
#' using the \code{httr} R package. In this way it is possible to parse the 
#' content of calls made outside the pxweb R package.
#' 
#' @param x a \code{httr} response object from a PXWEB call.
#' 
#' @export
pxweb_parse_response <- function(x){
  checkmate::assert_class(x, "response")
  
  pxq <- pxweb_query(x)
  if(is.null(pxq) || pxq$response %in% c("json", "json-stat")){
    obj <- suppressWarnings(httr::content(x, as = "parsed"))
  } else if (pxq$response %in% pxweb_file_response_formats()){
    obj <- suppressWarnings(httr::content(x, as = "raw"))
    obj_path <- file.path(tempdir(), paste0(digest::sha1(obj), ".", pxq$response))
    writeBin(con = obj_path, object = obj)
    return(obj_path)
  }

  try_obj <- try(pxweb_database_list(obj), silent = TRUE)
  if(!inherits(try_obj, "try-error")) {
    try_obj <- as_pxweb_levels(try_obj)
    return(try_obj)
  }
      
  try_obj <- try(pxweb_levels(obj), silent = TRUE)
  if(!inherits(try_obj, "try-error")) return(try_obj)  
  
  try_obj <- try(pxweb_metadata(obj), silent = TRUE)
  if(!inherits(try_obj, "try-error")) return(try_obj)  

  try_obj <- try(pxweb_data(x = obj), silent = TRUE)
  if(!inherits(try_obj, "try-error")) return(try_obj)  
  
  try_obj <- try(pxweb_data_jsonstat(x = obj), silent = TRUE)
  if(!inherits(try_obj, "try-error")) return(try_obj)  
  
  stop("Incorrect return response from PXWEB API url: \n", x$url, call. = FALSE)
}


#' @rdname pxweb_parse_response
#' @export
is_pxweb_response <- function(x){
  !inherits(try(pxweb_parse_response(x), silent = TRUE), "try-error")
}