hardcode encode_httr in kernel_api()

ref #429

Author: wibeasley

R/kernel-api.R

@@ -20,10 +20,10 @@
 #' [httr::POST()].
 #' This is useful for only unconventional authentication approaches.  It
 #' should be `NULL` for most institutions.
-#' @param encode_httr The value passed to the `encode` parameter of
-#' [httr::POST()].
-#' This is useful for only unconventional authentication approaches.
-#' Defaults to `"multipart"`, which is appropriate for most institutions.
+# @param encode_httr The value passed to the `encode` parameter of
+# [httr::POST()].
+# This is useful for only unconventional authentication approaches.
+# Defaults to `"multipart"`, which is appropriate for most institutions.
 #'
 #' @return
 #' A [utils::packageVersion].
@@ -58,14 +58,14 @@ kernel_api <- function(
   config_options,
   encoding            = "UTF-8",
   content_type        = "text/csv",
-  handle_httr         = NULL,
-  encode_httr         = "multipart"
+  handle_httr         = NULL
+  # encode_httr         = "multipart"
 ) {
 
   checkmate::assert_character(redcap_uri    , len = 1, any.missing = FALSE, null.ok = FALSE)
   checkmate::assert_character(encoding      , len = 1, any.missing = FALSE, null.ok = FALSE)
   checkmate::assert_character(content_type  , len = 1, any.missing = FALSE, null.ok = FALSE)
-  checkmate::assert_character(encode_httr   , len = 1, any.missing = FALSE, null.ok = FALSE)
+  # checkmate::assert_character(encode_httr   , len = 1, any.missing = FALSE, null.ok = FALSE)
 
   start_time <- Sys.time()
 
@@ -78,7 +78,7 @@ kernel_api <- function(
     body    = post_body,
     config  = config_options,
     handle  = handle_httr,
-    encode  = encode_httr,
+    encode  = "multipart",
     httr::user_agent("OuhscBbmc/REDCapR")
   )
 

R/redcap-metadata-read.R

@@ -27,6 +27,10 @@
 #' be visible somewhere public. Optional.
 #' @param config_options A list of options passed to [httr::POST()].
 #' See details at [httr::httr_options()]. Optional.
+#' @param handle_httr The value passed to the `handle` parameter of
+#' [httr::POST()].
+#' This is useful for only unconventional authentication approaches.  It
+#' should be `NULL` for most institutions.  Optional.
 #'
 #' @return
 #' Currently, a list is returned with the following elements:
@@ -74,7 +78,8 @@ redcap_metadata_read <- function(
   fields            = NULL,
   fields_collapsed  = "",
   verbose           = TRUE,
-  config_options    = NULL
+  config_options    = NULL,
+  handle_httr       = NULL
 ) {
 
   checkmate::assert_character(redcap_uri  , any.missing=FALSE, len=1, pattern="^.{1,}$")
@@ -99,7 +104,13 @@ redcap_metadata_read <- function(
   )
 
   # This is the important line that communicates with the REDCap server.
-  kernel <- kernel_api(redcap_uri, post_body, config_options)
+  kernel <-
+    kernel_api(
+      redcap_uri      = redcap_uri,
+      post_body       = post_body,
+      config_options  = config_options,
+      handle_httr     = handle_httr
+    )
 
   if (kernel$success) {
     try(

R/redcap-read-oneshot.R

@@ -88,11 +88,11 @@
 #' @param handle_httr The value passed to the `handle` parameter of
 #' [httr::POST()].
 #' This is useful for only unconventional authentication approaches.  It
-#' should be `NULL` for most institutions.
-#' @param encode_httr The value passed to the `encode` parameter of
-#' [httr::POST()].
-#' This is useful for only unconventional authentication approaches.
-#' Defaults to `"multipart"`, which is appropriate for most institutions.
+#' should be `NULL` for most institutions.  Optional.
+# @param encode_httr The value passed to the `encode` parameter of
+# [httr::POST()].
+# This is useful for only unconventional authentication approaches.
+# Defaults to `"multipart"`, which is appropriate for most institutions.
 #'
 #' @return
 #' Currently, a list is returned with the following elements:
@@ -203,8 +203,8 @@ redcap_read_oneshot <- function(
   locale                        = readr::default_locale(),
   verbose                       = TRUE,
   config_options                = NULL,
-  handle_httr                   = NULL,
-  encode_httr                   = "multipart"
+  handle_httr                   = NULL
+  # encode_httr                   = "multipart"
 ) {
 
   checkmate::assert_character(redcap_uri                , any.missing=FALSE, len=1, pattern="^.{1,}$")
@@ -237,7 +237,7 @@ redcap_read_oneshot <- function(
   checkmate::assert_class(    locale, "locale"          , null.ok = FALSE)
   checkmate::assert_logical(  verbose                   , any.missing=FALSE, len=1, null.ok=TRUE)
   checkmate::assert_list(     config_options            , any.missing=TRUE ,        null.ok=TRUE)
-  checkmate::assert_character(encode_httr               , any.missing=FALSE, len=1, null.ok = FALSE)
+  # checkmate::assert_character(encode_httr               , any.missing=FALSE, len=1, null.ok = FALSE)
 
   validate_field_names(fields, stop_on_error = TRUE)
 
@@ -283,8 +283,8 @@ redcap_read_oneshot <- function(
     post_body       = post_body,
     config_options  = config_options,
     encoding        = http_response_encoding,
-    handle_httr     = handle_httr,
-    encode_httr     = encode_httr
+    handle_httr     = handle_httr
+    # encode_httr     = encode_httr
   )
 
   if (kernel$success) {

R/redcap-read.R

@@ -96,6 +96,10 @@
 #' be visible somewhere public. Optional.
 #' @param config_options A list of options passed to [httr::POST()].
 #' See details at [httr::httr_options()]. Optional.
+#' @param handle_httr The value passed to the `handle` parameter of
+#' [httr::POST()].
+#' This is useful for only unconventional authentication approaches.  It
+#' should be `NULL` for most institutions.  Optional.
 #' @param id_position  The column position of the variable that unique
 #' identifies the subject (typically `record_id`).
 #' This defaults to the first variable in the dataset.
@@ -216,6 +220,7 @@ redcap_read <- function(
   locale                        = readr::default_locale(),
   verbose                       = TRUE,
   config_options                = NULL,
+  handle_httr                   = NULL,
   id_position                   = 1L
 ) {
 
@@ -270,7 +275,8 @@ redcap_read <- function(
     redcap_uri         = redcap_uri,
     token              = token,
     verbose            = verbose,
-    config_options     = config_options
+    config_options     = config_options,
+    handle_httr        = handle_httr
   )
 
   if (!metadata$success) {
@@ -296,7 +302,8 @@ redcap_read <- function(
     http_response_encoding     = http_response_encoding,
     locale                     = locale,
     verbose                    = verbose,
-    config_options             = config_options
+    config_options             = config_options,
+    handle_httr                = handle_httr
   )
 
   # Stop and return to the caller if the initial query failed. --------------
@@ -371,7 +378,8 @@ redcap_read <- function(
       http_response_encoding      = http_response_encoding,
       locale                      = locale,
       verbose                     = verbose,
-      config_options              = config_options
+      config_options              = config_options,
+      handle_httr                 = handle_httr
     )
 
     lst_status_code[[i]]      <- read_result$status_code