DP-92: Add in verbose option for all functions that lead to an API …

…call (#65)

* add in verbose option

* Minor bug fix

* Linting

* Add `verbose` option to `getDataValueSets`

* Add `verbose` option to `getSqlView`

* Update getMetadata.Rd

Co-authored-by: Christopher Nemarich <[email protected]>

R/callDATIMapi.R

@@ -7,12 +7,13 @@
 #' default will not try again
 #' @param timeout how long should a reponse be waited for
 #' @param api_version defaults to current but can pass in version number
+#' @param verbose return raw content with data
 #' @return Result of DATIM API query returned as named list.
 #'
 api_get <- function(path,
                     d2_session,
                     retry = 1, timeout = 60,
-                    api_version = NULL) {
+                    api_version = NULL, verbose = FALSE) {
 
   base_url <- d2_session$base_url
   handle <- d2_session$handle
@@ -129,10 +130,16 @@ api_get <- function(path,
   }
 
   # extract text response from api response
-  resp <- jsonlite::fromJSON(httr::content(resp, as = "text"),
+  content <- jsonlite::fromJSON(httr::content(resp, as = "text"),
     simplifyDataFrame = TRUE,
     flatten = TRUE
   )
 
-  return(resp)
+  if (verbose) {
+    return(list("data" = content, "api_responses" = resp))
+  } else {
+    return(content)
+  }
+
+
 }

R/getAnalytics.R

@@ -20,6 +20,7 @@
 #' @param d2_session the d2Session object, default is "d2_default_session",
 #' it will be made upon logining in to datim with loginToDATIM
 #' @param retry retry
+#' @param verbose return raw content with data
 #' @return data frame with the rows of the response
 
 getAnalytics <-  function(...,
@@ -31,7 +32,8 @@ getAnalytics <-  function(...,
                           return_names = FALSE,
                           d2_session = dynGet("d2_default_session", inherits = TRUE),
                           retry = 1,
-                          timeout = 60) {
+                          timeout = 60,
+                          verbose = FALSE) {
 
   # cap time out at 5 minutes
   if (timeout > 300) {
@@ -78,7 +80,13 @@ getAnalytics <-  function(...,
   resp <- api_get(path = path,
                   d2_session = d2_session,
                   retry = retry,
-                  timeout = timeout)
+                  timeout = timeout,
+                  verbose = verbose)
+
+  if (verbose) {
+    meta_data <- resp$api_responses
+    resp <- resp$data
+  }
 
   if (NROW(resp$rows) == 0) {
     return(NULL)
@@ -103,8 +111,11 @@ getAnalytics <-  function(...,
 
   #change data types to numeric where possible
   resp[, coercions == "NUMBER"] <- sapply(resp[, coercions == "NUMBER"], as.numeric)
-
-  return(resp)
+  if (verbose) {
+    return(list("data" = resp, "api_responses" = meta_data))
+  } else {
+    return(resp)
+  }
 }
 
 

R/getDataValueSets.R

@@ -10,13 +10,15 @@
 #'  with DATIM
 #' @param retry number of times to retry
 #' @param timeout number of seconds to wait during call
+#' @param verbose return raw content with data
 #' @return  Data frame with the data requested
 #'
 getDataValueSets <- function(variable_keys = NULL, #keys,
                              variable_values = NULL, #values,
                              d2_session = dynGet("d2_default_session",
                                                  inherits = TRUE),
-                             retry = 1, timeout = 180) {
+                             retry = 1, timeout = 180,
+                             verbose = FALSE) {
 
   #Test that the provided variables have their associated values used for
   # munging
@@ -77,10 +79,21 @@ getDataValueSets <- function(variable_keys = NULL, #keys,
       path = path,
       d2_session = d2_session,
       retry = retry,
-      timeout = timeout
+      timeout = timeout,
+      verbose = verbose
     )
 
+    if (verbose) {
+      meta_data <- resp$api_responses
+      resp <- resp$data
+    }
+
     #Create Dataframe from api response
     resp <- as.data.frame(resp$dataValues, stringsAsFactors = FALSE)
 
+    if (verbose) {
+      return(list("data" = resp, "api_responses" = meta_data))
+    } else {
+      return(resp)
+    }
 }

R/getMetadata.R

@@ -79,6 +79,7 @@ simplifyStructure <- function(resp) {
 #' it will be made upon logining in to datim with loginToDATIM
 #' @param retry number of times to retry
 #' @param timeout integer - seconds to wait for a response, default = 180
+#' @param verbose return raw content with data
 #' @return the metadata response in json format and flattened
 #'
 
@@ -89,7 +90,7 @@ getMetadata <- function(end_point,
                         d2_session = dynGet("d2_default_session",
                                             inherits = TRUE),
                         retry = 1,
-                        timeout = 180) {
+                        timeout = 180, verbose = FALSE) {
   if (!is.character(fields)) {
     stop("The fields argument of getMetadata should be of type character")
   }
@@ -125,9 +126,15 @@ getMetadata <- function(end_point,
   resp <- api_get(
     path = path, d2_session = d2_session, retry = retry,
     timeout = timeout,
-    api_version = NULL
+    api_version = NULL,
+    verbose = verbose
   )
 
+  if (verbose) {
+    meta_data <- resp$api_responses
+    resp <- resp$data
+  }
+
    # simplify data structure
   resp <- simplifyStructure(resp)
 
@@ -151,10 +158,18 @@ getMetadata <- function(end_point,
           fixed = TRUE
         )
     )) {
-    return(resp[[1]])
+    if (verbose) {
+      return(list("data" = resp[[1]], "api_responses" = meta_data))
+    } else {
+      return(resp[[1]])
+    }
   }
 
-  return(resp)
+  if (verbose) {
+    return(list("data" = resp, "api_responses" = meta_data))
+  } else {
+    return(resp)
+  }
 }
 
 #' @export