Add currencies

Author: erwindouna

src/pyfirefly/models.py

@@ -327,3 +327,27 @@ class PreferencesAttributes(DataClassORJSONMixin):
     user_group_id: int | None = None
     name: str | None = None
     data: str | bool | None = None
+
+
+@dataclass
+class Currency(DataClassORJSONMixin):
+    """Model for a Firefly currency."""
+
+    type: str
+    id: str
+    attributes: CurrencyAttributes
+
+
+@dataclass
+class CurrencyAttributes(DataClassORJSONMixin):
+    """Attributes of a Firefly currency."""
+
+    created_at: str | None = None
+    updated_at: str | None = None
+    enabled: bool | None = None
+    default: bool | None = None
+    native: bool | None = None
+    code: str | None = None
+    name: str | None = None
+    symbol: str | None = None
+    decimal_places: int | None = None

src/pyfirefly/pyfirefly.py

@@ -26,6 +26,7 @@
     Bill,
     Budget,
     Category,
+    Currency,
     Preferences,
     Transaction,
 )
@@ -348,6 +349,28 @@ async def get_preferences(self) -> list[Preferences]:
         preferences = await self._request("preferences")
         return [Preferences.from_dict(pref) for pref in preferences["data"]]
 
+    async def get_currencies(self) -> list[Currency]:
+        """Get currencies from the Firefly server.
+
+        Returns
+        -------
+            A list of Currency objects containing the currencies.
+
+        """
+        currencies = await self._request("currencies")
+        return [Currency.from_dict(cur) for cur in currencies["data"]]
+
+    async def get_currency_native(self) -> Currency:
+        """Get the native currency of the current administration.
+
+        Returns
+        -------
+            A Currency object containing the native currency symbol.
+
+        """
+        currency = await self._request("currencies/native")
+        return Currency.from_dict(currency["data"])
+
     async def close(self) -> None:
         """Close open client session."""
         if self._session and self._close_session:

tests/__snapshots__/test_models.ambr

@@ -50,6 +50,14 @@
 # name: test_category_model.1
   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_currencies_model
+  list([
+    Currency(type='currencies', id='2', attributes=CurrencyAttributes(created_at='2018-09-17T12:46:47+01:00', updated_at='2018-09-17T12:46:47+01:00', enabled=True, default=False, native=False, code='AMS', name='Ankh-Morpork dollar', symbol='AM$', decimal_places=2)),
+  ])
+# ---
+# name: test_currency_native_model
+  Currency(type='currencies', id='2', attributes=CurrencyAttributes(created_at='2018-09-17T12:46:47+01:00', updated_at='2018-09-17T12:46:47+01:00', enabled=True, default=False, native=False, code='AMS', name='Ankh-Morpork dollar', symbol='AM$', decimal_places=2))
+# ---
 # name: test_preferences_model
   list([
     Preferences(type='preferences', id=2),

tests/fixtures/currencies.json

@@ -0,0 +1,35 @@
+{
+    "data": [
+      {
+        "type": "currencies",
+        "id": "2",
+        "attributes": {
+          "created_at": "2018-09-17T12:46:47+01:00",
+          "updated_at": "2018-09-17T12:46:47+01:00",
+          "enabled": true,
+          "default": false,
+          "native": false,
+          "code": "AMS",
+          "name": "Ankh-Morpork dollar",
+          "symbol": "AM$",
+          "decimal_places": 2
+        }
+      }
+    ],
+    "meta": {
+      "pagination": {
+        "total": 3,
+        "count": 20,
+        "per_page": 100,
+        "current_page": 1,
+        "total_pages": 1
+      }
+    },
+    "links": {
+      "self": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=4",
+      "first": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=1",
+      "next": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=3",
+      "prev": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=2",
+      "last": "https://demo.firefly-iii.org/api/v1/OBJECT?&page=12"
+    }
+  }

tests/fixtures/currency_native.json

@@ -0,0 +1,17 @@
+{
+    "data": {
+      "type": "currencies",
+      "id": "2",
+      "attributes": {
+        "created_at": "2018-09-17T12:46:47+01:00",
+        "updated_at": "2018-09-17T12:46:47+01:00",
+        "enabled": true,
+        "default": false,
+        "native": false,
+        "code": "AMS",
+        "name": "Ankh-Morpork dollar",
+        "symbol": "AM$",
+        "decimal_places": 2
+      }
+    }
+  }

tests/test_models.py

@@ -240,3 +240,45 @@ async def test_preferences_model(
 
     preferences = await firefly_client.get_preferences()
     assert preferences == snapshot
+
+
+async def test_currencies_model(
+    aresponses: ResponsesMockServer,
+    firefly_client: Firefly,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test the Currencies model."""
+    aresponses.add(
+        "localhost:9000",
+        "/api/v1/currencies",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/vnd.api+json"},
+            text=load_fixtures("currencies.json"),
+        ),
+    )
+
+    currencies = await firefly_client.get_currencies()
+    assert currencies == snapshot
+
+
+async def test_currency_native_model(
+    aresponses: ResponsesMockServer,
+    firefly_client: Firefly,
+    snapshot: SnapshotAssertion,
+) -> None:
+    """Test the Currency Native model."""
+    aresponses.add(
+        "localhost:9000",
+        "/api/v1/currencies/native",
+        "GET",
+        aresponses.Response(
+            status=200,
+            headers={"Content-Type": "application/vnd.api+json"},
+            text=load_fixtures("currency_native.json"),
+        ),
+    )
+
+    currency_native = await firefly_client.get_currency_native()
+    assert currency_native == snapshot