commit 1459593cf95ded7dedecf5d5d62c8bbc16c22afb Author: Cédric Krier Date: Sun Apr 4 15:50:01 2021 +0200 Add sale_gift_card module issue9257 review315331002 diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..2049d30a49 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,68 @@ +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 CI_BUILD_NUMBER CI_JOB_NUMBER CI_JOB_ID + - 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 + check_dist: + image: ${IMAGE} + commands: + - pip install twine + - python setup.py sdist + - twine check dist/* + +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.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 + - IMAGE: python:3.9 + TOXENV: py39 + DATABASE: sqlite + - IMAGE: python:3.9 + TOXENV: py39 + 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..c54128df0f --- /dev/null +++ b/__init__.py @@ -0,0 +1,33 @@ +# 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 product +from . import sale +from . import stock + +__all__ = ['register'] + + +def register(): + Pool.register( + account.Configuration, + account.ConfigurationGiftCardAccount, + account.AccountTypeTemplate, + account.AccountType, + account.InvoiceLine, + product.Template, + product.Product, + sale.Configuration, + sale.ConfigurationGiftCardSequence, + sale.GiftCard, + sale.Sale, + sale.Line, + stock.Move, + module='sale_gift_card', type_='model') + Pool.register( + module='sale_gift_card', type_='wizard') + Pool.register( + sale.GiftCardEmail, + module='sale_gift_card', type_='report') diff --git a/account.py b/account.py new file mode 100644 index 0000000000..403e5cb70f --- /dev/null +++ b/account.py @@ -0,0 +1,102 @@ +# 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.model import ModelSQL, fields +from trytond.pool import PoolMeta, Pool +from trytond.pyson import Eval, Bool, If + +from trytond.modules.company.model import CompanyValueMixin + + +class Configuration(metaclass=PoolMeta): + __name__ = 'account.configuration' + + gift_card_account_expense = fields.MultiValue(fields.Many2One( + 'account.account', "Gift Card Expense", + domain=[ + ('type.gift_card', '=', True), + ('closed', '!=', True), + ('company', '=', Eval('context', {}).get('company', -1)), + ])) + gift_card_account_revenue = fields.MultiValue(fields.Many2One( + 'account.account', "Gift Card Revenue", + domain=[ + ('type.gift_card', '=', True), + ('closed', '!=', True), + ('company', '=', Eval('context', {}).get('company', -1)), + ])) + + @classmethod + def multivalue_model(cls, field): + pool = Pool() + if field in {'gift_card_account_expense', 'gift_card_account_revenue'}: + return pool.get('account.configuration.gift_card_account') + return super().multivalue_model(field) + + +class ConfigurationGiftCardAccount(ModelSQL, CompanyValueMixin): + "Account Configuration Gift Card Account" + __name__ = 'account.configuration.gift_card_account' + + gift_card_account_expense = fields.Many2One( + 'account.account', "Gift Card Expense", + domain=[ + ('type.gift_card', '=', True), + ('closed', '!=', True), + ('company', '=', Eval('company', -1)), + ], + depends=['company']) + gift_card_account_revenue = fields.Many2One( + 'account.account', "Gift Card Revenue", + domain=[ + ('type.gift_card', '=', True), + ('closed', '!=', True), + ('company', '=', Eval('company', -1)), + ], + depends=['company']) + + +def AccountTypeMixin(template=False): + + class Mixin: + __slots__ = () + gift_card = fields.Boolean( + "Gift Card", + domain=[ + If(Eval('statement') != 'balance', + ('gift_card', '=', False), ()), + ], + states={ + 'invisible': Eval('statement') != 'balance', + }, + depends=['statement']) + if not template: + for fname in dir(Mixin): + field = getattr(Mixin, fname) + if not isinstance(field, fields.Field): + continue + field.states['readonly'] = ( + Bool(Eval('template', -1)) & ~Eval('template_override', False)) + return Mixin + + +class AccountTypeTemplate(AccountTypeMixin(template=True), metaclass=PoolMeta): + __name__ = 'account.account.type.template' + + def _get_type_value(self, type=None): + values = super()._get_type_value(type=type) + if not type or type.gift_card != self.gift_card: + values['gift_card'] = self.gift_card + return values + + +class AccountType(AccountTypeMixin(), metaclass=PoolMeta): + __name__ = 'account.account.type' + + +class InvoiceLine(metaclass=PoolMeta): + __name__ = 'account.invoice.line' + + @classmethod + def _account_domain(cls, type_): + domain = super(InvoiceLine, cls)._account_domain(type_) + return domain + [('type.gift_card', '=', True)] diff --git a/account.xml b/account.xml new file mode 100644 index 0000000000..8579d59b94 --- /dev/null +++ b/account.xml @@ -0,0 +1,24 @@ + + + + + + account.configuration + + account_configuration_form + + + + account.account.type.template + + account_type_form + + + + account.account.type + + account_type_form + + + diff --git a/doc/conf.py b/doc/conf.py new file mode 100644 index 0000000000..8513b72dd2 --- /dev/null +++ b/doc/conf.py @@ -0,0 +1,61 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +modules_url = 'https://docs.tryton.org/projects/modules-{module}/en/{series}/' +trytond_url = 'https://docs.tryton.org/projects/server/en/{series}/' + + +def get_info(): + import configparser + import os + import subprocess + import sys + + module_dir = os.path.dirname(os.path.dirname(__file__)) + + config = configparser.ConfigParser() + config.read_file(open(os.path.join(module_dir, 'tryton.cfg'))) + info = dict(config.items('tryton')) + + result = subprocess.run( + [sys.executable, 'setup.py', '--name'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + info['name'] = result.stdout.decode('utf-8').strip() + + result = subprocess.run( + [sys.executable, 'setup.py', '--version'], + stdout=subprocess.PIPE, check=True, cwd=module_dir) + version = result.stdout.decode('utf-8').strip() + if 'dev' in version: + info['series'] = 'latest' + else: + info['series'] = '.'.join(version.split('.', 2)[:2]) + + for key in {'depends', 'extras_depend'}: + info[key] = info.get(key, '').strip().splitlines() + info['modules'] = set(info['depends'] + info['extras_depend']) + info['modules'] -= {'ir', 'res'} + + return info + + +info = get_info() + +master_doc = 'index' +project = info['name'] +release = version = info['series'] +default_role = 'ref' +highlight_language = 'none' +extensions = [ + 'sphinx.ext.intersphinx', + ] +intersphinx_mapping = { + 'trytond': (trytond_url.format(series=version), None), + } +intersphinx_mapping.update({ + m: (modules_url.format( + module=m.replace('_', '-'), series=version), None) + for m in info['modules'] + }) + +del get_info, info, modules_url, trytond_url diff --git a/doc/design.rst b/doc/design.rst new file mode 100644 index 0000000000..697695c27d --- /dev/null +++ b/doc/design.rst @@ -0,0 +1,67 @@ +****** +Design +****** + +The *Sale Gift Card Module* introduces or extends the following concepts. + +.. _concept-product: + +Product +======= + +When the *Sale Gift Card Module* is activated, services and goods can be +defined as gift cards. + +.. seealso:: + + The `Product ` concept is introduced by the + :doc:`Product Module `. + +.. _model-sale.gift_card: + +Gift Card +========= + +The *Gift Card* concept stores the unique number and value for each gift card. + +.. seealso:: + + Gift cards can be seen by opening the main menu item: + + |Sales --> Gift Cards|__ + + .. |Sales --> Gift Cards| replace:: :menuselection:`Sales --> Gift Cards` + __ https://demo.tryton.org/model/sale.gift_card + +.. _model-sale.sale: + +Sale +==== + +The *Sale* concept is extended to allow `Gift Cards ` +presented by customers to be redeemed. +On quotation these gift cards are deducted from the total. + +For *Sale Lines* that are for gift cards represented by service products an +optional email address can be provided. +This email address is then used to send the gift card to the customer by email. + +.. seealso:: + + The `Sale ` concept is introduced by the :doc:`Sale + Module `. + + +.. _model-stock.move: + +Stock Move +========== + +The *Stock Move* concept is extended to record the `Gift Cards +` shipped to customers. + + +.. seealso:: + + The `Move ` concept is introduced by the :doc:`Stock + Module `. diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..a7610bd6cb --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,11 @@ +##################### +Sale Gift Card Module +##################### + +The *Sale Gift Card Module* manages the selling and redeeming of gift cards. + +.. toctree:: + :maxdepth: 2 + + design + usage diff --git a/doc/usage.rst b/doc/usage.rst new file mode 100644 index 0000000000..5dcf4cbaf2 --- /dev/null +++ b/doc/usage.rst @@ -0,0 +1,32 @@ +***** +Usage +***** + +.. _Selling gift cards: + +Selling gift cards +================== + +A gift card `Product ` can sold on a `Sale +`. +When it is a service, the `Gift Card ` are created and +sent automatically by email to the email address from the sale line or, if this +has not been filled in, to the customer's email address. +When the *Product* is goods, the *Gift Cards* must be linked to the outgoing +`Stock Moves ` that send the gift card to the customer. + +.. _Redeeming gift card: + +Redeeming gift card +=================== + +Existing `Gift Cards ` can be added once to a `Sale +`. +On quotation, a return line for the amount of each gift card is created. + +.. note:: + + If the value of the redeemed gift cards exceeds the value of the sale then + the sales total will be negative. + This will normally result in a credit note being generated by the sale + instead of an `Invoice `. diff --git a/email.html b/email.html new file mode 100644 index 0000000000..40906ce78b --- /dev/null +++ b/email.html @@ -0,0 +1,20 @@ + + + + Gift Card + + + +
+

You received a gift card of ${format_currency(gift_card.value, None, gift_card.currency)} for ${gift_card.company.rec_name}.

+

Here is your code:

+
+ ${gift_card.number} +
+
+ + + diff --git a/exceptions.py b/exceptions.py new file mode 100644 index 0000000000..7f094879d9 --- /dev/null +++ b/exceptions.py @@ -0,0 +1,15 @@ +# 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.model.exceptions import ( + RequiredValidationError, SizeValidationError) +from trytond.modules.product.exceptions import TemplateValidationError + + +class GiftCardValidationError(TemplateValidationError): + pass + + +class MoveGiftCardValidationError( + RequiredValidationError, SizeValidationError): + pass diff --git a/message.xml b/message.xml new file mode 100644 index 0000000000..022ecb0d4f --- /dev/null +++ b/message.xml @@ -0,0 +1,16 @@ + + + + + + The numbers for each company's gift cards must be unique. + + + The default UOM for the gift card "%(template)s" must be "%(unit)s". + + + To do the move "%(move)s", you must use exactly %(quantity)d gift card(s). + + + diff --git a/product.py b/product.py new file mode 100644 index 0000000000..986a3bac33 --- /dev/null +++ b/product.py @@ -0,0 +1,62 @@ +# 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.i18n import gettext +from trytond.model import fields +from trytond.pool import PoolMeta, Pool +from trytond.pyson import Eval + +from .exceptions import GiftCardValidationError + + +class Template(metaclass=PoolMeta): + __name__ = 'product.template' + + gift_card = fields.Boolean( + "Gift Card", + states={ + 'invisible': ~Eval('type').in_(['service', 'goods']), + }, + depends=['type']) + + @fields.depends('gift_card') + def on_change_gift_card(self): + pool = Pool() + ModelData = pool.get('ir.model.data') + if self.gift_card: + self.default_uom = ModelData.get_id('product', 'uom_unit') + + @classmethod + def validate(cls, templates): + pool = Pool() + ModelData = pool.get('ir.model.data') + UoM = pool.get('product.uom') + super().validate(templates) + unit = UoM(ModelData.get_id('product', 'uom_unit')) + for template in templates: + if template.gift_card and template.default_uom != unit: + raise GiftCardValidationError( + gettext('sale_gift_card.msg_gift_card_invalid_uom', + template=template.rec_name, + unit=unit.rec_name)) + + @property + def account_expense_used(self): + pool = Pool() + Config = pool.get('account.configuration') + if self.gift_card: + config = Config(1) + return config.gift_card_account_expense + return super().account_expense_used + + @property + def account_revenue_used(self): + pool = Pool() + Config = pool.get('account.configuration') + if self.gift_card: + config = Config(1) + return config.gift_card_account_revenue + return super().account_revenue_used + + +class Product(metaclass=PoolMeta): + __name__ = 'product.product' diff --git a/product.xml b/product.xml new file mode 100644 index 0000000000..70184cd889 --- /dev/null +++ b/product.xml @@ -0,0 +1,12 @@ + + + + + + product.template + + template_form + + + diff --git a/sale.py b/sale.py new file mode 100644 index 0000000000..de63dd6db3 --- /dev/null +++ b/sale.py @@ -0,0 +1,345 @@ +# 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 email.header import Header + +from sql import Null +from sql.operators import Equal + +from trytond.config import config +from trytond.model import ModelSQL, ModelView, Workflow, Exclude, fields +from trytond.pool import PoolMeta, Pool +from trytond.pyson import Eval, Bool, Id +from trytond.report import Report, get_email +from trytond.sendmail import sendmail_transactional +from trytond.transaction import Transaction + +from trytond.modules.company.model import CompanyValueMixin + + +class Configuration(metaclass=PoolMeta): + __name__ = 'sale.configuration' + + gift_card_sequence = fields.MultiValue(fields.Many2One( + 'ir.sequence', "Gift Card Sequence", + domain=[ + ('company', 'in', [ + Eval('context', {}).get('company', -1), None]), + ('sequence_type', '=', Id( + 'sale_gift_card', 'sequence_type_gift_card')), + ])) + + @classmethod + def multivalue_model(cls, field): + pool = Pool() + if field == 'gift_card_sequence': + return pool.get('sale.configuration.gift_card.sequence') + return super().multivalue_model(field) + + +class ConfigurationGiftCardSequence(ModelSQL, CompanyValueMixin): + "Gift Card Configuration Sequence" + __name__ = 'sale.configuration.gift_card.sequence' + gift_card_sequence = fields.Many2One( + 'ir.sequence', "Gift Card Sequence", + domain=[ + ('company', 'in', [Eval('company', -1), None]), + ('sequence_type', '=', Id( + 'sale_gift_card', 'sequence_type_gift_card')), + ], + depends=['company']) + + +class GiftCard(ModelSQL, ModelView): + "Gift Card" + __name__ = 'sale.gift_card' + _rec_name = 'number' + + _states = { + 'readonly': Bool(Eval('origin')) | Bool(Eval('spent_on')), + } + _depends = ['origin'] + + number = fields.Char( + "Number", required=True, states=_states, depends=_depends) + company = fields.Many2One( + 'company.company', "Company", required=True, + states=_states, depends=_depends) + product = fields.Many2One( + 'product.product', "Product", required=True, + domain=[ + ('gift_card', '=', True), + ], + states=_states, depends=_depends) + value = fields.Numeric( + "Value", digits=(16, Eval('currency_digits', 2)), required=True, + states=_states, depends=_depends + ['currency_digits']) + currency = fields.Many2One( + 'currency.currency', "Currency", required=True, + states=_states, depends=_depends) + + origin = fields.Reference( + "Origin", selection='get_origin', select=True, readonly=True) + spent_on = fields.Reference( + "Spent On", selection='get_spent_on', select=True, readonly=True) + + currency_digits = fields.Function( + fields.Integer("Currency Digits"), 'on_change_with_currency_digits') + + del _states + del _depends + + @classmethod + def __setup__(cls): + super().__setup__() + t = cls.__table__() + cls._sql_constraints = [ + ('number_exclude', + Exclude(t, (t.number, Equal), (t.company, Equal), + where=(t.spent_on == Null)), + 'sale_gift_card.msg_gift_card_number_unique'), + ] + cls._order.insert(0, ('number', 'ASC')) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @fields.depends('currency') + def on_change_with_currency_digits(self, name=None): + if self.currency: + return self.currency.digits + + @classmethod + def _get_origin(cls): + return ['sale.line', 'stock.move'] + + @classmethod + def get_origin(cls): + pool = Pool() + Model = pool.get('ir.model') + return [(None, '')] + [ + (m, Model.get_name(m)) for m in cls._get_origin()] + + @fields.depends('origin', 'value', 'currency') + def on_change_origin(self): + pool = Pool() + SaleLine = pool.get('sale.line') + StockMove = pool.get('stock.move') + UoM = pool.get('product.uom') + if isinstance(self.origin, SaleLine): + line = self.origin + self.company = line.sale.company + self.product = line.product + if line.unit and line.unit_price and line.product: + self.value = UoM.compute_price( + line.unit, line.unit_price, line.product.default_uom) + self.currency = line.sale.currency + elif isinstance(self.origin, StockMove): + move = self.origin + self.company = move.company + self.product = move.product + if move.uom and move.unit_price: + self.value = UoM.compute_price( + move.uom, move.unit_price, move.product.default_uom) + self.currency = move.currency + if self.value and self.currency: + self.value = self.currency.round(self.value) + + @classmethod + def _get_spent_on(cls): + return ['sale.sale'] + + @classmethod + def get_spent_on(cls): + pool = Pool() + Model = pool.get('ir.model') + return [(None, '')] + [ + (m, Model.get_name(m)) for m in cls._get_spent_on()] + + def get_rec_name(self, name): + if not self.number: + name = '(%d)' % self.id + else: + name = self.number + return name + + @property + def _email(self): + pool = Pool() + SaleLine = pool.get('sale.line') + if isinstance(self.origin, SaleLine): + return self.origin.gift_card_email or self.origin.sale.party.email + + @property + def _languages(self): + pool = Pool() + SaleLine = pool.get('sale.line') + languages = [] + if isinstance(self.origin, SaleLine): + lang = self.origin.sale.party.lang + if lang: + languages.append(lang) + return languages + + @classmethod + def send(cls, gift_cards, from_=None): + pool = Pool() + Lang = pool.get('ir.lang') + if from_ is None: + from_ = config.get('email', 'from') + for gift_card in gift_cards: + email = gift_card._email + languages = gift_card._languages + if not languages: + languages.append(Lang.get()) + msg, title = get_email( + 'sale.gift_card.email', gift_card, languages) + msg['From'] = from_ + msg['To'] = email + msg['Subject'] = Header(title, 'utf-8') + sendmail_transactional(from_, [email], msg, strict=True) + + +class GiftCardEmail(Report): + __name__ = 'sale.gift_card.email' + + +class Sale(metaclass=PoolMeta): + __name__ = 'sale.sale' + + gift_cards = fields.One2Many( + 'sale.gift_card', 'spent_on', "Gift Cards", + domain=[ + ('company', '=', Eval('company', -1)), + ('currency', '=', Eval('currency', -1)), + ], + add_remove=[ + ('spent_on', '=', None), + ], + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state', 'company', 'currency']) + + @classmethod + @ModelView.button + @Workflow.transition('quotation') + def quote(cls, sales): + for sale in sales: + sale.add_return_gift_cards() + cls.save(sales) + super().quote(sales) + + def add_return_gift_cards(self): + lines = list(self.lines) + for line in self.lines: + if line.is_gift_card and line.quantity < 0: + lines.remove(line) + for gift_card in self.gift_cards: + lines.append(self.get_return_gift_card_line(gift_card)) + self.lines = lines + + def get_return_gift_card_line(self, gift_card): + pool = Pool() + Line = pool.get('sale.line') + sequence = None + if self.lines: + last_line = self.lines[-1] + if last_line.sequence is not None: + sequence = last_line.sequence + 1 + return Line( + sale=self, + sequence=sequence, + type='line', + product=gift_card.product, + quantity=-1, + unit=gift_card.product.default_uom, + unit_price=gift_card.value, + ) + + @classmethod + @ModelView.button + def process(cls, sales): + pool = Pool() + GiftCard = pool.get('sale.gift_card') + cls.lock(sales) + gift_cards = [] + for sale in sales: + for line in sale.lines: + cards = line.get_gift_cards() + if cards: + gift_cards.extend(cards) + GiftCard.save(gift_cards) + GiftCard.send(gift_cards) + super().process(sales) + + +class Line(metaclass=PoolMeta): + __name__ = 'sale.line' + + gift_cards = fields.One2Many( + 'sale.gift_card', 'origin', "Gift Cards", readonly=True, + states={ + 'invisible': ~Eval('gift_cards', []), + }) + is_gift_card = fields.Function( + fields.Boolean("Is Gift Card"), 'on_change_with_is_gift_card') + is_gift_card_service = fields.Function( + fields.Boolean("Is Gift Card Service"), + 'on_change_with_is_gift_card_service') + gift_card_email = fields.Char( + "Gift Card Email", + states={ + 'invisible': ~Eval('is_gift_card_service', False), + }, + depends=['is_gift_card_service'], + help="Leave empty for the customer email.") + + @fields.depends('product') + def on_change_with_is_gift_card(self, name=None): + return self.product and self.product.gift_card + + @fields.depends('product', methods=['on_change_with_is_gift_card']) + def on_change_with_is_gift_card_service(self, name=None): + return (self.on_change_with_is_gift_card() + and self.product.type == 'service') + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('//page[@id="gift_cards"]', 'states', { + 'invisible': ~Eval('is_gift_card_service', False), + }, ['is_gift_card_service']), + ] + + def get_gift_cards(self): + if (not self.is_gift_card_service + or self.quantity < 0 + or self.gift_cards): + return + pool = Pool() + GiftCard = pool.get('sale.gift_card') + UoM = pool.get('product.uom') + Config = pool.get('sale.configuration') + config = Config(1) + cards = [] + quantity = UoM.compute_qty( + self.unit, self.quantity, self.product.default_uom) + quantity -= len(self.gift_cards) + quantity = max(quantity, 0) + unit_price = UoM.compute_price( + self.unit, self.unit_price, self.product.default_uom) + unit_price = self.sale.currency.round(unit_price) + for _ in range(int(quantity)): + card = GiftCard() + card.company = self.sale.company + sequence = config.get_multivalue( + 'gift_card_sequence', company=card.company.id) + if sequence: + card.number = sequence.get() + card.product = self.product + card.value = unit_price + card.currency = self.sale.currency + card.origin = self + cards.append(card) + return cards diff --git a/sale.xml b/sale.xml new file mode 100644 index 0000000000..f9c7bf5563 --- /dev/null +++ b/sale.xml @@ -0,0 +1,116 @@ + + + + + + Gift Card Administration + + + + + + + + Gift Card + + + + + + + + sale.configuration + + configuration_form + + + + sale.gift_card + form + gift_card_form + + + + sale.gift_card + tree + gift_card_list + + + + Gift Cards + sale.gift_card + + + + + + + + + + + + + Pending + + + + + + + Sent + + + + + + + All + + + + + + + + + + + + + + + + + + + + + + + + Gift Card + sale.gift_card + sale.gift_card.email + sale_gift_card/email.html + html + + + + sale.sale + + sale_form + + + + sale.line + + sale_line_form + + + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..df705e4975 --- /dev/null +++ b/setup.py @@ -0,0 +1,152 @@ +#!/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): + content = io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + content = re.sub( + r'(?m)^\.\. toctree::\r?\n((^$|^\s.*$)\r?\n)*', '', content) + 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_sale_gift_card' + +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 = [] +if os.environ.get('CI_JOB_ID'): + local_version.append(os.environ['CI_JOB_ID']) +else: + for build in ['CI_BUILD_NUMBER', 'CI_JOB_NUMBER']: + if os.environ.get(build): + local_version.append(os.environ[build]) + else: + local_version = [] + break +if local_version: + version += '+' + '.'.join(local_version) + +requires = [] +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/?local_version=' + + '.'.join(local_version)) + +setup(name=name, + version=version, + description="Tryton module to manage gift cards", + 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/sale_gift_card', + }, + keywords='tryton sale gift card', + package_dir={'trytond.modules.sale_gift_card': '.'}, + packages=( + ['trytond.modules.sale_gift_card'] + + ['trytond.modules.sale_gift_card.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.sale_gift_card': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.fodt', + '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.6', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Office/Business', + ], + license='GPL-3', + python_requires='>=3.6', + install_requires=requires, + dependency_links=dependency_links, + zip_safe=False, + entry_points=""" + [trytond.modules] + sale_gift_card = trytond.modules.sale_gift_card + """, # noqa: E501 + test_suite='tests', + test_loader='trytond.test_loader:Loader', + tests_require=tests_require, + ) diff --git a/stock.py b/stock.py new file mode 100644 index 0000000000..76ac58186a --- /dev/null +++ b/stock.py @@ -0,0 +1,57 @@ +# 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.i18n import gettext +from trytond.model import ModelView, Workflow, fields +from trytond.pool import PoolMeta +from trytond.pyson import Eval, If + +from .exceptions import MoveGiftCardValidationError + + +class Move(metaclass=PoolMeta): + __name__ = 'stock.move' + + gift_cards = fields.One2Many( + 'sale.gift_card', 'origin', "Gift Cards", + size=If(Eval('gift_cards_required'), + Eval('internal_quantity', 0), 0), + add_remove=[ + ('origin', '=', None), + ], + domain=[ + ('company', '=', Eval('company', -1)), + ('product', '=', Eval('product', -1)), + ], + states={ + 'invisible': ~Eval('gift_cards_required', []), + 'required': ( + Eval('gift_cards_required', False) + & (Eval('state') == 'done')), + 'readonly': Eval('state').in_(['cancel', 'done']), + }, + depends=[ + 'gift_cards_required', 'internal_quantity', 'company', 'product', + 'state']) + gift_cards_required = fields.Function( + fields.Boolean("Gift Cards Required"), + 'on_change_with_gift_cards_required') + + @fields.depends('product', 'to_location') + def on_change_with_gift_cards_required(self, name=None): + return ( + self.product and self.product.gift_card + and self.to_location and self.to_location.type == 'customer') + + @classmethod + @ModelView.button + @Workflow.transition('done') + def do(cls, moves): + for move in moves: + if not move.gift_cards_required: + continue + if len(move.gift_cards) != move.internal_quantity: + raise MoveGiftCardValidationError( + gettext('sale_gift_card.msg_gift_card_move_quantity', + move=move.rec_name, + quantity=move.internal_quantity)) + super().do(moves) diff --git a/stock.xml b/stock.xml new file mode 100644 index 0000000000..73d6fed0bd --- /dev/null +++ b/stock.xml @@ -0,0 +1,12 @@ + + + + + + stock.move + + move_form + + + diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..243eb5f080 --- /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.sale_gift_card.tests.test_sale_gift_card import suite # noqa: E501 +except ImportError: + from .test_sale_gift_card import suite + +__all__ = ['suite'] diff --git a/tests/scenario_sale_gift_card.rst b/tests/scenario_sale_gift_card.rst new file mode 100644 index 0000000000..d8057c7c7a --- /dev/null +++ b/tests/scenario_sale_gift_card.rst @@ -0,0 +1,192 @@ +======================= +Sale Gift Card Scenario +======================= + +Imports:: + + >>> import re + >>> from decimal import Decimal + >>> from proteus import Model + >>> 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) + +Patch sendmail_transactional:: + + >>> from unittest.mock import MagicMock + >>> from trytond.modules.sale_gift_card import sale + >>> sale.sendmail_transactional = smtp_calls = MagicMock() + +Activate modules:: + + >>> config = activate_modules('sale_gift_card') + + >>> Account = Model.get('account.account') + >>> AccountConfig = Model.get('account.configuration') + >>> GiftCard = Model.get('sale.gift_card') + >>> Party = Model.get('party.party') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUoM = Model.get('product.uom') + >>> Sale = Model.get('sale.sale') + >>> SaleConfig = Model.get('sale.configuration') + >>> Sequence = Model.get('ir.sequence') + >>> SequenceType = Model.get('ir.sequence.type') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Setup gift card accounting:: + + >>> gift_card_type, = accounts['payable'].type.duplicate( + ... {'gift_card': True}) + >>> gift_card_revenue = Account(name="Gift Card") + >>> gift_card_revenue.type = gift_card_type + >>> gift_card_revenue.deferral = True + >>> gift_card_revenue.save() + >>> account_config = AccountConfig(1) + >>> account_config.gift_card_account_revenue = gift_card_revenue + >>> account_config.save() + +Set gift card sequence:: + + >>> sale_config = SaleConfig(1) + >>> gift_card_sequence = Sequence(name="Gift Card") + >>> gift_card_sequence.sequence_type, = SequenceType.find([ + ... ('name', '=', "Gift Card"), + ... ]) + >>> gift_card_sequence.type = 'hexadecimal timestamp' + >>> gift_card_sequence.save() + >>> sale_config.gift_card_sequence = gift_card_sequence + >>> sale_config.save() + +Create gift card product:: + + >>> unit, = ProductUoM.find([('name', '=', "Unit")]) + + >>> template = ProductTemplate() + >>> template.name = "Gift Card" + >>> template.type = 'service' + >>> template.default_uom = unit + >>> template.salable = True + >>> template.gift_card = True + >>> template.list_price = Decimal('50') + >>> template.save() + >>> gift_card, = template.products + +Create account category:: + + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_expense = accounts['expense'] + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.save() + +Create a product:: + + >>> template = ProductTemplate() + >>> template.name = "Product" + >>> template.default_uom = unit + >>> template.salable = True + >>> template.list_price = Decimal('100') + >>> template.account_category = account_category + >>> template.save() + >>> product, = template.products + +Create parties:: + + >>> customer1 = Party(name='Customer 1') + >>> customer1.save() + >>> customer2 = Party(name='Customer 2') + >>> customer2.save() + +Sell 2 gift cards:: + + >>> sale = Sale() + >>> sale.party = customer1 + >>> line = sale.lines.new() + >>> line.product = gift_card + >>> line.quantity = 2 + >>> line.gift_card_email = "customer@example.com" + >>> sale.click('quote') + >>> sale.click('confirm') + >>> sale.state + 'processing' + +Check gift cards:: + + >>> cards = GiftCard.find([]) + >>> len(cards) + 2 + >>> card = cards[-1] + >>> card.product == gift_card + True + >>> card.value + Decimal('50.00') + >>> bool(card.origin) + True + >>> bool(card.spent_on) + False + >>> smtp_calls.call_count + 2 + >>> from_, to, msg = smtp_calls.call_args[0] + >>> to + ['customer@example.com'] + >>> msg = msg.get_payload(0).get_payload(decode=True).decode('utf-8') + >>> card.number in msg + True + +Check invoice:: + + >>> invoice, = sale.invoices + >>> line, = invoice.lines + >>> line.account == gift_card_revenue + True + +Redeem a gift card to buy a product:: + + >>> sale = Sale() + >>> sale.party = customer2 + >>> line = sale.lines.new() + >>> line.product = product + >>> line.quantity = 1 + >>> sale.gift_cards.append(GiftCard(card.id)) + >>> sale.save() + >>> sale.total_amount + Decimal('100.00') + >>> sale.click('quote') + >>> len(sale.lines) + 2 + >>> sale.total_amount + Decimal('50.00') + >>> sale.click('confirm') + >>> sale.state + 'processing' + +Check gift card:: + + >>> card.reload() + >>> card.spent_on == sale + True + +Check the invoice:: + + >>> invoice, = sale.invoices + >>> len(invoice.lines) + 2 + >>> invoice.total_amount + Decimal('50.00') + >>> gift_card_line, = [l for l in invoice.lines if l.product == gift_card] + >>> gift_card_line.quantity + -1.0 + >>> gift_card_line.account == gift_card_revenue + True diff --git a/tests/scenario_sale_gift_card_goods.rst b/tests/scenario_sale_gift_card_goods.rst new file mode 100644 index 0000000000..f4101fbf69 --- /dev/null +++ b/tests/scenario_sale_gift_card_goods.rst @@ -0,0 +1,131 @@ +============================= +Sale Gift Card Goods Scenario +============================= + +Imports:: + + >>> from decimal import Decimal + >>> from proteus import Model + >>> 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('sale_gift_card') + + >>> Account = Model.get('account.account') + >>> AccountConfig = Model.get('account.configuration') + >>> GiftCard = Model.get('sale.gift_card') + >>> Party = Model.get('party.party') + >>> ProductCategory = Model.get('product.category') + >>> ProductTemplate = Model.get('product.template') + >>> ProductUoM = Model.get('product.uom') + >>> Sale = Model.get('sale.sale') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Setup gift card accounting:: + + >>> gift_card_type, = accounts['payable'].type.duplicate( + ... {'gift_card': True}) + >>> gift_card_revenue = Account(name="Gift Card") + >>> gift_card_revenue.type = gift_card_type + >>> gift_card_revenue.deferral = True + >>> gift_card_revenue.save() + >>> account_config = AccountConfig(1) + >>> account_config.gift_card_account_revenue = gift_card_revenue + >>> account_config.save() + +Create gift card product:: + + >>> unit, = ProductUoM.find([('name', '=', "Unit")]) + + >>> template = ProductTemplate() + >>> template.name = "Gift Card" + >>> template.type = 'goods' + >>> template.default_uom = unit + >>> template.salable = True + >>> template.gift_card = True + >>> template.list_price = Decimal('20') + >>> template.save() + >>> gift_card, = template.products + +Create account category:: + + >>> account_category = ProductCategory(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_expense = accounts['expense'] + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.save() + +Create a product:: + + >>> template = ProductTemplate() + >>> template.name = "Product" + >>> template.default_uom = unit + >>> template.salable = True + >>> template.list_price = Decimal('100') + >>> template.account_category = account_category + >>> template.save() + >>> product, = template.products + +Create parties:: + + >>> customer1 = Party(name='Customer 1') + >>> customer1.save() + >>> customer2 = Party(name='Customer 2') + >>> customer2.save() + +Sell 1 gift cards:: + + >>> sale = Sale() + >>> sale.party = customer1 + >>> line = sale.lines.new() + >>> line.product = gift_card + >>> line.quantity = 1 + >>> sale.click('quote') + >>> sale.click('confirm') + >>> sale.state + 'processing' + +Check gift cards:: + + >>> cards = GiftCard.find([]) + >>> len(cards) + 0 + +Check invoice:: + + >>> invoice, = sale.invoices + >>> line, = invoice.lines + >>> line.account == gift_card_revenue + True + +Ship the gift card:: + + >>> shipment, = sale.shipments + >>> shipment.click('assign_force') + >>> shipment.click('pick') + >>> shipment.click('pack') + >>> shipment.click('done') # doctest: +IGNORE_EXCEPTION_DETAIL + Traceback (most recent call last): + ... + MoveGiftCardValidationError: ... + >>> move, = shipment.outgoing_moves + >>> gift_card = move.gift_cards.new(product=gift_card) + >>> gift_card.number = "1234" + >>> gift_card.value + Decimal('20.00') + >>> move.save() + >>> shipment.click('done') diff --git a/tests/test_sale_gift_card.py b/tests/test_sale_gift_card.py new file mode 100644 index 0000000000..9903e8391a --- /dev/null +++ b/tests/test_sale_gift_card.py @@ -0,0 +1,33 @@ +# 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 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 SaleGiftCardTestCase(ModuleTestCase): + 'Test Sale Gift Card module' + module = 'sale_gift_card' + + +def suite(): + suite = test_suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + SaleGiftCardTestCase)) + suite.addTests(doctest.DocFileSuite( + 'scenario_sale_gift_card.rst', + tearDown=doctest_teardown, encoding='utf-8', + checker=doctest_checker, + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + suite.addTests(doctest.DocFileSuite( + 'scenario_sale_gift_card_goods.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..197496c0cb --- /dev/null +++ b/tox.ini @@ -0,0 +1,15 @@ +[tox] +envlist = {py36,py37,py38,py39}-{sqlite,postgresql},pypy3-{sqlite,postgresql} + +[testenv] +commands = {envpython} setup.py test +deps = + {py36,py37,py38,py39}-postgresql: psycopg2 >= 2.5 + pypy3-postgresql: psycopg2cffi >= 2.5 + 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/?local_version={env:CI_JOB_ID:{env:CI_BUILD_NUMBER}.{env:CI_JOB_NUMBER}} {opts} {packages} diff --git a/tryton.cfg b/tryton.cfg new file mode 100644 index 0000000000..a41dd92910 --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,16 @@ +[tryton] +version=5.9.0 +depends: + account + account_invoice + company + ir + product + sale + stock +xml: + account.xml + product.xml + sale.xml + stock.xml + message.xml diff --git a/view/account_configuration_form.xml b/view/account_configuration_form.xml new file mode 100644 index 0000000000..d1f3a0c9d9 --- /dev/null +++ b/view/account_configuration_form.xml @@ -0,0 +1,12 @@ + + + + + + + diff --git a/view/account_type_form.xml b/view/account_type_form.xml new file mode 100644 index 0000000000..36ba22e0c1 --- /dev/null +++ b/view/account_type_form.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/view/configuration_form.xml b/view/configuration_form.xml new file mode 100644 index 0000000000..004efeaa6a --- /dev/null +++ b/view/configuration_form.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/view/gift_card_form.xml b/view/gift_card_form.xml new file mode 100644 index 0000000000..6c78b78118 --- /dev/null +++ b/view/gift_card_form.xml @@ -0,0 +1,23 @@ + + +
+