feat: Add unit tests and small fixes to security

Author: wizrds

asknews_sdk/api/stories.py

@@ -135,6 +135,7 @@ def get_story(
         max_articles: int = 5,
         reddit: int = 0,
         citation_method: Literal["brackets", "urls", "none"] = "brackets",
+        condense_auxillary_updates: bool = False,
     ) -> StoryResponse:
         """
         Get a single news story given the ID.
@@ -151,6 +152,10 @@ def get_story(
         :type max_articles: int
         :param reddit: Amount of reddit threads to include per update.
         :type reddit: int
+        :param citation_method: The citation method.
+        :type citation_method: Literal["brackets", "urls", "none"]
+        :param condense_auxillary_updates: Whether to condense auxillary updates.
+        :type condense_auxillary_updates: bool
         :return: The story response.
         :rtype: StoryResponse
         """
@@ -163,6 +168,7 @@ def get_story(
                 "max_articles": max_articles,
                 "reddit": reddit,
                 "citation_method": citation_method,
+                "condense_auxillary_updates": condense_auxillary_updates,
             },
             params={"story_id": story_id},
             accept=[(StoryResponse.__content_type__, 1.0)],

asknews_sdk/security.py

@@ -146,7 +146,11 @@ def sync_auth_flow(self, request: Request) -> Generator[Request, Response, None]
 
         yield self.inject_headers(request)
 
-        if self._token_save_hook and inspect.isfunction(self._token_save_hook):
+        if (
+            self._token_save_hook
+            and inspect.isfunction(self._token_save_hook)
+            and not inspect.iscoroutinefunction(self._token_save_hook)
+        ):
             with self._token_lock:
                 self._token_save_hook(self.token.token_info)
 

poetry.lock

@@ -26,9 +26,11 @@ pre-commit = "^3.3.2"
 gitlint = "^0.19.1"
 commitizen = "^3.25.0"
 respx = "^0.21.1"
+polyfactory = "^2.16.0"
 
 [tool.ruff]
 line-length = 100
+exclude = ["tests"]
 
 [tool.ruff.lint]
 select = ["E", "W", "F", "I", "C", "B"]

pyproject.toml

@@ -0,0 +1,74 @@
+from datetime import datetime, timedelta
+from urllib.parse import parse_qs
+
+import pytest
+from polyfactory.factories.pydantic_factory import ModelFactory
+from respx import MockRouter
+
+from asknews_sdk.api.analytics import AnalyticsAPI, AsyncAnalyticsAPI
+from asknews_sdk.client import APIClient, AsyncAPIClient
+from asknews_sdk.dto.sentiment import FinanceResponse
+
+
+class MockFinanceResponse(ModelFactory[FinanceResponse]):
+    ...
+
+
+@pytest.fixture
+def sync_analytics_api(sync_api_client: APIClient):
+    return AnalyticsAPI(sync_api_client)
+
+
+@pytest.fixture
+def async_analytics_api(async_api_client: AsyncAPIClient):
+    return AsyncAnalyticsAPI(async_api_client)
+
+
+def test_sync_analytics_api_get_asset_sentiment(
+    sync_analytics_api: AnalyticsAPI, response_mock: MockRouter
+):
+    asset = "bitcoin"
+    date_from = datetime.now() - timedelta(days=1)
+    date_to = datetime.now()
+    mock_response = MockFinanceResponse.build()
+
+    response_mock.get("/v1/analytics/finance/sentiment").respond(content=mock_response.model_dump_json())
+
+    response = sync_analytics_api.get_asset_sentiment(asset, date_from=date_from, date_to=date_to)
+
+    assert isinstance(response, FinanceResponse)
+    assert response.__content_type__ == mock_response.__content_type__
+    assert response.model_dump() == mock_response.model_dump()
+
+    assert parse_qs(response_mock.calls.last.request.url.query.decode()) == {
+        "asset": [asset],
+        "metric": ["news_positive"],  # Default value
+        "date_from": [date_from.isoformat()],
+        "date_to": [date_to.isoformat()],
+    }
+
+
+async def test_async_analytics_api_get_asset_sentiment(
+    async_analytics_api: AsyncAnalyticsAPI, response_mock: MockRouter
+):
+    asset = "bitcoin"
+    date_from = datetime.now() - timedelta(days=1)
+    date_to = datetime.now()
+    mock_response = MockFinanceResponse.build()
+
+    response_mock.get("/v1/analytics/finance/sentiment").respond(content=mock_response.model_dump_json())
+
+    response = await async_analytics_api.get_asset_sentiment(
+        asset, date_from=date_from, date_to=date_to
+    )
+
+    assert isinstance(response, FinanceResponse)
+    assert response.__content_type__ == mock_response.__content_type__
+    assert response.model_dump() == mock_response.model_dump()
+
+    assert parse_qs(response_mock.calls.last.request.url.query.decode()) == {
+        "asset": [asset],
+        "metric": ["news_positive"],  # Default value
+        "date_from": [date_from.isoformat()],
+        "date_to": [date_to.isoformat()],
+    }