Add better categories

Author: erwindouna

src/pyfirefly/pyfirefly.py

@@ -231,7 +231,35 @@ async def get_transactions(
 
         return [Transaction.from_dict(tx) for tx in transactions]
 
-    async def get_categories(self, category_id: int, start: str | None = None, end: str | None = None) -> Category:
+    async def get_categories(self) -> list[Category]:
+        """Get all categories from the Firefly server.
+
+        Returns
+        -------
+            A list of Category objects containing category information.
+
+        """
+        categories: list[dict[str, Any]] = []
+        next_page: int | None = 1
+
+        while next_page:
+            response = await self._request(
+                uri="categories",
+                method="GET",
+                params={"page": next_page},
+            )
+
+            categories.extend(response["data"])
+
+            pagination = response.get("meta", {}).get("pagination", {})
+            current_page = int(pagination.get("current_page", 1) or 1)
+            total_pages = int(pagination.get("total_pages", 1) or 1)
+
+            next_page = current_page + 1 if current_page < total_pages else None
+
+        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:
         """Get a specific category by its ID.
 
         Args:

tests/__snapshots__/test_models.ambr

@@ -39,6 +39,11 @@
     Budget(type='budgets', id='2', attributes=BudgetAttributes(created_at='2018-09-17T12:46:47+01:00', updated_at='2018-09-17T12:46:47+01:00', name='Bills', active=False, notes='Some notes', order=5, auto_budget_type='reset', currency_id='12', currency_code='EUR', currency_symbol='$', currency_decimal_places=2, native_currency_id='5', native_currency_code='EUR', native_currency_symbol='$', native_currency_decimal_places=2, auto_budget_amount='-1012.12', native_auto_budget_amount='-1012.12', auto_budget_period='monthly', spent=[BudgetSpent(sum='123.45', currency_id='5', currency_code='USD', currency_symbol='$', currency_decimal_places=2)])),
   ])
 # ---
+# name: test_categories_model
+  list([
+    Category(type='categories', id='2', attributes=CategoryAttributes(created_at='2018-09-17T12:46:47+01:00', updated_at='2018-09-17T12:46:47+01:00', name='Lunch', notes='Some example notes', native_currency_id='5', native_currency_code='EUR', native_currency_symbol='$', native_currency_decimal_places=2, spent=[CategoryAmount(currency_id='5', currency_code='USD', currency_symbol='$', currency_decimal_places=2, sum='-12423.45')], earned=[CategoryAmount(currency_id='5', currency_code='USD', currency_symbol='$', currency_decimal_places=2, sum='123.45')])),
+  ])
+# ---
 # name: test_category_model
   Category(type='categories', id='2', attributes=CategoryAttributes(created_at='2018-09-17T12:46:47+01:00', updated_at='2018-09-17T12:46:47+01:00', name='Lunch', notes='Some example notes', native_currency_id='5', native_currency_code='EUR', native_currency_symbol='$', native_currency_decimal_places=2, spent=[CategoryAmount(currency_id='5', currency_code='USD', currency_symbol='$', currency_decimal_places=2, sum='-12423.45')], earned=[CategoryAmount(currency_id='5', currency_code='USD', currency_symbol='$', currency_decimal_places=2, sum='123.45')]))
 # ---

tests/fixtures/categories.json

@@ -0,0 +1,45 @@
+{
+    "data": [
+      {
+        "type": "categories",
+        "id": "2",
+        "attributes": {
+          "created_at": "2018-09-17T12:46:47+01:00",
+          "updated_at": "2018-09-17T12:46:47+01:00",
+          "name": "Lunch",
+          "notes": "Some example notes",
+          "native_currency_id": "5",
+          "native_currency_code": "EUR",
+          "native_currency_symbol": "$",
+          "native_currency_decimal_places": 2,
+          "spent": [
+            {
+              "currency_id": "5",
+              "currency_code": "USD",
+              "currency_symbol": "$",
+              "currency_decimal_places": 2,
+              "sum": "-12423.45"
+            }
+          ],
+          "earned": [
+            {
+              "currency_id": "5",
+              "currency_code": "USD",
+              "currency_symbol": "$",
+              "currency_decimal_places": 2,
+              "sum": "123.45"
+            }
+          ]
+        }
+      }
+    ],
+    "meta": {
+      "pagination": {
+        "total": 3,
+        "count": 20,
+        "per_page": 100,
+        "current_page": 1,
+        "total_pages": 1
+      }
+    }
+  }

tests/test_models.py

@@ -109,8 +109,8 @@ async def test_category_model(
         ),
     )
 
-    categories = await firefly_client.get_categories(category_id=1, start="2025-01-01", end="2025-12-31")
-    assert categories == snapshot
+    category = await firefly_client.get_category(category_id=1, start="2025-01-01", end="2025-12-31")
+    assert category == snapshot
 
     # Now without a date range
     aresponses.add(
@@ -124,7 +124,28 @@ async def test_category_model(
         ),
     )
 
-    categories = await firefly_client.get_categories(category_id=1)
+    category = await firefly_client.get_category(category_id=1)
+    assert category == snapshot
+
+
+async def test_categories_model(
+    aresponses: ResponsesMockServer,
+    firefly_client: Firefly,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test the Categories model."""
+    aresponses.add(
+        "localhost:9000",
+        "/api/v1/categories",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/vnd.api+json"},
+            text=load_fixtures("categories.json"),
+        ),
+    )
+
+    categories = await firefly_client.get_categories()
     assert categories == snapshot