Merge pull request #72 from UNLV-CS472-672/#45-Booking_Expiry_Logic_and_Reviews_Model

#45 Booking Expiry Logic and Reviews Model

Author: ChrisCRL

backend/apps/bookings/admin.py

@@ -1,9 +1,24 @@
 from django.contrib import admin
-from .models import Booking
-
+from .models import Booking, Review
 
 @admin.register(Booking)
-class BookingAdmin(admin.ModelAdmin):
+class BookingsAdmin(admin.ModelAdmin):
     list_display = ('session_date', 'tutor', 'student', 'booking_status')
     search_fields = ('tutor__username', 'student__username', 'session_date')
     list_filter = ('booking_status',)
+
+@admin.register(Review)
+class ReviewAdmin(admin.ModelAdmin):
+    list_display = ['tutor', 'reviewer', 'rating', 'feedback', 'is_visible', 'is_moderated', 'created_at']
+    list_filter = ['is_visible', 'is_moderated', 'rating']
+    search_fields = ['reviewer__username', 'feedback']
+    list_editable = ['is_visible', 'is_moderated']  # Allow inline editing
+
+    def make_visible(self, request, queryset):
+        queryset.update(is_visible=True)
+
+    def make_invisible(self, request, queryset):
+        queryset.update(is_visible=False)
+
+    actions = [make_visible, make_invisible]
+

backend/apps/bookings/migrations/0002_booking_session_end_time_and_more.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.1.6 on 2025-03-19 03:15
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('bookings', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='booking',
+            name='session_end_time',
+            field=models.DateTimeField(null=True),
+        ),
+        migrations.AlterField(
+            model_name='booking',
+            name='booking_status',
+            field=models.CharField(choices=[('Pending', 'Pending'), ('Approved', 'Approved'), ('Rejected', 'Rejected'), ('Expired', 'Expired'), ('Cancelled', 'Cancelled'), ('Fulfilled', 'Fulfilled')], default='Pending', max_length=20),
+        ),
+    ]

backend/apps/bookings/migrations/0003_rename_booking_bookings_reviews.py

@@ -0,0 +1,37 @@
+# Generated by Django 5.1.6 on 2025-03-19 05:26
+
+import django.core.validators
+import django.db.models.deletion
+from django.conf import settings
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('bookings', '0002_booking_session_end_time_and_more'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='Booking',
+            new_name='Bookings',
+        ),
+        migrations.CreateModel(
+            name='Reviews',
+            fields=[
+                ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('rating', models.PositiveSmallIntegerField(validators=[django.core.validators.MinValueValidator(1), django.core.validators.MaxValueValidator(5)])),
+                ('feedback', models.TextField(blank=True, null=True)),
+                ('created_at', models.DateTimeField(auto_now_add=True)),
+                ('is_visible', models.BooleanField(default=True)),
+                ('is_moderated', models.BooleanField(default=False)),
+                ('reviewer', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='reviewer', to=settings.AUTH_USER_MODEL)),
+                ('tutor', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='reviews', to=settings.AUTH_USER_MODEL)),
+            ],
+            options={
+                'ordering': ['-created_at'],
+            },
+        ),
+    ]

backend/apps/bookings/migrations/0004_rename_bookings_booking_rename_reviews_review.py

@@ -0,0 +1,23 @@
+# Generated by Django 5.1.6 on 2025-03-19 05:38
+
+from django.conf import settings
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('bookings', '0003_rename_booking_bookings_reviews'),
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
+    ]
+
+    operations = [
+        migrations.RenameModel(
+            old_name='Bookings',
+            new_name='Booking',
+        ),
+        migrations.RenameModel(
+            old_name='Reviews',
+            new_name='Review',
+        ),
+    ]

backend/apps/bookings/models.py

@@ -1,26 +1,35 @@
+from django.core.validators import MinValueValidator, MaxValueValidator
 from django.db import models
 from django.contrib.auth.models import User
 import uuid
 from datetime import timedelta
 from django.utils.timezone import now
