From b779ff3799f024228f16d0f0e99f5fef8da5909e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?C=C3=A9dric=20Krier?= Date: Thu, 8 Oct 2020 22:23:33 +0200 Subject: [PATCH] Add account_payment_braintree module issue9542 review306281002 --- .drone.yml | 62 + .flake8 | 2 + COPYRIGHT | 15 + LICENSE | 674 +++++++++ MANIFEST.in | 5 + README.rst | 1 + __init__.py | 32 + account.py | 1215 +++++++++++++++++ account.xml | 383 ++++++ checkout.html | 51 + doc/index.rst | 67 + ir.py | 25 + message.xml | 13 + party.py | 21 + routes.py | 83 ++ setup.py | 145 ++ tests/__init__.py | 9 + tests/scenario_account_payment_braintree.rst | 286 ++++ tests/test_account_payment_braintree.py | 31 + tox.ini | 15 + tryton.cfg | 10 + view/account_form.xml | 22 + view/account_list.xml | 7 + view/customer_form.xml | 24 + view/customer_list.xml | 9 + ...ustomer_payment_method_delete_ask_form.xml | 9 + view/payment_form.xml | 51 + view/payment_journal_form.xml | 11 + view/payment_list.xml | 9 + view/refund_form.xml | 19 + view/refund_list.xml | 8 + 31 files changed, 3314 insertions(+) create mode 100644 .drone.yml create mode 100644 .flake8 create mode 100644 COPYRIGHT create mode 100644 LICENSE create mode 100644 MANIFEST.in create mode 120000 README.rst create mode 100644 __init__.py create mode 100644 account.py create mode 100644 account.xml create mode 100644 checkout.html create mode 100644 doc/index.rst create mode 100644 ir.py create mode 100644 message.xml create mode 100644 party.py create mode 100644 routes.py create mode 100644 setup.py create mode 100644 tests/__init__.py create mode 100644 tests/scenario_account_payment_braintree.rst create mode 100644 tests/test_account_payment_braintree.py create mode 100644 tox.ini create mode 100644 tryton.cfg create mode 100644 view/account_form.xml create mode 100644 view/account_list.xml create mode 100644 view/customer_form.xml create mode 100644 view/customer_list.xml create mode 100644 view/customer_payment_method_delete_ask_form.xml create mode 100644 view/payment_form.xml create mode 100644 view/payment_journal_form.xml create mode 100644 view/payment_list.xml create mode 100644 view/refund_form.xml create mode 100644 view/refund_list.xml diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..b79548fdc8 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,62 @@ +clone: + hg: + image: plugins/hg + environment: + - HG_SHARE_POOL=/root/.cache/hg + volumes: + - cache:/root/.cache + +pipeline: + tox: + image: ${IMAGE} + environment: + - CFLAGS=-O0 + - DB_CACHE=/cache + - TOX_TESTENV_PASSENV=CFLAGS DB_CACHE + - POSTGRESQL_URI=postgresql://postgres@postgresql:5432/ + commands: + - echo "[extensions]" >> /root/.hgrc + - echo "hgext.share =" >> /root/.hgrc + - echo "[share]" >> /root/.hgrc + - echo "pool = /root/.cache/hg" >> /root/.hgrc + - pip install tox + - tox -e "${TOXENV}-${DATABASE}" + volumes: + - cache:/root/.cache + +services: + postgresql: + image: postgres + environment: + - POSTGRES_HOST_AUTH_METHOD=trust + command: "-c fsync=off -c synchronous_commit=off -c full_page_writes=off" + when: + matrix: + DATABASE: postgresql + +matrix: + include: + - IMAGE: python:3.5 + TOXENV: py35 + DATABASE: sqlite + - IMAGE: python:3.5 + TOXENV: py35 + DATABASE: postgresql + - IMAGE: python:3.6 + TOXENV: py36 + DATABASE: sqlite + - IMAGE: python:3.6 + TOXENV: py36 + DATABASE: postgresql + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: sqlite + - IMAGE: python:3.7 + TOXENV: py37 + DATABASE: postgresql + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: sqlite + - IMAGE: python:3.8 + TOXENV: py38 + DATABASE: postgresql diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000000..bb03d08a82 --- /dev/null +++ b/.flake8 @@ -0,0 +1,2 @@ +[flake8] +ignore=E123,E124,E126,E128,W503 diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..bf475e3362 --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,15 @@ +Copyright (C) 2020 B2CK +Copyright (C) 2020 Cédric Krier + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000..94a9ed024d --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000000..e88b2348a3 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include CHANGELOG +include COPYRIGHT +include LICENSE +include README.rst +include doc/* diff --git a/README.rst b/README.rst new file mode 120000 index 0000000000..176d9c2695 --- /dev/null +++ b/README.rst @@ -0,0 +1 @@ +doc/index.rst \ No newline at end of file diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000000..2786f31837 --- /dev/null +++ b/__init__.py @@ -0,0 +1,32 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.pool import Pool +from . import account +from . import ir +from . import party +from . import routes + +__all__ = ['register', 'routes'] + + +def register(): + Pool.register( + ir.Cron, + account.PaymentJournal, + account.PaymentGroup, + account.Payment, + account.PaymentBraintreeRefund, + account.PaymentBraintreeAccount, + account.PaymentBraintreeCustomer, + account.PaymentBraintreeCustomerPaymentMethodDeleteAsk, + party.Party, + module='account_payment_braintree', type_='model') + Pool.register( + account.PaymentBraintreeCustomerPaymentMethodDelete, + account.PaymentBraintreeCheckout, + party.Replace, + module='account_payment_braintree', type_='wizard') + Pool.register( + account.PaymentBraintreeCheckoutPage, + module='account_payment_braintree', type_='report') diff --git a/account.py b/account.py new file mode 100644 index 0000000000..7211df6b37 --- /dev/null +++ b/account.py @@ -0,0 +1,1215 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +import logging +import urllib +import uuid + +import braintree +from braintree.exceptions import TooManyRequestsError, GatewayTimeoutError +from braintree.exceptions.braintree_error import BraintreeError + +from trytond.cache import Cache +from trytond.config import config +from trytond.i18n import gettext +from trytond.model import ( + ModelSQL, ModelView, DeactivableMixin, Workflow, fields) +from trytond.pool import PoolMeta, Pool +from trytond.pyson import Eval, Bool +from trytond.report import Report +from trytond.transaction import Transaction +from trytond.url import http_host +from trytond.wizard import ( + Wizard, StateAction, StateView, StateTransition, Button) + +from trytond.modules.account_payment.exceptions import ( + ProcessError, PaymentValidationError) + +logger = logging.getLogger(__name__) + +SUCCEEDED_STATUSES = {braintree.Transaction.Status.Settled} +FAILED_STATUSES = { + braintree.Transaction.Status.AuthorizationExpired, + braintree.Transaction.Status.SettlementDeclined, + braintree.Transaction.Status.Failed, + braintree.Transaction.Status.GatewayRejected, + braintree.Transaction.Status.ProcessorDeclined, + braintree.Transaction.Status.Voided, + } +DISPUTE_FINAL_STATUSES = { + braintree.Dispute.Status.Expired, + braintree.Dispute.Status.Won, + braintree.Dispute.Status.Lost, + } + + +class PaymentJournal(metaclass=PoolMeta): + __name__ = 'account.payment.journal' + + braintree_account = fields.Many2One( + 'account.payment.braintree.account', "Account", ondelete='RESTRICT', + domain=[ + ('currency', '=', Eval('currency')), + ], + states={ + 'required': Eval('process_method') == 'braintree', + 'invisible': Eval('process_method') != 'braintree', + }, + depends=['currency', 'process_method']) + + @classmethod + def __setup__(cls): + super().__setup__() + braintree_method = ('braintree', "Braintree") + if braintree_method not in cls.process_method.selection: + cls.process_method.selection.append(braintree_method) + + +class PaymentGroup(metaclass=PoolMeta): + __name__ = 'account.payment.group' + + def process_braintree(self): + pool = Pool() + Payment = pool.get('account.payment') + for payment in self.payments: + if not payment.braintree_nonce and not payment.braintree_customer: + account = payment.journal.braintree_account + for customer in payment.party.braintree_customers: + if (customer.braintree_account == account + and customer.braintree_customer_id): + payment.braintree_customer = customer + break + else: + raise ProcessError( + gettext( + 'account_payment_braintree.msg_no_braintree_nonce', + payment=payment.rec_name)) + Payment.save(self.payments) + Payment.__queue__.braintree_transact(self.payments) + + +class CheckoutMixin: + braintree_checkout_id = fields.Char("Braintree Checkout ID", readonly=True) + braintree_client_token = fields.Char( + "Braintree Client Token", readonly=True) + braintree_nonce = fields.Char( + "Braintree Nonce", readonly=True, + states={ + 'invisible': ~Eval('braintree_nonce'), + }) + braintree_device_data = fields.Char( + "Braintree Device Data", readonly=True, + states={ + 'invisible': ~Eval('device_data'), + }) + + @classmethod + def copy(cls, records, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('braintree_checkout_id') + default.setdefault('braintree_client_token', None) + default.setdefault('braintree_nonce', None) + default.setdefault('braintree_device_data', None) + return super().copy(records, default=default) + + @classmethod + @ModelView.button_action('account_payment_braintree.wizard_checkout') + def braintree_checkout(cls, records): + for record in records: + record.braintree_checkout_id = uuid.uuid4().hex + cls.save(records) + + @property + def braintree_checkout_url(self): + pool = Pool() + database = Transaction().database.name + Checkout = pool.get( + 'account.payment.braintree.checkout', type='wizard') + action = Checkout.checkout.get_action() + return action['url'] % { + 'http_host': http_host(), + 'database': database, + 'model': self.__class__.__name__, + 'id': self.braintree_checkout_id, + } + + def braintree_set_nonce(self, nonce, device_data=None): + self.braintree_nonce = nonce + self.device_data = device_data + self.save() + + +class Payment(CheckoutMixin, metaclass=PoolMeta): + __name__ = 'account.payment' + + braintree_account = fields.Function(fields.Many2One( + 'account.payment.braintree.account', "Braintree Account"), + 'on_change_with_braintree_account') + + braintree_customer = fields.Many2One( + 'account.payment.braintree.customer', "Braintree Customer", + domain=[ + ('party', '=', Eval('party', -1)), + ('braintree_account', '=', Eval('braintree_account', -1)), + ], + states={ + 'invisible': Eval('process_method') != 'braintree', + 'readonly': (~Eval('state').in_(['draft', 'approved']) + | Eval('braintree_nonce')), + }, + depends=['party', 'braintree_account', 'process_method', + 'braintree_nonce', 'state']) + braintree_customer_method = fields.Char( + "Braintree Customer Method", + states={ + 'invisible': ((Eval('process_method') != 'braintree') + | Eval('braintree_nonce') + | ~Eval('braintree_customer')), + 'readonly': ~Eval('state').in_(['draft', 'approved']), + }, + depends=[ + 'process_method', + 'braintree_nonce', + 'braintree_customer', + 'state']) + # Use Function field with selection + # to avoid querying Braintree on validation + braintree_customer_method_selection = fields.Function(fields.Selection( + 'get_braintree_customer_methods', "Braintree Customer Method", + states={ + 'invisible': ((Eval('process_method') != 'braintree') + | Eval('braintree_nonce') + | ~Eval('braintree_customer')), + 'readonly': ~Eval('state').in_(['draft', 'approved']), + }, + depends=[ + 'process_method', + 'braintree_nonce', + 'braintree_customer', + 'state']), + 'get_braintree_customer_method', + setter='set_braintree_customer_method') + + braintree_transaction_id = fields.Char( + "Braintree Transaction ID", readonly=True, + states={ + 'invisible': ((Eval('process_method') != 'braintree') + | ~Eval('braintree_transaction_id')), + }, + depends=['process_method']) + braintree_settle_payment = fields.Boolean( + "Braintree Settle Payment", + states={ + 'invisible': Eval('process_method') != 'braintree', + 'readonly': Eval('state') != 'draft', + }, + depends=['process_method', 'state']) + braintree_payment_settled = fields.Boolean( + "Braintree Payment Settled", readonly=True) + braintree_settlement_needed = fields.Function( + fields.Boolean("Braintree Settlement Needed"), + 'get_braintree_settlement_needed') + + braintree_refunds = fields.One2Many( + 'account.payment.braintree.refund', 'payment', "Refunds", + states={ + 'invisible': ((Eval('process_method') != 'braintree') + | ~Eval('braintree_transaction_id')), + }, + depends=['process_method', 'braintree_transaction_id']) + + braintree_dispute_reason = fields.Char( + "Braintree Dispute Reason", readonly=True, + states={ + 'invisible': ~Eval('braintree_dispute_reason'), + }) + braintree_dispute_status = fields.Char( + "Braintree Dispute Status", readonly=True, + states={ + 'invisible': ~Eval('braintree_dispute_status'), + }) + + braintree_error_message = fields.Text( + "Braintree Error Message", readonly=True, + states={ + 'invisible': ~Eval('braintree_error_message'), + }) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.amount.states['readonly'] &= ~Eval('braintree_settlement_needed') + cls.amount.depends.append('braintree_settlement_needed') + cls._buttons.update({ + 'braintree_checkout': { + 'invisible': (~Eval('state', 'draft').in_( + ['approved', 'processing']) + | (Eval('process_method') != 'braintree') + | Eval('braintree_nonce') + | Eval('braintree_customer_method')), + 'depends': [ + 'state', + 'process_method', + 'braintree_nonce', + 'braintree_customer_method', + ], + }, + 'braintree_do_settle_payment': { + 'invisible': ((Eval('state', 'draft') != 'processing') + | ~Eval('braintree_settlement_needed')), + 'depends': ['state', 'braintree_settlement_needed'], + }, + 'braintree_do_pull': { + 'invisible': ~Eval('braintree_transaction_id'), + 'depends': ['braintree_transaction_id'], + }, + }) + + @fields.depends('journal') + def on_change_with_braintree_account(self, name=None): + if self.journal and self.journal.process_method == 'braintree': + return self.journal.braintree_account.id + + def on_change_party(self): + super().on_change_party() + self.braintree_customer = None + + @fields.depends('braintree_customer', 'braintree_customer_method') + def get_braintree_customer_methods(self): + methods = [('', '')] + if self.braintree_customer: + methods.extend(self.braintree_customer.payment_methods()) + if (self.braintree_customer_method + and self.braintree_customer_method not in dict(methods)): + methods.append(( + self.braintree_customer_method, + self.braintree_customer_method)) + return methods + + @fields.depends( + 'braintree_customer_method_selection', 'braintree_customer_method') + def on_change_braintree_customer_method_selection(self): + self.braintree_customer_method = ( + self.braintree_customer_method_selection) + + def get_braintree_customer_method(self, name): + return self.braintree_customer_method + + @classmethod + def set_braintree_customer_method(cls, payments, name, value): + pass + + @classmethod + def default_braintree_settle_payment(cls): + return True + + @classmethod + def default_braintree_payment_settled(cls): + return False + + def get_braintree_settlement_needed(self, name): + return (self.journal.process_method == 'braintree' + and self.braintree_transaction_id + and not self.braintree_settle_payment + and not self.braintree_payment_settled) + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('//group[@id="braintree"]', 'states', { + 'invisible': Eval('process_method') != 'braintree', + }), + ] + + @classmethod + def validate(cls, payments): + super(Payment, cls).validate(payments) + for payment in payments: + payment.check_braintree_journal() + + def check_braintree_journal(self): + if (self.kind != 'receivable' + and self.journal.process_method == 'braintree'): + raise PaymentValidationError( + gettext('account_payment_braintree.msg_braintree_receivable', + journal=self.journal.rec_name, + payment=self.rec_name)) + + @classmethod + def copy(cls, payments, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('braintree_transaction_id', None) + default.setdefault('braintree_payment_settled', False) + default.setdefault('braintree_error_message') + return super().copy(payments, default=default) + + @classmethod + def braintree_checkout(cls, payments): + for payment in payments: + if payment.braintree_client_token: + continue + gateway = payment.braintree_account.gateway() + client_token = gateway.client_token.generate() + payment.braintree_client_token = client_token + return super().braintree_checkout(payments) + + @classmethod + @ModelView.button + @Workflow.transition('draft') + def draft(cls, payments): + super(Payment, cls).draft(payments) + for payment in payments: + if payment.braintree_nonce: + payment.braintree_nonce = None + payment.braintree_device_data = None + cls.save(payments) + + @classmethod + def braintree_transact(cls, payments=None): + """Create transactions for braintree payments + + The transaction is committed after each payment sale.""" + if payments is None: + payments = cls.search([ + ('state', '=', 'processing'), + ('journal.process_method', '=', 'braintree'), + ['OR', + ('braintree_nonce', '!=', None), + ('braintree_customer_method', '!=', None), + ('braintree_customer', '!=', None), + ], + ('braintree_transaction_id', '=', None), + ('company', '=', Transaction().context.get('company')), + ]) + + for payment in payments: + # Use clear cache after a commit + payment = cls(payment.id) + if (payment.braintree_transaction_id + or payment.journal.process_method != 'braintree' + or payment.state != 'processing'): + continue + payment.lock() + gateway = payment.braintree_account.gateway() + try: + result = gateway.transaction.sale( + payment._braintree_transaction_parameters()) + except TooManyRequestsError as e: + logger.warning(str(e)) + continue + except BraintreeError as e: + payment.braintree_error_message = str(e) + payment.save() + cls.fail([payment]) + except Exception: + logger.error( + "Error when processing payment %d", payment.id, + exc_info=True) + continue + else: + if result.is_success: + payment.braintree_transaction_id = result.transaction.id + payment.braintree_payment_settled = ( + payment.braintree_settle_payment) + payment.braintree_update(result.transaction) + if (payment.braintree_account.environment == 'sandbox' + and (payment.braintree_account + .sandbox_settle_transaction) + and payment.braintree_settle_payment): + gateway.testing.settle_transaction( + result.transaction.id) + else: + payment.braintree_error_message = result.message + payment.save() + cls.fail([payment]) + Transaction().commit() + + def _braintree_transaction_parameters(self): + params = { + 'amount': self.amount, + 'options': { + 'submit_for_settlement': self.braintree_settle_payment, + }, + } + if self.braintree_nonce: + params['payment_method_nonce'] = self.braintree_nonce + elif self.braintree_customer_method: + params['payment_method_token'] = self.braintree_customer_method + elif self.braintree_customer: + params['customer_id'] = ( + self.braintree_customer.braintree_customer_id) + if self.braintree_device_data: + params['device_data'] = self.braintree_device_data + return params + + @classmethod + @ModelView.button + def braintree_do_settle_payment(cls, payments): + cls.write(payments, { + 'braintree_settle_payment': True, + }) + cls.__queue__.braintree_settle_payment_(payments) + + @classmethod + def braintree_settle_payment_(cls, payments=None): + """Settle braintree payments + + The transaction is committed after each payment settlement.""" + if payments is None: + payments = cls.search([ + ('state', '=', 'processing'), + ('journal.process_method', '=', 'braintree'), + ('braintree_transaction_id', '!=', None), + ('braintree_payment_settled', '=', False), + ('braintree_settle_payment', '=', True), + ('company', '=', Transaction().context.get('company')), + ]) + + for payment in payments: + # Use clear cache after a commit + payment = cls(payment.id) + if (payment.journal.process_method != 'braintree' + or payment.braintree_payment_settled + or payment.state != 'processing'): + continue + payment.lock() + braintree_account = payment.braintree_account + gateway = braintree_account.gateway() + try: + result = gateway.transaction.submit_for_settlement( + payment.braintree_transaction_id, + payment.amount, + payment._braintree_settlement_parameters()) + except TooManyRequestsError as e: + logger.warning(str(e)) + continue + except BraintreeError as e: + payment.braintree_error_message = str(e) + payment.save() + cls.fail([payment]) + except Exception: + logger.error( + "Error when processing payment %d", payment.id, + exc_info=True) + continue + else: + if result.is_success: + payment.braintree_payment_settled = True + payment.braintree_update(result.transaction) + if (braintree_account.environment == 'sandbox' + and (braintree_account + .sandbox_settle_transaction)): + gateway.testing.settle_transaction( + result.transaction.id) + else: + payment.braintree_error_message = result.message + payment.save() + cls.fail([payment]) + Transaction().commit() + + def _braintree_settlement_parameters(self): + return {} + + @classmethod + @ModelView.button + def braintree_do_pull(cls, payments): + cls.braintree_pull(payments) + + @classmethod + def braintree_pull(cls, payments=None): + "Update payments with braintree transactions" + if payments is None: + payments = cls.search([ + ('state', '=', 'processing'), + ('journal.process_method', '=', 'braintree'), + ('braintree_transaction_id', '!=', None), + ('company', '=', Transaction().context.get('company')), + ]) + + for payment in payments: + gateway = payment.braintree_account.gateway() + try: + transaction = gateway.transaction.find( + payment.braintree_transaction_id) + except TooManyRequestsError as e: + logger.warning(str(e)) + continue + except Exception: + logger.error( + "Error when pulling payment %d", payment.id, + exc_info=True) + continue + else: + payment.braintree_update(transaction) + cls.save(payments) + + def braintree_update(self, transaction): + "Update payment with braintree transaction" + if self.state == 'succeeded': + self.__class__.proceed([self]) + gateway = transaction.gateway + amount = transaction.amount + for id_ in transaction.refund_ids: + refund = gateway.transaction.find(id_) + if refund.status in SUCCEEDED_STATUSES: + amount -= refund.amount + for dispute in transaction.disputes: + if dispute.status in DISPUTE_FINAL_STATUSES: + amount -= dispute.amount_disputed - dispute.amount_won + self.amount = amount + self.save() + if transaction.status in SUCCEEDED_STATUSES: + if amount: + self.__class__.succeed([self]) + else: + self.__class__.fail([self]) + elif transaction.status in FAILED_STATUSES: + self.__class__.fail([self]) + + +class PaymentBraintreeRefund(Workflow, ModelSQL, ModelView): + "Braintree Payment Refund" + __name__ = 'account.payment.braintree.refund' + + payment = fields.Many2One( + 'account.payment', "Payment", required=True, + domain=[ + ('process_method', '=', 'braintree'), + ('braintree_transaction_id', '!=', None), + ], + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state']) + amount = fields.Numeric( + "Amount", required=True, digits=(16, Eval('currency_digits', 2)), + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['currency_digits', 'state']) + + state = fields.Selection([ + ('draft', "Draft"), + ('approved', "Approved"), + ('processing', "Processing"), + ('succeeded', "Succeeded"), + ('failed', "Failed"), + ], "State", readonly=True) + + braintree_transaction_id = fields.Char( + "Braintree Transaction ID", readonly=True) + + braintree_error_message = fields.Text( + "Braintree Error Message", readonly=True, + states={ + 'invisible': ~Eval('braintree_error_message'), + }) + + currency_digits = fields.Function( + fields.Integer("Currency Digits"), 'on_change_with_currency_digits') + + @classmethod + def __setup__(cls): + super().__setup__() + cls._transitions |= set(( + ('draft', 'approved'), + ('approved', 'processing'), + ('processing', 'succeeded'), + ('processing', 'failed'), + ('approved', 'draft'), + )) + cls._buttons.update({ + 'draft': { + 'invisible': Eval('state') != 'approved', + 'icon': 'tryton-back', + 'depends': ['state'], + }, + 'approve': { + 'invisible': Eval('state') != 'draft', + 'icon': 'tryton-forward', + 'depends': ['state'], + }, + }) + + @classmethod + def default_state(cls): + return 'draft' + + @fields.depends('payment', '_parent_payment.currency_digits') + def on_change_with_currency_digits(self, name=None): + if self.payment: + return self.payment.currency_digits + + @classmethod + def copy(cls, refunds, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('braintree_transaction_id') + default.setdefault('braintree_error_message') + return super().copy(refunds, default=default) + + @classmethod + @ModelView.button + @Workflow.transition('draft') + def draft(cls, refunds): + pass + + @classmethod + @ModelView.button + @Workflow.transition('approved') + def approve(cls, refunds): + pass + + @classmethod + @Workflow.transition('processing') + def process(cls, refunds): + pass + + @classmethod + @Workflow.transition('succeeded') + def succeed(cls, refunds): + pass + + @classmethod + @Workflow.transition('failed') + def fail(cls, refunds): + pass + + @classmethod + def braintree_refund(cls, refunds=None): + """Refund braintree transaction + + The transaction is committed after each refund.""" + if refunds is None: + refunds = cls.search([('state', '=', 'approved')]) + + for refund in refunds: + # User clear cache after a commit + refund = cls(refund.id) + if refund.braintree_transaction_id: + continue + refund.lock() + braintree_account = refund.payment.braintree_account + gateway = braintree_account.gateway() + try: + result = gateway.transaction.refund( + refund.payment.braintree_transaction_id, + refund._refund_parameters()) + except TooManyRequestsError as e: + logger.warning(str(e)) + continue + except BraintreeError as e: + refund.braintree_error_message = str(e) + refund.save() + cls.process([refund]) + cls.fail([refund]) + except Exception: + logger.error( + "Error when refund %d", refund.id, + exc_info=True) + continue + else: + cls.process([refund]) + if result.is_success: + refund.braintree_transaction_id = result.transaction.id + refund.braintree_update(result.transaction) + if (braintree_account.environment == 'sandbox' + and (braintree_account + .sandbox_settle_transaction)): + gateway.testing.settle_transaction( + result.transaction.id) + else: + refund.braintree_error_message = result.message + refund.save() + cls.fail([refund]) + Transaction().commit() + + def _refund_parameters(self): + return { + 'amount': self.amount, + } + + @classmethod + def braintree_pull(cls, refunds=None): + "Update refund with braintree transactions" + if refunds is None: + refunds = cls.search([ + ('state', '=', 'processing'), + ('braintree_transaction_id', '!=', None), + ('payment.company', + '=', Transaction().context.get('company')), + ]) + + for refund in refunds: + gateway = refund.payment.braintree_account.gateway() + try: + transaction = gateway.transaction.find( + refund.braintree_transaction_id) + except TooManyRequestsError as e: + logger.warning(str(e)) + continue + except Exception: + logger.error( + "Error when pulling refund %d", refund.id, + exc_info=True) + continue + else: + refund.braintree_update(transaction) + cls.save(refunds) + for refund in refunds: + if refund.state in {'succeeded', 'failed'}: + payment = refund.payment + gateway = payment.braintree_account.gateway() + transaction = gateway.transaction.find( + payment.braintree_transaction_id) + payment.braintree_update(transaction) + + def braintree_update(self, transaction): + "Update refund with braintree transaction" + self.amount = transaction.amount + self.save() + if transaction.status in SUCCEEDED_STATUSES: + self.__class__.succeed([self]) + elif transaction.status in FAILED_STATUSES: + self.__class__.fail([self]) + + +class PaymentBraintreeAccount(ModelSQL, ModelView): + "Braintree Account" + __name__ = 'account.payment.braintree.account' + + name = fields.Char("Name", required=True) + currency = fields.Many2One('currency.currency', "Currency", required=True) + environment = fields.Selection([ + ('sandbox', "Sandbox"), + ('production', "Production"), + ], "Environment", required=True) + merchant_id = fields.Char("Merchant ID", required=True) + public_key = fields.Char("Public Key", required=True) + private_key = fields.Char("Private Key", required=True) + webhook_identifier = fields.Char("Webhook Identifier", readonly=True) + webhook_endpoint = fields.Function( + fields.Char( + "Webhook Endpoint", + help="The URL to be called by Braintree."), + 'on_change_with_webhook_endpoint') + sandbox_settle_transaction = fields.Boolean( + "Automatic Settlement", + states={ + 'invisible': Eval('environment') != 'sandbox', + }, + depends=['environment']) + + @classmethod + def __setup__(cls): + super().__setup__() + cls._buttons.update({ + 'new_identifier': { + 'icon': 'tryton-refresh', + }, + }) + + @classmethod + def default_environment(cls): + return 'sandbox' + + @classmethod + def default_sandbox_settle_transaction(cls): + return False + + @fields.depends('webhook_identifier') + def on_change_with_webhook_endpoint(self, name=None): + if not self.webhook_identifier: + return + url_part = { + 'identifier': self.webhook_identifier, + 'database_name': Transaction().database.name, + } + return http_host() + ( + urllib.parse.quote( + '/%(database_name)s/account_payment_braintree' + '/webhook/%(identifier)s' % url_part)) + + @property + def configuration(self): + return braintree.Configuration( + environment=braintree.Environment.All[self.environment], + merchant_id=self.merchant_id, + public_key=self.public_key, + private_key=self.private_key, + ) + + def gateway(self): + return braintree.BraintreeGateway(self.configuration) + + @classmethod + @ModelView.button + def new_identifier(cls, accounts): + for account in accounts: + if account.webhook_identifier: + account.webhook_identifier = None + else: + account.webhook_identifier = uuid.uuid4().hex + cls.save(accounts) + + def webhook(self, notification): + """Handles Braintree webhook notification + + The return values must be: + - None if the method could not handle the notification kind + - True if the notification has been handled + - False if the notification should be retried by Braintree + """ + if notification.kind in { + braintree.WebhookNotification.Kind.DisputeOpened, + braintree.WebhookNotification.Kind.DisputeLost, + braintree.WebhookNotification.Kind.DisputeWon, + braintree.WebhookNotification.Kind.DisputeAccepted, + braintree.WebhookNotification.Kind.DisputeExpired, + braintree.WebhookNotification.Kind.DisputeDisputed}: + return self.webhook_dispute(notification.dispute) + elif notification.kind in { + braintree.WebhookNotification.Kind. + TransactionSettlementDeclined, + braintree.WebhookNotification.Kind.TransactionSettled}: + return self.webhook_transaction(notification.transaction) + return None + + def webhook_dispute(self, dispute): + pool = Pool() + Payment = pool.get('account.payment') + + payments = Payment.search([ + ('braintree_transaction_id', '=', dispute.transaction.id), + ]) + if not payments: + logger.error( + "webhook dispute: No payment '%s'", dispute.transaction.id) + for payment in payments: + # TODO remove when https://bugs.tryton.org/issue4080 + with Transaction().set_context(company=payment.company.id): + payment = Payment(payment.id) + payment.braintree_dispute_reason = dispute.reason + payment.braintree_dispute_status = dispute.status + payment.save() + gateway = payment.braintree_account.gateway() + transaction = gateway.transaction.find( + payment.braintree_transaction_id) + payment.braintree_update(transaction) + return bool(payments) + + def webhook_transaction(self, transaction): + pool = Pool() + Payment = pool.get('account.payment') + + payments = Payment.search([ + ('braintree_transaction_id', '=', transaction.id), + ]) + if not payments: + logger.error( + "webhook transaction: No payment '%s'", transaction.id) + for payment in payments: + # TODO remove when https://bugs.tryton.org/issue4080 + with Transaction().set_context(company=payment.company.id): + payment = Payment(payment.id) + payment.braintree_update(transaction) + return bool(payments) + + +class PaymentBraintreeCustomer( + CheckoutMixin, DeactivableMixin, ModelSQL, ModelView): + "Braintree Customer" + __name__ = 'account.payment.braintree.customer' + _history = True + party = fields.Many2One( + 'party.party', "Party", required=True, select=True, + states={ + 'readonly': ( + Eval('braintree_customer_id') | Eval('braintree_nonce')), + }, + depends=['braintree_customer_id', 'braintree_nonce']) + braintree_account = fields.Many2One( + 'account.payment.braintree.account', "Account", required=True, + states={ + 'readonly': ( + Eval('braintree_customer_id') | Eval('braintree_nonce')), + }, + depends=['braintree_customer_id', 'braintree_nonce']) + braintree_customer_id = fields.Char( + "Braintree Customer ID", + states={ + 'readonly': Eval('braintree_customer_id') & (Eval('id', -1) >= 0), + }) + braintree_error_message = fields.Text( + "Braintree Error Message", readonly=True, + states={ + 'invisible': ~Eval('braintree_error_message'), + }) + + _payment_methods_cache = Cache( + 'account_payment_braintree_customer.payment_methods', + duration=config.getint( + 'account_payment_braintree', 'payment_methods_cache', + default=15 * 60)) + + @classmethod + def __setup__(cls): + super().__setup__() + cls._buttons.update({ + 'braintree_checkout': { + 'invisible': Bool(Eval('braintree_nonce')), + 'depends': ['braintree_nonce'], + }, + 'delete_payment_method': { + 'invisible': ~Eval('braintree_customer_id'), + 'depends': ['braintree_customer_id'], + }, + }) + + def get_rec_name(self, name): + name = super().get_rec_name(name) + return ( + self.braintree_customer_id if self.braintree_customer_id else name) + + @classmethod + def delete(cls, customers): + cls.write(customers, { + 'active': False, + }) + + @classmethod + def copy(cls, customers, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('braintree_customer_id', None) + return super().copy(customers, default=default) + + @classmethod + def braintree_checkout(cls, customers): + for customer in customers: + if customer.braintree_client_token: + continue + gateway = customer.braintree_account.gateway() + client_token = gateway.client_token.generate( + customer._client_token_parameters()) + customer.braintree_client_token = client_token + return super().braintree_checkout(customers) + + def _client_token_parameters(self): + params = {} + if self.braintree_customer_id: + params['customer_id'] = self.braintree_customer_id + return params + + def braintree_set_nonce(self, nonce, device_data=None): + super().braintree_set_nonce(nonce, device_data=device_data) + self.braintree_create(customers=[self]) + + @classmethod + def braintree_create(cls, customers=None): + """Creates braintree customers + + The transaction is committed after each customer.""" + if not customers: + customers = cls.search([ + ('braintree_nonce', '!=', None), + ]) + for customer in customers: + # Use clear cache after commit + customer = cls(customer.id) + if not customer.braintree_nonce: + continue + customer.lock() + gateway = customer.braintree_account.gateway() + try: + if not customer.braintree_customer_id: + result = gateway.customer.create({ + 'email': customer.party.email, + 'phone': customer.party.phone, + 'payment_method_nonce': customer.braintree_nonce, + }) + else: + result = gateway.payment_method.create({ + 'customer_id': customer.braintree_customer_id, + 'payment_method_nonce': customer.braintree_nonce, + }) + except TooManyRequestsError as e: + logger.warning(str(e)) + continue + except BraintreeError as e: + customer.braintree_error_message = str(e) + except Exception: + logger.error( + "Error when creating customer %d", customer.id, + exc_info=True) + continue + else: + if result.is_success: + if not customer.braintree_customer_id: + customer.braintree_customer_id = result.customer.id + customer.braintree_error_message = None + else: + customer.braintree_error_message = result.message + customer.braintree_client_token = None + customer.braintree_nonce = None + customer.save() + cls._payment_methods_cache.clear() + Transaction().commit() + + @classmethod + def braintree_delete(cls, customers=None): + """Deletes braintree customers + + The transaction is committed after each customer.""" + if not customers: + customers = cls.search([ + ('active', '=', False), + ('braintree_customer_id', '!=', None), + ]) + for customer in customers: + # Use clear cache after commit + customer = cls(customer.id) + assert not customer.active + customer.lock() + gateway = customer.braintree_account.gateway() + try: + result = gateway.customer.delete( + customer.braintree_customer_id) + except TooManyRequestsError as e: + logger.warning(str(e)) + continue + except Exception: + logger.error( + "Error when deleting customer %d", customer.id, + exc_info=True) + continue + if result.is_success: + customer.braintree_customer_id = None + customer.save() + Transaction().commit() + + def find(self): + if not self.braintree_customer_id: + return + gateway = self.braintree_account.gateway() + try: + return gateway.customer.find(self.braintree_customer_id) + except (TooManyRequestsError, + GatewayTimeoutError) as e: + logger.warning(str(e)) + + def payment_methods(self): + methods = self._payment_methods_cache.get(self.id) + if methods is not None: + return methods + methods = [] + customer = self.find() + if customer: + for payment_method in customer.payment_methods: + name = self._payment_method_name(payment_method) + methods.append((payment_method.token, name)) + self._payment_methods_cache.set(self.id, methods) + return methods + + def _payment_method_name(cls, payment_method): + name = payment_method.token + if hasattr(payment_method, 'card_type'): + name = payment_method.card_type + if payment_method.last_4: + name += ' ****' + payment_method.last_4 + if (payment_method.expiration_month + and payment_method.expiration_year): + name += ' %s/%s' % ( + payment_method.expiration_month, + payment_method.expiration_year) + elif isinstance(payment_method, braintree.PayPalAccount): + name = "Paypal %s" % payment_method.email + elif isinstance(payment_method, braintree.VenmoAccount): + name = "Venmo %s" % payment_method.source_description + elif isinstance(payment_method, braintree.UsBankAccount): + name = "****" + payment_method.last_4 + return name + + @classmethod + @ModelView.button_action( + 'account_payment_braintree.wizard_customer_payment_method_delete') + def delete_payment_method(cls, customers): + pass + + def delete_payment_method_(self, payment_method): + gateway = self.braintree_account.gateway() + try: + result = gateway.payment_method.delete(payment_method) + except (TooManyRequestsError, + GatewayTimeoutError) as e: + logger.warning(str(e)) + else: + if not result.is_success: + logger.error(result.message) + self._payment_methods_cache.clear() + + +class PaymentBraintreeCustomerPaymentMethodDelete(Wizard): + "Delete Customer Payment Method" + __name__ = 'account.payment.braintree.customer.payment_method.delete' + start_state = 'ask' + ask = StateView( + 'account.payment.braintree.customer.payment_method.delete.ask', + 'account_payment_braintree.' + 'customer_payment_method_delete_ask_view_form', [ + Button("Cancel", 'end', 'tryton-cancel'), + Button("Delete", 'delete_', 'tryton-ok', default=True), + ]) + delete_ = StateTransition() + + def default_ask(self, fields): + default = {} + if 'customer' in fields: + default['customer'] = self.record.id + return default + + def transition_delete_(self): + self.record.delete_payment_method_(self.ask.payment_method) + return 'end' + + +class PaymentBraintreeCustomerPaymentMethodDeleteAsk(ModelView): + "Delete Customer Payment Method" + __name__ = 'account.payment.braintree.customer.payment_method.delete.ask' + + customer = fields.Many2One( + 'account.payment.braintree.customer', "Customer", readonly=True) + payment_method = fields.Selection( + 'get_payment_methods', "Payment Method", required=True) + + @fields.depends('customer') + def get_payment_methods(self): + methods = [('', '')] + if self.customer: + methods.extend(self.customer.payment_methods()) + return methods + + +class PaymentBraintreeCheckout(Wizard): + "Braintree Checkout" + __name__ = 'account.payment.braintree.checkout' + start_state = 'checkout' + checkout = StateAction('account_payment_braintree.url_checkout') + + def do_checkout(self, action): + action['url'] = self.record.braintree_checkout_url + return action, {} + + +class PaymentBraintreeCheckoutPage(Report): + "Braintree Checkout" + __name__ = 'account.payment.braintree.checkout' diff --git a/account.xml b/account.xml new file mode 100644 index 0000000000..82cde6de50 --- /dev/null +++ b/account.xml @@ -0,0 +1,383 @@ + + + + + + account.payment.journal + + payment_journal_form + + + + account.payment.braintree.account + form + account_form + + + + account.payment.braintree.account + tree + account_list + + + + Braintree Accounts + account.payment.braintree.account + + + + + + + + + + + + + + + new_identifier + New URL + This action will make the previous URL unusable. Do you want to continue? + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + account.payment + + payment_form + + + + account.payment + + payment_list + + + + braintree_checkout + Braintree Checkout + + + + + braintree_do_settle_payment + Braintree Settle Payment + + + + + braintree_do_pull + Braintree Pull + + + + + account.payment|braintree_transact + + minutes + + + + account.payment|braintree_pull + + minutes + + + + account.payment.braintree.refund + form + refund_form + + + account.payment.braintree.refund + tree + refund_list + + + + Braintree Refunds + account.payment.braintree.refund + + + + + + + + + + + + + Draft + + + + + + + Approved + + + + + + + Processing + + + + + + + Succeeded + + + + + + Failed + + + + + + All + + + + + + + + + User in company + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + draft + Draft + + + + + + + + + approve + Approve + + + + + + + + + account.payment.braintree.refund|braintree_refund + + minutes + + + + account.payment.braintree.refund|braintree_pull + + minutes + + + + account.payment.braintree.customer + form + customer_form + + + + account.payment.braintree.customer + tree + customer_list + + + + Braintree Customers + account.payment.braintree.customer + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + braintree_checkout + Add Card + + + + + account.payment.braintree.customer|braintree_create + + hours + + + + account.payment.braintree.customer|braintree_delete + + hours + + + + delete_payment_method + Delete Payment Method + + + + + Delete Payment Method + account.payment.braintree.customer.payment_method.delete + account.payment.braintree.customer + + + + account.payment.braintree.customer.payment_method.delete.ask + form + customer_payment_method_delete_ask_form + + + + Braintree Checkout + account.payment.braintree.checkout + + + + Braintree Checkout + %(http_host)s/%(database)s/account_payment_braintree/checkout/%(model)s/%(id)s + + + + Braintree Checkout + + account.payment.braintree.checkout + account_payment_braintree/checkout.html + html + + + diff --git a/checkout.html b/checkout.html new file mode 100644 index 0000000000..0477d9689d --- /dev/null +++ b/checkout.html @@ -0,0 +1,51 @@ + + + + + + Braintree Checkout + + + + +

