edx-platform/lms/djangoapps/learner_recommendations/serializers.py

"""
Serializers for learner recommendations APIs.
"""
from rest_framework import serializers


class ActiveCourseRunSerializer(serializers.Serializer):
    """Serializer for active course run for course about page recommendations API"""
    key = serializers.CharField()
    marketingUrl = serializers.URLField(source="marketing_url")


class CourseOwnersSerializer(serializers.Serializer):
    """Serializer for course owners for course about page recommendations API"""
    key = serializers.CharField()
    name = serializers.CharField()
    logoImageUrl = serializers.URLField(source="logo_image_url")


class CourseImageSerializer(serializers.Serializer):
    """Serializer for course image for course about page recommendations API"""
    src = serializers.URLField()


class RecommendedCourseSerializer(serializers.Serializer):
    """Serializer for a recommended course from the recommendation engine"""
    key = serializers.CharField()
    uuid = serializers.UUIDField()
    title = serializers.CharField()
    image = CourseImageSerializer()
    prospectusPath = serializers.SerializerMethodField()
    owners = serializers.ListField(
        child=CourseOwnersSerializer(), allow_empty=True
    )
    activeCourseRun = ActiveCourseRunSerializer(source="active_course_run")

    def get_prospectusPath(self, instance):
        url_slug = instance.get("url_slug")
        return f"course/{url_slug}"


class AboutPageProductRecommendationsSerializer(serializers.Serializer):
    """Serializer for a cross product recommended course for the course about page"""
    key = serializers.CharField()
    uuid = serializers.UUIDField()
    title = serializers.CharField()
    image = CourseImageSerializer()
    prospectusPath = serializers.SerializerMethodField()
    owners = serializers.ListField(
        child=CourseOwnersSerializer(), allow_empty=True
    )
    activeCourseRun = ActiveCourseRunSerializer(source="active_course_run")
    courseType = serializers.CharField(source="course_type")

    def get_prospectusPath(self, instance):
        url_slug = instance.get("url_slug")
        return f"course/{url_slug}"


class LearnerDashboardProductRecommendationsSerializer(serializers.Serializer):
    """Serializer for product recommendations for the Learner Dashboard"""
    title = serializers.CharField()
    image = CourseImageSerializer()
    prospectusPath = serializers.SerializerMethodField()
    owners = serializers.ListField(
        child=CourseOwnersSerializer(), allow_empty=True
    )
    courseType = serializers.CharField(source="course_type")

    def get_prospectusPath(self, instance):
        url_slug = instance.get("url_slug")
        return f"course/{url_slug}"


class AboutPageRecommendationsSerializer(serializers.Serializer):
    """Recommended courses for course about page"""

    courses = serializers.ListField(
        child=RecommendedCourseSerializer(), allow_empty=True
    )
    isControl = serializers.BooleanField(
        source="is_control",
        default=None
    )


class CrossProductRecommendationsSerializer(serializers.Serializer):
    """
    Cross product recommendation courses for course about page
    """
    courses = serializers.ListField(
        child=AboutPageProductRecommendationsSerializer(), allow_empty=True
    )


class CrossProductAndAmplitudeRecommendationsSerializer(serializers.Serializer):
    """
    Cross product recommendation courses and
    Amplitude recommendations for Learner Dashboard
    """
    crossProductCourses = serializers.ListField(
        child=LearnerDashboardProductRecommendationsSerializer(), allow_empty=True
    )
    amplitudeCourses = serializers.ListField(
        child=LearnerDashboardProductRecommendationsSerializer(), allow_empty=True
    )


class CourseSerializer(serializers.Serializer):
    """Serializer for a recommended course from the recommendation engine"""

    courseKey = serializers.CharField(source="course_key")
    logoImageUrl = serializers.URLField(source="logo_image_url")
    marketingUrl = serializers.URLField(source="marketing_url")
    title = serializers.CharField()


class DashboardRecommendationsSerializer(serializers.Serializer):
    """Recommended courses for learner dashboard"""

    courses = serializers.ListField(
        child=CourseSerializer(), allow_empty=True
    )
    isControl = serializers.BooleanField(
        source="is_control",
        default=None
    )