chore: rename filter generator to filter factory

"generator" is a bit of a loaded term in Python

Author: alukach

docs/user-guide/configuration.md

@@ -200,23 +200,23 @@ The application is configurable via environment variables.
 
 ### `ITEMS_FILTER_CLS`
 
-: CQL2 expression generator for item-level filtering
+: CQL2 expression factor for item-level filtering
 
     - **Type:** JSON object with class configuration
     - **Required:** No, defaults to `null` (disabled)
     - **Example:** `stac_auth_proxy.filters:Opa`, `stac_auth_proxy.filters:Template`, `my_package:OrganizationFilter`
 
 ### `ITEMS_FILTER_ARGS`
 
-: Positional arguments for CQL2 expression generator
+: Positional arguments for CQL2 expression factor
 
     - **Type:** List of positional arguments used to initialize the class
     - **Required:** No, defaults to `[]`
     - **Example:** `["org1"]`
 
 ### `ITEMS_FILTER_KWARGS`
 
-: Keyword arguments for CQL2 expression generator
+: Keyword arguments for CQL2 expression factor
 
     - **Type:** Dictionary of keyword arguments used to initialize the class
     - **Required:** No, defaults to `{}`
@@ -232,23 +232,23 @@ The application is configurable via environment variables.
 
 ### `COLLECTIONS_FILTER_CLS`
 
-: CQL2 expression generator for collection-level filtering
+: CQL2 expression factor for collection-level filtering
 
     - **Type:** JSON object with class configuration
     - **Required:** No, defaults to `null` (disabled)
     - **Example:** `stac_auth_proxy.filters:Opa`, `stac_auth_proxy.filters:Template`, `my_package:OrganizationFilter`
 
 ### `COLLECTIONS_FILTER_ARGS`
 
-: Positional arguments for CQL2 expression generator
+: Positional arguments for CQL2 expression factor
 
     - **Type:** List of positional arguments used to initialize the class
     - **Required:** No, defaults to `[]`
     - **Example:** `["org1"]`
 
 ### `COLLECTIONS_FILTER_KWARGS`
 
-: Keyword arguments for CQL2 expression generator
+: Keyword arguments for CQL2 expression factor
 
     - **Type:** Dictionary of keyword arguments used to initialize the class
     - **Required:** No, defaults to `{}`

docs/user-guide/record-level-auth.md

