diff --git a/DESCRIPTION b/DESCRIPTION index 778a186..444685c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -37,6 +37,6 @@ URL: https://github.com/DOI-USGS/sbtools, https://doi-usgs.github.io/sbtools/ BugReports: https://github.com/DOI-USGS/sbtools/issues RoxygenNote: 7.3.2 VignetteBuilder: knitr -Config/testthat/parallel: true +Config/testthat/parallel: false Config/testthat/edition: 3 Encoding: UTF-8 diff --git a/NAMESPACE b/NAMESPACE index 9eac835..9b08d19 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -10,6 +10,8 @@ export(as.sbitem) export(authenticate_sb) export(current_session) export(folder_create) +export(get_cached_token) +export(get_username) export(identifier_exists) export(initialize_sciencebase_session) export(is.sbitem) @@ -54,6 +56,7 @@ export(session_expired) export(session_renew) export(session_validate) export(set_endpoint) +export(token_stache_path) export(user_id) import(httr) import(jsonlite) diff --git a/NEWS.md b/NEWS.md index 829d636..9cf8e20 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,6 +2,9 @@ - removed `items_create()`, `items_upsert()`, and `items_update()` as they are no longer supported by sciencebase. - Fixed bugs related to sciencebase updates. +- added `get_username()` as exported function. +- added `get_cached_token()` as exported function. +- added `token_stache_path()` as exported function. # version 1.3.2 diff --git a/R/authenticate_sb.R b/R/authenticate_sb.R index c30d231..8e00ac8 100644 --- a/R/authenticate_sb.R +++ b/R/authenticate_sb.R @@ -1,5 +1,7 @@ -#' Authenticate to SB for subsequent calls +#' Authenticate to SB for subsequent calls [DEPRECATED] +#' +#' THIS AUTHENTICATION METHOD NO LONGER WORKS FOR INDIVIDUAL LOGIN SESSIONS #' #' This connects to SB, authenticates and gets a session token for communicating #' with SB. If you do not supply a username or password, you will be prompted to @@ -88,6 +90,20 @@ authenticate_sb = function(username, password){ return(invisible(TRUE)) } +#' Get or set ScienceBase username +#' @description +#' Used to retrieve the current user name. Will request the username be entered +#' if no user is provided and `interactive()` is TRUE. +#' +#' This is largely an internal function, but is exported for awareness and +#' use in automated pipelines. +#' +#' @param username character if NULL, will be retrieved from the `sb_user` +#' environment variable or the `username` file stored at `token_stache_path()` +#' @return character string containing a username. Throws an error if no +#' username is found and `interactive()` is FALSE +#' @export +#' get_username <- function(username = NULL) { if(is.null(username)) { @@ -98,6 +114,17 @@ get_username <- function(username = NULL) { return(username) } + username_file <- file.path(dirname(token_stache_path()), "username") + + if(file.exists(username_file)) { + username <- readLines(username_file, 1) + } + + if(username != "") { + pkg.env$username <- username + return(username) + } + if(interactive()) { username = readline('Please enter your username:') @@ -106,11 +133,11 @@ get_username <- function(username = NULL) { stop('Empty username supplied, stopping') } - }else { + } else { stop("username required for authentication") + } - # username <- try(session_details()$username) } pkg.env$username <- username @@ -148,7 +175,9 @@ set_keycloak_env <- function(token_resp) { #' If the token text is provided as input, no popup prompt will be raised. #' #' @param username email address of sciencebase user. Will be retrieved from the -#' `sb_user` environment variable if set. A prompt will be raised if not provided. +#' `sb_user` environment variable if set or retrieved from a `username` file cached +#' in the `token_text` directory. A prompt will be raised if not provided. +#' #' @export #' initialize_sciencebase_session <- function(username = NULL, token_text = NULL) { @@ -157,7 +186,7 @@ initialize_sciencebase_session <- function(username = NULL, token_text = NULL) { if(is.null(token_text)) { - token <- gsub("[\r\n]", "", grab_token()) + token <- get_cached_token() if(token != "") { check_current <- try( @@ -184,7 +213,7 @@ initialize_sciencebase_session <- function(username = NULL, token_text = NULL) { worked <- try(initialize_keycloack_env(token_text)) if(!inherits(worked, "try-error")) { - stache_token(token_text) + stache_token(username, token_text) return(invisible(TRUE)) } else { return(invisible(FALSE)) @@ -213,19 +242,26 @@ clean_session <- function() { } #' Get or set token stache data directory -#' @description if left unset, will return the user data dir -#' as returned by `tools::R_user_dir` for this package. -#' @param dir path of desired token stache file +#' @description Will check the `SBTOOLS_TOKEN_STACHE` environment variable +#' and will check if the `token_stache_path` has been set durring the current +#' session previously. If the environment variable or session-variable are not +#' found, returns `file.path(tools::R_user_dir(package = "sbtools"), "token")`. +#' @param dir path of desired token stache file. See description for behavior +#' if left unset. #' @return character path of data directory (silent when setting) #' @importFrom tools R_user_dir -#' @noRd +#' @export #' token_stache_path <- function(dir = NULL) { if(is.null(dir)) { - token_stache <- try(get("token_stache", envir = pkg.env), silent = TRUE) - - if(inherits(token_stache, "try-error")) { + token_stache <- Sys.getenv("SBTOOLS_TOKEN_STACHE") + + if(token_stache == "") { + token_stache <- try(get("token_stache", envir = pkg.env), silent = TRUE) + } + + if(inherits(token_stache, "try-error") | token_stache == "") { assign("token_stache", file.path(tools::R_user_dir(package = "sbtools"), "token"), envir = pkg.env) @@ -239,19 +275,26 @@ token_stache_path <- function(dir = NULL) { return(invisible(get("token_stache", envir = pkg.env))) } - } -stache_token <- function(token_text) { +stache_token <- function(username, token_text) { dir.create(dirname(token_stache_path()), recursive = TRUE, showWarnings = FALSE) + write(username, file = file.path(dirname(token_stache_path()), "username")) write(token_text, file = token_stache_path()) } -grab_token <- function() { + +#' get cached sciencebase token +#' @description +#' tries to retrieve a cached token from `token_stache_path()` +#' @return character containing the token (which may be stale) or an empty string +#' @export +get_cached_token <- function() { if(file.exists(token_stache_path())) { - readChar(token_stache_path(), file.info(token_stache_path())$size) + gsub("[\r\n]", "", + readChar(token_stache_path(), file.info(token_stache_path())$size)) } else { "" } diff --git a/_pkgdown.yml b/_pkgdown.yml index 8c8660e..0479385 100644 --- a/_pkgdown.yml +++ b/_pkgdown.yml @@ -16,6 +16,9 @@ reference: - '`set_endpoint`' - '`user_id`' - '`is_logged_in`' + - '`get_username`' + - '`get_cached_token`' + - '`token_stache_path`' - title: Item Operations - contents: - '`sbitem`' diff --git a/docs/404.html b/docs/404.html index 981ddce..5cc837e 100644 --- a/docs/404.html +++ b/docs/404.html @@ -20,7 +20,7 @@ sbtools - 1.3.2 + 1.4.0 + + + + + +
+
+
+ +

