Remove mm_authorize()

NAMESPACE

@@ -1,6 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
-export(mm_authorize)
 export(mm_get)
 export(mm_get_col_info)
 export(mm_get_criteria)

R/env.R

@@ -35,7 +35,7 @@ mm_url <- function() {
 #' @keywords internal
 testing_key <- function() {
   httr2::secret_decrypt(
-    "4E5GlxeUybPJnCQQnwyDGsPIncZI526gyfk",
+    "A0RezbBRC8_7F2uGNHujFBDfSAy5hukOeWU",
     "MEGAMATION_KEY_HTTR2"
   )
 }

R/get.R

@@ -15,7 +15,7 @@
 #' @returns A data frame of class [`tbl_df`][tibble::tbl_df-class]
 #' containing the endpoint's appendix.
 #' @export
-#' @examplesIf megamation:::mm_has_creds()
+#' @examplesIf megamation:::has_creds()
 #' mm_get_col_info("status")
 mm_get_col_info <- function(endpoint) {
   description <- filter_enabled <- NULL
@@ -82,7 +82,7 @@ mm_get_labels <- function(endpoint) {
 #' @returns A data frame of class [`tbl_df`][tibble::tbl_df-class]
 #' containing the requested data.
 #' @export
-#' @examplesIf megamation:::mm_has_creds()
+#' @examplesIf megamation:::has_creds()
 #' # Get all work orders from Jan. 2023 containing trades ADMIN and IT:
 #'
 #' # First create a Date-type vector

R/request.R

@@ -5,7 +5,7 @@
 #' does the following:
 #'
 #' * Inserts the base URL using the environment variable `MEGAMATION_URL` from
-#'  your [.Renviron]. Your key and base URL can be set using [mm_authorize()].
+#'  your [.Renviron].
 #' * Appends the URL with the endpoint defined by parameter `endpoint`.
 #' * Sets the user-agent as the GitHub [megamation] package.
 #' * Authenticates the request with HTTP basic authentication using
@@ -21,7 +21,7 @@
 #' https://apidocs.megamation.com/.
 #' @returns An object of class `httr2_request`.
 #' @keywords internal
-#' @examplesIf megamation:::mm_has_creds()
+#' @examplesIf megamation:::has_creds()
 #' megamation:::mm_request("timecard")
 #' megamation:::mm_request("trade")
 mm_request <- function(endpoint) {

R/utils-check.R

@@ -1,3 +1,17 @@
+#' Are there credentials on hand?
+#'
+#' @family low-level API functions
+#' @keywords internal
+#' @returns `TRUE` if user has `MEGAMATION_KEY` and `MEGAMATION_URL` environment
+#' variables.
+has_creds <- function() {
+  creds <- c(
+    key = Sys.getenv("MEGAMATION_KEY"),
+    url = Sys.getenv("MEGAMATION_URL")
+  )
+  !any(creds == "")
+}
+
 # Are httr2 parameters well-specified
 check_params <- function(x, call = rlang::caller_env()) {
   np <- names(x)
@@ -46,8 +60,14 @@ check_creds <- function() {
 
   if (any(creds == "")) {
     cli::cli_abort(c(
-      "Megamation API key and/or URL need registering:",
-      i = "Use {.fun mm_authorize}"
+      "Missing credentials.",
+      "i" = "Run {.fun usethis::edit_r_environ} to open your `.Renviron` file.
+      Edit in these lines and restart R to apply your credentials to all
+      sessions.",
+      ">" = "`MEGAMATION_KEY = <your-key>`",
+      ">" = "`MEGAMATION_URL = <your-URL>`",
+      "i" = "`Sys.setenv()` is another option that applies only to the current
+      session."
     ))
   }
 

README.Rmd

@@ -8,12 +8,12 @@ knitr::opts_chunk$set(
   comment = "#>",
   fig.path = "man/figures/README-",
   out.width = "100%",
-  eval = megamation:::mm_has_creds()
+  eval = megamation:::has_creds()
 )
 ```
 
-```{r eval = !megamation:::mm_has_creds(), echo = FALSE, comment = NA}
-message("No credentials available. Code chunks will not be evaluated.")
+```{r eval = !megamation:::has_creds(), echo = FALSE, comment = NA}
+message("Missing credentials. Code chunks will not be evaluated.")
 ```
 
 ```{r, include = FALSE}
@@ -59,13 +59,11 @@ library(megamation)
 
 ## Authorization
 
-`mm_authorize()` installs your API credentials in your `.Renviron`, a safe place for secrets.
+Run `usethis::edit_r_environ()` to install your API credentials in your `.Renviron`, a safe place for secrets.
 
 ``` {r, eval = FALSE}
-mm_authorize(
-  key = "<YOUR-MEGAMATION_KEY>",
-  url = "<YOUR-MEGAMATION_URL>"
-)
+MEGAMATION_KEY = '<YOUR-MEGAMATION_KEY>'
+MEGAMATION_URL = '<YOUR-MEGAMATION_URL>'
 ```
 
 The following functions will automatically use your credentials, so you don't have to expose them in your code.

README.md

@@ -43,14 +43,12 @@ library(megamation)
 
 ## Authorization
 
-`mm_authorize()` installs your API credentials in your `.Renviron`, a
-safe place for secrets.
+Run `usethis::edit_r_environ()` to install your API credentials in your
+`.Renviron`, a safe place for secrets.
 
 ``` r
-mm_authorize(
-  key = "<YOUR-MEGAMATION_KEY>",
-  url = "<YOUR-MEGAMATION_URL>"
-)
+MEGAMATION_KEY = '<YOUR-MEGAMATION_KEY>'
+MEGAMATION_URL = '<YOUR-MEGAMATION_URL>'
 ```
 
 The following functions will automatically use your credentials, so you

_pkgdown.yml

@@ -30,7 +30,7 @@ reference:
       - mm_parsed_extract
       - mm_resp_extract
       - mm_pagebind
-      - mm_has_creds
+      - has_creds
       - mm_key
       - mm_url
       - mm_get_appendix