feat(doApiQuery): add check for the limitation of 20000 records

- add functionnality and test

Closes ##5

DESCRIPTION

@@ -17,3 +17,6 @@ Imports:
     urltools
 RoxygenNote: 7.1.1
 Roxygen: list(markdown = TRUE)
+Suggests: 
+    testthat (>= 3.0.0)
+Config/testthat/edition: 3

R/doApiQuery.R

@@ -86,6 +86,10 @@ doApiQuery <- function(api,
       }
     } else {
       l <- httr::content(resp, "parsed")
+      if (as.numeric(l$count) > 20000) {
+        stop("The request reach the API limitation of 20000 records.\n",
+             "Use filter arguments to reduce the number of records of your request.")
+      }
       data <- c(data, l$data)
       if (resp$status_code == 206) {
         query <- l$`next`

man/doApiQuery.Rd

@@ -38,7 +38,7 @@ Pagination of the queries is handled automatically and the returned \link{list}
 \details{
 The function \code{get_available_params} returns the list of available query parameters for a given operation in an API.
 
-The functions \verb{get_[api]_[operation]} call the function \code{doQueryApi} and convert the response in a convenient format for the user (\link{data.frame} or \link{tibble})
+The functions \verb{get_[api]_[operation]} call the function \code{doQueryApi} and convert the response in a convenient format for the user (\link{data.frame} or \link[tibble:tibble]{tibble::tibble})
 }
 \examples{
 # To get the available APIs in the package

tests/testthat.R

+library(testthat)
+library(hubeau)
+
+test_check("hubeau")

tests/testthat/test-doApiQuery.R

+test_that("A query of more than 20000 records", {
+  expect_error(doApiQuery("indicateurs_services", "communes", params = list()),
+               regexp = "The request reach the API limitation of 20000 records")
+})