v0.0.0.9006

.Rbuildignore

@@ -5,3 +5,4 @@
 ^_pkgdown\.yml$
 ^docs$
 ^pkgdown$
+^\.lintr$

DESCRIPTION

@@ -1,23 +1,25 @@
 Package: objr
 Title: Wrapper for Objective APIs
-Version: 0.0.0.9005
+Version: 0.0.0.9006
 Authors@R: c(
     person("Scottish Government", , , "statistics.enquiries@gov.scot", role = "cph"),
     person("Alice", "Hannah", , "alice.hannah@gov.scot", role = c("aut", "cre"))
   )
 Description: An R package wrapper for Objective APIs including Objective
     Connect.
 License: MIT + file LICENCE
-URL:https://github.com/ScotGovAnalysis/objr,
+URL: https://github.com/ScotGovAnalysis/objr,
     https://ScotGovAnalysis.github.io/objr/
 BugReports: https://github.com/ScotGovAnalysis/objr/issues
 Imports: 
     cli,
     curl,
     dplyr,
     httr2,
+    magrittr,
     rlang,
-    rstudioapi
+    rstudioapi,
+    tidyr
 Suggests: 
     httptest2,
     knitr,

NAMESPACE

@@ -1,21 +1,29 @@
 # Generated by roxygen2: do not edit by hand
 
+export(add_participants)
 export(allow_bypass_2fa)
 export(asset_info)
 export(assets)
 export(comments)
 export(create_folder)
 export(delete_asset)
 export(download_file)
+export(download_file_version)
 export(my_user_id)
 export(new_reply)
 export(new_thread)
 export(objr)
 export(participant_bypass_2fa)
 export(participants)
 export(read_data)
+export(read_data_version)
+export(rename_asset)
+export(rollback_to_version)
 export(upload_file)
 export(upload_file_version)
+export(versions)
 export(workspaces)
 export(write_data)
 export(write_data_version)
+importFrom(magrittr,"%>%")
+importFrom(rlang,.data)

R/assets.R

@@ -3,11 +3,10 @@
 #' @param workspace_uuid UUID of workspace
 #' @param type List of asset types to return. Defaults to all types;
 #' document, folder and link.
-#' @param page Page number of responses to return (0..N).
-#' @param size Number of results to be returned per page.
 #' @inheritParams objr
+#' @inheritParams workspaces
 #'
-#' @return Data frame
+#' @return Tibble
 #'
 #' @export
 
@@ -30,11 +29,8 @@ assets <- function(workspace_uuid,
     use_proxy = use_proxy
   )
 
-  content <-
-    httr2::resp_body_json(response)$content |>
-    lapply(\(x) data.frame(asset_info_list(x)))
-
-  Reduce(dplyr::bind_rows, content)
+  tidyr::tibble(content = httr2::resp_body_json(response)$content) %>%
+    asset_info_list()
 
 }
 
@@ -44,7 +40,7 @@ assets <- function(workspace_uuid,
 #' @param asset_uuid UUID of asset
 #' @inheritParams objr
 #'
-#' @return Named list containing: uuid, name, type, extension, description.
+#' @return Tibble
 #'
 #' @export
 
@@ -55,10 +51,11 @@ asset_info <- function(asset_uuid,
     endpoint = "assets",
     url_path = list(asset_uuid),
     use_proxy = use_proxy
-  ) |>
+  ) %>%
     httr2::resp_body_json()
 
-  asset_info_list(response)
+  dplyr::tibble(content = list(response)) %>%
+    asset_info_list()
 
 }
 
