df45fe8317
This data can be used by external frontends or other apps. The list of course enrollments can optionally be filtered by course id or usernames.
117 lines
4.0 KiB
Python
117 lines
4.0 KiB
Python
"""
|
|
Serializers for all Course Enrollment related return objects.
|
|
"""
|
|
import logging
|
|
|
|
from rest_framework import serializers
|
|
|
|
from course_modes.models import CourseMode
|
|
from student.models import CourseEnrollment
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
|
|
class StringListField(serializers.CharField):
|
|
"""Custom Serializer for turning a comma delimited string into a list.
|
|
|
|
This field is designed to take a string such as "1,2,3" and turn it into an actual list
|
|
[1,2,3]
|
|
|
|
"""
|
|
def field_to_native(self, obj, field_name):
|
|
"""
|
|
Serialize the object's class name.
|
|
"""
|
|
if not obj.suggested_prices:
|
|
return []
|
|
|
|
items = obj.suggested_prices.split(',')
|
|
return [int(item) for item in items]
|
|
|
|
|
|
class CourseSerializer(serializers.Serializer): # pylint: disable=abstract-method
|
|
"""
|
|
Serialize a course descriptor and related information.
|
|
"""
|
|
|
|
course_id = serializers.CharField(source="id")
|
|
course_name = serializers.CharField(source="display_name_with_default")
|
|
enrollment_start = serializers.DateTimeField(format=None)
|
|
enrollment_end = serializers.DateTimeField(format=None)
|
|
course_start = serializers.DateTimeField(source="start", format=None)
|
|
course_end = serializers.DateTimeField(source="end", format=None)
|
|
invite_only = serializers.BooleanField(source="invitation_only")
|
|
course_modes = serializers.SerializerMethodField()
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
self.include_expired = kwargs.pop("include_expired", False)
|
|
super(CourseSerializer, self).__init__(*args, **kwargs)
|
|
|
|
def get_course_modes(self, obj):
|
|
"""
|
|
Retrieve course modes associated with the course.
|
|
"""
|
|
course_modes = CourseMode.modes_for_course(
|
|
obj.id,
|
|
include_expired=self.include_expired,
|
|
only_selectable=False
|
|
)
|
|
return [
|
|
ModeSerializer(mode).data
|
|
for mode in course_modes
|
|
]
|
|
|
|
|
|
class CourseEnrollmentSerializer(serializers.ModelSerializer):
|
|
"""Serializes CourseEnrollment models
|
|
|
|
Aggregates all data from the Course Enrollment table, and pulls in the serialization for
|
|
the Course Descriptor and course modes, to give a complete representation of course enrollment.
|
|
|
|
"""
|
|
course_details = CourseSerializer(source="course_overview")
|
|
user = serializers.SerializerMethodField('get_username')
|
|
|
|
def get_username(self, model):
|
|
"""Retrieves the username from the associated model."""
|
|
return model.username
|
|
|
|
class Meta(object):
|
|
model = CourseEnrollment
|
|
fields = ('created', 'mode', 'is_active', 'course_details', 'user')
|
|
lookup_field = 'username'
|
|
|
|
|
|
class CourseEnrollmentsApiListSerializer(CourseEnrollmentSerializer):
|
|
"""
|
|
Serializes CourseEnrollment model and returns a subset of fields returned
|
|
by the CourseEnrollmentSerializer.
|
|
"""
|
|
course_id = serializers.CharField(source='course_overview.id')
|
|
|
|
def __init__(self, *args, **kwargs):
|
|
super(CourseEnrollmentsApiListSerializer, self).__init__(*args, **kwargs)
|
|
self.fields.pop('course_details')
|
|
|
|
class Meta(CourseEnrollmentSerializer.Meta):
|
|
fields = CourseEnrollmentSerializer.Meta.fields + ('course_id', )
|
|
|
|
|
|
class ModeSerializer(serializers.Serializer):
|
|
"""Serializes a course's 'Mode' tuples
|
|
|
|
Returns a serialized representation of the modes available for course enrollment. The course
|
|
modes models are designed to return a tuple instead of the model object itself. This serializer
|
|
does not handle the model object itself, but the tuple.
|
|
|
|
"""
|
|
slug = serializers.CharField(max_length=100)
|
|
name = serializers.CharField(max_length=255)
|
|
min_price = serializers.IntegerField()
|
|
suggested_prices = StringListField(max_length=255)
|
|
currency = serializers.CharField(max_length=8)
|
|
expiration_datetime = serializers.DateTimeField()
|
|
description = serializers.CharField()
|
|
sku = serializers.CharField()
|
|
bulk_sku = serializers.CharField()
|