From d3a76b81063ec14d43bed62ca5480b8e8d84cb96 Mon Sep 17 00:00:00 2001 From: keven Date: Mon, 20 Oct 2025 15:41:19 -0300 Subject: [PATCH] [MVPTN-29] feat(CRUD): Criar o CRUD de Gramatica --- .../g_gramatica/g_gramatica_delete_action.py | 33 ++++++ .../g_gramatica/g_gramatica_index_action.py | 35 ++++++ .../g_gramatica/g_gramatica_save_action.py | 36 +++++++ .../g_gramatica/g_gramatica_show_action.py | 36 +++++++ .../g_gramatica/g_gramatica_update_action.py | 36 +++++++ .../controllers/g_gramatica_controller.py | 101 ++++++++++++++++++ .../endpoints/g_gramatica_endpoint.py | 94 ++++++++++++++++ .../g_gramatica_delete_repository.py | 45 ++++++++ .../g_gramatica_index_repository.py | 26 +++++ .../g_gramatica_save_repository.py | 50 +++++++++ .../g_gramatica_show_repository.py | 67 ++++++++++++ .../g_gramatica_update_repository.py | 61 +++++++++++ .../schemas/g_gramatica_schema.py | 59 ++++++++++ .../go/g_gramatica_delete_service.py | 35 ++++++ .../go/g_gramatica_index_service.py | 44 ++++++++ .../go/g_gramatica_save_service.py | 44 ++++++++ .../go/g_gramatica_show_service.py | 45 ++++++++ .../go/g_gramatica_update_service.py | 30 ++++++ packages/v1/api.py | 7 +- 19 files changed, 883 insertions(+), 1 deletion(-) create mode 100644 packages/v1/administrativo/actions/g_gramatica/g_gramatica_delete_action.py create mode 100644 packages/v1/administrativo/actions/g_gramatica/g_gramatica_index_action.py create mode 100644 packages/v1/administrativo/actions/g_gramatica/g_gramatica_save_action.py create mode 100644 packages/v1/administrativo/actions/g_gramatica/g_gramatica_show_action.py create mode 100644 packages/v1/administrativo/actions/g_gramatica/g_gramatica_update_action.py create mode 100644 packages/v1/administrativo/controllers/g_gramatica_controller.py create mode 100644 packages/v1/administrativo/endpoints/g_gramatica_endpoint.py create mode 100644 packages/v1/administrativo/repositories/g_gramatica/g_gramatica_delete_repository.py create mode 100644 packages/v1/administrativo/repositories/g_gramatica/g_gramatica_index_repository.py create mode 100644 packages/v1/administrativo/repositories/g_gramatica/g_gramatica_save_repository.py create mode 100644 packages/v1/administrativo/repositories/g_gramatica/g_gramatica_show_repository.py create mode 100644 packages/v1/administrativo/repositories/g_gramatica/g_gramatica_update_repository.py create mode 100644 packages/v1/administrativo/schemas/g_gramatica_schema.py create mode 100644 packages/v1/administrativo/services/g_gramatica/go/g_gramatica_delete_service.py create mode 100644 packages/v1/administrativo/services/g_gramatica/go/g_gramatica_index_service.py create mode 100644 packages/v1/administrativo/services/g_gramatica/go/g_gramatica_save_service.py create mode 100644 packages/v1/administrativo/services/g_gramatica/go/g_gramatica_show_service.py create mode 100644 packages/v1/administrativo/services/g_gramatica/go/g_gramatica_update_service.py diff --git a/packages/v1/administrativo/actions/g_gramatica/g_gramatica_delete_action.py b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_delete_action.py new file mode 100644 index 0000000..20ddc4f --- /dev/null +++ b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_delete_action.py @@ -0,0 +1,33 @@ +from abstracts.action import BaseAction +from api.packages.v1.administrativo.repositories.g_gramatica.g_gramatica_delete_repository import GGramaticaDeleteRepository +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaIdSchema + + +class GGramaticaDeleteAction(BaseAction): + """ + Serviço responsável por encapsular a lógica de negócio para a operação + de exclusão de um registro na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_id_schema: GGramaticaIdSchema): + """ + Executa a operação de exclusão no banco de dados. + + Args: + g_gramatica_id_schema (GGramaticaIdSchema): + O esquema contendo o ID do registro a ser excluído. + + Returns: + O resultado da operação de exclusão. + """ + # ---------------------------------------------------- + # Instanciamento do repositório + # ---------------------------------------------------- + g_gramatica_delete_repository = GGramaticaDeleteRepository() + + # ---------------------------------------------------- + # Execução da exclusão + # ---------------------------------------------------- + response = g_gramatica_delete_repository.execute(g_gramatica_id_schema) + + return response diff --git a/packages/v1/administrativo/actions/g_gramatica/g_gramatica_index_action.py b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_index_action.py new file mode 100644 index 0000000..164b3f6 --- /dev/null +++ b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_index_action.py @@ -0,0 +1,35 @@ +from abstracts.action import BaseAction +from api.packages.v1.administrativo.repositories.g_gramatica.g_gramatica_index_repository import GGramaticaIndexRepository + + +class GGramaticaIndexAction(BaseAction): + """ + Serviço responsável por encapsular a lógica de negócio para a operação + de listagem de todos os registros na tabela G_NATUREZA_TITULO. + """ + + def execute(self): + """ + Executa a operação de listagem no banco de dados. + + Args: + g_gramatica_index_schema (GGramaticaIndexSchema): + Esquema contendo parâmetros opcionais de filtro. + + Returns: + A lista de registros encontrados. + """ + # ---------------------------------------------------- + # Instanciamento do repositório + # ---------------------------------------------------- + g_gramatica_index_repository = GGramaticaIndexRepository() + + # ---------------------------------------------------- + # Execução do repositório + # ---------------------------------------------------- + response = g_gramatica_index_repository.execute() + + # ---------------------------------------------------- + # Retorno da informação + # -------------------------------- + return response diff --git a/packages/v1/administrativo/actions/g_gramatica/g_gramatica_save_action.py b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_save_action.py new file mode 100644 index 0000000..26f8385 --- /dev/null +++ b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_save_action.py @@ -0,0 +1,36 @@ +from abstracts.action import BaseAction +from api.packages.v1.administrativo.repositories.g_gramatica.g_gramatica_save_repository import GGramaticaSaveRepository +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaSaveSchema + + +class GGramaticaSaveAction(BaseAction): + """ + Serviço responsável por encapsular a lógica de negócio para a operação + de salvamento de um novo registro na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_save_schema: GGramaticaSaveSchema): + """ + Executa a operação de salvamento. + + Args: + g_gramatica_schema (GGramaticaSchema): + O esquema com os dados a serem persistidos. + + Returns: + O resultado da operação de salvamento. + """ + # ---------------------------------------------------- + # Instanciamento do repositório + # ---------------------------------------------------- + g_gramatica_save_repository = GGramaticaSaveRepository() + + # ---------------------------------------------------- + # Execução do repositório + # ---------------------------------------------------- + response = g_gramatica_save_repository.execute(g_gramatica_save_schema) + + # ---------------------------------------------------- + # Retorno da informação + # ---------------------------------------------------- + return response diff --git a/packages/v1/administrativo/actions/g_gramatica/g_gramatica_show_action.py b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_show_action.py new file mode 100644 index 0000000..52e1921 --- /dev/null +++ b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_show_action.py @@ -0,0 +1,36 @@ +from abstracts.action import BaseAction +from api.packages.v1.administrativo.repositories.g_gramatica.g_gramatica_show_repository import GGramaticaShowRepository +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaIdSchema + + +class GGramaticaShowAction(BaseAction): + """ + Serviço responsável por encapsular a lógica de negócio para a exibição + de um registro na tabela G_NATUREZA_TITULO. + """ + + def execute(self, g_gramatica_id_schema: GGramaticaIdSchema): + """ + Executa a operação de exibição. + + Args: + g_gramatica_id_schema (GGramaticaIdSchema): + O esquema com o ID do registro a ser exibido. + + Returns: + O resultado da operação de exibição. + """ + # ---------------------------------------------------- + # Instanciamento do repositório + # ---------------------------------------------------- + g_gramatica_show_repository = GGramaticaShowRepository() + + # ---------------------------------------------------- + # Execução do repositório + # ---------------------------------------------------- + response = g_gramatica_show_repository.execute(g_gramatica_id_schema) + + # ---------------------------------------------------- + # Retorno da informação + # ---------------------------------------------------- + return response diff --git a/packages/v1/administrativo/actions/g_gramatica/g_gramatica_update_action.py b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_update_action.py new file mode 100644 index 0000000..ea97d7e --- /dev/null +++ b/packages/v1/administrativo/actions/g_gramatica/g_gramatica_update_action.py @@ -0,0 +1,36 @@ +from abstracts.action import BaseAction +from api.packages.v1.administrativo.repositories.g_gramatica.g_gramatica_update_repository import GGramaticaUpdateRepository +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaUpdateSchema + + +class GGramaticaUpdateAction(BaseAction): + """ + Serviço responsável por encapsular a lógica de negócio para a atualização + de um registro na tabela G_NATUREZA_TITULO. + """ + + def execute(self, g_gramatica_update_schema: GGramaticaUpdateSchema): + """ + Executa a operação de atualização. + + Args: + g_gramatica_update_schema (GGramaticaUpdateSchema): + O esquema com os dados a serem atualizados. + + Returns: + O resultado da operação de atualização. + """ + # ---------------------------------------------------- + # Instanciamento do repositório de atualização + # ---------------------------------------------------- + g_gramatica_update_repository = GGramaticaUpdateRepository() + + # ---------------------------------------------------- + # Execução do repositório + # ---------------------------------------------------- + response = g_gramatica_update_repository.execute(g_gramatica_update_schema) + + # ---------------------------------------------------- + # Retorno do resultado + # ---------------------------------------------------- + return response diff --git a/packages/v1/administrativo/controllers/g_gramatica_controller.py b/packages/v1/administrativo/controllers/g_gramatica_controller.py new file mode 100644 index 0000000..a716363 --- /dev/null +++ b/packages/v1/administrativo/controllers/g_gramatica_controller.py @@ -0,0 +1,101 @@ +from actions.dynamic_import.dynamic_import import DynamicImport +from packages.v1.administrativo.schemas.g_gramatica_schema import ( + GGramaticaSaveSchema, + GGramaticaUpdateSchema, + GGramaticaIdSchema +) + + +class GGramaticaController: + """ + Controller responsável por orquestrar as operações CRUD da tabela G_GRAMATICA, + utilizando carregamento dinâmico de serviços via DynamicImport. + """ + + def __init__(self): + # ---------------------------------------------------- + # Inicialização do DynamicImport + # ---------------------------------------------------- + self.dynamic_import = DynamicImport() + self.dynamic_import.set_package("administrativo") + self.dynamic_import.set_table("g_gramatica") + + # ---------------------------------------------------- + # Lista todos os registros de G_GRAMATICA + # ---------------------------------------------------- + def index(self): + # Importação da classe desejada + index_service = self.dynamic_import.service("g_gramatica_index_service", "GGramaticaIndexService") + + # Instância da classe service + self.index_service = index_service() + + # Execução da listagem + return { + "message": "Registros de G_GRAMATICA localizados com sucesso.", + "data": self.index_service.execute(), + } + + # ---------------------------------------------------- + # Busca um registro específico de G_GRAMATICA pelo ID + # ---------------------------------------------------- + def show(self, g_gramatica_id_schema: GGramaticaIdSchema): + # Importação da classe desejada + show_service = self.dynamic_import.service("g_gramatica_show_service", "GGramaticaShowService") + + # Instância da classe service + self.show_service = show_service() + + # Execução da busca + return { + "message": "Registro de G_GRAMATICA localizado com sucesso.", + "data": self.show_service.execute(g_gramatica_id_schema), + } + + # ---------------------------------------------------- + # Cadastra um novo registro em G_GRAMATICA + # ---------------------------------------------------- + def save(self, g_gramatica_save_schema: GGramaticaSaveSchema): + # Importação da classe desejada + save_service = self.dynamic_import.service("g_gramatica_save_service", "GGramaticaSaveService") + + # Instância da classe service + self.save_service = save_service() + + # Execução do salvamento + return { + "message": "Registro de G_GRAMATICA salvo com sucesso.", + "data": self.save_service.execute(g_gramatica_save_schema), + } + + # ---------------------------------------------------- + # Atualiza um registro existente de G_GRAMATICA + # ---------------------------------------------------- + def update(self, g_gramatica_update_schema: GGramaticaUpdateSchema): + # Importação da classe desejada + update_service = self.dynamic_import.service("g_gramatica_update_service", "GGramaticaUpdateService") + + # Instância da classe service + self.update_service = update_service() + + # Execução da atualização + return { + "message": "Registro de G_GRAMATICA atualizado com sucesso.", + "data": self.update_service.execute(g_gramatica_update_schema), + } + + # ---------------------------------------------------- + # Exclui um registro de G_GRAMATICA + # ---------------------------------------------------- + def delete(self, g_gramatica_id_schema: GGramaticaIdSchema): + # Importação da classe desejada + delete_service = self.dynamic_import.service("g_gramatica_delete_service", "GGramaticaDeleteService") + + # Instância da classe service + self.delete_service = delete_service() + + # Execução da exclusão + return { + "message": "Registro de G_GRAMATICA removido com sucesso.", + "data": self.delete_service.execute(g_gramatica_id_schema), + } diff --git a/packages/v1/administrativo/endpoints/g_gramatica_endpoint.py b/packages/v1/administrativo/endpoints/g_gramatica_endpoint.py new file mode 100644 index 0000000..1415dcc --- /dev/null +++ b/packages/v1/administrativo/endpoints/g_gramatica_endpoint.py @@ -0,0 +1,94 @@ +# Importação de bibliotecas +from fastapi import APIRouter, Depends, status +from actions.jwt.get_current_user import get_current_user +from packages.v1.administrativo.controllers.g_gramatica_controller import GGramaticaController +from packages.v1.administrativo.schemas.g_gramatica_schema import ( + GGramaticaSaveSchema, + GGramaticaUpdateSchema, + GGramaticaIdSchema +) + +# ---------------------------------------------------- +# Inicializa o roteador para as rotas da tabela G_GRAMATICA +# ---------------------------------------------------- +router = APIRouter() + +# Instanciamento do controller +g_gramatica_controller = GGramaticaController() + +# ---------------------------------------------------- +# Lista todos os registros de G_GRAMATICA +# ---------------------------------------------------- +@router.get('/', + status_code=status.HTTP_200_OK, + summary='Lista todos os registros de G_GRAMATICA cadastrados', + response_description='Lista todos os registros de G_GRAMATICA cadastrados') +async def index(current_user: dict = Depends(get_current_user)): + """ + Retorna todos os registros da tabela G_GRAMATICA. + """ + response = g_gramatica_controller.index() + return response + + +# ---------------------------------------------------- +# Busca um registro específico de G_GRAMATICA pelo ID +# ---------------------------------------------------- +@router.get('/{gramatica_id}', + status_code=status.HTTP_200_OK, + summary='Busca um registro de G_GRAMATICA pelo ID', + response_description='Busca um registro de G_GRAMATICA em específico') +async def show(gramatica_id: int, current_user: dict = Depends(get_current_user)): + """ + Retorna um registro específico de G_GRAMATICA com base no ID informado. + """ + g_gramatica_id_schema = GGramaticaIdSchema(gramatica_id=gramatica_id) + response = g_gramatica_controller.show(g_gramatica_id_schema) + return response + + +# ---------------------------------------------------- +# Cadastra um novo registro em G_GRAMATICA +# ---------------------------------------------------- +@router.post('/', + status_code=status.HTTP_201_CREATED, + summary='Cadastra um novo registro em G_GRAMATICA', + response_description='Cadastra um novo registro em G_GRAMATICA') +async def save(g_gramatica_schema: GGramaticaSaveSchema, current_user: dict = Depends(get_current_user)): + """ + Cria um novo registro na tabela G_GRAMATICA. + """ + response = g_gramatica_controller.save(g_gramatica_schema) + return response + + +# ---------------------------------------------------- +# Atualiza um registro existente de G_GRAMATICA +# ---------------------------------------------------- +@router.put('/{gramatica_id}', + status_code=status.HTTP_200_OK, + summary='Atualiza um registro existente em G_GRAMATICA', + response_description='Atualiza um registro existente em G_GRAMATICA') +async def update(gramatica_id: int, g_gramatica_update_schema: GGramaticaUpdateSchema, current_user: dict = Depends(get_current_user)): + """ + Atualiza um registro existente de G_GRAMATICA com base no ID informado. + """ + g_gramatica_update_schema.gramatica_id = gramatica_id + response = g_gramatica_controller.update(g_gramatica_update_schema) + return response + + +# ---------------------------------------------------- +# Exclui um registro de G_GRAMATICA +# ---------------------------------------------------- +@router.delete('/{gramatica_id}', + status_code=status.HTTP_200_OK, + summary='Remove um registro de G_GRAMATICA', + response_description='Remove um registro de G_GRAMATICA') +async def delete(gramatica_id: int, current_user: dict = Depends(get_current_user)): + """ + Remove um registro específico de G_GRAMATICA com base no ID informado. + """ + g_gramatica_id_schema = GGramaticaIdSchema(gramatica_id=gramatica_id) + response = g_gramatica_controller.delete(g_gramatica_id_schema) + return response \ No newline at end of file diff --git a/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_delete_repository.py b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_delete_repository.py new file mode 100644 index 0000000..bf987ae --- /dev/null +++ b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_delete_repository.py @@ -0,0 +1,45 @@ +from abstracts.repository import BaseRepository +from fastapi import HTTPException, status + +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaIdSchema + +class GGramaticaDeleteRepository(BaseRepository): + """ + Repositório responsável pela exclusão de registros na tabela + G_GRAMATICA. + """ + def execute(self, g_gramatica_id_schema: GGramaticaIdSchema): + """ + Executa a exclusão de um registro específico da tabela G_GRAMATICA + com base no ID informado. + + Args: + g_gramatica_id_schema (GGramaticaIdSchema): Esquema contendo o ID do registro a ser excluído. + + Returns: + O resultado da operação de exclusão. + """ + try: + # Montagem do SQL + sql = """ + DELETE FROM G_GRAMATICA GG + WHERE GG.GRAMATICA_ID = :gramatica_id + """ + + # Preenchimento dos parâmetros + params = { + "gramatica_id": g_gramatica_id_schema.gramatica_id + } + + # Execução da instrução SQL + response = self.run(sql, params) + + # Retorna o resultado da exclusão + return response + + except Exception as e: + # Lança exceção HTTP em caso de erro + raise HTTPException( + status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, + detail=f"Erro ao excluir registro de G_GRAMATICA: {e}" + ) diff --git a/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_index_repository.py b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_index_repository.py new file mode 100644 index 0000000..c434e2c --- /dev/null +++ b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_index_repository.py @@ -0,0 +1,26 @@ +from abstracts.repository import BaseRepository + +class GGramaticaIndexRepository(BaseRepository): + """ + Repositório para a operação de listagem de todos os registros + na tabela t_censec_qualidade. + """ + + def execute(self): + """ + Executa a consulta SQL para buscar todos os registros. + + Returns: + Uma lista de dicionários contendo os dados dos registros. + """ + # Montagem do SQL + sql = """ SELECT + GG.* + FROM G_GRAMATICA GG + """ + + # Execução do sql + response = self.fetch_all(sql) + + # Retorna os dados localizados + return response \ No newline at end of file diff --git a/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_save_repository.py b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_save_repository.py new file mode 100644 index 0000000..b7ee6df --- /dev/null +++ b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_save_repository.py @@ -0,0 +1,50 @@ +from fastapi import HTTPException, status +from abstracts.repository import BaseRepository +from api.actions.data.generate_insert_sql import generate_insert_sql +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaSaveSchema + + +class GGramaticaSaveRepository(BaseRepository): + """ + Repositório responsável pela operação de salvamento de um novo registro + na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_save_schema: GGramaticaSaveSchema): + """ + Executa a operação de salvamento no banco de dados. + + Args: + g_gramatica_save_schema (GGramaticaSchema): O esquema com os dados a serem salvos. + + Returns: + O registro recém-criado. + + Raises: + HTTPException: Caso ocorra um erro na execução da query. + """ + try: + + # ---------------------------------------------------- + # Preenchimento dos parâmetros + # ---------------------------------------------------- + params = g_gramatica_save_schema.model_dump(exclude_unset=True) + + # ---------------------------------------------------- + # Montagem do SQL dinâmico + # ---------------------------------------------------- + sql = generate_insert_sql('G_GRAMATICA', params) + + # ---------------------------------------------------- + # Execução do SQL e retorno do registro + # ---------------------------------------------------- + return self.run_and_return(sql, params) + + except Exception as e: + # ---------------------------------------------------- + # Tratamento de erros e lançamento de exceção HTTP + # ---------------------------------------------------- + raise HTTPException( + status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, + detail=f"Erro ao salvar registro em G_GRAMATICA: {e}" + ) \ No newline at end of file diff --git a/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_show_repository.py b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_show_repository.py new file mode 100644 index 0000000..f55a3a8 --- /dev/null +++ b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_show_repository.py @@ -0,0 +1,67 @@ +from abstracts.repository import BaseRepository +from fastapi import HTTPException, status + +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaIdSchema + + +class GGramaticaShowRepository(BaseRepository): + """ + Repositório responsável pela operação de exibição de um registro + na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_id_schema: GGramaticaIdSchema): + """ + Busca um registro específico de G_GRAMATICA pelo ID. + + Args: + g_gramatica_id_schema (GGramaticaIdSchema): + Esquema contendo o ID do registro a ser buscado. + + Returns: + O registro encontrado ou levanta exceção HTTP 404 se não existir. + + Raises: + HTTPException: Caso ocorra um erro na execução da query. + """ + try: + # ---------------------------------------------------- + # Montagem do SQL + # ---------------------------------------------------- + sql = """ + SELECT * + FROM G_GRAMATICA GG + WHERE GG.GRAMATICA_ID = :gramatica_id + """ + + # ---------------------------------------------------- + # Preenchimento de parâmetros + # ---------------------------------------------------- + params = g_gramatica_id_schema.model_dump(exclude_unset=True) + + # ---------------------------------------------------- + # Execução do SQL + # ---------------------------------------------------- + result = self.fetch_one(sql, params) + + # ---------------------------------------------------- + # Validação de retorno + # ---------------------------------------------------- + if not result: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Registro de G_GRAMATICA não encontrado." + ) + + return result + + except HTTPException: + # Repassa exceções HTTP explícitas (como 404) + raise + + except Exception as e: + # Captura falhas inesperadas de execução + raise HTTPException( + status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, + detail=f"Erro ao buscar registro em G_GRAMATICA: {e}" + ) diff --git a/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_update_repository.py b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_update_repository.py new file mode 100644 index 0000000..2ab4043 --- /dev/null +++ b/packages/v1/administrativo/repositories/g_gramatica/g_gramatica_update_repository.py @@ -0,0 +1,61 @@ +from abstracts.repository import BaseRepository +from api.actions.data.prepare_update_data import prepare_update_data +from fastapi import HTTPException, status + +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaUpdateSchema + + +class GGramaticaUpdateRepository(BaseRepository): + """ + Repositório responsável pela operação de atualização de registros + na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_update_schema: GGramaticaUpdateSchema): + """ + Atualiza um registro existente na tabela G_GRAMATICA. + + Args: + g_gramatica_update_schema (GGramaticaUpdateSchema): + Esquema contendo os dados a serem atualizados. + + Returns: + O registro atualizado (via RETURNING *). + + Raises: + HTTPException: Caso ocorra um erro na execução do SQL. + """ + try: + # ---------------------------------------------------- + # Prepara parâmetros e colunas de atualização dinâmicas + # ---------------------------------------------------- + params, update_columns = prepare_update_data( + g_gramatica_update_schema, + exclude_fields=["gramatica_id"], + id_field="gramatica_id" + ) + + # ---------------------------------------------------- + # Montagem do SQL dinâmico + # ---------------------------------------------------- + sql = f""" + UPDATE G_GRAMATICA + SET {update_columns} + WHERE GRAMATICA_ID = :gramatica_id + RETURNING *; + """ + + # ---------------------------------------------------- + # Execução e retorno do registro atualizado + # ---------------------------------------------------- + response = self.run_and_return(sql, params) + return response + + except Exception as e: + # ---------------------------------------------------- + # Tratamento de exceção e retorno HTTP padronizado + # ---------------------------------------------------- + raise HTTPException( + status_code=status.HTTP_422_UNPROCESSABLE_ENTITY, + detail=f"Erro ao atualizar registro em G_GRAMATICA: {str(e)}" + ) diff --git a/packages/v1/administrativo/schemas/g_gramatica_schema.py b/packages/v1/administrativo/schemas/g_gramatica_schema.py new file mode 100644 index 0000000..98cb0d6 --- /dev/null +++ b/packages/v1/administrativo/schemas/g_gramatica_schema.py @@ -0,0 +1,59 @@ +from pydantic import BaseModel +from typing import Optional + +# ---------------------------------------------------- +# Schema base - representa a tabela G_GRAMATICA +# ---------------------------------------------------- +class GGramaticaSchema(BaseModel): + gramatica_id: Optional[float] = None + palavra: Optional[str] = None + prefixo: Optional[str] = None + sufixo_ms: Optional[str] = None + sufixo_mp: Optional[str] = None + sufixo_fs: Optional[str] = None + sufixo_fp: Optional[str] = None + + class Config: + from_attributes = True + + +# ---------------------------------------------------- +# Schema para localizar um registro pelo ID (GET /{id}) +# ---------------------------------------------------- +class GGramaticaIdSchema(BaseModel): + gramatica_id: float + + class Config: + from_attributes = True + + +# ---------------------------------------------------- +# Schema para criação (POST) +# ---------------------------------------------------- +class GGramaticaSaveSchema(BaseModel): + gramatica_id: Optional[float] = None + palavra: Optional[str] = None + prefixo: Optional[str] = None + sufixo_ms: Optional[str] = None + sufixo_mp: Optional[str] = None + sufixo_fs: Optional[str] = None + sufixo_fp: Optional[str] = None + + class Config: + from_attributes = True + + +# ---------------------------------------------------- +# Schema para atualização (PUT) +# ---------------------------------------------------- +class GGramaticaUpdateSchema(BaseModel): + gramatica_id: Optional[float] = None + palavra: Optional[str] = None + prefixo: Optional[str] = None + sufixo_ms: Optional[str] = None + sufixo_mp: Optional[str] = None + sufixo_fs: Optional[str] = None + sufixo_fp: Optional[str] = None + + class Config: + from_attributes = True diff --git a/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_delete_service.py b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_delete_service.py new file mode 100644 index 0000000..584f993 --- /dev/null +++ b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_delete_service.py @@ -0,0 +1,35 @@ +from api.packages.v1.administrativo.actions.g_gramatica.g_gramatica_delete_action import GGramaticaDeleteAction +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaIdSchema + + +class GGramaticaDeleteService: + """ + Serviço responsável por encapsular a lógica de negócio para a operação + de exclusão de um registro na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_id_schema: GGramaticaIdSchema): + """ + Executa a operação de exclusão do registro no banco de dados. + + Args: + g_gramatica_id_schema (GGramaticaIdSchema): + O esquema com o ID do registro a ser excluído. + + Returns: + O resultado da operação de exclusão. + """ + # ---------------------------------------------------- + # Instanciamento da ação + # ---------------------------------------------------- + g_gramatica_delete_action = GGramaticaDeleteAction() + + # ---------------------------------------------------- + # Execução da ação + # ---------------------------------------------------- + data = g_gramatica_delete_action.execute(g_gramatica_id_schema) + + # ---------------------------------------------------- + # Retorno da informação + # ---------------------------------------------------- + return data diff --git a/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_index_service.py b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_index_service.py new file mode 100644 index 0000000..74e8b99 --- /dev/null +++ b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_index_service.py @@ -0,0 +1,44 @@ +from api.packages.v1.administrativo.actions.g_gramatica.g_gramatica_index_action import GGramaticaIndexAction +from fastapi import HTTPException, status + + +class GGramaticaIndexService: + """ + Serviço responsável por encapsular a lógica de negócio para a operação + de listagem de registros na tabela G_GRAMATICA. + """ + + def execute(self): + """ + Executa a operação de busca de todos os registros no banco de dados. + + Args: + g_gramatica_index_schema (GGramaticaIndexSchema): + Esquema que pode conter filtros ou parâmetros de busca. + + Returns: + A lista de registros encontrados. + """ + # ---------------------------------------------------- + # Instanciamento da ação + # ---------------------------------------------------- + g_gramatica_index_action = GGramaticaIndexAction() + + # ---------------------------------------------------- + # Execução da ação + # ---------------------------------------------------- + data = g_gramatica_index_action.execute() + + # ---------------------------------------------------- + # Verificação de retorno + # ---------------------------------------------------- + if not data: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Não foi possível localizar registros de G_GRAMATICA." + ) + + # ---------------------------------------------------- + # Retorno da informação + # ---------------------------------------------------- + return data diff --git a/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_save_service.py b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_save_service.py new file mode 100644 index 0000000..3f5893d --- /dev/null +++ b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_save_service.py @@ -0,0 +1,44 @@ +from api.packages.v1.administrativo.actions.g_gramatica.g_gramatica_save_action import GGramaticaSaveAction +from api.packages.v1.sequencia.schemas.g_sequencia import GSequenciaSchema +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaSaveSchema +from api.packages.v1.sequencia.services.g_sequencia.generate_service import GenerateService + + +class GGramaticaSaveService: + """ + Serviço responsável por encapsular a lógica de negócio para a operação + de criação de registros na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_save_schema: GGramaticaSaveSchema): + """ + Executa a operação de salvamento do registro no banco de dados. + + Args: + g_gramatica_save_schema (GGramaticaSaveSchema): + O esquema com os dados a serem salvos. + + Returns: + O registro recém-criado. + """ + + # ---------------------------------------------------- + # Geração automática de ID (sequência) + # ---------------------------------------------------- + if not g_gramatica_save_schema.gramatica_id: + # Cria o schema de sequência + sequencia_schema = GSequenciaSchema() + sequencia_schema.tabela = "G_GRAMATICA" + + # Gera a sequência atualizada + generate = GenerateService() + sequencia = generate.execute(sequencia_schema) + + # Atualiza o ID no schema + g_gramatica_save_schema.gramatica_id = sequencia.sequencia + + # ---------------------------------------------------- + # Instanciamento e execução da Action de salvamento + # ---------------------------------------------------- + g_gramatica_save_action = GGramaticaSaveAction() + return g_gramatica_save_action.execute(g_gramatica_save_schema) diff --git a/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_show_service.py b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_show_service.py new file mode 100644 index 0000000..b03f2c2 --- /dev/null +++ b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_show_service.py @@ -0,0 +1,45 @@ +from api.packages.v1.administrativo.actions.g_gramatica.g_gramatica_show_action import GGramaticaShowAction +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaIdSchema +from fastapi import HTTPException, status + + +class GGramaticaShowService: + """ + Serviço responsável por encapsular a lógica de negócio para a operação + de busca de um registro na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_id_schema: GGramaticaIdSchema): + """ + Executa a operação de busca no banco de dados. + + Args: + g_gramatica_id_schema (GGramaticaIdSchema): + O esquema com o ID do registro a ser buscado. + + Returns: + O resultado da busca. + """ + # ---------------------------------------------------- + # Instanciamento da ação + # ---------------------------------------------------- + g_gramatica_show_action = GGramaticaShowAction() + + # ---------------------------------------------------- + # Execução da ação + # ---------------------------------------------------- + data = g_gramatica_show_action.execute(g_gramatica_id_schema) + + # ---------------------------------------------------- + # Verificação de resultado + # ---------------------------------------------------- + if not data: + raise HTTPException( + status_code=status.HTTP_404_NOT_FOUND, + detail="Não foi possível localizar o registro de G_GRAMATICA." + ) + + # ---------------------------------------------------- + # Retorno da informação + # ---------------------------------------------------- + return data diff --git a/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_update_service.py b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_update_service.py new file mode 100644 index 0000000..355f6f8 --- /dev/null +++ b/packages/v1/administrativo/services/g_gramatica/go/g_gramatica_update_service.py @@ -0,0 +1,30 @@ +from api.packages.v1.administrativo.actions.g_gramatica.g_gramatica_update_action import GGramaticaUpdateAction +from api.packages.v1.administrativo.schemas.g_gramatica_schema import GGramaticaUpdateSchema + + +class GGramaticaUpdateService: + """ + Serviço responsável pela operação de atualização de um registro + na tabela G_GRAMATICA. + """ + + def execute(self, g_gramatica_update_schema: GGramaticaUpdateSchema): + """ + Executa a operação de atualização no banco de dados. + + Args: + g_gramatica_update_schema (GGramaticaUpdateSchema): + O esquema com os dados a serem atualizados. + + Returns: + O resultado da operação de atualização. + """ + # ---------------------------------------------------- + # Instanciamento da ação + # ---------------------------------------------------- + g_gramatica_update_action = GGramaticaUpdateAction() + + # ---------------------------------------------------- + # Execução da ação e retorno do resultado + # ---------------------------------------------------- + return g_gramatica_update_action.execute(g_gramatica_update_schema) diff --git a/packages/v1/api.py b/packages/v1/api.py index 76419ba..3aeafe3 100644 --- a/packages/v1/api.py +++ b/packages/v1/api.py @@ -2,7 +2,7 @@ from fastapi import APIRouter # Importa os módulos de rotas específicos -from api.packages.v1.administrativo.endpoints import g_natureza_titulo_endpoint, t_ato_partetipo_endpoint, t_censec_tiponatureza_endpoint +from api.packages.v1.administrativo.endpoints import g_gramatica_endpoint, g_natureza_titulo_endpoint, t_ato_partetipo_endpoint, t_censec_tiponatureza_endpoint from packages.v1.administrativo.endpoints import t_censec_tipoato_endpoint from packages.v1.administrativo.endpoints import t_censec_qualidadeato_endpoint from packages.v1.administrativo.endpoints import g_tb_txmodelogrupo_endpoint @@ -204,4 +204,9 @@ api_router.include_router( # Inclui as rotas de g_natureza_titulo api_router.include_router( g_natureza_titulo_endpoint.router, prefix="/administrativo/g_natureza_titulo", tags=["Títulos do GNatureza"] +) + +# Inclui as rotas de g_gramatica +api_router.include_router( + g_gramatica_endpoint.router, prefix="/administrativo/g_gramatica", tags=["Dicionário Gramatical"] ) \ No newline at end of file