Update api limit value and add warning on exhaustion

NEWS.md

@@ -24,6 +24,10 @@
 
 * Added support for GitHub's versioned REST API
 
+* Increased the default value of `github_set_api_limit()` to 10,000.
+
+* Any rest API request will now report if the request limit is reached via a warning.
+
 # ghclass 0.2.1
 
 * ghclass is now on [CRAN](https://CRAN.R-project.org/package=ghclass)!

R/github_api_limit.R

@@ -30,13 +30,13 @@ NULL
 #' @export
 #'
 github_get_api_limit = function() {
-  getOption("ghclass.api.limit", 1000L)
+  getOption("ghclass.api.limit", 10000L)
 }
 
 #' @rdname github_api_limit
 #' @export
 #'
-github_set_api_limit = function(limit = 1000L) {
+github_set_api_limit = function(limit = 10000L) {
   arg_is_pos_int(limit)
   options("ghclass.api.limit" = limit)
 

R/util_github.R

@@ -200,7 +200,7 @@ ghclass_api_v3_req = function(
     limit = NULL
   }
 
-  suppressMessages(
+  res = suppressMessages(
     gh::gh(
       endpoint = endpoint,
       ...,
@@ -210,4 +210,13 @@ ghclass_api_v3_req = function(
       # .progress = FALSE # TODO - giving an error for some reason
     )
   )
+
+  if (length(res) == limit) {
+    cli::cli_warn(
+      c("The number of results is equal to the limit set by {.fn github_set_api_limit},",
+        "consider increasing this limit and rerunning the previous function.")
+    )
+  }
+
+  res
 }