Merge branch 'main' into jak/model-idea

Author: Phil Varner

.github/pull_request_template.md

@@ -9,4 +9,4 @@
 
 **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.
+- [ ] I have added my changes to the CHANGELOG **or** a CHANGELOG entry is not required.

CHANGELOG.md

@@ -5,6 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2024-12-6
+
+### Added
+
+none
+
+### Changed
+
+- OrderStatusCode and ProviderRole are now StrEnum instead of (str, Enum)
+- All types using `Result[A, Exception]` have been replace with the equivalent type `ResultE[A]`
+
+### Deprecated
+
+none
+
+### Removed
+
+none
+
+### Fixed
+
+none
+
+### Security
+
+none
+
 ## [v0.2.0] - 2024-11-23
 
 ### Added
@@ -19,6 +46,8 @@ none
 - Order field `id` must be a string, instead of previously allowing int. This is because while an
   order ID may an integral numeric value, it is not a "number" in the sense that math will be performed
   order ID values, so string represents this better.
+- Order and OrderCollection extend _GeoJsonBase instead of Feature and FeatureCollection, to allow for tighter
+  constraints on fields
 
 ### Deprecated
 
@@ -50,6 +79,7 @@ Initial release
 - Add links `opportunities` and `create-order` to Product
 - Add link `create-order` to OpportunityCollection
 
