openframe-adapters-db-mongo 1.0.0__tar.gz

openframe_adapters_db_mongo-1.0.0/.gitignore

@@ -0,0 +1,218 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

openframe_adapters_db_mongo-1.0.0/PKG-INFO

@@ -0,0 +1,198 @@
+Metadata-Version: 2.4
+Name: openframe-adapters-db-mongo
+Version: 1.0.0
+Summary: OpenFrame Microservice Suite — MongoDB document store adapter.
+License: MIT
+Keywords: document-store,hexagonal,microservice,mongodb,motor,openframe
+Requires-Python: >=3.11
+Requires-Dist: motor>=3.3
+Requires-Dist: openframe-core<2,>=1.0
+Requires-Dist: pymongo>=4.6
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# openframe-adapters-db-mongo
+
+MongoDB document store adapter for the **OpenFrame Microservice Suite**.
+
+Part of the `openframe-adapters` monorepo. Implements `BaseRepository[T]` and
+`HealthCheck` from `openframe-core` using `motor` (`AsyncIOMotorClient`).
+
+---
+
+## Installation
+
+```bash
+pip install openframe-adapters-db-mongo
+```
+
+Required env vars:
+
+```
+MONGO_URL=mongodb://user:password@host:27017
+MONGO_DATABASE=mydb
+```
+
+Atlas SRV URIs work too:
+
+```
+MONGO_URL=mongodb+srv://user:password@cluster.mongodb.net
+```
+
+---
+
+## Quick start
+
+### Raw dict mode
+
+```python
+from openframe.adapters.db.mongo import MongoSettings, MongoRepository
+
+settings = MongoSettings()  # reads MONGO_URL and MONGO_DATABASE from env
+repo = MongoRepository(settings, collection="artifacts")
+
+doc = await repo.get("507f1f77bcf86cd799439011")   # dict | None
+docs, total = await repo.list(10, 0)                # ([dict, ...], int)
+created = await repo.create({"title": "paper"})
+updated = await repo.update({"_id": "...", "title": "updated"})
+deleted = await repo.delete("507f1f77bcf86cd799439011")  # bool
+```
+
+### Typed domain mode
+
+```python
+from dataclasses import dataclass
+from openframe.adapters.db.mongo import MongoSettings, MongoRepository
+
+@dataclass
+class Artifact:
+    id: str
+    title: str
+    artifact_type: str
+
+class ArtifactRepository(MongoRepository[Artifact]):
+    _collection = "artifacts"
+
+    def _doc_to_entity(self, doc: dict) -> Artifact:
+        return Artifact(
+            id=doc["_id"],
+            title=doc["title"],
+            artifact_type=doc["artifact_type"],
+        )
+
+    def _entity_to_doc(self, entity: Artifact) -> dict:
+        return {
+            "_id": entity.id,
+            "title": entity.title,
+            "artifact_type": entity.artifact_type,
+        }
+
+settings = MongoSettings()
+repo = ArtifactRepository(settings)
+artifact: Artifact | None = await repo.get("507f1f77bcf86cd799439011")
+```
+
+---
+
+## `_id` handling
+
+MongoDB uses `_id` as the document identifier; `BaseRepository` uses
+`entity_id: str`. The adapter bridges this transparently:
+
+- **Reading:** `_id` is always returned as `str` — `ObjectId` is never
+  exposed to callers. A convenience `id` key is also added mirroring `_id`.
+- **Writing:** If an entity dict has an `id` key but no `_id` key, the
+  adapter maps `id` → `_id` before insertion.
+- **Filtering:** String entity IDs that are valid 24-char hex are parsed
+  as `ObjectId` for indexed lookups; other strings are used as plain string
+  `_id` values.
+
+---
+
+## Configuration
+
+All settings are read from environment variables.
+
+| Env var | Type | Default | Description |
+|---|---|---|---|
+| `MONGO_URL` | `str` | **required** | Motor/pymongo connection string |
+| `MONGO_DATABASE` | `str` | **required** | Database name |
+| `MONGO_MIN_POOL_SIZE` | `int` | `5` | Minimum pool connections |
+| `MONGO_MAX_POOL_SIZE` | `int` | `20` | Maximum pool connections |
+| `MONGO_SERVER_SELECTION_TIMEOUT_MS` | `int` | `5000` | Server selection timeout (ms) |
+| `MONGO_TLS` | `bool` | `False` | Enable TLS/SSL |
+| `MONGO_TLS_ALLOW_INVALID_CERTS` | `bool` | `False` | Skip cert validation (dev only) |
+| `CONNECTION_TIMEOUT` | `float` | `30.0` | Pool creation timeout (s) |
+| `OPERATION_TIMEOUT` | `float` | `10.0` | Per-operation timeout (s) |
+| `MAX_RETRIES` | `int` | `3` | Max retry attempts |
+
+---
+
+## Timeout strategy
+
+Two layers of timeout on every operation:
+
+1. `asyncio.timeout(settings.operation_timeout)` — cancels the Python coroutine.
+2. `max_time_ms=int(settings.operation_timeout * 1000)` passed to motor query
+   methods — instructs the MongoDB server to abort the query.
+
+---
+
+## Health checks
+
+`MongoRepository` implements the `HealthCheck` protocol from `openframe-core`.
+
+```python
+alive = await repo.ping()       # admin.command("ping") — fast liveness check
+ready = await repo.is_ready()   # list_collection_names() — full readiness check
+```
+
+Both methods return `False` on any failure and never raise.
+
+---
+
+## Exception hierarchy
+
+All exceptions are `AdapterError` subclasses from `openframe.core.exceptions`.
+Raw motor/pymongo exceptions never escape the adapter.
+
+| Situation | Exception |
+|---|---|
+| Cannot connect to MongoDB | `AdapterConnectionError` |
+| Invalid `MONGO_URL` syntax | `AdapterConfigurationError` |
+| Query failed (constraint, auth, etc.) | `AdapterQueryError` |
+| Operation exceeded timeout | `AdapterTimeoutError` |
+
+---
+
+## Development
+
+```bash
+# from the package directory
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+---
+
+## Protocol conformance
+
+```python
+from openframe.core.ports import BaseRepository
+from openframe.core.health import HealthCheck
+
+repo = MongoRepository(settings, collection="artifacts")
+assert isinstance(repo, BaseRepository)   # True — structural check
+assert isinstance(repo, HealthCheck)      # True — structural check
+```
+
+No inheritance from either Protocol is required or used.
+
+---
+
+## License
+
+MIT

openframe_adapters_db_mongo-1.0.0/README.md

@@ -0,0 +1,182 @@
+# openframe-adapters-db-mongo
+
+MongoDB document store adapter for the **OpenFrame Microservice Suite**.
+
+Part of the `openframe-adapters` monorepo. Implements `BaseRepository[T]` and
+`HealthCheck` from `openframe-core` using `motor` (`AsyncIOMotorClient`).
+
+---
+
+## Installation
+
+```bash
+pip install openframe-adapters-db-mongo
+```
+
+Required env vars:
+
+```
+MONGO_URL=mongodb://user:password@host:27017
+MONGO_DATABASE=mydb
+```
+
+Atlas SRV URIs work too:
+
+```
+MONGO_URL=mongodb+srv://user:password@cluster.mongodb.net
+```
+
+---
+
+## Quick start
+
+### Raw dict mode
+
+```python
+from openframe.adapters.db.mongo import MongoSettings, MongoRepository
+
+settings = MongoSettings()  # reads MONGO_URL and MONGO_DATABASE from env
+repo = MongoRepository(settings, collection="artifacts")
+
+doc = await repo.get("507f1f77bcf86cd799439011")   # dict | None
+docs, total = await repo.list(10, 0)                # ([dict, ...], int)
+created = await repo.create({"title": "paper"})
+updated = await repo.update({"_id": "...", "title": "updated"})
+deleted = await repo.delete("507f1f77bcf86cd799439011")  # bool
+```
+
+### Typed domain mode
+
+```python
+from dataclasses import dataclass
+from openframe.adapters.db.mongo import MongoSettings, MongoRepository
+
+@dataclass
+class Artifact:
+    id: str
+    title: str
+    artifact_type: str
+
+class ArtifactRepository(MongoRepository[Artifact]):
+    _collection = "artifacts"
+
+    def _doc_to_entity(self, doc: dict) -> Artifact:
+        return Artifact(
+            id=doc["_id"],
+            title=doc["title"],
+            artifact_type=doc["artifact_type"],
+        )
+
+    def _entity_to_doc(self, entity: Artifact) -> dict:
+        return {
+            "_id": entity.id,
+            "title": entity.title,
+            "artifact_type": entity.artifact_type,
+        }
+
+settings = MongoSettings()
+repo = ArtifactRepository(settings)
+artifact: Artifact | None = await repo.get("507f1f77bcf86cd799439011")
+```
+
+---
+
+## `_id` handling
+
+MongoDB uses `_id` as the document identifier; `BaseRepository` uses
+`entity_id: str`. The adapter bridges this transparently:
+
+- **Reading:** `_id` is always returned as `str` — `ObjectId` is never
+  exposed to callers. A convenience `id` key is also added mirroring `_id`.
+- **Writing:** If an entity dict has an `id` key but no `_id` key, the
+  adapter maps `id` → `_id` before insertion.
+- **Filtering:** String entity IDs that are valid 24-char hex are parsed
+  as `ObjectId` for indexed lookups; other strings are used as plain string
+  `_id` values.
+
+---
+
+## Configuration
+
+All settings are read from environment variables.
+
+| Env var | Type | Default | Description |
+|---|---|---|---|
+| `MONGO_URL` | `str` | **required** | Motor/pymongo connection string |
+| `MONGO_DATABASE` | `str` | **required** | Database name |
+| `MONGO_MIN_POOL_SIZE` | `int` | `5` | Minimum pool connections |
+| `MONGO_MAX_POOL_SIZE` | `int` | `20` | Maximum pool connections |
+| `MONGO_SERVER_SELECTION_TIMEOUT_MS` | `int` | `5000` | Server selection timeout (ms) |
+| `MONGO_TLS` | `bool` | `False` | Enable TLS/SSL |
+| `MONGO_TLS_ALLOW_INVALID_CERTS` | `bool` | `False` | Skip cert validation (dev only) |
+| `CONNECTION_TIMEOUT` | `float` | `30.0` | Pool creation timeout (s) |
+| `OPERATION_TIMEOUT` | `float` | `10.0` | Per-operation timeout (s) |
+| `MAX_RETRIES` | `int` | `3` | Max retry attempts |
+
+---
+
+## Timeout strategy
+
+Two layers of timeout on every operation:
+
+1. `asyncio.timeout(settings.operation_timeout)` — cancels the Python coroutine.
+2. `max_time_ms=int(settings.operation_timeout * 1000)` passed to motor query
+   methods — instructs the MongoDB server to abort the query.
+
+---
+
+## Health checks
+
+`MongoRepository` implements the `HealthCheck` protocol from `openframe-core`.
+
+```python
+alive = await repo.ping()       # admin.command("ping") — fast liveness check
+ready = await repo.is_ready()   # list_collection_names() — full readiness check
+```
+
+Both methods return `False` on any failure and never raise.
+
+---
+
+## Exception hierarchy
+
+All exceptions are `AdapterError` subclasses from `openframe.core.exceptions`.
+Raw motor/pymongo exceptions never escape the adapter.
+
+| Situation | Exception |
+|---|---|
+| Cannot connect to MongoDB | `AdapterConnectionError` |
+| Invalid `MONGO_URL` syntax | `AdapterConfigurationError` |
+| Query failed (constraint, auth, etc.) | `AdapterQueryError` |
+| Operation exceeded timeout | `AdapterTimeoutError` |
+
+---
+
+## Development
+
+```bash
+# from the package directory
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+---
+
+## Protocol conformance
+
+```python
+from openframe.core.ports import BaseRepository
+from openframe.core.health import HealthCheck
+
+repo = MongoRepository(settings, collection="artifacts")
+assert isinstance(repo, BaseRepository)   # True — structural check
+assert isinstance(repo, HealthCheck)      # True — structural check
+```
+
+No inheritance from either Protocol is required or used.
+
+---
+
+## License
+
+MIT

