diff --git a/account_payment_method_fs_storage/README.rst b/account_payment_method_fs_storage/README.rst new file mode 100644 index 000000000..2964fb16d --- /dev/null +++ b/account_payment_method_fs_storage/README.rst @@ -0,0 +1,104 @@ +================================= +Account Payment Method Fs Storage +================================= + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:119631980ff126b81a0dc920b633b345df0b03d62b0e2b875845c45c2ff454d0 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |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--payment-lightgray.png?logo=github + :target: https://github.com/OCA/bank-payment/tree/16.0/account_payment_method_fs_storage + :alt: OCA/bank-payment +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/bank-payment-16-0/bank-payment-16-0-account_payment_method_fs_storage + :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-payment&target_branch=16.0 + :alt: Try me on Runboat + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This Odoo addon enhances the payment mode functionality by introducing the ability to designate a specific storage location. +Users can now specify a storage destination within the payment method, +facilitating the automatic transfer of generated files to the designated location upon completing a payment transaction. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +This module depends on : + +* account_payment_order +* fs_storage + +This module is part of the OCA/bank-payment suite. + +Configuration +============= + +For setting the Storage: + +#. Activate "Use On Payment Method" on storage (boolean on form of Storage) +#. Go to Invoicing/Accounting > Configuration > Payment Methods +#. You can specify your storage on the payment method + +Usage +===== + +This module sepcifically works for SEPA Payment. +When generating payment file on a payment order, the file will be pushed to a specific storage (set on the payment method). + +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 +~~~~~~~ + +* ACSONE SA/NV + +Contributors +~~~~~~~~~~~~ + +* François Honoré +* Zina Rasoamanana + +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-payment `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/account_payment_method_fs_storage/__init__.py b/account_payment_method_fs_storage/__init__.py new file mode 100644 index 000000000..0650744f6 --- /dev/null +++ b/account_payment_method_fs_storage/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/account_payment_method_fs_storage/__manifest__.py b/account_payment_method_fs_storage/__manifest__.py new file mode 100644 index 000000000..dab93530d --- /dev/null +++ b/account_payment_method_fs_storage/__manifest__.py @@ -0,0 +1,23 @@ +# Copyright 2024 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "Account Payment Method Fs Storage", + "summary": """ + Add the possibility to specify on the payment method, + a storage where files generated will be pushed to upon payment + """, + "version": "16.0.1.0.0", + "license": "AGPL-3", + "author": "ACSONE SA/NV,Odoo Community Association (OCA)", + "website": "https://github.com/OCA/bank-payment", + "depends": [ + "account_banking_sepa_credit_transfer", + "fs_storage", + ], + "data": [ + "views/fs_storage.xml", + "views/account_payment_method.xml", + ], + "demo": [], +} diff --git a/account_payment_method_fs_storage/models/__init__.py b/account_payment_method_fs_storage/models/__init__.py new file mode 100644 index 000000000..ed752e7bb --- /dev/null +++ b/account_payment_method_fs_storage/models/__init__.py @@ -0,0 +1,3 @@ +from . import account_payment_order +from . import account_payment_method +from . import fs_storage diff --git a/account_payment_method_fs_storage/models/account_payment_method.py b/account_payment_method_fs_storage/models/account_payment_method.py new file mode 100644 index 000000000..433788acb --- /dev/null +++ b/account_payment_method_fs_storage/models/account_payment_method.py @@ -0,0 +1,25 @@ +# Copyright 2024 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import fields, models + + +class AccountPaymentMethod(models.Model): + + _inherit = "account.payment.method" + + storage = fields.Selection( + selection="_get_selection_storage", + help="Storage where to put the file after generation", + ) + + def _get_selection_storage(self): + """ + This is to avoid giving access to the model fs.storage + at groups other than base.group_system + """ + storages = ( + self.env["fs.storage"].sudo().search([("use_on_payment_method", "=", True)]) + ) + + return [(str(r.id), r.display_name) for r in storages] diff --git a/account_payment_method_fs_storage/models/account_payment_order.py b/account_payment_method_fs_storage/models/account_payment_order.py new file mode 100644 index 000000000..55f8d681f --- /dev/null +++ b/account_payment_method_fs_storage/models/account_payment_order.py @@ -0,0 +1,67 @@ +# Copyright 2024 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +import logging + +from odoo import _, models +from odoo.exceptions import UserError + +_logger = logging.getLogger(__name__) + + +class AccountPaymentOrder(models.Model): + + _inherit = "account.payment.order" + + def _must_be_exported_to_storage(self): + self.ensure_one() + return bool(self.payment_method_id.storage) + + def _export_to_storage(self, file_content, filename): + storage_id = int(self.payment_method_id.storage) + # user that confirms order may not have access to storage + export_storage = self.env["fs.storage"].sudo().search([("id", "=", storage_id)]) + try: + storage = export_storage._get_filesystem() + storage.pipe_file(filename, file_content) + + except Exception as e: + details = str(e) or str(type(e)) + _logger.error(details) + raise UserError( + _("Unknown issue to upload the file on the storage:\n{details}").format( + details=details + ) + ) from e + return True + + def generate_payment_file(self): + """ + Inherit to catch file generation and put it on the storage (if necessary) + """ + file_content, filename = super().generate_payment_file() + if self._must_be_exported_to_storage(): + self._export_to_storage(file_content, filename) + return file_content, filename + + def open2generated(self): + self.ensure_one() + action = super().open2generated() + if self._must_be_exported_to_storage(): + self.generated2uploaded() + action = { + "type": "ir.actions.client", + "tag": "display_notification", + "params": { + "type": "success", + "title": _("Generate and export"), + "message": _( + "The file has been generated and dropped on the storage." + ), + "sticky": True, + "next": { + "type": "ir.actions.client", + "tag": "reload", + }, + }, + } + return action diff --git a/account_payment_method_fs_storage/models/fs_storage.py b/account_payment_method_fs_storage/models/fs_storage.py new file mode 100644 index 000000000..bc5a3c138 --- /dev/null +++ b/account_payment_method_fs_storage/models/fs_storage.py @@ -0,0 +1,28 @@ +# Copyright 2024 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from odoo import _, api, fields, models +from odoo.exceptions import UserError + + +class FsStorage(models.Model): + + _inherit = "fs.storage" + + use_on_payment_method = fields.Boolean( + help="Tells if storage can be set on payment methods", + ) + + @api.constrains("use_on_payment_method") + def _check_use_on_payment_method(self): + storage_not_on_payment = self.filtered(lambda r: not r.use_on_payment_method) + storage_not_on_payment_str_ids = [str(r.id) for r in storage_not_on_payment] + data = self.env["account.payment.method"].read_group( + domain=[("storage", "in", storage_not_on_payment_str_ids)], + fields=["storage"], + groupby=["storage"], + ) + mapped_data = {r["storage"]: r["storage_count"] for r in data} + + if any(mapped_data.get(str(rec.id), 0) > 0 for rec in storage_not_on_payment): + raise UserError(_("Storage is already used on at least one payment method")) diff --git a/account_payment_method_fs_storage/readme/CONFIGURE.rst b/account_payment_method_fs_storage/readme/CONFIGURE.rst new file mode 100644 index 000000000..e4c327ab1 --- /dev/null +++ b/account_payment_method_fs_storage/readme/CONFIGURE.rst @@ -0,0 +1,5 @@ +For setting the Storage: + +#. Activate "Use On Payment Method" on storage (boolean on form of Storage) +#. Go to Invoicing/Accounting > Configuration > Payment Methods +#. You can specify your storage on the payment method diff --git a/account_payment_method_fs_storage/readme/CONTRIBUTORS.rst b/account_payment_method_fs_storage/readme/CONTRIBUTORS.rst new file mode 100644 index 000000000..5efd87d78 --- /dev/null +++ b/account_payment_method_fs_storage/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* François Honoré +* Zina Rasoamanana diff --git a/account_payment_method_fs_storage/readme/DESCRIPTION.rst b/account_payment_method_fs_storage/readme/DESCRIPTION.rst new file mode 100644 index 000000000..1d1de2a57 --- /dev/null +++ b/account_payment_method_fs_storage/readme/DESCRIPTION.rst @@ -0,0 +1,3 @@ +This Odoo addon enhances the payment mode functionality by introducing the ability to designate a specific storage location. +Users can now specify a storage destination within the payment method, +facilitating the automatic transfer of generated files to the designated location upon completing a payment transaction. diff --git a/account_payment_method_fs_storage/readme/INSTALL.rst b/account_payment_method_fs_storage/readme/INSTALL.rst new file mode 100644 index 000000000..5bca6a2f2 --- /dev/null +++ b/account_payment_method_fs_storage/readme/INSTALL.rst @@ -0,0 +1,6 @@ +This module depends on : + +* account_payment_order +* fs_storage + +This module is part of the OCA/bank-payment suite. diff --git a/account_payment_method_fs_storage/readme/USAGE.rst b/account_payment_method_fs_storage/readme/USAGE.rst new file mode 100644 index 000000000..728038a4d --- /dev/null +++ b/account_payment_method_fs_storage/readme/USAGE.rst @@ -0,0 +1,2 @@ +This module sepcifically works for SEPA Payment. +When generating payment file on a payment order, the file will be pushed to a specific storage (set on the payment method). \ No newline at end of file diff --git a/account_payment_method_fs_storage/static/description/icon.png b/account_payment_method_fs_storage/static/description/icon.png new file mode 100644 index 000000000..3a0328b51 Binary files /dev/null and b/account_payment_method_fs_storage/static/description/icon.png differ diff --git a/account_payment_method_fs_storage/static/description/index.html b/account_payment_method_fs_storage/static/description/index.html new file mode 100644 index 000000000..3133729a6 --- /dev/null +++ b/account_payment_method_fs_storage/static/description/index.html @@ -0,0 +1,450 @@ + + + + + + +Account Payment Method Fs Storage + + + +
+

