From f2f7d7c2db0bf839752f32481fc609782073f236 Mon Sep 17 00:00:00 2001 From: CristianoMafraJunior Date: Mon, 15 Sep 2025 13:32:35 -0300 Subject: [PATCH 1/6] [ADD] atm_averba_base: new module --- atm_averba_base/README.rst | 75 +++ atm_averba_base/__init__.py | 1 + atm_averba_base/__manifest__.py | 15 + atm_averba_base/constants/atm_averba.py | 4 + atm_averba_base/models/__init__.py | 1 + atm_averba_base/models/res_company.py | 67 +++ atm_averba_base/readme/CONFIGURE.rst | 4 + atm_averba_base/readme/CONTRIBUTORS.rst | 3 + atm_averba_base/readme/DESCRIPTION.rst | 1 + atm_averba_base/static/description/icon.png | Bin 0 -> 2873 bytes atm_averba_base/static/description/index.html | 435 ++++++++++++++++++ atm_averba_base/tests/__init__.py | 1 + atm_averba_base/tests/test_atm_averba.py | 78 ++++ atm_averba_base/views/res_company.xml | 31 ++ .../odoo/addons/atm_averba_base | 1 + setup/atm_averba_base/setup.py | 6 + 16 files changed, 723 insertions(+) create mode 100644 atm_averba_base/README.rst create mode 100644 atm_averba_base/__init__.py create mode 100644 atm_averba_base/__manifest__.py create mode 100644 atm_averba_base/constants/atm_averba.py create mode 100644 atm_averba_base/models/__init__.py create mode 100644 atm_averba_base/models/res_company.py create mode 100644 atm_averba_base/readme/CONFIGURE.rst create mode 100644 atm_averba_base/readme/CONTRIBUTORS.rst create mode 100644 atm_averba_base/readme/DESCRIPTION.rst create mode 100644 atm_averba_base/static/description/icon.png create mode 100644 atm_averba_base/static/description/index.html create mode 100644 atm_averba_base/tests/__init__.py create mode 100644 atm_averba_base/tests/test_atm_averba.py create mode 100644 atm_averba_base/views/res_company.xml create mode 120000 setup/atm_averba_base/odoo/addons/atm_averba_base create mode 100644 setup/atm_averba_base/setup.py diff --git a/atm_averba_base/README.rst b/atm_averba_base/README.rst new file mode 100644 index 0000000..8e42e01 --- /dev/null +++ b/atm_averba_base/README.rst @@ -0,0 +1,75 @@ +================ +AT&M Averba Base +================ + +.. + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! source digest: sha256:9a4224c2d4df2b32a46347629979517299f7700e10d26077b24cb238f0ab8ab7 + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Alpha-red.png + :target: https://odoo-community.org/page/development-status + :alt: Alpha +.. |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-Escodoo%2Fclog--addons-lightgray.png?logo=github + :target: https://github.com/Escodoo/clog-addons/tree/14.0/atm_averba_base + :alt: Escodoo/clog-addons + +|badge1| |badge2| |badge3| + +AT&M Averba Base + +.. IMPORTANT:: + This is an alpha version, the data model and design can change at any time without warning. + Only for development or testing purpose, do not use in production. + `More details on development status `_ + +**Table of contents** + +.. contents:: + :local: + +Configuration +============= + +#. Go to Settings > Users & Companies > Companies and open or create a new company: + +- Access the Document Registration notebook. +- Select the environment and fill out the user and password and codigoatm for authentication. + +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 +~~~~~~~ + +* Escodoo + +Contributors +~~~~~~~~~~~~ + +* `Escodoo `_: + + * Cristiano Mafra Junior + +Maintainers +~~~~~~~~~~~ + +This module is part of the `Escodoo/clog-addons `_ project on GitHub. + +You are welcome to contribute. diff --git a/atm_averba_base/__init__.py b/atm_averba_base/__init__.py new file mode 100644 index 0000000..0650744 --- /dev/null +++ b/atm_averba_base/__init__.py @@ -0,0 +1 @@ +from . import models diff --git a/atm_averba_base/__manifest__.py b/atm_averba_base/__manifest__.py new file mode 100644 index 0000000..b91e7c9 --- /dev/null +++ b/atm_averba_base/__manifest__.py @@ -0,0 +1,15 @@ +# Copyright 2025 - TODAY, Escodoo +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +{ + "name": "AT&M Averba Base", + "summary": """ + AT&M Averba Base""", + "version": "14.0.1.0.0", + "license": "AGPL-3", + "author": "Escodoo", + "development_status": "Alpha", + "website": "https://github.com/Escodoo/clog-addons", + "depends": ["base"], + "data": ["views/res_company.xml"], +} diff --git a/atm_averba_base/constants/atm_averba.py b/atm_averba_base/constants/atm_averba.py new file mode 100644 index 0000000..7bafb75 --- /dev/null +++ b/atm_averba_base/constants/atm_averba.py @@ -0,0 +1,4 @@ +# Copyright 2025 - TODAY, Cristiano Mafra Junior +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +ATM_AVERBA_URL = "https://webserver.averba.com.br/rest/CTe" diff --git a/atm_averba_base/models/__init__.py b/atm_averba_base/models/__init__.py new file mode 100644 index 0000000..aff44f3 --- /dev/null +++ b/atm_averba_base/models/__init__.py @@ -0,0 +1 @@ +from . import res_company diff --git a/atm_averba_base/models/res_company.py b/atm_averba_base/models/res_company.py new file mode 100644 index 0000000..f5cd1bf --- /dev/null +++ b/atm_averba_base/models/res_company.py @@ -0,0 +1,67 @@ +# Copyright 2025 - TODAY, Cristiano Mafra Junior +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + + +import requests + +from odoo import _, fields, models +from odoo.exceptions import UserError + +from ..constants.atm_averba import ATM_AVERBA_URL + + +class ResCompany(models.Model): + + _inherit = "res.company" + + atm_averba_environment = fields.Selection( + selection=[("1", "Production"), ("2", "Homologation")], + string="Environment", + default="2", + ) + atm_averba_user = fields.Char(string="User") + atm_averba_user_password = fields.Char(string="User Password") + atm_code = fields.Char() + atm_token = fields.Char() + + def get_atm_averba_environment(self): + self.ensure_one() + return { + "url": ATM_AVERBA_URL + if self.atm_averba_environment == "1" + else ATM_AVERBA_URL, + "usuario": self.atm_averba_user, + "senha": self.atm_averba_user_password, + "codigoatm": self.atm_code, + } + + def generate_atm_token(self): + self.ensure_one() + config = self.get_atm_averba_environment() + + url = "https://webserver.averba.com.br/rest/Auth" + headers = { + "Accept": "application/json", + "Content-Type": "application/json", + } + payload = { + "usuario": config["usuario"], + "senha": config["senha"], + "codigoatm": config["codigoatm"], + } + + try: + response = requests.post(url, json=payload, headers=headers, timeout=15) + response.raise_for_status() + result = response.json() + except requests.RequestException as e: + raise UserError(_("Erro na conexão com AT&M: %s") % str(e)) + except Exception as e: + raise UserError(_("Erro inesperado: %s") % str(e)) + + token = result.get("Bearer") + if not token: + raise UserError(_("Token não retornado pela AT&M: %s") % result) + + self.atm_token = token + return token diff --git a/atm_averba_base/readme/CONFIGURE.rst b/atm_averba_base/readme/CONFIGURE.rst new file mode 100644 index 0000000..174c9a8 --- /dev/null +++ b/atm_averba_base/readme/CONFIGURE.rst @@ -0,0 +1,4 @@ +#. Go to Settings > Users & Companies > Companies and open or create a new company: + +- Access the Document Registration notebook. +- Select the environment and fill out the user and password and codigoatm for authentication. diff --git a/atm_averba_base/readme/CONTRIBUTORS.rst b/atm_averba_base/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000..418948a --- /dev/null +++ b/atm_averba_base/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* `Escodoo `_: + + * Cristiano Mafra Junior diff --git a/atm_averba_base/readme/DESCRIPTION.rst b/atm_averba_base/readme/DESCRIPTION.rst new file mode 100644 index 0000000..e31d9be --- /dev/null +++ b/atm_averba_base/readme/DESCRIPTION.rst @@ -0,0 +1 @@ +AT&M Averba Base diff --git a/atm_averba_base/static/description/icon.png b/atm_averba_base/static/description/icon.png new file mode 100644 index 0000000000000000000000000000000000000000..12ab0051e3b9ac413f0f0016b7cff54f02fc763e GIT binary patch literal 2873 zcmV-93&!+`P)`uGecH7++*a9tqf=D4K3Mya}O@tpzNQ@yQCf@Kr zF!+nnKqBHT7^8%kXfz5&3vvk;1t}w7Z?N*D?A{ zHrd_G%z4iDJn#2;p6~mP`2CNcJjDNjrs?X8sbe)Nav^9t4K(ppCb-d2d)&lZ>k%SMT{9YBg-a+&W{!hd#wDr8Wl{eXS z*$7*96lqpl{PUr=s8^hIiDg}g*f5f1&&S6&>%w7_k{mf$=0jJV!9`c@;PA^Op1%JL zjvcP7X-sQIgb*+?KF9@EjIw?AMgZbC#&KNql%Q6tlgni}^ZZSmdHyEeJ2=g=55CEv zmnMkgHHh!qH~xB6FC&#;=S7>@bLA+-%~=4VD8ltxIF5^^DFQzvj6#%BWV03ng*-|r z04k*>&p&>cm!5nFzZI@poU2BJnbtV_!&|uU$}y~h2|yTz*p5r9WG&z2} zgzMT!DN#yCDn%xfCZEq?8U_G%-Q$HP-sbto4&yXiD<1EPFO7UL&G{c2<=nkn(2e#} z^@9M%@$h}0bjoDo#v;0Q@};9FB8of+1YzLQY&J2?6oo>LOfJpk*PX*9*NpSZGe>#u zk%LT6G*&F`6(eG3TaNRu7-jszVWetTW!G!rx-L-^kx8c+94Mev4;4F(2?8GipD+k; zT^B>w$>nooEsH%@Z0CZHj&bnk*sdZMTrtMhorAOY5aYNW zj^iMu#L8sIWYP#BmUN9U4B9_|Ps?vnt=7opvgGFp>%@^N2Od4dtIr-Kik7z0m!uI& z6O3QDnTtL##=x*O8*qf7`Rm>4UQp;#P5$@Lpq;;yjH>WJ5(YUt#1IdZuydp@>#C#ExmKro8|zO=gyYw6f?D@) zO;dA3C`t5Rlo9o%65&TKb${xF|7l7xRh|Jrss7IhDMeQ!8kOD#v=fMk38}gh#3yucyF^u$%5|2^EB4zY-za^N18QYBnvew`D8=+@OK&R~LPuuFnak z5RxG1S0Y4rSxl9B-?Ncn+@jtppZ0~in(HN$Qhl2d2r+LOZT9>&S#ggO^|0ZoX&U8; zxe^-mDG~ECqBhz4)_{zn-quh%Bicmtw?+sw)hV4`&+qGbY?M+kRi3RJQuVP$%xk8m zlMs=>LhJMrN-3f!BJR6pqJ1xO8qvGCE0Z{hwdp2N6m<>Qe#;6W1VV_mm6ZWIN8uMj|6uCNY-{rRJ5;e(WU#y58<6D+!hbBs>^A*b2-{&Q*;#Zg1T713H;K=R@>9XTTE9 zP&rKx*J&YTyG-?qTh;9$q{Oj3+~(r@7#~EU&JsXZigKwlbI87Nw1tq}(m6FzJI$+4 zMxxFVKvNp!iT?C2I~5~o4*?0wC$w$y(y@7a9Q~pZa&FkF_2^vBM`DdIPVgoACnMTE zL^~sz)5(t(B_={j$z;dK?IVo4u1Q7!R3n?fOf%0ptS1tBDwuA^x>gM$O;x=tL$)Tfg*Q?P{c2@pqu zU)=d88g(1fG#DJnBc)_&YMNTDz6OSkKq(E~Fv(`KY#rH5*2++;Ho4~~4-ojtm#f-) z?x${z;$$;}Qi|7Kdz(idcoxIdIcw)OOw&Nub!^AQwrw;`>!#}I&}cNS}g>5^ShC!i_>z<-r2tA#lnjNu~rZZ5;lh5Z6Lh%04GI!naN2*7BwiZWO z%2EeVdv{%ZYqY>N-{OHm$}q@V7UhWw5AEAey>4^P?j5AlCaIK3%lE0(8wfzx^#xDZ zoh~Dk($F*m%gVBO(-7%&8ow3r`(Ho8FYnmL2DVbnZdfu20OFh1e?M-8%U6Bd^C(v; zScMc{`pRe7d--kvS}mWZZ6kzappeHf^poDZP)4-H&_LHUHWZ7b(L-7u zAciSg8V#p4 zVHhW5$Eh+x({yyhAeYOrX?O@-*O{KI^7A|I<>B8QVEe#MEYn(c+#RUPc3pF87$=+5 z7J?9hjF}>r$?(qG$9Qnxe!?K)oZVxXrh#dixSmI&VWX7ldI$4~kW!%=DbkrV!^1=5 zvKCPkbN_u$@}uwmj#RVArotAaSlN?&;+E@gi@h*;-R%Vp$EGw>VPtfOo4@{f#?KuE zm=)7@Wf>^snVg))^Bj~m+Y<~Fx~KLIzHyYhe((pviouqF5t7bEy+Yh_!)>t_tPT+X zVH7c4t5LNZeDuma+<5b+$>lS|aZJ;8a9xi$0wKY&=FV+48xFs@`$6_U{3>S+??hM0 zOJWkNYDUb5+iFpssh|wS7r%TpS6zECLJ0gIpfpio$BvQi5#pyFe}Q{`wvQom8v~ia zRgVooTS{lS6r>D;ZNrHuU^O2v0>bXk7=45J37f-Kl}rwLv_YC zo`+ar9as$FmK$!5y&##tw_F5a$W*n8-E#TlXD;F5OLueVjrVxyzGpb2xRbQ8a@C+$ zh;Q9+d+e?;5gjxghjO)oP?FJsF}4hhu1g#MTFduVONdVkE1hOTc8IJ|M9GsIt+j&Z z+sJbD{dKvxCUuJG5elhI>q(I({QN z2z?sv45gWOvE4eFE>qZUjkoRBK+sicvFHdR7XOOU0%|W1q%;d9)-MBq*+VWTdKUiy XXqTGI$C0NT00000NkvXXu0mjf?G|(} literal 0 HcmV?d00001 diff --git a/atm_averba_base/static/description/index.html b/atm_averba_base/static/description/index.html new file mode 100644 index 0000000..6329304 --- /dev/null +++ b/atm_averba_base/static/description/index.html @@ -0,0 +1,435 @@ + + + + + +AT&M Averba Base + + + +
+