openframe_adapters_db_mongo-1.0.0/openframe/adapters/db/mongo/__init__.py

@@ -0,0 +1,49 @@
+"""
+openframe.adapters.db.mongo
+=============================
+MongoDB document store adapter for the OpenFrame Microservice Suite.
+
+Public API:
+
+    MongoSettings      — Pydantic Settings subclass for connection config.
+    MongoRepository    — Generic async repository (BaseRepository + HealthCheck).
+    get_mongo_client   — Synchronous factory that creates / returns the cached client.
+
+Quick start::
+
+    from openframe.adapters.db.mongo import (
+        MongoSettings,
+        MongoRepository,
+        get_mongo_client,
+    )
+
+    settings = MongoSettings(
+        mongo_url="mongodb://user:pw@localhost:27017",
+        mongo_database="mydb",
+    )
+
+    # Raw dict mode
+    repo = MongoRepository(settings, collection="artifacts")
+    doc = await repo.get("507f1f77bcf86cd799439011")    # dict | None
+
+    # Typed mode — subclass and override mapping methods
+    class ArtifactRepository(MongoRepository[Artifact]):
+        _collection = "artifacts"
+
+        def _doc_to_entity(self, doc):
+            return Artifact(**doc)
+
+        def _entity_to_doc(self, entity):
+            return entity.model_dump()
+"""
+from __future__ import annotations
+
+from .config import MongoSettings
+from .connection import get_mongo_client
+from .repository import MongoRepository
+
+__all__ = [
+    "MongoSettings",
+    "MongoRepository",
+    "get_mongo_client",
+]

