Add order parameters to order (#95)

* add order_parameters to product and order

* update test implementation

* WIP: order types

* rename classes

* refactor types to support correct typing of incoming OrderRequest

* remove unnecessary response model

* move around some code

* remove unnecessary pre-commit statement

* remove geometry from OrderProperties, as it is already provided by Feature

* add typing to order api route

* rename fields

* change Order order_parameters to dict, OrderRequest to typed object

* remove cql2 dependency

* remove duplicate ruff dependency

* remove unused Order typing

---------

Co-authored-by: Phil Varner <[email protected]>
Co-authored-by: Phil Varner <[email protected]>

Author: 3 people

.pre-commit-config.yaml

@@ -10,7 +10,7 @@ repos:
       - id: trailing-whitespace
       - id: no-commit-to-branch
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.7.3
+    rev: v0.7.4
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

bin/server.py

@@ -1,23 +1,31 @@
+from datetime import datetime, timezone
 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 ConstraintsException, NotFoundException
+from stapi_fastapi.exceptions import NotFoundException
 from stapi_fastapi.models.conformance import CORE
 from stapi_fastapi.models.opportunity import (
     Opportunity,
-    OpportunityPropertiesBase,
+    OpportunityProperties,
     OpportunityRequest,
 )
-from stapi_fastapi.models.order import Order, OrderCollection
-from stapi_fastapi.models.product import (
+from stapi_fastapi.models.order import (
+    Order,
+    OrderCollection,
     OrderParameters,
+    OrderRequest,
+    OrderStatus,
+    OrderStatusCode,
+)
+from stapi_fastapi.models.product import (
     Product,
     Provider,
     ProviderRole,
 )
+from stapi_fastapi.routers.product_router import ProductRouter
 from stapi_fastapi.routers.root_router import RootRouter
 
 
@@ -48,43 +56,57 @@ async def get_order(self, order_id: str, request: Request) -> Order:
 class MockProductBackend(ProductBackend):
     def __init__(self, orders: MockOrderDB) -> None:
         self._opportunities: list[Opportunity] = []
-        self._allowed_payloads: list[OpportunityRequest] = []
+        self._allowed_payloads: list[OrderRequest] = []
         self._orders: MockOrderDB = orders
 
     async def search_opportunities(
-        self, product: Product, search: OpportunityRequest, request: Request
+        self,
+        product_router: ProductRouter,
+        search: OpportunityRequest,
+        request: Request,
     ) -> list[Opportunity]:
         return [o.model_copy(update=search.model_dump()) for o in self._opportunities]
 
     async def create_order(
-        self, product: Product, payload: OpportunityRequest, request: Request
+        self, product_router: ProductRouter, payload: OrderRequest, request: Request
     ) -> Order:
         """
         Create a new order.
         """
-        allowed: bool = any(allowed == payload for allowed in self._allowed_payloads)
-        if allowed:
-            order = Order(
-                id=str(uuid4()),
-                geometry=payload.geometry,
-                properties={
-                    "filter": payload.filter,
+        order = Order(
+            id=str(uuid4()),
+            geometry=payload.geometry,
+            properties={
+                "product_id": product_router.product.id,
+                "created": datetime.now(timezone.utc),
+                "status": OrderStatus(
+                    timestamp=datetime.now(timezone.utc),
+                    status_code=OrderStatusCode.accepted,
+                ),
+                "search_parameters": {
+                    "geometry": payload.geometry,
                     "datetime": payload.datetime,
-                    "product_id": product.id,
+                    "filter": payload.filter,
+                },
+                "order_parameters": payload.order_parameters.model_dump(),
+                "opportunity_properties": {
+                    "datetime": "2024-01-29T12:00:00Z/2024-01-30T12:00:00Z",
+                    "off_nadir": 10,
                 },
-                links=[],
-            )
-            self._orders[order.id] = order
-            return order
-        raise ConstraintsException("not allowed")
+            },
+            links=[],
+        )
+
+        self._orders[order.id] = order
+        return order
 
 
-class TestSpotlightProperties(OpportunityPropertiesBase):
+class MyOpportunityProperties(OpportunityProperties):
     off_nadir: int
 
 
-class TestSpotlightOrderParameters(OrderParameters):
-    delivery_mechanism: str | None = None
+class MyOrderParameters(OrderParameters):
+    s3_path: str | None = None
 
 
 order_db = MockOrderDB()
@@ -106,8 +128,8 @@ class TestSpotlightOrderParameters(OrderParameters):
     keywords=["test", "satellite"],
     providers=[provider],
     links=[],
-    constraints=TestSpotlightProperties,
-    order_parameters=TestSpotlightOrderParameters,
+    constraints=MyOpportunityProperties,
+    order_parameters=MyOrderParameters,
     backend=product_backend,
 )
 

poetry.lock

@@ -20,7 +20,7 @@ optional = true
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^8.1.1"
-ruff = "^0.3.4"
+ruff = "^0.7.4"
 uvicorn = "^0.29.0"
 pydantic-settings = "^2.2.1"
 httpx = "^0.27.0"

pyproject.toml

@@ -1,7 +1,7 @@
 from .backends import ProductBackend, RootBackend
 from .models import (
     Link,
-    OpportunityPropertiesBase,
+    OpportunityProperties,
     Product,
     Provider,
     ProviderRole,
@@ -10,7 +10,7 @@
 
 __all__ = [
     "Link",
-    "OpportunityPropertiesBase",
+    "OpportunityProperties",
     "Product",
     "ProductBackend",
     "ProductRouter",

src/stapi_fastapi/__init__.py

@@ -5,7 +5,7 @@
 from fastapi import Request
 
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
-from stapi_fastapi.models.order import Order
+from stapi_fastapi.models.order import Order, OrderRequest
 from stapi_fastapi.routers.product_router import ProductRouter
 
 
@@ -27,7 +27,7 @@ async def search_opportunities(
     async def create_order(
         self,
         product_router: ProductRouter,
-        search: OpportunityRequest,
+        search: OrderRequest,
         request: Request,
     ) -> Order:
         """

src/stapi_fastapi/backends/product_backend.py

@@ -1,10 +1,10 @@
-from .opportunity import OpportunityPropertiesBase
+from .opportunity import OpportunityProperties
 from .product import Product, Provider, ProviderRole
 from .shared import Link
 
 __all__ = [
     "Link",
-    "OpportunityPropertiesBase",
+    "OpportunityProperties",
     "Product",
     "Provider",
     "ProviderRole",

src/stapi_fastapi/models/__init__.py

@@ -10,8 +10,7 @@
 
 
 # Copied and modified from https://github.com/stac-utils/stac-pydantic/blob/main/stac_pydantic/item.py#L11
-class OpportunityPropertiesBase(BaseModel):
-    product_id: str
+class OpportunityProperties(BaseModel):
     datetime: DatetimeInterval
     model_config = ConfigDict(extra="allow")
 
@@ -25,7 +24,7 @@ class OpportunityRequest(BaseModel):
 
 
 G = TypeVar("G", bound=Geometry)
-P = TypeVar("P", bound=OpportunityPropertiesBase)
+P = TypeVar("P", bound=OpportunityProperties)
 
 
 class Opportunity(Feature[G, P]):

src/stapi_fastapi/models/opportunity.py

@@ -1,16 +1,74 @@
-from typing import Literal
+from enum import Enum
+from typing import Any, Generic, Literal, Optional, TypeVar
 
 from geojson_pydantic import Feature, FeatureCollection
 from geojson_pydantic.geometries import Geometry
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from pydantic import (
+    AwareDatetime,
+    BaseModel,
+    ConfigDict,
+    Field,
+    StrictInt,
+    StrictStr,
+)
 
+from stapi_fastapi.models.opportunity import OpportunityProperties
 from stapi_fastapi.models.shared import Link
 from stapi_fastapi.types.datetime_interval import DatetimeInterval
+from stapi_fastapi.types.filter import CQL2Filter
+
+
+class OrderParameters(BaseModel):
+    model_config = ConfigDict(extra="forbid")
+
+
+OPP = TypeVar("OPP", bound=OpportunityProperties)
+ORP = TypeVar("ORP", bound=OrderParameters)
+
+
+class OrderRequest(BaseModel, Generic[ORP]):
+    datetime: DatetimeInterval
+    geometry: Geometry
+    # TODO: validate the CQL2 filter?
+    filter: CQL2Filter | None = None
+
+    order_parameters: ORP
+
+    model_config = ConfigDict(strict=True)
+
+
+class OrderStatusCode(str, Enum):
+    received = "received"
+    accepted = "accepted"
+    rejected = "rejected"
+    completed = "completed"
+    canceled = "canceled"
+
+
+class OrderStatus(BaseModel):
+    timestamp: AwareDatetime
+    status_code: OrderStatusCode
+    reason_code: Optional[str] = None
+    reason_text: Optional[str] = None
+    links: list[Link] = Field(default_factory=list)
+
+
+class OrderSearchParameters(BaseModel):
+    datetime: DatetimeInterval
+    geometry: Geometry
+    # TODO: validate the CQL2 filter?
+    filter: CQL2Filter | None = None
 
 
 class OrderProperties(BaseModel):
     product_id: str
-    datetime: DatetimeInterval
+    created: AwareDatetime
+    status: OrderStatus
+
+    search_parameters: OrderSearchParameters
+    opportunity_properties: dict[str, Any]
+    order_parameters: dict[str, Any]
+
     model_config = ConfigDict(extra="allow")
 
 

src/stapi_fastapi/models/order.py

@@ -4,9 +4,10 @@
 from enum import Enum
 from typing import TYPE_CHECKING, Literal, Optional, Self
 
-from pydantic import AnyHttpUrl, BaseModel, ConfigDict, Field
+from pydantic import AnyHttpUrl, BaseModel, Field
 
-from stapi_fastapi.models.opportunity import OpportunityPropertiesBase
+from stapi_fastapi.models.opportunity import OpportunityProperties
+from stapi_fastapi.models.order import OrderParameters
 from stapi_fastapi.models.shared import Link
 
 if TYPE_CHECKING:
@@ -32,10 +33,6 @@ def __init__(self, url: AnyHttpUrl | str, **kwargs):
         super().__init__(url=url, **kwargs)
 
 
-class OrderParameters(BaseModel):
-    model_config = ConfigDict(extra="allow")
-
-
 class Product(BaseModel):
     type_: Literal["Product"] = Field(default="Product", alias="type")
     conformsTo: list[str] = Field(default_factory=list)
@@ -48,15 +45,15 @@ class Product(BaseModel):
     links: list[Link] = Field(default_factory=list)
 
     # we don't want to include these in the model fields
-    _constraints: type[OpportunityPropertiesBase]
+    _constraints: type[OpportunityProperties]
     _order_parameters: type[OrderParameters]
     _backend: ProductBackend
 
     def __init__(
         self,
         *args,
         backend: ProductBackend,
-        constraints: type[OpportunityPropertiesBase],
+        constraints: type[OpportunityProperties],
         order_parameters: type[OrderParameters],
         **kwargs,
     ) -> None:
@@ -70,7 +67,7 @@ def backend(self: Self) -> ProductBackend:
         return self._backend
 
     @property
-    def constraints(self: Self) -> type[OpportunityPropertiesBase]:
+    def constraints(self: Self) -> type[OpportunityProperties]:
         return self._constraints
 
     @property