diff options
author | 2020-12-05 17:18:18 +0000 | |
---|---|---|
committer | 2020-12-05 17:18:18 +0000 | |
commit | e1a628bf579d74cbd6923ea42a91dd00ff5e4e05 (patch) | |
tree | 888b9b093f825cf8afc25f3494482b2ad61a1db2 /backend | |
parent | Create review-policy.yml (diff) | |
parent | Create route for creating new forms (diff) |
Merge pull request #13 from python-discord/ks123/forms-routes
Diffstat (limited to 'backend')
-rw-r--r-- | backend/middleware.py | 4 | ||||
-rw-r--r-- | backend/models/form.py | 10 | ||||
-rw-r--r-- | backend/models/question.py | 31 | ||||
-rw-r--r-- | backend/routes/auth/authorize.py | 2 | ||||
-rw-r--r-- | backend/routes/forms/discover.py | 12 | ||||
-rw-r--r-- | backend/routes/forms/index.py | 11 | ||||
-rw-r--r-- | backend/routes/forms/new.py | 30 | ||||
-rw-r--r-- | backend/routes/forms/submit.py | 2 |
8 files changed, 72 insertions, 30 deletions
diff --git a/backend/middleware.py b/backend/middleware.py index cf46dc6..2267a9a 100644 --- a/backend/middleware.py +++ b/backend/middleware.py @@ -1,7 +1,7 @@ import typing as t -import pymongo import ssl +from motor.motor_asyncio import AsyncIOMotorClient from starlette.middleware.base import BaseHTTPMiddleware from starlette.requests import Request from starlette.responses import Response @@ -11,7 +11,7 @@ from backend.constants import DATABASE_URL, MONGO_DATABASE class DatabaseMiddleware(BaseHTTPMiddleware): async def dispatch(self, request: Request, call_next: t.Callable) -> Response: - client = pymongo.MongoClient( + client: AsyncIOMotorClient = AsyncIOMotorClient( DATABASE_URL, ssl_cert_reqs=ssl.CERT_NONE ) diff --git a/backend/models/form.py b/backend/models/form.py index d0f0a3c..a8c5f92 100644 --- a/backend/models/form.py +++ b/backend/models/form.py @@ -3,7 +3,7 @@ import typing as t from pydantic import BaseModel, Field, validator from backend.constants import FormFeatures -from backend.models import Question +from .question import Question class Form(BaseModel): @@ -13,12 +13,16 @@ class Form(BaseModel): features: t.List[str] questions: t.List[Question] + class Config: + allow_population_by_field_name = True + @validator("features") - def validate_features(self, value: t.List[str]) -> t.Optional[t.List[str]]: + def validate_features(cls, value: t.List[str]) -> t.Optional[t.List[str]]: """Validates is all features in allowed list.""" # Uppercase everything to avoid mixed case in DB value = [v.upper() for v in value] - if not all(v in FormFeatures.__members__.values() for v in value): + allowed_values = list(v.value for v in FormFeatures.__members__.values()) + if not all(v in allowed_values for v in value): raise ValueError("Form features list contains one or more invalid values.") if FormFeatures.COLLECT_EMAIL in value and FormFeatures.REQUIRES_LOGIN not in value: # noqa diff --git a/backend/models/question.py b/backend/models/question.py index 2324a47..1a012ff 100644 --- a/backend/models/question.py +++ b/backend/models/question.py @@ -1,6 +1,6 @@ import typing as t -from pydantic import BaseModel, Field, validator +from pydantic import BaseModel, Field, root_validator, validator from backend.constants import QUESTION_TYPES, REQUIRED_QUESTION_TYPE_DATA @@ -13,8 +13,11 @@ class Question(BaseModel): type: str data: t.Dict[str, t.Any] + class Config: + allow_population_by_field_name = True + @validator("type", pre=True) - def validate_question_type(self, value: str) -> t.Optional[str]: + def validate_question_type(cls, value: str) -> t.Optional[str]: """Checks if question type in currently allowed types list.""" value = value.lower() if value not in QUESTION_TYPES: @@ -25,30 +28,24 @@ class Question(BaseModel): return value - @validator("data") + @root_validator def validate_question_data( - self, + cls, value: t.Dict[str, t.Any] ) -> t.Optional[t.Dict[str, t.Any]]: """Check does required data exists for question type and remove other data.""" # When question type don't need data, don't add anything to keep DB clean. - if self.type not in REQUIRED_QUESTION_TYPE_DATA: - return {} - - # Required keys (and values) will be stored to here - # to remove all unnecessary stuff - result = {} + if value.get("type") not in REQUIRED_QUESTION_TYPE_DATA: + return value - for key, data_type in REQUIRED_QUESTION_TYPE_DATA[self.type].items(): - if key not in value: + for key, data_type in REQUIRED_QUESTION_TYPE_DATA[value.get("type")].items(): + if key not in value.get("data", {}): raise ValueError(f"Required question data key '{key}' not provided.") - if not isinstance(value[key], data_type): + if not isinstance(value["data"][key], data_type): raise ValueError( f"Question data key '{key}' expects {data_type.__name__}, " - f"got {type(value[key]).__name__} instead." + f"got {type(value['data'][key]).__name__} instead." ) - result[key] = value[key] - - return result + return value diff --git a/backend/routes/auth/authorize.py b/backend/routes/auth/authorize.py index 5de49f5..41c0a0b 100644 --- a/backend/routes/auth/authorize.py +++ b/backend/routes/auth/authorize.py @@ -25,7 +25,7 @@ class AuthorizeRoute(Route): bearer_token = await fetch_bearer_token(data["token"]) user_details = await fetch_user_details(bearer_token["access_token"]) - user_details["admin"] = request.state.db.admins.find_one( + user_details["admin"] = await request.state.db.admins.find_one( {"_id": user_details["id"]} ) is not None diff --git a/backend/routes/forms/discover.py b/backend/routes/forms/discover.py index ca36e93..af6066e 100644 --- a/backend/routes/forms/discover.py +++ b/backend/routes/forms/discover.py @@ -4,6 +4,7 @@ Return a list of all publicly discoverable forms to unauthenticated users. from starlette.requests import Request from starlette.responses import JSONResponse +from backend.models import Form from backend.route import Route @@ -17,11 +18,14 @@ class DiscoverableFormsList(Route): async def get(self, request: Request) -> JSONResponse: forms = [] + cursor = request.state.db.forms.find({"features": "DISCOVERABLE"}) - for form in request.state.db.forms.find({ - "features": "DISCOVERABLE" - }): - forms.append(form) + # Parse it to Form and then back to dictionary + # to replace _id with id + for form in await cursor.to_list(None): + forms.append(Form(**form)) + + forms = [form.dict() for form in forms] return JSONResponse( forms diff --git a/backend/routes/forms/index.py b/backend/routes/forms/index.py index 183d5cc..f1df210 100644 --- a/backend/routes/forms/index.py +++ b/backend/routes/forms/index.py @@ -1,10 +1,12 @@ """ Return a list of all forms to authenticated users. """ +from starlette.authentication import requires from starlette.requests import Request from starlette.responses import JSONResponse from backend.route import Route +from backend.models import Form class FormsList(Route): @@ -15,11 +17,16 @@ class FormsList(Route): name = "forms_list" path = "/" + @requires(["authenticated", "admin"]) async def get(self, request: Request) -> JSONResponse: forms = [] + cursor = request.state.db.forms.find() - for form in request.state.db.forms.find(): - forms.append(form) + for form in await cursor.to_list(None): + forms.append(Form(**form)) # For converting _id to id + + # Covert them back to dictionaries + forms = [form.dict() for form in forms] return JSONResponse( forms diff --git a/backend/routes/forms/new.py b/backend/routes/forms/new.py new file mode 100644 index 0000000..ff39f12 --- /dev/null +++ b/backend/routes/forms/new.py @@ -0,0 +1,30 @@ +""" +Creates new form based on data provided. +""" +from pydantic import ValidationError +from starlette.authentication import requires +from starlette.requests import Request +from starlette.responses import JSONResponse + +from backend.models import Form +from backend.route import Route + + +class FormCreate(Route): + """ + Creates new form from JSON data. + """ + + name = "forms_create" + path = "/new" + + @requires(["authenticated", "admin"]) + async def post(self, request: Request) -> JSONResponse: + form_data = await request.json() + try: + form = Form(**form_data) + except ValidationError as e: + return JSONResponse(e.errors()) + + await request.state.db.forms.insert_one(form.dict(by_alias=True)) + return JSONResponse(form.dict()) diff --git a/backend/routes/forms/submit.py b/backend/routes/forms/submit.py index f933367..a94a1c9 100644 --- a/backend/routes/forms/submit.py +++ b/backend/routes/forms/submit.py @@ -25,7 +25,7 @@ class SubmitForm(Route): async def post(self, request: Request) -> JSONResponse: data = await request.json() - if form := request.state.db.forms.find_one( + if form := await request.state.db.forms.find_one( {"_id": request.path_params["form_id"], "features": "OPEN"} ): response_obj = {} |