Skip to content
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.

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

added paginated-videos api returning more video details #55

Merged
merged 4 commits into from
Jan 11, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
73 changes: 70 additions & 3 deletions app/today/views.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
from django.shortcuts import render
from typing import Optional

from rest_framework.request import Request
from rest_framework.response import Response
from rest_framework import viewsets
from rest_framework.decorators import action
from rest_framework.response import Response
from rest_framework import status
from django.utils import dateparse
from django.core import paginator

from today.models import Video
from today.serializers import VideoDetailsSerializer
Expand All @@ -18,9 +22,72 @@ class VideoDetailsViewSet(viewsets.ModelViewSet):
serializer_class = VideoDetailsSerializer

@action(detail=False, methods=["get"], url_path="latest")
def latest_video(self, request):
def latest_video(self, request: Request) -> Response:
"""
Fetches the most recently uploaded video
:param request: the HTTP request - unused param
:return: A JSON response with the latest video metadata and a 200 status code if successful, else 404 if no
videos are available
"""
recent_video = self.get_queryset().order_by("-upload_time").first()
if recent_video is not None:
serializer = self.get_serializer(recent_video)
return Response(serializer.data)
return Response({"detail": "No videos available"}, status=404)

@action(detail=False, methods=["get"], url_path="paginated-videos")
def paginated_videos(self, request: Request) -> Response:
"""
Fetches videos within a specified date range and paginates the results.

Query Parameters:
- start_date (str, optional): Filter videos uploaded on or after this date (YYYY-MM-DD).
- end_date (str, optional): Filter videos uploaded on or before this date (YYYY-MM-DD).
- page_num (int, optional): The page number to fetch (default is 1).
- limit (int, optional): The number of videos per page (default is 7).

:param request: The HTTP request containing query parameters.
:return: A JSON response containing paginated video data and metadata
"""
start_date = request.query_params.get("start_date")
end_date = request.query_params.get("end_date")
page_num = request.query_params.get("page_num", 1)
limit = request.query_params.get("limit", 7)

queryset = self.get_queryset()
if start_date is not None:
start_date_parsed = dateparse.parse_date(start_date)
if start_date_parsed is not None:
queryset = queryset.filter(upload_time__gte=start_date_parsed)
if end_date is not None:
end_date_parsed = dateparse.parse_date(end_date)
if end_date_parsed is not None:
queryset = queryset.filter(upload_time__lte=end_date_parsed)

queryset = queryset.order_by("-upload_time")

pages = paginator.Paginator(queryset, limit)
try:
videos_page = pages.page(page_num)
except paginator.PageNotAnInteger:
return Response({"detail": "Page number must be an integer"}, status=400)
except paginator.EmptyPage:
return Response({
"videos": [],
"detail": "Page number out of range - it's likely that no older videos are available",
"total_videos": pages.count,
"total_pages": pages.num_pages,
"current_page": page_num,
"has_next": False,
"has_previous": False,
}, status=200)

serializer = self.get_serializer(videos_page, many=True)
return Response({
"videos": serializer.data,
"total_videos": pages.count,
"total_pages": pages.num_pages,
"current_page": videos_page.number,
"has_next": videos_page.has_next(),
"has_previous": videos_page.has_previous(),
})
46 changes: 46 additions & 0 deletions frontend/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
"lint": "vue-cli-service lint"
},
"dependencies": {
"@fortawesome/fontawesome-svg-core": "^6.7.2",
"@fortawesome/free-solid-svg-icons": "^6.7.2",
"@fortawesome/vue-fontawesome": "^3.0.8",
"axios": "^1.7.7",
"core-js": "^3.8.3",
"vue": "^3.2.13",
Expand Down
Loading
Loading