Commit 1eb9b97ca95398d0dbb2898e3bb5f7b4ec856d6d
1 parent
69010b4978
Exists in
master
Fixed QuizRequestSerializer
Showing 2 changed files with 6 additions and 6 deletions Inline Diff
flashcards/serializers.py
View file @
1eb9b97
from json import dumps, loads | 1 | 1 | from json import dumps, loads | |
2 | 2 | |||
from django.utils.datetime_safe import datetime | 3 | 3 | from django.utils.datetime_safe import datetime | |
from django.utils.timezone import now | 4 | 4 | from django.utils.timezone import now | |
from flashcards.models import Section, LecturePeriod, User, Flashcard, UserFlashcard, UserFlashcardQuiz | 5 | 5 | from flashcards.models import Section, LecturePeriod, User, Flashcard, UserFlashcard, UserFlashcardQuiz | |
from flashcards.validators import FlashcardMask, OverlapIntervalException | 6 | 6 | from flashcards.validators import FlashcardMask, OverlapIntervalException | |
from rest_framework import serializers | 7 | 7 | from rest_framework import serializers | |
from rest_framework.fields import EmailField, BooleanField, CharField, IntegerField, DateTimeField, empty | 8 | 8 | from rest_framework.fields import EmailField, BooleanField, CharField, IntegerField, DateTimeField, empty | |
from rest_framework.serializers import ModelSerializer, Serializer, PrimaryKeyRelatedField, ListField | 9 | 9 | from rest_framework.serializers import ModelSerializer, Serializer, PrimaryKeyRelatedField, ListField | |
from rest_framework.validators import UniqueValidator | 10 | 10 | from rest_framework.validators import UniqueValidator | |
from flashy.settings import QUARTER_END, QUARTER_START | 11 | 11 | from flashy.settings import QUARTER_END, QUARTER_START | |
12 | 12 | |||
13 | 13 | |||
class EmailSerializer(Serializer): | 14 | 14 | class EmailSerializer(Serializer): | |
email = EmailField(required=True) | 15 | 15 | email = EmailField(required=True) | |
16 | 16 | |||
17 | 17 | |||
class EmailPasswordSerializer(EmailSerializer): | 18 | 18 | class EmailPasswordSerializer(EmailSerializer): | |
password = CharField(required=True) | 19 | 19 | password = CharField(required=True) | |
20 | 20 | |||
21 | 21 | |||
class RegistrationSerializer(EmailPasswordSerializer): | 22 | 22 | class RegistrationSerializer(EmailPasswordSerializer): | |
email = EmailField(required=True, validators=[UniqueValidator(queryset=User.objects.all())]) | 23 | 23 | email = EmailField(required=True, validators=[UniqueValidator(queryset=User.objects.all())]) | |
24 | 24 | |||
25 | 25 | |||
class PasswordResetRequestSerializer(EmailSerializer): | 26 | 26 | class PasswordResetRequestSerializer(EmailSerializer): | |
def validate_email(self, value): | 27 | 27 | def validate_email(self, value): | |
try: | 28 | 28 | try: | |
User.objects.get(email=value) | 29 | 29 | User.objects.get(email=value) | |
return value | 30 | 30 | return value | |
except User.DoesNotExist: | 31 | 31 | except User.DoesNotExist: | |
raise serializers.ValidationError('No user exists with that email') | 32 | 32 | raise serializers.ValidationError('No user exists with that email') | |
33 | 33 | |||
34 | 34 | |||
class PasswordResetSerializer(Serializer): | 35 | 35 | class PasswordResetSerializer(Serializer): | |
new_password = CharField(required=True, allow_blank=False) | 36 | 36 | new_password = CharField(required=True, allow_blank=False) | |
uid = IntegerField(required=True) | 37 | 37 | uid = IntegerField(required=True) | |
token = CharField(required=True) | 38 | 38 | token = CharField(required=True) | |
39 | 39 | |||
def validate_uid(self, value): | 40 | 40 | def validate_uid(self, value): | |
try: | 41 | 41 | try: | |
User.objects.get(id=value) | 42 | 42 | User.objects.get(id=value) | |
return value | 43 | 43 | return value | |
except User.DoesNotExist: | 44 | 44 | except User.DoesNotExist: | |
raise serializers.ValidationError('Could not verify reset token') | 45 | 45 | raise serializers.ValidationError('Could not verify reset token') | |
46 | 46 | |||
47 | 47 | |||
class UserUpdateSerializer(Serializer): | 48 | 48 | class UserUpdateSerializer(Serializer): | |
old_password = CharField(required=False) | 49 | 49 | old_password = CharField(required=False) | |
new_password = CharField(required=False, allow_blank=False) | 50 | 50 | new_password = CharField(required=False, allow_blank=False) | |
confirmation_key = CharField(required=False) | 51 | 51 | confirmation_key = CharField(required=False) | |
# reset_token = CharField(required=False) | 52 | 52 | # reset_token = CharField(required=False) | |
53 | 53 | |||
def validate(self, data): | 54 | 54 | def validate(self, data): | |
if 'new_password' in data and 'old_password' not in data: | 55 | 55 | if 'new_password' in data and 'old_password' not in data: | |
raise serializers.ValidationError('old_password is required to set a new_password') | 56 | 56 | raise serializers.ValidationError('old_password is required to set a new_password') | |
return data | 57 | 57 | return data | |
58 | 58 | |||
59 | 59 | |||
class Password(Serializer): | 60 | 60 | class Password(Serializer): | |
email = EmailField(required=True) | 61 | 61 | email = EmailField(required=True) | |
password = CharField(required=True) | 62 | 62 | password = CharField(required=True) | |
63 | 63 | |||
64 | 64 | |||
class LecturePeriodSerializer(ModelSerializer): | 65 | 65 | class LecturePeriodSerializer(ModelSerializer): | |
class Meta: | 66 | 66 | class Meta: | |
model = LecturePeriod | 67 | 67 | model = LecturePeriod | |
exclude = 'id', 'section' | 68 | 68 | exclude = 'id', 'section' | |
69 | 69 | |||
70 | 70 | |||
class SectionSerializer(ModelSerializer): | 71 | 71 | class SectionSerializer(ModelSerializer): | |
lecture_times = CharField() | 72 | 72 | lecture_times = CharField() | |
short_name = CharField() | 73 | 73 | short_name = CharField() | |
long_name = CharField() | 74 | 74 | long_name = CharField() | |
75 | 75 | |||
class Meta: | 76 | 76 | class Meta: | |
model = Section | 77 | 77 | model = Section | |
78 | 78 | |||
79 | 79 | |||
class DeepSectionSerializer(SectionSerializer): | 80 | 80 | class DeepSectionSerializer(SectionSerializer): | |
lectures = LecturePeriodSerializer(source='lectureperiod_set', many=True, read_only=True) | 81 | 81 | lectures = LecturePeriodSerializer(source='lectureperiod_set', many=True, read_only=True) | |
82 | 82 | |||
83 | 83 | |||
class UserSerializer(ModelSerializer): | 84 | 84 | class UserSerializer(ModelSerializer): | |
email = EmailField(required=False) | 85 | 85 | email = EmailField(required=False) | |
sections = SectionSerializer(many=True) | 86 | 86 | sections = SectionSerializer(many=True) | |
is_confirmed = BooleanField() | 87 | 87 | is_confirmed = BooleanField() | |
88 | 88 | |||
class Meta: | 89 | 89 | class Meta: | |
model = User | 90 | 90 | model = User | |
fields = ("sections", "email", "is_confirmed", "last_login", "date_joined") | 91 | 91 | fields = ("sections", "email", "is_confirmed", "last_login", "date_joined") | |
92 | 92 | |||
93 | 93 | |||
class MaskFieldSerializer(serializers.Field): | 94 | 94 | class MaskFieldSerializer(serializers.Field): | |
default_error_messages = { | 95 | 95 | default_error_messages = { | |
'max_length': 'Ensure this field has no more than {max_length} characters.', | 96 | 96 | 'max_length': 'Ensure this field has no more than {max_length} characters.', | |
'interval': 'Ensure this field has valid intervals.', | 97 | 97 | 'interval': 'Ensure this field has valid intervals.', | |
'overlap': 'Ensure this field does not have overlapping intervals.' | 98 | 98 | 'overlap': 'Ensure this field does not have overlapping intervals.' | |
} | 99 | 99 | } | |
100 | 100 | |||
def to_representation(self, value): | 101 | 101 | def to_representation(self, value): | |
return dumps(list(self._make_mask(value))) | 102 | 102 | return dumps(list(self._make_mask(value))) | |
103 | 103 | |||
def to_internal_value(self, value): | 104 | 104 | def to_internal_value(self, value): | |
return self._make_mask(loads(value)) | 105 | 105 | return self._make_mask(loads(value)) | |
106 | 106 | |||
def _make_mask(self, data): | 107 | 107 | def _make_mask(self, data): | |
try: | 108 | 108 | try: | |
mask = FlashcardMask(data) | 109 | 109 | mask = FlashcardMask(data) | |
except ValueError: | 110 | 110 | except ValueError: | |
raise serializers.ValidationError("Invalid JSON for MaskField") | 111 | 111 | raise serializers.ValidationError("Invalid JSON for MaskField") | |
except TypeError: | 112 | 112 | except TypeError: | |
raise serializers.ValidationError("Invalid data for MaskField.") | 113 | 113 | raise serializers.ValidationError("Invalid data for MaskField.") | |
except OverlapIntervalException: | 114 | 114 | except OverlapIntervalException: | |
raise serializers.ValidationError("Invalid intervals for MaskField data.") | 115 | 115 | raise serializers.ValidationError("Invalid intervals for MaskField data.") | |
if len(mask) > 32: | 116 | 116 | if len(mask) > 32: | |
raise serializers.ValidationError("Too many intervals in the mask.") | 117 | 117 | raise serializers.ValidationError("Too many intervals in the mask.") | |
return mask | 118 | 118 | return mask | |
119 | 119 | |||
120 | 120 | |||
class FlashcardSerializer(ModelSerializer): | 121 | 121 | class FlashcardSerializer(ModelSerializer): | |
is_hidden = BooleanField(read_only=True) | 122 | 122 | is_hidden = BooleanField(read_only=True) | |
hide_reason = CharField(read_only=True) | 123 | 123 | hide_reason = CharField(read_only=True) | |
material_date = DateTimeField(default=now) | 124 | 124 | material_date = DateTimeField(default=now) | |
mask = MaskFieldSerializer(allow_null=True) | 125 | 125 | mask = MaskFieldSerializer(allow_null=True) | |
126 | 126 | |||
def validate_material_date(self, value): | 127 | 127 | def validate_material_date(self, value): | |
# TODO: make this dynamic | 128 | 128 | # TODO: make this dynamic | |
if QUARTER_START <= value <= QUARTER_END: | 129 | 129 | if QUARTER_START <= value <= QUARTER_END: | |
return value | 130 | 130 | return value | |
else: | 131 | 131 | else: | |
raise serializers.ValidationError("Material date is outside allowed range for this quarter") | 132 | 132 | raise serializers.ValidationError("Material date is outside allowed range for this quarter") | |
133 | 133 | |||
def validate_pushed(self, value): | 134 | 134 | def validate_pushed(self, value): | |
if value > datetime.now(): | 135 | 135 | if value > datetime.now(): | |
raise serializers.ValidationError("Invalid creation date for the Flashcard") | 136 | 136 | raise serializers.ValidationError("Invalid creation date for the Flashcard") | |
return value | 137 | 137 | return value | |
138 | 138 | |||
def validate_mask(self, value): | 139 | 139 | def validate_mask(self, value): | |
if value is None: | 140 | 140 | if value is None: | |
return None | 141 | 141 | return None | |
if len(self.initial_data['text']) < value.max_offset(): | 142 | 142 | if len(self.initial_data['text']) < value.max_offset(): | |
raise serializers.ValidationError("Mask out of bounds") | 143 | 143 | raise serializers.ValidationError("Mask out of bounds") | |
return value | 144 | 144 | return value | |
145 | 145 | |||
class Meta: | 146 | 146 | class Meta: | |
model = Flashcard | 147 | 147 | model = Flashcard | |
exclude = 'author', 'previous' | 148 | 148 | exclude = 'author', 'previous' | |
149 | 149 | |||
150 | 150 | |||
class FlashcardUpdateSerializer(serializers.Serializer): | 151 | 151 | class FlashcardUpdateSerializer(serializers.Serializer): | |
text = CharField(max_length=255, required=False) | 152 | 152 | text = CharField(max_length=255, required=False) | |
material_date = DateTimeField(required=False) | 153 | 153 | material_date = DateTimeField(required=False) | |
mask = MaskFieldSerializer(required=False) | 154 | 154 | mask = MaskFieldSerializer(required=False) | |
155 | 155 | |||
def validate_material_date(self, date): | 156 | 156 | def validate_material_date(self, date): | |
if date > QUARTER_END: | 157 | 157 | if date > QUARTER_END: | |
raise serializers.ValidationError("Invalid material_date for the flashcard") | 158 | 158 | raise serializers.ValidationError("Invalid material_date for the flashcard") | |
return date | 159 | 159 | return date | |
160 | 160 | |||
def validate(self, attrs): | 161 | 161 | def validate(self, attrs): | |
# Make sure that at least one of the attributes was passed in | 162 | 162 | # Make sure that at least one of the attributes was passed in | |
if not any(i in attrs for i in ['material_date', 'text', 'mask']): | 163 | 163 | if not any(i in attrs for i in ['material_date', 'text', 'mask']): | |
raise serializers.ValidationError("No new value passed in") | 164 | 164 | raise serializers.ValidationError("No new value passed in") | |
return attrs | 165 | 165 | return attrs | |
166 | 166 | |||
167 | 167 | |||
class QuizRequestSerializer(serializers.Serializer): | 168 | 168 | class QuizRequestSerializer(serializers.Serializer): | |
# sections = PrimaryKeyRelatedField(queryset=Section.objects.all(),required=False, many=True) | 169 | 169 | # sections = PrimaryKeyRelatedField(queryset=Section.objects.all(),required=False, many=True) | |
sections = ListField(child=IntegerField(min_value=1), required=False) | 170 | 170 | sections = ListField(child=IntegerField(min_value=1), required=False) | |
material_date_begin = DateTimeField(default=QUARTER_START) | 171 | 171 | material_date_begin = DateTimeField(default=QUARTER_START) | |
material_date_end = DateTimeField(default=QUARTER_END) | 172 | 172 | material_date_end = DateTimeField(default=QUARTER_END) | |
173 | 173 | |||
def __init__(self, user, *args, **kwargs): | 174 | 174 | def __init__(self, user, instance=None, data=empty, **kwargs): | |
super(QuizRequestSerializer, self).__init__(*args, **kwargs) | 175 | 175 | super(QuizRequestSerializer, self).__init__(instance=instance, data=data, **kwargs) | |
self.user = user | 176 | 176 | self.user = user | |
self.user_flashcard = None | 177 | 177 | self.user_flashcard = None | |
178 | 178 | |||
def create(self, validated_data): | 179 | 179 | def create(self, validated_data): | |
return UserFlashcardQuiz.objects.create(user_flashcard=self.user_flashcard) | 180 | 180 | return UserFlashcardQuiz.objects.create(user_flashcard=self.user_flashcard) | |
181 | 181 | |||
def update(self, instance, validated_data): | 182 | 182 | def update(self, instance, validated_data): | |
for attr in validated_data: | 183 | 183 | for attr in validated_data: | |
setattr(instance, attr, validated_data[attr]) | 184 | 184 | setattr(instance, attr, validated_data[attr]) | |
instance.save() | 185 | 185 | instance.save() | |
return instance | 186 | 186 | return instance | |
187 | 187 | |||
def _get_user_flashcard(self, attrs): | 188 | 188 | def _get_user_flashcard(self, attrs): | |
user_flashcard_filter = UserFlashcard.objects.filter( | 189 | 189 | user_flashcard_filter = UserFlashcard.objects.filter( | |
user=self.user, flashcard__section__in=attrs['sections'], | 190 | 190 | user=self.user, flashcard__section__in=attrs['sections'], | |
flashcard__material_date__gte=attrs['material_date_begin'], | 191 | 191 | flashcard__material_date__gte=attrs['material_date_begin'], | |
flashcard__material_date__lte=attrs['material_date_end'] | 192 | 192 | flashcard__material_date__lte=attrs['material_date_end'] | |
) | 193 | 193 | ) | |
if not user_flashcard_filter.exists(): | 194 | 194 | if not user_flashcard_filter.exists(): | |
raise serializers.ValidationError("Your deck for that section is empty") | 195 | 195 | raise serializers.ValidationError("Your deck for that section is empty") | |
self.user_flashcard = user_flashcard_filter.order_by('?').first() | 196 | 196 | self.user_flashcard = user_flashcard_filter.order_by('?').first() | |
197 | 197 | |||
def validate_material_date_begin(self, value): | 198 | 198 | def validate_material_date_begin(self, value): | |
if QUARTER_START <= value <= QUARTER_END: | 199 | 199 | if QUARTER_START <= value <= QUARTER_END: | |
return value | 200 | 200 | return value | |
raise serializers.ValidationError("Invalid begin date for the flashcard range") | 201 | 201 | raise serializers.ValidationError("Invalid begin date for the flashcard range") | |
202 | 202 | |||
def validate_material_date_end(self, value): | 203 | 203 | def validate_material_date_end(self, value): | |
if QUARTER_START <= value <= QUARTER_END: | 204 | 204 | if QUARTER_START <= value <= QUARTER_END: | |
return value | 205 | 205 | return value | |
raise serializers.ValidationError("Invalid end date for the flashcard range") | 206 | 206 | raise serializers.ValidationError("Invalid end date for the flashcard range") | |
207 | 207 | |||
def validate_sections(self, value): | 208 | 208 | def validate_sections(self, value): | |
if value is None: | 209 | 209 | if value is None: | |
return self.user.sections | 210 | 210 | return self.user.sections | |
section_filter = Section.objects.filter(pk__in=value) | 211 | 211 | section_filter = Section.objects.filter(pk__in=value) | |
if not section_filter.exists(): | 212 | 212 | if not section_filter.exists(): | |
raise serializers.ValidationError("You aren't enrolled in those section(s)") | 213 | 213 | raise serializers.ValidationError("You aren't enrolled in those section(s)") | |
return section_filter | 214 | 214 | return section_filter | |
215 | 215 | |||
def validate(self, attrs): | 216 | 216 | def validate(self, attrs): | |
if attrs['material_date_begin'] > attrs['material_date_end']: | 217 | 217 | if attrs['material_date_begin'] > attrs['material_date_end']: | |
raise serializers.ValidationError("Invalid range") | 218 | 218 | raise serializers.ValidationError("Invalid range") | |
if 'sections' not in attrs: | 219 | 219 | if 'sections' not in attrs: | |
attrs['sections'] = self.validate_sections(None) | 220 | 220 | attrs['sections'] = self.validate_sections(None) | |
self._get_user_flashcard(attrs) | 221 | 221 | self._get_user_flashcard(attrs) | |
return attrs | 222 | 222 | return attrs | |
223 | 223 | |||
224 | 224 |
flashcards/views.py
View file @
1eb9b97
from random import sample | 1 | 1 | from random import sample | |
2 | 2 | |||
import django | 3 | 3 | import django | |
from django.contrib import auth | 4 | 4 | from django.contrib import auth | |
from django.shortcuts import get_object_or_404 | 5 | 5 | from django.shortcuts import get_object_or_404 | |
from flashcards.api import StandardResultsSetPagination, IsEnrolledInAssociatedSection, IsFlashcardReviewer | 6 | 6 | from flashcards.api import StandardResultsSetPagination, IsEnrolledInAssociatedSection, IsFlashcardReviewer | |
from flashcards.models import Section, User, Flashcard, FlashcardHide, UserFlashcardQuiz | 7 | 7 | from flashcards.models import Section, User, Flashcard, FlashcardHide, UserFlashcardQuiz | |
from flashcards.notifications import notify_new_card | 8 | 8 | from flashcards.notifications import notify_new_card | |
from flashcards.serializers import SectionSerializer, UserUpdateSerializer, RegistrationSerializer, UserSerializer, \ | 9 | 9 | from flashcards.serializers import SectionSerializer, UserUpdateSerializer, RegistrationSerializer, UserSerializer, \ | |
PasswordResetSerializer, PasswordResetRequestSerializer, EmailPasswordSerializer, FlashcardSerializer, \ | 10 | 10 | PasswordResetSerializer, PasswordResetRequestSerializer, EmailPasswordSerializer, FlashcardSerializer, \ | |
FlashcardUpdateSerializer, QuizRequestSerializer, QuizResponseSerializer, \ | 11 | 11 | FlashcardUpdateSerializer, QuizRequestSerializer, QuizResponseSerializer, \ | |
QuizAnswerRequestSerializer, DeepSectionSerializer | 12 | 12 | QuizAnswerRequestSerializer, DeepSectionSerializer | |
from rest_framework.decorators import detail_route, permission_classes, api_view, list_route | 13 | 13 | from rest_framework.decorators import detail_route, permission_classes, api_view, list_route | |
from rest_framework.generics import ListAPIView, GenericAPIView | 14 | 14 | from rest_framework.generics import ListAPIView, GenericAPIView | |
from rest_framework.mixins import CreateModelMixin, RetrieveModelMixin, UpdateModelMixin | 15 | 15 | from rest_framework.mixins import CreateModelMixin, RetrieveModelMixin, UpdateModelMixin | |
from rest_framework.permissions import IsAuthenticated | 16 | 16 | from rest_framework.permissions import IsAuthenticated | |
from rest_framework.viewsets import ReadOnlyModelViewSet, GenericViewSet | 17 | 17 | from rest_framework.viewsets import ReadOnlyModelViewSet, GenericViewSet | |
from django.core.mail import send_mail | 18 | 18 | from django.core.mail import send_mail | |
from django.contrib.auth import authenticate | 19 | 19 | from django.contrib.auth import authenticate | |
from django.contrib.auth.tokens import default_token_generator | 20 | 20 | from django.contrib.auth.tokens import default_token_generator | |
from rest_framework.status import HTTP_204_NO_CONTENT, HTTP_201_CREATED, HTTP_200_OK | 21 | 21 | from rest_framework.status import HTTP_204_NO_CONTENT, HTTP_201_CREATED, HTTP_200_OK | |
from rest_framework.response import Response | 22 | 22 | from rest_framework.response import Response | |
from rest_framework.exceptions import AuthenticationFailed, NotAuthenticated, ValidationError, PermissionDenied | 23 | 23 | from rest_framework.exceptions import AuthenticationFailed, NotAuthenticated, ValidationError, PermissionDenied | |
from simple_email_confirmation import EmailAddress | 24 | 24 | from simple_email_confirmation import EmailAddress | |
25 | 25 | |||
26 | 26 | |||
class SectionViewSet(ReadOnlyModelViewSet): | 27 | 27 | class SectionViewSet(ReadOnlyModelViewSet): | |
queryset = Section.objects.all() | 28 | 28 | queryset = Section.objects.all() | |
serializer_class = DeepSectionSerializer | 29 | 29 | serializer_class = DeepSectionSerializer | |
pagination_class = StandardResultsSetPagination | 30 | 30 | pagination_class = StandardResultsSetPagination | |
permission_classes = [IsAuthenticated] | 31 | 31 | permission_classes = [IsAuthenticated] | |
32 | 32 | |||
@detail_route(methods=['GET']) | 33 | 33 | @detail_route(methods=['GET']) | |
def flashcards(self, request, pk): | 34 | 34 | def flashcards(self, request, pk): | |
""" | 35 | 35 | """ | |
Gets flashcards for a section, excluding hidden cards. | 36 | 36 | Gets flashcards for a section, excluding hidden cards. | |
Returned in strictly chronological order (material date). | 37 | 37 | Returned in strictly chronological order (material date). | |
""" | 38 | 38 | """ | |
flashcards = Flashcard.cards_visible_to(request.user).filter(section=self.get_object()).all() | 39 | 39 | flashcards = Flashcard.cards_visible_to(request.user).filter(section=self.get_object()).all() | |
return Response(FlashcardSerializer(flashcards, many=True).data) | 40 | 40 | return Response(FlashcardSerializer(flashcards, many=True).data) | |
41 | 41 | |||
@detail_route(methods=['POST']) | 42 | 42 | @detail_route(methods=['POST']) | |
def enroll(self, request, pk): | 43 | 43 | def enroll(self, request, pk): | |
""" | 44 | 44 | """ | |
Add the current user to a specified section | 45 | 45 | Add the current user to a specified section | |
If the class has a whitelist, but the user is not on the whitelist, the request will fail. | 46 | 46 | If the class has a whitelist, but the user is not on the whitelist, the request will fail. | |
--- | 47 | 47 | --- | |
view_mocker: flashcards.api.mock_no_params | 48 | 48 | view_mocker: flashcards.api.mock_no_params | |
""" | 49 | 49 | """ | |
50 | 50 | |||
self.get_object().enroll(request.user) | 51 | 51 | self.get_object().enroll(request.user) | |
return Response(status=HTTP_204_NO_CONTENT) | 52 | 52 | return Response(status=HTTP_204_NO_CONTENT) | |
53 | 53 | |||
@detail_route(methods=['POST']) | 54 | 54 | @detail_route(methods=['POST']) | |
def drop(self, request, pk): | 55 | 55 | def drop(self, request, pk): | |
""" | 56 | 56 | """ | |
Remove the current user from a specified section | 57 | 57 | Remove the current user from a specified section | |
If the user is not in the class, the request will fail. | 58 | 58 | If the user is not in the class, the request will fail. | |
--- | 59 | 59 | --- | |
view_mocker: flashcards.api.mock_no_params | 60 | 60 | view_mocker: flashcards.api.mock_no_params | |
""" | 61 | 61 | """ | |
try: | 62 | 62 | try: | |
self.get_object().drop(request.user) | 63 | 63 | self.get_object().drop(request.user) | |
except django.core.exceptions.PermissionDenied as e: | 64 | 64 | except django.core.exceptions.PermissionDenied as e: | |
raise PermissionDenied(e) | 65 | 65 | raise PermissionDenied(e) | |
except django.core.exceptions.ValidationError as e: | 66 | 66 | except django.core.exceptions.ValidationError as e: | |
raise ValidationError(e) | 67 | 67 | raise ValidationError(e) | |
return Response(status=HTTP_204_NO_CONTENT) | 68 | 68 | return Response(status=HTTP_204_NO_CONTENT) | |
69 | 69 | |||
@list_route(methods=['GET']) | 70 | 70 | @list_route(methods=['GET']) | |
def search(self, request): | 71 | 71 | def search(self, request): | |
""" | 72 | 72 | """ | |
Returns a list of sections which match a user's query | 73 | 73 | Returns a list of sections which match a user's query | |
--- | 74 | 74 | --- | |
parameters: | 75 | 75 | parameters: | |
- name: q | 76 | 76 | - name: q | |
description: space-separated list of terms | 77 | 77 | description: space-separated list of terms | |
required: true | 78 | 78 | required: true | |
type: form | 79 | 79 | type: form | |
response_serializer: SectionSerializer | 80 | 80 | response_serializer: SectionSerializer | |
""" | 81 | 81 | """ | |
query = request.GET.get('q', None) | 82 | 82 | query = request.GET.get('q', None) | |
if not query: return Response('[]') | 83 | 83 | if not query: return Response('[]') | |
qs = Section.search(query.split(' '))[:20] | 84 | 84 | qs = Section.search(query.split(' '))[:20] | |
data = SectionSerializer(qs, many=True).data | 85 | 85 | data = SectionSerializer(qs, many=True).data | |
return Response(data) | 86 | 86 | return Response(data) | |
87 | 87 | |||
@detail_route(methods=['GET']) | 88 | 88 | @detail_route(methods=['GET']) | |
def deck(self, request, pk): | 89 | 89 | def deck(self, request, pk): | |
""" | 90 | 90 | """ | |
Gets the contents of a user's deck for a given section. | 91 | 91 | Gets the contents of a user's deck for a given section. | |
""" | 92 | 92 | """ | |
qs = request.user.get_deck(self.get_object()) | 93 | 93 | qs = request.user.get_deck(self.get_object()) | |
serializer = FlashcardSerializer(qs, many=True) | 94 | 94 | serializer = FlashcardSerializer(qs, many=True) | |
return Response(serializer.data) | 95 | 95 | return Response(serializer.data) | |
96 | 96 | |||
@detail_route(methods=['GET'], permission_classes=[IsAuthenticated]) | 97 | 97 | @detail_route(methods=['GET'], permission_classes=[IsAuthenticated]) | |
def ordered_deck(self, request, pk): | 98 | 98 | def ordered_deck(self, request, pk): | |
""" | 99 | 99 | """ | |
Get a chronological order by material_date of flashcards for a section. | 100 | 100 | Get a chronological order by material_date of flashcards for a section. | |
This excludes hidden card. | 101 | 101 | This excludes hidden card. | |
""" | 102 | 102 | """ | |
qs = request.user.get_deck(self.get_object()).order_by('-material_date') | 103 | 103 | qs = request.user.get_deck(self.get_object()).order_by('-material_date') | |
serializer = FlashcardSerializer(qs, many=True) | 104 | 104 | serializer = FlashcardSerializer(qs, many=True) | |
return Response(serializer.data) | 105 | 105 | return Response(serializer.data) | |
106 | 106 | |||
@detail_route(methods=['GET']) | 107 | 107 | @detail_route(methods=['GET']) | |
def feed(self, request, pk): | 108 | 108 | def feed(self, request, pk): | |
""" | 109 | 109 | """ | |
Gets the contents of a user's feed for a section. | 110 | 110 | Gets the contents of a user's feed for a section. | |
Exclude cards that are already in the user's deck | 111 | 111 | Exclude cards that are already in the user's deck | |
""" | 112 | 112 | """ | |
serializer = FlashcardSerializer(self.get_object().get_feed_for_user(request.user), many=True) | 113 | 113 | serializer = FlashcardSerializer(self.get_object().get_feed_for_user(request.user), many=True) | |
return Response(serializer.data) | 114 | 114 | return Response(serializer.data) | |
115 | 115 | |||
116 | 116 | |||
class UserSectionListView(ListAPIView): | 117 | 117 | class UserSectionListView(ListAPIView): | |
serializer_class = DeepSectionSerializer | 118 | 118 | serializer_class = DeepSectionSerializer | |
permission_classes = [IsAuthenticated] | 119 | 119 | permission_classes = [IsAuthenticated] | |
120 | 120 | |||
def get_queryset(self): | 121 | 121 | def get_queryset(self): | |
return self.request.user.sections.all() | 122 | 122 | return self.request.user.sections.all() | |
123 | 123 | |||
def paginate_queryset(self, queryset): return None | 124 | 124 | def paginate_queryset(self, queryset): return None | |
125 | 125 | |||
126 | 126 | |||
class UserDetail(GenericAPIView): | 127 | 127 | class UserDetail(GenericAPIView): | |
serializer_class = UserSerializer | 128 | 128 | serializer_class = UserSerializer | |
permission_classes = [IsAuthenticated] | 129 | 129 | permission_classes = [IsAuthenticated] | |
130 | 130 | |||
def patch(self, request, format=None): | 131 | 131 | def patch(self, request, format=None): | |
""" | 132 | 132 | """ | |
Updates the user's password, or verifies their email address | 133 | 133 | Updates the user's password, or verifies their email address | |
--- | 134 | 134 | --- | |
request_serializer: UserUpdateSerializer | 135 | 135 | request_serializer: UserUpdateSerializer | |
response_serializer: UserSerializer | 136 | 136 | response_serializer: UserSerializer | |
""" | 137 | 137 | """ | |
data = UserUpdateSerializer(data=request.data, context={'user': request.user}) | 138 | 138 | data = UserUpdateSerializer(data=request.data, context={'user': request.user}) | |
data.is_valid(raise_exception=True) | 139 | 139 | data.is_valid(raise_exception=True) | |
data = data.validated_data | 140 | 140 | data = data.validated_data | |
141 | 141 | |||
if 'new_password' in data: | 142 | 142 | if 'new_password' in data: | |
if not request.user.check_password(data['old_password']): | 143 | 143 | if not request.user.check_password(data['old_password']): | |
raise ValidationError('old_password is incorrect') | 144 | 144 | raise ValidationError('old_password is incorrect') | |
request.user.set_password(data['new_password']) | 145 | 145 | request.user.set_password(data['new_password']) | |
request.user.save() | 146 | 146 | request.user.save() | |
147 | 147 | |||
if 'confirmation_key' in data: | 148 | 148 | if 'confirmation_key' in data: | |
try: | 149 | 149 | try: | |
request.user.confirm_email(data['confirmation_key']) | 150 | 150 | request.user.confirm_email(data['confirmation_key']) | |
except EmailAddress.DoesNotExist: | 151 | 151 | except EmailAddress.DoesNotExist: | |
raise ValidationError('confirmation_key is invalid') | 152 | 152 | raise ValidationError('confirmation_key is invalid') | |
153 | 153 | |||
return Response(UserSerializer(request.user).data) | 154 | 154 | return Response(UserSerializer(request.user).data) | |
155 | 155 | |||
def get(self, request, format=None): | 156 | 156 | def get(self, request, format=None): | |
""" | 157 | 157 | """ | |
Return data about the user | 158 | 158 | Return data about the user | |
--- | 159 | 159 | --- | |
response_serializer: UserSerializer | 160 | 160 | response_serializer: UserSerializer | |
""" | 161 | 161 | """ | |
serializer = UserSerializer(request.user, context={'request': request}) | 162 | 162 | serializer = UserSerializer(request.user, context={'request': request}) | |
return Response(serializer.data) | 163 | 163 | return Response(serializer.data) | |
164 | 164 | |||
def delete(self, request): | 165 | 165 | def delete(self, request): | |
""" | 166 | 166 | """ | |
Irrevocably delete the user and their data | 167 | 167 | Irrevocably delete the user and their data | |
168 | 168 | |||
Yes, really | 169 | 169 | Yes, really | |
""" | 170 | 170 | """ | |
request.user.delete() | 171 | 171 | request.user.delete() | |
return Response(status=HTTP_204_NO_CONTENT) | 172 | 172 | return Response(status=HTTP_204_NO_CONTENT) | |
173 | 173 | |||
174 | 174 | |||
@api_view(['POST']) | 175 | 175 | @api_view(['POST']) | |
def register(request, format=None): | 176 | 176 | def register(request, format=None): | |
""" | 177 | 177 | """ | |
Register a new user | 178 | 178 | Register a new user | |
--- | 179 | 179 | --- | |
request_serializer: EmailPasswordSerializer | 180 | 180 | request_serializer: EmailPasswordSerializer | |
response_serializer: UserSerializer | 181 | 181 | response_serializer: UserSerializer | |
""" | 182 | 182 | """ | |
data = RegistrationSerializer(data=request.data) | 183 | 183 | data = RegistrationSerializer(data=request.data) | |
data.is_valid(raise_exception=True) | 184 | 184 | data.is_valid(raise_exception=True) | |
185 | 185 | |||
User.objects.create_user(**data.validated_data) | 186 | 186 | User.objects.create_user(**data.validated_data) | |
user = authenticate(**data.validated_data) | 187 | 187 | user = authenticate(**data.validated_data) | |
auth.login(request, user) | 188 | 188 | auth.login(request, user) | |
189 | 189 | |||
return Response(UserSerializer(request.user).data, status=HTTP_201_CREATED) | 190 | 190 | return Response(UserSerializer(request.user).data, status=HTTP_201_CREATED) | |
191 | 191 | |||
192 | 192 | |||
@api_view(['POST']) | 193 | 193 | @api_view(['POST']) | |
def login(request): | 194 | 194 | def login(request): | |
""" | 195 | 195 | """ | |
Authenticates user and returns user data if valid. | 196 | 196 | Authenticates user and returns user data if valid. | |
--- | 197 | 197 | --- | |
request_serializer: EmailPasswordSerializer | 198 | 198 | request_serializer: EmailPasswordSerializer | |
response_serializer: UserSerializer | 199 | 199 | response_serializer: UserSerializer | |
""" | 200 | 200 | """ | |
201 | 201 | |||
data = EmailPasswordSerializer(data=request.data) | 202 | 202 | data = EmailPasswordSerializer(data=request.data) | |
data.is_valid(raise_exception=True) | 203 | 203 | data.is_valid(raise_exception=True) | |
user = authenticate(**data.validated_data) | 204 | 204 | user = authenticate(**data.validated_data) | |
205 | 205 | |||
if user is None: | 206 | 206 | if user is None: | |
raise AuthenticationFailed('Invalid email or password') | 207 | 207 | raise AuthenticationFailed('Invalid email or password') | |
if not user.is_active: | 208 | 208 | if not user.is_active: | |
raise NotAuthenticated('Account is disabled') | 209 | 209 | raise NotAuthenticated('Account is disabled') | |
auth.login(request, user) | 210 | 210 | auth.login(request, user) | |
return Response(UserSerializer(request.user).data) | 211 | 211 | return Response(UserSerializer(request.user).data) | |
212 | 212 | |||
213 | 213 | |||
@api_view(['POST']) | 214 | 214 | @api_view(['POST']) | |
@permission_classes((IsAuthenticated,)) | 215 | 215 | @permission_classes((IsAuthenticated,)) | |
def logout(request, format=None): | 216 | 216 | def logout(request, format=None): | |
""" | 217 | 217 | """ | |
Logs the authenticated user out. | 218 | 218 | Logs the authenticated user out. | |
""" | 219 | 219 | """ | |
auth.logout(request) | 220 | 220 | auth.logout(request) | |
return Response(status=HTTP_204_NO_CONTENT) | 221 | 221 | return Response(status=HTTP_204_NO_CONTENT) | |
222 | 222 | |||
223 | 223 | |||
@api_view(['POST']) | 224 | 224 | @api_view(['POST']) | |
def request_password_reset(request, format=None): | 225 | 225 | def request_password_reset(request, format=None): | |
""" | 226 | 226 | """ | |
Send a password reset token/link to the provided email. | 227 | 227 | Send a password reset token/link to the provided email. | |
--- | 228 | 228 | --- | |
request_serializer: PasswordResetRequestSerializer | 229 | 229 | request_serializer: PasswordResetRequestSerializer | |
""" | 230 | 230 | """ | |
data = PasswordResetRequestSerializer(data=request.data) | 231 | 231 | data = PasswordResetRequestSerializer(data=request.data) | |
data.is_valid(raise_exception=True) | 232 | 232 | data.is_valid(raise_exception=True) | |
get_object_or_404(User, email=data['email'].value).request_password_reset() | 233 | 233 | get_object_or_404(User, email=data['email'].value).request_password_reset() | |
return Response(status=HTTP_204_NO_CONTENT) | 234 | 234 | return Response(status=HTTP_204_NO_CONTENT) | |
235 | 235 | |||
236 | 236 | |||
@api_view(['POST']) | 237 | 237 | @api_view(['POST']) | |
def reset_password(request, format=None): | 238 | 238 | def reset_password(request, format=None): | |
""" | 239 | 239 | """ | |
Updates user's password to new password if token is valid. | 240 | 240 | Updates user's password to new password if token is valid. | |
--- | 241 | 241 | --- | |
request_serializer: PasswordResetSerializer | 242 | 242 | request_serializer: PasswordResetSerializer | |
""" | 243 | 243 | """ | |
data = PasswordResetSerializer(data=request.data) | 244 | 244 | data = PasswordResetSerializer(data=request.data) | |
data.is_valid(raise_exception=True) | 245 | 245 | data.is_valid(raise_exception=True) | |
246 | 246 | |||
user = User.objects.get(id=data['uid'].value) | 247 | 247 | user = User.objects.get(id=data['uid'].value) | |
# Check token validity. | 248 | 248 | # Check token validity. | |
249 | 249 | |||
if default_token_generator.check_token(user, data['token'].value): | 250 | 250 | if default_token_generator.check_token(user, data['token'].value): | |
user.set_password(data['new_password'].value) | 251 | 251 | user.set_password(data['new_password'].value) | |
user.save() | 252 | 252 | user.save() | |
else: | 253 | 253 | else: | |
raise ValidationError('Could not verify reset token') | 254 | 254 | raise ValidationError('Could not verify reset token') | |
return Response(status=HTTP_204_NO_CONTENT) | 255 | 255 | return Response(status=HTTP_204_NO_CONTENT) | |
256 | 256 | |||
257 | 257 | |||
class FlashcardViewSet(GenericViewSet, CreateModelMixin, RetrieveModelMixin): | 258 | 258 | class FlashcardViewSet(GenericViewSet, CreateModelMixin, RetrieveModelMixin): | |
queryset = Flashcard.objects.all() | 259 | 259 | queryset = Flashcard.objects.all() | |
serializer_class = FlashcardSerializer | 260 | 260 | serializer_class = FlashcardSerializer | |
permission_classes = [IsAuthenticated, IsEnrolledInAssociatedSection] | 261 | 261 | permission_classes = [IsAuthenticated, IsEnrolledInAssociatedSection] | |
262 | 262 | |||
# Override create in CreateModelMixin | 263 | 263 | # Override create in CreateModelMixin | |
def create(self, request, *args, **kwargs): | 264 | 264 | def create(self, request, *args, **kwargs): | |
serializer = FlashcardSerializer(data=request.data) | 265 | 265 | serializer = FlashcardSerializer(data=request.data) | |
serializer.is_valid(raise_exception=True) | 266 | 266 | serializer.is_valid(raise_exception=True) | |
data = serializer.validated_data | 267 | 267 | data = serializer.validated_data | |
if not request.user.is_in_section(data['section']): | 268 | 268 | if not request.user.is_in_section(data['section']): | |
raise PermissionDenied('The user is not enrolled in that section') | 269 | 269 | raise PermissionDenied('The user is not enrolled in that section') | |
data['author'] = request.user | 270 | 270 | data['author'] = request.user | |
flashcard = Flashcard.objects.create(**data) | 271 | 271 | flashcard = Flashcard.objects.create(**data) | |
self.perform_create(flashcard) | 272 | 272 | self.perform_create(flashcard) | |
notify_new_card(flashcard) | 273 | 273 | notify_new_card(flashcard) | |
headers = self.get_success_headers(data) | 274 | 274 | headers = self.get_success_headers(data) | |
response_data = FlashcardSerializer(flashcard).data | 275 | 275 | response_data = FlashcardSerializer(flashcard).data | |
276 | 276 | |||
return Response(response_data, status=HTTP_201_CREATED, headers=headers) | 277 | 277 | return Response(response_data, status=HTTP_201_CREATED, headers=headers) | |
278 | 278 | |||
@detail_route(methods=['POST']) | 279 | 279 | @detail_route(methods=['POST']) | |
def unhide(self, request, pk): | 280 | 280 | def unhide(self, request, pk): | |
""" | 281 | 281 | """ | |
Unhide the given card | 282 | 282 | Unhide the given card | |
--- | 283 | 283 | --- | |
view_mocker: flashcards.api.mock_no_params | 284 | 284 | view_mocker: flashcards.api.mock_no_params | |
""" | 285 | 285 | """ | |
hide = get_object_or_404(FlashcardHide, user=request.user, flashcard=self.get_object()) | 286 | 286 | hide = get_object_or_404(FlashcardHide, user=request.user, flashcard=self.get_object()) | |
hide.delete() | 287 | 287 | hide.delete() | |
return Response(status=HTTP_204_NO_CONTENT) | 288 | 288 | return Response(status=HTTP_204_NO_CONTENT) | |
289 | 289 | |||
@detail_route(methods=['POST']) | 290 | 290 | @detail_route(methods=['POST']) | |
def report(self, request, pk): | 291 | 291 | def report(self, request, pk): | |
""" | 292 | 292 | """ | |
Hide the given card | 293 | 293 | Hide the given card | |
--- | 294 | 294 | --- | |
view_mocker: flashcards.api.mock_no_params | 295 | 295 | view_mocker: flashcards.api.mock_no_params | |
""" | 296 | 296 | """ | |
self.get_object().report(request.user) | 297 | 297 | self.get_object().report(request.user) | |
return Response(status=HTTP_204_NO_CONTENT) | 298 | 298 | return Response(status=HTTP_204_NO_CONTENT) | |
299 | 299 | |||
hide = report | 300 | 300 | hide = report | |
301 | 301 | |||
@detail_route(methods=['POST']) | 302 | 302 | @detail_route(methods=['POST']) | |
def pull(self, request, pk): | 303 | 303 | def pull(self, request, pk): | |
""" | 304 | 304 | """ | |
Pull a card from the live feed into the user's deck. | 305 | 305 | Pull a card from the live feed into the user's deck. | |
--- | 306 | 306 | --- | |
view_mocker: flashcards.api.mock_no_params | 307 | 307 | view_mocker: flashcards.api.mock_no_params | |
""" | 308 | 308 | """ | |
user = request.user | 309 | 309 | user = request.user | |
flashcard = self.get_object() | 310 | 310 | flashcard = self.get_object() | |
user.pull(flashcard) | 311 | 311 | user.pull(flashcard) | |
return Response(status=HTTP_204_NO_CONTENT) | 312 | 312 | return Response(status=HTTP_204_NO_CONTENT) | |
313 | 313 | |||
@detail_route(methods=['POST']) | 314 | 314 | @detail_route(methods=['POST']) | |
def unpull(self, request, pk): | 315 | 315 | def unpull(self, request, pk): | |
""" | 316 | 316 | """ | |
Unpull a card from the user's deck | 317 | 317 | Unpull a card from the user's deck | |
--- | 318 | 318 | --- | |
view_mocker: flashcards.api.mock_no_params | 319 | 319 | view_mocker: flashcards.api.mock_no_params |