Merge pull request #64 from ScotGovAnalysis/assets

Temporary fix to type arg in assets() (#53)

Author: alice-hannah

NEWS.md

@@ -16,9 +16,13 @@
 `read/write_data_version()`(#54).
 
 * Added support for [mobile authentication](https://secure.objectiveconnect.co.uk/publicapi/1/swagger-ui/index.html?configUrl=/publicapi/1/v3/api-docs/swagger-config#/MobileAuth)
-to view status (`mobile_auth_staus()`) and to login (`mobile_auth_login()`) 
+to view status (`mobile_auth_staus()`) and to login (`mobile_auth_login()`)
 (#52).
 
+* Temporary fix to `assets()` to account for bug in underlying API (#53).
+The `type` argument now only accepts an empty list (default to return all asset 
+types) or a list of length 1.
+
 # objr 0.1.1
 
 * Set minimum versions for `dplyr` and `tidyr` dependencies (#32).

R/assets.R

@@ -7,8 +7,14 @@
 # nolint end
 #'
 #' @param workspace_uuid UUID of workspace
-#' @param type List of asset types to return. Defaults to all types;
-#' document, folder and link.
+#' @param type List of asset types to return. Default returns all types;
+#' "document", "folder" and "link".
+#'
+#' List must be empty (default, returns all asset types), or length 1 (e.g.
+#' `list("document")`). This is a temporary measure while a bug in the
+#' underlying API is outstanding (see
+#' [objr#53](https://github.com/ScotGovAnalysis/objr/issues/53)).
+#'
 #' @inheritParams objr
 #' @inheritParams workspaces
 #'
@@ -17,13 +23,28 @@
 #' @export
 
 assets <- function(workspace_uuid,
-                   type = list("document", "folder", "link"),
+                   type = list(),
                    page = NULL,
                    size = NULL,
                    use_proxy = FALSE) {
 
   check_list(type)
 
+  if (length(type) > 1) {
+    cli::cli_abort(c(
+      "x" = "{.arg type} must be a list of length 0 or 1, not {length(type)}.",
+      "i" = paste(
+        "There is currently a bug in the underlying API preventing",
+        "users from selecting more than one asset type. See",
+        "{.href [objr#53](https://github.com/ScotGovAnalysis/objr/issues/53)}",
+        "for more information."),
+      "i" = paste("To return all assets, use `type = list()` (default)."),
+      "i" = paste("To return one asset type only, e.g. documents, use",
+                  "`type = list(\"document\")`. See `?assets` for all",
+                  "options.")
+    ))
+  }
+
   type <- paste(toupper(type), collapse = "|")
 
   response <- objr(

man/assets.Rd

@@ -1,6 +1,6 @@
 # All types
 
-structure(list(method = "GET", url = "https://api/assets?workspaceUuid=test_workspace&type=DOCUMENT%7CFOLDER%7CLINK",
+structure(list(method = "GET", url = "https://api/assets?workspaceUuid=test_workspace&type=",
     status_code = 200L, headers = structure(list(Date = "Mon, 08 Apr 2024 16:12:59 GMT",
         `Content-Type` = "application/json", `Transfer-Encoding` = "chunked",
         Connection = "keep-alive", `X-CONNECT-MDC` = "apiGMsONBfA",

tests/testthat/api/assets-3192ad.R tests/testthat/api/assets-90958f.Rtests/testthat/api/assets-3192ad.R renamed to tests/testthat/api/assets-90958f.R

@@ -1,13 +1,18 @@
 # assets ----
 
+test_that("Error if `type` length > 1", {
+  expect_error(assets(workspace_uuid = "test_workspace",
+                      type = list("document", "link")))
+})
+
 without_internet({
 
   test_that("Valid request created", {
 
     expect_GET(
-      assets(workspace_uuid = "test_workspace"),
+      assets(workspace_uuid = "test_workspace", type = list()),
       paste0("https://secure.objectiveconnect.co.uk/publicapi/1/assets?",
-             "workspaceUuid=test_workspace&type=DOCUMENT%7CFOLDER%7CLINK")
+             "workspaceUuid=test_workspace&type=")
     )
 
     expect_GET(