Create a json output version of the open calls on the front page. (#4554)

Fixes #4555

Useful if an organisation wants to list the open calls on their web
site.

Author: frjo

docs/references/open-calls-api-json.md

@@ -0,0 +1,17 @@
+# Open calls API endpoint
+
+At `/api/v2/open-calls.json` that same lists and order of open calls that appear on the front page are available in JSON format.
+
+```json
+[
+    {
+        "description": "The application description if any.",
+        "image": "/path/to/application/image.jpeg",
+        "next_deadline": "1970-01-01",
+        "title": "Title of the application",
+        "weight": 1
+    }
+]
+```
+
+This should make it easy to add a list of open calls to the organisations main web site.

hypha/api/__init__.py

@@ -0,0 +1,9 @@
+from django.urls import include, path
+
+from .v2 import urls as v2_urls
+
+app_name = "api"
+
+urlpatterns = [
+    path("v2/", include(v2_urls)),
+]

hypha/api/urls.py

@@ -0,0 +1,9 @@
+from django.urls import path
+
+from .views import open_calls_json
+
+app_name = "v2"
+
+urlpatterns = [
+    path("open-calls.json", open_calls_json),
+]

hypha/api/v2/__init__.py

@@ -0,0 +1,24 @@
+from django.conf import settings
+from django.http import JsonResponse
+from django_ratelimit.decorators import ratelimit
+
+from hypha.apply.funds.models import ApplicationBase, LabBase
+
+
+@ratelimit(key="ip", rate=settings.DEFAULT_RATE_LIMIT)
+def open_calls_json(request):
+    """Open calls in JSON format.
+
+    List open calls in JSON format, useful when you want to list open calls on an external site.
+    """
+    rounds = ApplicationBase.objects.order_by_end_date().specific()
+    labs = LabBase.objects.public().live().specific()
+    all_funds = list(rounds) + list(labs)
+
+    # Only pass rounds/labs that are open & visible for the front page
+    data = [
+        fund.as_json
+        for fund in all_funds
+        if fund.open_round and fund.list_on_front_page
+    ]
+    return JsonResponse(data, safe=False)

hypha/api/v2/urls.py

@@ -1,6 +1,7 @@
 from datetime import date
 from typing import Optional
 
+import nh3
 from django import forms
 from django.conf import settings
 from django.contrib.postgres.fields import ArrayField
@@ -73,10 +74,40 @@ def order_by_end_date(self):
         return qs.order_by("end_date")
 
 
+class AsJsonMixin:
+    @cached_property
+    def as_json(self):
+        # Clean the strings in title and description.
+        title = nh3.clean(self.title, tags=set())
+        description = nh3.clean(self.description, tags=set())
+        # If image exist scale it down and convert to webp.
+        image = (
+            self.image.get_rendition("max-1200x1200|format-webp|webpquality-60").url
+            if self.image
+            else ""
+        )
+        # Make sure weight is an int.
+        weight = int(self.weight)
+        # If next deadline exist and is set to show, format it as standard iso date.
+        try:
+            next_deadline = (
+                self.next_deadline().isoformat() if self.show_deadline else ""
+            )
+        except AttributeError:
+            next_deadline = ""
+        return {
+            "title": title,
+            "description": description,
+            "image": image,
+            "weight": weight,
+            "next_deadline": next_deadline,
+        }
+
+
 @method_decorator(
     ratelimit(key="ip", rate=settings.DEFAULT_RATE_LIMIT, method="POST"), name="serve"
 )
-class ApplicationBase(EmailForm, WorkflowStreamForm):  # type: ignore
+class ApplicationBase(EmailForm, WorkflowStreamForm, AsJsonMixin):  # type: ignore
     is_creatable = False
 
     # Adds validation around forms & workflows. Isn't on Workflow class due to not displaying workflow field on Round
@@ -555,7 +586,7 @@ def serve(self, request, *args, **kwargs):
 @method_decorator(
     ratelimit(key="ip", rate=settings.DEFAULT_RATE_LIMIT, method="POST"), name="serve"
 )
-class LabBase(EmailForm, WorkflowStreamForm, SubmittableStreamForm):  # type: ignore
+class LabBase(EmailForm, WorkflowStreamForm, SubmittableStreamForm, AsJsonMixin):  # type: ignore
     is_creatable = False
     submission_class = ApplicationSubmission
 

hypha/api/v2/views.py

@@ -17,10 +17,13 @@
 from hypha.apply.utils.views import custom_wagtail_page_delete
 from hypha.home.views import home
 
+from .api import urls as api_urls
+
 urlpatterns = [
     path("", home, name="home"),
     path("apply/", include("hypha.apply.funds.urls", "apply")),
     path("activity/", include("hypha.apply.activity.urls", "activity")),
+    path("api/", include(api_urls)),
     path("todo/", include("hypha.apply.todo.urls", "todo")),
     path("django-admin/", admin.site.urls),
     path(