feat: don't include download formats with no URL

Author: tillywoodfield

README.md

@@ -33,8 +33,8 @@ While the app is running, go to `http://127.0.0.1:8000/docs/`
 ### Run linting and type checking
 
 ```
-black oc4ids_datastore_api/
-isort oc4ids_datastore_api/
-flake8 oc4ids_datastore_api/
-mypy oc4ids_datastore_api/
+black oc4ids_datastore_api/ tests/
+isort oc4ids_datastore_api/ tests/
+flake8 oc4ids_datastore_api/ tests/
+mypy oc4ids_datastore_api/ tests/
 ```

oc4ids_datastore_api/services.py

@@ -4,10 +4,13 @@
 
 
 def _transform_dataset(dataset: DatasetSQLModel) -> Dataset:
+    download_urls = {
+        "json": dataset.json_url,
+        "csv": dataset.csv_url,
+        "xlsx": dataset.xlsx_url,
+    }
     downloads = [
-        Download(format="json", url=(dataset.json_url or "")),
-        Download(format="csv", url=(dataset.csv_url or "")),
-        Download(format="xlsx", url=(dataset.xlsx_url or "")),
+        Download(format=format, url=url) for format, url in download_urls.items() if url
     ]
     return Dataset(
         loaded_at=dataset.updated_at,

pyproject.toml

@@ -20,6 +20,8 @@ dev = [
   "flake8",
   "Flake8-pyproject",
   "mypy",
+  "pytest",
+  "pytest-mock",
 ]
 
 [tool.isort]
@@ -30,3 +32,7 @@ max-line-length = 88
 
 [tool.mypy]
 strict = true
+
+[tool.pytest.ini_options]
+log_cli = true
+log_cli_level = "INFO"

requirements_dev.txt

@@ -52,6 +52,8 @@ idna==3.10
     #   anyio
     #   email-validator
     #   httpx
+iniconfig==2.0.0
+    # via pytest
 isort==6.0.0
     # via oc4ids-datastore-api (pyproject.toml)
 jinja2==3.1.5
@@ -71,11 +73,15 @@ mypy-extensions==1.0.0
     #   black
     #   mypy
 packaging==24.2
-    # via black
+    # via
+    #   black
+    #   pytest
 pathspec==0.12.1
     # via black
 platformdirs==4.3.6
     # via black
+pluggy==1.5.0
+    # via pytest
 psycopg2==2.9.10
     # via oc4ids-datastore-api (pyproject.toml)
 pycodestyle==2.12.1
@@ -90,6 +96,12 @@ pyflakes==3.2.0
     # via flake8
 pygments==2.19.1
     # via rich
+pytest==8.3.4
+    # via
+    #   oc4ids-datastore-api (pyproject.toml)
+    #   pytest-mock
+pytest-mock==3.14.0
+    # via oc4ids-datastore-api (pyproject.toml)
 python-dotenv==1.0.1
     # via uvicorn
 python-multipart==0.0.20

tests/test_services.py

@@ -0,0 +1,74 @@
+import datetime
+
+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.services import get_all_datasets
+
+
+def test_get_all_datasets(mocker: MockerFixture) -> None:
+    patch_fetch_all_datasets = mocker.patch(
+        "oc4ids_datastore_api.services.fetch_all_datasets"
+    )
+    now = datetime.datetime.now()
+    dataset_sql_model = DatasetSQLModel(
+        dataset_id="test_dataset",
+        source_url="https://test-dataset.json",
+        publisher_name="test_publisher",
+        license_url="https://license.com",
+        license_name="License",
+        json_url="https://downloads/test_dataset.json",
+        csv_url="https://downloads/test_dataset.csv",
+        xlsx_url="https://downloads/test_dataset.xlsx",
+        updated_at=now,
+    )
+    patch_fetch_all_datasets.return_value = [dataset_sql_model]
+
+    datasets = get_all_datasets()
+
+    expected_dataset = Dataset(
+        loaded_at=now,
+        source_url="https://test-dataset.json",
+        publisher=Publisher(name="test_publisher"),
+        license=License(name="License", url="https://license.com"),
+        downloads=[
+            Download(format="json", url="https://downloads/test_dataset.json"),
+            Download(format="csv", url="https://downloads/test_dataset.csv"),
+            Download(format="xlsx", url="https://downloads/test_dataset.xlsx"),
+        ],
+    )
+    assert datasets == [expected_dataset]
+
+
+def test_get_all_datasets_missing_download_formats(mocker: MockerFixture) -> None:
+    patch_fetch_all_datasets = mocker.patch(
+        "oc4ids_datastore_api.services.fetch_all_datasets"
+    )
+    now = datetime.datetime.now()
+    dataset_sql_model = DatasetSQLModel(
+        dataset_id="test_dataset",
+        source_url="https://test-dataset.json",
+        publisher_name="test_publisher",
+        license_url="https://license.com",
+        license_name="License",
+        json_url="https://downloads/test_dataset.json",
+        csv_url=None,
+        xlsx_url=None,
+        updated_at=now,
+    )
+    patch_fetch_all_datasets.return_value = [dataset_sql_model]
+
+    datasets = get_all_datasets()
+
+    expected_dataset = Dataset(
+        loaded_at=now,
+        source_url="https://test-dataset.json",
+        publisher=Publisher(name="test_publisher"),
+        license=License(name="License", url="https://license.com"),
+        downloads=[
+            Download(format="json", url="https://downloads/test_dataset.json"),
+        ],
+    )
+
+    assert datasets == [expected_dataset]