R/rs_bundle.R

In appeears: Interface to 'AppEEARS' NASA Web Services

#' AppEEARS list of bundled files to download
#'
#' Returns a data frame of all data ready for download as one bundle
#'
#' @param user username used to sign up
#' @param task_id task id for which to return the file download bundle
#' @return returns a nested list of files to download
#'
#' @export
#' @author Koen Hufkens
#' @examples
#'
#' \dontrun{
#' # get a list of datasets
#' rs_bundle(
#' user = "your_user_name",
#' task_id = "a_task_id"
#' )
#'}

rs_bundle <- function(
    task_id,
    user
){

  # retrieve token to list tasks
  token <- rs_login(user)

  # get bundle (can't take more than 30 seconds)
  response <- httr::GET(
      file.path(rs_server(),"bundle", task_id),
      httr::add_headers(
          Authorization = paste("Bearer", token)
        ),
      httr::timeout(30)
      )

  # trap general http error
  if (httr::http_error(response)) {
    stop(
      "      Your requested download is unavailable as the session expired\n
      (download > 48h old), or your connection timed out!",
      call. = FALSE
    )
  }

  # split out the content from the returned
  # API data, and clean up the JSON formatting
  ct <- httr::content(response)

  # return content
  return(ct)
}