Merge branch 'main' into 87_order_parameters

Author: Phil Varner

.github/actions/pre-commit/action.yml

@@ -0,0 +1,12 @@
+**Related Issue(s):**
+
+- #
+
+**Proposed Changes:**
+
+1.
+2.
+
+**PR Checklist:**
+
+- [ ] I have added my changes to the [CHANGELOG](https://github.com/Element84/filmdrop-ui/blob/main/CHANGELOG.md) **or** a CHANGELOG entry is not required.

.github/pull_request_template.md

@@ -5,28 +5,24 @@ on:
     branches: ["main"]
 
 jobs:
-  lint:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - run: pipx install pre-commit
-      - name: Run commit checks
-        uses: ./.github/actions/pre-commit
-
   test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: ["3.12"]
-
     steps:
       - uses: actions/checkout@v4
       - run: pipx install poetry==1.7.1
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: ${{ matrix.python-version }}
           cache: poetry
       - name: Install dependencies
         run: poetry install --with=dev
+      - name: Lint code
+        if: ${{ matrix.python-version == 3.12 }}
+        run: |
+          python -m pip install pre-commit
+          pre-commit run --all-files
       - name: Run tests
         run: poetry run nox

.github/workflows/pr.yml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.5.0
+    rev: v5.0.0
     hooks:
       - id: check-merge-conflict
       - id: end-of-file-fixer
@@ -10,8 +10,15 @@ repos:
       - id: trailing-whitespace
       - id: no-commit-to-branch
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: "v0.3.7"
+    rev: v0.7.3
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
       - id: ruff-format
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v1.13.0
+    hooks:
+      - id: mypy
+        files: ".*\\.py$"
+        additional_dependencies:
+          - types-pyRFC3339~=1.1.1

.pre-commit-config.yaml

@@ -7,6 +7,30 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Added
+
+- Conformance endpoint `/conformance` and root body `conformsTo` attribute.
+
+### Changed
+
+none
+
+### Deprecated
+
+none
+
+### Removed
+
+none
+
+### Fixed
+
+none
+
+### Security
+
+none
+
 ## [v0.1.0] - 2024-10-23
 
 Initial release

CHANGELOG.md

@@ -1,14 +1,22 @@
 from uuid import uuid4
 
 from fastapi import FastAPI, Request
+
 from stapi_fastapi.backends.product_backend import ProductBackend
+from stapi_fastapi.backends.root_backend import RootBackend
 from stapi_fastapi.exceptions import NotFoundException
+from stapi_fastapi.models.conformance import CORE
 from stapi_fastapi.models.opportunity import (
     Opportunity,
     OpportunityProperties,
     OpportunityRequest,
 )
-from stapi_fastapi.models.order import Order, OrderParameters, OrderRequest
+from stapi_fastapi.models.order import (
+    Order,
+    OrderCollection,
+    OrderParameters,
+    OrderRequest,
+)
 from stapi_fastapi.models.product import (
     Product,
     Provider,
@@ -22,15 +30,15 @@ class MockOrderDB(dict[int | str, Order]):
     pass
 
 
-class MockRootBackend:
+class MockRootBackend(RootBackend):
     def __init__(self, orders: MockOrderDB) -> None:
         self._orders: MockOrderDB = orders
 
-    async def get_orders(self, request: Request) -> list[Order]:
+    async def get_orders(self, request: Request) -> OrderCollection:
         """
         Show all orders.
         """
-        return list(self._orders.values())
+        return OrderCollection(features=list(self._orders.values()))
 
     async def get_order(self, order_id: str, request: Request) -> Order:
         """
@@ -115,7 +123,7 @@ class TestOrderParameters(OrderParameters):
     backend=product_backend,
 )
 
-root_router = RootRouter(root_backend)
+root_router = RootRouter(root_backend, conformances=[CORE])
 root_router.add_product(product)
 app: FastAPI = FastAPI()
 app.include_router(root_router, prefix="")

bin/server.py

@@ -1,4 +1,4 @@
-from typing import Any
+from typing import Any, Optional
 
 from fastapi import HTTPException, status
 
@@ -13,5 +13,5 @@ def __init__(self, detail: Any) -> None:
 
 
 class NotFoundException(StapiException):
-    def __init__(self, detail: Any) -> None:
+    def __init__(self, detail: Optional[Any] = None) -> None:
         super().__init__(status.HTTP_404_NOT_FOUND, detail)

src/stapi_fastapi/exceptions.py

@@ -0,0 +1,10 @@
+from pydantic import BaseModel, Field
+
+CORE = "https://stapi.example.com/v0.1.0/core"
+OPPORTUNITIES = "https://stapi.example.com/v0.1.0/opportunities"
+
+
+class Conformance(BaseModel):
+    conforms_to: list[str] = Field(
+        default_factory=list, serialization_alias="conformsTo"
+    )

src/stapi_fastapi/models/conformance.py

@@ -14,8 +14,8 @@ class OrderParameters(BaseModel):
     model_config = ConfigDict(extra="allow")
 
 
-ORP = TypeVar("P", bound=OrderParameters)
-OPP = TypeVar("O", bound=OpportunityProperties)
+ORP = TypeVar("ORP", bound=OrderParameters)
+OPP = TypeVar("OPP", bound=OpportunityProperties)
 
 
 class OrderRequest(BaseModel, Generic[ORP]):
@@ -45,7 +45,7 @@ class OrderProperties(BaseModel, Generic[OPP, ORP]):
 class Order(Feature[Geometry, OrderProperties]):
     # We need to enforce that orders have an id defined, as that is required to
     # retrieve them via the API
-    id: StrictInt | StrictStr  # type: ignore
+    id: StrictInt | StrictStr
     type: Literal["Feature"] = "Feature"
     links: list[Link] = Field(default_factory=list)
 

src/stapi_fastapi/models/order.py

@@ -1,7 +1,11 @@
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 from stapi_fastapi.models.shared import Link
 
 
 class RootResponse(BaseModel):
-    links: list[Link]
+    id: str
+    conformsTo: list[str] = Field(default_factory=list)
+    title: str = ""
+    description: str = ""
+    links: list[Link] = Field(default_factory=list)