fairagro-middleware-shared 8.6.2__tar.gz

fairagro_middleware_shared-8.6.2/.gitignore

@@ -0,0 +1,229 @@
+# 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
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Allow encrypted .env.integration.enc but ignore any unencrypted .env files
+!.env.integration.enc
+
+# 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/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+scratch/
+**/*.csv
+**/*.stats
+
+**/*.decrypted.*
+
+# Cryptographic keys and certificates for testing that are not meant to be committed
+helmchart/**/*.crt
+helmchart/**/*.key
+helmchart/**/*.csr
+helmchart/**/*.srl
+helmchart/**/server.conf
+helmchart/**/client_ext.conf
+
+# ggshield cache
+.cache_ggshield
+
+docker/Dockerfile.api.bak

fairagro_middleware_shared-8.6.2/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: fairagro-middleware-shared
+Version: 8.6.2
+Summary: The FAIRagro advanced middleware shared components
+Requires-Python: >=3.12
+Requires-Dist: opentelemetry-api>=1.26.0
+Requires-Dist: opentelemetry-exporter-otlp>=1.26.0
+Requires-Dist: opentelemetry-instrumentation-logging>=0.47b0
+Requires-Dist: opentelemetry-sdk>=1.26.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pyyaml>=6.0.3
+Description-Content-Type: text/markdown
+
+# FAIRagro Advanced Middleware - Shared Components
+
+This package contains shared utilities and components used across the FAIRagro Advanced Middleware system.
+
+## Overview
+
+The `shared` package provides:
+
+- **Configuration Management**: Base classes and utilities for configuration handling
+- **Common Models**: Pydantic models used across multiple middleware components
+- **Utilities**: Helper functions and classes for common operations
+
+## Components
+
+### Configuration (`middleware.shared.config`)
+
+Configuration utilities including:
+
+- `ConfigWrapper`: Base class for configuration management
+- Environment variable handling
+- Configuration validation with Pydantic
+
+### Models
+
+Shared Pydantic models for data validation and serialization across the middleware.
+
+## Usage
+
+This package is used as a dependency by other middleware components:
+
+- `api`: The main REST API
+- `api_client`: Client library for API interaction
+- `inspire_to_arc`: INSPIRE metadata to ARC conversion
+
+## Dependencies
+
+- `pydantic>=2.12.4`: Data validation and settings management
+
+## Development
+
+Install in development mode:
+
+```bash
+uv sync --package shared
+```
+
+Run tests:
+
+```bash
+uv run pytest middleware/shared/tests
+```

fairagro_middleware_shared-8.6.2/README.md

@@ -0,0 +1,51 @@
+# FAIRagro Advanced Middleware - Shared Components
+
+This package contains shared utilities and components used across the FAIRagro Advanced Middleware system.
+
+## Overview
+
+The `shared` package provides:
+
+- **Configuration Management**: Base classes and utilities for configuration handling
+- **Common Models**: Pydantic models used across multiple middleware components
+- **Utilities**: Helper functions and classes for common operations
+
+## Components
+
+### Configuration (`middleware.shared.config`)
+
+Configuration utilities including:
+
+- `ConfigWrapper`: Base class for configuration management
+- Environment variable handling
+- Configuration validation with Pydantic
+
+### Models
+
+Shared Pydantic models for data validation and serialization across the middleware.
+
+## Usage
+
+This package is used as a dependency by other middleware components:
+
+- `api`: The main REST API
+- `api_client`: Client library for API interaction
+- `inspire_to_arc`: INSPIRE metadata to ARC conversion
+
+## Dependencies
+
+- `pydantic>=2.12.4`: Data validation and settings management
+
+## Development
+
+Install in development mode:
+
+```bash
+uv sync --package shared
+```
+
+Run tests:
+
+```bash
+uv run pytest middleware/shared/tests
+```

fairagro_middleware_shared-8.6.2/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "fairagro-middleware-shared"
+dynamic = ["version"]
+description = "The FAIRagro advanced middleware shared components"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "pydantic>=2.12.5",
+    "pyyaml>=6.0.3",
+    "opentelemetry-api>=1.26.0",
+    "opentelemetry-sdk>=1.26.0",
+    "opentelemetry-exporter-otlp>=1.26.0",
+    "opentelemetry-instrumentation-logging>=0.47b0",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/middleware"]
+
+[tool.ruff]
+extend = "../../pyproject.toml"
+
+[tool.hatch.version]
+source = "vcs"
+raw-options = { root = "../..", fallback_version = "0.0.0", tag_regex = "^(?:v|.*-(?:chart|docker)-v)(?P<version>\\d+\\.\\d+\\.\\d+)(?:$|[-+].*)" }
+
+[build-system]
+requires = ["hatchling", "hatch-vcs"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "types-pyyaml>=6.0.12.20250915",
+]

fairagro_middleware_shared-8.6.2/src/middleware/shared/__init__.py

@@ -0,0 +1 @@
+"""Contains same generic utility functions."""

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/__init__.py

