b555c869bf
- added the abstract and concrete layers of enrollment report provider - created a celery task. -added the button in the e-commerce reports section added the enrollment data backend added the payment data and start writing the test cases. updated the code with the feedback suggestions and wrote some test cases. - all the downloadable reports are now visible in the ecommerce download section. Pending instructor tasks is also visible in the ecommerce section added the fields in the user profile information changed the report store configuration key added the new http endpoint for financial reports to add more permissions for finance_admin to access. fix quality issues added test cases to check csv content data rebased with master and resolved conflicts changed the log messages added the changes as per code clintonb suggestions during code review updated the test cases for the finance_admin decorator changes suggested by clinton. Created and moved Table level filters to the Custom Manager for the CourseEnrollment model. ecommerce.js file was loaded twice in the instructor_dashboard.js fixed the issues added the registration code column in the csv added the full gender in the csv file Update data sources and add display name translations for the report columns fix meta name Make sure the reports section does not appear on non whitelabel courses pylint fixes expand out enumerated values
99 lines
3.2 KiB
Python
99 lines
3.2 KiB
Python
"""
|
|
Defines abstract class for the Enrollment Reports.
|
|
"""
|
|
|
|
from django.contrib.auth.models import User
|
|
from student.models import UserProfile
|
|
import collections
|
|
import json
|
|
import abc
|
|
|
|
|
|
class AbstractEnrollmentReportProvider(object):
|
|
"""
|
|
Abstract interface for Detailed Enrollment Report Provider
|
|
"""
|
|
__metaclass__ = abc.ABCMeta
|
|
|
|
@abc.abstractmethod
|
|
def get_enrollment_info(self, user, course_id):
|
|
"""
|
|
Returns the User Enrollment information.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def get_user_profile(self, user_id):
|
|
"""
|
|
Returns the UserProfile information.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
@abc.abstractmethod
|
|
def get_payment_info(self, user, course_id):
|
|
"""
|
|
Returns the User Payment information.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
|
|
class BaseAbstractEnrollmentReportProvider(AbstractEnrollmentReportProvider):
|
|
"""
|
|
The base abstract class for all Enrollment Reports that can support multiple
|
|
backend such as MySQL/Django-ORM.
|
|
|
|
# don't allow instantiation of this class, it must be subclassed
|
|
"""
|
|
def get_user_profile(self, user_id):
|
|
"""
|
|
Returns the UserProfile information.
|
|
"""
|
|
user_info = User.objects.select_related('profile').get(id=user_id)
|
|
# extended user profile fields are stored in the user_profile meta column
|
|
meta = {}
|
|
if user_info.profile.meta:
|
|
meta = json.loads(user_info.profile.meta)
|
|
|
|
user_data = collections.OrderedDict()
|
|
user_data['User ID'] = user_info.id
|
|
user_data['Username'] = user_info.username
|
|
user_data['Full Name'] = user_info.profile.name
|
|
user_data['First Name'] = meta.get('first-name', '')
|
|
user_data['Last Name'] = meta.get('last-name', '')
|
|
user_data['Company Name'] = meta.get('company', '')
|
|
user_data['Title'] = meta.get('title', '')
|
|
user_data['Language'] = user_info.profile.language
|
|
user_data['Country'] = user_info.profile.country
|
|
user_data['Year of Birth'] = user_info.profile.year_of_birth
|
|
|
|
user_data['Gender'] = None
|
|
gender = user_info.profile.gender
|
|
for _gender in UserProfile.GENDER_CHOICES:
|
|
if gender == _gender[0]:
|
|
user_data['Gender'] = _gender[1]
|
|
break
|
|
|
|
user_data['Level of Education'] = None
|
|
level_of_education = user_info.profile.level_of_education
|
|
for _loe in UserProfile.LEVEL_OF_EDUCATION_CHOICES:
|
|
if level_of_education == _loe[0]:
|
|
user_data['Level of Education'] = _loe[1]
|
|
|
|
user_data['Mailing Address'] = user_info.profile.mailing_address
|
|
user_data['Goals'] = user_info.profile.goals
|
|
user_data['City'] = user_info.profile.city
|
|
user_data['Country'] = user_info.profile.country
|
|
return user_data
|
|
|
|
def get_enrollment_info(self, user, course_id):
|
|
"""
|
|
Returns the User Enrollment information.
|
|
"""
|
|
raise NotImplementedError()
|
|
|
|
def get_payment_info(self, user, course_id):
|
|
"""
|
|
Returns the User Payment information.
|
|
"""
|
|
raise NotImplementedError()
|