R/token.R

In seandavi/RefineBio: The bridge between refine.bio and Bioconductor

#' Create or get an active API token for use in downloading from the API
#'
#' The API token mechanism that refine.bio uses is relatively simple.
#' There is no "authentication" per se, just an acknowledgement of
#' agreement to terms and conditions of use. The token is only needed
#' for download of data. Other functionality will work fine without it.
#'
#' @details
#' Upon calling this function the first time in a session, if a token
#' is successfully obtained and activated, it will be stored in the session
#' in memory. Further calls will use the cached value. A new R session will
#' result in a new API token.
#'
#' @export
rb_get_token <- function() {
  #    if (!.rb_has_agreed_to_tos()) {
  #        return(NULL)
  #    }
  if (!is.null(.rb_environment[["token"]])) {
    return(.rb_environment[["token"]])
  }
  # new token
  r <- httr::content(httr::POST("https://api.refine.bio", path = "/v1/token/"))
  # activate
  r <- httr::content(httr::PUT("https://api.refine.bio",
    path = sprintf("/v1/token/%s/", r$id),
    body = list(is_activated = TRUE),
    encode = "json"
  ))
  if (!r$is_activated) {
    stop("There was a problem obtaining or activating a token")
  }
  .rb_environment[["token"]] <- r$id
  r$id
}

rb_agree_to_tos <- function(agree = TRUE) {
  # TODO get TOS and report to user if interactive
  .rb_environment[["agree"]] <- agree
}

.rb_has_agreed_to_tos <- function() {
  if (!is.null(.rb_environment[["agree"]])) {
    if (.rb_environment[["agree"]]) {
      return(TRUE)
    }
  }
  FALSE
}