@@ -0,0 +1,30 @@
+"""FAIRagro Middleware API Models package.
+
+Backward compatibility layer for refactored shared models.
+"""
+
+from .common import models as common
+from .v1 import models as v1
+from .v2 import models as v2
+
+# Common / Shared
+ArcStatus = common.ArcStatus
+TaskStatus = common.TaskStatus
+ApiResponse = common.ApiResponse
+ArcResponse = common.ArcResponse  # V1/V2 common
+
+# V1 Models
+LivenessResponse = v1.LivenessResponse
+HealthResponse = v1.HealthResponse
+CreateOrUpdateArcsRequest = v1.CreateOrUpdateArcsRequest
+CreateOrUpdateArcsResponse = v1.CreateOrUpdateArcsResponse
+GetTaskStatusResponse = v1.GetTaskStatusResponse
+WhoamiResponse = v1.WhoamiResponse
+ArcTaskTicket = v1.ArcTaskTicket
+
+# V2 Models
+HealthResponseV2 = v2.HealthResponse
+CreateOrUpdateArcRequest = v2.CreateOrUpdateArcRequest
+CreateOrUpdateArcResponse = v2.CreateOrUpdateArcResponse
+ArcOperationResult = v2.ArcOperationResult
+GetTaskStatusResponseV2 = v2.GetTaskStatusResponse

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/common/__init__.py

@@ -0,0 +1 @@
+"""Common API models."""

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/common/models.py

@@ -0,0 +1,104 @@
+"""Common models and enums shared across API versions."""
+
+from enum import StrEnum
+from typing import Annotated
+
+from pydantic import BaseModel, Field
+
+
+class ArcStatus(StrEnum):
+    """Enumeration of possible ARC status values."""
+
+    CREATED = "created"
+    UPDATED = "updated"
+    DELETED = "deleted"
+    REQUESTED = "requested"
+
+
+class TaskStatus(StrEnum):
+    """Enumeration of possible task states.
+
+    Values match Celery task states.
+    """
+
+    PENDING = "PENDING"
+    STARTED = "STARTED"
+    SUCCESS = "SUCCESS"
+    FAILURE = "FAILURE"
+    RETRY = "RETRY"
+    REVOKED = "REVOKED"
+
+
+class ArcLifecycleStatus(StrEnum):
+    """ARC lifecycle status in the system."""
+
+    ACTIVE = "ACTIVE"  # Normal active state
+    PROCESSING = "PROCESSING"  # Git workflow in progress
+    MISSING = "MISSING"  # Not seen in recent harvest
+    DELETED = "DELETED"  # Soft-deleted (not physically removed)
+    INVALID = "INVALID"  # Validation failed
+
+
+class ArcEventType(StrEnum):
+    """Types of events in the ARC event log."""
+
+    # Lifecycle events
+    ARC_CREATED = "ARC_CREATED"
+    ARC_UPDATED = "ARC_UPDATED"
+    ARC_NOT_SEEN = "ARC_NOT_SEEN"
+    ARC_MARKED_MISSING = "ARC_MARKED_MISSING"
+    ARC_MARKED_DELETED = "ARC_MARKED_DELETED"
+    ARC_RESTORED = "ARC_RESTORED"  # Reappeared after being marked missing/deleted
+    ARC_NOT_CHANGED = "ARC_NOT_CHANGED"  # Explicitly tracking no-change events (if needed)
+
+    # Git workflow events
+    GIT_QUEUED = "GIT_QUEUED"
+    GIT_PROCESSING = "GIT_PROCESSING"
+    GIT_PUSH_SUCCESS = "GIT_PUSH_SUCCESS"
+    GIT_PUSH_FAILED = "GIT_PUSH_FAILED"
+
+    # Validation events
+    VALIDATION_WARNING = "VALIDATION_WARNING"
+    VALIDATION_ERROR = "VALIDATION_ERROR"
+    VALIDATION_SUCCESS = "VALIDATION_SUCCESS"
+
+    # Operator actions
+    OPERATOR_NOTE = "OPERATOR_NOTE"
+    MANUAL_DELETION = "MANUAL_DELETION"
+
+
+class HarvestStatus(StrEnum):
+    """Harvest run status."""
+
+    RUNNING = "RUNNING"
+    COMPLETED = "COMPLETED"
+    FAILED = "FAILED"
+    CANCELLED = "CANCELLED"
+
+
+class ApiResponse(BaseModel):
+    """Base response model for business logic operations."""
+
+    client_id: Annotated[
+        str | None,
+        Field(
+            description="Client identifier which is the CN from the client certificate, "
+            "or 'unknown' if client certificates are not required",
+        ),
+    ] = None
+    message: Annotated[str, Field(description="Response message")] = ""
+
+
+class ArcResponse(BaseModel):
+    """Response model for individual ARC operations."""
+
+    id: Annotated[str, Field(description="ARC identifier, as hashed value of the original identifier and RDI")]
+    status: Annotated[ArcStatus, Field(description="Status of the ARC operation")]
+    timestamp: Annotated[str, Field(description="Timestamp of the ARC operation in ISO 8601 format")]
+
+
+class ArcOperationResult(ApiResponse):
+    """Response model for the actual result of a single ARC operation."""
+
+    rdi: Annotated[str, Field(description="Research Data Infrastructure identifier the ARC belongs to")]
+    arc: Annotated[ArcResponse, Field(description="ARC response for the operation")]

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/v1/__init__.py