@@ -58,20 +58,20 @@ The [`ITEMS_FILTER_CLS`](configuration.md#items_filter_cls) applies filters to t
 
 ## Filter Contract
 
-A filter generator implements the following contract:
+A filter factory implements the following contract:
 
 - A class or function that may take initialization arguments
-- Once initialized, the generator is a callable with the following behavior:
+- Once initialized, the factory is a callable with the following behavior:
   - **Input**: A context dictionary containing request and user information
   - **Output**: A valid CQL2 expression (as a string or dict) that filters the data
 
 In Python typing syntax, it conforms to:
 
 ```py
-FilterGenerator = Callable[..., Callable[[dict[str, Any]], Awaitable[str | dict[str, Any]]]]
+FilterFactory = Callable[..., Callable[[dict[str, Any]], Awaitable[str | dict[str, Any]]]]
 ```
 
-### Example Filter Generator
+### Example Filter Factory
 
 ```py
 import dataclasses
@@ -87,7 +87,7 @@ class ExampleFilter:
 ```
 
 > [!TIP]
-> Despite being referred to as a _class_, a filter generator could be written as a function.
+> Despite being referred to as a _class_ in the settings, a filter factory could be written as a function.
 >
 >   <details>
 >
@@ -149,7 +149,7 @@ ITEMS_FILTER_KWARGS='{"cache_ttl": 30.0}'
 - `{FILTER_TYPE}_FILTER_ARGS`: Positional arguments (comma-separated)
 - `{FILTER_TYPE}_FILTER_KWARGS`: Keyword arguments (comma-separated key=value pairs)
 
-## Built-in Filter Generators
+## Built-in Filter Factorys
 
 ### Template Filter
 
@@ -195,14 +195,14 @@ items_cql2 := "true" if {
 }
 ```
 
-## Custom Filter Generators
+## Custom Filter Factories
 
 > [!TIP]
 > An example integration can be found in [`examples/custom-integration`](https://github.com/developmentseed/stac-auth-proxy/blob/main/examples/custom-integration).
 
-### Complex Filter Generator
+### Complex Filter Factory
 
-An example of a more complex filter generator where the filter is generated based on the response of an external API:
+An example of a more complex filter factory where the filter is generated based on the response of an external API:
 
 ```py
 import dataclasses

examples/custom-integration/README.md

@@ -1,6 +1,6 @@
 # Custom Integration Example
 
-This example demonstrates how to integrate with a custom filter generator.
+This example demonstrates how to integrate with a custom filter factory.
 
 ## Running the Example
 

helm/values.schema.yaml

@@ -92,13 +92,13 @@ properties:
       # Filtering
       ITEMS_FILTER_CLS:
         type: ["string", "null"]
-        description: "CQL2 expression generator for item-level filtering"
+        description: "CQL2 expression factor for item-level filtering"
       ITEMS_FILTER_ARGS:
         type: ["array", "string"]
-        description: "Positional arguments for CQL2 expression generator"
+        description: "Positional arguments for CQL2 expression factor"
       ITEMS_FILTER_KWARGS:
         type: ["object", "string"]
-        description: "Keyword arguments for CQL2 expression generator"
+        description: "Keyword arguments for CQL2 expression factor"
     required:
       - UPSTREAM_URL
       - OIDC_DISCOVERY_URL

src/stac_auth_proxy/filters/__init__.py

@@ -1,4 +1,4 @@
-"""CQL2 filter generators."""
+"""CQL2 filter factories."""
 
 from .opa import Opa
 from .template import Template

tests/test_filters_opa.py

@@ -9,7 +9,7 @@
 
 
 @pytest.fixture
-def opa_filter_generator():
+def opa_filter_factory():
     """Create an OPA instance for testing."""
     return Opa(host="http://localhost:8181", decision="stac/filter")
 
@@ -24,72 +24,72 @@ def mock_opa_response():
 
 
 @pytest.mark.asyncio
-async def test_opa_initialization(opa_filter_generator):
+async def test_opa_initialization(opa_filter_factory):
     """Test OPA initialization."""
-    assert opa_filter_generator.host == "http://localhost:8181"
-    assert opa_filter_generator.decision == "stac/filter"
-    assert opa_filter_generator.cache_key == "req.headers.authorization"
-    assert opa_filter_generator.cache_ttl == 5.0
-    assert isinstance(opa_filter_generator.client, AsyncClient)
-    assert opa_filter_generator.cache is not None
+    assert opa_filter_factory.host == "http://localhost:8181"
+    assert opa_filter_factory.decision == "stac/filter"
+    assert opa_filter_factory.cache_key == "req.headers.authorization"
+    assert opa_filter_factory.cache_ttl == 5.0
+    assert isinstance(opa_filter_factory.client, AsyncClient)
+    assert opa_filter_factory.cache is not None
 
 
 @pytest.mark.asyncio
-async def test_opa_cache_hit(opa_filter_generator, mock_opa_response):
+async def test_opa_cache_hit(opa_filter_factory, mock_opa_response):
     """Test OPA cache hit behavior."""
     context = {"req": {"headers": {"authorization": "test-token"}}}
 
     # Mock the OPA response
     with patch.object(
-        opa_filter_generator.client, "post", new_callable=AsyncMock
+        opa_filter_factory.client, "post", new_callable=AsyncMock
     ) as mock_post:
         mock_post.return_value = mock_opa_response
 
         # First call should hit OPA
-        result = await opa_filter_generator(context)
+        result = await opa_filter_factory(context)
         assert result == "collection = 'test'"
         assert mock_post.call_count == 1
 
         # Second call should use cache
-        result = await opa_filter_generator(context)
+        result = await opa_filter_factory(context)
         assert result == "collection = 'test'"
         assert mock_post.call_count == 1  # Still 1, no new call made
 
 
 @pytest.mark.asyncio
-async def test_opa_cache_miss(opa_filter_generator, mock_opa_response):
+async def test_opa_cache_miss(opa_filter_factory, mock_opa_response):
     """Test OPA cache miss behavior."""
     context = {"req": {"headers": {"authorization": "test-token"}}}
 
     with patch.object(
-        opa_filter_generator.client, "post", new_callable=AsyncMock
+        opa_filter_factory.client, "post", new_callable=AsyncMock
     ) as mock_post:
         mock_post.return_value = mock_opa_response
 
         # First call with token1
-        result = await opa_filter_generator(context)
+        result = await opa_filter_factory(context)
         assert result == "collection = 'test'"
         assert mock_post.call_count == 1
 
         # Call with different token should miss cache
         context["req"]["headers"]["authorization"] = "different-token"
-        result = await opa_filter_generator(context)
+        result = await opa_filter_factory(context)
         assert result == "collection = 'test'"
         assert mock_post.call_count == 2  # New call made
 
 
 @pytest.mark.asyncio
-async def test_opa_error_handling(opa_filter_generator):
+async def test_opa_error_handling(opa_filter_factory):
     """Test OPA error handling."""
     context = {"req": {"headers": {"authorization": "test-token"}}}
 
     with patch.object(
-        opa_filter_generator.client, "post", new_callable=AsyncMock
+        opa_filter_factory.client, "post", new_callable=AsyncMock
     ) as mock_post:
         # Create a mock response that raises an exception on raise_for_status
         error_response = MagicMock(spec=Response)
         error_response.raise_for_status.side_effect = Exception("Internal server error")
         mock_post.return_value = error_response
 
         with pytest.raises(Exception):
-            await opa_filter_generator(context)
+            await opa_filter_factory(context)