da08357d89
This reverts commit a67b9f70a16a0f16a842aad84754b245a2480b5f, reinstating commit cf78660ed35712f9bb7c112f70411179070d7382. The original commit was reverted because I thought I found bugs in it while verifying it on Stage, but it turns out that it was simply misconfigured Stage data that causing errors. The original commit's message has has been copied below: This commit completes the program_enrollments LMS app Python API for the time being. It does the following: * Add bulk-lookup of users by external key in api/reading.py * Add bulk-writing of program enrollments in api/writing.py * Move grade-reading to api/grades.py * Refactor api/linking.py to use api/writing.py * Refactor signals.py to use api/linking.py * Update rest_api/v1/views.py to utilize all these changes * Update linking management command and support tool to use API * Remove outdated tests from test_models.py * Misc. cleanup EDUCATOR-4321
121 lines
3.9 KiB
Python
121 lines
3.9 KiB
Python
# -*- coding: utf-8 -*-
|
|
"""
|
|
Django model specifications for the Program Enrollments API
|
|
"""
|
|
from __future__ import absolute_import, unicode_literals
|
|
|
|
from django.contrib.auth.models import User
|
|
from django.core.exceptions import ValidationError
|
|
from django.db import models
|
|
from django.utils.translation import ugettext_lazy as _
|
|
from model_utils.models import TimeStampedModel
|
|
from opaque_keys.edx.django.models import CourseKeyField
|
|
from simple_history.models import HistoricalRecords
|
|
|
|
from student.models import CourseEnrollment
|
|
|
|
from .constants import ProgramCourseEnrollmentStatuses, ProgramEnrollmentStatuses
|
|
|
|
|
|
class ProgramEnrollment(TimeStampedModel): # pylint: disable=model-missing-unicode
|
|
"""
|
|
This is a model for Program Enrollments from the registrar service
|
|
|
|
.. pii: PII is found in the external key for a program enrollment
|
|
.. pii_types: other
|
|
.. pii_retirement: local_api
|
|
"""
|
|
STATUS_CHOICES = ProgramEnrollmentStatuses.__MODEL_CHOICES__
|
|
|
|
class Meta(object):
|
|
app_label = "program_enrollments"
|
|
|
|
# A student enrolled in a given (program, curriculum) should always
|
|
# have a non-null ``user`` or ``external_user_key`` field (or both).
|
|
unique_together = (
|
|
('user', 'program_uuid', 'curriculum_uuid'),
|
|
('external_user_key', 'program_uuid', 'curriculum_uuid'),
|
|
)
|
|
|
|
user = models.ForeignKey(
|
|
User,
|
|
null=True,
|
|
blank=True
|
|
)
|
|
external_user_key = models.CharField(
|
|
db_index=True,
|
|
max_length=255,
|
|
null=True
|
|
)
|
|
program_uuid = models.UUIDField(db_index=True, null=False)
|
|
curriculum_uuid = models.UUIDField(db_index=True, null=False)
|
|
status = models.CharField(max_length=9, choices=STATUS_CHOICES)
|
|
historical_records = HistoricalRecords()
|
|
|
|
def clean(self):
|
|
if not (self.user or self.external_user_key):
|
|
raise ValidationError(_('One of user or external_user_key must not be null.'))
|
|
|
|
@classmethod
|
|
def retire_user(cls, user_id):
|
|
"""
|
|
With the parameter user_id, retire the external_user_key field
|
|
|
|
Return True if there is data that was retired
|
|
Return False if there is no matching data
|
|
"""
|
|
|
|
enrollments = cls.objects.filter(user=user_id)
|
|
if not enrollments:
|
|
return False
|
|
|
|
for enrollment in enrollments:
|
|
enrollment.historical_records.update(external_user_key=None)
|
|
|
|
enrollments.update(external_user_key=None)
|
|
return True
|
|
|
|
def __str__(self):
|
|
return '[ProgramEnrollment id={}]'.format(self.id)
|
|
|
|
|
|
class ProgramCourseEnrollment(TimeStampedModel): # pylint: disable=model-missing-unicode
|
|
"""
|
|
This is a model to represent a learner's enrollment in a course
|
|
in the context of a program from the registrar service
|
|
|
|
.. no_pii:
|
|
"""
|
|
STATUS_CHOICES = ProgramCourseEnrollmentStatuses.__MODEL_CHOICES__
|
|
|
|
class Meta(object):
|
|
app_label = "program_enrollments"
|
|
|
|
# For each program enrollment, there may be only one
|
|
# waiting program-course enrollment per course key.
|
|
# This same constraint is implicitly enforced for
|
|
# completed program-course enrollments by the
|
|
# OneToOneField on `course_enrollment`, which mandates that
|
|
# there may be at most one program-course enrollment per
|
|
# (user, course) pair.
|
|
unique_together = (
|
|
('program_enrollment', 'course_key'),
|
|
)
|
|
|
|
program_enrollment = models.ForeignKey(
|
|
ProgramEnrollment,
|
|
on_delete=models.CASCADE,
|
|
related_name="program_course_enrollments"
|
|
)
|
|
course_enrollment = models.OneToOneField(
|
|
CourseEnrollment,
|
|
null=True,
|
|
blank=True,
|
|
)
|
|
course_key = CourseKeyField(max_length=255)
|
|
status = models.CharField(max_length=9, choices=STATUS_CHOICES)
|
|
historical_records = HistoricalRecords()
|
|
|
|
def __str__(self):
|
|
return '[ProgramCourseEnrollment id={}]'.format(self.id)
|