e1d1c29c00
Fix all deprecation warnings generated by Django REST Framework during the unit tests: * ``The `base_name` argument is pending deprecation in favor of `basename`.`` (86 occurrences) * `` `detail_route` is deprecated and will be removed in 3.10 in favor of `action`, which accepts a `detail` bool. Use `@action(detail=True)` instead.`` (18 occurrences)
97 lines
3.8 KiB
Python
97 lines
3.8 KiB
Python
"""HTTP endpoints for the Course Run API."""
|
|
|
|
|
|
from django.conf import settings
|
|
from django.http import Http404
|
|
from edx_rest_framework_extensions.auth.jwt.authentication import JwtAuthentication
|
|
from opaque_keys.edx.keys import CourseKey
|
|
from rest_framework import parsers, permissions, status, viewsets
|
|
from rest_framework.authentication import SessionAuthentication
|
|
from rest_framework.decorators import action
|
|
from rest_framework.response import Response
|
|
|
|
from contentstore.views.course import _accessible_courses_iter, get_course_and_check_access
|
|
|
|
from ..serializers.course_runs import (
|
|
CourseRunCreateSerializer,
|
|
CourseRunImageSerializer,
|
|
CourseRunRerunSerializer,
|
|
CourseRunSerializer
|
|
)
|
|
|
|
|
|
# pylint: disable=unused-argument
|
|
class CourseRunViewSet(viewsets.GenericViewSet):
|
|
authentication_classes = (JwtAuthentication, SessionAuthentication,)
|
|
lookup_value_regex = settings.COURSE_KEY_REGEX
|
|
permission_classes = (permissions.IsAdminUser,)
|
|
serializer_class = CourseRunSerializer
|
|
|
|
def get_object(self):
|
|
lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
|
|
|
|
assert lookup_url_kwarg in self.kwargs, (
|
|
u'Expected view %s to be called with a URL keyword argument '
|
|
u'named "%s". Fix your URL conf, or set the `.lookup_field` '
|
|
'attribute on the view correctly.' %
|
|
(self.__class__.__name__, lookup_url_kwarg)
|
|
)
|
|
|
|
course_run_key = CourseKey.from_string(self.kwargs[lookup_url_kwarg])
|
|
course_run = get_course_and_check_access(course_run_key, self.request.user)
|
|
if course_run:
|
|
return course_run
|
|
|
|
raise Http404
|
|
|
|
def list(self, request, *args, **kwargs):
|
|
course_runs, __ = _accessible_courses_iter(request)
|
|
page = self.paginate_queryset(list(course_runs))
|
|
serializer = self.get_serializer(page, many=True)
|
|
return self.get_paginated_response(serializer.data)
|
|
|
|
def retrieve(self, request, *args, **kwargs):
|
|
course_run = self.get_object()
|
|
serializer = self.get_serializer(course_run)
|
|
return Response(serializer.data)
|
|
|
|
def update(self, request, *args, **kwargs):
|
|
course_run = self.get_object()
|
|
|
|
partial = kwargs.pop('partial', False)
|
|
serializer = self.get_serializer(course_run, data=request.data, partial=partial)
|
|
serializer.is_valid(raise_exception=True)
|
|
serializer.save()
|
|
return Response(serializer.data)
|
|
|
|
def partial_update(self, request, *args, **kwargs):
|
|
kwargs['partial'] = True
|
|
return self.update(request, *args, **kwargs)
|
|
|
|
def create(self, request, *args, **kwargs):
|
|
serializer = CourseRunCreateSerializer(data=request.data, context=self.get_serializer_context())
|
|
serializer.is_valid(raise_exception=True)
|
|
serializer.save()
|
|
return Response(serializer.data, status=status.HTTP_201_CREATED)
|
|
|
|
@action(
|
|
detail=True,
|
|
methods=['post', 'put'],
|
|
parser_classes=(parsers.FormParser, parsers.MultiPartParser,),
|
|
serializer_class=CourseRunImageSerializer)
|
|
def images(self, request, *args, **kwargs):
|
|
course_run = self.get_object()
|
|
serializer = CourseRunImageSerializer(course_run, data=request.data, context=self.get_serializer_context())
|
|
serializer.is_valid(raise_exception=True)
|
|
serializer.save()
|
|
return Response(serializer.data)
|
|
|
|
@action(detail=True, methods=['post'])
|
|
def rerun(self, request, *args, **kwargs):
|
|
course_run = self.get_object()
|
|
serializer = CourseRunRerunSerializer(course_run, data=request.data, context=self.get_serializer_context())
|
|
serializer.is_valid(raise_exception=True)
|
|
new_course_run = serializer.save()
|
|
serializer = self.get_serializer(new_course_run)
|
|
return Response(serializer.data, status=status.HTTP_201_CREATED)
|