Account Payment Method Fs Storage

+ + +

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

+

This Odoo addon enhances the payment mode functionality by introducing the ability to designate a specific storage location. +Users can now specify a storage destination within the payment method, +facilitating the automatic transfer of generated files to the designated location upon completing a payment transaction.

+

Table of contents

+ +
+

Installation

+

This module depends on :

+
    +
  • account_payment_order
    • +
  • fs_storage
    • +
+

This module is part of the OCA/bank-payment suite.

+
+
+

Configuration

+

For setting the Storage:

+
    +
  1. Activate “Use On Payment Method” on storage (boolean on form of Storage)
    2. +
  2. Go to Invoicing/Accounting > Configuration > Payment Methods
    3. +
  3. You can specify your storage on the payment method
    4. +
+
+
+

Usage

+

This module sepcifically works for SEPA Payment. +When generating payment file on a payment order, the file will be pushed to a specific storage (set on the payment method).

+
+
+

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

+
    +
  • ACSONE SA/NV
    • +
+
+
+

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-payment project on GitHub.

+

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

+
+
+
+ + diff --git a/account_payment_method_fs_storage/tests/__init__.py b/account_payment_method_fs_storage/tests/__init__.py new file mode 100644 index 000000000..be4eb6652 --- /dev/null +++ b/account_payment_method_fs_storage/tests/__init__.py @@ -0,0 +1 @@ +from . import test_account_payment_method_fs_storage diff --git a/account_payment_method_fs_storage/tests/test_account_payment_method_fs_storage.py b/account_payment_method_fs_storage/tests/test_account_payment_method_fs_storage.py new file mode 100644 index 000000000..99594187a --- /dev/null +++ b/account_payment_method_fs_storage/tests/test_account_payment_method_fs_storage.py @@ -0,0 +1,129 @@ +# Copyright 2024 ACSONE SA/NV +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). +from contextlib import contextmanager +from datetime import date +from unittest.mock import patch + +from odoo.exceptions import UserError +from odoo.tests import tagged + +from odoo.addons.account.tests.common import AccountTestInvoicingCommon + + +@tagged("-at_install", "post_install") +class TestAccountPaymentMethodFsStorage(AccountTestInvoicingCommon): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.env = cls.env(context=dict(cls.env.context, tracking_disable=True)) + cls.company = cls.company_data["company"] + + cls.fs_storage = cls.env.ref("fs_storage.default_fs_storage") + + cls.fs_storage.write( + { + "use_on_payment_method": True, + } + ) + cls.payment_method = cls.env.ref( + "account.account_payment_method_manual_out" + ).copy( + { + "storage": str(cls.fs_storage.id), + "name": "method test", + "code": "test", + } + ) + + cls.creation_mode = cls.env["account.payment.mode"].create( + { + "name": "Test Direct Debit of suppliers from Société Générale", + "company_id": cls.company.id, + "bank_account_link": "variable", + "payment_method_id": cls.payment_method.id, + } + ) + cls.bank_journal = cls.company_data["default_journal_bank"] + cls.partner = cls.env["res.partner"].create( + { + "name": "Test Partner", + } + ) + + # create payment order with payment method and fs storage + + @contextmanager + def with_custom_method(self): + path = ( + "odoo.addons.account_payment_order.models" + ".account_payment_order.AccountPaymentOrder.generate_payment_file" + ) + with patch( + path, + new=lambda self: (b"Content", "Filename"), + create=not hasattr( + self.env["account.payment.order"], "generate_payment_file" + ), + ): + yield + + def test_payment_method_fs_storage(self): + order_vals = { + "payment_type": "outbound", + "payment_mode_id": self.creation_mode.id, + "journal_id": self.bank_journal.id, + } + + order = self.env["account.payment.order"].create(order_vals) + + vals = { + "order_id": order.id, + "partner_id": self.partner.id, + "communication": "manual line and manual date", + "currency_id": order.payment_mode_id.company_id.currency_id.id, + "amount_currency": 200, + "date": date.today(), + } + self.env["account.payment.line"].create(vals) + + order.draft2open() + with self.with_custom_method(): + action = order.open2generated() + + self.assertDictEqual( + action, + { + "type": "ir.actions.client", + "tag": "display_notification", + "params": { + "type": "success", + "title": "Generate and export", + "message": "The file has been generated and dropped on the storage.", + "sticky": True, + "next": { + "type": "ir.actions.client", + "tag": "reload", + }, + }, + }, + ) + + attachment = self.env["ir.attachment"].search( + [("res_model", "=", "account.payment.order"), ("res_id", "=", order.id)] + ) + + self.assertEqual(len(attachment), 1) + + def test_check_use_on_payment_method(self): + self.assertEqual(self.payment_method.storage, str(self.fs_storage.id)) + + with self.assertRaisesRegex( + UserError, "Storage is already used on at least one payment method" + ): + self.fs_storage.write({"use_on_payment_method": False}) + + self.payment_method.write({"storage": False}) + self.fs_storage.write({"use_on_payment_method": False}) + + self.assertFalse(self.payment_method.storage) + self.assertFalse(self.fs_storage.use_on_payment_method) diff --git a/account_payment_method_fs_storage/views/account_payment_method.xml b/account_payment_method_fs_storage/views/account_payment_method.xml new file mode 100644 index 000000000..9dde8dfc5 --- /dev/null +++ b/account_payment_method_fs_storage/views/account_payment_method.xml @@ -0,0 +1,22 @@ + + + + + + account.payment.method.form (in account_payment_method_fs_storage) + account.payment.method + + + + + + + + + diff --git a/account_payment_method_fs_storage/views/fs_storage.xml b/account_payment_method_fs_storage/views/fs_storage.xml new file mode 100644 index 000000000..891aaef00 --- /dev/null +++ b/account_payment_method_fs_storage/views/fs_storage.xml @@ -0,0 +1,18 @@ + + + + + + fs.storage + + + + + + + + + + + diff --git a/setup/account_payment_method_fs_storage/odoo/addons/account_payment_method_fs_storage b/setup/account_payment_method_fs_storage/odoo/addons/account_payment_method_fs_storage new file mode 120000 index 000000000..b9c8bd894 --- /dev/null +++ b/setup/account_payment_method_fs_storage/odoo/addons/account_payment_method_fs_storage @@ -0,0 +1 @@ +../../../../account_payment_method_fs_storage \ No newline at end of file diff --git a/setup/account_payment_method_fs_storage/setup.py b/setup/account_payment_method_fs_storage/setup.py new file mode 100644 index 000000000..28c57bb64 --- /dev/null +++ b/setup/account_payment_method_fs_storage/setup.py @@ -0,0 +1,6 @@ +import setuptools + +setuptools.setup( + setup_requires=['setuptools-odoo'], + odoo_addon=True, +)