get cached sciencebase token

+ Source: R/authenticate_sb.R +
get_cached_token.Rd
+
+ +
+

tries to retrieve a cached token from `token_stache_path()`

+
+ +
+

Usage

+ 
get_cached_token()
+
+ +
+

Value

+

character containing the token (which may be stale) or an empty string

+
+ +
+ + +
+

Developed by David Blodgett, Luke Winslow.

+
+ +
+

Site built with pkgdown 2.1.1.

+
+ +
+ + + + + + + diff --git a/docs/reference/get_username.html b/docs/reference/get_username.html new file mode 100644 index 0000000..2837165 --- /dev/null +++ b/docs/reference/get_username.html @@ -0,0 +1,89 @@ + +get or set sciencebase username — get_username • sbtools + Skip to contents + + +
+
+
+ +

get or set sciencebase username

+ Source: R/authenticate_sb.R +
get_username.Rd
+
+ +
+

Used to retrieve the current user name. Will request the username be entered +if no user is provided and `interactive()` is TRUE.

+

This is largely an internal function, but is exported for awareness and +use in automated pipelines.

+
+ +
+

Usage

+ 
get_username(username = NULL)
+
+ +
+

Arguments

+ + +
username
+

character if NULL, will be retrieved from the `sb_user` +environment variable or the `username` file stored at `token_stache_path()`

+ +
+
+

Value

+

character string containing a username. Throws an error if no +username is found and `interactive()` is FALSE

+
+ +
+ + +
+

Developed by David Blodgett, Luke Winslow.

+
+ +
+

Site built with pkgdown 2.1.1.

+
+ +
+ + + + + + + diff --git a/docs/reference/identifier_exists.html b/docs/reference/identifier_exists.html index e650291..5e00716 100644 --- a/docs/reference/identifier_exists.html +++ b/docs/reference/identifier_exists.html @@ -13,7 +13,7 @@ sbtools - 1.3.2 + 1.4.0 + + + + + +
+
+
+ +

Get or set token stache data directory

+ Source: R/authenticate_sb.R +
token_stache_path.Rd
+
+ +
+

Will check the `SBTOOLS_TOKEN_STACHE` environment variable +and will check if the `token_stache_path` has been set durring the current +session previously. If the environment variable or session-variable are not +found, returns `file.path(tools::R_user_dir(package = "sbtools"), "token")`.

+
+ +
+

Usage

+ 
token_stache_path(dir = NULL)
+
+ +
+

Arguments

+ + +
dir
+

path of desired token stache file. See description for behavior +if left unset.

+ +
+
+

Value

+

character path of data directory (silent when setting)

+
+ +
+ + +
+

Developed by David Blodgett, Luke Winslow.

+
+ +
+

Site built with pkgdown 2.1.1.

+
+ +
+ + + + + + + diff --git a/docs/reference/user_id.html b/docs/reference/user_id.html index 6c1241c..8229f88 100644 --- a/docs/reference/user_id.html +++ b/docs/reference/user_id.html @@ -7,7 +7,7 @@ sbtools - 1.3.2 + 1.4.0