Begin draft

alembic/versions/2025_10_20_1620-6adf9d894180_enable_data_source_agency_submission.py

@@ -0,0 +1,109 @@
+"""Enable data source/agency submission
+
+Revision ID: 6adf9d894180
+Revises: 9d57b3b79d35
+Create Date: 2025-10-20 16:20:44.081736
+
+"""
+from typing import Sequence, Union
+
+from alembic import op
+import sqlalchemy as sa
+from sqlalchemy.dialects.postgresql import ENUM, ARRAY
+
+
+# revision identifiers, used by Alembic.
+revision: str = '6adf9d894180'
+down_revision: Union[str, None] = '9d57b3b79d35'
+branch_labels: Union[str, Sequence[str], None] = None
+depends_on: Union[str, Sequence[str], None] = None
+
+def upgrade() -> None:
+    _add_autogenerated_agency_id()
+    _add_new_columns_to_optional_ds_metadata()
+
+def _add_new_columns_to_optional_ds_metadata():
+    table_name: str = "url_optional_data_source_metadata"
+
+    agency_aggregation_enum = ENUM(
+        'federal',
+        'state',
+        'county',
+        'local',
+        name='agency_aggregation_enum',
+        create_type=True,
+    )
+    agency_aggregation_enum.create(op.get_bind())
+
+    update_method_enum = ENUM(
+        'Overwrite',
+        'Insert',
+        'No updates',
+        name='update_method_enum',
+        create_type=True
+    )
+    update_method_enum.create(op.get_bind())
+
+    retention_schedule_enum = ENUM(
+        'Future only',
+        '1 month',
+        '1 day',
+        '1 week',
+        '1-10 years',
+        '< 1 day',
+        '< 1 week',
+        '< 1 year',
+        '> 10 years',
+        name='retention_schedule_enum',
+        create_type=True
+    )
+    retention_schedule_enum.create(op.get_bind())
+
+    access_type_enum = ENUM(
+        'Webpage',
+        'Download',
+        'API',
+        name='access_type_enum',
+        create_type=True,
+    )
+    access_type_enum.create(op.get_bind())
+
+    for column in [
+        sa.Column('coverage_start', sa.Date(), nullable=True),
+        sa.Column('coverage_end', sa.Date(), nullable=True),
+        sa.Column("agency_supplied", sa.Boolean(), nullable=True),
+        sa.Column('agency_originated', sa.Boolean(), nullable=True),
+        sa.Column('agency_aggregation', agency_aggregation_enum),
+        sa.Column('agency_described_not_in_database', sa.Text(), nullable=True),
+        sa.Column('update_method', update_method_enum, nullable=True),
+        sa.Column('readme_url', sa.Text(), nullable=True),
+        sa.Column('originating_entity', sa.Text(), nullable=True),
+        sa.Column('retention_schedule', retention_schedule_enum, nullable=True),
+        sa.Column('scraper_url', sa.Text(), nullable=True),
+        sa.Column('submission_notes', sa.Text(), nullable=True),
+        sa.Column('access_notes', sa.Text(), nullable=True),
+        sa.Column('access_types', ARRAY(
+            access_type_enum
+        ), nullable=True),
+    ]:
+        op.add_column(
+            table_name,
+            column,
+        )
+
+def _add_autogenerated_agency_id():
+    op.execute(
+        """
+        CREATE SEQUENCE agencies_agency_id START WITH 23191;
+        """
+        )
+
+    op.execute(
+        """
+        ALTER TABLE agencies
+            ALTER COLUMN agency_id SET DEFAULT nextval('agencies_agency_id');
+               """
+    )
+
+def downgrade() -> None:
+    pass

pytest.ini

@@ -3,3 +3,4 @@ timeout = 300
 asyncio_default_fixture_loop_scope=function
 markers =
     manual: mark test as manual-only (excluded from default test runs)
+asyncio_mode = auto

src/api/endpoints/agencies/by_id/delete/query.py

@@ -0,0 +1,22 @@
+from sqlalchemy import delete
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from src.db.models.impl.agency.sqlalchemy import Agency
+from src.db.queries.base.builder import QueryBuilderBase
+
+
+class DeleteAgencyQueryBuilder(QueryBuilderBase):
+
+    def __init__(
+            self,
+            agency_id: int,
+    ):
+        super().__init__()
+        self.agency_id = agency_id
+
+    async def run(self, session: AsyncSession) -> None:
+        statement = (
+            delete(Agency)
+            .where(Agency.agency_id == self.agency_id)
+        )
+        await session.execute(statement)

src/api/endpoints/agencies/by_id/locations/delete/query.py

@@ -0,0 +1,29 @@
+from sqlalchemy import delete
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from src.db.models.impl.link.agency_location.sqlalchemy import LinkAgencyLocation
+from src.db.queries.base.builder import QueryBuilderBase
+
+
+class DeleteAgencyLocationQueryBuilder(QueryBuilderBase):
+
+    def __init__(
+            self,
+            agency_id: int,
+            location_id: int,
+    ):
+        super().__init__()
+        self.agency_id = agency_id
+        self.location_id = location_id
+
+    async def run(self, session: AsyncSession) -> None:
+        statement = (
+            delete(LinkAgencyLocation)
+            .where(
+                (LinkAgencyLocation.agency_id == self.agency_id)
+                & (LinkAgencyLocation.location_id == self.location_id)
+            )
+        )
+
+        await session.execute(statement)
+

src/api/endpoints/agencies/by_id/locations/get/query.py