-[unreleased]: https://github.com/stapi-spec/stapi-fastapi/compare/v0.2.0...main
+[unreleased]: https://github.com/stapi-spec/stapi-fastapi/compare/v0.3.0...main
+[v0.3.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.3.0
 [v0.2.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.2.0
 [v0.1.0]: https://github.com/stapi-spec/stapi-fastapi/tree/v0.1.0

README.md

@@ -1,6 +1,6 @@
 # STAPI FastAPI - Sensor Tasking API with FastAPI
 
-WARNING: The whole [STAPI spec] is very much work in progress, so things are
+WARNING: The whole [STAPI spec] is very much a work in progress, so things are
 guaranteed to be not correct.
 
 ## Usage

pyproject.toml

@@ -59,8 +59,7 @@ show_missing = true
 skip_empty = true
 sort = "Cover"
 omit = [
-    "**/*_test.py",
-    "**/conftest.py",
+    "tests/**/*.py",
     "stapi_fastapi/__dev__.py",
 ]
 

src/stapi_fastapi/backends/product_backend.py

@@ -3,7 +3,7 @@
 from typing import Protocol
 
 from fastapi import Request
-from returns.result import Result
+from returns.result import ResultE
 
 from stapi_fastapi.models.opportunity import Opportunity, OpportunityRequest
 from stapi_fastapi.models.order import Order, OrderRequest
@@ -16,7 +16,7 @@ async def search_opportunities(
         product_router: ProductRouter,
         search: OpportunityRequest,
         request: Request,
-    ) -> Result[list[Opportunity], Exception]:
+    ) -> ResultE[list[Opportunity]]:
         """
         Search for ordering opportunities for the  given search parameters.
 
@@ -29,7 +29,7 @@ async def create_order(
         product_router: ProductRouter,
         search: OrderRequest,
         request: Request,
-    ) -> Result[Order, Exception]:
+    ) -> ResultE[Order]:
         """
         Create a new order.
 

src/stapi_fastapi/backends/root_backend.py

@@ -2,21 +2,19 @@
 
 from fastapi import Request
 from returns.maybe import Maybe
-from returns.result import Result
+from returns.result import ResultE
 
 from stapi_fastapi.models.order import Order, OrderCollection
 
 
 class RootBackend(Protocol):  # pragma: nocover
-    async def get_orders(self, request: Request) -> Result[OrderCollection, Exception]:
+    async def get_orders(self, request: Request) -> ResultE[OrderCollection]:
         """
         Return a list of existing orders.
         """
         ...
 
-    async def get_order(
-        self, order_id: str, request: Request
-    ) -> Result[Maybe[Order], Exception]:
+    async def get_order(self, order_id: str, request: Request) -> ResultE[Maybe[Order]]:
         """
         Get details for order with `order_id`.
 

src/stapi_fastapi/models/conformance.py

@@ -1,7 +1,7 @@
 from pydantic import BaseModel, Field
 
-CORE = "https://stapi.example.com/v0.2.0/core"
-OPPORTUNITIES = "https://stapi.example.com/v0.2.0/opportunities"
+CORE = "https://stapi.example.com/v0.1.0/core"
+OPPORTUNITIES = "https://stapi.example.com/v0.1.0/opportunities"
 
 
 class Conformance(BaseModel):

src/stapi_fastapi/models/order.py

@@ -1,21 +1,25 @@
-from enum import Enum
-from typing import Any, Generic, Literal, Optional, TypeVar
+from enum import StrEnum
+from typing import Any, Dict, Generic, Iterator, Literal, Optional, TypeVar, Union
 
-from geojson_pydantic import Feature, FeatureCollection
+from geojson_pydantic.base import _GeoJsonBase
 from geojson_pydantic.geometries import Geometry
 from pydantic import (
     AwareDatetime,
     BaseModel,
     ConfigDict,
     Field,
     StrictStr,
+    field_validator,
 )
 
 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
 
+Props = TypeVar("Props", bound=Union[Dict[str, Any], BaseModel])
+Geom = TypeVar("Geom", bound=Geometry)
+
 
 class OrderParameters(BaseModel):
     model_config = ConfigDict(extra="forbid")
@@ -36,7 +40,7 @@ class OrderRequest(BaseModel, Generic[ORP]):
     model_config = ConfigDict(strict=True)
 
 
-class OrderStatusCode(str, Enum):
+class OrderStatusCode(StrEnum):
     received = "received"
     accepted = "accepted"
     rejected = "rejected"
@@ -71,14 +75,43 @@ class OrderProperties(BaseModel):
     model_config = ConfigDict(extra="allow")
 
 
-class Order(Feature[Geometry, OrderProperties]):
+# derived from geojson_pydantic.Feature
+class Order(_GeoJsonBase):
     # We need to enforce that orders have an id defined, as that is required to
     # retrieve them via the API
     id: StrictStr
     type: Literal["Feature"] = "Feature"
+
+    geometry: Geometry = Field(...)
+    properties: OrderProperties = Field(...)
+
     links: list[Link] = Field(default_factory=list)
 
+    __geojson_exclude_if_none__ = {"bbox", "id"}
+
+    @field_validator("geometry", mode="before")
+    def set_geometry(cls, geometry: Any) -> Any:
+        """set geometry from geo interface or input"""
+        if hasattr(geometry, "__geo_interface__"):
+            return geometry.__geo_interface__
+
+        return geometry
 
-class OrderCollection(FeatureCollection[Order]):
+
+# derived from geojson_pydantic.FeatureCollection
+class OrderCollection(_GeoJsonBase):
     type: Literal["FeatureCollection"] = "FeatureCollection"
+    features: list[Order]
     links: list[Link] = Field(default_factory=list)
+
+    def __iter__(self) -> Iterator[Order]:  # type: ignore [override]
+        """iterate over features"""
+        return iter(self.features)
+
+    def __len__(self) -> int:
+        """return features length"""
+        return len(self.features)
+
+    def __getitem__(self, index: int) -> Order:
+        """get feature at a given index"""
+        return self.features[index]

src/stapi_fastapi/models/product.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from enum import Enum
+from enum import StrEnum
 from typing import TYPE_CHECKING, Literal, Optional, Self
 
 from pydantic import AnyHttpUrl, BaseModel, Field
@@ -16,7 +16,7 @@
 type Constraints = BaseModel
 
 
-class ProviderRole(str, Enum):
+class ProviderRole(StrEnum):
     licensor = "licensor"
     producer = "producer"
     processor = "processor"

tests/application.py

@@ -5,7 +5,7 @@
 from fastapi import FastAPI, Request
 from pydantic import BaseModel, Field, model_validator
 from returns.maybe import Maybe
-from returns.result import Failure, Result, Success
+from returns.result import Failure, ResultE, Success
 
 from stapi_fastapi.backends.product_backend import ProductBackend
 from stapi_fastapi.backends.root_backend import RootBackend
@@ -40,15 +40,13 @@ class MockRootBackend(RootBackend):
     def __init__(self, orders: MockOrderDB) -> None:
         self._orders: MockOrderDB = orders
 
-    async def get_orders(self, request: Request) -> Result[OrderCollection, Exception]:
+    async def get_orders(self, request: Request) -> ResultE[OrderCollection]:
         """
         Show all orders.
         """
         return Success(OrderCollection(features=list(self._orders.values())))
 
-    async def get_order(
-        self, order_id: str, request: Request
-    ) -> Result[Maybe[Order], Exception]:
+    async def get_order(self, order_id: str, request: Request) -> ResultE[Maybe[Order]]:
         """
         Show details for order with `order_id`.
         """
@@ -67,7 +65,7 @@ async def search_opportunities(
         product_router: ProductRouter,
         search: OpportunityRequest,
         request: Request,
-    ) -> Result[list[Opportunity], Exception]:
+    ) -> ResultE[list[Opportunity]]:
         try:
             return Success(
                 [o.model_copy(update=search.model_dump()) for o in self._opportunities]
@@ -77,7 +75,7 @@ async def search_opportunities(
 
     async def create_order(
         self, product_router: ProductRouter, payload: OrderRequest, request: Request
-    ) -> Result[Order, Exception]:
+    ) -> ResultE[Order]:
         """
         Create a new order.
         """