feat: Added vcr to Suggests and in unit tests for openFDA, as well as use in openFDA() roxygen docs

Author: simpar1471

.gitattributes

@@ -0,0 +1,2 @@
+* text=auto
+tests/fixtures/**/* -diff

DESCRIPTION

@@ -15,9 +15,9 @@ License: GPL (>= 3)
 URL: https://github.com/simpar1471/openFDA,
     https://simpar1471.github.io/openFDA/
 BugReports: https://github.com/simpar1471/openFDA/issues
-Depends:
+Depends: 
     R (>= 4.1.0)
-Imports:
+Imports: 
     cli,
     httr2,
     checkmate,
@@ -27,11 +27,12 @@ Imports:
     prettyunits,
     keyring
 Config/Needs/website: rmarkdown
-Suggests: 
+Suggests:
     knitr,
     rmarkdown,
+    stringr,
     testthat (>= 3.0.0),
-    stringr
+    vcr (>= 0.6.0)
 Config/testthat/edition: 3
 Config/testthat/start-first: options
 Encoding: UTF-8

R/api_key.R

@@ -11,6 +11,9 @@
 #'   the number of requests on a per-IP address basis, as well as on a per-key
 #'   basis).
 #' @examples
+#' \dontshow{
+#'   try(prior_api_key <- get_api_key(), silent = TRUE)
+#' }
 #' # Set your openFDA API key with `set_api_key()`
 #' api_key <- "example_api_key"
 #' set_api_key(api_key)
@@ -20,6 +23,9 @@
 #'
 #' # An error will be thrown you try to set your API key to an empty string.
 #' try(set_api_key(""))
+#' \dontshow{
+#'   try(set_api_key(api_key = prior_api_key), silent = TRUE)
+#' }
 #' @section Setting an openFDA API key:
 #' API keys are the sort of thing that should be stored securely. For that
 #' reason, `set_api_key()` and `get_api_key()` utilise the

R/openFDA.R

@@ -134,28 +134,27 @@
 #'     [httr2](https://httr2.r-lib.org/) response object without printing a
 #'     warning.
 #' @examples
-#' if (httr2::secret_has_key("OPENFDA_KEY")) {
-#'   set_api_key(httr2::secret_decrypt(
-#'     "TEaDtqdFMq9_Montij5p9IY6T57IyqkbF8IYFVOpk-ttxotFUNdJSxgccAnkq4nQhplaf-r3deQ",
-#'     "OPENFDA_KEY"
-#'   ))
-#'
-#'   resp <- openFDA(search = "openfda.manufacturer_name:gilead*",
-#'                   limit = 2,
-#'                   skip = 10,
-#'                   paging = "never",
-#'                   paging_verbosity = "quiet")
-#'
-#'   # The function returns an `httr2` object
-#'   print(resp)
+#' \dontshow{
+#'   vcr::insert_example_cassette("openFDA_examples", package = "openFDA")
 #' }
+#' resp <- openFDA(search = "openfda.manufacturer_name:gilead*",
+#'                 limit = 2,
+#'                 skip = 10,
+#'                 paging = "never",
+#'                 paging_verbosity = "quiet")
+#'
+#' # The function returns an `httr2` object
+#' print(resp)
 #'
 #' # Bad inputs will cause informative errors - here, a bad API key is supplied
 #' try(
 #'   openFDA(search = "openfda.manufacturer_name:gilead*",
 #'           api_key = "BAD_API_KEY",
 #'           limit = 1)
 #' )
+#' \dontshow{
+#'   vcr::eject_cassette()
+#' }
 #' @references
 #' Kass-Hout TA, Xu Z, Mohebbi M, Nelsen H, Baker A, LEvine J, Johansen E,
 #' Bright RA. **OpenFDA: an innovative platform providing access to a wealth of
@@ -379,7 +378,7 @@ openFDA_err_400_msg <- function(resp) {
 #' @rdname openFDA_http_errors
 #' @noRd
 openFDA_err_403_msg <- function(resp) {
-  api_key <- httr2::url_parse(resp$url)$query$api_key
+  api_key <- rlang::env_get(rlang::caller_env(7), nm = "api_key")
   c("The openFDA API returned a 403 error.",
     "!" = "This usually means that an invalid {.var api_key} was used.",
     "i" = cli::format_inline("Your API key was {.val {api_key}}."))