Merge pull request #230 from mawoka-myblock/quiztivity

classquiz/__init__.py

@@ -33,6 +33,7 @@ from classquiz.routers import (
     results,
     admin,
     box_controller,
+    quiztivity,
 )
 from classquiz.socket_server import sio
 from classquiz.helpers import meilisearch_init, telemetry_ping, bg_tasks
@@ -86,6 +87,8 @@ async def auth_middleware_wrapper(request: Request, call_next):
     return await rememberme_middleware(request, call_next)
 
 
+app.include_router(quiztivity.router, tags=["quiztivity"], prefix="/api/v1/quiztivity", include_in_schema=True)
+
 app.include_router(
     box_controller.router, tags=["boxcontroller"], prefix="/api/v1/box-controller", include_in_schema=True
 )

classquiz/db/models.py

@@ -11,7 +11,9 @@ import ormar
 from pydantic import BaseModel, Json, validator
 from enum import Enum
 from . import metadata, database
+from .quiztivity import QuizTivityPage
 from ..config import server_regex
+from sqlalchemy import func
 
 
 class UserAuthTypes(Enum):
@@ -318,3 +320,59 @@ class GameResults(ormar.Model):
         tablename = "game_results"
         metadata = metadata
         database = database
+
+
+class QuizTivityInput(BaseModel):
+    title: str
+    pages: list[QuizTivityPage]
+
+
+class QuizTivity(ormar.Model):
+    id: uuid.UUID = ormar.UUID(primary_key=True)
+    title: str = ormar.Text(nullable=False)
+    created_at: datetime = ormar.DateTime(nullable=False, server_default=func.now())
+    user: User | None = ormar.ForeignKey(User)
+    pages: list[QuizTivityPage] = ormar.JSON(nullable=False)
+
+    class Meta:
+        tablename = "quiztivitys"
+        metadata = metadata
+        database = database
+
+
+class QuizTivityShare(ormar.Model):
+    id: uuid.UUID = ormar.UUID(primary_key=True)
+    name: str | None = ormar.Text(nullable=True)
+    expire_at: datetime | None = ormar.DateTime(nullable=True)
+    quiztivity: QuizTivity | None = ormar.ForeignKey(QuizTivity)
+    user: User | None = ormar.ForeignKey(User)
+
+    class Meta:
+        tablename = "quiztivityshares"
+        metadata = metadata
+        database = database
+
+
+class OnlyId(BaseModel):
+    id: uuid.UUID
+
+
+class PublicQuizTivityShare(BaseModel):
+    id: uuid.UUID
+    name: str | None
+    expire_in: int | None
+    quiztivity: OnlyId
+    user: OnlyId
+
+    @classmethod
+    def from_db_model(cls, data: QuizTivityShare):
+        expire_in = None
+        if data.expire_at is not None:
+            expire_in = int((data.expire_at - datetime.now()).seconds / 60)
+        return cls(
+            id=data.id,
+            name=data.name,
+            expire_in=expire_in,
+            quiztivity=OnlyId(id=data.quiztivity.id),
+            user=OnlyId(id=data.user.id),
+        )

classquiz/db/quiztivity.py

@@ -0,0 +1,50 @@
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+from pydantic import BaseModel
+import enum
+
+
+class Pdf(BaseModel):
+    url: str
+
+
+class _MemoryCard(BaseModel):
+    image: str | None
+    text: str | None
+    id: str
+
+
+class Memory(BaseModel):
+    cards: list[list[_MemoryCard]]
+
+
+class Markdown(BaseModel):
+    markdown: str
+
+
+class QuizTivityTypes(str, enum.Enum):
+    SLIDE = "SLIDE"
+    PDF = "PDF"
+    MEMORY = "MEMORY"
+    MARKDOWN = "MARKDOWN"
+
+
+TYPE_CLASS_LIST = {
+    QuizTivityTypes.PDF: type(Pdf),
+    QuizTivityTypes.MEMORY: type(Memory),
+    QuizTivityTypes.MARKDOWN: type(Markdown),
+}
+
+
+class QuizTivityPage(BaseModel):
+    title: str | None
+    type: QuizTivityTypes
+    data: Pdf | Memory | Markdown
+
+    # @validator("type")
+    # def match_type_to_data_type(cls, v, values, **kwargs):
+    #     print(values)
+    #     if TYPE_CLASS_LIST[v] != type(values["data"]):
+    #         raise ValueError("Specified Type doesn't match real data type")
+    #     pass

classquiz/routers/quiztivity/__init__.py

