Add meta URL and data source CRUD endpoints

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

@@ -8,5 +8,8 @@
     id: int
     name: str
     type: AgencyType
-    jurisdiction_type: JurisdictionType
-    locations: list[AgencyGetLocationsResponse]
+    jurisdiction_type: JurisdictionType | None
+    locations: list[AgencyGetLocationsResponse]
+
+class AgencyGetOuterResponse(BaseModel):
+    results: list[AgencyGetResponse]

src/api/endpoints/data_source/by_id/agency/delete/wrapper.py

@@ -0,0 +1,17 @@
+from src.api.endpoints.data_source.by_id.agency.shared.check import check_is_data_source_url
+from src.api.shared.agency.delete.query import RemoveURLAgencyLinkQueryBuilder
+from src.db.client.async_ import AsyncDatabaseClient
+
+
+async def delete_data_source_agency_link(
+    url_id: int,
+    agency_id: int,
+    adb_client: AsyncDatabaseClient
+) -> None:
+    await check_is_data_source_url(url_id=url_id, adb_client=adb_client)
+    await adb_client.run_query_builder(
+        RemoveURLAgencyLinkQueryBuilder(
+            url_id=url_id,
+            agency_id=agency_id
+        )
+    )

src/api/endpoints/data_source/by_id/agency/get/wrapper.py

@@ -0,0 +1,14 @@
+from src.api.endpoints.agencies.root.get.response import AgencyGetOuterResponse
+from src.api.endpoints.data_source.by_id.agency.shared.check import check_is_data_source_url
+from src.api.shared.agency.get.query import GetRelatedAgenciesQueryBuilder
+from src.db.client.async_ import AsyncDatabaseClient
+
+
+async def get_data_source_agencies_wrapper(
+    url_id: int,
+    adb_client: AsyncDatabaseClient
+) -> AgencyGetOuterResponse:
+    await check_is_data_source_url(url_id=url_id, adb_client=adb_client)
+    return await adb_client.run_query_builder(
+        GetRelatedAgenciesQueryBuilder(url_id=url_id)
+    )

src/api/endpoints/data_source/by_id/agency/post/wrapper.py

@@ -0,0 +1,17 @@
+from src.api.endpoints.data_source.by_id.agency.shared.check import check_is_data_source_url
+from src.api.shared.agency.post.query import AddURLAgencyLinkQueryBuilder
+from src.db.client.async_ import AsyncDatabaseClient
+
+
+async def add_data_source_agency_link(
+    url_id: int,
+    agency_id: int,
+    adb_client: AsyncDatabaseClient
+) -> None:
+    await check_is_data_source_url(url_id=url_id, adb_client=adb_client)
+    await adb_client.run_query_builder(
+        AddURLAgencyLinkQueryBuilder(
+            url_id=url_id,
+            agency_id=agency_id
+        )
+    )

src/api/endpoints/data_source/by_id/agency/shared/check.py

@@ -0,0 +1,17 @@
+from src.api.shared.check.url_type.query import CheckURLTypeQueryBuilder
+from src.db.client.async_ import AsyncDatabaseClient
+from src.db.models.impl.flag.url_validated.enums import URLType
+
+
+async def check_is_data_source_url(
+    url_id: int,
+    adb_client: AsyncDatabaseClient
+) -> None:
+    """
+    Raises:
+        Bad Request if url_type is not valid or does not exist
+    """
+
+    await adb_client.run_query_builder(
+        CheckURLTypeQueryBuilder(url_id=url_id, url_type=URLType.DATA_SOURCE)
+    )

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