AT&M Averba Base

+ + +

Alpha License: AGPL-3 Escodoo/clog-addons

+

AT&M Averba Base

+
+

Important

+

This is an alpha version, the data model and design can change at any time without warning. +Only for development or testing purpose, do not use in production. +More details on development status

+
+

Table of contents

+ +
+

Configuration

+
    +
  1. Go to Settings > Users & Companies > Companies and open or create a new company:
    2. +
+
    +
  • Access the Document Registration notebook.
    • +
  • Select the environment and fill out the user and password and codigoatm for authentication.
    • +
+
+
+

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

+
    +
  • Escodoo
    • +
+
+
+

Contributors

+ +
+
+

Maintainers

+

This module is part of the Escodoo/clog-addons project on GitHub.

+

You are welcome to contribute.

+
+
+
+ + diff --git a/atm_averba_base/tests/__init__.py b/atm_averba_base/tests/__init__.py new file mode 100644 index 0000000..ff995ef --- /dev/null +++ b/atm_averba_base/tests/__init__.py @@ -0,0 +1 @@ +from . import test_atm_averba diff --git a/atm_averba_base/tests/test_atm_averba.py b/atm_averba_base/tests/test_atm_averba.py new file mode 100644 index 0000000..5a99cef --- /dev/null +++ b/atm_averba_base/tests/test_atm_averba.py @@ -0,0 +1,78 @@ +# Copyright 2025 - TODAY, Cristiano Mafra Junior +# License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). + +from unittest import mock + +import requests + +from odoo.exceptions import UserError +from odoo.tests.common import SavepointCase + +from ..constants.atm_averba import ATM_AVERBA_URL + + +class MockResponse: + def __init__(self, json_data, status_code=200, ok=True, http_error=False): + self._json_data = json_data + self.status_code = status_code + self.ok = ok + self.http_error = http_error + + def json(self): + if self.http_error: + raise requests.HTTPError("Mocked HTTP Error") + return self._json_data + + def raise_for_status(self): + if self.http_error or not self.ok or self.status_code >= 400: + raise requests.HTTPError("Mocked HTTP Error") + + +def mocked_atm_token_success(*args, **kwargs): + return MockResponse({"token": "ATM_TOKEN_123"}) + + +def mocked_atm_token_failure(*args, **kwargs): + return MockResponse({"mensagem": "Erro ao autenticar"}, status_code=400, ok=False) + + +def mocked_atm_token_http_error(*args, **kwargs): + return MockResponse({}, status_code=500, ok=False, http_error=True) + + +class TestAtmAverba(SavepointCase): + @classmethod + def setUpClass(cls): + super().setUpClass() + cls.company = cls.env.company + cls.atm_user = "ws2" + cls.atm_pwd = "base123" + cls.company.atm_averba_user = cls.atm_user + cls.company.atm_averba_user_password = cls.atm_pwd + cls.company.atm_code = "12345678" + cls.company.atm_averba_environment = "2" + + def test_get_atm_averba_environment(self): + env = self.company.get_atm_averba_environment() + self.assertEqual(env["url"], ATM_AVERBA_URL) + self.assertEqual(env["usuario"], self.atm_user) + self.assertEqual(env["senha"], self.atm_pwd) + self.assertEqual(env["codigoatm"], "12345678") + + self.company.atm_averba_environment = "1" + env = self.company.get_atm_averba_environment() + self.assertEqual(env["url"], ATM_AVERBA_URL) + + @mock.patch("requests.post", side_effect=mocked_atm_token_failure) + def test_generate_atm_token_api_error(self, mock_post): + with self.assertRaises(UserError) as error: + self.company.generate_atm_token() + self.assertIn( + "Erro na conexão com AT&M: Mocked HTTP Error", str(error.exception) + ) + + @mock.patch("requests.post", side_effect=mocked_atm_token_http_error) + def test_generate_atm_token_http_error(self, mock_post): + with self.assertRaises(UserError) as error: + self.company.generate_atm_token() + self.assertIn("Erro na conexão com AT&M", str(error.exception)) diff --git a/atm_averba_base/views/res_company.xml b/atm_averba_base/views/res_company.xml new file mode 100644 index 0000000..82e6ff7 --- /dev/null +++ b/atm_averba_base/views/res_company.xml @@ -0,0 +1,31 @@ + + + + + + res.company.form (in atm_averba_base) + res.company + + + + + + + + + + + +