stac-fastapi.api 4.0.0__tar.gz → 5.0.0__tar.gz

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: stac-fastapi.api
-Version: 4.0.0
+Version: 5.0.0
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -19,7 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: brotli_asgi
-Requires-Dist: stac-fastapi.types~=4.0
+Requires-Dist: stac-fastapi.types~=5.0
 Provides-Extra: dev
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/setup.py

@@ -7,7 +7,7 @@ with open("README.md") as f:
 
 install_requires = [
     "brotli_asgi",
-    "stac-fastapi.types~=4.0",
+    "stac-fastapi.types~=5.0",
 ]
 
 extra_reqs = {

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/stac_fastapi/api/app.py

@@ -1,12 +1,11 @@
 """Fastapi app creation."""
 
 
-from typing import Any, Dict, List, Optional, Tuple, Type, Union
+from typing import Dict, List, Optional, Tuple, Type, Union
 
 import attr
 from brotli_asgi import BrotliMiddleware
 from fastapi import APIRouter, FastAPI
-from fastapi.openapi.utils import get_openapi
 from fastapi.params import Depends
 from stac_pydantic import api
 from stac_pydantic.api.collections import Collections
@@ -71,19 +70,6 @@ class StacApi:
     exceptions: Dict[Type[Exception], int] = attr.ib(
         default=attr.Factory(lambda: DEFAULT_STATUS_CODES)
     )
-    app: FastAPI = attr.ib(
-        default=attr.Factory(
-            lambda self: FastAPI(
-                openapi_url=self.settings.openapi_url,
-                docs_url=self.settings.docs_url,
-                redoc_url=None,
-                root_path=self.settings.root_path,
-            ),
-            takes_self=True,
-        ),
-        converter=update_openapi,
-    )
-    router: APIRouter = attr.ib(default=attr.Factory(APIRouter))
     title: str = attr.ib(
         default=attr.Factory(
             lambda self: self.settings.stac_fastapi_title, takes_self=True
@@ -100,6 +86,22 @@ class StacApi:
             lambda self: self.settings.stac_fastapi_description, takes_self=True
         )
     )
+    app: FastAPI = attr.ib(
+        default=attr.Factory(
+            lambda self: FastAPI(
+                openapi_url=self.settings.openapi_url,
+                docs_url=self.settings.docs_url,
+                redoc_url=None,
+                root_path=self.settings.root_path,
+                title=self.title,
+                version=self.api_version,
+                description=self.description,
+            ),
+            takes_self=True,
+        ),
+        converter=update_openapi,
+    )
+    router: APIRouter = attr.ib(default=attr.Factory(APIRouter))
     search_get_request_model: Type[BaseSearchGetRequest] = attr.ib(
         default=BaseSearchGetRequest
     )
@@ -388,22 +390,6 @@ class StacApi:
         self.register_get_collection()
         self.register_get_item_collection()
 
-    def customize_openapi(self) -> Optional[Dict[str, Any]]:
-        """Customize openapi schema."""
-        if self.app.openapi_schema:
-            return self.app.openapi_schema
-
-        openapi_schema = get_openapi(
-            title=self.title,
-            version=self.api_version,
-            description=self.description,
-            routes=self.app.routes,
-            servers=self.app.servers,
-        )
-
-        self.app.openapi_schema = openapi_schema
-        return self.app.openapi_schema
-
     def add_health_check(self):
         """Add a health check."""
         mgmt_router = APIRouter(prefix=self.app.state.router_prefix)
@@ -467,9 +453,6 @@ class StacApi:
         # register exception handlers
         add_exception_handlers(self.app, status_codes=self.exceptions)
 
-        # customize openapi
-        self.app.openapi = self.customize_openapi
-
         # add middlewares
         if self.middlewares and self.app.middleware_stack is not None:
             raise RuntimeError("Cannot add middleware after an application has started")

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/stac_fastapi/api/middleware.py

@@ -4,7 +4,7 @@ import contextlib
 import re
 import typing
 from http.client import HTTP_PORT, HTTPS_PORT
-from typing import List, Tuple
+from typing import List, Optional, Tuple
 
 from starlette.middleware.cors import CORSMiddleware as _CORSMiddleware
 from starlette.types import ASGIApp, Receive, Scope, Send
@@ -95,12 +95,13 @@ class ProxyHeaderMiddleware:
                 domain = header_host_parts[0]
                 port = None
 
+        port_str = None  # make sure it is defined in all paths since we access it later
+
         if forwarded := self._get_header_value_by_name(scope, "forwarded"):
             for proxy in forwarded.split(","):
-                if (proto_expr := _PROTO_HEADER_REGEX.search(proxy)) and (
-                    host_expr := _HOST_HEADER_REGEX.search(proxy)
-                ):
+                if proto_expr := _PROTO_HEADER_REGEX.search(proxy):
                     proto = proto_expr.group("proto")
+                if host_expr := _HOST_HEADER_REGEX.search(proxy):
                     domain = host_expr.group("host")
                     port_str = host_expr.group("port")  # None if not present in the match
 
@@ -115,8 +116,8 @@ class ProxyHeaderMiddleware:
         return (proto, domain, port)
 
     def _get_header_value_by_name(
-        self, scope: Scope, header_name: str, default_value: str = None
-    ) -> str:
+        self, scope: Scope, header_name: str, default_value: Optional[str] = None
+    ) -> Optional[str]:
         headers = scope["headers"]
         candidates = [
             value.decode() for key, value in headers if key.decode() == header_name

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/stac_fastapi/api/version.py

@@ -1,3 +1,3 @@
 """Library version."""
 
-__version__ = "4.0.0"
+__version__ = "5.0.0"

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/stac_fastapi.api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: stac-fastapi.api
-Version: 4.0.0
+Version: 5.0.0
 Summary: An implementation of STAC API based on the FastAPI framework.
 Home-page: https://github.com/stac-utils/stac-fastapi
 Author: Arturo Engineering
@@ -19,7 +19,7 @@ Classifier: License :: OSI Approved :: MIT License
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 Requires-Dist: brotli_asgi
-Requires-Dist: stac-fastapi.types~=4.0
+Requires-Dist: stac-fastapi.types~=5.0
 Provides-Extra: dev
 Requires-Dist: httpx; extra == "dev"
 Requires-Dist: pytest; extra == "dev"

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/stac_fastapi.api.egg-info/requires.txt

@@ -1,5 +1,5 @@
 brotli_asgi
-stac-fastapi.types~=4.0
+stac-fastapi.types~=5.0
 
 [benchmark]
 pytest-benchmark

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/tests/test_app_prefix.py

@@ -208,3 +208,30 @@ def test_api_prefix_with_root_path(TestCoreClient, prefix):
 
             resp = client.get(prefix + expected_path)
             assert resp.status_code == 200
+
+
+def test_api_fastapi_option(TestCoreClient):
+    api_settings = ApiSettings(
+        stac_fastapi_title="stac-fastapi-tests",
+        stac_fastapi_description="test for stac-fastapi",
+        stac_fastapi_version="0.1.0dev",
+    )
+
+    api = StacApi(
+        settings=api_settings,
+        client=TestCoreClient(),
+    )
+
+    with TestClient(api.app, base_url="http://stac.io") as client:
+        landing = client.get("/")
+        assert landing.status_code == 200
+        body = landing.json()
+        assert body["title"] == "stac-fastapi-tests"
+        assert body["description"] == "test for stac-fastapi"
+
+        service_desc = client.get("/api")
+        assert service_desc.status_code == 200
+        body = service_desc.json()["info"]
+        assert body["title"] == "stac-fastapi-tests"
+        assert body["description"] == "test for stac-fastapi"
+        assert body["version"] == "0.1.0dev"

{stac_fastapi_api-4.0.0 → stac_fastapi_api-5.0.0}/tests/test_middleware.py

@@ -183,6 +183,20 @@ def test_replace_header_value_by_name(
             },
             ("https", "test", 1234),
         ),
+        (
+            {
+                "scheme": "http",
+                "server": ["testserver", 80],
+                "headers": [
+                    (
+                        b"forwarded",
+                        # proto is set, but no host
+                        b'for="85.193.181.55";proto=https,for="85.193.181.55";proto=https',
+                    )
+                ],
+            },
+            ("https", "testserver", 80),
+        ),
     ],
 )
 def test_get_forwarded_url_parts(