Clean up API codebase by using idiomatic DRF and removing boilerplate

openverse-api/catalog/api/examples/__init__.py

@@ -19,6 +19,7 @@
     image_detail_curl,
     image_stats_curl,
     report_image_curl,
+    oembed_list_curl,
 )
 from catalog.api.examples.image_responses import (
     image_search_200_example,

openverse-api/catalog/api/examples/image_requests.py

@@ -46,3 +46,8 @@
 # Report an issue about image ID 7c829a03-fb24-4b57-9b03-65f43ed19395
 curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer DLBYIcfnKfolaXKcmMC8RIDCavc2hW" -d '{"reason": "mature", "identifier": "7c829a03-fb24-4b57-9b03-65f43ed19395", "description": "This image contains sensitive content"}' https://api.openverse.engineering/v1/images/7c829a03-fb24-4b57-9b03-65f43ed19395/report
 """  # noqa
+
+oembed_list_curl = """
+# Retrieve embedded content from image URL (https://wordpress.org/openverse/photos/7c829a03-fb24-4b57-9b03-65f43ed19395)
+curl -H "Authorization: Bearer DLBYIcfnKfolaXKcmMC8RIDCavc2hW" https://api.openverse.engineering/v1/oembed/?url=https://wordpress.org/openverse/photos/7c829a03-fb24-4b57-9b03-65f43ed19395
+"""  # noqa

openverse-api/catalog/api/serializers/audio_serializers.py

@@ -188,6 +188,17 @@ def create(self, validated_data):
         return AudioReport.objects.create(**validated_data)
 
 
+class AudioWaveformSerializer(serializers.Serializer):
+    len = serializers.SerializerMethodField()
+    points = serializers.ListField(
+        serializers.FloatField(min_value=0, max_value=1)
+    )
+
+    @staticmethod
+    def get_len(obj):
+        return len(obj.get('points', []))
+
+
 class AboutAudioSerializer(AboutMediaSerializer):
     """
     Used by `AudioStats`.

openverse-api/catalog/api/utils/exceptions.py

@@ -1,4 +1,5 @@
 from rest_framework import status
+from rest_framework.exceptions import APIException
 from rest_framework.response import Response
 """
 Override the presentation of ValidationErrors, which are deeply nested and
@@ -51,3 +52,23 @@ def input_error_response(errors):
             'fields': fields
         }
     )
+
+
+def get_api_exception(error_message, response_code=500, error_code=None):
+    """
+    Returns an instance of a subclass of ``APIException`` with the given error
+    message, error code and response status code.
+
+    The returned object should be used with the ``raise`` keyword.
+
+    :param error_message: the detailed error message shown to the user
+    :param response_code: the HTTP response status code
+    :param error_code: the codename of the error
+    :return: an instance of a subclass of ``APIException``
+    """
+
+    class SubAPIException(APIException):
+        status_code = response_code
+        default_detail = error_message
+        default_code = error_code
+    return SubAPIException()

openverse-api/catalog/urls/audio.py

@@ -16,22 +16,22 @@
         name='audio-stats'
     ),
     path(
-        '<str:identifier>',
+        '<uuid:identifier>',
         AudioDetail.as_view(),
         name='audio-detail'
     ),
     path(
-        '<str:identifier>/thumb',
+        '<uuid:identifier>/thumb',
         AudioArt.as_view(),
         name='audio-thumb'
     ),
     path(
-        '<str:identifier>/recommendations',
+        '<uuid:identifier>/recommendations',
         RelatedAudio.as_view(),
         name='audio-related'
     ),
     path(
-        '<str:identifier>/waveform',
+        '<uuid:identifier>/waveform',
         AudioWaveform.as_view(),
         name='audio-waveform'
     ),

openverse-api/catalog/urls/images.py

@@ -22,22 +22,22 @@
         name='image-oembed'
     ),
     path(
-        '<str:identifier>',
+        '<uuid:identifier>',
         ImageDetail.as_view(),
         name='image-detail'
     ),
     path(
-        '<str:identifier>/thumb',
+        '<uuid:identifier>/thumb',
         ProxiedImage.as_view(),
         name='image-thumb'
     ),
     path(
-        '<str:identifier>/recommendations',
+        '<uuid:identifier>/recommendations',
         RelatedImage.as_view(),
         name='image-related'
     ),
     path(
-        '<str:identifier>/report',
+        '<uuid:identifier>/report',
         ReportImageView.as_view(),
         name='report-image'
     ),