Merge pull request #10 from OpenDataServices/portals

Portals

Author: jarofgreen

oc4ids_datastore_api/models.py

@@ -13,6 +13,8 @@ class DatasetSQLModel(SQLModel, table=True):
     license_url: str | None
     license_title: str | None
     license_title_short: str | None
+    portal_title: str | None
+    portal_url: str | None
     json_url: str | None
     csv_url: str | None
     xlsx_url: str | None

oc4ids_datastore_api/schemas.py

@@ -14,6 +14,11 @@ class License(BaseModel):
     title_short: str | None
 
 
+class Portal(BaseModel):
+    url: str | None
+    title: str | None
+
+
 class Download(BaseModel):
     format: str
     url: str
@@ -24,4 +29,5 @@ class Dataset(BaseModel):
     source_url: str
     publisher: Publisher
     license: License
+    portal: Portal
     downloads: list[Download]

oc4ids_datastore_api/services.py

@@ -1,6 +1,6 @@
 from oc4ids_datastore_api.database import fetch_all_datasets
 from oc4ids_datastore_api.models import DatasetSQLModel
-from oc4ids_datastore_api.schemas import Dataset, Download, License, Publisher
+from oc4ids_datastore_api.schemas import Dataset, Download, License, Portal, Publisher
 
 
 def _transform_dataset(dataset: DatasetSQLModel) -> Dataset:
@@ -23,6 +23,10 @@ def _transform_dataset(dataset: DatasetSQLModel) -> Dataset:
             title=dataset.license_title,
             title_short=dataset.license_title_short,
         ),
+        portal=Portal(
+            url=dataset.portal_url,
+            title=dataset.portal_title,
+        ),
         downloads=downloads,
     )
 

pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "oc4ids-datastore-api"
 description = "OC4IDS Datastore API"
-version = "0.3.0"
+version = "0.4.0"
 readme = "README.md"
 dependencies = [
   "fastapi[standard]",

tests/test_services.py

@@ -3,7 +3,7 @@
 from pytest_mock import MockerFixture
 
 from oc4ids_datastore_api.models import DatasetSQLModel
-from oc4ids_datastore_api.schemas import Dataset, Download, License, Publisher
+from oc4ids_datastore_api.schemas import Dataset, Download, License, Portal, Publisher
 from oc4ids_datastore_api.services import get_all_datasets
 
 
@@ -20,6 +20,8 @@ def test_get_all_datasets(mocker: MockerFixture) -> None:
         license_url="https://license.com",
         license_title="License",
         license_title_short="L",
+        portal_url="https://portal.com",
+        portal_title="Portal",
         json_url="https://downloads/test_dataset.json",
         csv_url="https://downloads/test_dataset.csv",
         xlsx_url="https://downloads/test_dataset.xlsx",
@@ -34,6 +36,7 @@ def test_get_all_datasets(mocker: MockerFixture) -> None:
         source_url="https://test-dataset.json",
         publisher=Publisher(name="test_publisher", country="ab"),
         license=License(title="License", title_short="L", url="https://license.com"),
+        portal=Portal(title="Portal", url="https://portal.com"),
         downloads=[
             Download(format="json", url="https://downloads/test_dataset.json"),
             Download(format="csv", url="https://downloads/test_dataset.csv"),
@@ -69,6 +72,7 @@ def test_get_all_datasets_missing_download_formats(mocker: MockerFixture) -> Non
         source_url="https://test-dataset.json",
         publisher=Publisher(name="test_publisher", country=None),
         license=License(title="License", title_short="L", url="https://license.com"),
+        portal=Portal(title=None, url=None),
         downloads=[
             Download(format="json", url="https://downloads/test_dataset.json"),
         ],