Refactor duplicate code #272

Signed-off-by: tdruez <tdruez@nexb.com>

Author: tdruez

component_catalog/api.py

@@ -15,6 +15,7 @@
 from packageurl.contrib import url2purl
 from packageurl.contrib.django.filters import PackageURLFilter
 from rest_framework import serializers
+from rest_framework import status
 from rest_framework.decorators import action
 from rest_framework.fields import ListField
 from rest_framework.response import Response
@@ -29,6 +30,7 @@
 from component_catalog.models import ComponentKeyword
 from component_catalog.models import Package
 from component_catalog.models import Subcomponent
+from component_catalog.views import scan_data_as_zip_response
 from dejacode_toolkit.download import DataCollectionException
 from dejacode_toolkit.download import collect_package_data
 from dejacode_toolkit.scancodeio import ScanCodeIO
@@ -919,18 +921,9 @@ def about(self, request, uuid):
         package = self.get_object()
         return Response({"about_data": package.as_about_yaml()})
 
-    # TODO: Remove duplication with send_scan_data_as_file_view
     @action(detail=True)
     def download_scan_data(self, request, uuid):
-        import io
-        import json
-        import zipfile
-
-        from django.http import FileResponse
-
-        from rest_framework import status
-        from rest_framework.response import Response
-
+        """Download package scan data: results and sumary, as a zip file."""
         package = self.get_object()
         dataspace = request.user.dataspace
 
@@ -948,25 +941,9 @@ def download_scan_data(self, request, uuid):
             return Response(message, status=status.HTTP_400_BAD_REQUEST)
 
         project_uuid = scan_infos.get("uuid")
-
-        scan_results_url = scancodeio.get_scan_action_url(project_uuid, "results")
-        scan_results = scancodeio.fetch_scan_data(scan_results_url)
-        scan_summary_url = scancodeio.get_scan_action_url(project_uuid, "summary")
-        scan_summary = scancodeio.fetch_scan_data(scan_summary_url)
-
         filename = package.filename or package.package_url_filename
-        in_memory_zip = io.BytesIO()
-        with zipfile.ZipFile(in_memory_zip, "a", zipfile.ZIP_DEFLATED, False) as zipf:
-            zipf.writestr(f"{filename}_scan.json", json.dumps(scan_results, indent=2))
-            zipf.writestr(f"{filename}_summary.json", json.dumps(scan_summary, indent=2))
-        in_memory_zip.seek(0)
-
-        return FileResponse(
-            in_memory_zip,
-            filename=filename,
-            as_attachment=True,
-            content_type="application/zip",
-        )
+        filename = f"{filename}_scan.zip"
+        return scan_data_as_zip_response(scancodeio, project_uuid, filename)
 
     @action(detail=False, methods=["post"], name="Package Add")
     def add(self, request):

component_catalog/tests/test_api.py

@@ -1507,7 +1507,9 @@ def test_api_package_viewset_download_scan_data_action(
         response = self.client.get(scan_data_url)
         self.assertEqual(200, response.status_code)
         self.assertEqual("application/zip", response["content-type"])
-        self.assertEqual('attachment; filename="package1.zip"', response["content-disposition"])
+        self.assertEqual(
+            'attachment; filename="package1.zip_scan.zip"', response["content-disposition"]
+        )
 
     def test_api_package_protected_fields_as_read_only(self):
         policy = UsagePolicy.objects.create(

component_catalog/views.py

@@ -1635,16 +1635,8 @@ def component_create_ajax_view(request):
         return HttpResponse(rendered_form)
 
 
-@login_required
-def send_scan_data_as_file_view(request, project_uuid, filename):
-    dataspace = request.user.dataspace
-    if not dataspace.enable_package_scanning:
-        raise Http404
-
-    scancodeio = ScanCodeIO(dataspace)
-    if not scancodeio.is_available():
-        raise Http404("The ScanCode.io service is not available")
-
+def scan_data_as_zip_response(scancodeio, project_uuid, filename):
+    """Return a FileResponse of a package scan data (results, summary) as a zip file."""
     scan_results_url = scancodeio.get_scan_action_url(project_uuid, "results")
     scan_results = scancodeio.fetch_scan_data(scan_results_url)
     scan_summary_url = scancodeio.get_scan_action_url(project_uuid, "summary")
@@ -1654,11 +1646,28 @@ def send_scan_data_as_file_view(request, project_uuid, filename):
     with zipfile.ZipFile(in_memory_zip, "a", zipfile.ZIP_DEFLATED, False) as zipf:
         zipf.writestr(f"{filename}_scan.json", json.dumps(scan_results, indent=2))
         zipf.writestr(f"{filename}_summary.json", json.dumps(scan_summary, indent=2))
-
     in_memory_zip.seek(0)
-    response = FileResponse(in_memory_zip, content_type="application/zip")
-    response["Content-Disposition"] = f'attachment; filename="{filename}_scan.zip"'
-    return response
+
+    return FileResponse(
+        in_memory_zip,
+        filename=filename,
+        as_attachment=True,
+        content_type="application/zip",
+    )
+
+
+@login_required
+def send_scan_data_as_file_view(request, project_uuid, filename):
+    dataspace = request.user.dataspace
+    if not dataspace.enable_package_scanning:
+        raise Http404
+
+    scancodeio = ScanCodeIO(dataspace)
+    if not scancodeio.is_available():
+        raise Http404("The ScanCode.io service is not available")
+
+    filename = f"{filename}_scan.zip"
+    return scan_data_as_zip_response(scancodeio, project_uuid, filename)
 
 
 @login_required