+from rest_framework.exceptions import ValidationError
 
 
 class Booking(models.Model):
     PENDING = 'Pending'
     APPROVED = 'Approved'
     REJECTED = 'Rejected'
+    EXPIRED = 'Expired'
+    CANCELLED = 'Cancelled'
+    FULFILLED = 'Fulfilled'
 
     BOOKING_STATUS_TYPES = [
         (PENDING, 'Pending'),
         (APPROVED, 'Approved'),
         (REJECTED, 'Rejected'),
+        (EXPIRED, 'Expired'),
+        (CANCELLED, 'Cancelled'),
+        (FULFILLED, 'Fulfilled'),
     ]
 
     session_date = models.DateTimeField()
     session_updated_at = models.DateTimeField(auto_now=True)
+    session_end_time = models.DateTimeField(null=True)
     booking_status = models.CharField(max_length=20, choices=BOOKING_STATUS_TYPES, default=PENDING)
     session_price = models.DecimalField(max_digits=10, decimal_places=2)
-    student = models.ForeignKey(User, on_delete=models.CASCADE, related_name="student")
+    student = models.ForeignKey(User, on_delete=models.CASCADE, related_name="student_bookings")
     tutor = models.ForeignKey(User, on_delete=models.CASCADE, related_name="tutor")
     description = models.TextField(null=True, blank=True)
     payment_gateway_ref = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
@@ -39,19 +48,65 @@ def is_paid(self):
         return self.payment_gateway_ref is not None
 
     def reschedule_booking(self, new_date):
+        if self.session_date < now():
+            return False
         self.session_date = new_date
         self.save()
 
     def cancel_booking(self):
         if self.session_date < now():
             return False
         self.booking_status = self.REJECTED
-        self.save()
+        self.save(update_fields=['booking_status'])
         return True
 
-    def booking_end_time(self, duration_in_minutes=60):
-        return self.session_date + timedelta(minutes=duration_in_minutes)
+    def booking_duration(self):
+        if not self.session_end_time:
+            return timedelta(0)
+        return self.session_end_time - self.session_date
 
     @classmethod
     def get_bookings_by_status(cls, status):
         return cls.objects.filter(booking_status=status)
+
+    def is_expired(self):
+        return self.session_end_time < now()
+
+    def clean(self):
+        if self.session_end_time <= self.session_date:
+            raise ValidationError("Session end time must be after the session start time.")
+
+    def save(self, *args, **kwargs):
+        """Run full validation before saving."""
+        self.full_clean()  # Ensures validation runs before saving
+        super().save(*args, **kwargs)
+
+
+class Review(models.Model):
+    tutor = models.ForeignKey(User, on_delete=models.CASCADE, related_name="reviews")
+    reviewer = models.ForeignKey(User, on_delete=models.CASCADE, related_name="reviewer")
+    rating = models.PositiveSmallIntegerField(validators=[MinValueValidator(1), MaxValueValidator(5)])
+    feedback = models.TextField(null=True, blank=True)
+    created_at = models.DateTimeField(auto_now_add=True)
+
+    is_visible = models.BooleanField(default=True)  # Whether the review is visible to others
+    is_moderated = models.BooleanField(
+        default=False)  # Whether the review has been moderated (e.g., checked for inappropriate content)
+
+    def __str__(self):
+        return f"Review for {self.tutor.username} by {self.reviewer.username}"
+
+    class Meta:
+        ordering = ['-created_at']  # Sort reviews by most recent first
+        unique_together = ('tutor', 'reviewer')
+
+    def is_valid_review(self):
+        """Checks if the review has a valid rating and comments."""
+        return self.rating is not None and self.feedback.strip() != ""
+
+    @staticmethod
+    def average_rating(tutor):
+        """Calculates the average rating for a tutor based on all reviews."""
+        reviews = Review.objects.filter(tutor=tutor)
+        total_rating = sum([review.rating for review in reviews])
+        return total_rating / len(reviews) if reviews else 0

