feat: support updating site settings

Author: jorwoods

tableauserverclient/models/extensions_item.py

@@ -75,7 +75,7 @@ def prompt_needed(self, value: Optional[bool]) -> None:
 class ExtensionsSiteSettings:
     def __init__(self) -> None:
         self._enabled: Optional[bool] = None
-        self._use_default_settings: Optional[bool] = None
+        self._use_default_setting: Optional[bool] = None
         self.safe_list: Optional[list[SafeExtension]] = None
 
     @property
@@ -88,13 +88,13 @@ def enabled(self, value: Optional[bool]) -> None:
         self._enabled = value
 
     @property
-    def use_default_settings(self) -> Optional[bool]:
-        return self._use_default_settings
+    def use_default_setting(self) -> Optional[bool]:
+        return self._use_default_setting
 
-    @use_default_settings.setter
+    @use_default_setting.setter
     @property_is_boolean
-    def use_default_settings(self, value: Optional[bool]) -> None:
-        self._use_default_settings = value
+    def use_default_setting(self, value: Optional[bool]) -> None:
+        self._use_default_setting = value
 
     @classmethod
     def from_response(cls: type[Self], response, ns) -> Self:
@@ -107,7 +107,7 @@ def from_response(cls: type[Self], response, ns) -> Self:
         if (enabled_element := element.find("./t:extensionsEnabled", namespaces=ns)) is not None:
             obj.enabled = string_to_bool(enabled_element.text)
         if (default_settings_element := element.find("./t:useDefaultSetting", namespaces=ns)) is not None:
-            obj.use_default_settings = string_to_bool(default_settings_element.text)
+            obj.use_default_setting = string_to_bool(default_settings_element.text)
 
         safe_list = []
         for safe_extension_element in element.findall("./t:safeList", namespaces=ns):

tableauserverclient/models/property_decorators.py

@@ -1,7 +1,7 @@
 import datetime
 import re
 from functools import wraps
-from typing import Any, Optional
+from typing import Any, Optional, Tuple
 from collections.abc import Container
 
 from tableauserverclient.datetime_helpers import parse_datetime

tableauserverclient/server/endpoint/extensions_endpoint.py

@@ -30,7 +30,8 @@ def get_server_settings(self) -> ExtensionsServer:
 
     @api(version="3.21")
     def update_server_settings(self, extensions_server: ExtensionsServer) -> ExtensionsServer:
-        """Updates the settings for extensions of a server
+        """Updates the settings for extensions of a server. Overwrites all existing settings. Any
+        sites omitted from the block list will be unblocked.
 
         Parameters
         ----------
