Archived
feat: bookmarks and notes management
- Backend: Django REST Framework API with Bookmark and Note models - ViewSets with user-scoped querysets and select_related for N+1 prevention - Create/List/Detail/Update/Delete endpoints - Batch delete operations - Unique constraint on user+book+page for bookmarks - IsOwner permission class for object-level access control - Full serializer validation (page > 0, non-empty content, duplicate check) - 30+ pytest-django tests covering CRUD, auth, filtering, edge cases - Frontend: React TypeScript components - AnnotationsContext with useReducer for state management - BookmarkList, NoteList, AddAnnotationForm, AnnotationsDashboard - Inline note editing with immediate save - Batch delete support - API client with JWT auto-refresh interceptors - Paginated query hook for infinite scroll support - Responsive CSS with loading/empty states - Infrastructure: Django project with custom User model, JWT auth, CORS - PostgreSQL database models with proper FK and indexes - Django admin configuration for all models
This commit is contained in:
@@ -0,0 +1,88 @@
|
||||
from django.shortcuts import get_object_or_404
|
||||
from rest_framework import parsers, permissions, status, viewsets
|
||||
from rest_framework.decorators import action
|
||||
from rest_framework.request import Request
|
||||
from rest_framework.response import Response
|
||||
|
||||
from books.models import Book, ReadingProgress, ReadingSettings
|
||||
from books.serializers import (
|
||||
BookDetailSerializer,
|
||||
BookListSerializer,
|
||||
BookUploadSerializer,
|
||||
ReadingProgressSerializer,
|
||||
ReadingSettingsSerializer,
|
||||
)
|
||||
|
||||
|
||||
class IsBookOwner(permissions.BasePermission):
|
||||
"""Only the owner of a book can access it."""
|
||||
|
||||
def has_object_permission(
|
||||
self, request: Request, view: object, obj: Book
|
||||
) -> bool:
|
||||
return obj.user == request.user
|
||||
|
||||
|
||||
class BookViewSet(viewsets.ModelViewSet):
|
||||
"""API endpoint for managing user books."""
|
||||
|
||||
parser_classes = [parsers.MultiPartParser, parsers.FormParser, parsers.JSONParser]
|
||||
permission_classes = [permissions.IsAuthenticated, IsBookOwner]
|
||||
|
||||
def get_serializer_class(self) -> type:
|
||||
if self.action == "create":
|
||||
return BookUploadSerializer
|
||||
if self.action == "list":
|
||||
return BookListSerializer
|
||||
return BookDetailSerializer
|
||||
|
||||
def get_queryset(self):
|
||||
return (
|
||||
Book.objects.filter(user=self.request.user)
|
||||
.select_related("reading_progress", "user")
|
||||
.prefetch_related()
|
||||
)
|
||||
|
||||
@action(detail=True, methods=["get", "patch"])
|
||||
def progress(self, request: Request, pk: int | None = None) -> Response:
|
||||
"""Get or update reading progress for a specific book."""
|
||||
book = self.get_object()
|
||||
progress, _created = ReadingProgress.objects.get_or_create(
|
||||
user=request.user,
|
||||
book=book,
|
||||
)
|
||||
|
||||
if request.method == "GET":
|
||||
serializer = ReadingProgressSerializer(progress)
|
||||
return Response(serializer.data)
|
||||
|
||||
serializer = ReadingProgressSerializer(progress, data=request.data, partial=True)
|
||||
serializer.is_valid(raise_exception=True)
|
||||
serializer.save()
|
||||
return Response(serializer.data)
|
||||
|
||||
|
||||
class ReadingSettingsViewSet(viewsets.GenericViewSet):
|
||||
"""API endpoint for user reading settings."""
|
||||
|
||||
permission_classes = [permissions.IsAuthenticated]
|
||||
serializer_class = ReadingSettingsSerializer
|
||||
|
||||
def get_queryset(self):
|
||||
return ReadingSettings.objects.filter(user=self.request.user)
|
||||
|
||||
def list(self, request: Request) -> Response:
|
||||
settings, _created = ReadingSettings.objects.get_or_create(
|
||||
user=request.user,
|
||||
)
|
||||
serializer = self.get_serializer(settings)
|
||||
return Response(serializer.data)
|
||||
|
||||
def partial_update(self, request: Request) -> Response:
|
||||
settings, _created = ReadingSettings.objects.get_or_create(
|
||||
user=request.user,
|
||||
)
|
||||
serializer = self.get_serializer(settings, data=request.data, partial=True)
|
||||
serializer.is_valid(raise_exception=True)
|
||||
serializer.save()
|
||||
return Response(serializer.data)
|
||||
Reference in New Issue
Block a user