General backend cleanup (#86)

Author: jsignell

demo/README.md

@@ -1,13 +1,26 @@
-# tasking-api
+# Demo
 
-Install packages
+This directory contains a demo site where several satelite providers
+have implemented proxies to map the STAT API to their existing
+provider-specific APIs.
+
+## Run locally
+
+### Install packages
 
 ```python
 pip install -r requirements.txt
 ```
 
-Run backend:
+Install next: [Next.js](https://nextjs.org/)
+
+### Run demo
 
 ```shell
 ./scripts/run
 ```
+
+### Access demo
+
+frontend: localhost:3000
+backend: localhost:8000

demo/api/api_types.py

@@ -1,14 +1,14 @@
 from api.backends.base import Backend
 from api.backends.blacksky_backend import BlackskyBackend
+from api.backends.earthsearch_backend import EarthSearchBackend
 from api.backends.fake_backend import FakeBackend
 from api.backends.planet_backend import PlanetBackend
-from api.backends.sentinel_backend import HistoricalBackend
 from api.backends.umbra_backend import UmbraBackend
 
 BACKENDS: dict[str, Backend] = {
-    "fake": FakeBackend,
-    "historical": HistoricalBackend,
-    "blacksky": BlackskyBackend,
-    "planet": PlanetBackend,
-    "umbra": UmbraBackend,
+    "fake": FakeBackend(),  # type: ignore
+    "earthsearch": EarthSearchBackend(),  # type: ignore
+    "blacksky": BlackskyBackend(),  # type: ignore
+    "planet": PlanetBackend(),  # type: ignore
+    "umbra": UmbraBackend(),  # type: ignore
 }

demo/api/backends/__init__.py

@@ -1,28 +1,35 @@
 from typing import Protocol
 
-from api.api_types import OpportunityCollection, Order, Product, Search
+from api.models import Opportunity, Order, Product
 
 
-# backend protocol class
 class Backend(Protocol):
-    """Backend Python API"""
+    """
+    Protocol class that backend provider APIs must conform to
 
-    async def find_opportunities(
-        self,
-        search: Search,
-        token: str,
-    ) -> OpportunityCollection:
-        return NotImplemented
+    In order to create a backend a provider must create a class
+    with the methods defined in this Protocol.
+    """
 
     async def find_products(
         self,
         token: str,
     ) -> list[Product]:
+        """Get a list of all Products"""
         return NotImplemented
 
     async def place_order(
         self,
-        search: Search,
+        search: Opportunity,
         token: str,
     ) -> Order:
+        """Given an Opportunity, place an order"""
+        return NotImplemented
+
+    async def find_opportunities(
+        self,
+        search: Opportunity,
+        token: str,
+    ) -> list[Opportunity]:
+        """Given an Opportunity, get a list of Opportunites that fulfill it"""
         return NotImplemented

demo/api/backends/base.py

@@ -1,11 +1,10 @@
 import requests
-
-from api.api_types import Opportunity, OpportunityCollection, Search
+from api.models import Opportunity
 
 BLACKSKY_BASE_URL = "https://api.dev.blacksky.com/v1"
 
 
-def stac_search_to_oppurtunities_request(search_request: Search):
+def stat_to_oppurtunities_request(search_request: Opportunity):
     """
     :param search_request: STAC search as passed on to find_future_items
     :return: a triple of iw request body, geom and bbox (geom and bbox needed again later to construct STAC answers)
@@ -55,37 +54,33 @@ def get_oppurtunities(blacksky_request, token):
     return r.json()["opportunities"]
 
 
-def oppurtunity_to_stac_item(iw):
+def blacksky_oppurtunity_to_opportunity(iw):
     """
     translates a Planet Imaging Windows into a STAC item
     :param iw: an element from the 'imaging_windows' array of a /imaging_windows/[search_id] response
     :return: a corresponding STAC item
     """
 
-    item = Opportunity(
+    opportunity = Opportunity(
         id=iw["satellite"],
+        product_id="BS-Test:Standard",
         geometry={"type": "Point", "coordinates": [iw["longitude"], iw["latitude"], 0]},
-        properties={
-            "title": "",
-            "datetime": f"{iw['timestamp']}/{iw['timestamp']}",
-            "constraints": {
-                "off_nadir": iw["offNadirAngleDegrees"],
-                "cloud_cover": iw["weatherForecast"]["cloudCover"],
-            },
+        datetime=f"{iw['timestamp']}/{iw['timestamp']}",
+        constraints={
+            "off_nadir": iw["offNadirAngleDegrees"],
+            "cloud_cover": iw["weatherForecast"]["cloudCover"],
         },
     )
 
-    return item
+    return opportunity
 
 
 class BlackskyBackend:
     async def find_opportunities(
         self,
-        search_request: Search,
+        search_request: Opportunity,
         token: str,
-    ) -> OpportunityCollection:
-        blacksky_request = stac_search_to_oppurtunities_request(search_request)
+    ) -> list[Opportunity]:
+        blacksky_request = stat_to_oppurtunities_request(search_request)
         oppurtunities = get_oppurtunities(blacksky_request, token)
-        stac_items = [oppurtunity_to_stac_item(iw) for iw in oppurtunities]
-
-        return OpportunityCollection(features=stac_items, links=[])
+        return [blacksky_oppurtunity_to_opportunity(iw) for iw in oppurtunities]