@@ -0,0 +1,37 @@
+from typing import Sequence
+
+from sqlalchemy import select, RowMapping
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from src.api.endpoints.agencies.by_id.locations.get.response import AgencyGetLocationsResponse
+from src.db.models.impl.link.agency_location.sqlalchemy import LinkAgencyLocation
+from src.db.models.views.location_expanded import LocationExpandedView
+from src.db.queries.base.builder import QueryBuilderBase
+
+
+class GetAgencyLocationsQueryBuilder(QueryBuilderBase):
+
+    def __init__(
+            self,
+            agency_id: int,
+    ):
+        super().__init__()
+        self.agency_id = agency_id
+
+    async def run(self, session: AsyncSession) -> list[AgencyGetLocationsResponse]:
+        query = (
+            select(
+                LinkAgencyLocation.location_id,
+                LocationExpandedView.full_display_name
+            )
+            .where(
+                LinkAgencyLocation.agency_id == self.agency_id
+            )
+            .join(
+                LocationExpandedView,
+                LocationExpandedView.id == LinkAgencyLocation.location_id
+            )
+        )
+
+        result: Sequence[RowMapping] = await self.sh.mappings(session, query=query)
+        return [AgencyGetLocationsResponse(**row) for row in result]

src/api/endpoints/agencies/by_id/locations/get/response.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class AgencyGetLocationsResponse(BaseModel):
+    location_id: int
+    full_display_name: str

src/api/endpoints/agencies/by_id/locations/post/query.py

@@ -0,0 +1,23 @@
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from src.db.models.impl.link.agency_location.sqlalchemy import LinkAgencyLocation
+from src.db.queries.base.builder import QueryBuilderBase
+
+
+class AddAgencyLocationQueryBuilder(QueryBuilderBase):
+
+    def __init__(
+            self,
+            agency_id: int,
+            location_id: int
+    ):
+        super().__init__()
+        self.agency_id = agency_id
+        self.location_id = location_id
+
+    async def run(self, session: AsyncSession) -> None:
+        lal = LinkAgencyLocation(
+            agency_id=self.agency_id,
+            location_id=self.location_id,
+        )
+        session.add(lal)

src/api/endpoints/agencies/by_id/put/query.py

@@ -0,0 +1,42 @@
+from fastapi import HTTPException
+from sqlalchemy import select
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from src.api.endpoints.agencies.by_id.put.request import AgencyPutRequest
+from src.db.models.impl.agency.sqlalchemy import Agency
+from src.db.queries.base.builder import QueryBuilderBase
+
+
+class UpdateAgencyQueryBuilder(QueryBuilderBase):
+
+    def __init__(
+            self,
+            agency_id: int,
+            request: AgencyPutRequest,
+    ):
+        super().__init__()
+        self.agency_id = agency_id
+        self.request = request
+
+    async def run(self, session: AsyncSession) -> None:
+
+        query = (
+            select(
+                Agency
+            )
+            .where(
+                Agency.agency_id == self.agency_id
+            )
+        )
+
+        agency = await self.sh.one_or_none(session, query=query)
+        if not agency:
+            raise HTTPException(status_code=400, detail="Agency not found")
+
+        if self.request.name is not None:
+            agency.name = self.request.name
+        if self.request.type is not None:
+            agency.type = self.request.type
+        if self.request.jurisdiction_type is not None:
+            agency.jurisdiction_type = self.request.jurisdiction_type
+

src/api/endpoints/agencies/by_id/put/request.py

@@ -0,0 +1,9 @@
+from pydantic import BaseModel
+
+from src.db.models.impl.agency.enums import AgencyType, JurisdictionType
+
+
+class AgencyPutRequest(BaseModel):
+    name: str | None = None
+    type: AgencyType | None = None
+    jurisdiction_type: JurisdictionType | None = None

src/api/endpoints/agencies/root/get/query.py

@@ -0,0 +1,52 @@
+from sqlalchemy import select, Result
+from sqlalchemy.ext.asyncio import AsyncSession
+from sqlalchemy.orm import joinedload, selectinload
+
+from src.api.endpoints.agencies.by_id.locations.get.response import AgencyGetLocationsResponse
+from src.api.endpoints.agencies.root.get.response import AgencyGetResponse
+from src.db.models.impl.agency.sqlalchemy import Agency
+from src.db.queries.base.builder import QueryBuilderBase
+
+
+class GetAgenciesQueryBuilder(QueryBuilderBase):
+
+    def __init__(
+            self,
+            page: int,
+    ):
+        super().__init__()
+        self.page = page
+
+    async def run(self, session: AsyncSession) -> list[AgencyGetResponse]:
+
+        query = (
+            select(
+                Agency
+            )
+            .options(
+                selectinload(Agency.locations)
+            )
+            .offset((self.page - 1) * 100)
+            .limit(100)
+        )
+
+        results: Result[tuple[Agency]] = await session.execute(query)
+        responses: list[AgencyGetResponse] = []
+        for result in results:
+            agency: Agency = result[0]
+            locations: list[AgencyGetLocationsResponse] = [
+                AgencyGetLocationsResponse(
+                    location_id=location.id,
+                    full_display_name=location.full_display_name,
+                )
+                for location in agency.locations
+            ]
+            responses.append(AgencyGetResponse(
+                id=agency.agency_id,
+                name=agency.name,
+                type=agency.agency_type,
+                jurisdiction_type=agency.jurisdiction_type,
+                locations=locations,
+            ))
+
+        return responses

src/api/endpoints/agencies/root/get/response.py

@@ -0,0 +1,12 @@
+from pydantic import BaseModel
+
+from src.api.endpoints.agencies.by_id.locations.get.response import AgencyGetLocationsResponse
+from src.db.models.impl.agency.enums import AgencyType, JurisdictionType
+
+
+class AgencyGetResponse(BaseModel):
+    id: int
+    name: str
+    type: AgencyType
+    jurisdiction_type: JurisdictionType
+    locations: list[AgencyGetLocationsResponse]