@@ -81,7 +78,7 @@ delete_asset <- function(asset_uuid,
     method = "DELETE",
     url_path = list(asset_uuid),
     use_proxy = use_proxy
-  ) |>
+  ) %>%
     httr2::resp_body_json()
 
   if (tolower(response$status) == "complete") {
@@ -93,25 +90,56 @@ delete_asset <- function(asset_uuid,
 }
 
 
-na_if_null <- function(x) {
-  if (is.null(x)) NA else x
+#' Rename an asset
+#'
+#' @param asset_uuid UUID of asset
+#' @param new_name Character. New name to give asset.
+#' @inheritParams objr
+#'
+#' @export
+
+rename_asset <- function(asset_uuid,
+                         new_name,
+                         use_proxy = FALSE) {
+
+  response <- objr(
+    endpoint = "assets",
+    method = "PUT",
+    accept = "*/*",
+    url_path = list(asset_uuid, "name"),
+    body = list(name = new_name),
+    use_proxy = use_proxy
+  )
+
+  if (response$status_code == 204) {
+    cli::cli_alert_success("Asset renamed to {.val new_name}: {asset_uuid}.")
+  }
+
+  invisible(response)
+
 }
 
 asset_info_list <- function(x) {
 
-  list(
-    asset_name       = x$name,
-    asset_ext        = na_if_null(x$extension),
-    asset_type       = x$type,
-    asset_uuid       = x$uuid,
-    last_modified_by = paste(na_if_null(x[["modifiedBy"]]$givenName),
-                             na_if_null(x[["modifiedBy"]]$familyName)),
-    last_modified    = na_if_null(convert_from_epoch(x$modifiedTime)),
-    latest_version   = na_if_null(x$contentVersion),
-    parent_name      = na_if_null(x[["parent"]]$name),
-    parent_uuid      = na_if_null(x[["parent"]]$uuid),
-    workspace_name   = x[["workspace"]]$name,
-    workspace_uuid   = x[["workspace"]]$uuid
-  )
+  tidyr::hoist(
+    x,
+    .data$content,
+    asset_name       = "name",
+    asset_ext        = "extension",
+    asset_type       = "type",
+    asset_uuid       = "uuid",
+    name1            = c("modifiedBy", "givenName"),
+    name2            = c("modifiedBy", "familyName"),
+    last_modified    = "modifiedTime",
+    latest_version   = "contentVersion",
+    parent_name      = c("parent", "name"),
+    parent_uuid      = c("parent", "uuid"),
+    workspace_name   = c("workspace", "name"),
+    workspace_uuid   = c("workspace", "uuid"),
+    .transform = list(last_modified = convert_from_epoch)
+  ) %>%
+    dplyr::mutate(last_modified_by = paste(.data$name1, .data$name2),
+                  .after = "last_modified") %>%
+    dplyr::select(-c("name1", "name2", "content"))
 
 }

R/comments.R

@@ -36,25 +36,22 @@ comments <- function(created_after = NULL,
     use_proxy = use_proxy
   )
 
-  content <-
-    httr2::resp_body_json(response)$content |>
-    lapply(
-      \(content) {
-        data.frame(
-          type = content$commentType,
-          text = content$commentText,
-          author = paste(content$creator$givenName,
-                         content$creator$familyName),
-          created_time = as.POSIXct(content$createdTime / 1000,
-                                    origin = "1970-01-01"),
-          thread_uuid = content$thread$uuid,
-          workspace_name = content$workspace$name,
-          workspace_uuid = content$workspace$uuid
-        )
-      }
-    )
-
-  Reduce(dplyr::bind_rows, content)
+  dplyr::tibble(content = httr2::resp_body_json(response)$content) %>%
+    tidyr::hoist(
+      .data$content,
+      type = "commentType",
+      text = "commentText",
+      name1 = c("creator", "givenName"),
+      name2 = c("creator", "familyName"),
+      created_time = "createdTime",
+      thread_uuid = c("thread", "uuid"),
+      workspace_name = c("workspace", "name"),
+      workspace_uuid = c("workspace", "uuid"),
+      .transform = list(created_time = convert_from_epoch)
+    ) %>%
+    dplyr::mutate(author = paste(.data$name1, .data$name2),
+                  .after = "text") %>%
+    dplyr::select(-c("name1", "name2", "content"))
 
 }
 

R/create_folder.R

@@ -26,7 +26,7 @@ create_folder <- function(folder_name,
       description = description
     ),
     use_proxy = use_proxy
-  ) |>
+  ) %>%
     httr2::resp_body_json()
 
   if (tolower(response$status) == "complete") {

R/documents.R

@@ -0,0 +1,72 @@
+#' Get data frame of document versions
+#'
+#' @param document_uuid UUID of document (asset)
+#' @inheritParams objr
+#' @inheritParams workspaces
+#'
+#' @return Data frame
+#'
+#' @export
+
+versions <- function(document_uuid,
+                     page = NULL,
+                     size = NULL,
+                     use_proxy = FALSE) {
+
+  response <- objr(
+    endpoint = "documentversions",
+    url_query = list(documentUuid = document_uuid,
+                     page = page,
+                     size = size),
+    use_proxy = use_proxy
+  )
+
+  dplyr::tibble(content = httr2::resp_body_json(response)$content) %>%
+    tidyr::hoist(
+      .data$content,
+      asset_name = c("asset", "name"),
+      asset_ext = "extension",
+      asset_uuid = c("asset", "uuid"),
+      version = "version",
+      version_uuid = "uuid",
+      created_date = "createdTime",
+      name1 = c("createdBy", "givenName"),
+      name2 = c("createdBy", "familyName"),
+      workspace_name = c("asset", "workspace", "name"),
+      workspace_uuid = c("asset", "workspace", "uuid"),
+      .transform = list(created_date = convert_from_epoch)
+    ) %>%
+    dplyr::mutate(created_by = paste(.data$name1, .data$name2),
+                  .after = "created_date") %>%
+    dplyr::select(-c("name1", "name2", "content"))
+
+}
+
+
+#' Rollback a document to a previous version
+#'
+#' @param document_uuid UUID of document (asset)
+#' @param version_uuid UUID of version to rollback to
+#' @inheritParams objr
+#'
+#' @export
+
+rollback_to_version <- function(document_uuid,
+                                version_uuid,
+                                use_proxy = FALSE) {
+
+  response <- objr(
+    endpoint = "documents",
+    method = "PUT",
+    url_path = list(document_uuid, "rollback"),
+    body = list(targetVersionUuid = version_uuid),
+    use_proxy = use_proxy
+  )
+
+  if (response$status_code == 204) {
+    cli::cli_alert_success("Document rollback successful.")
+  }
+
+  invisible(response)
+
+}