allow folder names with leading /

Author: jlwalke2

CHANGELOG.md

@@ -1,6 +1,7 @@
 Unreleased
 ----------
- -
+**Improvements**
+ - `folders.get_folder()` can now handle folder names that include a leading or trailing "/" character.
 
 v1.8.1 (2023-01-19)
 ----------

src/sasctl/_services/folders.py

@@ -18,7 +18,7 @@ class Folders(Service):
 
     _SERVICE_ROOT = "/folders"
 
-    list_folders, get_folder, update_folder, delete_folder = Service._crud_funcs(
+    list_folders, _get_folder, update_folder, delete_folder = Service._crud_funcs(
         "/folders", "folder"
     )
 
@@ -61,3 +61,33 @@ def create_folder(cls, name, parent=None, description=None):
             params={"parentFolderUri": parent_uri},
             headers={"Content-Type": "application/vnd.sas.content.folder+json"},
         )
+
+    @classmethod
+    def get_folder(cls, folder, refresh=False):
+        """Return a folder instance.
+
+        Parameters
+        ----------
+        folder : str or dict
+            Name, ID, or dictionary representation of the folder.
+        refresh : bool, optional
+            Obtain an updated copy of the folder.
+
+        Returns
+        -------
+        RestObj or None
+            A dictionary containing the folder attributes or None.
+
+        Notes
+        -------
+        If `folder` is a complete representation of the folder it will be
+        returned unless `refresh` is set.  This prevents unnecessary REST
+        calls when data is already available on the client.
+
+        """
+        # If users pass in a folder name like "/Public" instead of "Public"
+        # then just cleanup the folder name so that it matches what's returned by Viya.
+        if isinstance(folder, str):
+            folder = folder.strip("/")
+
+        return cls._get_folder(folder, refresh=refresh)

tests/unit/test_folders.py

@@ -75,3 +75,25 @@ def test_create_folder_with_parent():
         with mock.patch("sasctl._services.folders.Folders.post"):
             with pytest.raises(ValueError):
                 folders.create_folder(FOLDER_NAME, parent="Doesnt Matter")
+
+
+@mock.patch("sasctl.core.Session.request")
+def test_get_folder_with_path(request):
+    """Verify that simple folder paths instead of names are handled."""
+    request.return_value.status_code = 200
+    request.return_value.json.return_value = {"name": "Spam"}
+
+    folder = folders.get_folder("/Spam")
+    assert folder is not None
+    assert folder.name == "Spam"
+
+    # Service should do a search on folder name first followed by a get for folder details.
+    assert request.call_count == 2
+
+    url, params = request.call_args_list[0]
+    search_filter = params["params"]
+
+    # / should have been stripped out of folder name
+    assert '"Spam"' in search_filter
+    assert '"/Spam"' not in search_filter
+