Add button to download health stats PDF (#1756)

* Add API endpoint

* Add frontend button and fetch method

* Fix spelling

* Add metrics route

* Update tests

* Remove old urls.py

* Update code

* Dynamically generated file

* Update code

* Update tests

* Update with views

Signed-off-by: Ahmed Gouda <[email protected]>

* Add require GET

* Update REST

* Update code

* Apply suggestions

* Update code

---------

Signed-off-by: Ahmed Gouda <[email protected]>
Co-authored-by: Arkadii Yakovets <[email protected]>
Co-authored-by: Arkadii Yakovets <[email protected]>

Author: ahmedxgouda

CONTRIBUTING.md

@@ -39,9 +39,9 @@ Before contributing, ensure you have the following installed:
 
 #### `NEXT_PUBLIC_API_URL`
 
-- **Description**: The base URL for the application's REST API.
-- **Example Value**: `https://nest.owasp.org/api/`
-- **Usage**: Used by frontend components to make REST API calls.
+- **Description**: The base URL for the application's internal API.
+- **Example Value**: `https://nest.owasp.org/`
+- **Usage**: Used by frontend components to make API calls.
 
 #### `NEXT_PUBLIC_CSRF_URL`
 

backend/apps/owasp/api/internal/views/__init__.py

@@ -0,0 +1,16 @@
+"""Views for OWASP project health metrics."""
+
+from django.http import FileResponse
+from django.views.decorators.http import require_GET
+
+from apps.owasp.utils.pdf import generate_metrics_overview_pdf
+
+
+@require_GET
+def generate_overview_pdf(_request):
+    """Generate a PDF overview of OWASP project health metrics."""
+    return FileResponse(
+        generate_metrics_overview_pdf(),
+        as_attachment=True,
+        filename="owasp_project_health_metrics_overview.pdf",
+    )

backend/apps/owasp/api/internal/views/project_health_metrics.py

@@ -0,0 +1,13 @@
+"""URLs for OWASP project health metrics."""
+
+from django.urls import path
+
+from apps.owasp.api.internal.views.project_health_metrics import generate_overview_pdf
+
+urlpatterns = [
+    path(
+        "project-health-metrics/overview/pdf/",
+        generate_overview_pdf,
+        name="project_health_metrics_overview_pdf",
+    ),
+]

backend/apps/owasp/api/internal/views/urls.py

@@ -0,0 +1,77 @@
+"""PDF generation for OWASP project health metrics."""
+
+from io import BytesIO
+
+from django.utils import timezone
+from reportlab.pdfgen.canvas import Canvas
+from reportlab.platypus import Table, TableStyle
+
+from apps.owasp.models.project_health_metrics import ProjectHealthMetrics
+
+
+def generate_metrics_overview_pdf() -> BytesIO:
+    """Generate a PDF overview of project health metrics.
+
+    Returns:
+        BytesIO: PDF content as bytes.
+
+    """
+    metrics_stats = ProjectHealthMetrics.get_stats()
+
+    buffer = BytesIO()
+    canvas = Canvas(buffer)
+    canvas.setFont("Helvetica", 12)
+    canvas.setTitle("OWASP Project Health Metrics Overview")
+    canvas.drawCentredString(300, 800, "OWASP Project Health Metrics Overview")
+
+    table_data = (
+        ("Metric", "Value"),
+        ("Healthy Projects", f"{metrics_stats.projects_count_healthy}"),
+        ("Unhealthy Projects", f"{metrics_stats.projects_count_unhealthy}"),
+        ("Need Attention Projects", f"{metrics_stats.projects_count_need_attention}"),
+        (
+            "Average Score",
+            f"{metrics_stats.average_score:.2f}"
+            if metrics_stats.average_score is not None
+            else "N/A",
+        ),
+        ("Total Contributors", f"{metrics_stats.total_contributors:,}"),
+        ("Total Forks", f"{metrics_stats.total_forks:,}"),
+        ("Total Stars", f"{metrics_stats.total_stars:,}"),
+        (
+            "Healthy Projects Percentage",
+            f"{metrics_stats.projects_percentage_healthy:.2f}%",
+        ),
+        (
+            "Need Attention Projects Percentage",
+            f"{metrics_stats.projects_percentage_need_attention:.2f}%",
+        ),
+        (
+            "Unhealthy Projects Percentage",
+            f"{metrics_stats.projects_percentage_unhealthy:.2f}%",
+        ),
+    )
+
+    table = Table(
+        table_data,
+        colWidths="*",
+        style=TableStyle(
+            (
+                ("BACKGROUND", (0, 0), (-1, 0), "lightgrey"),
+                ("TEXTCOLOR", (0, 0), (-1, 0), "black"),
+                ("ALIGN", (0, 0), (-1, -1), "CENTER"),
+                ("FONTNAME", (0, 0), (-1, 0), "Helvetica-Bold"),
+                ("BOTTOMPADDING", (0, 0), (-1, 0), 5),
+                ("BACKGROUND", (0, 1), (-1, -1), "white"),
+            )
+        ),
+    )
+    table.wrapOn(canvas, 400, 600)
+    table.drawOn(canvas, 100, 570)
+    canvas.drawCentredString(
+        300, 100, f"Generated on: {timezone.now().strftime('%Y-%m-%d %H:%M:%S')}"
+    )
+    canvas.showPage()
+    canvas.save()
+    buffer.seek(0)
+    return buffer

backend/apps/owasp/management/commands/owasp_generate_project_health_metrics_overview_pdf.py

@@ -14,6 +14,7 @@
 from apps.core.api.internal.algolia import algolia_search
 from apps.core.api.internal.csrf import get_csrf_token
 from apps.core.api.internal.status import get_status
+from apps.owasp.api.internal.views.urls import urlpatterns as owasp_urls
 from apps.slack.apps import SlackConfig
 from settings.api.v1 import api as api_v1
 from settings.graphql import schema
@@ -24,6 +25,7 @@
     path("graphql/", csrf_protect(GraphQLView.as_view(schema=schema, graphiql=settings.DEBUG))),
     path("api/v1/", api_v1.urls),
     path("a/", admin.site.urls),
+    path("owasp/", include(owasp_urls)),
     path("status/", get_status),
     path("", include("apps.sitemap.urls")),
 ]