diff --git a/account_statement_import_online_plaid/README.rst b/account_statement_import_online_plaid/README.rst new file mode 100644 index 000000000..58a89d891 --- /dev/null +++ b/account_statement_import_online_plaid/README.rst @@ -0,0 +1,126 @@ +================================= +Online Bank Statements: plaid.com +================================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:a7b84e04274ce7746346dbb4b33c1d2d98df5306dfde3a173ce2982576104eae + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fbank--statement--import-lightgray.png?logo=github + :target: https://github.com/OCA/bank-statement-import/tree/16.0/account_statement_import_online_plaid + :alt: OCA/bank-statement-import +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/bank-statement-import-16-0/bank-statement-import-16-0-account_statement_import_online_plaid + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png + :target: https://runboat.odoo-community.org/builds?repo=OCA/bank-statement-import&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module provides online bank statements from Plaid.com. + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +To configure online bank statements provider: + +#. Go to *Invoicing > Configuration > Bank Accounts* +#. Open bank account to configure and edit it +#. Set *Bank Feeds* to *Online* +#. Select *Plaid.com* as online bank statements provider in + *Online Bank Statements (OCA)* section +#. Save the bank account +#. Click on provider and configure provider-specific settings. + +or, alternatively: + +#. Go to *Invoicing > Overview* +#. Open settings of the corresponding journal account +#. Switch to *Bank Account* tab +#. Set *Bank Feeds* to *Online* +#. Select *Plaid.com* as online bank statements provider in + *Online Bank Statements (OCA)* section +#. Save the bank account +#. Click on provider and configure provider-specific settings. + +To obtain *Login* and *Key*: + +#. Open `Plaid.com `_. + +Check also ``account_bank_statement_import_online`` configuration instructions +for more information. + +Usage +===== + +To pull historical bank statements: + +#. Go to *Invoicing > Configuration > Bank Accounts* +#. Select specific bank accounts +#. Configure username, password and host for plaid +#. Launch *Actions > Sync with plaid.com* + +#. After launch *Actions > Online Bank Statements Pull Wizard* +#. Configure date interval and click *Pull* + +If historical data is not needed, then just simply wait for the scheduled +activity "Pull Online Bank Statements" to be executed for getting new +transactions. + +Bug Tracker +=========== + +Bugs are tracked on `GitHub Issues `_. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. + +Credits +======= + +Authors +~~~~~~~ + +* Binhex + +Contributors +~~~~~~~~~~~~ + +* `Binhex `_: + + * Adasat Torres de León + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use. + +This module is part of the `OCA/bank-statement-import `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/account_statement_import_online_plaid/__init__.py b/account_statement_import_online_plaid/__init__.py new file mode 100644 index 000000000..31660d6a9 --- /dev/null +++ b/account_statement_import_online_plaid/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import models diff --git a/account_statement_import_online_plaid/__manifest__.py b/account_statement_import_online_plaid/__manifest__.py new file mode 100644 index 000000000..2324047b7 --- /dev/null +++ b/account_statement_import_online_plaid/__manifest__.py @@ -0,0 +1,24 @@ +# Copyright 2024 Binhex - Adasat Torres de León. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +{ + "name": "Online Bank Statements: plaid.com", + "version": "16.0.1.0.0", + "category": "Account", + "website": "https://github.com/OCA/bank-statement-import", + "author": "Binhex, Odoo Community Association (OCA)", + "license": "AGPL-3", + "installable": True, + "depends": ["account_statement_import_online"], + "data": [ + "views/online_bank_statement_provider.xml", + ], + "assets": { + "web.assets_backend": [ + "/account_statement_import_online_plaid/static/src/**/*.js", + "https://cdn.plaid.com/link/v2/stable/link-initialize.js", + ], + }, + "external_dependencies": { + "python": ["plaid-python"], + }, +} diff --git a/account_statement_import_online_plaid/i18n/es.po b/account_statement_import_online_plaid/i18n/es.po new file mode 100644 index 000000000..478305b1a --- /dev/null +++ b/account_statement_import_online_plaid/i18n/es.po @@ -0,0 +1,102 @@ +# Translation of Odoo Server. +# This file contains the translation of the following modules: +# * account_statement_import_online_plaid +# +msgid "" +msgstr "" +"Project-Id-Version: Odoo Server 16.0-20240104\n" +"Report-Msgid-Bugs-To: \n" +"POT-Creation-Date: 2024-05-22 12:02+0000\n" +"PO-Revision-Date: 2024-05-22 13:04+0100\n" +"Last-Translator: \n" +"Language-Team: \n" +"Language: es\n" +"MIME-Version: 1.0\n" +"Content-Type: text/plain; charset=UTF-8\n" +"Content-Transfer-Encoding: 8bit\n" +"Plural-Forms: nplurals=2; plural=(n != 1);\n" +"X-Generator: Poedit 3.4.3\n" + +#. module: account_statement_import_online_plaid +#: model:ir.model.fields.selection,name:account_statement_import_online_plaid.selection__online_bank_statement_provider__plaid_host__development +msgid "Development" +msgstr "Desarrollo" + +#. module: account_statement_import_online_plaid +#. odoo-python +#: code:addons/account_statement_import_online_plaid/models/plaid_interface.py:0 +#, python-format +msgid "Error getting access token: %s" +msgstr "Error al obtener el token de acceso: %s" + +#. module: account_statement_import_online_plaid +#. odoo-python +#: code:addons/account_statement_import_online_plaid/models/plaid_interface.py:0 +#, python-format +msgid "Error getting client api: %s" +msgstr "Error obteniendo api de cliente: %s" + +#. module: account_statement_import_online_plaid +#. odoo-python +#: code:addons/account_statement_import_online_plaid/models/plaid_interface.py:0 +#, python-format +msgid "Error getting link token: %s" +msgstr "Error al obtener el token de enlace: %s" + +#. module: account_statement_import_online_plaid +#. odoo-python +#: code:addons/account_statement_import_online_plaid/models/plaid_interface.py:0 +#, python-format +msgid "Error getting transactions: %s" +msgstr "Error al obtener transacciones: %s" + +#. module: account_statement_import_online_plaid +#: model_terms:ir.ui.view,arch_db:account_statement_import_online_plaid.online_bank_statement_provider_form +msgid "Login" +msgstr "Iniciar sesión" + +#. module: account_statement_import_online_plaid +#: model:ir.model,name:account_statement_import_online_plaid.model_online_bank_statement_provider +msgid "Online Bank Statement Provider" +msgstr "Proveedor de extractos bancarios en línea" + +#. module: account_statement_import_online_plaid +#: model:ir.model.fields,field_description:account_statement_import_online_plaid.field_online_bank_statement_provider__plaid_access_token +msgid "Plaid Access Token" +msgstr "Ficha de acceso Plaid" + +#. module: account_statement_import_online_plaid +#: model:ir.model.fields,field_description:account_statement_import_online_plaid.field_online_bank_statement_provider__plaid_host +#: model_terms:ir.ui.view,arch_db:account_statement_import_online_plaid.online_bank_statement_provider_form +msgid "Plaid Host" +msgstr "Anfitrión" + +#. module: account_statement_import_online_plaid +#: model:ir.model,name:account_statement_import_online_plaid.model_plaid_interface +msgid "Plaid Interface" +msgstr "Interfaz plaid" + +#. module: account_statement_import_online_plaid +#: model_terms:ir.ui.view,arch_db:account_statement_import_online_plaid.online_bank_statement_provider_form +msgid "Plaid config" +msgstr "Configuración plaid" + +#. module: account_statement_import_online_plaid +#: model:ir.model.fields.selection,name:account_statement_import_online_plaid.selection__online_bank_statement_provider__plaid_host__production +msgid "Production" +msgstr "Producción" + +#. module: account_statement_import_online_plaid +#: model:ir.model.fields.selection,name:account_statement_import_online_plaid.selection__online_bank_statement_provider__plaid_host__sandbox +msgid "Sandbox" +msgstr "Salvadera" + +#. module: account_statement_import_online_plaid +#: model_terms:ir.ui.view,arch_db:account_statement_import_online_plaid.online_bank_statement_provider_form +msgid "Secret Key" +msgstr "LLave secreta" + +#. module: account_statement_import_online_plaid +#: model_terms:ir.ui.view,arch_db:account_statement_import_online_plaid.online_bank_statement_provider_form +msgid "Sync with Plaid.com" +msgstr "Sincronizar con plaid.com" diff --git a/account_statement_import_online_plaid/models/__init__.py b/account_statement_import_online_plaid/models/__init__.py new file mode 100644 index 000000000..7e0411756 --- /dev/null +++ b/account_statement_import_online_plaid/models/__init__.py @@ -0,0 +1,3 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from . import online_bank_statement_provider_plaid +from . import plaid_interface diff --git a/account_statement_import_online_plaid/models/online_bank_statement_provider_plaid.py b/account_statement_import_online_plaid/models/online_bank_statement_provider_plaid.py new file mode 100644 index 000000000..da11d7346 --- /dev/null +++ b/account_statement_import_online_plaid/models/online_bank_statement_provider_plaid.py @@ -0,0 +1,74 @@ +# Copyright 2024 Binhex - Adasat Torres de León. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from odoo import api, fields, models + + +class OnlineBankStatementProvider(models.Model): + _inherit = "online.bank.statement.provider" + plaid_access_token = fields.Char() + plaid_host = fields.Selection( + [ + ("development", "Development"), + ("sandbox", "Sandbox"), + ("production", "Production"), + ], + default="sandbox", + ) + + def _obtain_statement_data(self, date_since, date_until): + self.ensure_one() + if self.service != "plaid": + return super()._obtain_statement_data(date_since, date_until) + return self._plaid_retrieve_data(date_since, date_until), {} + + @api.model + def _get_available_services(self): + return super()._get_available_services() + [ + ("plaid", "Plaid.com"), + ] + + def action_sync_with_plaid(self): + self.ensure_one() + plaid_interface = self.env["plaid.interface"] + args = [self.username, self.password, self.plaid_host] + client = plaid_interface._client(*args) + plaid_link_token = plaid_interface._link(client) + return { + "type": "ir.actions.client", + "tag": "plaid_login", + "args": {"token": plaid_link_token}, + } + + def _plaid_retrieve_data(self, date_since, date_until): + plaid_interface = self.env["plaid.interface"] + args = [self.username, self.password, self.plaid_host] + client = plaid_interface._client(*args) + transactions = plaid_interface._get_transactions( + client, self.plaid_access_token, date_since, date_until + ) + return self._prepare_vals_for_statement(transactions) + + def plaid_create_access_token(self, public_token, active_id): + provider = self.browse(active_id) + plaid_interface = self.env["plaid.interface"] + client = plaid_interface._client( + provider.username, provider.password, provider.plaid_host + ) + args = [client, public_token] + provider.plaid_access_token = plaid_interface._login(*args) + if provider.plaid_access_token: + return True + return False + + def _prepare_vals_for_statement(self, transactions): + return [ + { + "date": transaction["date"], + "ref": transaction["name"], + "payment_ref": transaction["name"], + "unique_import_id": transaction["transaction_id"], + "amount": transaction["amount"], + "raw_data": transaction, + } + for transaction in transactions + ] diff --git a/account_statement_import_online_plaid/models/plaid_interface.py b/account_statement_import_online_plaid/models/plaid_interface.py new file mode 100644 index 000000000..73c11890d --- /dev/null +++ b/account_statement_import_online_plaid/models/plaid_interface.py @@ -0,0 +1,95 @@ +# Copyright 2024 Binhex - Adasat Torres de León. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +import plaid +from plaid.api import plaid_api +from plaid.model.country_code import CountryCode +from plaid.model.item_public_token_exchange_request import ( + ItemPublicTokenExchangeRequest, +) +from plaid.model.link_token_create_request import LinkTokenCreateRequest +from plaid.model.link_token_create_request_user import LinkTokenCreateRequestUser +from plaid.model.products import Products +from plaid.model.transactions_get_request import TransactionsGetRequest +from plaid.model.transactions_get_request_options import TransactionsGetRequestOptions + +from odoo import _, models +from odoo.exceptions import ValidationError + + +class PlaidInterface(models.AbstractModel): + _name = "plaid.interface" + _description = "Plaid Interface" + + def _get_host(self, host): + if host == "development": + return plaid.Environment.Development + if host == "sandbox": + return plaid.Environment.Sandbox + if host == "production": + return plaid.Environment.Production + return False + + def _client(self, client_id, secret, host): + configuration = plaid.Configuration( + host=self._get_host(host), + api_key={ + "clientId": client_id or "", + "secret": secret or "", + }, + ) + try: + return plaid_api.PlaidApi(plaid.ApiClient(configuration)) + except plaid.ApiException as e: + raise ValidationError(_("Error getting client api: %s") % e.body) from e + + def _link(self, client): + request = LinkTokenCreateRequest( + products=[Products("transactions")], + client_name="Plaid Test App", + country_codes=[CountryCode("US")], + language="es", + user=LinkTokenCreateRequestUser(client_user_id="client_user_id"), + ) + try: + response = client.link_token_create(request) + except plaid.ApiException as e: + raise ValidationError(_("Error getting link token: %s") % e.body) from e + return response.to_dict()["link_token"] + + def _login(self, client, public_token): + request = ItemPublicTokenExchangeRequest(public_token=public_token) + try: + response = client.item_public_token_exchange(request) + except plaid.ApiException as e: + raise ValidationError(_("Error getting access token: %s") % e.body) from e + return response["access_token"] + + def _get_transactions(self, client, access_token, start_date, end_date): + request = TransactionsGetRequest( + access_token=access_token, + start_date=start_date.date(), + end_date=end_date.date(), + ) + try: + response = client.transactions_get(request) + except plaid.ApiException as e: + raise ValidationError(_("Error getting transactions: %s") % e.body) from e + transactions = response["transactions"] + while len(transactions) < response["total_transactions"]: + options = TransactionsGetRequestOptions() + options.offset = len(transactions) + request = TransactionsGetRequest( + access_token=access_token, + start_date=start_date.date(), + end_date=end_date.date(), + options=options, + ) + try: + response = client.transactions_get(request) + except plaid.ApiException as e: + raise ValidationError( + _("Error getting transactions: %s") % e.body + ) from e + transactions.extend(response["transactions"]) + return transactions diff --git a/account_statement_import_online_plaid/readme/CONFIGURE.rst b/account_statement_import_online_plaid/readme/CONFIGURE.rst new file mode 100644 index 000000000..e83f93325 --- /dev/null +++ b/account_statement_import_online_plaid/readme/CONFIGURE.rst @@ -0,0 +1,27 @@ +To configure online bank statements provider: + +#. Go to *Invoicing > Configuration > Bank Accounts* +#. Open bank account to configure and edit it +#. Set *Bank Feeds* to *Online* +#. Select *Plaid.com* as online bank statements provider in + *Online Bank Statements (OCA)* section +#. Save the bank account +#. Click on provider and configure provider-specific settings. + +or, alternatively: + +#. Go to *Invoicing > Overview* +#. Open settings of the corresponding journal account +#. Switch to *Bank Account* tab +#. Set *Bank Feeds* to *Online* +#. Select *Plaid.com* as online bank statements provider in + *Online Bank Statements (OCA)* section +#. Save the bank account +#. Click on provider and configure provider-specific settings. + +To obtain *Login* and *Key*: + +#. Open `Plaid.com `_. + +Check also ``account_bank_statement_import_online`` configuration instructions +for more information. diff --git a/account_statement_import_online_plaid/readme/CONTRIBUTORS.rst b/account_statement_import_online_plaid/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..a2a3a6b64 --- /dev/null +++ b/account_statement_import_online_plaid/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `Binhex `_: + + * Adasat Torres de León diff --git a/account_statement_import_online_plaid/readme/DESCRIPTION.rst b/account_statement_import_online_plaid/readme/DESCRIPTION.rst new file mode 100644 index 000000000..d0669d4dc --- /dev/null +++ b/account_statement_import_online_plaid/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +This module provides online bank statements from Plaid.com. diff --git a/account_statement_import_online_plaid/readme/USAGE.rst b/account_statement_import_online_plaid/readme/USAGE.rst new file mode 100644 index 000000000..29a24817f --- /dev/null +++ b/account_statement_import_online_plaid/readme/USAGE.rst @@ -0,0 +1,13 @@ +To pull historical bank statements: + +#. Go to *Invoicing > Configuration > Bank Accounts* +#. Select specific bank accounts +#. Configure username, password and host for plaid +#. Launch *Actions > Sync with plaid.com* + +#. After launch *Actions > Online Bank Statements Pull Wizard* +#. Configure date interval and click *Pull* + +If historical data is not needed, then just simply wait for the scheduled +activity "Pull Online Bank Statements" to be executed for getting new +transactions. diff --git a/account_statement_import_online_plaid/static/description/icon.png b/account_statement_import_online_plaid/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/account_statement_import_online_plaid/static/description/icon.png differ diff --git a/account_statement_import_online_plaid/static/description/index.html b/account_statement_import_online_plaid/static/description/index.html new file mode 100644 index 000000000..4c28f93ee --- /dev/null +++ b/account_statement_import_online_plaid/static/description/index.html @@ -0,0 +1,473 @@ + + + + + +Online Bank Statements: plaid.com + + + +
+

