Merge pull request #933 from thunderstore-io/cyberstorm-package-versions-endpoint

Cyberstorm API: add endpoint for Package's versions

Author: anttimaki

django/thunderstore/api/cyberstorm/tests/test_package_versions.py

@@ -0,0 +1,50 @@
+import pytest
+from rest_framework.test import APIClient
+
+from thunderstore.repository.factories import PackageVersionFactory
+from thunderstore.repository.models import Package
+
+
+@pytest.mark.django_db
+def test_package_versions_api_view__returns_error_for_inactive_package(
+    api_client: APIClient,
+    package: Package,
+) -> None:
+    package.is_active = False
+    package.save()
+
+    response = api_client.get(
+        f"/api/cyberstorm/versions/{package.namespace}/{package.name}/",
+    )
+    actual = response.json()
+
+    assert actual["detail"] == "Not found."
+
+
+@pytest.mark.django_db
+def test_package_versions_api_view__does_not_return_inactive_versions(
+    api_client: APIClient,
+) -> None:
+    inactive = PackageVersionFactory(is_active=False)
+
+    response = api_client.get(
+        f"/api/cyberstorm/versions/{inactive.package.namespace}/{inactive.package.name}/",
+    )
+    actual = response.json()
+
+    assert actual["detail"] == "Not found."
+
+
+@pytest.mark.django_db
+def test_package_versions_api_view__returns_versions(
+    api_client: APIClient,
+) -> None:
+    expected = PackageVersionFactory()
+
+    response = api_client.get(
+        f"/api/cyberstorm/versions/{expected.package.namespace}/{expected.package.name}/",
+    )
+    actual = response.json()
+
+    assert len(actual) == 1
+    assert actual[0]["version_number"] == expected.version_number

django/thunderstore/api/cyberstorm/views/__init__.py

@@ -3,6 +3,7 @@
 from .community_list import CommunityListAPIView
 from .markdown import PackageVersionChangelogAPIView, PackageVersionReadmeAPIView
 from .package_detail import PackageDetailAPIView
+from .package_versions import PackageVersionsAPIView
 from .packages import (
     CommunityPackageListAPIView,
     NamespacePackageListAPIView,
@@ -20,6 +21,7 @@
     "PackageDetailAPIView",
     "PackageVersionChangelogAPIView",
     "PackageVersionReadmeAPIView",
+    "PackageVersionsAPIView",
     "TeamDetailAPIView",
     "TeamMembersAPIView",
     "TeamServiceAccountsAPIView",

django/thunderstore/api/cyberstorm/views/package_versions.py

@@ -0,0 +1,30 @@
+from rest_framework import serializers
+from rest_framework.generics import ListAPIView, get_object_or_404
+
+from thunderstore.api.utils import CyberstormAutoSchemaMixin
+from thunderstore.repository.models import Package
+
+
+class CyberstormPackageVersionSerializer(serializers.Serializer):
+    version_number = serializers.CharField()
+    datetime_created = serializers.DateTimeField(source="date_created")
+    download_count = serializers.IntegerField(min_value=0, source="downloads")
+    download_url = serializers.CharField(source="full_download_url")
+    install_url = serializers.CharField()
+
+
+class PackageVersionsAPIView(CyberstormAutoSchemaMixin, ListAPIView):
+    """
+    Return a list of available versions of the package.
+    """
+
+    serializer_class = CyberstormPackageVersionSerializer
+
+    def get_queryset(self):
+        package = get_object_or_404(
+            Package.objects.active(),
+            namespace__name=self.kwargs["namespace_id"],
+            name__iexact=self.kwargs["package_name"],
+        )
+
+        return package.versions.active()

django/thunderstore/api/urls.py

@@ -10,6 +10,7 @@
     PackageDetailAPIView,
     PackageVersionChangelogAPIView,
     PackageVersionReadmeAPIView,
+    PackageVersionsAPIView,
     TeamDetailAPIView,
     TeamMembersAPIView,
     TeamServiceAccountsAPIView,
@@ -89,4 +90,9 @@
         PackageVersionReadmeAPIView.as_view(),
         name="cyberstorm.package-version.readme",
     ),
+    path(
+        "versions/<str:namespace_id>/<str:package_name>/",
+        PackageVersionsAPIView.as_view(),
+        name="cyberstorm.package.versions",
+    ),
 ]