backend/apps/bookings/serializers.py

@@ -1,5 +1,5 @@
 from rest_framework import serializers
-from .models import Booking
+from .models import Booking, Review
 
 
 class BookingSerializer(serializers.ModelSerializer):
@@ -18,3 +18,8 @@ class Meta(BookingSerializer.Meta):
             'booking': {'read_only': True}
         }
 
+class ReviewSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = Review
+        fields = ['tutor', 'reviewer', 'rating', 'feedback', 'created_at', 'is_visible', 'is_moderated']
+        read_only_fields = ['created_at', 'is_visible', 'is_moderated']

backend/apps/bookings/tasks.py

@@ -0,0 +1,17 @@
+from datetime import timedelta
+from celery import shared_task
+from django.utils import timezone
+from .models import Booking
+
+@shared_task
+def mark_expired_bookings():
+    threshold_time = timezone.now() - timedelta(weeks=1)
+    expired_bookings = Booking.objects.filter(session_date__lt=threshold_time, booking_status="Approved")
+    expired_count = expired_bookings.update(booking_status="Expired")
+    return f"Marked {expired_count} bookings as expired"
+
+@shared_task
+def delete_rejected_bookings():
+    threshold_time = timezone.now() - timedelta(hours=24)
+    deleted_count, _ = Booking.objects.filter(booking_status="Rejected", session_end_time__lt=threshold_time).delete()
+    return f"Deleted {deleted_count} rejected bookings older than 24 hours."

backend/apps/bookings/urls.py

@@ -1,10 +1,12 @@
 from django.urls import path, include
 from rest_framework.routers import DefaultRouter
-from .views import BookingViewSet
+from . import views
 
 router = DefaultRouter()
-router.register(r'bookings', BookingViewSet)
+router.register(r'bookings', views.BookingViewSet)
 
 urlpatterns = [
-    path('api/', include(router.urls), name='bookings-api'),
+    path('', include(router.urls), name='bookings_api'),
+    path('reviews/', views.get_reviews, name='get_reviews'),
+    path('reviews/submit/', views.submit_review, name='submit_reviews'),
 ]

backend/apps/bookings/views.py

@@ -1,6 +1,8 @@
-from rest_framework import viewsets
-from .models import Booking
-from .serializers import BookingSerializer
+from rest_framework import viewsets, status
+from rest_framework.decorators import api_view
+from rest_framework.response import Response
+from .models import Booking, Review
+from .serializers import BookingSerializer, ReviewSerializer
 from rest_framework.permissions import IsAuthenticated
 
 
@@ -17,4 +19,26 @@ def get_queryset(self):
         user = self.request.user
         if user.is_staff:
             return Booking.objects.all()
-        return Booking.objects.filter(student=user) | Booking.objects.filter(tutor=user)
+        return Booking.objects.filter(student=user) | Booking.objects.filter(tutor=user)
+
+# GET /api/reviews/ - Get all reviews
+@api_view(['GET'])
+def get_reviews(request):
+    reviews = Review.objects.filter(is_visible=True)  # Only show visible reviews
+    serializer = ReviewSerializer(reviews, many=True)
+    return Response(serializer.data)
+
+
+# POST /api/reviews/ - Submit a new review
+@api_view(['POST'])
+def submit_review(request):
+    # Check if the required data exists in the request
+    if 'tutor' not in request.data or 'rating' not in request.data or 'feedback' not in request.data:
+        return Response({"error": "Missing required fields."}, status=status.HTTP_400_BAD_REQUEST)
+
+    serializer = ReviewSerializer(data=request.data)
+
+    if serializer.is_valid():
+        serializer.save(reviewer=request.user)  # Associate the logged-in user as the student
+        return Response(serializer.data, status=status.HTTP_201_CREATED)
+    return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)