Online Bank Statements: plaid.com

+ + +

Beta License: AGPL-3 OCA/bank-statement-import Translate me on Weblate Try me on Runboat

+

This module provides online bank statements from Plaid.com.

+

Table of contents

+ +
+

Configuration

+

To configure online bank statements provider:

+
    +
  1. Go to Invoicing > Configuration > Bank Accounts
    2. +
  2. Open bank account to configure and edit it
    3. +
  3. Set Bank Feeds to Online
    4. +
  4. Select Plaid.com as online bank statements provider in +Online Bank Statements (OCA) section
    5. +
  5. Save the bank account
    6. +
  6. Click on provider and configure provider-specific settings.
    7. +
+

or, alternatively:

+
    +
  1. Go to Invoicing > Overview
    2. +
  2. Open settings of the corresponding journal account
    3. +
  3. Switch to Bank Account tab
    4. +
  4. Set Bank Feeds to Online
    5. +
  5. Select Plaid.com as online bank statements provider in +Online Bank Statements (OCA) section
    6. +
  6. Save the bank account
    7. +
  7. Click on provider and configure provider-specific settings.
    8. +
+

To obtain Login and Key:

+
    +
  1. Open Plaid.com.
    2. +
+

Check also account_bank_statement_import_online configuration instructions +for more information.

