Fix PUT News endpoint by sending News data in body

Author: arthur-mesquita

app/routers/news/routes.py

@@ -8,7 +8,7 @@
 
 import app.services.database.orm.news as orm_news
 from app.routers.authentication import get_current_active_community
-from app.schemas import News, NewsPublishStatus
+from app.schemas import News, NewsWithPublishStatus
 from app.services.database.models import Community as DBCommunity
 from app.services.limiter import limiter
 
@@ -39,10 +39,10 @@ def encode_email(email: str) -> str:
 
 
 def setup():
-    router = APIRouter(prefix="/news", tags=["news"])
+    router: APIRouter = APIRouter(prefix="/news", tags=["news"])
 
     @router.post(
-        "",
+        path="",
         response_model=NewsCreateResponse,
         status_code=status.HTTP_200_OK,
         summary="News endpoint",
@@ -98,44 +98,29 @@ async def get_news(
         return NewsGetResponse(news_list=news_list)
 
     @router.put(
-        "",
-        response_model=NewsGetResponse,
+        path="/{news_id}",
         status_code=status.HTTP_200_OK,
         summary="PUT News",
-        description="Updates news by query params and set publish value",
+        description="Updates news and sets publish value",
     )
-    @limiter.limit("60/minute")
+    @limiter.limit(limit_value="60/minute")
     async def put_news(
         request: Request,
         current_community: Annotated[
             DBCommunity, Depends(get_current_active_community)
         ],
-        publish_status: NewsPublishStatus,
-        id: str | None = None,
-        title: str | None = None,
-        content: str | None = None,
-        category: str | None = None,
-        user_email: str = str(Header(..., alias="user-email")),
-        source_url: str | None = None,
-        tags: str | None = None,
-        social_media_url: str | None = None,
+        news_id: str,
+        news: NewsWithPublishStatus,
+        user_email: str = Header(..., alias="user-email"),
     ):
         """
         Get News endpoint that retrieves news filtered by user and query params.
         """
-        news: dict = {
-            "id": id,
-            "title": title,
-            "content": content,
-            "category": category,
-            "user_email": user_email,
-            "source_url": source_url,
-            "tags": tags,
-            "social_media_url": social_media_url,
-            "publish": publish_status.publish,
-        }
         await orm_news.update_news(
-            session=request.app.db_session_factory, news=news
+            session=request.app.db_session_factory,
+            news=news.__dict__,
+            news_id=news_id,
+            user_email=user_email,
         )
         return NewsUpdateResponse()
 
@@ -146,11 +131,11 @@ async def put_news(
         summary="News like endpoint",
         description="Allows user to like a news item",
     )
-    @limiter.limit("60/minute")
+    @limiter.limit(limit_value="60/minute")
     async def post_like(
         request: Request,
         current_community: Annotated[
-            DBCommunity, Depends(get_current_active_community)
+            DBCommunity, Depends(dependency=get_current_active_community)
         ],
         news_id: str,
         user_email: str = Header(..., alias="user-email"),
@@ -173,7 +158,7 @@ async def post_like(
         summary="News undo like endpoint",
         description="Allows user to undo a like to a news item",
     )
-    @limiter.limit("60/minute")
+    @limiter.limit(limit_value="60/minute")
     async def delete_like(
         request: Request,
         current_community: Annotated[

app/schemas.py

@@ -48,13 +48,12 @@ class News(BaseModel):
     title: str
     content: str
     category: str
-    tags: str | None = None
     source_url: str
+    tags: str | None = None
     social_media_url: str | None = None
-    likes: int = 0
 
 
-class NewsPublishStatus(BaseModel):
+class NewsWithPublishStatus(News):
     publish: bool = False
 
 

app/services/database/models/news.py

@@ -26,6 +26,8 @@ class News(SQLModel, table=True):
             for this news.
         likes (int): Number of likes this news article has received.
             Defaults to 0.
+        publish (bool): Indicates whether the news is published or not.
+            Defaults to False.
 
         community_id (Optional[int]): Foreign key to the associated community
             (communities.id).

app/services/database/orm/news.py

@@ -16,7 +16,6 @@ async def create_news(session: AsyncSession, news: dict) -> None:
         source_url=news["source_url"],
         tags=news["tags"] or "",
         social_media_url=news["social_media_url"] or "",
-        likes=news["likes"],
     )
     session.add(_news)
     await session.commit()
@@ -45,8 +44,15 @@ async def get_news_by_query_params(
     return list(results.all())
 
 
-async def update_news(session: AsyncSession, news: dict) -> None:
-    statement = select(News).where(News.id == news["id"])
+async def update_news(
+    session: AsyncSession,
+    news: dict,
+    news_id: str,
+    user_email: str,
+) -> None:
+    statement = select(News).where(
+        News.id == news_id and News.user_email == user_email
+    )
     results = await session.exec(statement)
     news_item = results.first()
     if news_item:

tests/test_news.py

@@ -4,7 +4,7 @@
 import pytest
 import pytest_asyncio
 from fastapi import status
-from httpx import AsyncClient
+from httpx import AsyncClient, Response
 from sqlmodel import select
 from sqlmodel.ext.asyncio.session import AsyncSession
 
@@ -101,8 +101,8 @@ async def test_post_news_endpoint(
         "category": "test_category",
         "source_url": "https://example.com/test-news",
     }
-    response = await async_client.post(
-        "/api/news", headers=valid_auth_headers, json=news_data
+    response: Response = await async_client.post(
+        url="/api/news", headers=valid_auth_headers, json=news_data
     )
     assert response.status_code == status.HTTP_200_OK
     assert response.json() == {"status": "News Criada"}
@@ -310,26 +310,23 @@ async def test_put_news_endpoint(
         "title": "updated title",
         "content": "updated content",
         "category": "updated_category",
-        "user_email": "updated_email@test.com",
         "source_url": "https://updated_url.com",
         "tags": "test_tag_updated",
         "social_media_url": "https://updated_social_media_url.com",
     }
 
-    response = await async_client.put(
-        "/api/news",
-        params={
-            "id": stored_news.id,
+    response: Response = await async_client.put(
+        url=f"/api/news/{stored_news.id}",
+        headers=valid_auth_headers,
+        json={
             "title": data["title"],
             "content": data["content"],
             "category": data["category"],
-            "user_email": data["user_email"],
             "source_url": data["source_url"],
             "tags": data["tags"],
             "social_media_url": data["social_media_url"],
+            "publish": True,
         },
-        headers=valid_auth_headers,
-        json={"publish": True},
     )
     assert response.status_code == status.HTTP_200_OK
 
@@ -339,7 +336,7 @@ async def test_put_news_endpoint(
     assert stored_news is not None
     assert stored_news.content == data["content"]
     assert stored_news.category == data["category"]
-    assert stored_news.user_email == data["user_email"]
+    assert stored_news.user_email == valid_auth_headers["user-email"]
     assert stored_news.source_url == data["source_url"]
     assert stored_news.tags == data["tags"]
     assert stored_news.social_media_url == data["social_media_url"]
@@ -361,8 +358,8 @@ async def test_news_likes_endpoint(
         "source_url": "https://example.com/test-news",
         "social_media_url": "https://test.com/test_news",
     }
-    response = await async_client.post(
-        "/api/news", json=news_data, headers=valid_auth_headers
+    response: Response = await async_client.post(
+        url="/api/news", json=news_data, headers=valid_auth_headers
     )
     assert response.status_code == status.HTTP_200_OK
     statement = select(News).where(News.title == news_data["title"])
@@ -374,8 +371,8 @@ async def test_news_likes_endpoint(
     emails = ["like@test.com", "like2@test.com"]
 
     # Add likes
-    response = await async_client.post(
-        f"/api/news/{stored_news.id}/like",
+    response: Response = await async_client.post(
+        url=f"/api/news/{stored_news.id}/like",
         json={"email": emails[0]},
         headers={**valid_auth_headers, "user-email": emails[0]},
     )
@@ -387,8 +384,8 @@ async def test_news_likes_endpoint(
     assert stored_news.likes == 1
     assert stored_news.user_email_list == f"['{encode_email(emails[0])}']"
 
-    response = await async_client.post(
-        f"/api/news/{stored_news.id}/like",
+    response: Response = await async_client.post(
+        url=f"/api/news/{stored_news.id}/like",
         headers={**valid_auth_headers, "user-email": emails[1]},
     )
     assert response.status_code == status.HTTP_200_OK
@@ -403,8 +400,8 @@ async def test_news_likes_endpoint(
     )
 
     # Remove likes
-    response = await async_client.delete(
-        f"/api/news/{stored_news.id}/like",
+    response: Response = await async_client.delete(
+        url=f"/api/news/{stored_news.id}/like",
         headers={**valid_auth_headers, "user-email": emails[0]},
     )
     assert response.status_code == status.HTTP_200_OK
@@ -415,8 +412,8 @@ async def test_news_likes_endpoint(
     assert stored_news.likes == 1
     assert stored_news.user_email_list == f"['{encode_email(emails[1])}']"
 
-    response = await async_client.delete(
-        f"/api/news/{stored_news.id}/like",
+    response: Response = await async_client.delete(
+        url=f"/api/news/{stored_news.id}/like",
         headers={**valid_auth_headers, "user-email": emails[1]},
     )
     assert response.status_code == status.HTTP_200_OK