report pair-search conformance classes (#8)

* report pair-search conformance classes

Author: ungarj

src/stac_fastapi_pgstac_pair_search/client.py

@@ -19,6 +19,7 @@
 from stac_pydantic.item import Item
 
 from stac_fastapi_pgstac_pair_search.models import PairSearchRequest, PairSearchLinks
+from stac_fastapi_pgstac_pair_search.extensions.pair_search import PairSearchExtension
 
 
 logger = logging.getLogger(__name__)
@@ -217,6 +218,8 @@ def render_sql(pair_search_request: PairSearchRequest) -> Tuple[str, List[Any]]:
 
 
 def register_pair_search(api: StacApi):
+    """Shoehorn pair-search on an instantiated StacApi."""
+
     # initialize the client
     pair_search_client = PairSearchClient(
         stac_version=api.stac_version,
@@ -226,6 +229,12 @@ def register_pair_search(api: StacApi):
         extensions=api.extensions,
     )
 
+    # this is required to add conformance classes:
+    pair_search_extension = PairSearchExtension()
+    api.extensions.append(pair_search_extension)
+    api.client.extensions.append(pair_search_extension)
+
+    # add api routes:
     # POST /pair-search
     api.app.add_api_route(
         name="Pair Search",

src/stac_fastapi_pgstac_pair_search/extensions/__init__.py

@@ -0,0 +1,50 @@
+import attr
+from enum import Enum
+from typing import List, Optional
+
+from fastapi import FastAPI
+from stac_fastapi.types.extension import ApiExtension
+
+from stac_fastapi_pgstac_pair_search.models import PairSearchRequest
+
+
+class PairSearchConformanceClasses(str, Enum):
+    """Conformance classes for the Pair-Search extension."""
+
+    SearchCore = "https://foo.bar/v0.0.1/pair-search"
+    Query = "https://foo.bar/v0.0.1/pair-search#query"
+    CQL2NumberDifference = "https://foo.bar/ext/cq12/1.0/conf/n_diff"
+    CQL2TimeDifference = "https://foo.bar/ext/cq12/1.0/conf/t_diff"
+    CQL2TimeStart = "https://foo.bar/ext/cq12/1.0/conf/t_start"
+    CQL2TimeEnd = "https://foo.bar/ext/cq12/1.0/conf/t_end"
+    CQL2RelativeGeometryOverlap = "https://foo.bar/ext/cq12/1.0/conf/s_raoverlap"
+
+
+@attr.s
+class PairSearchExtension(ApiExtension):
+    """Query Extension.
+
+    The Query extension adds an additional `query` parameter to `/search` requests which
+    allows the caller to perform queries against item metadata (ex. find all images with
+    cloud cover less than 15%).
+    https://github.com/stac-api-extensions/query
+    """
+
+    GET = PairSearchRequest
+    POST = PairSearchRequest
+
+    conformance_classes: List[str] = attr.ib(
+        factory=lambda: PairSearchConformanceClasses
+    )
+    schema_href: Optional[str] = attr.ib(default=None)
+
+    def register(self, app: FastAPI) -> None:
+        """Register the extension with a FastAPI application.
+
+        Args:
+            app: target FastAPI application.
+
+        Returns:
+            None
+        """
+        pass

src/stac_fastapi_pgstac_pair_search/extensions/pair_search.py

@@ -9,6 +9,29 @@ def test_app(client):
     assert response.json()
 
 
+@pytest.mark.parametrize(
+    "class_name",
+    [
+        "pair-search",
+        "n_diff",
+        "t_diff",
+        "t_start",
+        "t_end",
+        "s_raoverlap",
+    ],
+)
+def test_conformance(client, class_name):
+    response = client.get("/conformance")
+    assert response.status_code == 200
+    assert response.json()
+
+    for conformance_class_uri in response.json()["conformsTo"]:
+        if class_name in conformance_class_uri:
+            break
+    else:
+        raise ValueError(f"{class_name} not found")
+
+
 def test_search(client):
     response = client.get("/search")
     assert response.status_code == 200