bedger 0.0.4__tar.gz → 0.0.6__tar.gz

bedger-0.0.6/PKG-INFO

@@ -0,0 +1,14 @@
+Metadata-Version: 2.1
+Name: bedger
+Version: 0.0.6
+Summary: 
+Author: Henk van den Brink
+Requires-Python: >=3.8.1,<4.0.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Description-Content-Type: text/markdown
+
+

bedger-0.0.6/pyproject.toml

@@ -0,0 +1,41 @@
+[tool.poetry]
+name = "bedger"
+version = "0.0.6"
+description = ""
+authors = ["Henk van den Brink"]
+readme = "README.md"
+packages = [{include = "bedger", from = "src"}]
+
+[tool.poetry.dependencies]
+python = "^3.8.1,<=4.0.0"
+
+[tool.isort]
+profile = "black"
+line_length = 130
+
+[tool.flake8]
+max-line-length = 130
+exclude = [
+    ".git",
+    "__pycache__",
+    ".venv"
+]
+
+[tool.black]
+line-length = 130
+target-version = ['py310', 'py311']
+exclude = '''
+/(
+  \.git
+  | \.venv
+  | \.hg
+  | \.mypy_cache
+  | \.tox
+  | \.venv
+  | _build
+  | buck-out
+  | build
+  | dist
+  | node_modules
+)/
+'''

bedger-0.0.6/src/bedger/edge/connection.py

@@ -0,0 +1,65 @@
+from __future__ import annotations
+
+import json
+import socket
+from .config import Config
+from . import entities
+import logging
+
+
+logger = logging.getLogger("bedger.edge.connection")
+
+
+class BedgerConnection:
+    def __init__(self, config: Config = Config()):
+        self._config = config
+
+        self._socket = None
+
+    def __enter__(self) -> BedgerConnection:
+        self._connect()
+        return self
+
+    def _connect(self) -> None:
+        logger.info(f"Connecting to socket at {self._config.socket_path}")
+        try:
+            self._socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+            self._socket.connect(self._config.socket_path)
+            logger.info("Connected to socket")
+        except Exception as e:
+            logger.error(f"Error connecting to socket: {e}")
+            raise e
+
+    def __exit__(self, exc_type, exc_value, traceback) -> None:
+        self._socket.close()
+
+    def send_event(self, event_type, severity, payload):
+        message = entities.Message(
+            event_type=event_type,
+            severity=severity,
+            details=payload,
+        )
+
+        try:
+            logger.debug("Sending message")
+            self._socket.sendall(json.dumps(message).encode())
+
+            ack = self._socket.recv(1024)
+            logger.info(f"Received acknowledgment: {ack.decode()}")
+        except Exception as e:
+            logger.error(f"Error sending message: {e}")
+            raise e
+
+
+# Example usage
+if __name__ == "__main__":
+    import time
+
+    connection = BedgerConnection()
+
+    with connection:
+        for i in range(5):
+            connection.send_event(
+                event_type="TestEvent", severity=entities.Severity.INFO, payload={"message": f"Test message {i}"}
+            )
+            time.sleep(1)

{bedger-0.0.4 → bedger-0.0.6}/src/bedger/edge/entities/__init__.py

@@ -1,4 +1,5 @@
 from .message import Message
 from .severity import Severity
 
-__all__ = [Message, Severity]
+
+__all__ = [Message, Severity]

{bedger-0.0.4 → bedger-0.0.6}/src/bedger/edge/entities/message.py

@@ -1,10 +1,7 @@
-import json
-from typing import Dict
-
-from pydantic import BaseModel, Field, field_serializer, field_validator
-from typing_extensions import Annotated
-
+from typing import Dict, Annotated
+from pydantic import BaseModel, Field, field_validator, field_serializer
 from .severity import Severity
+import json
 
 
 class Message(BaseModel):

bedger-0.0.4/PKG-INFO