@@ -0,0 +1 @@
+"""V1 API models."""

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/v1/models.py

@@ -0,0 +1,74 @@
+"""V1 API Models."""
+
+from typing import Annotated
+
+from pydantic import BaseModel, Field
+
+from ..common.models import ApiResponse, ArcResponse
+
+
+class LivenessResponse(BaseModel):
+    """Response model for liveness check."""
+
+    message: Annotated[str, Field(description="Liveness message")] = "ok"
+
+
+class HealthResponse(BaseModel):
+    """Response model for health check including backend status."""
+
+    status: Annotated[str, Field(description="Overall service status (ok/error)")] = "ok"
+    redis_reachable: Annotated[
+        bool,
+        Field(
+            description="[DEPRECATED] Kept for backward compatibility. Always True as Redis is no longer used.",
+            deprecated=True,
+        ),
+    ] = True
+    rabbitmq_reachable: Annotated[bool, Field(description="True if RabbitMQ is reachable")]
+
+
+class WhoamiResponse(ApiResponse):
+    """Response model for whoami operation."""
+
+    accessible_rdis: Annotated[
+        list[str], Field(description="List of Research Data Infrastructures the client is authorized for")
+    ]
+
+
+class ArcTaskTicket(ApiResponse):
+    """Response model for a newly created async task ticket."""
+
+    rdi: Annotated[str, Field(description="Research Data Infrastructure identifier the ARC belongs to")]
+    task_id: Annotated[str, Field(description="Async task ID")]
+
+
+class CreateOrUpdateArcsRequest(BaseModel):
+    """Request model for creating or updating ARCs."""
+
+    rdi: Annotated[str, Field(description="Research Data Infrastructure identifier")]
+    arcs: Annotated[list[dict], Field(description="List of ARC definitions in RO-Crate JSON format")]
+
+
+class CreateOrUpdateArcsResponse(ApiResponse):
+    """Response model for create or update ARC operations (Task Ticket or Result)."""
+
+    rdi: Annotated[str | None, Field(description="Research Data Infrastructure identifier the ARCs belong to")] = None
+    arcs: Annotated[list[ArcResponse], Field(description="List of ARC responses for the operation")] = Field(
+        default_factory=list
+    )
+
+    # Async task fields
+    task_id: Annotated[str | None, Field(description="The ID of the background task processing the ARC")] = None
+    status: Annotated[str | None, Field(description="The status of the task submission")] = None
+
+
+class GetTaskStatusResponse(BaseModel):
+    """Response model for task status."""
+
+    task_id: Annotated[str, Field(description="The ID of the background task")]
+    status: Annotated[str, Field(description="The status of the task")]
+    result: Annotated[
+        CreateOrUpdateArcsResponse | None,
+        Field(description="The result of the task if completed"),
+    ] = None
+    error: Annotated[str | None, Field(description="Error message if task failed")] = None

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/v2/__init__.py

@@ -0,0 +1 @@
+"""V2 API models."""

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/v2/models.py

@@ -0,0 +1,38 @@
+"""V2 API Models."""
+
+from typing import Annotated
+
+from pydantic import BaseModel, Field
+
+from ..common.models import ApiResponse, ArcOperationResult, TaskStatus
+
+
+class HealthResponse(BaseModel):
+    """Response model for health check v2."""
+
+    status: Annotated[str, Field(description="Overall service status (ok/error)")] = "ok"
+    services: Annotated[dict[str, bool], Field(description="Dictionary of service statuses")]
+
+
+class CreateOrUpdateArcRequest(BaseModel):
+    """Request model for creating or updating a single ARC."""
+
+    rdi: Annotated[str, Field(description="Research Data Infrastructure identifier")]
+    arc: Annotated[dict, Field(description="ARC definition in RO-Crate JSON format")]
+
+
+class CreateOrUpdateArcResponse(ApiResponse):
+    """Response model for create or update a single ARC operation ticket."""
+
+    task_id: Annotated[str, Field(description="The ID of the background task")]
+    status: Annotated[TaskStatus, Field(description="The status of the task")]
+
+
+class GetTaskStatusResponse(ApiResponse):
+    """Response model for task status."""
+
+    status: Annotated[TaskStatus, Field(description="The status of the task")]
+    result: Annotated[
+        ArcOperationResult | None,
+        Field(description="The result of the task if completed"),
+    ] = None

fairagro_middleware_shared-8.6.2/src/middleware/shared/api_models/v3/__init__.py

@@ -0,0 +1 @@
+"""V3 API models."""