forked from openedx/edx-platform
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Extend settings handler to be accessible via api (#533)
- Loading branch information
Showing
6 changed files
with
222 additions
and
52 deletions.
There are no files selected for viewing
74 changes: 74 additions & 0 deletions
74
cms/djangoapps/contentstore/rest_api/v0/tests/test_details_settings.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,74 @@ | ||
""" | ||
Tests for the course advanced settings API. | ||
""" | ||
import json | ||
|
||
import ddt | ||
from django.urls import reverse | ||
from rest_framework import status | ||
|
||
from cms.djangoapps.contentstore.tests.utils import CourseTestCase | ||
|
||
|
||
@ddt.ddt | ||
class CourseDetailsSettingViewTest(CourseTestCase): | ||
""" | ||
Tests for DetailsSettings API View. | ||
""" | ||
|
||
def setUp(self): | ||
super().setUp() | ||
self.url = reverse( | ||
"cms.djangoapps.contentstore:v0:course_details_settings", | ||
kwargs={"course_id": self.course.id}, | ||
) | ||
|
||
def get_and_check_developer_response(self, response): | ||
""" | ||
Make basic asserting about the presence of an error response, and return the developer response. | ||
""" | ||
content = json.loads(response.content.decode("utf-8")) | ||
assert "developer_message" in content | ||
return content["developer_message"] | ||
|
||
def test_permissions_unauthenticated(self): | ||
""" | ||
Test that an error is returned in the absence of auth credentials. | ||
""" | ||
self.client.logout() | ||
response = self.client.get(self.url) | ||
error = self.get_and_check_developer_response(response) | ||
assert error == "Authentication credentials were not provided." | ||
|
||
def test_permissions_unauthorized(self): | ||
""" | ||
Test that an error is returned if the user is unauthorised. | ||
""" | ||
client, _ = self.create_non_staff_authed_user_client() | ||
response = client.get(self.url) | ||
error = self.get_and_check_developer_response(response) | ||
assert error == "You do not have permission to perform this action." | ||
|
||
def test_get_course_details(self): | ||
""" | ||
Test for get response | ||
""" | ||
response = self.client.get(self.url) | ||
self.assertEqual(response.status_code, status.HTTP_200_OK) | ||
|
||
def test_patch_course_details(self): | ||
""" | ||
Test for patch response | ||
""" | ||
data = { | ||
"start_date": "2030-01-01T00:00:00Z", | ||
"end_date": "2030-01-31T00:00:00Z", | ||
"enrollment_start": "2029-12-01T00:00:00Z", | ||
"enrollment_end": "2030-01-01T00:00:00Z", | ||
"course_title": "Test Course", | ||
"short_description": "This is a test course", | ||
"overview": "This course is for testing purposes", | ||
"intro_video": None | ||
} | ||
response = self.client.patch(self.url, data, content_type='application/json') | ||
self.assertEqual(response.status_code, status.HTTP_200_OK) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
cms/djangoapps/contentstore/rest_api/v0/views/details_settings.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,69 @@ | ||
""" API Views for course details settings """ | ||
|
||
import edx_api_doc_tools as apidocs | ||
from opaque_keys.edx.keys import CourseKey | ||
from rest_framework.request import Request | ||
from rest_framework.views import APIView | ||
from xmodule.modulestore.django import modulestore | ||
|
||
from cms.djangoapps.models.settings.encoder import CourseSettingsEncoder | ||
from common.djangoapps.student.auth import has_studio_read_access, has_studio_write_access | ||
from common.djangoapps.util.json_request import JsonResponse, expect_json | ||
from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes | ||
from openedx.core.djangoapps.models.course_details import CourseDetails | ||
|
||
from ....views.course import update_course_details_settings | ||
|
||
|
||
@view_auth_classes(is_authenticated=True) | ||
@expect_json | ||
class CourseDetailsSettingsView(DeveloperErrorViewMixin, APIView): | ||
""" | ||
View for getting and setting the details settings for a course. | ||
""" | ||
|
||
@apidocs.schema( | ||
parameters=[ | ||
apidocs.string_parameter("course_id", apidocs.ParameterLocation.PATH, description="Course ID"), | ||
], | ||
responses={ | ||
401: "The requester is not authenticated.", | ||
403: "The requester cannot access the specified course.", | ||
404: "The requested course does not exist.", | ||
}, | ||
) | ||
@verify_course_exists() | ||
def get(self, request: Request, course_id: str): | ||
""" | ||
Get an object containing all the details settings in a course. | ||
""" | ||
course_key = CourseKey.from_string(course_id) | ||
if not has_studio_read_access(request.user, course_key): | ||
self.permission_denied(request) | ||
course_details = CourseDetails.fetch(course_key) | ||
return JsonResponse( | ||
course_details, | ||
# encoder serializes dates, old locations, and instances | ||
encoder=CourseSettingsEncoder | ||
) | ||
|
||
@apidocs.schema( | ||
parameters=[ | ||
apidocs.string_parameter("course_id", apidocs.ParameterLocation.PATH, description="Course ID"), | ||
], | ||
responses={ | ||
401: "The requester is not authenticated.", | ||
403: "The requester cannot access the specified course.", | ||
404: "The requested course does not exist.", | ||
}, | ||
) | ||
@verify_course_exists() | ||
def patch(self, request: Request, course_id: str): | ||
""" | ||
Update a course's details settings. | ||
""" | ||
course_key = CourseKey.from_string(course_id) | ||
if not has_studio_write_access(request.user, course_key): | ||
self.permission_denied(request) | ||
course_block = modulestore().get_course(course_key) | ||
return update_course_details_settings(course_key, course_block, request) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters