Merge remote-tracking branch 'origin/main' into 15-criação-endpoint-news---post

Author: arthur-mesquita

.gitignore

@@ -182,9 +182,9 @@ cython_debug/
 .abstra/
 
 # Visual Studio Code
-#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
 #  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
-#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
 #  you could uncomment the following to ignore the entire vscode folder
 # .vscode/
 

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+    -   id: trailing-whitespace
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.5
+    hooks:
+    -   id: ruff-check
+        args: [ --fix , --diff, format]

.vscode/launch.json

@@ -29,4 +29,4 @@
             "justMyCode": false
         }
     ]
-}
+}

.vscode/settings.json

@@ -6,5 +6,8 @@
         "source.organizeImports": "explicit"
       },
       "editor.defaultFormatter": "charliermarsh.ruff"
-    }
-}
+    },
+    "python-envs.defaultEnvManager": "ms-python.python:poetry",
+    "python-envs.defaultPackageManager": "ms-python.python:poetry",
+    "python-envs.pythonProjects": []
+}

Dockerfile

@@ -60,4 +60,4 @@ WORKDIR $PROJECT_PATH
 COPY app app
 COPY tests tests
 
-CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000", "--lifespan", "on"]
+CMD ["uvicorn", "app.main:app", "--host", "0.0.0.0", "--port", "8000", "--lifespan", "on"]

README.md

@@ -4,24 +4,24 @@ Serviço de Noticas e Bibliotecas PyNews
 ## 💡 Visão Geral
 
 ## 💻 Tecnologias Utilizadas
-    - Python 
-        - FastAPI 
+    - Python
+        - FastAPI
         - Pydantic
         - Poetry
         - Sqlite3
         - Orjson
         - ruff (linter)
 
 ## 🚀 Recursos e Funcionalidades
-    Endpoints para CRUD de noticias selecionadas pela comunidade. 
+    Endpoints para CRUD de noticias selecionadas pela comunidade.
 
 ### Schema da API
     [Documentação de referencia API Dog](https://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/)
 <div class="px-2 pb-2 pt-5 os:px-5 os:pb-10 _tree-scroll-container relative h-full w-full overflow-y-auto"><ul class="w-full"><li><div to="" class="_sidebar-tree-node_13jsg_1 cursor-pointer select-none font-600 text-color" title="Authentication"><span class="break-word">Authentication</span><div class="flex-1"></div><div class="flex h-[22px] w-[22px] items-center justify-center"><span role="img" class="appicon app_icon text-disabled" style="font-size:16px"><svg viewBox="0 0 1024 1024" width="1em" height="1em" fill="currentColor" aria-hidden="true" focusable="false" role="img"><path d="M225.834667 353.834667a42.666667 42.666667 0 0 1 60.330666 0L512 579.669333l225.834667-225.834666a42.666667 42.666667 0 1 1 60.330666 60.330666l-256 256a42.666667 42.666667 0 0 1-60.330666 0l-256-256a42.666667 42.666667 0 0 1 0-60.330666z"></path></svg></span></div></div><ul class="ml-3 border-l border-color-split pl-2"><li><a class="_sidebar-tree-node_13jsg_1 _sidebar-tree-node--selected_13jsg_24 font-600 sidebar-tree-node-apiDetail-15916580" title="Athenticate" data-discover="true" href="https://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/athenticate-15916580e0"><span class="break-word">Athenticate</span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-orange-6 text-white ml-2 mt-1 max-w-[70px]"><span class="truncate">POST</span></span></a></li></ul></li><li><div to="" class="_sidebar-tree-node_13jsg_1 cursor-pointer select-none text-color" title="News"><span class="break-word">News</span><div class="flex-1"></div><div class="flex h-[22px] w-[22px] items-center justify-center"><span role="img" class="appicon app_icon text-disabled" style="font-size:16px"><svg viewBox="0 0 1024 1024" width="1em" height="1em" fill="currentColor" aria-hidden="true" focusable="false" role="img"><path d="M225.834667 353.834667a42.666667 42.666667 0 0 1 60.330666 0L512 579.669333l225.834667-225.834666a42.666667 42.666667 0 1 1 60.330666 60.330666l-256 256a42.666667 42.666667 0 0 1-60.330666 0l-256-256a42.666667 42.666667 0 0 1 0-60.330666z"></path></svg></span></div></div><ul class="ml-3 border-l border-color-split pl-2"><li><a class="_sidebar-tree-node_13jsg_1" title="Create" data-discover="true" href="https://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/create-15876459e0"><span class="break-word">Create</span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-orange-1 text-orange-6 ml-2 mt-1 max-w-[70px]"><span class="truncate">POST</span></span></a></li><li><a class="_sidebar-tree-node_13jsg_1" title="Get" data-discover="true" href="https://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/get-15876866e0"><span class="break-word">Get</span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-green-1 text-green-6 ml-2 mt-1 max-w-[70px]"><span class="truncate">GET</span></span></a></li><li><a class="_sidebar-tree-node_13jsg_1" title="Update" data-discover="true" href="https://apidog.comhttps://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/update-15878592e0"><span class="break-word">Update</span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-blue-1 text-blue-6 ml-2 mt-1 max-w-[70px]"><span class="truncate">PUT</span></span></a></li><li><a class="_sidebar-tree-node_13jsg_1" title="Like" data-discover="true" href="https://apidog.comhttps://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/like-15961454e0"><span class="break-word">Like</span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-orange-1 text-orange-6 ml-2 mt-1 max-w-[70px]"><span class="truncate">POST</span></span></a></li></ul></li><li><div to="" class="_sidebar-tree-node_13jsg_1 cursor-pointer select-none text-color" title="Libraries"><span class="break-word">Libraries</span><div class="flex-1"></div><div class="flex h-[22px] w-[22px] items-center justify-center"><span role="img" class="appicon app_icon text-disabled" style="font-size:16px"><svg viewBox="0 0 1024 1024" width="1em" height="1em" fill="currentColor" aria-hidden="true" focusable="false" role="img"><path d="M225.834667 353.834667a42.666667 42.666667 0 0 1 60.330666 0L512 579.669333l225.834667-225.834666a42.666667 42.666667 0 1 1 60.330666 60.330666l-256 256a42.666667 42.666667 0 0 1-60.330666 0l-256-256a42.666667 42.666667 0 0 1 0-60.330666z"></path></svg></span></div></div><ul class="ml-3 border-l border-color-split pl-2"><li><a class="_sidebar-tree-node_13jsg_1" title="Create Subscription" data-discover="true" href="https://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/create-subscription-16489942e0"><span class="break-word">Create Subscription</span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-orange-1 text-orange-6 ml-2 mt-1 max-w-[70px]"><span class="truncate">POST</span></span></a></li><li><a class="_sidebar-tree-node_13jsg_1" title="Add new Library" data-discover="true" href="/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/add-new-library-16489959e0"><span class="break-word">Add new Library</span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-orange-1 text-orange-6 ml-2 mt-1 max-w-[70px]"><span class="truncate">POST</span></span></a></li><li><a class="_sidebar-tree-node_13jsg_1" title="GET List of the last 30 days updates " data-discover="true" href="https://apidog.com/apidoc/shared/70418cab-ddba-4c7d-97a4-8b70b43a7946/get-list-of-the-last-30-days-updates-16490481e0"><span class="break-word">GET List of the last 30 days updates </span><span class="ui-badge ui-badge-status ui-badge-not-a-wrapper ml-1 opacity-40"><span class="ui-badge-status-dot ui-badge-status-blue"></span></span><div class="flex-1"></div><span class="inline-flex items-center h-[14px] rounded-full px-1 py-0.5 text-xs font-700 leading-[10px] bg-green-1 text-green-6 ml-2 mt-1 max-w-[70px]"><span class="truncate">GET</span></span></a></li></ul></li></ul></div>
 
 ---
 
-### Schema do Servidor 
+### Schema do Servidor
 ```
     fastapi_news_service/
     │
@@ -41,7 +41,7 @@ Serviço de Noticas e Bibliotecas PyNews
     │       ├── libraries.py      # Definição dos endpoints da API para o módulo de Libraries (/libraries)
     │       └── authentication.py # Definição dos endpoints da API para o módulo de Autenticação (/auth)
     │
-    ├── test/                     # Diretório para testes unitários 
+    ├── test/                     # Diretório para testes unitários
     │   └── __init__.py
     │   └── test_auth.py
     │   └── test_news.py
@@ -77,7 +77,7 @@ sequenceDiagram
     ServicoNoticias-->>Cliente: Notícia Criada (201 Created)
     deactivate ServicoNoticias
     deactivate Cliente
- 
+
 
 ```
 
@@ -245,6 +245,6 @@ poetry run ruff format .
 poetry run ruff check . --fix
 ```
 
- 
-## referencias 
+
+## referencias
     [Opinion based fastapi best practices](https://github.com/zhanymkanov/fastapi-best-practices)

app/routers/healthcheck/routes.py

@@ -3,19 +3,19 @@
 
 
 class HealthCheckResponse(BaseModel):
-    status: str = 'healthy'
-    version: str = '2.0.0'
+    status: str = "healthy"
+    version: str = "2.0.0"
 
 
 def setup():
-    router = APIRouter(prefix='/healthcheck', tags=['healthcheck'])
+    router = APIRouter(prefix="/healthcheck", tags=["healthcheck"])
 
     @router.get(
-        '',
+        "",
         response_model=HealthCheckResponse,
         status_code=status.HTTP_200_OK,
-        summary='Health check endpoint',
-        description='Returns the health status of the API',
+        summary="Health check endpoint",
+        description="Returns the health status of the API",
     )
     async def healthcheck():
         """

app/schemas.py

@@ -1,14 +1,17 @@
-from pydantic import BaseModel, HttpUrl
 from datetime import datetime
 
+from pydantic import BaseModel, HttpUrl
+
+
 class News(BaseModel):
     description: str
     tag: str
 
+
 class Library(BaseModel):
     library_name: str
     news: list[News]
     logo: HttpUrl
     version: str
     release_date: datetime
-    release_doc_url: HttpUrl
+    release_doc_url: HttpUrl

app/services/database/database.py

@@ -2,68 +2,88 @@
 import os
 from typing import AsyncGenerator
 
-from sqlalchemy.ext.asyncio import AsyncEngine
-from sqlalchemy.orm import sessionmaker
-from sqlmodel import SQLModel, create_engine, Field
+from sqlalchemy.ext.asyncio import async_sessionmaker, create_async_engine
+from sqlmodel import Field, SQLModel
 from sqlmodel.ext.asyncio.session import AsyncSession
 
-from app.services.database import models
+from app.services.database import models  # noqa F401
 
 logger = logging.getLogger(__name__)
 
+
 # --- Configuração do Banco de Dados ---
 # 'sqlite+aiosqlite' para suporte assíncrono com SQLite
-SQLITE_PATH = os.getenv('SQLITE_PATH', 'pynewsdb.db') # Valor padrão se não definida
-SQLITE_URL = os.getenv('SQLITE_URL', f'sqlite+aiosqlite:///{SQLITE_PATH}')
+SQLITE_PATH = os.getenv(
+    "SQLITE_PATH", "pynewsdb.db"
+)  # Valor padrão se não definida
+SQLITE_URL = os.getenv("SQLITE_URL", f"sqlite+aiosqlite:///{SQLITE_PATH}")
+
+DATABASE_FILE = SQLITE_PATH  # Usamos SQLITE_PATH para o nome do arquivo
+DATABASE_URL = SQLITE_URL  # Usamos SQLITE_URL para a URL completa
 
-DATABASE_FILE = SQLITE_PATH # Usamos SQLITE_PATH para o nome do arquivo
-DATABASE_URL = SQLITE_URL # Usamos SQLITE_URL para a URL completa
+# Cria o motor assíncrono
+engine = create_async_engine(DATABASE_URL, echo=True, future=True)
 
-# Cria o motor assíncrono 
-engine: AsyncEngine = AsyncEngine(create_engine(DATABASE_URL, echo=True, future=True))
 
 # --- Fábrica de Sessões Assíncronas ---
 # Crie a fábrica de sessões UMA VEZ no escopo global do módulo.
-# Esta é a variável é injetada para obter sessões nas chamadas. 
-AsyncSessionLocal = sessionmaker(
-    engine, class_=AsyncSession, expire_on_commit=False, echo= True # expire_on_commit=False é importante!
+# Esta é a variável é injetada para obter sessões nas chamadas.
+AsyncSessionLocal = async_sessionmaker(
+    engine,
+    class_=AsyncSession,
+    expire_on_commit=False,
+    echo=True,  # expire_on_commit=False é importante!
 )
 
+
 # --- Modelo de Teste Temporário (SQLModel) ---
-class TestEntry(SQLModel, table=True): # table=True indica que esta classe é um modelo de tabela
+class TestEntry(
+    SQLModel, table=True
+):  # table=True indica que esta classe é um modelo de tabela
     """
     Classe de modelo temporária para testes de conexão com o banco de dados.
-    Será usada como uma solução provisória antes da implementação dos modelos finais do projeto.
+    Será usada como uma solução provisória antes da implementação dos
+    modelos finais do projeto.
     """
-    __tablename__ = "test_entries"
+
     id: int | None = Field(default=None, primary_key=True)
     message: str
+    __tablename__ = "test_entry"
 
     def __repr__(self):
         return f"<TestEntry(id={self.id}, message='{self.message}')>"
-    
+
 
 # --- Funções de Inicialização e Sessão do Banco de Dados ---
 async def init_db():
     """
     Inicializa o banco de dados:
     1. Verifica se o arquivo do banco de dados existe.
-    2. Se não existir, cria o arquivo e todas as tabelas definidas nos modelos SQLModel nos imports e acima.
+    2. Se não existir, cria o arquivo e todas as tabelas definidas
+    nos modelos SQLModel nos imports e acima.
     """
     if not os.path.exists(DATABASE_FILE):
-        logger.info(f"Arquivo de banco de dados '{DATABASE_FILE}' não encontrado. Criando novo banco de dados e tabelas.")
+        logger.info(
+            f"Arquivo de banco de dados '{DATABASE_FILE}' não encontrado."
+            f"Criando novo banco de dados e tabelas."
+        )
         async with engine.begin() as conn:
-            # SQLModel.metadata.create_all é síncrono e precisa ser executado via run_sync
+            # SQLModel.metadata.create_all é síncrono e precisa
+            # ser executado via run_sync
             await conn.run_sync(SQLModel.metadata.create_all)
         logger.info("Tabelas criadas com sucesso.")
     else:
-        logger.info(f"Arquivo de banco de dados '{DATABASE_FILE}' já existe. Conectando.")
+        logger.info(
+            f"Arquivo de banco de dados '{DATABASE_FILE}'"
+            f"já existe. Conectando."
+        )
+
 
 async def get_session() -> AsyncGenerator[AsyncSession, None]:
     """
     Função utilitária que fornece uma sessão de banco de dados assíncrona.
-    Injeção de dependência no app no lifespan. 
+    Injeção de dependência no app no lifespan.
     """
     async with AsyncSessionLocal() as session:
         yield session
-    # chamada do session.close() acontece ao final do bloco async with(). 
+    # chamada do session.close() acontece ao final do bloco async with().

app/services/database/models/__init__.py

@@ -1,4 +1,4 @@
 from app.services.database.models.communities import Community
 from app.services.database.models.libraries import Library
 
-__all__ = ["Community", "Library"]
+__all__ = ["Community", "Library"]