Switch to HttpClient()$retry() and document related arguments

ropensci · Dec 12, 2024 · a76f939 · a76f939
1 parent 3316062
commit a76f939
Show file tree

Hide file tree

Showing 31 changed files with 320 additions and 20 deletions.
diff --git a/R/zzz.R b/R/zzz.R
@@ -42,7 +42,7 @@ rr_GET_raw <- function(path, key = NULL, query = list(), ...) {
     opts = list(useragent = rredlist_ua()),
     headers = list(Authorization = check_key(key))
   )
-  cli$get(query = ct(query), ...)
+  cli$retry("GET", query = ct(query), ..., retry_only_on = c(429))
 }
 
 #' Handle a GET query of the IUCN API
@@ -83,7 +83,7 @@ check_internet <- function() {
 #'   code errors are found, an error is thrown.
 #' @noRd
 status_catcher <- function(res) {
-  if (res$status_code >= 300) {
+  if (res$status_code >= 400) {
     if (res$status_code == 401) {
       stop("Token not valid! (HTTP 401)", call. = FALSE)
     } else if (res$status_code == 404) {

diff --git a/man-roxygen/curl.R b/man-roxygen/curl.R
@@ -1,2 +1,12 @@
-#' @param ... [Curl options][curl::curl_options()] passed to the GET request via
-#'   [crul][crul::HttpClient()].
+#' @param ...  Includes the following arguments related to the wait time between
+#'   request retries if a "Too Many Requests" error is received from the API
+#'   (see [HttpClient()$retry()][crul::HttpClient()] for more details):
+#'   \itemize{
+#'     \item `pause_base`, `pause_cap`, and `pause_min`: basis, maximum, and minimum
+#'       for calculating wait time for retry
+#'     \item `times`: the maximum number of times to retry
+#'     \item `onwait`: a callback function if the request will be retried and a
+#'       wait time is being applied
+#'   }
+#'   Also supports any [curl options][curl::curl_options()] passed to the GET
+#'   request via [HttpClient][crul::HttpClient()].
diff --git a/man-roxygen/filters.R b/man-roxygen/filters.R
@@ -12,5 +12,15 @@
 #'       Europe). This is similar to the `region` argument of the old Red List
 #'       API and old versions of rredlist.
 #'   }
+#'   Also includes the following arguments related to the wait time between
+#'   request retries if a "Too Many Requests" error is received from the API
+#'   (see [HttpClient()$retry()][crul::HttpClient()] for more details):
+#'   \itemize{
+#'     \item `pause_base`, `pause_cap`, and `pause_min`: basis, maximum, and minimum
+#'       for calculating wait time for retry
+#'     \item `times`: the maximum number of times to retry
+#'     \item `onwait`: a callback function if the request will be retried and a
+#'       wait time is being applied
+#'   }
 #'   Also supports any [curl options][curl::curl_options()] passed to the GET
 #'   request via [HttpClient][crul::HttpClient()].
diff --git a/man/rl_actions.Rd b/man/rl_actions.Rd
diff --git a/man/rl_assessment.Rd b/man/rl_assessment.Rd
diff --git a/man/rl_categories.Rd b/man/rl_categories.Rd
diff --git a/man/rl_class.Rd b/man/rl_class.Rd
diff --git a/man/rl_comp_groups.Rd b/man/rl_comp_groups.Rd
diff --git a/man/rl_countries.Rd b/man/rl_countries.Rd
diff --git a/man/rl_extinct.Rd b/man/rl_extinct.Rd
diff --git a/man/rl_extinct_wild.Rd b/man/rl_extinct_wild.Rd
diff --git a/man/rl_family.Rd b/man/rl_family.Rd
diff --git a/man/rl_faos.Rd b/man/rl_faos.Rd
diff --git a/man/rl_green.Rd b/man/rl_green.Rd
diff --git a/man/rl_growth_forms.Rd b/man/rl_growth_forms.Rd
diff --git a/man/rl_habitats.Rd b/man/rl_habitats.Rd
diff --git a/man/rl_kingdom.Rd b/man/rl_kingdom.Rd
diff --git a/man/rl_order.Rd b/man/rl_order.Rd
diff --git a/man/rl_phylum.Rd b/man/rl_phylum.Rd
diff --git a/man/rl_pop_trends.Rd b/man/rl_pop_trends.Rd
diff --git a/man/rl_realms.Rd b/man/rl_realms.Rd
diff --git a/man/rl_research.Rd b/man/rl_research.Rd