Added search handler

Author: kompotkot

bugout/__init__.py

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

bugout/app.py

@@ -301,3 +301,9 @@ def delete_tag(
         tag: str,
     ) -> data.BugoutJournalEntryTags:
         return self.journal.delete_tag(token, journal_id, entry_id, tag)
+
+    # Search
+    def search(
+        self, token: uuid.UUID, journal_id: uuid.UUID, **queries: Dict[str, Any]
+    ) -> data.BugoutSearchResults:
+        return self.journal.search(token, journal_id, **queries)

bugout/data.py

@@ -151,3 +151,30 @@ class BugoutJournalEntryTags(BaseModel):
     journal_id: uuid.UUID
     entry_id: uuid.UUID
     tags: List[str]
+
+
+class BugoutSearchFields(BaseModel):
+    query: str = ""
+    filters: Optional[List[str]] = None
+    limit: int = 10
+    offset: int = 0
+    content: Optional[bool] = True
+
+
+class BugoutSearchResult(BaseModel):
+    entry_url: str
+    content_url: str
+    title: str
+    content: Optional[str]
+    tags: List[str]
+    created_at: str
+    updated_at: str
+    score: float
+
+
+class BugoutSearchResults(BaseModel):
+    total_results: int
+    offset: int
+    next_offset: Optional[int]
+    max_score: float
+    results: List[BugoutSearchResult]

bugout/journal.py

@@ -11,6 +11,8 @@
     BugoutJournalEntries,
     BugoutJournalEntryContent,
     BugoutJournalEntryTags,
+    BugoutSearchFields,
+    BugoutSearchResults,
     HolderType,
     Method,
 )
@@ -253,7 +255,7 @@ def delete_entry(
         result = self._call(method=Method.delete, path=entry_id_path, headers=headers)
         return BugoutJournalEntry(**result)
 
-    # Tags modules
+    # Tags module
     def get_most_used_tags(self, token: uuid.UUID, journal_id: uuid.UUID) -> List[Any]:
         tags_path = f"journals/{journal_id}/tags"
         headers = {
@@ -322,3 +324,33 @@ def delete_tag(
             method=Method.delete, path=tags_path, headers=headers, json=json
         )
         return BugoutJournalEntryTags(**result)
+
+    # Search module
+    def _search_query(self, search_path: str, **queries: Dict[str, Any]) -> str:
+        """
+        Validate search arguments with pydantic model BugoutSearchFields and
+        generate search_path with queries.
+        """
+        field_queries = BugoutSearchFields(**queries)
+        fields_list = list(BugoutSearchFields.schema().get("properties").keys())  # type: ignore
+
+        search_path += f"?{fields_list[0]}={getattr(field_queries, fields_list[0])}"
+        for field in fields_list[1:]:
+            attr = getattr(field_queries, field)
+            if type(attr) is list:
+                attr = ",".join(attr)
+            search_path += f"&{field}={attr}"
+
+        return search_path
+
+    def search(
+        self, token: uuid.UUID, journal_id: uuid.UUID, **queries: Dict[str, Any]
+    ) -> BugoutSearchResults:
+        search_path_org = f"journals/{journal_id}/search"
+        search_path = self._search_query(search_path=search_path_org, **queries)
+
+        headers = {
+            "Authorization": f"Bearer {token}",
+        }
+        result = self._call(method=Method.get, path=search_path, headers=headers)
+        return BugoutSearchResults(**result)