return "connect_user"/"connect_users" objects

get_user now returns list of `"connect_user"` objects instead of a data frame.
as.data.frame and as_tibble methods have been added.

Author: karawoo

NAMESPACE

@@ -7,9 +7,11 @@ S3method(api_build,op_base_connect)
 S3method(api_build,op_head)
 S3method(as.data.frame,connect_integration_list)
 S3method(as.data.frame,connect_list_hits)
+S3method(as.data.frame,connect_users)
 S3method(as.data.frame,tbl_connect)
 S3method(as_tibble,connect_integration_list)
 S3method(as_tibble,connect_list_hits)
+S3method(as_tibble,connect_users)
 S3method(connect_vars,op_base)
 S3method(connect_vars,op_single)
 S3method(connect_vars,tbl_connect)

R/connect.R

@@ -497,7 +497,7 @@ Connect <- R6::R6Class(
     #' @description Get user details.
     #' @param guid The user GUID.
     user = function(guid) {
-      self$GET(v1_url("users", guid))
+      prepend_class(self$GET(v1_url("users", guid)), "connect_user")
     },
 
     #' @description Get users.
@@ -527,7 +527,11 @@ Connect <- R6::R6Class(
         user_role = user_role,
         account_status = account_status
       )
-      self$GET(path, query = query)
+      res <- self$GET(path, query = query)
+      if (!is.null(res$results)) {
+        res$results <- lapply(res$results, prepend_class, "connect_user")
+      }
+      res
     },
 
     #' @description Get remote users.

R/get.R

@@ -13,8 +13,8 @@
 #' value (boolean OR). When `NULL` (the default), results are not filtered.
 
 #'
-#' @return
-#' A tibble with the following columns:
+#' @return For `get_users`, a list of objects of type `"connect_user"` which
+#'   contain the following information:
 #'
 #'   * `email`: The user's email
 #'   * `username`: The user's username
@@ -33,6 +33,8 @@
 #'   * `locked`: Whether or not the user is locked
 #'   * `guid`: The user's GUID, or unique identifier, in UUID RFC4122 format
 #'
+#' For `get_user`, a single `"connect_user"` object.
+#'
 #' @details
 #' Please see https://docs.posit.co/connect/api/#get-/v1/users for more information.
 #'
@@ -49,6 +51,10 @@
 #'
 #' # Get all users who are administrators or publishers
 #' get_users(client, user_role = c("administrator", "publisher"))
+#'
+#' # Convert to a data frame
+#' users_list <- get_users(client)
+#' as.data.frame(users_list)
 #' }
 #'
 #' @export
@@ -72,10 +78,23 @@ get_users <- function(
     ),
     limit = limit
   )
+  return(prepend_class(res, "connect_users"))
+}
 
-  out <- parse_connectapi_typed(res, connectapi_ptypes$users)
+#' @param guid user GUID
+#' @rdname get_users
+get_user <- function(src, guid) {
+  src$user(guid)
+}
 
-  return(out)
+#' @export
+as.data.frame.connect_users <- function(x, ...) {
+  parse_connectapi_typed(x, connectapi_ptypes$users)
+}
+
+#' @export
+as_tibble.connect_users <- function(x, ...) {
+  parse_connectapi_typed(x, connectapi_ptypes$users)
 }
 
 #' Get information about content on the Posit Connect server

R/utils.R

@@ -256,3 +256,9 @@ message_if_not_testing <- function(...) {
     message(...)
   }
 }
+
+# Prepends a new class to a given objec
+prepend_class <- function(x, class) {
+  class(x) <- c(class, class(x))
+  x
+}

man/get_users.Rd

@@ -2,8 +2,8 @@ with_mock_api({
   test_that("we can retrieve the users list", {
     con <- Connect$new(server = "https://connect.example", api_key = "fake")
     users <- get_users(con)
-    expect_s3_class(users, "data.frame")
-    expect_equal(nrow(users), 3)
+    expect_s3_class(users, "connect_users")
+    expect_equal(length(users), 3)
   })
 
   test_that("we can retrieve a user by id", {