Add golang purl service

packagedb/serializers.py

@@ -414,3 +414,11 @@ class PurlValidateResponseSerializer(Serializer):
 class PurlValidateSerializer(Serializer):
     purl = CharField(required=True)
     check_existence = BooleanField(required=False, default=False)
+
+
+class GoLangPurlSerializer(Serializer):
+    go_package = CharField(required=True)
+
+
+class GoLangPurlResponseSerializer(Serializer):
+    golang_purl = CharField()

packagedb/tests/test_api.py

@@ -1179,3 +1179,11 @@ def test_api_purl_validation_empty_request(self):
         }
 
         self.assertAlmostEquals(expected, response1.data)
+
+
+class ToGolangPurlTestCase(TestCase):
+
+    def test_to_golang_purl(self):
+        response = self.client.get("/api/to_purl/go", data={"go_package": "github.com/gorilla/[email protected]"}, follow=True)
+        expected = "pkg:golang/github.com/gorilla/mux%40v1.7.3"
+        self.assertEqual(expected, response.data["golang_purl"])

packagedb/to_purl.py

@@ -0,0 +1,58 @@
+#
+# Copyright (c) nexB Inc. and others. All rights reserved.
+# purldb is a trademark of nexB Inc.
+# SPDX-License-Identifier: Apache-2.0
+# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
+# See https://github.com/nexB/purldb for support or download.
+# See https://aboutcode.org for more information about nexB OSS projects.
+#
+
+from django.db import router
+from drf_spectacular.utils import OpenApiParameter, extend_schema
+from packageurl.utils import get_golang_purl
+from rest_framework import status
+from rest_framework import viewsets
+from rest_framework.response import Response
+
+from packagedb.serializers import GoLangPurlResponseSerializer
+from packagedb.serializers import GoLangPurlSerializer
+from rest_framework import routers
+
+
+@extend_schema(
+    parameters=[
+        OpenApiParameter("go_package", str, "query", description="go import package"),
+    ],
+    responses={200: GoLangPurlResponseSerializer()},
+)
+class GolangPurlViewSet(viewsets.ViewSet):
+    """
+    Return a ``golang_purl`` from a standard go import string 
+    ``go_package``.
+    """
+
+    serializer_class = GoLangPurlSerializer
+
+    def get_view_name(self):
+        return "GoLang purl"
+
+    def list(self, request):
+        serializer = self.serializer_class(data=request.query_params)
+        response = {}
+
+        if not serializer.is_valid():
+            return Response(
+                {"errors": serializer.errors}, status=status.HTTP_400_BAD_REQUEST
+            )
+
+        validated_data = serializer.validated_data
+        go_import = validated_data.get("go_package")
+        purl = get_golang_purl(go_import)
+        response["golang_purl"] = purl
+        serializer = GoLangPurlResponseSerializer(
+            response, context={"request": request}
+        )
+        return Response(serializer.data)
+
+api_to_purl_router = routers.DefaultRouter()
+api_to_purl_router.register("go", GolangPurlViewSet, "go")

purldb_project/urls.py

@@ -25,6 +25,7 @@
 from matchcode.api import ExactPackageArchiveIndexViewSet
 from minecode.api import PriorityResourceURIViewSet
 from packagedb.api import PurlValidateViewSet
+from packagedb.to_purl import api_to_purl_router
 from packagedb.api import CollectViewSet
 from drf_spectacular.views import SpectacularAPIView
 from drf_spectacular.views import SpectacularSwaggerView
@@ -51,6 +52,7 @@
         TemplateView.as_view(template_name='robots.txt', content_type='text/plain'),
     ),
     path('api/', include((api_router.urls, 'api'))),
+    path('api/to_purl/', include((api_to_purl_router.urls, 'api_to'))),
     path("", RedirectView.as_view(url="api/")),
     path('api/schema/', SpectacularAPIView.as_view(), name='schema'),
     path('api/docs/', SpectacularSwaggerView.as_view(url_name='schema'), name='swagger-ui'),

requirements.txt

@@ -74,7 +74,7 @@ natsort==8.2.0
 normality==2.5.0
 openpyxl==3.1.2
 packagedcode-msitools==0.101.210706
-packageurl-python==0.13.4
+packageurl-python==0.14.0
 packaging==23.2
 packvers==21.5
 parameter-expansion-patched==0.3.1

setup.cfg

@@ -51,7 +51,7 @@ install_requires =
     jawa == 2.2.0
     markdown == 3.5.1
     natsort == 8.2.0
-    packageurl-python == 0.13.4
+    packageurl-python == 0.14.0
     psycopg[binary]==3.1.17
     PyGithub == 1.56
     reppy2 == 0.3.6