R/get_bearer.R

In academictwitteR: Access the Twitter Academic Research Product Track V2 API Endpoint

#' Manage bearer token
#'
#' This function attempts to retrieve your bearer token from the environmental variable "TWITTER_BEARER". 
#' The easiest way to setup this environmental variable is to use \code{set_bearer()} 
#' and insert your bearer token to \code{.Renviron} file following the format: TWITTER_BEARER=YOURTOKENHERE. 
#' Replace YOURTOKENHERE with your own token.
#' 
#' Note: for \code{get_bearer()} to retrieve your bearer token you will need to restart the 
#' R session after storing in \code{.Renviron}.
#' 
#' @return string represents your bearer token, if it the environmental variable "TWITTER_BEARER" has been preset.
#' @export
get_bearer <- function() {
  bearer_token <- Sys.getenv('TWITTER_BEARER')
  if (identical(bearer_token, "")) {
    stop("Please set envvar TWITTER_BEARER or supply your bearer token in every call. See ?get_bearer for more information.", call. = FALSE)
  }
  return(bearer_token)
}