Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add custom handler for the German bank Rheinhessen Sparkasse to the GoCardless app #454

Merged
merged 12 commits into from
Sep 26, 2024
Merged

Add custom handler for the German bank Rheinhessen Sparkasse to the GoCardless app #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e0c4a30
Add custom handler for the German bank Rheinhessen Sparkasse to the G…
DirgoSalga Sep 14, 2024
9ee4421
FIx linting errors and add release notes
DirgoSalga Sep 15, 2024
be81684
FIx linting errors (second try) and fix error in the release notes
DirgoSalga Sep 15, 2024
5b53bf7
Fix linting errors
DirgoSalga Sep 15, 2024
7ce4c90
Merge branch 'master' into bank-rheinhessen-sparkasse
DirgoSalga Sep 18, 2024
42b6053
Update src/app-gocardless/bank-factory.js
DirgoSalga Sep 20, 2024
2a99577
Update src/app-gocardless/bank-factory.js
DirgoSalga Sep 20, 2024
ca314e2
Update src/app-gocardless/banks/spk_worms_alzey_ried_malade51wor.js
DirgoSalga Sep 20, 2024
ebc0e5c
Update upcoming-release-notes/454.md
DirgoSalga Sep 20, 2024
94f67b6
Rename file "spk-worms-alzey-ried-malade51wor.js"
DirgoSalga Sep 20, 2024
5a84b18
Remove functions normalizeAccount and CalculateStartingBalance
DirgoSalga Sep 25, 2024
87b2080
Correct linting error
DirgoSalga Sep 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions src/app-gocardless/bank-factory.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import SandboxfinanceSfin0000 from './banks/sandboxfinance-sfin0000.js';
import SparNordSpNoDK22 from './banks/sparnord-spnodk22.js';
import SpkKarlsruhekarsde66 from './banks/spk-karlsruhe-karsde66.js';
import SpkMarburgBiedenkopfHeladef1mar from './banks/spk-marburg-biedenkopf-heladef1mar.js';
import SpkWormsAlzeyRiedMalade51wor from './banks/spk-worms-alzey-ried-malade51wor.js';
matt-fidd marked this conversation as resolved.
Show resolved Hide resolved
import VirginNrnbgb22 from './banks/virgin_nrnbgb22.js';
import NbgEthngraaxxx from './banks/nbg_ethngraaxxx.js';

Expand Down Expand Up @@ -51,6 +52,7 @@ export const banks = [
SparNordSpNoDK22,
SpkKarlsruhekarsde66,
SpkMarburgBiedenkopfHeladef1mar,
SpkWormsAlzeyRiedMalade51wor,
VirginNrnbgb22,
NbgEthngraaxxx,
];
Expand Down
29 changes: 29 additions & 0 deletions src/app-gocardless/banks/spk-worms-alzey-ried-malade51wor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
import Fallback from './integration-bank.js';

import { formatPayeeName } from '../../util/payee-name.js';

/** @type {import('./bank.interface.js').IBank} */
export default {
...Fallback,

institutionIds: ['SPK_WORMS_ALZEY_RIED_MALADE51WOR'],

accessValidForDays: 90,

normalizeTransaction(transaction, _booked) {
const date = transaction.bookingDate || transaction.valueDate;
if (!date) {
return null;
}

transaction.remittanceInformationUnstructured =
transaction.remittanceInformationUnstructured ??
transaction.remittanceInformationStructured ??
transaction.remittanceInformationStructuredArray?.join(' ');
matt-fidd marked this conversation as resolved.
Show resolved Hide resolved
return {
...transaction,
payeeName: formatPayeeName(transaction),
date: transaction.bookingDate || transaction.valueDate,
};
},
Comment on lines +13 to +28
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Refactor to avoid mutating the transaction object

The normalizeTransaction function is mostly well-implemented, but there's an issue with directly mutating the transaction object. This was correctly identified in a previous review comment. Let's address this to improve the function's immutability.

Apply this diff to refactor the function:

 normalizeTransaction(transaction, _booked) {
   const date = transaction.bookingDate || transaction.valueDate;
   if (!date) {
     return null;
   }

-  transaction.remittanceInformationUnstructured =
-    transaction.remittanceInformationUnstructured ??
-    transaction.remittanceInformationStructured ??
-    transaction.remittanceInformationStructuredArray?.join(' ');
   return {
     ...transaction,
+    remittanceInformationUnstructured:
+      transaction.remittanceInformationUnstructured ??
+      transaction.remittanceInformationStructured ??
+      transaction.remittanceInformationStructuredArray?.join(' '),
     payeeName: formatPayeeName(transaction),
     date: transaction.bookingDate || transaction.valueDate,
   };
 },

This change ensures that we're not modifying the original transaction object, which aligns better with immutability principles and prevents potential side effects.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
normalizeTransaction(transaction, _booked) {
const date = transaction.bookingDate || transaction.valueDate;
if (!date) {
return null;
}
transaction.remittanceInformationUnstructured =
transaction.remittanceInformationUnstructured ??
transaction.remittanceInformationStructured ??
transaction.remittanceInformationStructuredArray?.join(' ');
return {
...transaction,
payeeName: formatPayeeName(transaction),
date: transaction.bookingDate || transaction.valueDate,
};
},
normalizeTransaction(transaction, _booked) {
const date = transaction.bookingDate || transaction.valueDate;
if (!date) {
return null;
}
return {
...transaction,
remittanceInformationUnstructured:
transaction.remittanceInformationUnstructured ??
transaction.remittanceInformationStructured ??
transaction.remittanceInformationStructuredArray?.join(' '),
payeeName: formatPayeeName(transaction),
date: transaction.bookingDate || transaction.valueDate,
};
},

};
6 changes: 6 additions & 0 deletions upcoming-release-notes/454.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
category: Enhancements
authors: [DirgoSalga]
---

Add integration of Rheinhessen Sparkasse (`SPK_WORMS_ALZEY_RIED_MALADE51WOR`) to the GoCardless app