ofxstatement-nordigen 0.1__tar.gz → 0.1.2__tar.gz

{ofxstatement_nordigen-0.1/src/ofxstatement_nordigen.egg-info → ofxstatement_nordigen-0.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ofxstatement-nordigen
-Version: 0.1
+Version: 0.1.2
 Summary: ofxstatement plugin for Nordigen bank statements
 Author-email: Jimmy Stammers <jimmy.stammers@gmail.com>
 Project-URL: Homepage, https://github.com/jstammers/ofxstatement-nordigen/
@@ -57,18 +57,18 @@ To verify that the plugin is installed correctly, you can run:
 
     ofxstatement --list-plugins
 
-This should list the `nordigen` plugin among other plugins.
+This should list the ``nordigen`` plugin among other plugins.
 
 Usage
 ================
 
-To use the plugin, you can run the `ofxstatement` command with the `--plugin` option:
+To use the plugin, you can run the ``ofxstatement`` command with the ``--plugin`` option:
 
 .. code-block:: shell
 
     ofxstatement convert -t nordigen <input_file> <output_file>
 
-Replace `<input_file>` with the path to your input file and `<output_file>` with the desired output file name.
+Replace ``<input_file>`` with the path to your input file and ``<output_file>`` with the desired output file name.
 
 The input file should be a JSON of transactions from GoCardless that has the schema defined `here`_.
 
@@ -76,6 +76,15 @@ The input file should be a JSON of transactions from GoCardless that has the sch
 
 The output file will be an OFX file that can be imported into GnuCash or other financial software.
 
+Configuration
+================
+
+Configuration can be edited using the ``ofxstatement edit-config`` command.
+The following parameters are available:
+
+- ``account_id``: The account ID to use for the transactions. This is required.
+- ``currency``: The currency to use for the account. If not specified, the currency will be determined from the transactions.
+
 After you are done
 ==================
 

{ofxstatement_nordigen-0.1 → ofxstatement_nordigen-0.1.2}/README.rst

@@ -35,18 +35,18 @@ To verify that the plugin is installed correctly, you can run:
 
     ofxstatement --list-plugins
 
-This should list the `nordigen` plugin among other plugins.
+This should list the ``nordigen`` plugin among other plugins.
 
 Usage
 ================
 
-To use the plugin, you can run the `ofxstatement` command with the `--plugin` option:
+To use the plugin, you can run the ``ofxstatement`` command with the ``--plugin`` option:
 
 .. code-block:: shell
 
     ofxstatement convert -t nordigen <input_file> <output_file>
 
-Replace `<input_file>` with the path to your input file and `<output_file>` with the desired output file name.
+Replace ``<input_file>`` with the path to your input file and ``<output_file>`` with the desired output file name.
 
 The input file should be a JSON of transactions from GoCardless that has the schema defined `here`_.
 
@@ -54,6 +54,15 @@ The input file should be a JSON of transactions from GoCardless that has the sch
 
 The output file will be an OFX file that can be imported into GnuCash or other financial software.
 
+Configuration
+================
+
+Configuration can be edited using the ``ofxstatement edit-config`` command.
+The following parameters are available:
+
+- ``account_id``: The account ID to use for the transactions. This is required.
+- ``currency``: The currency to use for the account. If not specified, the currency will be determined from the transactions.
+
 After you are done
 ==================
 

{ofxstatement_nordigen-0.1 → ofxstatement_nordigen-0.1.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "ofxstatement-nordigen"
-version = "0.1"
+version = "0.1.2"
 authors = [
   { name="Jimmy Stammers", email="jimmy.stammers@gmail.com" },
 ]

{ofxstatement_nordigen-0.1 → ofxstatement_nordigen-0.1.2}/src/ofxstatement_nordigen/plugin.py

@@ -1,6 +1,6 @@
 import json
-from typing import Iterable
-
+from typing import Iterable, Optional
+from datetime import datetime
 from ofxstatement.plugin import Plugin
 from ofxstatement.parser import StatementParser
 from ofxstatement.statement import Statement, StatementLine
@@ -12,15 +12,24 @@ class NordigenPlugin(Plugin):
     """Retrieves Nordigen transactions and converts them to OFX format."""
 
     def get_parser(self, filename: str) -> "NordigenParser":
-        return NordigenParser(filename)
+        default_ccy = self.settings.get("currency")
+        account_id = self.settings.get("account")
+        return NordigenParser(filename, default_ccy, account_id)
 
 
 class NordigenParser(StatementParser[str]):
-    def __init__(self, filename: str) -> None:
+    def __init__(
+        self,
+        filename: str,
+        currency: Optional[str] = None,
+        account_id: Optional[str] = None,
+    ) -> None:
         super().__init__()
         if not filename.endswith(".json"):
             raise ValueError("Only JSON files are supported")
         self.filename = filename
+        self.currency = currency
+        self.account_id = account_id
 
     def parse(self) -> Statement:
         """Main entry point for parsers
@@ -29,7 +38,16 @@ class NordigenParser(StatementParser[str]):
         process the file.
         """
         with open(self.filename, "r"):
-            return super().parse()
+            statement = super().parse()
+            dates = [
+                line.date for line in statement.lines if isinstance(line.date, datetime)
+            ]
+            if len(dates) > 0:
+                statement.start_date = min(dates)
+                statement.end_date = max(dates)
+            statement.account_id = self.account_id
+            statement.currency = self.currency or statement.currency
+            return statement
 
     def split_records(self) -> Iterable[str]:
         """Return iterable object consisting of a line per transaction"""

{ofxstatement_nordigen-0.1 → ofxstatement_nordigen-0.1.2}/src/ofxstatement_nordigen/schemas.py

@@ -22,24 +22,25 @@ class Amount(BaseModel):
         return value
 
 
-class InstructedAmount(Amount):
-    targetCurrency: Optional[Currency] = None
+class Account(BaseModel):
+    bban: Optional[str] = None
+
+
+class CurrencyExchange(BaseModel):
     sourceCurrency: Optional[Currency] = None
+    targetCurrency: Optional[Currency] = None
+    unitCurrency: Optional[Currency] = None
     exchangeRate: Optional[float] = None
+    instructedAmount: Optional[Amount] = None
 
-    @field_validator("targetCurrency", "sourceCurrency", mode="before")
+    @field_validator("sourceCurrency", "targetCurrency", "unitCurrency", mode="before")
     def validate_currency(cls, value):
         if isinstance(value, str):
             return Currency(value)
         return value
 
-
-class Account(BaseModel):
-    bban: Optional[str] = None
-
-
-class ReportExchangeRate(BaseModel):
-    instructedAmount: Optional[InstructedAmount] = None
+    class Config:
+        arbitrary_types_allowed = True
 
 
 class NordigenTransactionModel(BaseModel):
@@ -56,7 +57,7 @@ class NordigenTransactionModel(BaseModel):
     creditorAgent: Optional[str] = None
     creditorId: Optional[str] = None
     creditorName: Optional[str] = None
-    currencyExchange: Optional[Union[ReportExchangeRate, InstructedAmount]] = None
+    currencyExchange: Optional[CurrencyExchange] = None
     debtorAccount: Optional[Account] = None
     debtorAgent: Optional[str] = None
     debtorName: Optional[str] = None

{ofxstatement_nordigen-0.1 → ofxstatement_nordigen-0.1.2/src/ofxstatement_nordigen.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ofxstatement-nordigen
-Version: 0.1
+Version: 0.1.2
 Summary: ofxstatement plugin for Nordigen bank statements
 Author-email: Jimmy Stammers <jimmy.stammers@gmail.com>
 Project-URL: Homepage, https://github.com/jstammers/ofxstatement-nordigen/
@@ -57,18 +57,18 @@ To verify that the plugin is installed correctly, you can run:
 
     ofxstatement --list-plugins
 
-This should list the `nordigen` plugin among other plugins.
+This should list the ``nordigen`` plugin among other plugins.
 
 Usage
 ================
 
-To use the plugin, you can run the `ofxstatement` command with the `--plugin` option:
+To use the plugin, you can run the ``ofxstatement`` command with the ``--plugin`` option:
 
 .. code-block:: shell
 
     ofxstatement convert -t nordigen <input_file> <output_file>
 
-Replace `<input_file>` with the path to your input file and `<output_file>` with the desired output file name.
+Replace ``<input_file>`` with the path to your input file and ``<output_file>`` with the desired output file name.
 
 The input file should be a JSON of transactions from GoCardless that has the schema defined `here`_.
 
@@ -76,6 +76,15 @@ The input file should be a JSON of transactions from GoCardless that has the sch
 
 The output file will be an OFX file that can be imported into GnuCash or other financial software.
 
+Configuration
+================
+
+Configuration can be edited using the ``ofxstatement edit-config`` command.
+The following parameters are available:
+
+- ``account_id``: The account ID to use for the transactions. This is required.
+- ``currency``: The currency to use for the account. If not specified, the currency will be determined from the transactions.
+
 After you are done
 ==================
 

{ofxstatement_nordigen-0.1 → ofxstatement_nordigen-0.1.2}/tests/test_sample.py

@@ -6,6 +6,24 @@ from ofxstatement_nordigen.plugin import NordigenPlugin, NordigenParser
 from ofxstatement import ofx
 
 
+def test_config_sets_account_and_currency() -> None:
+    """Test that account and currency are set correctly when provided in config."""
+    # Create a plugin with specific account and currency settings
+    settings = {"account": "test-account-123", "currency": "EUR"}
+    plugin = NordigenPlugin(UI(), settings)
+
+    here = os.path.dirname(__file__)
+    sample_filename = os.path.join(here, "sample-statement.json")
+    parser = plugin.get_parser(sample_filename)
+
+    assert parser.account_id == settings["account"]
+    assert parser.currency == settings["currency"]
+
+    statement = parser.parse()
+    assert statement.account_id == settings["account"]
+    assert statement.currency == settings["currency"]
+
+
 def test_sample() -> None:
     plugin = NordigenPlugin(UI(), {})
     here = os.path.dirname(__file__)
@@ -15,6 +33,8 @@ def test_sample() -> None:
             parser = plugin.get_parser(sample_filename)
             statement = parser.parse()
             assert len(statement.lines) > 0
+            assert statement.start_date is not None
+            assert statement.end_date is not None
 
 
 @pytest.mark.parametrize("filename", ["test_date.json"])
@@ -30,13 +50,12 @@ def test_parse_record(filename: str) -> None:
     writer = ofx.OfxWriter(statement)
     result = writer.toxml(pretty=True)
 
-    # Get everything between the <STMTTRNRS> and </STMTTRNRS> tags
+    # Get everything between the <STMTTRN> and </STMTTRN> tags
     result = result[
-        result.index("<STMTTRNRS>") : result.index("</STMTTRNRS>") + len("</STMTTRNRS>")
+        result.index("<STMTTRN>") : result.index("</STMTTRN>") + len("</STMTTRN>")
     ]
     expected = expected[
-        expected.index("<STMTTRNRS>") : expected.index("</STMTTRNRS>")
-        + len("</STMTTRNRS>")
+        expected.index("<STMTTRN>") : expected.index("</STMTTRN>") + len("</STMTTRN>")
     ]
 
     assert result == expected

{ofxstatement_nordigen-0.1 → ofxstatement_nordigen-0.1.2}/tests/test_schemas.py

@@ -42,8 +42,25 @@ from ofxstatement_nordigen.schemas import NordigenTransactionModel
             },
             "internalTransactionId": "anonymized_internal_transaction_id",
         },
+        {
+            "transactionId": "anonymized_transaction_id",
+            "bookingDate": "2025-04-05",
+            "bookingDateTime": "2025-05-05T07:20:42.19Z",
+            "transactionAmount": {"amount": "-100.0000", "currency": "GBP"},
+            "currencyExchange": {
+                "instructedAmount": {"amount": "204.5010", "currency": "AUD"},
+                "sourceCurrency": "AUD",
+                "exchangeRate": "2.04501",
+                "unitCurrency": "GBP",
+                "targetCurrency": "GBP",
+            },
+            "remittanceInformationUnstructured": "anonymized_remittance_information",
+            "proprietaryBankTransactionCode": "anonymized_code",
+            "internalTransactionId": "anonymized_internal_transaction_id",
+        },
     ],
 )
 def test_go_cardless_transaction_model(data):
     validated = NordigenTransactionModel(**data)
+    print(validated)
     assert validated is not None