@@ -1,105 +0,0 @@
-Metadata-Version: 2.1
-Name: bedger
-Version: 0.0.4
-Summary: Edge monitoring software for secure and efficient device management.
-Author: Henk van den Brink
-Author-email: henk.vandenbrink@bedger.io
-Requires-Python: >=3.8.1,<4.0.0
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: pydantic (>=2.9.2,<3.0.0)
-Requires-Dist: typing-extensions (>=4.12.2,<5.0.0)
-Project-URL: homepage, https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk
-Project-URL: issues, https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk/issues
-Description-Content-Type: text/markdown
-
-# ConnectionManager Class Documentation
-
-The `ConnectionManager` class manages connections to a UNIX socket for sending and receiving messages.
-It provides context management capabilities to ensure connections are properly opened and closed.
-
-## Features
-- Context manager support for connection lifecycle management.
-- Error handling for socket-related issues.
-- Sends event messages with acknowledgment handling.
-
-## Installation
-Ensure you have the `bedger` package and its dependencies installed.
-
-```bash
-pip install bedger
-```
-
-## Usage
-The following example demonstrates how to use the `ConnectionManager` to send events:
-
-```python
-import time
-import bedger.edge.config as config
-import bedger.edge.connection as connection
-import bedger.edge.entities as entities
-
-if __name__ == "__main__":
-    events = [
-        {"event_type": "EventA", "severity": entities.Severity.HIGH, "payload": {"key": "value1"}},
-        {"event_type": "EventB", "severity": entities.Severity.LOW, "payload": {"key": "value2"}},
-        {"event_type": "EventC", "severity": entities.Severity.CRITICAL, "payload": {"key": "value3"}},
-    ]
-
-    with connection.ConnectionManager(config.Config()) as conn:
-        for event in events:
-            time.sleep(1)
-            conn.send_event(event["event_type"], event["severity"], event["payload"])
-```
-
-## API Reference
-
-### `ConnectionManager`
-Manages a connection to a UNIX socket for sending and receiving messages.
-
-#### Constructor
-- **`__init__(config: Config = Config())`**
-  - Initializes the `ConnectionManager` with a specified configuration.
-  - **Parameters:**
-    - `config (Config)`: The configuration containing the socket path. Defaults to a new `Config` instance.
-
-#### Context Management
-- **`__enter__() -> ConnectionManager`**
-  - Establishes the socket connection when entering the context.
-  - **Returns:** The instance of the `ConnectionManager`.
-
-- **`__exit__(exc_type, exc_value, traceback) -> None`**
-  - Closes the socket connection when exiting the context.
-
-#### Methods
-- **`send_event(event_type: str, severity: str | Severity, payload: dict) -> None`**
-  - Sends an event message through the socket.
-  - **Parameters:**
-    - `event_type (str)`: The type of event being sent.
-    - `severity (str | Severity)`: The severity level of the event.
-    - `payload (dict)`: The event's payload details.
-  - **Raises:**
-    - `SocketNotConnectedError`: If no active socket connection exists.
-    - `SocketBrokenPipeError`: If the socket connection is lost during transmission.
-    - `SocketCommunicationError`: If an error occurs during socket communication.
-
-## Error Handling
-The `ConnectionManager` raises custom errors from the `bedger.edge.errors` module for:
-- Permission issues (`SocketPermissionDeniedError`).
-- Missing socket files (`SocketFileNotFoundError`).
-- Connection problems (`SocketConnectionError`).
-- Communication errors (`SocketCommunicationError`, `SocketBrokenPipeError`).
-
-## Logging
-The class uses the `logging` module to log the following:
-- Connection attempts and successes.
-- Errors during connection, disconnection, and message sending.
-- Debug information for message preparation and acknowledgments.
-
-## License
-This project is licensed under the MIT License. See the LICENSE file for details.
-

bedger-0.0.4/README.md

