Error on named NA, ignore named NULL

Closes #21, closes #84.

R/package.R

@@ -29,7 +29,8 @@
 #'    to `"GET"`.
 #' @param ... Name-value pairs giving API parameters. Will be matched
 #'   into `endpoint` placeholders, sent as query parameters in GET
-#'   requests, and as a JSON body of POST requests.
+#'   requests, and as a JSON body of POST requests. Named `NULL` values
+#'   are silently dropped, and named `NA` values trigger an error.
 #' @param per_page Number of items to return per page. If omitted,
 #'   will be substituted by `max(.limit, 100)` if `.limit` is set,
 #'   otherwise determined by the API (never greater than 100).
@@ -118,6 +119,8 @@ gh <- function(endpoint, ..., per_page = NULL, .token = NULL, .destfile = NULL,
                ) {
 
   params <- list(...)
+  params <- drop_named_nulls(params)
+  check_named_nas(params)
 
   if (is.null(per_page)) {
     if (!is.null(.limit)) {

R/utils.R

@@ -63,3 +63,23 @@ probe <- function(.x, .p, ...) {
     vapply(.x, .p, logical(1), ...)
   }
 }
+
+drop_named_nulls <- function(x) {
+  if (has_no_names(x)) return(x)
+  named <- has_name(x)
+  null <- vapply(x, is.null, logical(1))
+  cleanse_names(x[! named | ! null])
+}
+
+check_named_nas <- function(x) {
+  if (has_no_names(x)) return(x)
+  named <- has_name(x)
+  na <- vapply(x, FUN.VALUE = logical(1), function(v) {
+    is.atomic(v) && anyNA(v)
+  })
+  bad <- which(named & na)
+  if (length(bad)) {
+    str <- paste0("`", names(x)[bad], "`", collapse = ", ")
+    stop("Named NA parameters are not allowed: ", str)
+  }
+}

inst/NEWS.md

@@ -5,6 +5,8 @@
    argument
 -  gh now sets `.Last.error` to the error object after an uncaught error,
    and `.Last.error.trace` to the stack trace of the error.
+-  `gh()` now silently drops named `NULL` parameters, and throws an
+   error for named `NA` parameters (#21, #84).
 
 # 1.0.1
 

tests/testthat/test-na-null.R

@@ -0,0 +1,43 @@
+
+test_that("named NULL is dropped", {
+
+  tcs <- list(
+    list(list(), list()),
+    list(list(a = 1), list(a = 1)),
+    list(list(NULL), list(NULL)),
+    list(list(a = NULL), list()),
+    list(list(NULL, a = NULL, 1), list(NULL, 1)),
+    list(list(a = NULL, b = 1, 5), list(b = 1, 5))
+  )
+
+  for (tc in tcs) {
+    expect_identical(
+      drop_named_nulls(tc[[1]]),
+      tc[[2]],
+      info = tc
+    )
+  }
+})
+
+test_that("named NA is error", {
+
+  goodtcs <- list(
+    list(),
+    list(NA),
+    list(NA, NA_integer_, a = 1)
+  )
+
+  badtcs <- list(
+    list(b = NULL, a = NA),
+    list(a = NA_integer_),
+    list(NA, c = NA_real_)
+  )
+
+  for (tc in goodtcs) {
+    expect_silent(check_named_nas(tc))
+  }
+
+  for (tc in badtcs) {
+    expect_error(check_named_nas(tc))
+  }
+})