feat: create and delete groups

vusaverse · Jan 5, 2024 · 20ae1f8 · 20ae1f8
1 parent 9ecf48e
commit 20ae1f8
Show file tree

Hide file tree

Showing 34 changed files with 183 additions and 2 deletions.
diff --git a/NAMESPACE b/NAMESPACE
@@ -9,6 +9,7 @@ export(adjust_tableau_font_style)
 export(adjust_tableau_size)
 export(authenticate_server)
 export(check_dashboard_names)
+export(create_group)
 export(download_filtered_tableau_image)
 export(download_tableau_crosstab_excel)
 export(download_tableau_data)

diff --git a/R/create_group.R b/R/create_group.R
@@ -0,0 +1,50 @@
+#' Create Group
+#'
+#' Creates a group on Tableau Server or Tableau Cloud site.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, and `site_id`.
+#' @param group_name The name of the group to create.
+#' @param api_version The API version to use (default: 3.19).
+#'
+#' @return The ID of the new group.
+#' @export
+#'
+#' @family Tableau REST API
+create_group <- function(tableau, group_name, api_version = 3.19) {
+  base_url <- tableau$base_url
+  token <- tableau$token
+  site_id <- tableau$site_id
+
+  url <- paste0(
+    base_url,
+    "/api/",
+    3.19,
+    "/sites/",
+    site_id,
+    "/groups"
+  )
+
+  # Construct the request body
+  request_body <- paste0(
+    "<tsRequest>",
+    "<group name=\"", group_name, "\"/>",
+    "</tsRequest>"
+  )
+
+  api_response <- httr::POST(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token),
+    body = request_body
+  )
+
+  # Check the response status code
+  if (httr::status_code(api_response) != 201) {
+    stop("Group creation failed. Please check your API key and base URL.")
+  }
+
+  # Extract the ID of the new group from the Location header
+  location_header <- httr::headers(api_response)$location
+  group_id <- stringr::str_extract(location_header, "\\w{8}-\\w{4}-\\w{4}-\\w{4}-\\w{12}")
+
+  return(group_id)
+}
diff --git a/R/delete_group.R b/R/delete_group.R
@@ -0,0 +1,31 @@
+#' Delete Group
+#'
+#' Deletes the specified group from the site.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, `user_id`, and `site_id`.
+#' @param group_id The ID of the group to delete.
+#' @param api_version The API version to use (default: 3.19).
+delete_group <- function(tableau, group_id, api_version = 3.19) {
+  base_url <- tableau$base_url
+  site_id <- tableau$site_id
+  token <- tableau$token
+
+  url <- paste0(
+    base_url,
+    "api/",
+    api_version,
+    "/sites/",
+    site_id,
+    "/groups/",
+    group_id
+  )
+
+  api_response <- httr::DELETE(url,
+                               httr::add_headers("X-Tableau-Auth" = token)
+  )
+
+  # Check the response status code
+  if (httr::status_code(api_response) != 204) {
+    stop("Group deletion failed. Please check your API key and base URL.")
+  }
+}
diff --git a/TODO.md b/TODO.md
@@ -284,8 +284,8 @@
 -   [ ] Update Subscription
 -   [x] Add User to Group
 -   [x] Add User to Site
--   [ ] Create Group
--   [ ] Delete Group
+-   [x] Create Group
+-   [x] Delete Group
 -   [ ] Delete Users from Site with CSV
 -   [x] Get Groups for a User
 -   [x] Get Users in Group

diff --git a/man/add_tags_to_view.Rd b/man/add_tags_to_view.Rd
diff --git a/man/add_tags_to_workbook.Rd b/man/add_tags_to_workbook.Rd
diff --git a/man/add_user_to_group.Rd b/man/add_user_to_group.Rd
diff --git a/man/add_user_to_site.Rd b/man/add_user_to_site.Rd
diff --git a/man/authenticate_server.Rd b/man/authenticate_server.Rd
diff --git a/man/create_group.Rd b/man/create_group.Rd
diff --git a/man/delete_group.Rd b/man/delete_group.Rd
diff --git a/man/download_filtered_tableau_image.Rd b/man/download_filtered_tableau_image.Rd
diff --git a/man/download_tableau_crosstab_excel.Rd b/man/download_tableau_crosstab_excel.Rd
diff --git a/man/download_tableau_data.Rd b/man/download_tableau_data.Rd
diff --git a/man/download_workbooks_server.Rd b/man/download_workbooks_server.Rd
diff --git a/man/download_workbooks_server_pdf.Rd b/man/download_workbooks_server_pdf.Rd
diff --git a/man/download_workbooks_server_powerpoint.Rd b/man/download_workbooks_server_powerpoint.Rd
diff --git a/man/get_groups_for_user.Rd b/man/get_groups_for_user.Rd
diff --git a/man/get_server_connected_apps.Rd b/man/get_server_connected_apps.Rd
diff --git a/man/get_server_datasources.Rd b/man/get_server_datasources.Rd
diff --git a/man/get_server_groups.Rd b/man/get_server_groups.Rd
diff --git a/man/get_server_info.Rd b/man/get_server_info.Rd
diff --git a/man/get_server_jobs.Rd b/man/get_server_jobs.Rd
diff --git a/man/get_server_projects.Rd b/man/get_server_projects.Rd
diff --git a/man/get_server_refresh_tasks.Rd b/man/get_server_refresh_tasks.Rd
diff --git a/man/get_server_schedules.Rd b/man/get_server_schedules.Rd
diff --git a/man/get_server_user_favorites.Rd b/man/get_server_user_favorites.Rd
diff --git a/man/get_server_users.Rd b/man/get_server_users.Rd
diff --git a/man/get_server_views.Rd b/man/get_server_views.Rd
diff --git a/man/get_server_workbooks.Rd b/man/get_server_workbooks.Rd
diff --git a/man/get_table_assets.Rd b/man/get_table_assets.Rd
diff --git a/man/get_users_in_group.Rd b/man/get_users_in_group.Rd
diff --git a/man/remove_user_from_group.Rd b/man/remove_user_from_group.Rd
diff --git a/man/remove_user_from_site.Rd b/man/remove_user_from_site.Rd