Merge pull request #36 from bugout-dev/fix-update-entry-with-tag-action

Adds support for updating tags in the same HTTP request as an entry update

Author: zomglings

bugout/__init__.py

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

bugout/app.py

@@ -5,7 +5,7 @@
 from .calls import ping
 from .group import Group
 from .humbug import Humbug
-from .journal import Journal, SearchOrder
+from .journal import Journal, SearchOrder, TagsAction
 from .resource import Resource
 from .user import User
 from .settings import BUGOUT_BROOD_URL, BUGOUT_SPIRE_URL, REQUESTS_TIMEOUT
@@ -595,6 +595,8 @@ def update_entry_content(
         title: str,
         content: str,
         timeout: float = REQUESTS_TIMEOUT,
+        tags: Optional[List[str]] = None,
+        tags_action: TagsAction = TagsAction.merge,
     ) -> data.BugoutJournalEntryContent:
         self.journal.timeout = timeout
         return self.journal.update_entry_content(
@@ -603,6 +605,8 @@ def update_entry_content(
             entry_id=entry_id,
             title=title,
             content=content,
+            tags=tags,
+            tags_action=tags_action,
         )
 
     def delete_entry(

bugout/journal.py

@@ -1,5 +1,5 @@
 from enum import Enum
-from typing import Any, List, Optional, Union
+from typing import Any, Dict, List, Optional, Union
 import uuid
 
 from .calls import make_request
@@ -28,6 +28,21 @@ class SearchOrder(Enum):
     DESCENDING = "desc"
 
 
+class TagsAction(Enum):
+    """
+    tags_action query parameter for PUT /{journal_id}/entries/{entry_id} requests.
+    See Spire API implementation of that endpoint for more details:
+    https://github.com/bugout-dev/spire/blob/cc748d45d0aa7e3350105810449ff4c14fa64ec9/spire/journal/api.py#L1249
+
+    Corresponds to EntryUpdateTagActions enum in Spire:
+    https://github.com/bugout-dev/spire/blob/cc748d45d0aa7e3350105810449ff4c14fa64ec9/spire/journal/data.py#L32
+    """
+
+    ignore = "ignore"
+    replace = "replace"
+    merge = "merge"
+
+
 class Journal:
     """
     Represent a journal from Bugout.
@@ -301,12 +316,18 @@ def update_entry_content(
         entry_id: Union[str, uuid.UUID],
         title: str,
         content: str,
+        tags: Optional[List[str]] = None,
+        tags_action: TagsAction = TagsAction.merge,
     ) -> BugoutJournalEntryContent:
         entry_id_content_path = f"journals/{journal_id}/entries/{entry_id}/content"
-        json = {
+        params: Dict[str, str] = {}
+        json: Dict[str, Any] = {
             "title": title,
             "content": content,
         }
+        if tags is not None:
+            json["tags"] = tags
+            params["tags_action"] = tags_action.value
         headers = {
             "Authorization": f"Bearer {token}",
         }
@@ -315,6 +336,7 @@ def update_entry_content(
             path=entry_id_content_path,
             headers=headers,
             json=json,
+            params=params,
         )
         return BugoutJournalEntryContent(**result)