@@ -0,0 +1,123 @@
+from sqlalchemy import update, select, literal, insert
+from sqlalchemy.ext.asyncio import AsyncSession
+
+from src.api.endpoints.data_source.by_id.put.request import DataSourcePutRequest
+from src.api.shared.batch.url.link import UpdateBatchURLLinkQueryBuilder
+from src.api.shared.record_type.put.query import UpdateRecordTypeQueryBuilder
+from src.api.shared.url.put.query import UpdateURLQueryBuilder
+from src.db.models.impl.url.optional_ds_metadata.sqlalchemy import URLOptionalDataSourceMetadata
+from src.db.queries.base.builder import QueryBuilderBase
+
+
+class UpdateDataSourceQueryBuilder(QueryBuilderBase):
+
+    def __init__(
+        self,
+        url_id: int,
+        request: DataSourcePutRequest,
+    ):
+        super().__init__()
+        self.url_id = url_id
+        self.request = request
+
+    async def run(self, session: AsyncSession) -> None:
+
+        if self.request.record_type is not None:
+            await UpdateRecordTypeQueryBuilder(
+                url_id=self.url_id,
+                record_type=self.request.record_type
+            ).run(session)
+
+        # Update URL if any of the URL fields are not None
+        if (
+            self.request.description is None and
+            self.request.name is None and
+            self.request.description is None
+        ):
+            return
+
+        # Update Batch if Batch link is none
+        if self.request.batch_id is not None:
+            await UpdateBatchURLLinkQueryBuilder(
+                batch_id=self.request.batch_id,
+                url_id=self.url_id
+            ).run(session)
+
+        await UpdateURLQueryBuilder(
+            url_id=self.url_id,
+            url=self.request.url,
+            name=self.request.name,
+            description=self.request.description,
+        ).run(
+            session,
+        )
+        if not self.request.optional_data_source_metadata_not_none():
+            return
+        value_dict = {}
+        if self.request.record_formats is not None:
+            value_dict["record_formats"] = self.request.record_formats
+        if self.request.data_portal_type is not None:
+            value_dict["data_portal_type"] = self.request.data_portal_type
+        if self.request.supplying_entity is not None:
+            value_dict["supplying_entity"] = self.request.supplying_entity
+        if self.request.coverage_start is not None:
+            value_dict["coverage_start"] = self.request.coverage_start
+        if self.request.coverage_end is not None:
+            value_dict["coverage_end"] = self.request.coverage_end
+        if self.request.agency_supplied is not None:
+            value_dict["agency_supplied"] = self.request.agency_supplied
+        if self.request.agency_originated is not None:
+            value_dict["agency_originated"] = self.request.agency_originated
+        if self.request.agency_aggregation is not None:
+            value_dict["agency_aggregation"] = self.request.agency_aggregation
+        if self.request.agency_described_not_in_database is not None:
+            value_dict["agency_described_not_in_database"] = self.request.agency_described_not_in_database
+        if self.request.update_method is not None:
+            value_dict["update_method"] = self.request.update_method
+        if self.request.readme_url is not None:
+            value_dict["readme_url"] = self.request.readme_url
+        if self.request.originating_entity is not None:
+            value_dict["originating_entity"] = self.request.originating_entity
+        if self.request.retention_schedule is not None:
+            value_dict["retention_schedule"] = self.request.retention_schedule
+        if self.request.scraper_url is not None:
+            value_dict["scraper_url"] = self.request.scraper_url
+        if self.request.submission_notes is not None:
+            value_dict["submission_notes"] = self.request.submission_notes
+        if self.request.access_notes is not None:
+            value_dict["access_notes"] = self.request.access_notes
+        if self.request.access_types is not None:
+            value_dict["access_types"] = self.request.access_types
+
+        # Check for existing metadata object
+        query = (
+            select(
+                literal(True)
+            )
+            .where(
+                URLOptionalDataSourceMetadata.url_id == self.url_id
+            )
+        )
+        exists = await self.sh.one_or_none(session=session, query=query)
+        if not exists:
+            insert_obj = URLOptionalDataSourceMetadata(
+                url_id=self.url_id,
+                **value_dict
+            )
+            session.add(insert_obj)
+        else:
+            statement = (
+                update(
+                    URLOptionalDataSourceMetadata
+                )
+                .where(
+                    URLOptionalDataSourceMetadata.url_id == self.url_id
+                )
+                .values(
+                    value_dict
+                )
+            )
+
+            await session.execute(statement)
+
+

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

@@ -0,0 +1,59 @@
+from datetime import date
+
+from pydantic import BaseModel
+
+from src.core.enums import RecordType
+from src.db.models.impl.url.optional_ds_metadata.enums import AgencyAggregationEnum, UpdateMethodEnum, \
+    RetentionScheduleEnum, AccessTypeEnum
+
+
+class DataSourcePutRequest(BaseModel):
+
+    # Required Attributes
+    url: str | None = None
+    name: str | None = None
+    record_type: RecordType | None = None
+
+    # Optional Attributes
+    batch_id: int | None = None
+    description: str | None = None
+
+    # Optional data source metadata
+    record_formats: list[str] | None = None
+    data_portal_type: str | None = None
+    supplying_entity: str | None = None
+    coverage_start: date | None = None
+    coverage_end: date | None = None
+    agency_supplied: bool | None = None
+    agency_originated: bool | None = None
+    agency_aggregation: AgencyAggregationEnum | None = None
+    agency_described_not_in_database: str | None = None
+    update_method: UpdateMethodEnum | None = None
+    readme_url: str | None = None
+    originating_entity: str | None = None
+    retention_schedule: RetentionScheduleEnum | None = None
+    scraper_url: str | None = None
+    submission_notes: str | None = None
+    access_notes: str | None = None
+    access_types: list[AccessTypeEnum] | None = None
+
+    def optional_data_source_metadata_not_none(self) -> bool:
+        return (
+            self.record_formats is not None or
+            self.data_portal_type is not None or
+            self.supplying_entity is not None or
+            self.coverage_start is not None or
+            self.coverage_end is not None or
+            self.agency_supplied is not None or
+            self.agency_originated is not None or
+            self.agency_aggregation is not None or
+            self.agency_described_not_in_database is not None or
+            self.update_method is not None or
+            self.readme_url is not None or
+            self.originating_entity is not None or
+            self.retention_schedule is not None or
+            self.scraper_url is not None or
+            self.submission_notes is not None or
+            self.access_notes is not None or
+            self.access_types is not None
+        )