Improve controller files structure

Author: arquejadalucy

source/__init__.py

@@ -2,7 +2,18 @@
 from dotenv import load_dotenv
 import os
 
-load_dotenv()
+# load_dotenv()
+#
+# client = motor.motor_asyncio.AsyncIOMotorClient(os.getenv("MONGO_URI"))
+# db = client.college
 
-client = motor.motor_asyncio.AsyncIOMotorClient(os.getenv("MONGO_URI"))
-db = client.college
+FIREBASE_CONFIG = {
+    "apiKey": "AIzaSyDp_XqMeP6rQ061y6M9mtlPp-JFatYBa-4",
+    "authDomain": "crawler-jus.firebaseapp.com",
+    "databaseURL": "https://crawler-jus-default-rtdb.firebaseio.com",
+    "projectId": "crawler-jus",
+    "storageBucket": "crawler-jus.appspot.com",
+    "messagingSenderId": "654136178133",
+    "appId": "1:654136178133:web:42658f521054817806395c",
+    "measurementId": "G-QN0D2Q1SF7"
+}

source/config/settings.py

@@ -1,37 +1,18 @@
-import firebase_admin
-import pyrebase
-from firebase_admin import credentials
 from cerberus import Validator
-from fastapi import FastAPI, Request, Form
-from fastapi.responses import HTMLResponse
-from fastapi.staticfiles import StaticFiles
-from fastapi.templating import Jinja2Templates
-
+from fastapi import APIRouter
 from source.services.collect import search_process_data
 from source.models.NumeroProcessoInfo import NumeroProcessoInfo
 from source.models.ProcessoRequestBody import ProcessRequestBody
 from source.services.validate import process_request_informations_schema, id_processo_schema, \
     ProcessNumberRegexErrorHandler
 
-app = FastAPI()
-validator = Validator(error_handler=ProcessNumberRegexErrorHandler)
-
-if not firebase_admin._apps:
-    cred = credentials.Certificate("/Users/lucyvelasco/PycharmProjects/jus_crawler/serviceAccount.json")
-    firebase_admin.initialize_app(cred)
 
-firebaseConfig = {
-    "apiKey": "AIzaSyDp_XqMeP6rQ061y6M9mtlPp-JFatYBa-4",
-    "authDomain": "crawler-jus.firebaseapp.com",
-    "databaseURL": "https://crawler-jus-default-rtdb.firebaseio.com",
-    "projectId": "crawler-jus",
-    "storageBucket": "crawler-jus.appspot.com",
-    "messagingSenderId": "654136178133",
-    "appId": "1:654136178133:web:42658f521054817806395c",
-    "measurementId": "G-QN0D2Q1SF7"
-}
+router = APIRouter(
+    prefix="/processos",
+    tags=["processos"]
+)
 
-firebase = pyrebase.initialize_app(firebaseConfig)
+validator = Validator(error_handler=ProcessNumberRegexErrorHandler)
 
 
 def valid_request(processo_info: NumeroProcessoInfo):
@@ -42,22 +23,7 @@ def valid_process_id(numero_processo: str):
     return validator.validate({"numero_processo": numero_processo}, id_processo_schema)
 
 
-@app.post("/cadastro")
-async def create_an_account():
-    pass
-
-
-@app.post("/login")
-async def create_access_token():
-    pass
-
-
-@app.post("/ping")
-async def validate_token():
-    pass
-
-
-@app.post("/processo")
+@router.post("/busca")
 def buscar_processo(process_request: ProcessRequestBody):
     """
     API que busca dados de um processo em todos os graus dos Tribunais de Justiça de Alagoas (TJAL) e do Ceará (TJCE).
@@ -92,7 +58,7 @@ def buscar_processo(process_request: ProcessRequestBody):
     return response
 
 
-@app.get("/processo/{id_processo}")
+@router.get("/{id_processo}")
 def get_processo_info_by_id(id_processo: str):
     """
     API que busca dados de um processo em todos os graus dos Tribunais de Justiça de Alagoas (TJAL) e do Ceará (TJCE).
@@ -123,19 +89,3 @@ def get_processo_info_by_id(id_processo: str):
     if not valid_request(processo_info):
         return validator.errors
     return search_process_data(processo_info)
