Refine the scan_data_as_zip implementation #272

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

Author: tdruez

component_catalog/api.py

@@ -10,6 +10,7 @@
 
 from django.db import transaction
 from django.forms.widgets import HiddenInput
+from django.http import FileResponse
 
 import django_filters
 from packageurl.contrib import url2purl
@@ -30,7 +31,6 @@
 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
@@ -942,8 +942,14 @@ def download_scan_data(self, request, uuid):
 
         project_uuid = scan_infos.get("uuid")
         filename = package.filename or package.package_url_filename
-        filename = f"{filename}_scan.zip"
-        return scan_data_as_zip_response(scancodeio, project_uuid, filename)
+
+        scan_data_as_zip = scancodeio.scan_data_as_zip(project_uuid, filename)
+        return FileResponse(
+            scan_data_as_zip,
+            filename=f"{filename}_scan.zip",
+            as_attachment=True,
+            content_type="application/zip",
+        )
 
     @action(detail=False, methods=["post"], name="Package Add")
     def add(self, request):

component_catalog/views.py

@@ -6,9 +6,7 @@
 # See https://aboutcode.org for more information about AboutCode FOSS projects.
 #
 
-import io
 import json
-import zipfile
 from collections import Counter
 from operator import itemgetter
 from urllib.parse import quote_plus
@@ -1635,27 +1633,6 @@ def component_create_ajax_view(request):
         return HttpResponse(rendered_form)
 
 
-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")
-    scan_summary = scancodeio.fetch_scan_data(scan_summary_url)
-
-    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",
-    )
-
-
 @login_required
 def send_scan_data_as_file_view(request, project_uuid, filename):
     dataspace = request.user.dataspace
@@ -1666,8 +1643,13 @@ def send_scan_data_as_file_view(request, project_uuid, filename):
     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)
+    scan_data_as_zip = scancodeio.scan_data_as_zip(project_uuid, filename)
+    return FileResponse(
+        scan_data_as_zip,
+        filename=f"{filename}_scan.zip",
+        as_attachment=True,
+        content_type="application/zip",
+    )
 
 
 @login_required

dejacode_toolkit/scancodeio.py

@@ -6,7 +6,9 @@
 # See https://aboutcode.org for more information about AboutCode FOSS projects.
 #
 
+import io
 import json
+import zipfile
 from hashlib import md5
 from urllib.parse import quote_plus
 
@@ -262,6 +264,21 @@ def fetch_project_dependencies(self, project_uuid):
         api_url = self.get_scan_action_url(project_uuid, "dependencies")
         return self.fetch_results(api_url)
 
+    def scan_data_as_zip(self, project_uuid, filename):
+        """Return a FileResponse of a package scan data as a zip file."""
+        scan_results_url = self.get_scan_action_url(project_uuid, "results")
+        scan_results = self.fetch_scan_data(scan_results_url)
+        scan_summary_url = self.get_scan_action_url(project_uuid, "summary")
+        scan_summary = self.fetch_scan_data(scan_summary_url)
+
+        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 in_memory_zip
+
     # (label, scan_field, model_field, input_type)
     SCAN_SUMMARY_FIELDS = [
         (