${record.party.rec_name}

+
+
+ + +
+
+ + + diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..9f8f8c0a68 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,67 @@ +Account Payment Braintree Module +################################ + +The account_payment_braintree module allows receipt of payments using +`Braintree`_. +It uses the `Drop-in UI`_ in a checkout form to handle the `payment method +nonce`_ for card and other supported payment methods. + +.. _`Braintree`: https://www.braintreepayments.com/ +.. _`Drop-in UI`: https://developers.braintreepayments.com/guides/drop-in/overview/javascript/v3 +.. _`payment method nonce`: https://developers.braintreepayments.com/guides/payment-method-nonces + +Account +******* + +The Account stores the information about the Braintree account like the +merchant ID, the public and secret keys etc. + +The account's webhook endpoint is the URL used by Braintree's webhooks_. +If no webhook is setup, disputes will not update existing payments. + +.. _webhooks: https://developers.braintreepayments.com/guides/webhooks/overview + +Customer +******** + +The Customer allows parties to be registered as Braintree customers. +The checkout/add card button opens the Braintree Drop-in UI form. + +A scheduled task runs every hour to create new customers on Braintree and +another to delete them if they have become inactive. + +Journal +******* + +The journal has a new field to store the Braintree account if the process +method is set to "Braintree". + +Payment +******* + +The payment also has a checkout button which opens the Braintree Drop-in UI +form. +A payment can be processed using a nonce or a `payment method`_ from the +customer. +In case of an error, a new field displays the error message from Braintree. +The settle field can be unchecked to only authorize on processing and settle +the amount in a second step. + +Two scheduled tasks run every 15 minutes to transact and settle each processing +payment. +Another scheduled task also runs every 15 minutes to pull updates for each +processing payment until they have succeeded or failed. + +The Braintree payments have a pull button which can be used to force an update +with the braintree transaction. + +.. _payment method: https://developers.braintreepayments.com/guides/payment-methods + +Configuration +************* + +The account_payment_braintree module uses the section +`account_payment_braintree` to retrieve some parameters: + +- `payment_methods_cache`: defines the duration in seconds that payment methods + are kept in the cache. The default value is `15 * 60`. diff --git a/ir.py b/ir.py new file mode 100644 index 0000000000..c9d27dc9d9 --- /dev/null +++ b/ir.py @@ -0,0 +1,25 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.pool import PoolMeta + + +class Cron(metaclass=PoolMeta): + __name__ = 'ir.cron' + + @classmethod + def __setup__(cls): + super().__setup__() + cls.method.selection.extend([ + ('account.payment.braintree.customer|braintree_create', + "Create Braintree Customer"), + ('account.payment.braintree.customer|braintree_delete', + "Delete Braintree Customer"), + ('account.payment|braintree_transact', + "Transact Braintree Payment"), + ('account.payment|braintree_pull', + "Pull Braintree Payment"), + ('account.payment.braintree.refund|braintree_refund', + "Refund Braintree Payment"), + ('account.payment.braintree.refund|braintree_pull', + "Pull Braintree Refund"), + ]) diff --git a/message.xml b/message.xml new file mode 100644 index 0000000000..7768844bdd --- /dev/null +++ b/message.xml @@ -0,0 +1,13 @@ + + + + + + To process payment "%(payment)s" you must set a Braintree nonce or customer. + + + To pay "%(payment)s", you cannot use a Braintree journal "%(journal)s". + + + diff --git a/party.py b/party.py new file mode 100644 index 0000000000..32beea4a20 --- /dev/null +++ b/party.py @@ -0,0 +1,21 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.pool import PoolMeta +from trytond.model import fields + + +class Party(metaclass=PoolMeta): + __name__ = 'party.party' + + braintree_customers = fields.One2Many( + 'account.payment.braintree.customer', 'party', "Braintree Customers") + + +class Replace(metaclass=PoolMeta): + __name__ = 'party.replace' + + @classmethod + def fields_to_replace(cls): + return super().fields_to_replace() + [ + ('account.payment.braintree.customer', 'party'), + ] diff --git a/routes.py b/routes.py new file mode 100644 index 0000000000..0ea7ffb12a --- /dev/null +++ b/routes.py @@ -0,0 +1,83 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +import http.client +import logging +try: + from http import HTTPStatus +except ImportError: + from http import client as HTTPStatus + +import braintree +from werkzeug.exceptions import abort +from werkzeug.wrappers import Response + +from trytond.protocols.wrappers import with_pool, with_transaction +from trytond.wsgi import app + +logger = logging.getLogger(__name__) + + +@app.route( + '//account_payment_braintree/checkout//', + methods=['GET', 'POST']) +@with_pool +@with_transaction() +def checkout(request, pool, model, id): + Payment = pool.get('account.payment') + Customer = pool.get('account.payment.braintree.customer') + if model == Payment.__name__: + Model = Payment + elif model == Customer.__name__: + Model = Customer + else: + abort(HTTPStatus.FORBIDDEN) + try: + record, = Model.search([ + ('braintree_checkout_id', '=', id), + ]) + except ValueError: + abort(HTTPStatus.FORBIDDEN) + if request.method == 'GET': + Report = pool.get('account.payment.braintree.checkout', type='report') + # TODO language + data = { + 'model': Model.__name__, + 'client_token': record.braintree_client_token, + } + ext, content, _, _ = Report.execute([record.id], data) + assert ext == 'html' + return Response(content, HTTPStatus.OK, content_type='text/html') + elif request.method == 'POST': + record.braintree_set_nonce( + request.form['payment_method_nonce'], + request.form.get('device_data')) + return Response( + '', + HTTPStatus.OK, + content_type='text/html') + + +@app.route( + '//account_payment_braintree/webhook/', + methods={'POST'}) +@with_pool +@with_transaction() +def webhooks_endpoint(request, pool, account): + Account = pool.get('account.payment.braintree.account') + account, = Account.search([ + ('webhook_identifier', '=', account), + ]) + gateway = account.gateway() + try: + notification = gateway.webhook_notification.parse( + str(request.form['bt_signature']), request.form['bt_payload']) + except braintree.exceptions.invalid_signature_error.InvalidSignatureError: + abort(http.client.BAD_REQUEST) + + result = account.webhook(notification) + if result is None: + logger.info( + "No callback for notification kind '%s'", notification.kind) + elif not result: + return Response(status=http.client.NOT_FOUND) + return Response(status=http.client.NO_CONTENT) diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..571c376713 --- /dev/null +++ b/setup.py @@ -0,0 +1,145 @@ +#!/usr/bin/env python3 +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +import io +import os +import re +from configparser import ConfigParser +from setuptools import setup, find_packages + + +def read(fname, slice=None): + content = io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + if slice: + content = '\n'.join(content.splitlines()[slice]) + return content + + +def get_require_version(name): + if minor_version % 2: + require = '%s >= %s.%s.dev0, < %s.%s' + else: + require = '%s >= %s.%s, < %s.%s' + require %= (name, major_version, minor_version, + major_version, minor_version + 1) + return require + + +config = ConfigParser() +config.read_file(open(os.path.join(os.path.dirname(__file__), 'tryton.cfg'))) +info = dict(config.items('tryton')) +for key in ('depends', 'extras_depend', 'xml'): + if key in info: + info[key] = info[key].strip().splitlines() +version = info.get('version', '0.0.1') +major_version, minor_version, _ = version.split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) +name = 'trytond_account_payment_braintree' + +download_url = 'http://downloads.tryton.org/%s.%s/' % ( + major_version, minor_version) +if minor_version % 2: + version = '%s.%s.dev0' % (major_version, minor_version) + download_url = ( + 'hg+http://hg.tryton.org/modules/%s#egg=%s-%s' % ( + name[8:], name, version)) +local_version = [] +for build in ['CI_BUILD_NUMBER', 'CI_JOB_NUMBER', 'CI_JOB_ID']: + if os.environ.get(build): + local_version.append(os.environ[build]) +if local_version: + version += '+' + '.'.join(local_version) + +requires = ['braintree >= 3.24.0'] +for dep in info.get('depends', []): + if not re.match(r'(ir|res)(\W|$)', dep): + requires.append(get_require_version('trytond_%s' % dep)) +requires.append(get_require_version('trytond')) + +tests_require = [get_require_version('proteus')] +dependency_links = [] +if minor_version % 2: + dependency_links.append('https://trydevpi.tryton.org/') + +setup(name=name, + version=version, + description='Tryton module for Braintree payment', + long_description=read('README.rst'), + author='Tryton', + author_email='bugs@tryton.org', + url='http://www.tryton.org/', + download_url=download_url, + project_urls={ + "Bug Tracker": 'https://bugs.tryton.org/', + "Documentation": 'https://docs.tryton.org/', + "Forum": 'https://www.tryton.org/forum', + "Source Code": ( + 'https://hg.tryton.org/modules/account_payment_braintree'), + }, + keywords='tryton account payment braintree', + package_dir={'trytond.modules.account_payment_braintree': '.'}, + packages=( + ['trytond.modules.account_payment_braintree'] + + ['trytond.modules.account_payment_braintree.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.account_payment_braintree': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', '*.html', + 'icons/*.svg', 'tests/*.rst']), + }, + classifiers=[ + 'Development Status :: 5 - Production/Stable', + 'Environment :: Plugins', + 'Framework :: Tryton', + 'Intended Audience :: Developers', + 'Intended Audience :: Financial and Insurance Industry', + 'Intended Audience :: Legal Industry', + 'License :: OSI Approved :: ' + 'GNU General Public License v3 or later (GPLv3+)', + 'Natural Language :: Bulgarian', + 'Natural Language :: Catalan', + 'Natural Language :: Chinese (Simplified)', + 'Natural Language :: Czech', + 'Natural Language :: Dutch', + 'Natural Language :: English', + 'Natural Language :: Finnish', + 'Natural Language :: French', + 'Natural Language :: German', + 'Natural Language :: Hungarian', + 'Natural Language :: Indonesian', + 'Natural Language :: Italian', + 'Natural Language :: Persian', + 'Natural Language :: Polish', + 'Natural Language :: Portuguese (Brazilian)', + 'Natural Language :: Russian', + 'Natural Language :: Slovenian', + 'Natural Language :: Spanish', + 'Natural Language :: Turkish', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: 3.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Office/Business', + ], + license='GPL-3', + python_requires='>=3.5', + install_requires=requires, + dependency_links=dependency_links, + zip_safe=False, + entry_points=""" + [trytond.modules] + account_payment_braintree = trytond.modules.account_payment_braintree + """, # noqa: E501 + test_suite='tests', + test_loader='trytond.test_loader:Loader', + tests_require=tests_require, + ) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..9bee44bda6 --- /dev/null +++ b/tests/__init__.py @@ -0,0 +1,9 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +try: + from trytond.modules.account_payment_braintree.tests.test_account_payment_braintree import suite # noqa: E501 +except ImportError: + from .test_account_payment_braintree import suite + +__all__ = ['suite'] diff --git a/tests/scenario_account_payment_braintree.rst b/tests/scenario_account_payment_braintree.rst new file mode 100644 index 0000000000..e5f435fbce --- /dev/null +++ b/tests/scenario_account_payment_braintree.rst @@ -0,0 +1,286 @@ +================================== +Account Payment Braintree Scenario +================================== + +Imports:: + + >>> import os + >>> import random + >>> from decimal import Decimal + >>> import braintree + >>> from braintree.test.nonces import Nonces + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import create_company, \ + ... get_company + >>> from trytond.modules.account.tests.tools import create_fiscalyear, \ + ... create_chart, get_accounts + +Activate modules:: + + >>> config = activate_modules('account_payment_braintree') + +Get cron:: + + >>> Cron = Model.get('ir.cron') + +Create company:: + + >>> Company = Model.get('company.company') + >>> _ = create_company() + >>> company = get_company() + +Create fiscal year:: + + >>> fiscalyear = create_fiscalyear(company) + >>> fiscalyear.click('create_period') + +Create chart of accounts:: + + >>> _ = create_chart(company) + +Create Braintree account:: + + >>> BraintreeAccount = Model.get('account.payment.braintree.account') + >>> braintree_account = BraintreeAccount(name="Braintree") + >>> braintree_account.currency = company.currency + >>> braintree_account.environment = 'sandbox' + >>> braintree_account.merchant_id = os.getenv('BRAINTREE_MERCHANT_ID') + >>> braintree_account.public_key = os.getenv('BRAINTREE_PUBLIC_KEY') + >>> braintree_account.private_key = os.getenv('BRAINTREE_PRIVATE_KEY') + >>> braintree_account.save() + + >>> gateway = braintree.BraintreeGateway(braintree.Configuration( + ... environment=braintree.Environment.Sandbox, + ... merchant_id=braintree_account.merchant_id, + ... public_key=braintree_account.public_key, + ... private_key=braintree_account.private_key, + ... )) + +Create webhook identifier:: + + >>> braintree_account.click('new_identifier') + >>> len(braintree_account.webhook_identifier) + 32 + +Remove webhook:: + + >>> braintree_account.click('new_identifier') + >>> braintree_account.webhook_identifier + +Create payment journal:: + + >>> PaymentJournal = Model.get('account.payment.journal') + >>> payment_journal = PaymentJournal(name="Braintree", + ... process_method='braintree', braintree_account=braintree_account) + >>> payment_journal.save() + +Create party:: + + >>> Party = Model.get('party.party') + >>> customer = Party(name="Customer") + >>> customer.save() + +Create approved payment:: + + >>> Payment = Model.get('account.payment') + >>> payment = Payment() + >>> payment.journal = payment_journal + >>> payment.kind = 'receivable' + >>> payment.party = customer + >>> # Use random amount to prevent gateway rejection for duplicate + >>> payment.amount = amount = Decimal(random.randint(0, 1999)) + >>> payment.click('approve') + >>> payment.state + 'approved' + +Checkout the payment:: + + >>> action_id = payment.click('braintree_checkout') + >>> checkout = Wizard('account.payment.braintree.checkout', [payment]) + >>> bool(payment.braintree_checkout_id) + True + + >>> Payment.write([payment.id], { + ... 'braintree_nonce': Nonces.Transactable, + ... }, config.context) + +Process the payment:: + + >>> process_payment = Wizard('account.payment.process', [payment]) + >>> process_payment.execute('process') + >>> payment.state + 'processing' + >>> bool(payment.braintree_payment_settled) + True + >>> payment.amount == amount + True + + >>> _ = gateway.testing.settle_transaction(payment.braintree_transaction_id) + +Pull update:: + + >>> cron_payment_pull, = Cron.find([ + ... ('method', '=', 'account.payment|braintree_pull'), + ... ]) + >>> cron_payment_pull.companies.append(Company(company.id)) + >>> cron_payment_pull.click('run_once') + + >>> payment.reload() + >>> payment.state + 'succeeded' + >>> payment.amount == amount + True + +Create a customer:: + + >>> Customer = Model.get('account.payment.braintree.customer') + >>> braintree_customer = Customer() + >>> braintree_customer.party = customer + >>> braintree_customer.braintree_account = braintree_account + >>> braintree_customer.save() + >>> Customer.write([braintree_customer.id], { + ... 'braintree_nonce': Nonces.Transactable, + ... }, config.context) + +Run cron:: + + >>> cron_customer_create, = Cron.find([ + ... ('method', '=', 'account.payment.braintree.customer|braintree_create'), + ... ]) + >>> cron_customer_create.companies.append(Company(company.id)) + >>> cron_customer_create.click('run_once') + + >>> braintree_customer.reload() + >>> bool(braintree_customer.braintree_customer_id) + True + +Make payment with customer:: + + >>> payment, = payment.duplicate() + >>> payment.braintree_customer = braintree_customer + >>> payment.amount = amount = Decimal(random.randint(0, 1999)) + >>> payment.save() + >>> _, method = Payment.get_braintree_customer_methods(payment.id, config.context) + >>> method_token, _ = method + >>> payment.braintree_customer_method = method_token + >>> payment.click('approve') + >>> payment.state + 'approved' + >>> process_payment = Wizard('account.payment.process', [payment]) + >>> process_payment.execute('process') + >>> payment.state + 'processing' + + >>> _ = gateway.testing.settle_transaction(payment.braintree_transaction_id) + >>> cron_payment_pull.click('run_once') + >>> payment.reload() + >>> payment.state + 'succeeded' + +Delete customer:: + + >>> braintree_customer.delete() + >>> bool(braintree_customer.active) + False + +Run cron:: + + >>> cron_customer_delete, = Cron.find([ + ... ('method', '=', 'account.payment.braintree.customer|braintree_delete'), + ... ]) + >>> cron_customer_delete.companies.append(Company(company.id)) + >>> cron_customer_delete.click('run_once') + + >>> braintree_customer.reload() + >>> braintree_customer.braintree_customer_id + +Create payment to settle:: + + >>> payment, = payment.duplicate() + >>> payment.braintree_customer = None + >>> payment.braintree_settle_payment = False + >>> payment.amount = amount = Decimal(random.randint(0, 1999)) + >>> payment.click('approve') + >>> payment.state + 'approved' + + >>> Payment.write([payment.id], { + ... 'braintree_nonce': Nonces.Transactable, + ... }, config.context) + + >>> process_payment = Wizard('account.payment.process', [payment]) + >>> process_payment.execute('process') + >>> payment.state + 'processing' + + >>> _ = gateway.testing.settle_transaction(payment.braintree_transaction_id) + >>> cron_payment_pull.click('run_once') + >>> payment.reload() + >>> payment.state + 'processing' + +Settle lower amount:: + + >>> payment.amount = amount = Decimal(random.randint(2, int(payment.amount))) + >>> payment.click('braintree_do_settle_payment') + >>> payment.state + 'processing' + + >>> _ = gateway.testing.settle_transaction(payment.braintree_transaction_id) + >>> cron_payment_pull.click('run_once') + >>> payment.reload() + >>> payment.state + 'succeeded' + >>> bool(payment.braintree_payment_settled) + True + +Refund some amount:: + + >>> Refund = Model.get('account.payment.braintree.refund') + >>> refund = Refund() + >>> refund.payment = payment + >>> refund.amount = amount - 1 + >>> refund.click('approve') + >>> cron_refund, = Cron.find([ + ... ('method', '=', 'account.payment.braintree.refund|braintree_refund'), + ... ]) + >>> cron_refund.companies.append(Company(company.id)) + >>> cron_refund.click('run_once') + + >>> refund.reload() + >>> refund.state + 'processing' + >>> payment.reload() + >>> payment.amount == amount + True + + >>> _ = gateway.testing.settle_transaction(refund.braintree_transaction_id) + >>> cron_refund_pull, = Cron.find([ + ... ('method', '=', 'account.payment.braintree.refund|braintree_pull'), + ... ]) + >>> cron_refund_pull.companies.append(Company(company.id)) + >>> cron_refund_pull.click('run_once') + >>> refund.reload() + >>> refund.state + 'succeeded' + + >>> payment.reload() + >>> payment.amount + Decimal('1.00') + >>> payment.state + 'succeeded' + +Try to refund more:: + + >>> refund = Refund() + >>> refund.payment = payment + >>> refund.amount = Decimal('10') + >>> refund.click('approve') + >>> cron_refund.click('run_once') + >>> refund.reload() + >>> refund.state + 'failed' + >>> payment.reload() + >>> payment.amount + Decimal('1.00') diff --git a/tests/test_account_payment_braintree.py b/tests/test_account_payment_braintree.py new file mode 100644 index 0000000000..fb2b5a0956 --- /dev/null +++ b/tests/test_account_payment_braintree.py @@ -0,0 +1,31 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +import os +import unittest + +import doctest + +from trytond.tests.test_tryton import ModuleTestCase +from trytond.tests.test_tryton import suite as test_suite +from trytond.tests.test_tryton import doctest_teardown +from trytond.tests.test_tryton import doctest_checker + + +class AccountPaymentBraintreeTestCase(ModuleTestCase): + 'Test Account Payment Braintree module' + module = 'account_payment_braintree' + + +def suite(): + suite = test_suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + AccountPaymentBraintreeTestCase)) + if (os.getenv('BRAINTREE_MERCHANT_ID') + and os.getenv('BRAINTREE_PUBLIC_KEY') + and os.getenv('BRAINTREE_PRIVATE_KEY')): + suite.addTests(doctest.DocFileSuite( + 'scenario_account_payment_braintree.rst', + tearDown=doctest_teardown, encoding='utf-8', + checker=doctest_checker, + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + return suite diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..cc228265d8 --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +[tox] +envlist = {py35,py36,py37,py38}-{sqlite,postgresql},pypy3-{sqlite,postgresql} + +[testenv] +commands = {envpython} setup.py test +deps = + {py35,py36,py37,py38}-postgresql: psycopg2 >= 2.5 + pypy3-postgresql: psycopg2cffi >= 2.5 + {py35,py36}-sqlite: sqlitebck +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + sqlite: DB_NAME={env:SQLITE_NAME::memory:} + postgresql: DB_NAME={env:POSTGRESQL_NAME:test} +install_command = pip install --pre --find-links https://trydevpi.tryton.org/ {opts} {packages} diff --git a/tryton.cfg b/tryton.cfg new file mode 100644 index 0000000000..b7deedd9d1 --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,10 @@ +[tryton] +version=5.7.0 +depends: + account + account_payment + ir + party +xml: + account.xml + message.xml diff --git a/view/account_form.xml b/view/account_form.xml new file mode 100644 index 0000000000..c96191d3e3 --- /dev/null +++ b/view/account_form.xml @@ -0,0 +1,22 @@ + + +
+