always use the path for content.vanity attribute

Author: tdstein

integration/tests/posit/connect/test_vanities.py

@@ -41,8 +41,7 @@ def test_property(self):
 
         # Get
         vanity = content.vanity
-        assert vanity
-        assert vanity["path"] == "/example/"
+        assert vanity == "/example/"
 
         # Delete
         del content.vanity
@@ -61,7 +60,7 @@ def test_destroy(self):
         content.vanity = "example"
 
         # Get
-        vanity = content.vanity
+        vanity = content.find_vanity()
         assert vanity
         assert vanity["path"] == "/example/"
 

src/posit/connect/vanities.py

@@ -1,4 +1,4 @@
-from typing import Callable, List, Optional, TypedDict, Union
+from typing import Callable, List, Optional, TypedDict
 
 from typing_extensions import NotRequired, Required, Unpack
 
@@ -47,9 +47,9 @@ class Vanity(Resource):
     class VanityAttributes(TypedDict):
         """Vanity attributes."""
 
-        path: str
+        path: Required[str]
         content_guid: Required[str]
-        created_time: str
+        created_time: Required[str]
 
     def __init__(
         self,
@@ -123,7 +123,7 @@ class VanityMixin(Resource):
     class HasGuid(TypedDict):
         """Has a guid."""
 
-        guid: str
+        guid: Required[str]
 
     def __init__(self, /, params: ResourceParameters, **kwargs: Unpack[HasGuid]):
         super().__init__(params, **kwargs)
@@ -135,38 +135,38 @@ def _endpoint(self):
         return self.params.url + f"v1/content/{self._content_guid}/vanity"
 
     @property
-    def vanity(self) -> Optional[Vanity]:
+    def vanity(self) -> Optional[str]:
         """Get the vanity."""
         if self._vanity:
-            return self._vanity
+            return self._vanity["path"]
 
         try:
             self._vanity = self.find_vanity()
-            self._vanity._after_destroy = self.reset_vanity
-            return self._vanity
+            return self._vanity["path"]
         except ClientError as e:
             if e.http_status == 404:
                 return None
             raise e
 
     @vanity.setter
-    def vanity(self, value: Union[str, "CreateVanityRequest"]) -> None:
+    def vanity(self, value: str) -> None:
         """Set the vanity.
 
         Parameters
         ----------
-        value : str or CreateVanityRequest
-            The value can be a str or a CreateVanityRequest. If provided as a string, it is the vanity path.
+        value : str
+            The vanity path.
+
+        Note
+        ----
+        This action requires owner or administrator privileges.
 
         See Also
         --------
         create_vanity
         """
-        if isinstance(value, str):
-            self.create_vanity(path=value)
-        elif isinstance(value, dict):
-            self.create_vanity(**value)
-        self.reset_vanity()
+        self._vanity = self.create_vanity(path=value)
+        self._vanity._after_destroy = self.reset_vanity
 
     @vanity.deleter
     def vanity(self) -> None:
@@ -178,7 +178,7 @@ def vanity(self) -> None:
 
         Note
         ----
-        This action requires administrator privileges.
+        This action requires owner or administrator privileges.
 
         See Also
         --------
@@ -196,32 +196,39 @@ def reset_vanity(self) -> None:
         self._vanity = None
 
     class CreateVanityRequest(TypedDict, total=False):
-        """A request schema for creating a vanity.
-
-        Attributes
-        ----------
-        path : str
-            The path for the vanity.
-        force : bool
-            Whether to force the creation of the vanity.
-        """
+        """A request schema for creating a vanity."""
 
         path: Required[str]
+        """The vanity path (.e.g, 'my-dashboard')"""
+
         force: NotRequired[bool]
+        """Whether to force creation of the vanity"""
 
-    def create_vanity(self, **kwargs: Unpack[CreateVanityRequest]) -> None:
+    def create_vanity(self, **kwargs: Unpack[CreateVanityRequest]) -> Vanity:
         """Create a vanity.
 
         Parameters
         ----------
         path : str, required
             The path for the vanity.
         force : bool, not required
-            Whether to force the creation of the vanity, default False
+            Whether to force the creation of the vanity. When True, any other vanity with the same path will be deleted.
+
+        Warnings
+        --------
+        If setting force=True, the destroy operation performed on the other vanity is irreversible.
         """
-        self.params.session.put(self._endpoint, json=kwargs)
+        response = self.params.session.put(self._endpoint, json=kwargs)
+        result = response.json()
+        return Vanity(self.params, **result)
 
-    def find_vanity(self):
+    def find_vanity(self) -> Vanity:
+        """Find the vanity.
+
+        Returns
+        -------
+        Vanity
+        """
         response = self.params.session.get(self._endpoint)
         result = response.json()
-        return Vanity(self.params, **result)
+        return Vanity(self.params, after_destroy=self.reset_vanity, **result)

tests/posit/connect/test_vanities.py

@@ -20,7 +20,7 @@ def test_destroy_sends_delete_request(self):
         session = requests.Session()
         url = Url(base_url)
         params = ResourceParameters(session, url)
-        vanity = Vanity(params, content_guid=content_guid)
+        vanity = Vanity(params, content_guid=content_guid, path=Mock(), created_time=Mock())
 
         vanity.destroy()
 
@@ -67,15 +67,14 @@ def test_vanity_getter_returns_vanity(self):
         guid = "8ce6eaca-60af-4c2f-93a0-f5f3cddf5ee5"
         base_url = "http://connect.example/__api__"
         endpoint = f"{base_url}/v1/content/{guid}/vanity"
-        vanity_data = {"content_guid": guid}
-        mock_get = responses.get(endpoint, json=vanity_data)
+        mock_get = responses.get(endpoint, json={"content_guid": guid, "path": "my-dashboard"})
 
         session = requests.Session()
         url = Url(base_url)
         params = ResourceParameters(session, url)
         content = VanityMixin(params, guid=guid)
 
-        assert content.vanity == vanity_data
+        assert content.vanity == "my-dashboard"
         assert mock_get.call_count == 1
 
     @responses.activate
@@ -84,33 +83,20 @@ def test_vanity_setter_with_string(self):
         base_url = "http://connect.example/__api__"
         endpoint = f"{base_url}/v1/content/{guid}/vanity"
         path = "example"
-        mock_put = responses.put(endpoint, match=[json_params_matcher({"path": path})])
+        mock_put = responses.put(
+            endpoint,
+            json={"content_guid": guid, "path": path},
+            match=[json_params_matcher({"path": path})],
+        )
 
         session = requests.Session()
         url = Url(base_url)
         params = ResourceParameters(session, url)
         content = VanityMixin(params, guid=guid)
         content.vanity = path
+        assert content.vanity == path
 
         assert mock_put.call_count == 1
-        assert content._vanity is None
-
-    @responses.activate
-    def test_vanity_setter_with_dict(self):
-        guid = "8ce6eaca-60af-4c2f-93a0-f5f3cddf5ee5"
-        base_url = "http://connect.example/__api__"
-        endpoint = f"{base_url}/v1/content/{guid}/vanity"
-        attrs = {"path": "example", "locked": True}
-        mock_put = responses.put(endpoint, match=[json_params_matcher(attrs)])
-
-        session = requests.Session()
-        url = Url(base_url)
-        params = ResourceParameters(session, url)
-        content = VanityMixin(params, guid=guid)
-        content.vanity = attrs
-
-        assert content._vanity is None
-        assert mock_put.call_count == 1
 
     @responses.activate
     def test_vanity_deleter(self):