stac-fastapi.api 3.0.0a2__tar.gz → 3.0.0a3__tar.gz

{stac_fastapi_api-3.0.0a2 → stac_fastapi_api-3.0.0a3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.api
-Version: 3.0.0a2
+Version: 3.0.0a3
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering

{stac_fastapi_api-3.0.0a2 → stac_fastapi_api-3.0.0a3}/stac_fastapi/api/app.py

@@ -458,10 +458,6 @@ class StacApi:
         self.client.title = self.title
         self.client.description = self.description
 
-        fields_ext = self.get_extension(FieldsExtension)
-        if fields_ext:
-            self.settings.default_includes = fields_ext.default_includes
-
         Settings.set(self.settings)
         self.app.state.settings = self.settings
 

{stac_fastapi_api-3.0.0a2 → stac_fastapi_api-3.0.0a3}/stac_fastapi/api/config.py

@@ -18,6 +18,7 @@ class ApiExtensions(enum.Enum):
     query = "query"
     sort = "sort"
     transaction = "transaction"
+    aggregation = "aggregation"
 
 
 class AddOns(enum.Enum):

{stac_fastapi_api-3.0.0a2 → stac_fastapi_api-3.0.0a3}/stac_fastapi/api/routes.py

@@ -1,5 +1,6 @@
 """Route factories."""
 
+import copy
 import functools
 import inspect
 import warnings
@@ -100,15 +101,28 @@ def add_route_dependencies(
     Allows a developer to add dependencies to a route after the route has been
     defined.
 
+    "*" can be used for path or method to match all allowed routes.
+
     Returns:
         None
     """
     for scope in scopes:
+        _scope = copy.deepcopy(scope)
         for route in routes:
-            match, _ = route.matches({"type": "http", **scope})
+            if scope["path"] == "*":
+                _scope["path"] = route.path
+
+            if scope["method"] == "*":
+                _scope["method"] = list(route.methods)[0]
+
+            match, _ = route.matches({"type": "http", **_scope})
             if match != Match.FULL:
                 continue
 
+            # Ignore paths without dependants, e.g. /api, /api.html, /docs/oauth2-redirect
+            if not hasattr(route, "dependant"):
+                continue
+
             # Mimicking how APIRoute handles dependencies:
             # https://github.com/tiangolo/fastapi/blob/1760da0efa55585c19835d81afa8ca386036c325/fastapi/routing.py#L408-L412
             for depends in dependencies[::-1]:

stac_fastapi_api-3.0.0a3/stac_fastapi/api/version.py

@@ -0,0 +1,2 @@
+"""Library version."""
+__version__ = "3.0.0a3"

{stac_fastapi_api-3.0.0a2 → stac_fastapi_api-3.0.0a3}/stac_fastapi.api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: stac-fastapi.api
-Version: 3.0.0a2
+Version: 3.0.0a3
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering

stac_fastapi_api-3.0.0a3/tests/test_api.py

@@ -0,0 +1,447 @@
+from fastapi import Depends, HTTPException, security, status
+from starlette.testclient import TestClient
+
+from stac_fastapi.api.app import StacApi
+from stac_fastapi.extensions.core import (
+    TokenPaginationExtension,
+    TransactionExtension,
+)
+from stac_fastapi.types import config, core
+
+
+class TestRouteDependencies:
+    @staticmethod
+    def _build_api(**overrides):
+        settings = config.ApiSettings()
+        return StacApi(
+            **{
+                "settings": settings,
+                "client": DummyCoreClient(),
+                "extensions": [
+                    TransactionExtension(
+                        client=DummyTransactionsClient(), settings=settings
+                    ),
+                    TokenPaginationExtension(),
+                ],
+                **overrides,
+            }
+        )
+
+    @staticmethod
+    def _assert_dependency_applied(api, routes):
+        with TestClient(api.app) as client:
+            for route in routes:
+                response = getattr(client, route["method"].lower())(route["path"])
+                assert (
+                    response.status_code == 401
+                ), "Unauthenticated requests should be rejected"
+                assert response.json() == {"detail": "Not authenticated"}
+
+                path = route["path"].format(
+                    collectionId="test_collection", itemId="test_item"
+                )
+                response = client.request(
+                    method=route["method"].lower(),
+                    url=path,
+                    auth=("bob", "dobbs"),
+                    content=route["payload"],
+                    headers={"content-type": "application/json"},
+                )
+                assert (
+                    200 <= response.status_code < 300
+                ), "Authenticated requests should be accepted"
+                assert response.json() == "dummy response"
+
+    @staticmethod
+    def _assert_dependency_not_applied(api, routes):
+        with TestClient(api.app) as client:
+            for route in routes:
+                path = route["path"].format(
+                    collectionId="test_collection", itemId="test_item"
+                )
+                response = client.request(
+                    method=route["method"].lower(),
+                    url=path,
+                    content=route["payload"],
+                    headers={"content-type": "application/json"},
+                )
+                assert (
+                    200 <= response.status_code < 300
+                ), "Authenticated requests should be accepted"
+                assert response.json() == "dummy response"
+
+    def test_openapi_content_type(self):
+        api = self._build_api()
+        with TestClient(api.app) as client:
+            response = client.get(api.settings.openapi_url)
+            assert (
+                response.headers["content-type"]
+                == "application/vnd.oai.openapi+json;version=3.0"
+            )
+
+    def test_build_api_with_route_dependencies(self, collection, item):
+        routes = [
+            {"path": "/collections", "method": "POST", "payload": collection},
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {"path": "/collections/{collectionId}", "method": "DELETE", "payload": ""},
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        dependencies = [Depends(must_be_bob)]
+        api = self._build_api(route_dependencies=[(routes, dependencies)])
+        self._assert_dependency_applied(api, routes)
+
+    def test_add_route_dependencies_after_building_api(self, collection, item):
+        routes = [
+            {"path": "/collections", "method": "POST", "payload": collection},
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {"path": "/collections/{collectionId}", "method": "DELETE", "payload": ""},
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        api = self._build_api()
+        api.add_route_dependencies(scopes=routes, dependencies=[Depends(must_be_bob)])
+        self._assert_dependency_applied(api, routes)
+
+    def test_build_api_with_default_route_dependencies(self, collection, item):
+        routes = [{"path": "*", "method": "*"}]
+        test_routes = [
+            {"path": "/collections", "method": "POST", "payload": collection},
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {"path": "/collections/{collectionId}", "method": "DELETE", "payload": ""},
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        dependencies = [Depends(must_be_bob)]
+        api = self._build_api(route_dependencies=[(routes, dependencies)])
+        self._assert_dependency_applied(api, test_routes)
+
+    def test_build_api_with_default_path_route_dependencies(self, collection, item):
+        routes = [{"path": "*", "method": "POST"}]
+        test_routes = [
+            {
+                "path": "/collections",
+                "method": "POST",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+        ]
+        test_not_routes = [
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        dependencies = [Depends(must_be_bob)]
+        api = self._build_api(route_dependencies=[(routes, dependencies)])
+        self._assert_dependency_applied(api, test_routes)
+        self._assert_dependency_not_applied(api, test_not_routes)
+
+    def test_build_api_with_default_method_route_dependencies(self, collection, item):
+        routes = [
+            {
+                "path": "/collections/{collectionId}",
+                "method": "*",
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "*",
+            },
+        ]
+        test_routes = [
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        test_not_routes = [
+            {
+                "path": "/collections",
+                "method": "POST",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+        ]
+        dependencies = [Depends(must_be_bob)]
+        api = self._build_api(route_dependencies=[(routes, dependencies)])
+        self._assert_dependency_applied(api, test_routes)
+        self._assert_dependency_not_applied(api, test_not_routes)
+
+    def test_add_default_route_dependencies_after_building_api(self, collection, item):
+        routes = [{"path": "*", "method": "*"}]
+        test_routes = [
+            {
+                "path": "/collections",
+                "method": "POST",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        api = self._build_api()
+        api.add_route_dependencies(scopes=routes, dependencies=[Depends(must_be_bob)])
+        self._assert_dependency_applied(api, test_routes)
+
+    def test_add_default_path_route_dependencies_after_building_api(
+        self, collection, item
+    ):
+        routes = [{"path": "*", "method": "POST"}]
+        test_routes = [
+            {
+                "path": "/collections",
+                "method": "POST",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+        ]
+        test_not_routes = [
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        api = self._build_api()
+        api.add_route_dependencies(scopes=routes, dependencies=[Depends(must_be_bob)])
+        self._assert_dependency_applied(api, test_routes)
+        self._assert_dependency_not_applied(api, test_not_routes)
+
+    def test_add_default_method_route_dependencies_after_building_api(
+        self, collection, item
+    ):
+        routes = [
+            {
+                "path": "/collections/{collectionId}",
+                "method": "*",
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "*",
+            },
+        ]
+        test_routes = [
+            {
+                "path": "/collections/{collectionId}",
+                "method": "PUT",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "PUT",
+                "payload": item,
+            },
+            {
+                "path": "/collections/{collectionId}/items/{itemId}",
+                "method": "DELETE",
+                "payload": "",
+            },
+        ]
+        test_not_routes = [
+            {
+                "path": "/collections",
+                "method": "POST",
+                "payload": collection,
+            },
+            {
+                "path": "/collections/{collectionId}/items",
+                "method": "POST",
+                "payload": item,
+            },
+        ]
+        api = self._build_api()
+        api.add_route_dependencies(scopes=routes, dependencies=[Depends(must_be_bob)])
+        self._assert_dependency_applied(api, test_routes)
+        self._assert_dependency_not_applied(api, test_not_routes)
+
+
+class DummyCoreClient(core.BaseCoreClient):
+    def all_collections(self, *args, **kwargs):
+        ...
+
+    def get_collection(self, *args, **kwargs):
+        ...
+
+    def get_item(self, *args, **kwargs):
+        ...
+
+    def get_search(self, *args, **kwargs):
+        ...
+
+    def post_search(self, *args, **kwargs):
+        ...
+
+    def item_collection(self, *args, **kwargs):
+        ...
+
+
+class DummyTransactionsClient(core.BaseTransactionsClient):
+    """Defines a pattern for implementing the STAC transaction extension."""
+
+    def create_item(self, *args, **kwargs):
+        return "dummy response"
+
+    def update_item(self, *args, **kwargs):
+        return "dummy response"
+
+    def delete_item(self, *args, **kwargs):
+        return "dummy response"
+
+    def create_collection(self, *args, **kwargs):
+        return "dummy response"
+
+    def update_collection(self, *args, **kwargs):
+        return "dummy response"
+
+    def delete_collection(self, *args, **kwargs):
+        return "dummy response"
+
+
+def must_be_bob(
+    credentials: security.HTTPBasicCredentials = Depends(security.HTTPBasic()),
+):
+    if credentials.username == "bob":
+        return True
+
+    raise HTTPException(
+        status_code=status.HTTP_401_UNAUTHORIZED,
+        detail="You're not Bob",
+        headers={"WWW-Authenticate": "Basic"},
+    )

stac_fastapi_api-3.0.0a2/stac_fastapi/api/version.py

@@ -1,2 +0,0 @@
-"""Library version."""
-__version__ = "3.0.0a2"

stac_fastapi_api-3.0.0a2/tests/test_api.py

@@ -1,172 +0,0 @@
-from fastapi import Depends, HTTPException, security, status
-from starlette.testclient import TestClient
-
-from stac_fastapi.api.app import StacApi
-from stac_fastapi.extensions.core import TokenPaginationExtension, TransactionExtension
-from stac_fastapi.types import config, core
-
-
-class TestRouteDependencies:
-    @staticmethod
-    def _build_api(**overrides):
-        settings = config.ApiSettings()
-        return StacApi(
-            **{
-                "settings": settings,
-                "client": DummyCoreClient(),
-                "extensions": [
-                    TransactionExtension(
-                        client=DummyTransactionsClient(), settings=settings
-                    ),
-                    TokenPaginationExtension(),
-                ],
-                **overrides,
-            }
-        )
-
-    @staticmethod
-    def _assert_dependency_applied(api, routes):
-        with TestClient(api.app) as client:
-            for route in routes:
-                response = getattr(client, route["method"].lower())(route["path"])
-                assert (
-                    response.status_code == 401
-                ), "Unauthenticated requests should be rejected"
-                assert response.json() == {"detail": "Not authenticated"}
-
-                path = route["path"].format(
-                    collectionId="test_collection", itemId="test_item"
-                )
-                response = client.request(
-                    method=route["method"].lower(),
-                    url=path,
-                    auth=("bob", "dobbs"),
-                    content=route["payload"],
-                    headers={"content-type": "application/json"},
-                )
-                assert (
-                    200 <= response.status_code < 300
-                ), "Authenticated requests should be accepted"
-                assert response.json() == "dummy response"
-
-    def test_openapi_content_type(self):
-        api = self._build_api()
-        with TestClient(api.app) as client:
-            response = client.get(api.settings.openapi_url)
-            assert (
-                response.headers["content-type"]
-                == "application/vnd.oai.openapi+json;version=3.0"
-            )
-
-    def test_build_api_with_route_dependencies(self, collection, item):
-        routes = [
-            {"path": "/collections", "method": "POST", "payload": collection},
-            {
-                "path": "/collections/{collectionId}",
-                "method": "PUT",
-                "payload": collection,
-            },
-            {"path": "/collections/{collectionId}", "method": "DELETE", "payload": ""},
-            {
-                "path": "/collections/{collectionId}/items",
-                "method": "POST",
-                "payload": item,
-            },
-            {
-                "path": "/collections/{collectionId}/items/{itemId}",
-                "method": "PUT",
-                "payload": item,
-            },
-            {
-                "path": "/collections/{collectionId}/items/{itemId}",
-                "method": "DELETE",
-                "payload": "",
-            },
-        ]
-        dependencies = [Depends(must_be_bob)]
-        api = self._build_api(route_dependencies=[(routes, dependencies)])
-        self._assert_dependency_applied(api, routes)
-
-    def test_add_route_dependencies_after_building_api(self, collection, item):
-        routes = [
-            {"path": "/collections", "method": "POST", "payload": collection},
-            {
-                "path": "/collections/{collectionId}",
-                "method": "PUT",
-                "payload": collection,
-            },
-            {"path": "/collections/{collectionId}", "method": "DELETE", "payload": ""},
-            {
-                "path": "/collections/{collectionId}/items",
-                "method": "POST",
-                "payload": item,
-            },
-            {
-                "path": "/collections/{collectionId}/items/{itemId}",
-                "method": "PUT",
-                "payload": item,
-            },
-            {
-                "path": "/collections/{collectionId}/items/{itemId}",
-                "method": "DELETE",
-                "payload": "",
-            },
-        ]
-        api = self._build_api()
-        api.add_route_dependencies(scopes=routes, dependencies=[Depends(must_be_bob)])
-        self._assert_dependency_applied(api, routes)
-
-
-class DummyCoreClient(core.BaseCoreClient):
-    def all_collections(self, *args, **kwargs):
-        ...
-
-    def get_collection(self, *args, **kwargs):
-        ...
-
-    def get_item(self, *args, **kwargs):
-        ...
-
-    def get_search(self, *args, **kwargs):
-        ...
-
-    def post_search(self, *args, **kwargs):
-        ...
-
-    def item_collection(self, *args, **kwargs):
-        ...
-
-
-class DummyTransactionsClient(core.BaseTransactionsClient):
-    """Defines a pattern for implementing the STAC transaction extension."""
-
-    def create_item(self, *args, **kwargs):
-        return "dummy response"
-
-    def update_item(self, *args, **kwargs):
-        return "dummy response"
-
-    def delete_item(self, *args, **kwargs):
-        return "dummy response"
-
-    def create_collection(self, *args, **kwargs):
-        return "dummy response"
-
-    def update_collection(self, *args, **kwargs):
-        return "dummy response"
-
-    def delete_collection(self, *args, **kwargs):
-        return "dummy response"
-
-
-def must_be_bob(
-    credentials: security.HTTPBasicCredentials = Depends(security.HTTPBasic()),
-):
-    if credentials.username == "bob":
-        return True
-
-    raise HTTPException(
-        status_code=status.HTTP_401_UNAUTHORIZED,
-        detail="You're not Bob",
-        headers={"WWW-Authenticate": "Basic"},
-    )