-
-
-def get_jinja_templates():
-    app.mount("/static", StaticFiles(directory="front-end/static"), name="static")
-    return Jinja2Templates(directory="front-end/templates")
-
-
-@app.post('/buscaprocesso', include_in_schema=False)
-def buscar_processo_pelo_form(request: Request, id_processo: str = Form()):
-    result = get_processo_info_by_id(id_processo)
-    return get_jinja_templates().TemplateResponse('processo.html', {'request': request, 'result': result})
-
-
-@app.get('/', response_class=HTMLResponse, include_in_schema=False)
-def main(request: Request):
-    return get_jinja_templates().TemplateResponse('home.html', {'request': request})

source/controller/__init__.py

@@ -0,0 +1,34 @@
+import pyrebase
+import firebase_admin
+from fastapi import APIRouter
+from firebase_admin import credentials
+from source.config.settings import FIREBASE_CONFIG
+from source.schemas.AuthenticationSchemas import SignUpSchema
+
+if not firebase_admin._apps:
+    cred = credentials.Certificate("/Users/lucyvelasco/PycharmProjects/jus_crawler/serviceAccount.json")
+    firebase_admin.initialize_app(cred)
+
+firebase = pyrebase.initialize_app(FIREBASE_CONFIG)
+
+router = APIRouter(
+    prefix="/users",
+    tags=["users"]
+)
+
+
+@router.post("/cadastro")
+async def create_an_account(user_data: SignUpSchema):
+    email = user_data.email
+    password = user_data.password
+    pass
+
+
+@router.post("/login")
+async def create_access_token():
+    pass
+
+
+@router.post("/ping")
+async def validate_token():
+    pass

source/controller/routes.py renamed to source/controller/processos.py

@@ -0,0 +1,13 @@
+from typing import Annotated
+
+from fastapi import Header, HTTPException
+
+
+async def get_token_header(x_token: Annotated[str, Header()]):
+    if x_token != "fake-super-secret-token":
+        raise HTTPException(status_code=400, detail="X-Token header invalid")
+
+
+async def get_query_token(token: str):
+    if token != "jessica":
+        raise HTTPException(status_code=400, detail="No Jessica token provided")

source/controller/users.py

@@ -0,0 +1,27 @@
+from fastapi import FastAPI, Request, Form
+from fastapi.responses import HTMLResponse
+from fastapi.staticfiles import StaticFiles
+from fastapi.templating import Jinja2Templates
+
+from source.controller.processos import get_processo_info_by_id
+from source.controller import processos, users
+
+app = FastAPI()
+app.include_router(users.router)
+app.include_router(processos.router)
+
+
+def get_jinja_templates():
+    app.mount("/static", StaticFiles(directory="front-end/static"), name="static")
+    return Jinja2Templates(directory="front-end/templates")
+
+
+@app.get('/', response_class=HTMLResponse, tags=["home"], include_in_schema=False)
+def main(request: Request):
+    return get_jinja_templates().TemplateResponse('home.html', {'request': request})
+
+
+@app.post('/buscaprocesso', include_in_schema=False)
+def buscar_processo_pelo_form(request: Request, id_processo: str = Form()):
+    result = get_processo_info_by_id(id_processo)
+    return get_jinja_templates().TemplateResponse('processo.html', {'request': request, 'result': result})

source/dependencies.py

@@ -0,0 +1,27 @@
+from pydantic import BaseModel
+
+
+class SignUpSchema(BaseModel):
+    email: str
+    password: str
+
+    class Config:
+        schema_extra = {
+            "example": {
+                "email": "[email protected]",
+                "password": "samplepass123"
+            }
+        }
+
+
+class LoginSchema(BaseModel):
+    email: str
+    password: str
+
+    class Config:
+        schema_extra = {
+            "example": {
+                "email": "[email protected]",
+                "password": "samplepass123"
+            }
+        }

source/main.py

@@ -8,7 +8,7 @@
 
 from fastapi.testclient import TestClient
 
-from source.controller.routes import app
+from source.controller.processos import app
 from source.services.validate import validate_process_number_message
 from Stubs import get_request_body_json_test, \
     NUMERO_PROCESSO_TRIBUNAL_INVALIDO, TRIBUNAL_NAO_SUPORTADO, \