feat: rsconnect fs access_type args

Author: machow

pins/rsconnect/api.py

@@ -304,7 +304,7 @@ def get_content_item(self, guid: str) -> Content:
         return Content(result)
 
     def post_content_item(
-        self, name, access_type, title: str = "", description: str = "", **kwargs
+        self, name, access_type: str, title: str = "", description: str = "", **kwargs
     ) -> Content:
         data = self._get_params(locals(), exclude={"kwargs"})
         result = self.query_v1("content", "POST", json={**data, **kwargs})

pins/rsconnect/fs.py

@@ -18,6 +18,17 @@
     RSC_CODE_OBJECT_DOES_NOT_EXIST,
 )
 
+# Misc ----
+
+
+def _not_impl_args_kwargs(args, kwargs):
+    return NotImplementedError(
+        "Additional args and kwargs not supported." f"\nArgs: {args}\nKwargs: {kwargs}"
+    )
+
+
+# Bundles ----
+
 
 @dataclass
 class PinBundleManifestMetadata:
@@ -148,6 +159,7 @@ def put(
         rpath,
         recursive=False,
         *args,
+        access_type="acl",
         deploy=True,
         cls_manifest=PinBundleManifest,
         **kwargs,
@@ -160,6 +172,8 @@ def put(
             A path to the local bundle directory.
         rpath: str
             A path to the content where the bundle is being put.
+        access_type:
+            Who can use and view this content? Must be one of all, logged_in or acl.
         cls_manifest:
             If maniest does not exist, a class with an .add_manifest_to_directory()
             method.
@@ -168,6 +182,9 @@ def put(
 
         parsed = self.parse_path(rpath)
 
+        if len(args) or len(kwargs):
+            raise _not_impl_args_kwargs(args, kwargs)
+
         if recursive is False:
             raise NotImplementedError(
                 "Must set recursive to True in order to put any RSConnect content."
@@ -185,7 +202,7 @@ def put(
             # TODO: this could be seen as analogous to mkdir (which gets
             # called by pins anyway)
             # TODO: hard-coded acl bad?
-            content = self.api.post_content_item(parsed.content, "acl")
+            content = self.api.post_content_item(parsed.content, access_type)
 
         # Create bundle (with manifest.json inserted if missing) ----
 
@@ -265,18 +282,22 @@ def exists(self, path: str, **kwargs) -> bool:
         except RsConnectApiMissingContentError:
             return False
 
-    def mkdir(self, path, create_parents=True, **kwargs) -> None:
+    def mkdir(
+        self, path, create_parents=True, *args, access_type="acl", **kwargs
+    ) -> None:
         parsed = self.parse_path(path)
 
+        if len(args) or len(kwargs):
+            raise _not_impl_args_kwargs(args, kwargs)
+
         if not isinstance(parsed, ContentPath):
             raise ValueError(f"Requires path to content, but received: {path}")
 
         if self.exists(path):
             raise FileExistsError(path)
 
         # TODO: could implement and call makedirs, but seems overkill
-        # TODO: hard-coded "acl"?
-        self.api.post_content_item(parsed.content, "acl", **kwargs)
+        self.api.post_content_item(parsed.content, access_type, **kwargs)
 
     def info(self, path, **kwargs) -> "User | Content | Bundle":
         # TODO: source of fsspec info uses self._parent to check cache?

pins/tests/test_rsconnect_api.py

@@ -426,6 +426,25 @@ def test_rsconnect_fs_put_bundle(fs_short):
     assert f_index.read().decode() == (Path(path_to_example) / "index.html").read_text()
 
 
+def test_rsconnect_fs_put_bundle_all_access(fs_short):
+    import requests
+
+    # TODO: use pkg_resources to get this
+    path_to_example = "pins/tests/example-bundle"
+    fs_short.put(
+        path_to_example, "susan/test-content", recursive=True, access_type="all"
+    )
+
+    # access control is set at the content (not bundle) level. we need to get the
+    # content guid to recreate the "shareable" link
+    content = fs_short.info("susan/test-content")
+
+    r = requests.get(f"{fs_short.api.server_url}/content/{content['guid']}")
+    r.raise_for_status()
+
+    assert r.text == (Path(path_to_example) / "index.html").read_text()
+
+
 # fs.mkdir ----