@@ -1,85 +0,0 @@
-# ConnectionManager Class Documentation
-
-The `ConnectionManager` class manages connections to a UNIX socket for sending and receiving messages.
-It provides context management capabilities to ensure connections are properly opened and closed.
-
-## Features
-- Context manager support for connection lifecycle management.
-- Error handling for socket-related issues.
-- Sends event messages with acknowledgment handling.
-
-## Installation
-Ensure you have the `bedger` package and its dependencies installed.
-
-```bash
-pip install bedger
-```
-
-## Usage
-The following example demonstrates how to use the `ConnectionManager` to send events:
-
-```python
-import time
-import bedger.edge.config as config
-import bedger.edge.connection as connection
-import bedger.edge.entities as entities
-
-if __name__ == "__main__":
-    events = [
-        {"event_type": "EventA", "severity": entities.Severity.HIGH, "payload": {"key": "value1"}},
-        {"event_type": "EventB", "severity": entities.Severity.LOW, "payload": {"key": "value2"}},
-        {"event_type": "EventC", "severity": entities.Severity.CRITICAL, "payload": {"key": "value3"}},
-    ]
-
-    with connection.ConnectionManager(config.Config()) as conn:
-        for event in events:
-            time.sleep(1)
-            conn.send_event(event["event_type"], event["severity"], event["payload"])
-```
-
-## API Reference
-
-### `ConnectionManager`
-Manages a connection to a UNIX socket for sending and receiving messages.
-
-#### Constructor
-- **`__init__(config: Config = Config())`**
-  - Initializes the `ConnectionManager` with a specified configuration.
-  - **Parameters:**
-    - `config (Config)`: The configuration containing the socket path. Defaults to a new `Config` instance.
-
-#### Context Management
-- **`__enter__() -> ConnectionManager`**
-  - Establishes the socket connection when entering the context.
-  - **Returns:** The instance of the `ConnectionManager`.
-
-- **`__exit__(exc_type, exc_value, traceback) -> None`**
-  - Closes the socket connection when exiting the context.
-
-#### Methods
-- **`send_event(event_type: str, severity: str | Severity, payload: dict) -> None`**
-  - Sends an event message through the socket.
-  - **Parameters:**
-    - `event_type (str)`: The type of event being sent.
-    - `severity (str | Severity)`: The severity level of the event.
-    - `payload (dict)`: The event's payload details.
-  - **Raises:**
-    - `SocketNotConnectedError`: If no active socket connection exists.
-    - `SocketBrokenPipeError`: If the socket connection is lost during transmission.
-    - `SocketCommunicationError`: If an error occurs during socket communication.
-
-## Error Handling
-The `ConnectionManager` raises custom errors from the `bedger.edge.errors` module for:
-- Permission issues (`SocketPermissionDeniedError`).
-- Missing socket files (`SocketFileNotFoundError`).
-- Connection problems (`SocketConnectionError`).
-- Communication errors (`SocketCommunicationError`, `SocketBrokenPipeError`).
-
-## Logging
-The class uses the `logging` module to log the following:
-- Connection attempts and successes.
-- Errors during connection, disconnection, and message sending.
-- Debug information for message preparation and acknowledgments.
-
-## License
-This project is licensed under the MIT License. See the LICENSE file for details.

bedger-0.0.4/pyproject.toml

@@ -1,51 +0,0 @@
-[tool.poetry]
-name = "bedger"
-version = "0.0.4"
-description = "Edge monitoring software for secure and efficient device management."
-authors = ["Henk van den Brink <henk.vandenbrink@bedger.io>"]
-readme = "README.md"
-packages = [{include = "bedger", from = "src"}]
-
-[tool.poetry.urls]
-homepage = "https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk"
-issues = "https://github.com/bedger-io/BEDGER-edgeservices-securitymonitoring-sdk/issues"
-
-[tool.poetry.dependencies]
-python = "^3.8.1,<=4.0.0"
-typing-extensions = "^4.12.2"
-pydantic = "^2.9.2"
-
-[tool.poetry.group.dev.dependencies]
-black = "^24.4.0"
-isort = "^5.13.2"
-flake8-pyproject = "^1.2.3"
-
-[build-system]
-requires = ["poetry>=1.6"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.isort]
-profile = "black"
-line_length = 130
-
-[tool.flake8]
-max-line-length = 130
-exclude = [".git", "__pycache__", ".venv"]
-
-[tool.black]
-line-length = 130
-target-version = ["py310", "py311"]
-exclude = '''
-/(
-  \.git
-  | \.venv
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | _build
-  | buck-out
-  | build
-  | dist
-  | node_modules
-)/
-'''

bedger-0.0.4/src/bedger/edge/connection.py

