R/AWQMS_credentials.R

In TravisPritchardODEQ/AWQMSdata: Retrieves data from Oregon DEQ water quality database AWQMS

#' Install AWQMS password and Stations database address in your `.Renviron` file for repeated use
#'
#' @description This function adds AWQMS and the server database addresses to your
#' `.Renviron` file so it can be called securely without being stored in
#' your code. After you have installed these two credentials, they can be
#' called any time with `Sys.getenv("AWQMS_Password")` or
#' `Sys.getenv("STATIONS_SERVER")`. I had some problems when on VPN that caused R to not look in the correct spot.
#' You can run readRenviron("~/.Renviron") to force read the `.Renviron` file. The query functions will run
#' `readRenviron("~/.Renviron")`to be sure it's loaded correctly. If you do not have an
#' `.Renviron` file, the function will create one for you. If you already
#' have an `.Renviron` file, the function will append the key to your
#' existing file, while making a backup of your original file for disaster
#' recovery purposes. The point of this function is to not put SQL server address in public
#' spaces such as github. The parameters used in the function MUST be kept secret.
#' This code was very heavily borrowed from the qualtRics package authored by Julia Silge and Jasper Ginn.
#' @param AWQMS_Password The password to connect to AWQMS cloud ODBC connection
#' @param STATIONS_SERVER The first three brackets of the STATIONS server address formatted in quotes. must end with .
#' Example [SERVER].[database_name].[dbo].
#' @param install If TRUE, will install the items in your `.Renviron` file
#' for use in future sessions.
#' @param overwrite If TRUE, will overwrite existing
#' credentials that you already have in your `.Renviron` file.
#' @examples
#'
#' \dontrun{
#' AWQMS_set_password(
#'    AWQMS_Password = "****",
#'   STATIONS_SERVER = "[SERVER].[database_name].[dbo].",
#'   install = TRUE
#' )
#' # Reload your environment so you can use the credentials without restarting R
#' readRenviron("~/.Renviron")
#' # You can check it with:
#' Sys.getenv("AWQMS_SERVER")
#'
#' # If you need to overwrite existing credentials:
#' AWQMS_set_password(
#'    AWQMS_Password = "****",
#'   STATIONS_SERVER = "[SERVER].[database_name].[dbo].",
#'   overwrite = TRUE,
#'   install = TRUE
#' )
#' # Reload your environment to use the credentials
#' }
#' @export


AWQMS_credentials <- function(AWQMS_usr, AWQMS_pass,
                              overwrite = FALSE,
                              install = TRUE){

  if (install) {
    home <- Sys.getenv("HOME")
    renv <- file.path(home, ".Renviron")
    if (file.exists(renv)) {
      # Backup original .Renviron before doing anything else here.
      file.copy(renv, file.path(home, paste0(".Renviron_backup_", Sys.Date())))
    }
    if (!file.exists(renv)) {
      file.create(renv)
    }
    else {
      if (isTRUE(overwrite)) {
        message("Your original .Renviron will be backed up and stored in your R HOME directory if needed.")
        oldenv <- readLines(renv)

        newenv <- oldenv[!grepl('^AWQMS_usr$|^AWQMS_pass$', oldenv)]
        writeLines(newenv, renv)
      }
      else {
        tv <- readLines(renv)
        if (any(grepl("'^AWQMS_usr$|^AWQMS_pass$'", tv))) {
          stop("User Name and Password already exist. You can overwrite them with the argument overwrite=TRUE", call. = FALSE)
        }
      }
    }

    AWQMSconcat <- paste0("AWQMS_usr = '", AWQMS_usr, "'")
    Stationsconcat <- paste0("AWQMS_pass = '", AWQMS_pass, "'")
    # Append credentials to .Renviron file
    write(AWQMSconcat, renv, sep = "\n", append = TRUE)
    write(Stationsconcat, renv, sep = "\n", append = TRUE)
    message('The Username and passwords have been stored in your .Renviron.  \nTo use now, restart R or run `readRenviron("~/.Renviron")`')
  } else {
    message("To install the addresses for use in future sessions, run this function with `install = TRUE`.")
    Sys.setenv(
      AWQMS_usr = AWQMS_usr,
      AWQMS_pass = AWQMS_pass
    )
  }
}