diff --git a/tableauserverclient/server/endpoint/views_endpoint.py b/tableauserverclient/server/endpoint/views_endpoint.py index c2779b17d..49cbc6b7d 100644 --- a/tableauserverclient/server/endpoint/views_endpoint.py +++ b/tableauserverclient/server/endpoint/views_endpoint.py @@ -1,5 +1,7 @@ +import html import logging from contextlib import closing +from urllib.parse import quote from tableauserverclient.models.permissions_item import PermissionsRule from tableauserverclient.server.endpoint.endpoint import QuerysetEndpoint, api @@ -461,6 +463,58 @@ def update_tags(self, item: ViewItem) -> None: """ return super().update_tags(item) + def embed_code(self, view: ViewItem) -> str: + """ + Build the Share-dialog embed snippet for a view. + + The REST API does not return this HTML. The snippet is the one the + Share button copies: the Embedding API v3 web component on Tableau + 2021.4 (REST API 3.13) and later, and the JavaScript API object embed + on older servers. ``src`` is the view URL for the signed-in site. + """ + if not view.content_url: + raise MissingRequiredFieldError("View item missing content URL.") + parts = [part for part in view.content_url.split("/") if part] + if len(parts) < 2: + raise MissingRequiredFieldError("View content URL does not identify a workbook and a view.") + workbook = parts[0] + sheet = view.view_url_name or parts[-1] + server = self.parent_srv.server_address.rstrip("/") + site = self.parent_srv.site_url + view_path = f"{quote(workbook, safe='')}/{quote(sheet, safe='')}" + if site: + src = f"{server}/t/{quote(site, safe='')}/views/{view_path}" + site_root = f"/t/{site}" + else: + src = f"{server}/views/{view_path}" + site_root = "" + if self.parent_srv.check_at_least_version("3.13"): + script = f"{server}/javascripts/api/tableau.embedding.3.latest.min.js" + return ( + f'\n' + f'' + ) + host = html.escape(server + "/", quote=True) + return ( + "
\n" + "
\n" + "" + ) + def filter(self, *invalid, page_size: int | None = None, **kwargs) -> QuerySet[ViewItem]: """ Queries the Tableau Server for items using the specified filters. Page diff --git a/test/test_view.py b/test/test_view.py index f4d5b7e1f..028ca2cff 100644 --- a/test/test_view.py +++ b/test/test_view.py @@ -582,3 +582,36 @@ def test_delete_view(server: TSC.Server, view: TSC.ViewItem | str) -> None: server.views.delete(view) assert m.called assert m.call_count == 1 + + +def _overview() -> TSC.ViewItem: + view = TSC.ViewItem() + view._content_url = "Superstore/sheets/Overview" + view._view_url_name = "Overview" + return view + + +def test_embed_code_uses_the_legacy_share_snippet_before_2021_4(server: TSC.Server) -> None: + server._site_url = "Samples" + server.version = "3.2" + code = server.views.embed_code(_overview()) + assert "javascripts/api/viz_v1.js" in code + assert "value='Superstore/Overview'" in code + assert "value='/t/Samples'" in code + assert "tableau.embedding" not in code + + +def test_embed_code_uses_embedding_api_v3(server: TSC.Server) -> None: + server._site_url = "" + server.version = "3.13" + code = server.views.embed_code(_overview()) + assert 'src="http://test/javascripts/api/tableau.embedding.3.latest.min.js"' in code + assert 'src="http://test/views/Superstore/Overview"' in code + assert " None: + server._site_url = "Samples" + server.version = "3.22" + code = server.views.embed_code(_overview()) + assert 'src="http://test/t/Samples/views/Superstore/Overview"' in code