feat(events): add image's license_url to api

Displays image's license url in the api.

Refs LINK-2241

Author: nicobav

events/serializers.py

@@ -4,6 +4,7 @@
 import urllib
 from copy import deepcopy
 from datetime import timedelta
+from typing import Optional
 from zoneinfo import ZoneInfo
 
 from django.conf import settings
@@ -207,6 +208,7 @@ class ImageSerializer(EditableLinkedEventsObjectSerializer):
     license = serializers.PrimaryKeyRelatedField(
         queryset=License.objects.all(), required=False
     )
+    license_url = serializers.SerializerMethodField()
     created_time = DateTimeField(
         default_timezone=ZoneInfo("UTC"), required=False, allow_null=True
     )
@@ -220,6 +222,10 @@ class Meta:
         model = Image
         fields = "__all__"
 
+    @extend_schema_field(Optional[str])
+    def get_license_url(self, obj):
+        return obj.license.url if obj.license else None
+
     def to_representation(self, obj):
         # the url field is customized based on image and url
         representation = super().to_representation(obj)

events/tests/test_api.py

@@ -15,7 +15,7 @@
 
 from ..api import EventSerializer, OrganizationListSerializer, _terms_to_regex
 from ..auth import ApiKeyAuth
-from ..models import DataSource, Image
+from ..models import DataSource, Image, License
 from ..utils import get_user_data_source_and_organization_from_request
 from .utils import versioned_reverse as reverse
 
@@ -317,12 +317,17 @@ def setUp(self):
             origin_id="org-3",
             data_source=self.data_source,
         )
+        img_license = License.objects.create(
+            name="Test license",
+            url="http://urltothe.license",
+        )
         self.image_1 = Image.objects.create(
             name="image-1",
             data_source=self.data_source,
             publisher=self.org_1,
             url="http://fake.url/image-1/",
             alt_text="Lorem",
+            license=img_license,
         )
         self.image_2 = Image.objects.create(
             name="image-2",
@@ -365,6 +370,15 @@ def test_get_image_alt_text(self):
         alt_text = response.data["alt_text"]
         self.assertEqual(alt_text, "Lorem")
 
+    def test_get_image_license_url(self):
+        url = reverse("image-detail", kwargs={"pk": self.image_1.id})
+
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        license_url = response.data["license_url"]
+        self.assertEqual(license_url, "http://urltothe.license")
+
     def test_text_search_by_image_alt_text(self):
         url = "{0}?text=lorem".format(reverse("image-list"))
 

events/tests/test_event_get.py

@@ -16,7 +16,7 @@
 from rest_framework import status
 
 from audit_log.models import AuditLogEntry
-from events.models import Event, Language, PublicationStatus
+from events.models import Event, Language, License, PublicationStatus
 from events.tests.conftest import APIClient
 from events.tests.factories import EventFactory, OfferFactory
 from events.tests.utils import (
@@ -1948,6 +1948,21 @@ def test_get_event_with_offer_and_offer_price_groups(api_client, event):
     )
 
 
+@pytest.mark.django_db
+def test_event_list_shows_image_and_its_license(event, image):
+    event.images.add(image)
+    img_license = License.objects.create(
+        name="Test license",
+        url="http://urltothe.license",
+    )
+    image.license = img_license
+    image.save()
+
+    response = get_list(api_client)
+    license_url = response.data["data"][0]["images"][0]["license_url"]
+    assert license_url == "http://urltothe.license"
+
+
 class FilterEventsByRegistrationCapacitiesV1TestCase(TestCase, EventsListTestCaseMixin):
     @classmethod
     def setUpTestData(cls):

events/tests/test_event_images_v1.py

@@ -69,6 +69,7 @@ def assert_image_fields_exist(data, version="v1"):
         "photographer_name",
         "data_source",
         "alt_text",
+        "license_url",
     )
 
     assert_fields_exist(data, fields)