feat: download datasource

NAMESPACE

@@ -12,6 +12,7 @@ export(authenticate_server)
 export(check_dashboard_names)
 export(create_group)
 export(delete_group)
+export(download_datasource)
 export(download_filtered_tableau_image)
 export(download_tableau_crosstab_excel)
 export(download_tableau_data)
@@ -22,6 +23,7 @@ export(get_actions)
 export(get_folders)
 export(get_groups_for_user)
 export(get_hierarchy)
+export(get_mobile_security_settings)
 export(get_nodenames)
 export(get_parameter)
 export(get_revision)

R/download_datasource.R

@@ -0,0 +1,39 @@
+#' Download a data source in .tdsx format using Tableau REST API and save it as a file.
+#'
+#' Downloads a data source in .tdsx format and saves it as a file on your computer.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, `user_id`, and `site_id`.
+#' @param api_version The API version to use (default: 3.16).
+#' @param datasource_id The ID of the data source to download.
+#' @param file_path The path to save the downloaded data source.
+#' @param include_extract Logical indicating whether to include the extract when downloading the data source (default: TRUE).
+#' @return A binary vector containing the data source in .tdsx format.
+#' @export
+#' @family Tableau REST API
+download_datasource <- function(tableau, api_version = 3.16, datasource_id, file_path, include_extract = TRUE) {
+  base_url <- tableau$base_url
+  token <- tableau$token
+  site_id <- tableau$site_id
+
+  url <- paste0(
+    base_url,
+    "api/",
+    api_version,
+    "/sites/",
+    site_id,
+    "/datasources/",
+    datasource_id,
+    "/content"
+  )
+
+  if (!include_extract) {
+    url <- paste0(url, "?includeExtract=False")
+  }
+
+  api_response <- httr::GET(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token),
+    httr::write_disk(paste0(file_path, "data.tdsx"), overwrite = TRUE)
+  )
+
+}

R/get_mobile_security_settings.R

@@ -0,0 +1,31 @@
+#' Get mobile security settings for the server using Tableau REST API.
+#'
+#' Retrieves the mobile security settings for the Tableau Server.
+#'
+#' @param tableau A list containing the Tableau authentication variables: `base_url`, `token`, `user_id`.
+#' @param api_version The API version to use (default: 3.19).
+#' @return A list containing the mobile security settings for the server.
+#' @export
+#' @family Tableau REST API
+get_mobile_security_settings <- function(tableau, api_version = 3.19) {
+  base_url <- tableau$base_url
+  token <- tableau$token
+
+  url <- paste0(
+    base_url,
+    "api/",
+    api_version,
+    "/settings/mobilesecuritysettings"
+  )
+
+  api_response <- httr::GET(
+    url,
+    httr::add_headers("X-Tableau-Auth" = token)
+  )
+
+  jsonResponseText <- httr::content(api_response, as = "text")
+
+  settings <- jsonlite::fromJSON(jsonResponseText)
+
+  return(settings)
+}

TODO.md

@@ -55,7 +55,7 @@
 -   [ ] Add Tags to Data Source
 -   [ ] Delete Data Source
 -   [ ] Delete Tag from Data Source
--   [ ] Download Data Source
+-   [x] Download Data Source
 -   [ ] Download Data Source Revision
 -   [ ] Get Data Source Revisions
 -   [ ] Publish Data Source
@@ -210,7 +210,7 @@
 -   [ ] Get Metric Data
 -   [ ] List Metrics for Site
 -   [ ] Update Metric
--   [ ] Get Mobile Security Settings for Server
+-   [x] Get Mobile Security Settings for Server
 -   [ ] Get Mobile Security Settings for Site
 -   [ ] Update Mobile Security Settings for Site
 -   [ ] Add User to Data-Driven Alert

_pkgdown.yml

@@ -37,6 +37,7 @@ reference:
   - title: Data Sources Methods
     desc: Data sources methods for Tableau REST API.
     contents:
+      - download_datasource
       - download_tableau_data
       - get_server_datasources
 
@@ -77,10 +78,10 @@ reference:
 #     contents:
 #       - None
 
-#   - title: Mobile Settings Methods
-#     desc: Mobile settings methods for Tableau REST API.
-#     contents:
-#       - None
+  - title: Mobile Settings Methods
+    desc: Mobile settings methods for Tableau REST API.
+    contents:
+      - get_mobile_security_settings
 
 #   - title: Notifications Methods
 #     desc: Notifications methods for Tableau REST API.