support passing connect_user object to downstream functions

we still support GUID string for now

Author: karawoo

R/connect.R

@@ -495,8 +495,9 @@ Connect <- R6::R6Class(
     # users -----------------------------------------------
 
     #' @description Get user details.
-    #' @param guid The user GUID.
+    #' @param guid The user GUID or a `connect_user` object.
     user = function(guid) {
+      guid <- get_user_guid(guid)
       prepend_class(self$GET(v1_url("users", guid)), "connect_user")
     },
 
@@ -589,8 +590,9 @@ Connect <- R6::R6Class(
     },
 
     #' @description Lock a user.
-    #' @param user_guid User GUID.
-    users_lock = function(user_guid) {
+    #' @param user User GUID or a `connect_user` object.
+    users_lock = function(user) {
+      user_guid <- get_user_guid(user)
       path <- v1_url("users", user_guid, "lock")
       message(path)
       self$POST(
@@ -600,8 +602,9 @@ Connect <- R6::R6Class(
     },
 
     #' @description Unlock a user.
-    #' @param user_guid User GUID.
-    users_unlock = function(user_guid) {
+    #' @param user User GUID or a `connect_user` object.
+    users_unlock = function(user) {
+      user_guid <- get_user_guid(user)
       path <- v1_url("users", user_guid, "lock")
       self$POST(
         path = path,
@@ -610,9 +613,10 @@ Connect <- R6::R6Class(
     },
 
     #' @description Update a user.
-    #' @param user_guid User GUID.
+    #' @param user User GUID or a `connect_user` object.
     #' @param ... User fields.
-    users_update = function(user_guid, ...) {
+    users_update = function(user, ...) {
+      user_guid <- get_user_guid(user)
       path <- v1_url("users", user_guid)
       self$PUT(
         path = path,
@@ -645,16 +649,18 @@ Connect <- R6::R6Class(
 
     #' @description Add a group member.
     #' @param group_guid The group GUID.
-    #' @param user_guid The user GUID.
-    group_member_add = function(group_guid, user_guid) {
+    #' @param user The user GUID or a `connect_user` object.
+    group_member_add = function(group_guid, user) {
+      user_guid <- get_user_guid(user)
       path <- v1_url("groups", group_guid, "members")
       self$POST(path, body = list(user_guid = user_guid))
     },
 
     #' @description Remove a group member.
     #' @param group_guid The group GUID.
-    #' @param user_guid The user GUID.
-    group_member_remove = function(group_guid, user_guid) {
+    #' @param user The user GUID or a `connect_user` object.
+    group_member_remove = function(group_guid, user) {
+      user_guid <- get_user_guid(user)
       path <- v1_url("groups", group_guid, "members", user_guid)
       self$DELETE(path)
     },

R/content.R

@@ -219,10 +219,14 @@ Content <- R6::R6Class(
       self$connect$GET(url)
     },
     #' @description Add a principal to the ACL for this content.
-    #' @param principal_guid GUID for the target user or group.
+    #' @param principal_guid GUID for the target user or group. When
+    #'   `principal_type = "user"`, can also be a `connect_user` object.
     #' @param principal_type Acting on user or group.
     #' @param role The kind of content access.
     permissions_add = function(principal_guid, principal_type, role) {
+      if (principal_type == "user") {
+        principal_guid <- get_user_guid(principal_guid)
+      }
       url <- v1_url("content", self$content$guid, "permissions")
       self$connect$POST(
         url,
@@ -235,10 +239,14 @@ Content <- R6::R6Class(
     },
     #' @description Alter a principal in the ACL for this content.
     #' @param id The target identifier.
-    #' @param principal_guid GUID for the target user or group.
+    #' @param principal_guid GUID for the target user or group. When
+    #'   `principal_type = "user"`, can also be a `connect_user` object.
     #' @param principal_type Acting on user or group.
     #' @param role The kind of content access.
     permissions_update = function(id, principal_guid, principal_type, role) {
+      if (principal_type == "user") {
+        principal_guid <- get_user_guid(principal_guid)
+      }
       url <- v1_url("content", self$content$guid, "permissions", id)
       self$connect$PUT(
         url,
@@ -954,7 +962,6 @@ set_run_as <- function(content, run_as, run_as_current_user = FALSE) {
   return(content)
 }
 
-
 #' Delete Content
 #'
 #' Delete a content item. WARNING: This action deletes all history, configuration,
@@ -1007,8 +1014,8 @@ content_delete <- function(content, force = FALSE) {
 #' @param content An R6 content item
 #' @param ... Settings up update that are passed along to Posit Connect
 #' @param access_type One of "all", "logged_in", or "acl"
-#' @param owner_guid The GUID of a user who is a publisher, so that they can
-#'   become the new owner of the content
+#' @param owner The GUID of a user who is a publisher, so that they can
+#'   become the new owner of the content. Can also be a `connect_user` object.
 #'
 #' @return An R6 content item
 #'
@@ -1040,7 +1047,8 @@ content_update_access_type <- function(
 
 #' @rdname content_update
 #' @export
-content_update_owner <- function(content, owner_guid) {
+content_update_owner <- function(content, owner) {
+  owner_guid <- get_user_guid(owner)
   content_update(content = content, owner_guid = owner_guid)
 }
 
@@ -1103,7 +1111,6 @@ unlock_content <- function(content) {
   return(content)
 }
 
-
 #' Verify Content Name
 #'
 #' Ensures that a content name fits the specifications / requirements of Posit
@@ -1178,7 +1185,6 @@ delete_bundle <- function(content, bundle_id) {
   return(content)
 }
 
-
 #' Content permissions
 #'
 #' Get or set content permissions for a content item
@@ -1199,8 +1205,12 @@ delete_bundle <- function(content, bundle_id) {
 #' This makes it easier to find / isolate this record.
 #'
 #' @param content An R6 content object
-#' @param guid The guid associated with either a user (for `content_add_user`) or group (for `content_add_group`)
-#' @param role The role to assign to a user. Either "viewer" or "owner." Defaults to "viewer"
+#' @param user The guid associated with either a user (for `content_add_user`)
+#'   or group (for `content_add_group`). Can also be a list of `connect_user`
+#'   objects.
+#' @param guid The guid associated with a group.
+#' @param role The role to assign to a user. Either "viewer" or "owner."
+#'   Defaults to "viewer"
 #' @param add_owner Optional. Whether to include the owner in returned
 #'   permission sets. Default is TRUE. The owner will have an NA_character_
 #'   permission "id"
@@ -1209,10 +1219,11 @@ delete_bundle <- function(content, bundle_id) {
 #' @rdname permissions
 #' @family content functions
 #' @export
-content_add_user <- function(content, guid, role = c("viewer", "owner")) {
+content_add_user <- function(content, user, role = c("viewer", "owner")) {
   validate_R6_class(content, "Content")
   role <- .define_role(role)
 
+  guid <- purrr::map_chr(user, get_user_guid)
   purrr::map(guid, ~ .content_add_permission_impl(content, "user", .x, role))
 
   return(content)
@@ -1278,8 +1289,9 @@ content_add_group <- function(content, guid, role = c("viewer", "owner")) {
 
 #' @rdname permissions
 #' @export
-content_delete_user <- function(content, guid) {
+content_delete_user <- function(content, user) {
   validate_R6_class(content, "Content")
+  guid <- purrr::map_chr(user, get_user_guid)
   purrr::map(
     guid,
     ~ .content_delete_permission_impl(
@@ -1331,8 +1343,9 @@ content_delete_group <- function(content, guid) {
 
 #' @rdname permissions
 #' @export
-get_user_permission <- function(content, guid, add_owner = TRUE) {
+get_user_permission <- function(content, user, add_owner = TRUE) {
   validate_R6_class(content, "Content")
+  guid <- get_user_guid(user)
   res <- .get_permission(content, "user", guid, add_owner = add_owner)
   if (length(res) > 0) {
     return(res[[1]])
@@ -1361,7 +1374,6 @@ get_group_permission <- function(content, guid) {
   }
 }
 
-
 #' @rdname permissions
 #' @export
 get_content_permissions <- function(content, add_owner = TRUE) {

R/user.R

@@ -32,3 +32,28 @@ user_guid_from_username <- function(client, username) {
     return(res[[1]]$guid)
   }
 }
+
+#' Extract User GUID
+#'
+#' Helper function to extract a user GUID from either a character string or a
+#' `connect_user` object.
+#'
+#' @param user Either a character string containing a user GUID or a
+#'   `connect_user` object (as returned by `Connect$user()` or `Connect$users()`)
+#'
+#' @return A character string containing the user GUID
+#'
+#' @keywords internal
+get_user_guid <- function(user) {
+  if (is.character(user)) {
+    return(user)
+  } else if (inherits(user, "connect_user")) {
+    if (!is.null(user$guid)) {
+      return(user$guid)
+    } else {
+      stop("connect_user object does not contain a guid field")
+    }
+  } else {
+    stop("user must be either a character string (GUID) or a connect_user object")
+  }
+}