Merge pull request #1147 from codeWithGodstime/feat/filter_faq_by_category

feat: modified the query parameter to all filtering faq by category

Author: joboy-dev

.env.sample

@@ -42,4 +42,4 @@ MAILJET_API_SECRET='SECRET KEY'
 
 APP_NAME="fastapi_boilerplate"
 
-TELEX_WEBHOOK_URL=""
+TELEX_WEBHOOK_URL=""

api/v1/routes/faq.py

@@ -18,25 +18,28 @@
 @faq.get("", response_model=success_response, status_code=200)
 async def get_all_faqs(
     db: Session = Depends(get_db),
-    keyword: Optional[str] = Query(None, min_length=1)
+    keyword: Optional[str] = Query(None, min_length=1),
+    category: Optional[str] = Query(None, min_length=1)
 ):
     """Endpoint to get all FAQs or search by keyword in both question and answer"""
 
     query_params = {}
     if keyword:
         query_params["question"] = keyword
         query_params["answer"] = keyword
+    if category:
+        query_params["category"] = category
 
     grouped_faqs = faq_service.fetch_all_grouped_by_category(
-        db=db, **query_params)
+        db=db, **query_params
+    )
 
     return success_response(
         status_code=200,
         message="FAQs retrieved successfully",
         data=jsonable_encoder(grouped_faqs),
     )
 
-
 @faq.post("", response_model=success_response, status_code=201)
 async def create_faq(
     schema: CreateFAQ,

tests/v1/faq/filter_faq_by_category_test.py

@@ -0,0 +1,63 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+from fastapi.testclient import TestClient
+from sqlalchemy.orm import Session
+
+from api.db.database import get_db
+from api.v1.services.faq import faq_service
+from main import app
+
+
+@pytest.fixture
+def mock_db_session():
+    db_session = MagicMock(spec=Session)
+    return db_session
+
+
+@pytest.fixture
+def client(mock_db_session):
+    app.dependency_overrides[get_db] = lambda: mock_db_session
+    client = TestClient(app)
+    yield client
+    app.dependency_overrides = {}
+
+
+def test_filter_faq_by_category(mock_db_session, client):
+    """Test to verify the response for filtering FAQs by category."""
+
+    mock_faq_data_grouped = {
+        "General": [
+            {"question": "What is FastAPI?",
+                "answer": "FastAPI is a modern web framework for Python."},
+            {"question": "What is SQLAlchemy?",
+                "answer": "SQLAlchemy is a SQL toolkit and ORM for Python."}
+        ]
+    }
+
+    with patch.object(faq_service, 'fetch_all_grouped_by_category', return_value=mock_faq_data_grouped):
+        response = client.get('/api/v1/faqs/?category=General')
+        response_data = response.json()
+
+    assert response.status_code == 200
+    assert response_data["status_code"] == 200
+    assert response_data["message"] == "FAQs retrieved successfully"
+    assert "General" in response_data["data"]
+    assert len(response_data["data"]["General"]) == 2
+    assert response_data["data"]["General"][0]["question"] == "What is FastAPI?"
+    assert response_data["data"]["General"][1]["question"] == "What is SQLAlchemy?"
+
+
+def test_filter_faq_category_not_found(mock_db_session, client):
+    """Test when the requested category does not exist."""
+
+    mock_faq_data_grouped = {}
+
+    with patch.object(faq_service, 'fetch_all_grouped_by_category', return_value=mock_faq_data_grouped):
+        response = client.get('/api/v1/faqs/?category=UnknownCategory')
+        response_data = response.json()
+
+    assert response.status_code == 200
+    assert response_data["status_code"] == 200
+    assert response_data["message"] == "FAQs retrieved successfully"
+    assert response_data["data"] == {}