chore(release): 0.5.0

CHANGELOG.md

@@ -2,6 +2,58 @@
 
 All notable changes to this project will be documented in this file.
 
+## [0.5.0] - 2025-11-19
+
+### Features
+
+- [`2ef4ada`](https://gitea.pufereq.pl/judas/judas_protocol/commit/2ef4adaaa1e872c3c622ec6c37966dda1c7665d3) **message.py**: add `CLOSE` msg constructor
+- [`aa0703f`](https://gitea.pufereq.pl/judas/judas_protocol/commit/aa0703fcde9d531fc5eaf8d9c93b160422692387) **types.py**: add `CLOSE` msg ControlAction
+- [`332ce3f`](https://gitea.pufereq.pl/judas/judas_protocol/commit/332ce3ffa16ba43d6af1ba71bce1bc633e1661a9) **message.py**: add `acknowledged` and `ack_required` properties
+
+## [0.4.3] - 2025-10-05
+
+### Bug Fixes
+
+- [`1ab577e`](https://gitea.pufereq.pl/judas/judas_protocol/commit/1ab577ebd583ed17f813d37745b5dc195855d9c3) **message.py**: provide `id_` in `ack()` and `hello()`
+
+## [0.4.2] - 2025-10-05
+
+### Bug Fixes
+
+- [`37eec56`](https://gitea.pufereq.pl/judas/judas_protocol/commit/37eec56afeb2697955702aba04476ccdde7435e4) **message.py**: allow providing ID via argument
+
+## [0.4.1] - 2025-10-05
+
+### Miscellaneous Tasks
+
+- [`f307a7f`](https://gitea.pufereq.pl/judas/judas_protocol/commit/f307a7f457924ff1717ed4c8ce195ce022dd5680) **message.py**: add `target_id` argument to `Message.ack` classmethod
+
+## [0.4.0] - 2025-10-05
+
+### Features
+
+- [`4cc3a5b`](https://gitea.pufereq.pl/judas/judas_protocol/commit/4cc3a5bb3a0fce0c4d90958f26fa09a1d638a4b3) **message.py**: add message uuid
+
+## [0.3.0] - 2025-09-23
+
+### Features
+
+- [`ffc4ed1`](https://gitea.pufereq.pl/judas/judas_protocol/commit/ffc4ed18974e89c6f1f5554d9e8832065432310a) **message.py**: add `__str__` and `__repr__` methods
+- [`bc1bf46`](https://gitea.pufereq.pl/judas/judas_protocol/commit/bc1bf46388eb904738893a2f86b5050b4ce2489e) **message.py**: raise ValueError if invalid json in `Message.from_bytes()`
+
+### Styling
+
+- [`9b5b104`](https://gitea.pufereq.pl/judas/judas_protocol/commit/9b5b104061859b2dd4ab93258414edd8ce34b4a7) **message.py**: organize imports
+
+## [0.2.0] - 2025-08-29
+
+### Features
+
+- [`fd070b1`](https://gitea.pufereq.pl/judas/judas_protocol/commit/fd070b176347a0f7b81f937b189d8f50736f3514) **message.py**: add `b"\n"` at end of data from `to_bytes()`
+- [`df55e0c`](https://gitea.pufereq.pl/judas/judas_protocol/commit/df55e0c5cba00c6d08b98cf09f265c130bc11f73) **message.py**: add `Message.from_bytes()`
+- [`762d09e`](https://gitea.pufereq.pl/judas/judas_protocol/commit/762d09ea9b3e28efdfdd2ac0674bb874154b41a9) **message.py**: add `Message.to_bytes()`
+- [`b90653b`](https://gitea.pufereq.pl/judas/judas_protocol/commit/b90653b3fd90957a0056dcd803da20a78a589314) **__init__.py**: add public api
+
 ## [0.1.0] - 2025-08-28
 
 ### Features

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "judas_protocol"
-version = "0.1.0"
+version = "0.5.0"
 description = "The judas protocol"
 readme = "README.md"
 authors = []

src/judas_protocol/__init__.py

@@ -1 +1,6 @@
 __version__: str = "0.1.0"
+
+from .message import Message
+from .types import Category, ControlAction
+
+__all__ = ["__version__", "Message", "Category", "ControlAction"]

src/judas_protocol/message.py

@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
 from __future__ import annotations
 
-from enum import Enum
 import json
-from typing import Any
+import uuid
+from enum import Enum
+from typing import Any, override
 
 from judas_protocol.types import Category, ControlAction
 
@@ -13,21 +14,44 @@ class Message:
 
     def __init__(
         self,
+        id_: str | None,
         category: Category,
         action: Enum,
         payload: dict[str, Any] | None = None,
+        *,
+        acknowledged: bool = False,
+        ack_required: bool = False,
     ) -> None:
         """Initialize a Message.
 
         Args:
+            id_ (str | None): The ID of the message. If None, a new UUID will be generated.
             category (Category): The category of the message.
             action (Enum): The action of the message.
             payload (dict[str, Any] | None): The payload of the message.
+            acknowledged (bool): Whether the message has been acknowledged. Defaults to False.
+            ack_required (bool): Whether the message requires an acknowledgment. Defaults to False.
         """
+        self.id: str = id_ or str(uuid.uuid4())
         self.category: Category = category
         self.action: Enum = action
         self.payload: dict[str, Any] = payload or {}
 
+        self.acknowledged: bool = acknowledged
+        self.ack_required: bool = ack_required
+
+    @override
+    def __str__(self) -> str:
+        return f"Message ({self.id}) ack'd: {self.acknowledged}, req: {self.ack_required} [{self.category.name}] {self.action.name} - {self.payload}"
+
+    @override
+    def __repr__(self) -> str:
+        return (
+            f"Message(id_={self.id}, category={self.category}, action={self.action}"
+            f", payload={self.payload}, acknowledged={self.acknowledged}"
+            f", ack_required={self.ack_required})"
+        )
+
     def to_dict(self) -> dict[str, Any]:
         """Convert the message to a dictionary.
 
@@ -35,9 +59,12 @@ class Message:
             dict[str, Any]: The message as a dictionary.
         """
         return {
+            "id": self.id,
             "category": self.category,
             "action": self.action,
             "payload": self.payload,
+            "acknowledged": self.acknowledged,
+            "ack_required": self.ack_required,
         }
 
     def to_json(self) -> str:
@@ -48,6 +75,14 @@ class Message:
         """
         return json.dumps(self.to_dict())
 
+    def to_bytes(self) -> bytes:
+        """Convert the message to bytes.
+
+        Returns:
+            bytes: The message as bytes.
+        """
+        return self.to_json().encode("utf-8") + b"\n"
+
     @classmethod
     def from_dict(cls, data: dict[str, Any]) -> Message:
         """Create a Message from a dictionary.
@@ -58,8 +93,14 @@ class Message:
         Returns:
             Message: The created message.
         """
+        if "id" not in data:
+            data["id"] = None
+
+        id_: str | None = data["id"]
         category = Category(data["category"])
         action_str = data["action"]
+        acknowledged = data["acknowledged"]
+        ack_required = data["ack_required"]
 
         match category:
             case Category.CONTROL:
@@ -68,7 +109,14 @@ class Message:
                 raise ValueError(f"Unknown category: {category}")
 
         payload = data.get("payload", {})
-        return cls(category=category, action=action, payload=payload)
+        return cls(
+            id_=id_,
+            category=category,
+            action=action,
+            payload=payload,
+            acknowledged=acknowledged,
+            ack_required=ack_required,
+        )
 
     @classmethod
     def from_json(cls, data: str) -> Message:
@@ -79,17 +127,41 @@ class Message:
         Returns:
             Message: The created message.
         """
-        return cls.from_dict(json.loads(data))
+        try:
+            json_data = json.loads(data)
+        except json.JSONDecodeError as e:
+            raise ValueError("Invalid JSON data") from e
+
+        return cls.from_dict(json_data)
 
     @classmethod
-    def ack(cls) -> Message:
+    def from_bytes(cls, data: bytes) -> Message:
+        """Create a Message from bytes.
+
+        Args:
+            data (bytes): The bytes to create the message from.
+        Returns:
+            Message: The created message.
+        """
+        return cls.from_json(data.decode("utf-8"))
+
+    @classmethod
+    def ack(cls, target_id: str) -> Message:
         """Create an ACK message.
 
+        Args:
+            target_id (str): The ID of the message to acknowledge.
+
         Returns:
             Message: The created ACK message.
         """
         return cls(
-            category=Category.CONTROL, action=ControlAction.ACK, payload={}
+            id_=None,
+            category=Category.CONTROL,
+            action=ControlAction.ACK,
+            payload={"target_id": target_id},
+            acknowledged=False,
+            ack_required=False,
         )
 
     @classmethod
@@ -102,7 +174,27 @@ class Message:
             Message: The created HELLO message.
         """
         return cls(
+            id_=None,
             category=Category.CONTROL,
             action=ControlAction.HELLO,
             payload={"mac": mac},
+            acknowledged=False,
+            ack_required=True,
+        )
+
+    @classmethod
+    def close(cls) -> Message:
+        """Create a CLOSE message.
+        Prompts the recipient to close the connection and not reconnect.
+
+        Returns:
+            Message: The created CLOSE message.
+        """
+        return cls(
+            id_=None,
+            category=Category.CONTROL,
+            action=ControlAction.CLOSE,
+            payload={},
+            acknowledged=False,
+            ack_required=True,
         )

src/judas_protocol/types.py

@@ -13,3 +13,4 @@ class Category(str, Enum):
 class ControlAction(str, Enum):
     HELLO = "hello"
     ACK = "ack"
+    CLOSE = "close"

uv.lock

@@ -240,7 +240,7 @@ wheels = [
 
 [[package]]
 name = "judas-protocol"
-version = "0.1.0"
+version = "0.5.0"
 source = { editable = "." }
 
 [package.dev-dependencies]