Merge pull request #52 from Element84/orders

Add `/orders` endpoint

Author: jsignell

demo/api/api_types.py

@@ -33,6 +33,11 @@
 ProductParameters = Dict[str, Union[Range, List[Any], Dict[str, Any]]]
 
 
+
+class Order(BaseModel):
+    id: str
+
+
 class Product(BaseModel):
     """https://github.com/Element84/sat-tasking-sprint/tree/main/product-spec"""
 

demo/api/backends/base.py

@@ -1,8 +1,8 @@
 from typing import Protocol, Optional
-
-from api.api_types import OpportunityCollection, Product, Search
 import os
 
+from api.api_types import OpportunityCollection, Product, Search, Order
+
 
 # backend protocol class
 class Backend(Protocol):
@@ -21,6 +21,13 @@ async def find_products(
     ) -> list[Product]:
         return NotImplemented
 
+    async def place_order(
+        self,
+        search: Search,
+        token: str,
+    ) -> Order:
+        return NotImplemented
+
 
 def get_token(backend: str) -> Optional[str]:
     token_name = f"{backend.upper()}_TOKEN"

demo/api/backends/sentinel_backend.py

@@ -7,8 +7,9 @@
 import pystac
 from api.api_types import (Opportunity, OpportunityCollection,
                            OpportunityProperties, Product, ProductConstraints,
-                           Search, Provider)
-from pystac import Collection
+                           Search, Order, Provider)
+from pystac import Collection, ItemCollection
+
 from pystac_client.client import Client
 
 DEFAULT_MAX_ITEMS = 10
@@ -89,11 +90,7 @@ class HistoricalBackend:
     def __init__(self) -> None:
         self.catalog = Client.open('https://earth-search.aws.element84.com/v1')  # type: ignore
 
-    async def find_opportunities(
-        self,
-        search: Search,
-        token: str,
-    ) -> OpportunityCollection:
+    def _search(self, search) -> ItemCollection:
         max_items = min(search.limit, MAX_MAX_ITEMS)
 
         args: dict[str, Any] = {
@@ -114,19 +111,26 @@ async def find_opportunities(
             raise Exception('A datetime range must be specified')
 
         search_obj = self.catalog.search(**args)
-        item_coll = search_obj.item_collection()
+        return search_obj.item_collection()
 
+    async def find_opportunities(
+        self,
+        search: Search,
+        token: str,
+    ) -> OpportunityCollection:
         # Convert the STAC items from earth search into opportunities
+        item_collection = self._search(search)
         opportunities: list[Opportunity] = [
             stac_item_to_opportunity(item, product_id=search.product_id)
-            for item in item_coll.items
+            for item in item_collection.items
         ]
         opportunity_collection = OpportunityCollection(
             features=opportunities
         )
 
         return opportunity_collection
 
+
     async def find_products(self, token: str) -> list[Product]:
         def safe_get_coll(product_id: str) -> Collection:
             coll = self.catalog.get_collection(product_id)
@@ -138,3 +142,17 @@ def safe_get_coll(product_id: str) -> Collection:
             stac_collection_to_product(safe_get_coll(product_id))
             for product_id in PRODUCT_IDS
         ]
+
+    async def place_order(
+        self,
+        search: Search,
+        token: str,
+    ) -> Order:
+        """Get the first item off the search output and return that ID"""
+        item_collection = self._search(search)
+
+        if len(item_collection.items) == 0:
+            raise ValueError(f"Unable to place an order for this product: '{search.product_id}'")
+
+        best_guess = item_collection.items[0]
+        return Order(id=best_guess.id)

demo/api/main.py

@@ -8,7 +8,7 @@
 from api.backends.base import Backend, get_token
 from api.backends import BACKENDS
 
-from api.api_types import Search, OpportunityCollection, Product
+from api.api_types import Search, OpportunityCollection, Product, Order
 
 app = FastAPI(title="Tasking API")
 
@@ -19,6 +19,7 @@
 async def redirect_home():
     return RedirectResponse("/docs")
 
+
 @app.get("/products", response_model=list[Product])
 async def get_products(
         request: Request,
@@ -117,3 +118,37 @@ async def post_opportunities(
     )
 
     return opportunity_collection
+
+
+@app.post("/orders", response_model=Order)
+async def post_order(
+    request: Request,
+    search: Search,
+):
+    # get the right token and backend from the header
+    backend = request.headers.get("backend", "historical")
+
+    token = "this-is-not-a-real-token"
+    if authorization := request.headers.get("authorization"):
+        token = authorization.replace("Bearer ", "")
+
+    if backend in BACKENDS:
+        impl: Backend = BACKENDS[backend]
+    else:
+        raise HTTPException(
+            status_code=404,
+            detail=f"Backend '{backend}' not in options: {list(BACKENDS.keys())}"
+        )
+
+    try:
+        order = await impl.place_order(
+            search,
+            token=token,
+        )
+    except Exception as e:
+        raise HTTPException(
+            status_code=500,
+            detail=str(e),
+        )
+
+    return order

demo/api/tests/test_api.py

@@ -21,7 +21,7 @@
     "datetime": "2025-01-01T00:00:00Z/2025-01-02T00:00:00Z",
     "geometry": {
         "type": "Point",
-        "coordinates": [39.95, 75.16]
+        "coordinates": [-75.16, 39.95]
     }
 }
 
@@ -94,7 +94,7 @@ def test_post_to_opportunities_with_opportunities_body_and_header_authenticated(
         "datetime":  f"{start_time.isoformat()}/{end_time.isoformat()}",
         "geometry": {
             "type": "Point",
-            "coordinates": [39.95, 75.16]
+            "coordinates": [-75.16, 39.95]
         }
     }
 
@@ -118,3 +118,30 @@ def test_post_to_opportunities_with_bad_backend_raises():
     assert response.json()["detail"] == f"Backend 'foo' not in options: {list(BACKENDS.keys())}"
 
 
+def test_post_to_orders_raises_if_not_possible():
+    product_id = "landsat-c2-l2"
+    response = client.post(
+        "/orders",
+        headers={"Backend": "historical"},
+        json={"product_id": product_id, **VALID_SEARCH_BODY},
+    )
+    assert response.status_code == 500
+    assert response.json()["detail"] == f"Unable to place an order for this product: '{product_id}'"
+
+
+def test_post_to_orders():
+    json_body = {
+        "datetime": "2025-01-01T00:00:00Z/2025-05-02T00:00:00Z",
+        "geometry": {
+            "type": "Point",
+            "coordinates": [-75.16, 39.95]
+        },
+        "product_id": "landsat-c2-l2",
+    }
+    response = client.post(
+        "/orders",
+        headers={"Backend": "historical"},
+        json=json_body,
+    )
+    assert response.status_code == 200
+    assert response.json()["id"] == "LC09_L2SP_014032_20220501_02_T1"