openframe_adapters_db_mongo-1.0.0/openframe/adapters/db/mongo/config.py

@@ -0,0 +1,69 @@
+"""
+openframe/adapters/db/mongo/config.py
+=======================================
+MongoDB adapter settings.
+
+Reads all connection configuration from environment variables via Pydantic
+Settings. Every field is validated at instantiation — missing required fields
+raise ``pydantic_core.ValidationError`` immediately so misconfigured
+deployments fail fast on startup.
+
+Required env vars:
+    MONGO_URL:      Full motor/pymongo connection string.
+                    Standard: mongodb://user:pass@host:port
+                    Atlas:    mongodb+srv://user:pass@cluster.mongodb.net
+                    Atlas SRV URIs require dnspython, which motor resolves
+                    automatically — no extra dependency needed.
+    MONGO_DATABASE: Database name to operate on.
+
+Optional env vars (all have defaults):
+    MONGO_MIN_POOL_SIZE:               int  = 5
+    MONGO_MAX_POOL_SIZE:               int  = 20
+    MONGO_SERVER_SELECTION_TIMEOUT_MS: int  = 5000
+    MONGO_TLS:                         bool = False
+    MONGO_TLS_ALLOW_INVALID_CERTS:     bool = False
+    ADAPTER_NAME:                      str  = "mongo"
+"""
+from __future__ import annotations
+
+from openframe.core.config import BaseAdapterSettings
+
+__all__ = ["MongoSettings"]
+
+
+class MongoSettings(BaseAdapterSettings):
+    """
+    Settings for the MongoDB adapter.
+
+    All fields read from environment variables. Missing required fields raise
+    ``pydantic_core.ValidationError`` at instantiation time.
+
+    Inherits from ``BaseAdapterSettings``:
+        adapter_name:       str   = "mongo"   (overrides base default)
+        connection_timeout: float = 30.0
+        operation_timeout:  float = 10.0
+        max_retries:        int   = 3
+
+    Attributes:
+        mongo_url:                        Motor/pymongo connection string
+                                          (required). Standard or Atlas SRV.
+        mongo_database:                   Database name (required).
+        mongo_min_pool_size:              Minimum connections in the pool.
+                                          Default 5.
+        mongo_max_pool_size:              Maximum connections in the pool.
+                                          Default 20.
+        mongo_server_selection_timeout_ms: Milliseconds to wait for a suitable
+                                          server. Default 5000.
+        mongo_tls:                        Enable TLS/SSL. Default False.
+        mongo_tls_allow_invalid_certs:    Skip certificate validation — for
+                                          development only. Default False.
+    """
+
+    mongo_url: str
+    mongo_database: str
+    mongo_min_pool_size: int = 5
+    mongo_max_pool_size: int = 20
+    mongo_server_selection_timeout_ms: int = 5000
+    mongo_tls: bool = False
+    mongo_tls_allow_invalid_certs: bool = False
+    adapter_name: str = "mongo"