@@ -0,0 +1,65 @@
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+from uuid import UUID, uuid4
+
+from fastapi import APIRouter, Depends, HTTPException
+
+from classquiz.auth import get_current_user
+from datetime import datetime
+from classquiz.db.models import User, QuizTivityInput, QuizTivity, QuizTivityShare, PublicQuizTivityShare
+from classquiz.routers.quiztivity.shares import router as shares_router
+
+router = APIRouter()
+
+router.include_router(shares_router, prefix="/shares")
+
+
+@router.post("/create")
+async def create_quiztivity(data: QuizTivityInput, user: User = Depends(get_current_user)) -> QuizTivity:
+    quiztivity = QuizTivity.parse_obj({**data.dict(), "user": user, "id": uuid4(), "created_at": datetime.now()})
+    return await quiztivity.save()
+
+
+@router.get("/{uuid}")
+async def get_quiztivity(uuid: UUID) -> QuizTivity:
+    quiztivity = await QuizTivity.objects.get_or_none(id=uuid)
+    if quiztivity is None:
+        raise HTTPException(status_code=404, detail="QuizTivity not found")
+    return quiztivity
+
+
+@router.put("/{uuid}")
+async def put_quiztivity(data: QuizTivityInput, uuid: UUID, user: User = Depends(get_current_user)) -> QuizTivity:
+    quiztivity = await QuizTivity.objects.get_or_none(id=uuid, user=user)
+    if quiztivity is None:
+        raise HTTPException(status_code=404, detail="QuizTivity not found")
+    quiztivity.pages = data.dict()["pages"]
+    quiztivity.title = data.title
+    return await quiztivity.update()
+
+
+@router.delete("/{uuid}")
+async def delete_quiztivity(uuid: UUID):
+    quiztivity = await QuizTivity.objects.get_or_none(id=uuid)
+    if quiztivity is None:
+        raise HTTPException(status_code=404, detail="QuizTivity not found")
+    await quiztivity.delete()
+
+
+@router.get("/")
+async def get_all_quiztivities(user: User = Depends(get_current_user)) -> list[QuizTivity]:
+    quiztivities = await QuizTivity.objects.filter(user=user).order_by(QuizTivity.created_at.desc()).all()
+    return quiztivities
+
+
+@router.get("/{uuid}/shares")
+async def get_shares(uuid: UUID, user: User = Depends(get_current_user)) -> list[PublicQuizTivityShare]:
+    shares = (
+        await QuizTivityShare.objects.filter(quiztivity=uuid, user=user).order_by(QuizTivityShare.expire_at.asc()).all()
+    )
+    resp_shares = []
+    for share in shares:
+        resp_shares.append(PublicQuizTivityShare.from_db_model(share))
+    return resp_shares

classquiz/routers/quiztivity/shares.py

@@ -0,0 +1,82 @@
+#  This Source Code Form is subject to the terms of the Mozilla Public
+#  License, v. 2.0. If a copy of the MPL was not distributed with this
+#  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+from uuid import UUID, uuid4
+
+from fastapi import APIRouter, Depends, HTTPException
+from pydantic import BaseModel
+from datetime import datetime, timedelta
+
+from classquiz.auth import get_current_user
+from classquiz.db.models import User, QuizTivityShare, QuizTivity, PublicQuizTivityShare
+
+router = APIRouter()
+
+
+@router.get("/")
+async def get_shares(user: User = Depends(get_current_user)) -> list[PublicQuizTivityShare]:
+    shares = await QuizTivityShare.objects.filter(user=user).all()
+    resp_shares = []
+    for share in shares:
+        resp_shares.append(PublicQuizTivityShare.from_db_model(share))
+    return resp_shares
+
+
+class CreateShareInput(BaseModel):
+    name: str | None
+    quiztivity: UUID
+    expire_in: int | None
+
+
+@router.post("/")
+async def create_share(data: CreateShareInput, user: User = Depends(get_current_user)) -> PublicQuizTivityShare:
+    quiztivity = await QuizTivity.objects.get_or_none(id=data.quiztivity, user=user)
+    expire_at = None
+    if data.expire_in is not None:
+        expire_at = (datetime.now() + timedelta(minutes=data.expire_in)).replace(tzinfo=None)
+    if quiztivity is None:
+        raise HTTPException(status_code=400, detail="Quiztivity wasn't found")
+    share = await QuizTivityShare.objects.create(
+        id=uuid4(), name=data.name, expire_at=expire_at, quiztivity=quiztivity, user=user
+    )
+    share = PublicQuizTivityShare.from_db_model(share)
+    return share
+
+
+@router.delete("/{uuid}")
+async def delete_share(uuid: UUID, user: User = Depends(get_current_user)):
+    share = await QuizTivityShare.objects.get_or_none(id=uuid, user=user)
+    if share is None:
+        raise HTTPException(status_code=404, detail="Share wasn't found")
+    await share.delete()
+    return
+
+
+class UpdateShareInput(BaseModel):
+    name: str | None
+    expire_in: int | None
+
+
+@router.put("/{uuid}")
+async def update_share(
+    data: UpdateShareInput, uuid: UUID, user: User = Depends(get_current_user)
+) -> PublicQuizTivityShare:
+    share = await QuizTivityShare.objects.get_or_none(id=uuid, user=user)
+    if share is None:
+        raise HTTPException(status_code=404, detail="Share wasn't found")
+    expire_at = None
+    if data.expire_in is not None:
+        expire_at = (datetime.now() + timedelta(minutes=data.expire_in)).replace(tzinfo=None)
+    share.name = data.name
+    share.expire_at = expire_at
+    return PublicQuizTivityShare.from_db_model(await share.update())
+
+
+@router.get("/{uuid}")
+async def get_share(uuid: UUID) -> QuizTivity:
+    share = await QuizTivityShare.objects.select_related("quiztivity").get_or_none(id=uuid)
+    if share is None:
+        raise HTTPException(status_code=404, detail="Share not found")
+    if share.expire_at < datetime.now():
+        raise HTTPException(status_code=410, detail="Already expired")
+    return share.quiztivity