remove dependency on rapiclient fork

Author: stevencarlislewalker

R/iidda.api/DESCRIPTION

@@ -1,6 +1,6 @@
 Package: iidda.api
 Title: IIDDA API
-Version: 0.2.1
+Version: 0.3.0
 Authors@R: 
     person("Steve", "Walker", , "[email protected]", role = c("aut", "cre"))
 Description: R Bindings for the IIDDA API.

R/iidda.api/NAMESPACE

@@ -19,7 +19,6 @@ importFrom(iidda,parse_columns)
 importFrom(iidda,rm_trailing_slash)
 importFrom(rapiclient,get_api)
 importFrom(rapiclient,get_operations)
-importFrom(rapiclient,set_default_args_list)
 importFrom(readr,cols)
 importFrom(stats,setNames)
 importFrom(utils,assignInNamespace)

R/iidda.api/R/bindings.R

@@ -19,7 +19,7 @@ production = NULL
 #' @importFrom stats setNames
 #' @importFrom readr cols
 #' @importFrom httr content
-#' @importFrom rapiclient get_api get_operations set_default_args_list
+#' @importFrom rapiclient get_api get_operations
 #' @importFrom iidda list_xpath rm_trailing_slash
 #' @importFrom utils browseURL
 
@@ -73,7 +73,7 @@ handle_iidda_response <- function(x) {
   }
 
 make_api_obj = function(api_url, base_path, type) {
-  try(
+  api_obj = try(
     rapiclient::get_api(
       url = file.path(
         iidda::rm_trailing_slash(file.path(api_url, base_path)),
@@ -82,30 +82,10 @@ make_api_obj = function(api_url, base_path, type) {
     ),
     silent = TRUE
   )
-}
-
-our_rapiclient_fork = function() {
-  ## look for a zero-byte file in the rapiclient package. the
-  ## existence of this file would indicate that the user has
-  ## the our fork of rapiclient that supports passing vectors.
-  file.exists(system.file("canmod", package = "rapiclient"))
-}
-msg_rapiclient = function() {
-  c(
-      "Your installation of rapiclient does not support passing "
-    , "vectors to the arguments of iidda.api functions. "
-    , "If you wish to pass vectors, please follow installation "
-    , "instructions for rapiclient here: "
-    , "https://canmod.r-universe.dev/rapiclient"
-  )
-}
-check_rapiclient = function() {
-  if (!our_rapiclient_fork()) warning(msg_rapiclient())
+  return(api_obj)
 }
 
 make_ops_list = function(api_url, base_path, type) {
-  check_rapiclient()
-
   summary_to_function_name = function(x) {
     gsub(pattern = " ", replacement = "_", tolower(x))
   }
@@ -141,7 +121,7 @@ make_ops_list = function(api_url, base_path, type) {
   }
 
   for (name in names(raw_requests)) {
-    raw_requests[[name]] <- rapiclient::set_default_args_list(
+    raw_requests[[name]] <- set_default_args_list(
       raw_requests[[name]],
       parameter_list(name)
     )
@@ -158,7 +138,14 @@ make_ops_list = function(api_url, base_path, type) {
     post_request_names,
     get_request_names
   )
-  setNames(raw_requests, request_names)
+  requests = setNames(raw_requests, request_names)
+
+  ## use our .api_args function, instead of rapiclient's
+  for (method in names(requests)) {
+    assign(".api_args", .api_args, environment(requests[[method]]))
+  }
+
+  return(requests)
 }
 
 #' IIDDA API Operations

R/iidda.api/R/featured.R

@@ -25,6 +25,7 @@ NULL
 #'   , basal_disease = "poliomyelitis"
 #'   , period_end_date = "1950-01-01..1959-12-31"
 #' )
+#' head(atlantic_polio_1950s)
 #'
 #' @export
 featured_data = function(dataset_id, ...) {
@@ -60,33 +61,21 @@ featured_data = function(dataset_id, ...) {
     , dataset_ids = dataset_id
   )
   args_filter = args_filter[cnames_good]
-  if (!our_rapiclient_fork()) {
-    arg_lengths = vapply(args_filter, length, integer(1L))
-    if (any(arg_lengths > 1L)) stop(msg_rapiclient())
-  }
   args = c(args, args_filter)
   do.call(ops_staging$filter, args)[ , cnames_data, drop = FALSE]
 }
 
 roxygen_featured_params = function() {
-  if (!our_rapiclient_fork()) {
-    vec = c(
-        "ERROR: Instruction list is not available because the following "
-      , "issue occurred when building the package documentation. "
-      , msg_rapiclient()
-    )
-  } else {
-    filter_params = try(attributes(ops_staging$filter)$definition$parameters)
-    if (inherits(filter_params, "try-error")) {
-      filter_params = cached_api_list$staging$paths$`/filter`$get$parameters
-    }
-    names(filter_params) = vapply(filter_params, \(x) x$name, character(1L))
-    exclude = c("resource_type", "response_type", "dataset_ids")
-    pnames = setdiff(names(filter_params), exclude)
-    filter_params = filter_params[pnames]
-    pdesc = vapply(filter_params, \(x) x$description, character(1L))
-    vec = sprintf("\n* %s : %s", pnames, pdesc)
+  filter_params = try(attributes(ops_staging$filter)$definition$parameters)
+  if (inherits(filter_params, "try-error")) {
+    filter_params = cached_api_list$staging$paths$`/filter`$get$parameters
   }
+  names(filter_params) = vapply(filter_params, \(x) x$name, character(1L))
+  exclude = c("resource_type", "response_type", "dataset_ids")
+  pnames = setdiff(names(filter_params), exclude)
+  filter_params = filter_params[pnames]
+  pdesc = vapply(filter_params, \(x) x$description, character(1L))
+  vec = sprintf("\n* %s : %s", pnames, pdesc)
   paste(vec, collapse = "")
 }
 

R/iidda.api/R/rapiclient.R

@@ -0,0 +1,23 @@
+# modified versions of functions from rapiclient. allows us to depend
+# on official rapiclient and not our fork of it.
+
+.api_args = function(formals, environment) {
+    arg_names <- if (is.null(names(formals))) character() else names(formals)
+    arg_names <- arg_names[!arg_names %in% c("...", ".__body__")]
+    args <- mget(arg_names, environment)
+    expand_url_args = function(x) {
+      if (is.null(x)) return(x) ## silence warning about passing NULL to structure
+      structure(
+          do.call(c, lapply(x, function(z) as.list(z)))
+        , names = rep(names(x), sapply(x, length))
+      )
+    }
+    expand_url_args(args)
+}
+
+set_default_args_list <- function (f, arguments) {
+  saved_attributes = attributes(f)
+  formals(f)[names(arguments)] <- arguments
+  attributes(f) = saved_attributes
+  f
+}

R/iidda.api/R/zzz.R

@@ -12,7 +12,6 @@
       "Please re-establish connectivity, restart R, and try again."
     )
   }
-  check_rapiclient()  ## some stuff won't work if you don't use the canmod fork
   messages = lapply(messages, MakeMessage)
   ops = suppressWarnings({try(do.call(make_ops_list, production), silent = TRUE)})
   ops_local = suppressWarnings({try(do.call(make_ops_list, local), silent = TRUE)})