@@ -57,3 +58,22 @@ def get(self) -> ExtensionsSiteSettings:
         """
         response = self.get_request(self.baseurl)
         return ExtensionsSiteSettings.from_response(response.content, self.parent_srv.namespace)
+
+    @api(version="3.21")
+    def update(self, extensions_site_settings: ExtensionsSiteSettings) -> ExtensionsSiteSettings:
+        """Updates the extensions settings for the site. Overwrites all existing settings.
+        Any extensions omitted from the safe extensions list will be removed.
+
+        Parameters
+        ----------
+        extensions_site_settings : ExtensionsSiteSettings
+            The site extensions settings to update
+
+        Returns
+        -------
+        ExtensionsSiteSettings
+            The updated site extensions settings
+        """
+        req = RequestFactory.Extensions.update_site_extensions(extensions_site_settings)
+        response = self.put_request(self.baseurl, req)
+        return ExtensionsSiteSettings.from_response(response.content, self.parent_srv.namespace)

tableauserverclient/server/request_factory.py

@@ -1637,6 +1637,32 @@ def update_server_extensions(self, xml_request: ET.Element, extensions_server: "
             blocked_element.text = blocked
         return
 
+    @_tsrequest_wrapped
+    def update_site_extensions(self, xml_request: ET.Element, extensions_site_settings: ExtensionsSiteSettings) -> None:
+        ext_element = ET.SubElement(xml_request, "extensionsSiteSettings")
+        if not isinstance(extensions_site_settings.enabled, bool):
+            raise ValueError(f"Extensions Site Settings missing enabled: {extensions_site_settings}")
+        enabled_element = ET.SubElement(ext_element, "extensionsEnabled")
+        enabled_element.text = str(extensions_site_settings.enabled).lower()
+        if not isinstance(extensions_site_settings.use_default_setting, bool):
+            raise ValueError(
+                f"Extensions Site Settings missing use_default_setting: {extensions_site_settings.use_default_setting}"
+            )
+        default_element = ET.SubElement(ext_element, "useDefaultSetting")
+        default_element.text = str(extensions_site_settings.use_default_setting).lower()
+
+        for safe in extensions_site_settings.safe_list or []:
+            safe_element = ET.SubElement(ext_element, "safeList")
+            if safe.url is not None:
+                url_element = ET.SubElement(safe_element, "url")
+                url_element.text = safe.url
+            if safe.full_data_allowed is not None:
+                full_data_element = ET.SubElement(safe_element, "fullDataAllowed")
+                full_data_element.text = str(safe.full_data_allowed).lower()
+            if safe.prompt_needed is not None:
+                prompt_element = ET.SubElement(safe_element, "promptNeeded")
+                prompt_element.text = str(safe.prompt_needed).lower()
+
 
 class RequestFactory:
     Auth = AuthRequest()

test/test_extensions.py

@@ -1,5 +1,7 @@
 from pathlib import Path
+from xml.etree.ElementTree import Element
 
+from defusedxml.ElementTree import fromstring
 import requests_mock
 import pytest
 
@@ -67,10 +69,62 @@ def test_get_site_settings(server: TSC.Server) -> None:
 
     assert isinstance(site_settings, TSC.ExtensionsSiteSettings)
     assert site_settings.enabled is True
-    assert site_settings.use_default_settings is False
+    assert site_settings.use_default_setting is False
     assert site_settings.safe_list is not None
     assert len(site_settings.safe_list) == 1
     first_safe = site_settings.safe_list[0]
     assert first_safe.url == "http://localhost:9123/Dynamic.html"
     assert first_safe.full_data_allowed is True
     assert first_safe.prompt_needed is True
+
+
+def test_update_site_settings(server: TSC.Server) -> None:
+    with requests_mock.mock() as m:
+        m.put(server.extensions.baseurl, text=GET_SITE_SETTINGS.read_text())
+
+        site_settings = TSC.ExtensionsSiteSettings()
+        site_settings.enabled = True
+        site_settings.use_default_setting = False
+        safe_extension = TSC.SafeExtension(
+            url="http://localhost:9123/Dynamic.html",
+            full_data_allowed=True,
+            prompt_needed=True,
+        )
+        site_settings.safe_list = [safe_extension]
+
+        updated_settings = server.extensions.update(site_settings)
+        history = m.request_history
+
+    assert isinstance(updated_settings, TSC.ExtensionsSiteSettings)
+    assert updated_settings.enabled is True
+    assert updated_settings.use_default_setting is False
+    assert updated_settings.safe_list is not None
+    assert len(updated_settings.safe_list) == 1
+    first_safe = updated_settings.safe_list[0]
+    assert first_safe.url == "http://localhost:9123/Dynamic.html"
+    assert first_safe.full_data_allowed is True
+    assert first_safe.prompt_needed is True
+
+    # Verify that the request body was as expected
+    assert len(history) == 1
+    xml_payload = fromstring(history[0].body)
+    extensions_site_settings_elem = xml_payload.find(".//extensionsSiteSettings")
+    assert extensions_site_settings_elem is not None
+    enabled_elem = extensions_site_settings_elem.find("extensionsEnabled")
+    assert enabled_elem is not None
+    assert enabled_elem.text == "true"
+    use_default_elem = extensions_site_settings_elem.find("useDefaultSetting")
+    assert use_default_elem is not None
+    assert use_default_elem.text == "false"
+    safe_list_elements = list(extensions_site_settings_elem.findall("safeList"))
+    assert len(safe_list_elements) == 1
+    safe_extension_elem = safe_list_elements[0]
+    url_elem = safe_extension_elem.find("url")
+    assert url_elem is not None
+    assert url_elem.text == "http://localhost:9123/Dynamic.html"
+    full_data_allowed_elem = safe_extension_elem.find("fullDataAllowed")
+    assert full_data_allowed_elem is not None
+    assert full_data_allowed_elem.text == "true"
+    prompt_needed_elem = safe_extension_elem.find("promptNeeded")
+    assert prompt_needed_elem is not None
+    assert prompt_needed_elem.text == "true"