def proxied_get(self, *args, **kwargs):
"""
Perform the query and returns a single object matching the given keyword arguments.
This customizes the queryset to return an instance of ``ProxyDataSharingConsent`` when
the searched-for ``DataSharingConsent`` instance does not exist.
"""
original_kwargs = kwargs.copy()
if 'course_id' in kwargs:
try:
# Check if we have a course ID or a course run ID
course_run_key = str(CourseKey.from_string(
kwargs['course_id']))
except InvalidKeyError:
# The ID we have is for a course instead of a course run; fall through
# to the second check.
pass
else:
try:
# Try to get the record for the course run specifically
return self.get(*args, **kwargs)
except DataSharingConsent.DoesNotExist:
# A record for the course run didn't exist, so modify the query
# parameters to look for just a course record on the second pass.
kwargs['course_id'] = parse_course_key(course_run_key)
try:
return self.get(*args, **kwargs)
except DataSharingConsent.DoesNotExist:
return ProxyDataSharingConsent(**original_kwargs)
def get_course_and_course_run(self, course_run_id):
"""
Return the course and course run metadata for the given course run ID.
Arguments:
course_run_id (str): The course run ID.
Returns:
tuple: The course metadata and the course run metadata.
"""
# Parse the course ID from the course run ID.
course_id = parse_course_key(course_run_id)
# Retrieve the course metadata from the catalog service.
course = self.get_course_details(course_id)
course_run = None
if course:
# Find the specified course run.
course_run = None
course_runs = [
course_run for course_run in course['course_runs']
if course_run['key'] == course_run_id
]
if course_runs:
course_run = course_runs[0]
return course, course_run
def get_learner_data_records(self,
enterprise_enrollment,
completed_date=None,
grade=None,
is_passing=False):
"""
Return a SapSuccessFactorsLearnerDataTransmissionAudit with the given enrollment and course completion data.
If completed_date is None and the learner isn't passing, then course completion has not been met.
If no remote ID can be found, return None.
"""
completed_timestamp = None
course_completed = False
if completed_date is not None:
completed_timestamp = parse_datetime_to_epoch_millis(
completed_date)
course_completed = is_passing
sapsf_user_id = enterprise_enrollment.enterprise_customer_user.get_remote_id(
)
if sapsf_user_id is not None:
SapSuccessFactorsLearnerDataTransmissionAudit = apps.get_model( # pylint: disable=invalid-name
'sap_success_factors',
'SapSuccessFactorsLearnerDataTransmissionAudit')
# We return two records here, one with the course key and one with the course run id, to account for
# uncertainty about the type of content (course vs. course run) that was sent to the integrated channel.
return [
SapSuccessFactorsLearnerDataTransmissionAudit(
enterprise_course_enrollment_id=enterprise_enrollment.id,
sapsf_user_id=sapsf_user_id,
course_id=parse_course_key(
enterprise_enrollment.course_id),
course_completed=course_completed,
completed_timestamp=completed_timestamp,
grade=grade,
),
SapSuccessFactorsLearnerDataTransmissionAudit(
enterprise_course_enrollment_id=enterprise_enrollment.id,
sapsf_user_id=sapsf_user_id,
course_id=enterprise_enrollment.course_id,
course_completed=course_completed,
completed_timestamp=completed_timestamp,
grade=grade,
),
]
else:
LOGGER.debug(
'No learner data was sent for user [%s] because an SAP SuccessFactors user ID could not be found.',
enterprise_enrollment.enterprise_customer_user.username)
def get_learner_data_records(self,
enterprise_enrollment,
completed_date=None,
is_passing=False,
**kwargs): # pylint: disable=arguments-differ,unused-argument
"""
Return a DegreedLearnerDataTransmissionAudit with the given enrollment and course completion data.
If completed_date is None, then course completion has not been met.
If no remote ID can be found, return None.
"""
# Degreed expects completion dates of the form 'yyyy-mm-dd'.
completed_timestamp = completed_date.strftime("%F") if isinstance(
completed_date, datetime) else None
if enterprise_enrollment.enterprise_customer_user.get_remote_id(
) is not None:
DegreedLearnerDataTransmissionAudit = apps.get_model( # pylint: disable=invalid-name
'degreed', 'DegreedLearnerDataTransmissionAudit')
# We return two records here, one with the course key and one with the course run id, to account for
# uncertainty about the type of content (course vs. course run) that was sent to the integrated channel.
return [
DegreedLearnerDataTransmissionAudit(
enterprise_course_enrollment_id=enterprise_enrollment.id,
degreed_user_email=enterprise_enrollment.
enterprise_customer_user.user_email,
course_id=parse_course_key(
enterprise_enrollment.course_id),
course_completed=completed_date is not None and is_passing,
completed_timestamp=completed_timestamp,
),
DegreedLearnerDataTransmissionAudit(
enterprise_course_enrollment_id=enterprise_enrollment.id,
degreed_user_email=enterprise_enrollment.
enterprise_customer_user.user_email,
course_id=enterprise_enrollment.course_id,
course_completed=completed_date is not None and is_passing,
completed_timestamp=completed_timestamp,
)
]
else:
LOGGER.debug(
'No learner data was sent for user [%s] because a Degreed user ID could not be found.',
enterprise_enrollment.enterprise_customer_user.username)