Merge pull request video-db#31 from video-db/ankit/add-public-collection

feat: add public collection

Author: ashish-spext

videodb/__about__.py

@@ -1,7 +1,7 @@
 """ About information for videodb sdk"""
 
 
-__version__ = "0.2.8"
+__version__ = "0.2.9"
 __title__ = "videodb"
 __author__ = "videodb"
 __email__ = "[email protected]"

videodb/client.py

@@ -38,6 +38,7 @@ def get_collection(self, collection_id: Optional[str] = "default") -> Collection
             self.collection_id,
             collection_data.get("name"),
             collection_data.get("description"),
+            collection_data.get("is_public", False),
         )
 
     def get_collections(self) -> List[Collection]:
@@ -48,6 +49,7 @@ def get_collections(self) -> List[Collection]:
                 collection.get("id"),
                 collection.get("name"),
                 collection.get("description"),
+                collection.get("is_public", False),
             )
             for collection in collections_data.get("collections")
         ]
@@ -66,6 +68,7 @@ def create_collection(self, name: str, description: str) -> Collection:
             collection_data.get("id"),
             collection_data.get("name"),
             collection_data.get("description"),
+            collection_data.get("is_public", False),
         )
 
     def update_collection(self, id: str, name: str, description: str) -> Collection:
@@ -82,6 +85,7 @@ def update_collection(self, id: str, name: str, description: str) -> Collection:
             collection_data.get("id"),
             collection_data.get("name"),
             collection_data.get("description"),
+            collection_data.get("is_public", False),
         )
 
     def check_usage(self) -> dict:

videodb/collection.py

@@ -24,18 +24,27 @@
 
 
 class Collection:
-    def __init__(self, _connection, id: str, name: str = None, description: str = None):
+    def __init__(
+        self,
+        _connection,
+        id: str,
+        name: str = None,
+        description: str = None,
+        is_public: bool = False,
+    ):
         self._connection = _connection
         self.id = id
         self.name = name
         self.description = description
+        self.is_public = is_public
 
     def __repr__(self) -> str:
         return (
             f"Collection("
             f"id={self.id}, "
             f"name={self.name}, "
-            f"description={self.description})"
+            f"description={self.description}), "
+            f"is_public={self.is_public})"
         )
 
     def delete(self) -> None:
@@ -168,3 +177,15 @@ def upload(
             return Audio(self._connection, **upload_data)
         elif media_id.startswith("img-"):
             return Image(self._connection, **upload_data)
+
+    def make_public(self):
+        self._connection.patch(
+            path=f"{ApiPath.collection}/{self.id}", data={"is_public": True}
+        )
+        self.is_public = True
+
+    def make_private(self):
+        self._connection.patch(
+            path=f"{ApiPath.collection}/{self.id}", data={"is_public": False}
+        )
+        self.is_public = False

videodb/video.py

@@ -277,15 +277,17 @@ def get_scene_collection(self, collection_id: str) -> Optional[SceneCollection]:
         if not collection_id:
             raise ValueError("collection_id is required")
         scenes_data = self._connection.get(
-            path=f"{ApiPath.video}/{self.id}/{ApiPath.scenes}/{collection_id}"
+            path=f"{ApiPath.video}/{self.id}/{ApiPath.scenes}/{collection_id}",
+            params={"collection_id": self.collection_id},
         )
         if not scenes_data:
             return None
         return self._format_scene_collection(scenes_data.get("scene_collection"))
 
     def list_scene_collection(self):
         scene_collections_data = self._connection.get(
-            path=f"{ApiPath.video}/{self.id}/{ApiPath.scenes}"
+            path=f"{ApiPath.video}/{self.id}/{ApiPath.scenes}",
+            params={"collection_id": self.collection_id},
         )
         return scene_collections_data.get("scene_collections", [])
 
@@ -328,13 +330,15 @@ def index_scenes(
 
     def list_scene_index(self) -> List:
         index_data = self._connection.get(
-            path=f"{ApiPath.video}/{self.id}/{ApiPath.index}/{ApiPath.scene}"
+            path=f"{ApiPath.video}/{self.id}/{ApiPath.index}/{ApiPath.scene}",
+            params={"collection_id": self.collection_id},
         )
         return index_data.get("scene_indexes", [])
 
     def get_scene_index(self, scene_index_id: str) -> Optional[List]:
         index_data = self._connection.get(
-            path=f"{ApiPath.video}/{self.id}/{ApiPath.index}/{ApiPath.scene}/{scene_index_id}"
+            path=f"{ApiPath.video}/{self.id}/{ApiPath.index}/{ApiPath.scene}/{scene_index_id}",
+            params={"collection_id": self.collection_id},
         )
         if not index_data:
             return None