R/orion_auth.R

In JohnCoene/oRion: Integrate R & Cheetah Mobile Orion

#' orionAuthenticate
#' 
#' @description Authenticate the Orion API.
#' 
#' @param client.id Your \code{client_id}
#' @param client.secret Your \code{client_secret}
#' @param grant.type Currently only supports \code{client_credentials} 
#' (default)
#' @param save If \code{TRUE} will save the token for future sessions, 
#' default to \code{FALSE}
#' 
#' @details Please see the 
#' \href{http://api.ori.cmcm.com/doc/#api-Auth-access_token}{official documentation} 
#' to apply for the API and 
#' get your \code{client_id} and \code{client_secret}: 
#' \url{api.ori.cmcm.com/doc/#api-Auth-access_token}. If the token is stored 
#' (\code{save = TRUE}) then \code{orionOAuth} does not need to be run in 
#' future sessions, see example.
#' 
#' @examples 
#' \dontrun{
#' # authenticate
#' orionOAuth(client.id = 0000,
#'            client.secret = "0x00000000x00x0x000xxx0000x0xx0")
#'            
#' # test
#' camp_oauth <- listCampaigns()
#'            
#' # authenticate and save
#' orionOAuth(client.id = 0000,
#'            client.secret = "0x00000000x00x0x000xxx0000x0xx0", 
#'            save = TRUE)
#'            
#' # detach and unload package
#' detach("package:oRion", unload = TRUE)
#' 
#' # no oauth
#' library(oRion)
#' camp_noauth <- listCampaigns()
#' 
#' identical(camp_oauth, camp_noauth)
#' }
#' 
#' @author John Coene \email{jcoenep@@gmail.com}
#' 
#' @export
orionOAuth <- function (client.id, client.secret,
                        grant.type = "client_credentials", save = FALSE) {
  # check required inputs
  if (missing(client.id)){
    stop("must specify client.id", call. = FALSE)
  } else if (missing(client.secret)){
    stop("must specify client.secret", call. = FALSE)
  } else if (grant.type != "client_credentials"){
    stop("currently grant.type only supports 'client_credentials'")
  }
  # POST
  uri <- paste0(getOption("base_url"), "/", file.path("oauth", "access_token"))
  response <- httr::POST(uri, encode = "multipart",
                         body = list(grant_type = grant.type,
                                     client_id = client.id,
                                     client_secret = client.secret))
  # parse
  return <- jsonlite::fromJSON(rawToChar(response$content))
  testReturn(return)
  constructCred(return, pars = list(client.id = client.id,
                                    client.secret = client.secret))
  message("authentication successful")
  if (save == TRUE){
    credentials <- get("credentials", envir = cred_env)
    credentials$client.id <- charToRaw(as.character(credentials$client.id))
    credentials$client.secret <- charToRaw(as.character(credentials$client.secret))
    save(credentials, file = ".orionToken")
  }
}