@@ -1,123 +0,0 @@
-from __future__ import annotations
-
-import logging
-import socket
-from typing import Optional
-
-from bedger.edge import errors
-from bedger.edge.config import Config
-from bedger.edge.entities import Message, Severity
-
-logger = logging.getLogger("bedger.edge.connection")
-
-
-class ConnectionManager:
-    """Manages a connection to a UNIX socket for sending and receiving messages.
-
-    This class provides context manager support for establishing and tearing
-    down a connection to a UNIX socket.
-
-    Attributes:
-        _config (Config): The configuration containing the socket path.
-        _socket (Optional[socket.socket]): The current socket connection.
-    """
-
-    def __init__(self, config: Config = Config()):
-        """Initializes the ConnectionManager.
-
-        Args:
-            config (Config): Configuration for the connection. Defaults to a new `Config` instance.
-        """
-        self._config = config
-        self._socket: Optional[socket.socket] = None
-
-    def __enter__(self) -> ConnectionManager:
-        """Establishes the socket connection when entering the context.
-
-        Returns:
-            ConnectionManager: The instance of the ConnectionManager.
-        """
-        self._connect()
-        return self
-
-    def __exit__(self, exc_type, exc_value, traceback) -> None:
-        """Closes the socket connection when exiting the context."""
-        self._disconnect()
-
-    def _connect(self) -> None:
-        """Establish a connection to the UNIX socket.
-
-        Raises:
-            errors.SocketPermissionDeniedError: If the application does not have permission to connect to the socket.
-            errors.SocketFileNotFoundError: If the socket file is not found at the specified path.
-            errors.SocketConnectionError: If any other error occurs during the connection attempt.
-        """
-        logger.info(f"Attempting to connect to socket at {self._config.socket_path}")
-        try:
-            self._socket = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
-            self._socket.connect(self._config.socket_path)
-            logger.info("Successfully connected to the socket")
-        except PermissionError:
-            logger.error("Permission denied: Unable to connect to the socket. Ensure you have the correct permissions.")
-            raise errors.SocketPermissionDeniedError("Permission denied to connect to socket. Are you running as root?")
-        except FileNotFoundError:
-            logger.error("Socket file not found. Verify the server is running and the socket path is correct.")
-            raise errors.SocketFileNotFoundError("Socket file not found. Is the server running?")
-        except Exception as e:
-            logger.exception(f"Unexpected error while connecting to the socket: {e}")
-            raise errors.SocketConnectionError(f"An unexpected error occurred while connecting to the socket: {e}")
-
-    def _disconnect(self) -> None:
-        """Close the socket connection gracefully.
-
-        Ensures the socket is closed and cleaned up properly, even in case of errors.
-        """
-        if self._socket:
-            try:
-                logger.info("Closing the socket connection")
-                self._socket.close()
-            except Exception as e:
-                logger.warning(f"Error occurred while closing the socket: {e}")
-            finally:
-                self._socket = None
-
-    def send_event(self, event_type: str, severity: str | Severity, payload: dict) -> None:
-        """Send an event message through the socket.
-
-        Args:
-            event_type (str): The type of event being sent.
-            severity (str | Severity): The severity level of the event.
-            payload (dict): The event's payload details.
-
-        Raises:
-            errors.SocketNotConnectedError: If no active socket connection exists.
-            errors.SocketBrokenPipeError: If the socket connection is lost during message transmission.
-            errors.SocketCommunicationError: If any error occurs during socket communication.
-        """
-        if not self._socket:
-            logger.error("Attempted to send a message without an active socket connection.")
-            raise errors.SocketNotConnectedError("No active socket connection. Ensure the connection is established.")
-
-        try:
-            message = Message(
-                event_type=event_type,
-                severity=severity,
-                details=payload,
-            )
-            message_json = message.model_dump_json()
-            logger.debug(f"Prepared message: {message_json}")
-
-            logger.debug("Sending message")
-            self._socket.sendall(message_json.encode())
-
-            ack = self._socket.recv(1024)
-            logger.info(f"Received acknowledgment from server: {ack.decode()}")
-        except BrokenPipeError:
-            logger.error("Broken pipe error: The socket connection was lost during message transmission.")
-            raise errors.SocketBrokenPipeError("Socket connection lost. Unable to send message.")
-        except socket.error as e:
-            logger.error(f"Socket error occurred: {e}")
-            raise errors.SocketCommunicationError(f"Socket error during communication: {e}")
-        except Exception as e:
-            logger.exception(f"Unexpected error while sending the message: {e}")
-            raise errors.SocketCommunicationError(f"Unexpected error occurred: {e}")

bedger-0.0.4/src/bedger/edge/errors.py

@@ -1,18 +0,0 @@
-class SocketPermissionDeniedError(Exception):
-    pass
-
-
-class SocketFileNotFoundError(Exception):
-    pass
-
-
-class SocketConnectionError(Exception):
-    pass
-
-
-class SocketNotConnectedError(Exception):
-    pass
-
-
-class SocketCommunicationError(Exception):
-    pass