+
+
+

Usage

+

To pull historical bank statements:

+
    +
  1. Go to Invoicing > Configuration > Bank Accounts
    2. +
  2. Select specific bank accounts
    3. +
  3. Configure username, password and host for plaid
    4. +
  4. Launch Actions > Sync with plaid.com
    5. +
  5. After launch Actions > Online Bank Statements Pull Wizard
    6. +
  6. Configure date interval and click Pull
    7. +
+

If historical data is not needed, then just simply wait for the scheduled +activity “Pull Online Bank Statements” to be executed for getting new +transactions.

+
+
+

Bug Tracker

+

Bugs are tracked on GitHub Issues. +In case of trouble, please check there if your issue has already been reported. +If you spotted it first, help us to smash it by providing a detailed and welcomed +feedback.

+

Do not contact contributors directly about support or help with technical issues.

+
+
+

Credits

+
+

Authors

+
    +
  • Binhex
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is maintained by the OCA.

+ +Odoo Community Association + +

OCA, or the Odoo Community Association, is a nonprofit organization whose +mission is to support the collaborative development of Odoo features and +promote its widespread use.

+

This module is part of the OCA/bank-statement-import project on GitHub.

+

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

+
+
+
+ + diff --git a/account_statement_import_online_plaid/static/src/js/plaid_integration.esm.js b/account_statement_import_online_plaid/static/src/js/plaid_integration.esm.js new file mode 100644 index 000000000..68ef275ba --- /dev/null +++ b/account_statement_import_online_plaid/static/src/js/plaid_integration.esm.js @@ -0,0 +1,23 @@ +/** @odoo-module **/ +/* global Plaid */ +import {registry} from "@web/core/registry"; +export async function plaid_login(env, action) { + const handler = Plaid.create({ + clientName: "Plaid Quickstart", + product: ["transactions"], + onSuccess: (public_token) => { + console.log(env, action); + env.services.orm.call( + "online.bank.statement.provider", + "plaid_create_access_token", + [false, public_token, action.context.active_id] + ); + }, + countryCodes: ["US", "ES"], + language: "es", + token: action.args.token, + }); + handler.open(); +} + +registry.category("actions").add("plaid_login", plaid_login); diff --git a/account_statement_import_online_plaid/tests/__init__.py b/account_statement_import_online_plaid/tests/__init__.py new file mode 100644 index 000000000..9b69b5907 --- /dev/null +++ b/account_statement_import_online_plaid/tests/__init__.py @@ -0,0 +1,4 @@ +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from . import test_plaid_interface +from . import test_account_statement_import_online_plaid diff --git a/account_statement_import_online_plaid/tests/test_account_statement_import_online_plaid.py b/account_statement_import_online_plaid/tests/test_account_statement_import_online_plaid.py new file mode 100644 index 000000000..34690d8e3 --- /dev/null +++ b/account_statement_import_online_plaid/tests/test_account_statement_import_online_plaid.py @@ -0,0 +1,206 @@ +# Copyright 2024 Binhex - Adasat Torres de León. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +import datetime +from unittest.mock import MagicMock, patch + +from odoo.tests import common + +TRANSACTIONS = [ + { + "account_id": "Qxm5dj75QXuBe5QVPAwbIN1PgEMExnCGroLgv", + "account_owner": None, + "amount": 500.0, + "authorized_date": None, + "authorized_datetime": None, + "category": ["Food and Drink", "Restaurants"], + "category_id": "13005000", + "check_number": None, + "counterparties": [], + "date": datetime.date(2024, 6, 20), + "datetime": None, + "iso_currency_code": "USD", + "location": { + "address": None, + "city": None, + "country": None, + "lat": None, + "lon": None, + "postal_code": None, + "region": None, + "store_number": None, + }, + "logo_url": None, + "merchant_entity_id": None, + "merchant_name": None, + "name": "Tectra Inc", + "payment_channel": "in store", + "payment_meta": { + "by_order_of": None, + "payee": None, + "payer": None, + "payment_method": None, + "payment_processor": None, + "ppd_id": None, + "reason": None, + "reference_number": None, + }, + "pending": False, + "pending_transaction_id": None, + "personal_finance_category": { + "confidence_level": "LOW", + "detailed": "ENTERTAINMENT_SPORTING_EVENTS_AMUSEMENT_PARKS_AND_MUSEUMS", + "primary": "ENTERTAINMENT", + }, + "transaction_code": None, + "transaction_id": "Mro5zaR59jCV95J8gNedi4LjoLE76qCL6MMEe", + "transaction_type": "place", + "unofficial_currency_code": None, + "website": None, + }, + { + "account_id": "Qxm5dj75QXuBe5QVPAwbIN1PgEMExnCGroLgv", + "account_owner": None, + "amount": 30.0, + "authorized_date": None, + "authorized_datetime": None, + "category": ["Food and Drink", "Restaurants"], + "category_id": "13005000", + "check_number": None, + "counterparties": [], + "date": datetime.date(2024, 5, 7), + "datetime": None, + "iso_currency_code": "USD", + "location": { + "address": None, + "city": None, + "country": None, + "lat": None, + "lon": None, + "postal_code": None, + "region": None, + "store_number": None, + }, + "logo_url": None, + "merchant_entity_id": None, + "merchant_name": None, + "name": "Tectra Inc 2", + "payment_channel": "in store", + "payment_meta": { + "by_order_of": None, + "payee": None, + "payer": None, + "payment_method": None, + "payment_processor": None, + "ppd_id": None, + "reason": None, + "reference_number": None, + }, + "pending": False, + "pending_transaction_id": None, + "personal_finance_category": { + "confidence_level": "LOW", + "detailed": "ENTERTAINMENT_SPORTING_EVENTS_AMUSEMENT_PARKS_AND_MUSEUMS", + "primary": "ENTERTAINMENT", + }, + "transaction_code": None, + "transaction_id": "Mro5zaR59jCV95J8gNedi4LjoLE76qCL6MMEu", + "transaction_type": "place", + "unofficial_currency_code": None, + "website": None, + }, +] + +EMPTY_TRANSACTIONS = [] + + +class TestAccountStatementImportOnlinePlaid(common.TransactionCase): + post_install = True + + def setUp(self): + super().setUp() + + self.now = datetime.datetime.now() + self.currency_eur = self.env.ref("base.EUR") + self.currency_usd = self.env.ref("base.USD") + self.AccountJournal = self.env["account.journal"] + self.ResPartnerBank = self.env["res.partner.bank"] + self.OnlineBankStatementProvider = self.env["online.bank.statement.provider"] + self.AccountBankStatement = self.env["account.bank.statement"] + self.AccountBankStatementLine = self.env["account.bank.statement.line"] + self.AccountStatementPull = self.env["online.bank.statement.pull.wizard"] + + self.currency_eur.write({"active": True}) + + self.bank_account = self.ResPartnerBank.create( + { + "acc_number": "FR0214508000302245362775K46", + "partner_id": self.env.user.company_id.partner_id.id, + } + ) + self.journal = self.AccountJournal.create( + { + "name": "Bank", + "type": "bank", + "code": "BANK", + "currency_id": self.currency_eur.id, + "bank_statements_source": "online", + "bank_account_id": self.bank_account.id, + } + ) + self.provider = self.OnlineBankStatementProvider.create( + { + "name": "plaid Provider", + "service": "plaid", + "username": "username", + "password": "password", + "plaid_host": "sandbox", + "plaid_access_token": "access_token", + "journal_id": self.journal.id, + # To get all the moves in a month at once + "statement_creation_mode": "monthly", + } + ) + + @patch("plaid.api.plaid_api.PlaidApi.transactions_get") + def test_import_online_bank_statement_plaid(self, trasactions_get): + trasactions_get.return_value = { + "transactions": TRANSACTIONS, + "total_transactions": len(TRANSACTIONS), + } + vals = { + "date_since": datetime.datetime(2024, 5, 1), + "date_until": datetime.datetime(2024, 6, 30), + } + wizard = ( + self.env["online.bank.statement.pull.wizard"] + .with_context( + active_model="account.journal", + active_id=self.journal.id, + ) + .create(vals) + ) + wizard.action_pull() + statements = self.env["account.bank.statement"].search( + [("journal_id", "=", self.journal.id)] + ) + self.assertEqual(len(statements), 2) + lines = statements.line_ids + self.assertEqual(len(lines), 2) + self.assertEqual(lines[0].amount, 500.0) + self.assertEqual(lines[1].amount, 30.0) + + def test_get_services(self): + services = self.provider._get_available_services() + self.assertTrue(services) + self.assertIn(("plaid", "Plaid.com"), services) + + @patch("plaid.api.plaid_api.PlaidApi.link_token_create") + def test_action_sycn_with_plaid(self, link_token_create): + link_token_create.return_value = MagicMock( + to_dict=lambda: {"link_token": "isalinktoken", "expiration": "isadate"} + ) + action = self.provider.action_sync_with_plaid() + self.assertTrue(action) + self.assertEqual(action["type"], "ir.actions.client") + self.assertEqual(action["tag"], "plaid_login") + self.assertEqual(action["args"]["token"], "isalinktoken") diff --git a/account_statement_import_online_plaid/tests/test_plaid_interface.py b/account_statement_import_online_plaid/tests/test_plaid_interface.py new file mode 100644 index 000000000..7cc467025 --- /dev/null +++ b/account_statement_import_online_plaid/tests/test_plaid_interface.py @@ -0,0 +1,129 @@ +# Copyright 2024 Binhex - Adasat Torres de León. +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +import datetime +from unittest.mock import MagicMock, patch + +import plaid +from dateutil.relativedelta import relativedelta + +from odoo.exceptions import ValidationError +from odoo.tests import common + +from .test_account_statement_import_online_plaid import TRANSACTIONS + + +class TestPlaidInterface(common.TransactionCase): + post_install = True + + def test_get_host(self): + """Test getting Plaid host.""" + interface_model = self.env["plaid.interface"] + self.assertEqual( + interface_model._get_host("development"), plaid.Environment.Development + ) + self.assertEqual( + interface_model._get_host("sandbox"), plaid.Environment.Sandbox + ) + self.assertEqual( + interface_model._get_host("production"), plaid.Environment.Production + ) + self.assertFalse(interface_model._get_host("nonexistent")) + + @patch("plaid.api.plaid_api.PlaidApi") + def test_client(self, PlaidApi): + interface_model = self.env["plaid.interface"] + PlaidApi.return_value = MagicMock() + client = interface_model._client("client_id", "secret", "sandbox") + self.assertTrue(client) + + @patch( + "plaid.api.plaid_api.PlaidApi", + side_effect=plaid.ApiException("INVALID_SECRET", "This secret is invalid"), + ) + def test_client_error(self, PlaidApi): + interface_model = self.env["plaid.interface"] + self.assertRaises( + ValidationError, interface_model._client, "client_id", "secret2", "sandbox" + ) + + @patch("plaid.api.plaid_api.PlaidApi.link_token_create") + def test_link(self, link_token_create): + interface_model = self.env["plaid.interface"] + link_token_create.return_value = MagicMock( + to_dict=lambda: {"link_token": "isalinktoken", "expiration": "isadate"} + ) + client = interface_model._client("client_id", "secret", "sandbox") + link = interface_model._link(client) + self.assertTrue(link) + self.assertEqual(link, "isalinktoken") + + @patch( + "plaid.api.plaid_api.PlaidApi.link_token_create", + side_effect=plaid.ApiException( + "INVALID_CLIENT_ID", "This client id is invalid" + ), + ) + def test_link_error(self, link_token_create): + interface_model = self.env["plaid.interface"] + client = interface_model._client("client_id", "secret", "sandbox") + self.assertRaises(ValidationError, interface_model._link, client) + + @patch("plaid.api.plaid_api.PlaidApi.item_public_token_exchange") + def test_login(self, item_public_token_exchange): + interface_model = self.env["plaid.interface"] + item_public_token_exchange.return_value = MagicMock( + to_dict=lambda: {"access_token": "isaccesstoken"} + ) + client = interface_model._client("client_id", "secret", "sandbox") + public_token = "isapulbictoken" + access_token = interface_model._login(client, public_token) + self.assertTrue(access_token) + + @patch( + "plaid.api.plaid_api.PlaidApi.item_public_token_exchange", + side_effect=plaid.ApiException("INVALID_PUBLIC_TOKEN", "This token is invalid"), + ) + def test_login_error(self, item_public_token_exchange): + interface_model = self.env["plaid.interface"] + client = interface_model._client("client_id", "secret", "sandbox") + public_token = "isapulbictoken" + self.assertRaises(ValidationError, interface_model._login, client, public_token) + + @patch("plaid.api.plaid_api.PlaidApi.transactions_get") + def test_get_transactions(self, transactions_get): + interface_model = self.env["plaid.interface"] + client = interface_model._client("client_id", "secret", "sandbox") + transactions_get.return_value = { + "transactions": TRANSACTIONS, + "total_transactions": len(TRANSACTIONS), + } + + access_token = "isaccesstoken" + start_date = datetime.datetime.now() - relativedelta(months=1) + end_date = datetime.datetime.now() + res = interface_model._get_transactions( + client, access_token, start_date, end_date + ) + + self.assertTrue(res) + + @patch( + "plaid.api.plaid_api.PlaidApi.transactions_get", + side_effect=plaid.ApiException( + "INVALID_ACCESS_TOKEN", "This access token is invalid" + ), + ) + def test_get_transactions_error(self, transactions_get): + interface_model = self.env["plaid.interface"] + client = interface_model._client("client_id", "secret", "sandbox") + access_token = "isaccesstoken" + start_date = datetime.datetime.now() - relativedelta(months=1) + end_date = datetime.datetime.now() + self.assertRaises( + ValidationError, + interface_model._get_transactions, + client, + access_token, + start_date, + end_date, + ) diff --git a/account_statement_import_online_plaid/views/online_bank_statement_provider.xml b/account_statement_import_online_plaid/views/online_bank_statement_provider.xml new file mode 100644 index 000000000..1ea53d63f --- /dev/null +++ b/account_statement_import_online_plaid/views/online_bank_statement_provider.xml @@ -0,0 +1,38 @@ + + + + online.bank.statement.provider.form + online.bank.statement.provider + + + + + + + + + + + +