Skip to content

feat: toggle cert enablement for courses #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat: toggle cert enablement for courses #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d6b675a
feat: toggle cert enablement for courses
arora-r Aug 7, 2025
74e5e70
add explicit audit mode to be able to switch between audit and honor …
arora-r Aug 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion edx_courses_api/urls.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
from django.conf import settings
from django.conf.urls import url

from .views import CourseView, hide, show, export, export_output, export_status, xblock_handler, xblock_item_handler
from .views import CourseView, hide, show, export, export_output, export_status, xblock_handler, xblock_item_handler, set_certificate_settings

urlpatterns = [
url(r'^{}/$'.format(settings.COURSE_KEY_PATTERN), CourseView.as_view(), name='course'),
Expand All @@ -19,6 +19,7 @@
url(r'^{}/export/$'.format(settings.COURSE_KEY_PATTERN), export, name='export'),
url(r'^{}/export_status/$'.format(settings.COURSE_KEY_PATTERN), export_status, name='export_status'),
url(r'^{}/export_output/$'.format(settings.COURSE_KEY_PATTERN), export_output, name='export_output'),
url(r'^{}/certificate/settings/$'.format(settings.COURSE_KEY_PATTERN), set_certificate_settings, name='set_certificate_settings'),
]

# Since urls.py is executed once, create service user here for server to server auth
Expand Down
56 changes: 50 additions & 6 deletions edx_courses_api/views.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
from django.core.files.storage import FileSystemStorage

# edx imports
from openedx.core.djangoapps.content.course_overviews.models import CourseOverview
from openedx.core.djangoapps.content.course_modes.models import CourseMode
from cms.djangoapps.contentstore.views.course import create_new_course_in_store
from cms.djangoapps.contentstore.utils import delete_course
from xmodule.modulestore.exceptions import DuplicateCourseError
Expand Down Expand Up @@ -55,6 +55,9 @@ class CourseView(APIView):
authentication_classes = [BasicAuthentication]
permission_classes = [IsAuthenticated]

def str_to_bool(self, val):
return str(val).lower() == 'true'

def delete(self, request, course_key_string):
course_key = CourseKey.from_string(course_key_string)
log.info('DELETING {}'.format(course_key))
Expand All @@ -67,7 +70,11 @@ def post(self, request, course_key_string):
try:
user = User.objects.get(username=USERNAME)
course_name = request.data.get("name", "Empty")
fields = { "display_name": course_name }

# Correctly parse boolean value from request
certificate_enabled = self.str_to_bool(request.data.get("certificate_enabled", 'true'))

fields = {"display_name": course_name}
new_course = create_new_course_in_store(
"split",
user,
Expand All @@ -78,15 +85,20 @@ def post(self, request, course_key_string):
)
msg = u"Created {}".format(new_course.id)
log.info(msg)
self.finalize_course(course_key)
self.finalize_course(course_key, certificate_enabled)
return Response({'detail': msg})
except DuplicateCourseError:
msg = u"Course already exists for {}, {}, {}".format(course_key.org, course_key.course, course_key.run)
log.warning(msg)
raise ParseError(msg)


def finalize_course(self, course_key):
def finalize_course(self, course_key, certificate_enabled):
log.info('Adding audit course mode')
CourseMode.objects.get_or_create(
course_id=course_key,
mode_slug=CourseMode.AUDIT,
defaults={"mode_display_name": "Audit"},
)
log.info('Adding honor course mode')
CourseMode.objects.get_or_create(
course_id=course_key,
Expand All @@ -96,7 +108,7 @@ def finalize_course(self, course_key):
log.info('Enabling self generated certificates')
CertificateGenerationCourseSetting.objects.get_or_create(
course_key=course_key,
self_generation_enabled=True,
self_generation_enabled=certificate_enabled,
)
log.info('Enabling LTI fields')
CourseEditLTIFieldsEnabledFlag.objects.get_or_create(
Expand All @@ -115,6 +127,38 @@ def set_visibility(course_key, visibility):
course.catalog_visibility = visibility
course.save()

@api_view(['POST'])
@authentication_classes([BasicAuthentication])
@permission_classes([IsAuthenticated])
def set_certificate_settings(request, course_key_string):
try:
course_key = CourseKey.from_string(course_key_string)
except Exception as e:
log.error(f"Invalid course key: {course_key_string}")
return Response({"detail": "Invalid course key."}, status=status.HTTP_400_BAD_REQUEST)

try:
data = json.loads(request.body.decode('utf-8'))
enabled = data.get("enabled")
enabled = enabled.lower() == 'true'
except (json.JSONDecodeError, ValueError, KeyError) as e:
return Response({"detail": "Request must include a JSON body with a boolean field 'enabled'."},
status=status.HTTP_400_BAD_REQUEST)

certificate_generation_setting, created = CertificateGenerationCourseSetting.objects.get_or_create(
course_key=course_key
)

certificate_generation_setting.enabled = enabled
certificate_generation_setting.save()

log.info(f"Course: {course_key} now has its certificate generation setting set to {enabled}")
return Response({
'course_key': str(course_key),
'enabled': enabled,
'status': 'created' if created else 'updated'
})

@api_view(['POST'])
@authentication_classes([BasicAuthentication])
@permission_classes([IsAuthenticated])
Expand Down