Journal permissions handler and check journal is public

Author: kompotkot

bugout/__init__.py

@@ -7,7 +7,7 @@
 
 __email__ = "engineering@bugout.dev"
 __license__ = "MIT"
-__version__ = "0.1.11"
+__version__ = "0.1.12"
 
 __all__ = (
     "__author__",

bugout/app.py

@@ -300,6 +300,18 @@ def list_scopes(
         self.journal.timeout = timeout
         return self.journal.list_scopes(token=token, api=api)
 
+    def get_journal_permissions(
+        self,
+        token: Union[str, uuid.UUID],
+        journal_id: Union[str, uuid.UUID],
+        holder_ids: Optional[List[Union[str, uuid.UUID]]] = None,
+        timeout: float = REQUESTS_TIMEOUT,
+    ) -> data.BugoutJournalPermissions:
+        self.journal.timeout = timeout
+        return self.journal.get_journal_permissions(
+            token=token, journal_id=journal_id, holder_ids=holder_ids
+        )
+
     def get_journal_scopes(
         self,
         token: Union[str, uuid.UUID],
@@ -579,6 +591,15 @@ def search(
             token, journal_id, query, filters, limit, offset, content
         )
 
+    # Public
+    def check_journal_public(
+        self,
+        journal_id: Union[str, uuid.UUID],
+        timeout: float = REQUESTS_TIMEOUT,
+    ) -> bool:
+        self.journal.timeout = timeout
+        return self.journal.check_journal_public(journal_id=journal_id)
+
     # Humbug
     def get_humbug_integrations(
         self,

bugout/data.py

@@ -97,6 +97,17 @@ class BugoutGroupMembers(BaseModel):
     users: List[BugoutUserShort]
 
 
+class BugoutJournalPermission(BaseModel):
+    holder_type: HolderType
+    holder_id: str
+    permissions: List[str] = Field(default_factory=list)
+
+
+class BugoutJournalPermissions(BaseModel):
+    journal_id: uuid.UUID
+    permissions: List[BugoutJournalPermission] = Field(default_factory=list)
+
+
 class BugoutScope(BaseModel):
     api: str
     scope: str

bugout/journal.py

@@ -5,6 +5,7 @@
 from .data import (
     BugoutJournal,
     BugoutJournals,
+    BugoutJournalPermissions,
     BugoutScopes,
     BugoutJournalScopeSpecs,
     BugoutJournalEntry,
@@ -52,6 +53,29 @@ def list_scopes(self, token: Union[str, uuid.UUID], api: str) -> BugoutScopes:
         )
         return BugoutScopes(**result)
 
+    def get_journal_permissions(
+        self,
+        token: Union[str, uuid.UUID],
+        journal_id: Union[str, uuid.UUID],
+        holder_ids: Optional[List[Union[str, uuid.UUID]]] = None,
+    ) -> BugoutJournalPermissions:
+        journal_scopes_path = f"journals/{journal_id}/permissions"
+        headers = {
+            "Authorization": f"Bearer {token}",
+        }
+        query_params = {}
+        if holder_ids is not None:
+            holder_ids_string = [str(holder_id) for holder_id in holder_ids]
+            holder_ids_param = ",".join(holder_ids_string)
+            query_params = {"holder_ids": holder_ids_param}
+        result = self._call(
+            method=Method.get,
+            path=journal_scopes_path,
+            params=query_params,
+            headers=headers,
+        )
+        return BugoutJournalPermissions(**result)
+
     def get_journal_scopes(
         self, token: Union[str, uuid.UUID], journal_id: Union[str, uuid.UUID]
     ) -> BugoutJournalScopeSpecs:
@@ -401,3 +425,10 @@ def search(
             method=Method.get, path=search_path, params=query_params, headers=headers
         )
         return BugoutSearchResults(**result)
+
+    # Public module
+    def check_journal_public(self, journal_id: Union[str, uuid.UUID]) -> bool:
+        journal_path = "public/check"
+        query_params = {"journal_id": journal_id}
+        result = self._call(method=Method.get, path=journal_path, params=query_params)
+        return result