Merge pull request #8 from Tech-JI/restful/main

fix all the existing issues

Author: PACHAKUTlQ

.husky/pre-commit

@@ -0,0 +1,9 @@
+repos:
+  - repo: local
+    hooks:
+      - id: format-and-add
+        name: Format code and stage changes
+        entry: uv run scripts/pre-commit-format.py
+        language: system
+        pass_filenames: false
+        always_run: true

.pre-commit-config.yaml

@@ -31,11 +31,6 @@ def vote(self, value, course_id, category, user):
         else:
             vote.value = value
             vote.save()
-            # add the new value of the vote
-            if category == Vote.CATEGORIES.QUALITY:
-                course.quality_score += vote.value
-            elif category == Vote.CATEGORIES.DIFFICULTY:
-                course.difficulty_score += vote.value
 
         new_score = self._calculate_average_score(course, category)
         if category == Vote.CATEGORIES.QUALITY:

apps/web/models/vote.py

@@ -22,7 +22,7 @@
     authentication_classes,
     permission_classes,
 )
-from rest_framework.permissions import AllowAny
+from rest_framework.permissions import AllowAny, IsAuthenticated
 from rest_framework.response import Response
 
 
@@ -377,7 +377,7 @@ def course_search_api(request):
 
 
 @api_view(["GET"])
-@permission_classes([AllowAny])
+@permission_classes([IsAuthenticated])
 def course_review_search_api(request, course_id):
     try:
         course = Course.objects.get(pk=course_id)
@@ -388,9 +388,7 @@ def course_review_search_api(request, course_id):
     reviews = course.search_reviews(query)
     review_count = reviews.count()
 
-    if not request.user.is_authenticated:
-        reviews = reviews[: LIMITS["unauthenticated_review_search"]]
-
+    # Since we now require authentication, no need to limit reviews
     serializer = ReviewSerializer(reviews, many=True, context={"request": request})
 
     return Response(
@@ -399,11 +397,7 @@ def course_review_search_api(request, course_id):
             "course_id": course.id,
             "course_short_name": course.short_name(),
             "reviews_full_count": review_count,
-            "remaining": (
-                review_count - LIMITS["unauthenticated_review_search"]
-                if review_count > LIMITS["unauthenticated_review_search"]
-                else 0
-            ),
+            "remaining": 0,  # No remaining since user is authenticated
             "reviews": serializer.data,
         }
     )

apps/web/views.py

@@ -18,9 +18,11 @@ Environment:
 
 4. `uv sync`
 
-5. Make directory for builds of static files: `mkdir staticfiles`
+5. `uv run pre-commit install` (for installing git hook in .git)
 
-6. Create .env file for storing secrets. The contents should be like:
+6. Make directory for builds of static files: `mkdir staticfiles`
+
+7. Create .env file for storing secrets. The contents should be like:
 
    ```ini
    # PostgreSQL
@@ -34,9 +36,9 @@ Environment:
    OFFERINGS_THRESHOLD_FOR_TERM_UPDATE=100
    ```
 
-7. Build static files: `make collect`
+8. Build static files: `make collect`
 
-8. Configure database
+9. Configure database
 
    1. Install Postgres:
 
@@ -89,11 +91,11 @@ Environment:
 
    10. Auto setup database connection and static file routes in Django: `make migrate`, `make makemigrations`
 
-9. Install cache database redis: `sudo apt install redis-server`, `sudo systemctl start redis`. Run `sudo systemctl enable redis` to auto-start redis service on start-up.
+10. Install cache database valkey: `sudo apt install valkey`, `sudo systemctl start valkey`. Run `sudo systemctl enable valkey` to auto-start valkey service on start-up.
 
-10. `make run` and visit <http://127.0.0.1:8000/>
+11. `make run` and visit <http://127.0.0.1:8000/>
 
-11. Add local admin:
+12. Add local admin:
 
     1. `make createsuperuser`. The email can be blank. Use a strong password in production.
 
@@ -110,7 +112,7 @@ Environment:
        u.save()
        ```
 
-12. Crawl data from JI official website:
+13. Crawl data from JI official website:
 
     1. Edit `COURSE_DETAIL_URL_PREFIX` in `apps/spider/crawlers/orc.py`: Add a number after url param `id` like this: `...?id=23`, so only course id starting from 23 (e.g. 230-239, 2300) will be crawled, so as to save time during development. Remember not to commit this change.
 
@@ -123,4 +125,4 @@ Environment:
        crawl_and_import_data()
        ```
 
-13. Run frontend (dev mode): `make dev-frontend` and visit http://127.0.0.1:5173/
+14. Run frontend (dev mode): `make dev-frontend` and visit http://127.0.0.1:5173/

docs/Setup.md

@@ -26,3 +26,8 @@ dependencies = [
 
 [tool.uv]
 package = false
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.3.0",
+]

docs/Structure.md

@@ -0,0 +1,27 @@
+#!/usr/bin/env python3
+
+import subprocess
+import sys
+
+
+def main():
+    """Pre-commit formatting script"""
+    print("Running formatter...")
+
+    try:
+        # Run make format and capture exit code
+        result = subprocess.run(["make", "format"], check=True)
+
+        # Format succeeded, stage the changes
+        subprocess.run(["git", "add", "--update"], check=True)
+        print("formatted.")
+        return 0
+
+    except subprocess.CalledProcessError:
+        # Format failed, stop the commit
+        print("ERROR: Formatting failed! Commit aborted.")
+        return 1
+
+
+if __name__ == "__main__":
+    sys.exit(main())