Merge pull request #10 from erwindouna/add-date-object

Add date object

Author: erwindouna

src/pyfirefly/pyfirefly.py

@@ -5,6 +5,7 @@
 import asyncio
 import socket
 from dataclasses import dataclass
+from datetime import datetime
 from importlib import metadata
 from typing import Any, Self
 from urllib.parse import urlparse
@@ -151,6 +152,20 @@ async def _request(
 
         return await response.json()
 
+    def _format_date(self, date_value: datetime | str) -> str:
+        """Format a date value to a string in 'YYYY-MM-DD' format.
+
+        Args:
+            date_value: A date object or a string representing a date.
+
+        Returns:
+            A string formatted as 'YYYY-MM-DD'.
+
+        """
+        if isinstance(date_value, datetime):
+            return date_value.strftime("%Y-%m-%d")
+        return date_value
+
     async def get_about(self) -> About:
         """Get information about the Firefly server.
 
@@ -194,8 +209,8 @@ async def get_accounts(self) -> list[Account]:
     async def get_transactions(
         self,
         account_id: int | None = None,
-        start: str | None = None,
-        end: str | None = None,
+        start: datetime | None = None,
+        end: datetime | None = None,
     ) -> list[Transaction]:
         """Get transactions for a specific account. Else, return all transactions.
 
@@ -220,9 +235,9 @@ async def get_transactions(
         while next_page:
             params: dict[str, str] = {"page": str(next_page)}
             if start:
-                params["start"] = start
+                params["start"] = self._format_date(start)
             if end:
-                params["end"] = end
+                params["end"] = self._format_date(end)
 
             response = await self._request(
                 uri=uri,
@@ -268,7 +283,12 @@ async def get_categories(self) -> list[Category]:
 
         return [Category.from_dict(cat) for cat in categories]
 
-    async def get_category(self, category_id: int, start: str | None = None, end: str | None = None) -> Category:
+    async def get_category(
+        self,
+        category_id: int,
+        start: datetime | None = None,
+        end: datetime | None = None,
+    ) -> Category:
         """Get a specific category by its ID.
 
         Args:
@@ -282,14 +302,14 @@ async def get_category(self, category_id: int, start: str | None = None, end: st
         """
         params: dict[str, str] = {}
         if start:
-            params["start"] = start
+            params["start"] = self._format_date(start)
         if end:
-            params["end"] = end
+            params["end"] = self._format_date(end)
 
         category = await self._request(uri=f"categories/{category_id}", params=params)
         return Category.from_dict(category["data"])
 
-    async def get_budgets(self, start: str | None = None, end: str | None = None) -> list[Budget]:
+    async def get_budgets(self, start: datetime | None = None, end: datetime | None = None) -> list[Budget]:
         """Get budgets for the Firefly server. Both start and end dates are required for date range filtering.
 
         Args:
@@ -302,13 +322,13 @@ async def get_budgets(self, start: str | None = None, end: str | None = None) ->
         """
         params: dict[str, str] = {}
         if start and end:
-            params["start"] = start
-            params["end"] = end
+            params["start"] = self._format_date(start)
+            params["end"] = self._format_date(end)
 
         budgets = await self._request(uri="budgets", params=params)
         return [Budget.from_dict(budget) for budget in budgets["data"]]
 
-    async def get_bills(self, start: str | None = None, end: str | None = None) -> list[Bill]:
+    async def get_bills(self, start: datetime | None = None, end: datetime | None = None) -> list[Bill]:
         """Get bills for the Firefly server. Both start and end dates are required for date range filtering.
 
         Args:
@@ -323,8 +343,8 @@ async def get_bills(self, start: str | None = None, end: str | None = None) -> l
         next_page: int | None = 1
         params: dict[str, str] = {"page": str(next_page)}
         if start and end:
-            params["start"] = start
-            params["end"] = end
+            params["start"] = self._format_date(start)
+            params["end"] = self._format_date(end)
 
         while next_page:
             response = await self._request(uri="bills", params=params)

tests/test_models.py

@@ -2,6 +2,7 @@
 
 from __future__ import annotations
 
+from datetime import datetime, timezone
 from typing import TYPE_CHECKING
 
 from aresponses import ResponsesMockServer
@@ -73,7 +74,11 @@ async def test_account_transactions_model(
         ),
     )
 
-    transactions = await firefly_client.get_transactions(account_id=1, start="2025-01-01", end="2025-12-31")
+    transactions = await firefly_client.get_transactions(
+        account_id=1,
+        start=datetime(2025, 1, 1, tzinfo=timezone.utc),
+        end=datetime(2025, 12, 31, tzinfo=timezone.utc),
+    )
     assert transactions == snapshot
 
     # Now for all transactions
@@ -109,7 +114,11 @@ async def test_category_model(
         ),
     )
 
-    category = await firefly_client.get_category(category_id=1, start="2025-01-01", end="2025-12-31")
+    category = await firefly_client.get_category(
+        category_id=1,
+        start=datetime(2025, 1, 1, tzinfo=timezone.utc),
+        end=datetime(2025, 12, 31, tzinfo=timezone.utc),
+    )
     assert category == snapshot
 
     # Now without a date range
@@ -166,7 +175,10 @@ async def test_budgets_model(
         ),
     )
 
-    budgets = await firefly_client.get_budgets(start="2025-01-01", end="2025-12-31")
+    budgets = await firefly_client.get_budgets(
+        start=datetime(2025, 1, 1, tzinfo=timezone.utc),
+        end=datetime(2025, 12, 31, tzinfo=timezone.utc),
+    )
     assert budgets == snapshot
 
     # Now without a date range
@@ -202,7 +214,10 @@ async def test_bills_model(
         ),
     )
 
-    bills = await firefly_client.get_bills(start="2025-01-01", end="2025-12-31")
+    bills = await firefly_client.get_bills(
+        start=datetime(2025, 1, 1, tzinfo=timezone.utc),
+        end=datetime(2025, 12, 31, tzinfo=timezone.utc),
+    )
     assert bills == snapshot
 
     # Now without a date range