commit 07dc2bd9cbb52906dfca5415cf8f9b6ea3e8d740 Author: Cédric Krier Date: Mon Oct 12 18:11:20 2020 +0200 Add web_shop_vue_storefront module issue9010 review252971002 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..e8f61953ec --- /dev/null +++ b/__init__.py @@ -0,0 +1,50 @@ +# 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 routes + +__all__ = ['register', 'routes'] + +from . import carrier +from . import ir +from . import party +from . import product +from . import sale +from . import web + + +def register(): + Pool.register( + web.Shop, + web.ShopVSFIdentifier, + web.User, + ir.Cron, + party.Address, + party.Identifier, + product.Product, + product.Template, + product.Category, + sale.Sale, + sale.Line, + module='web_shop_vue_storefront', type_='model') + Pool.register( + product.ProductAttribute, + product.TemplateAttribute, + product.Attribute, + sale.LineAttribute, + module='web_shop_vue_storefront', type_='model', + depends=['product_attribute']) + Pool.register( + web.ShopCoupon, + module='web_shop_vue_storefront', type_='model', + depends=['sale_promotion_coupon']) + Pool.register( + carrier.Carrier, + module='web_shop_vue_storefront', type_='model', + depends=['carrier']) + Pool.register( + web.ShopShipmentCost, + sale.SaleShipmentCost, + module='web_shop_vue_storefront', type_='model', + depends=['sale_shipment_cost']) diff --git a/carrier.py b/carrier.py new file mode 100644 index 0000000000..cfc7126ab0 --- /dev/null +++ b/carrier.py @@ -0,0 +1,23 @@ +# 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 Carrier(metaclass=PoolMeta): + __name__ = 'carrier' + + @property + def vsf_carrier_title(self): + return self.party.name + + @property + def vsf_method_title(self): + return self.carrier_product.name + + def get_vsf(self): + return { + 'carrier_code': str(self.id), + 'method_code': str(self.id), + 'carrier_title': self.vsf_carrier_title, + 'method_title': self.vsf_method_title, + } diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..feac56eaf9 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,17 @@ +Web Vue Storefront Module +######################### + +The web_shop_vue_storefront module provides the back-end to integrate with `Vue +Storefront 1.x`_. + +.. _`Vue Storefront`: https://www.vuestorefront.io/ + + +Vue StoreFront Configuration +---------------------------- + +The endpoint must be updated to use the Tryton URL. You must just replace +`/api` by +`http(s)://://web_shop_vue_storefront/`. + +The configuration `autoRefreshTokens` must be set to `false`. diff --git a/exceptions.py b/exceptions.py new file mode 100644 index 0000000000..203dd8c229 --- /dev/null +++ b/exceptions.py @@ -0,0 +1,16 @@ +# 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 werkzeug import exceptions + + +class LoginException(exceptions.Unauthorized): + pass + + +class NotFound(exceptions.NotFound): + pass + + +class BadRequest(exceptions.BadRequest): + pass diff --git a/ir.py b/ir.py new file mode 100644 index 0000000000..f655ed7617 --- /dev/null +++ b/ir.py @@ -0,0 +1,14 @@ +# 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([ + ('web.shop|vsf_update', "Update Vue Storefront"), + ]) diff --git a/message.xml b/message.xml new file mode 100644 index 0000000000..5ec7a40b7d --- /dev/null +++ b/message.xml @@ -0,0 +1,34 @@ + + + + + + The Vue Storefront identifier must be unique for each record. + + + Vue Storefront Identifier + + + You did not sign in correctly or your account is temporarily disabled. + + + The number "%(code)s" is not a valid tax identifier. + + + The country code "%(code)s" is not known. + + + Subtotal + + + Tax + + + Grand Total + + + Shipping + + + diff --git a/party.py b/party.py new file mode 100644 index 0000000000..ec9bd57075 --- /dev/null +++ b/party.py @@ -0,0 +1,133 @@ +# 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 stdnum import get_cc_module +try: + import phonenumbers + from phonenumbers import PhoneNumberFormat, NumberParseException +except ImportError: + phonenumbers = None + +from trytond.i18n import gettext +from trytond.model import fields +from trytond.pool import PoolMeta, Pool +from trytond.pyson import Eval + +from .exceptions import BadRequest +from .web import split_name, join_name + + +class Address(metaclass=PoolMeta): + __name__ = 'party.address' + + vsf_telephone = fields.Many2One( + 'party.contact_mechanism', "Telephone", + domain=[ + ('party', '=', Eval('party', -1)), + ('type', 'in', ['phone', 'mobile']), + ], + depends=['party']) + + def get_vsf(self, for_party=None): + if for_party and for_party != self.party: + firstname, lastname = split_name( + self.party_name or for_party.name) + else: + firstname, lastname = split_name( + self.party_name or self.party.name) + address = { + 'id': self.id, + 'firstname': firstname, + 'lastname': lastname, + 'street': self.street.splitlines(), + 'city': self.city, + 'country_id': self.country.code if self.country else None, + 'postcode': self.zip, + } + if self.subdivision: + address['region'] = { + 'region': self.subdivision.name, + } + if self.vsf_telephone: + address['telephone'] = self.vsf_telephone.value + if for_party: + address['company'] = self.party.name + address['vat_id'] = ( + self.party.tax_identifier.code + if self.party.tax_identifier else None) + return address + + def set_vsf(self, data, for_party=None): + pool = Pool() + Country = pool.get('country.country') + Subdivision = pool.get('country.subdivision') + ContactMechanism = pool.get('party.contact_mechanism') + + name = join_name(data['firstname'], data['lastname']) + party = for_party or self.party + if name != party.name: + self.party_name = name + self.street = '\n'.join(map(str, data['street'])) + self.city = data['city'] + if data['country_id']: + try: + self.country, = Country.search([ + ('code', '=', data['country_id']), + ], limit=1) + except ValueError: + raise BadRequest(gettext( + 'web_shop_vue_storefront.msg_unknown_country_code', + code=data['country_id'])) + self.zip = data['postcode'] + + if data.get('region') and data['region']['region']: + domain = [ + ('name', '=', data['region']['region']), + ] + if self.country: + domain.append(('country', '=', self.country.id)) + subdivisions = Subdivision.search(domain, limit=1) + if subdivisions: + self.subdivision, = subdivisions + + if data.get('telephone'): + value = data['telephone'] + if phonenumbers: + try: + phonenumber = phonenumbers.parse( + data['telephone'], data['country_id']) + value = phonenumbers.format_number( + phonenumber, PhoneNumberFormat.INTERNATIONAL) + except NumberParseException: + pass + contacts = ContactMechanism.search([ + ('party', '=', self.party.id), + ('type', 'in', ['phone', 'mobile']), + ('value', '=', value), + ], limit=1) + if contacts: + self.vsf_telephone, = contacts + else: + contact = ContactMechanism( + party=self.party, + type='phone', + value=value) + contact.save() + self.vsf_telephone = contact + + +class Identifier(metaclass=PoolMeta): + __name__ = 'party.identifier' + + def set_vsf_tax_identifier(self, code): + pool = Pool() + Party = pool.get('party.party') + for type in Party.tax_identifier_types(): + module = get_cc_module(*type.split('_', 1)) + if module and module.is_valid(code): + self.type = type + self.code = code + break + else: + raise BadRequest(gettext( + 'web_shop_vue_storefront.msg_invalid_tax_identifier', + code=code)) diff --git a/product.py b/product.py new file mode 100644 index 0000000000..e557c763d6 --- /dev/null +++ b/product.py @@ -0,0 +1,256 @@ +# 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 json +from operator import attrgetter + +from trytond.model import fields +from trytond.pool import PoolMeta, Pool +from trytond.tools import slugify + +from .web import ShopVSFIdentifierMixin + + +class _ProductEntityMixin: + + vsf_sku = fields.Function( + fields.Char("SKU"), 'get_vsf_sku', searcher='search_vsf_sku') + + def get_vsf_sku(self, name): + return self.code + + @classmethod + def search_vsf_sku(cls, name, clause): + return [('code',) + tuple(clause[1:])] + + @property + def vsf_image(self): + if self.vsf_sku: + return '/product/%(sku)s.jpg' % { + 'sku': slugify(self.vsf_sku.lower()), + } + + @property + def vsf_type_id(self): + return 'virtual' if self.type == 'service' else 'simple' + + @property + def vsf_quantity(self): + pool = Pool() + Uom = pool.get('product.uom') + quantity = self.forecast_quantity + if quantity < 0: + quantity = 0 + return Uom.compute_qty(self.default_uom, quantity, self.sale_uom) + + def get_vsf_entity(self, shop, price, tax): + categories = [ + c for c in self.categories_all + if c in shop.categories] + status = 1 + if not self.salable: + status = 2 + quantity = self.vsf_quantity + if quantity <= 0: + status = 3 + return { + 'id': self.vsf_identifier.id, + 'name': self.name, + 'image': self.vsf_image, + 'sku': self.vsf_sku, + 'url_key': slugify(self.name.lower()), + 'url_path': '%s/%s' % ( + self.vsf_identifier.id, slugify(self.name.lower())), + 'type_id': self.vsf_type_id, + 'price': float(price), + 'price_tax': float(tax), + 'price_incl_tax': float(price + tax), + 'status': status, + 'visibility': 4, + 'category_ids': [c.vsf_identifier.id for c in categories], + 'category': [c.get_vsf_entity_product(shop) for c in categories], + 'stock': [{ + 'is_in_stock': quantity > 0, + 'qty': quantity, + }], + } + + def get_vsf_stock(self): + quantity = self.vsf_quantity + return { + 'product_id': self.vsf_identifier.id, + 'qty': quantity, + 'is_in_stock': quantity > 0, + } + + +class Product(_ProductEntityMixin, ShopVSFIdentifierMixin, metaclass=PoolMeta): + __name__ = 'product.product' + + def vsf_is_configurable(self, shop): + return False + + +class Template( + _ProductEntityMixin, ShopVSFIdentifierMixin, metaclass=PoolMeta): + __name__ = 'product.template' + + @property + def vsf_type_id(self): + return 'configurable' + + def get_vsf_products(self, shop): + return [p for p in self.products if shop in p.web_shops] + + +class Category(ShopVSFIdentifierMixin, metaclass=PoolMeta): + __name__ = 'product.category' + + def get_vsf_entity(self, shop): + pool = Pool() + Product = pool.get('product.product') + count = Product.search([ + ('categories_all', '=', self.id), + ('web_shops', '=', shop.id), + ], count=True) + paths = self.get_vsf_paths(shop) + + def children(category): + return [{ + 'id': c.vsf_identifier.id, + 'children_data': children(c), + } for c in category.childs + if c in shop.categories] + return { + 'id': self.vsf_identifier.id, + 'name': self.name, + 'parent_id': (self.parent.vsf_identifier.id + if self.parent in shop.categories else None), + 'path': '/'.join([str(p.vsf_identifier.id) for p in paths]), + 'url_key': slugify(self.name.lower()), + 'url_path': '/'.join( + map(slugify, map(str.lower, map(attrgetter('name'), paths)))), + 'is_active': True, + 'position': self.id, + 'level': len(paths), + 'product_count': count, + 'children_data': children(self), + } + + def get_vsf_entity_product(self, shop): + return { + 'category_id': self.vsf_identifier.id, + 'name': self.name, + 'slug': slugify(self.name), + 'path': '/'.join( + map(slugify, map(attrgetter('name'), + self.get_vsf_paths(shop)))), + } + + def get_vsf_paths(self, shop): + category = self + paths = [category] + while category.parent: + if category.parent not in shop.categories: + break + category = category.parent + paths.append(category) + return list(reversed(paths)) + + +class ProductAttribute(metaclass=PoolMeta): + __name__ = 'product.product' + + def get_vsf_entity(self, shop, price, tax): + entity = super().get_vsf_entity(shop, price, tax) + if self.attribute_set: + for attribute in self.attribute_set.attributes: + if attribute not in shop.attributes: + continue + name = attribute.name + value = self.attributes.get(name) + options = { + o['name']: o['value'] + for o in attribute.get_vsf_options()} + entity[name] = options.get(value, value) + return entity + + def vsf_is_configurable(self, shop): + configurable = super().vsf_is_configurable(shop) + if self.template.attribute_set: + template_products = self.template.get_vsf_products(shop) + if len(template_products) > 1: + names = [ + a.name for a in self.template.attribute_set.attributes + if a in shop.attributes] + values = {filter( + lambda k: k in names, sorted(p.attributes.keys())) + for p in template_products} + configurable = len(values) == len(template_products) + return configurable + + +class TemplateAttribute(metaclass=PoolMeta): + __name__ = 'product.template' + + def get_vsf_entity(self, shop, price, tax): + entity = super().get_vsf_entity(shop, price, tax) + if self.attribute_set: + for attribute in self.attribute_set.attributes: + if attribute not in shop.attributes: + continue + name = attribute.name + p_attr_values = { + p.attributes[name] + for p in self.products + if name in p.attributes} + if attribute.type_ == 'multiselection': + p_attr_values = set(sum(p_attr_values, [])) + options = [ + o['value'] for o in attribute.get_vsf_options() + if o['name'] in p_attr_values] + entity[name + '_options'] = options + + config_options = entity.setdefault('configurable_options', []) + config_options.append( + attribute.get_vsf_entity_template(self, p_attr_values)) + return entity + + +class Attribute(ShopVSFIdentifierMixin, metaclass=PoolMeta): + __name__ = 'product.attribute' + + def get_vsf_options(self): + return [{ + 'value': i, + 'name': n, + 'label': s, + } for i, (n, s) in enumerate( + json.loads(self.selection_json), 1)] + + def get_vsf_entity(self, shop): + return { + 'id': self.vsf_identifier.id, + 'attribute_id': self.vsf_identifier.id, + 'attribute_code': self.name, + 'frontend_input': self.type_, + 'frontend_label': self.string, + 'is_comparable': True, + 'is_user_defined': True, + 'is_visible': True, + 'is_visible_on_front': True, + 'options': self.get_vsf_options(), + } + + def get_vsf_entity_template(self, template, attribute_values): + values = [{ + 'value_index': o['value'], + 'label': o['label'], + } for o in self.get_vsf_options() + if o['name'] in attribute_values] + return { + 'attribute_id': self.vsf_identifier.id, + 'attribute_code': self.name, + 'label': self.string, + 'product_id': template.vsf_identifier.id, + 'values': values, + } diff --git a/routes.py b/routes.py new file mode 100644 index 0000000000..970706fd3d --- /dev/null +++ b/routes.py @@ -0,0 +1,55 @@ +# 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 + +from werkzeug.exceptions import HTTPException + +from trytond import backend +from trytond.exceptions import UserError, UserWarning +from trytond.protocols.wrappers import with_pool, with_transaction +from trytond.transaction import Transaction +from trytond.wsgi import app + +logger = logging.getLogger(__name__) + + +@app.route( + '//web_shop_vue_storefront///', + methods={'POST', 'GET'}) +@app.route( + '//web_shop_vue_storefront////', + methods={'GET'}) +@with_pool +@with_transaction() +def route(request, pool, shop, target, action, sku=None): + Shop = pool.get('web.shop') + Session = pool.get('web.user.session') + shop = Shop.get(shop) + method = '_'.join( + [request.method, 'vsf', target, action.replace('-', '_')]) + if 'token' in request.args: + with Transaction().new_transaction(): + try: + Session.reset(request.args['token']) + except backend.DatabaseOperationalError: + logger.debug('Reset session failed', exc_info=True) + try: + if request.data: + data = request.parsed_data + else: + data = None + kwargs = request.args.to_dict() + if sku is not None: + kwargs['sku'] = sku + with Transaction().set_context(**shop.get_context()): + result = getattr(shop, method)(data, **kwargs) + except HTTPException as exception: + Transaction().rollback() + return {'code': exception.code, 'result': exception.description} + except (UserError, UserWarning) as exception: + Transaction().rollback() + return {'code': '400', 'result': str(exception)} + except Exception as exception: + Transaction().rollback() + return {'code': 500, 'result': str(exception)} + return {'code': 200, 'result': result} diff --git a/sale.py b/sale.py new file mode 100644 index 0000000000..fe1140e58d --- /dev/null +++ b/sale.py @@ -0,0 +1,245 @@ +# 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 decimal import Decimal + +from trytond.i18n import gettext +from trytond.pool import PoolMeta, Pool + +from trytond.modules.account.tax import TaxableMixin + +from .exceptions import BadRequest +from .web import split_name + + +class Sale(metaclass=PoolMeta): + __name__ = 'sale.sale' + + @property + def vsf_id(self): + if self.web_shop: + if self.web_shop.guest_party == self.party: + return self.web_id + else: + return self.id + + def get_vsf_user_order_history(self): + firstname, lastname = split_name(self.party.name) + return { + 'entity_id': self.id, + 'increment_id': self.number, + 'created_at': self.create_date.isoformat(), + 'customer_firstname': firstname, + 'customer_lastname': lastname, + 'grand_total': float(self.total_amount), + 'status': self.state_string, + 'items': [ + line.get_vsf_user_order_history() for line in self.lines], + } + + @classmethod + def search_vsf(cls, cart_id, shop, user=None): + domain = [ + ('web_shop', '=', shop.id), + ('state', '=', 'draft'), + ] + # cart_id may be either id and web_id + cart_id_domain = ['OR'] + domain.append(cart_id_domain) + try: + sale_id = int(cart_id) + except ValueError: + pass + else: + if user: + party = user.party + cart_id_domain.append([ + ('id', '=', sale_id), + ('party', '=', party.id), + ]) + cart_id_domain.append(('web_id', '=', cart_id)) + try: + sale, = cls.search(domain, limit=1) + except ValueError: + raise BadRequest() + return sale + + @property + def vsf_subtotal(self): + return self.untaxed_amount + + def set_vsf(self, data, user=None): + if user and self.web_shop and self.party == self.web_shop.guest_party: + self.party = user.party + self.on_change_party() + if user and 'addressInformation' in data: + addresses = data['addressInformation'] + address_data = addresses.get('shippingAddress') + if address_data: + address = user.set_vsf_address(address_data, self.party) + if address.party != self.party: + self.shipment_party = address.party + self.shipment_address = address + address_data = addresses.get('billingAddress') + if address_data: + if address_data != addresses.get('shippingAddress'): + address = user.set_vsf_address(address_data, self.party) + if address.party != self.party: + self.invoice_party = address.party + self.invoice_address = address + + def get_vsf(self): + return { + 'grand_total': float(self.total_amount), + 'items': [line.get_vsf() for line in self.lines if line.product], + 'total_segments': [{ + 'code': 'subtotal', + 'title': gettext('web_shop_vue_storefront.msg_subtotal'), + 'value': float(self.vsf_subtotal), + }, { + 'code': 'tax', + 'title': gettext('web_shop_vue_storefront.msg_tax'), + 'value': float(self.tax_amount), + }, { + 'code': 'grand_total', + 'title': gettext( + 'web_shop_vue_storefront.msg_grand_total'), + 'value': float(self.total_amount), + }], + } + + +class SaleShipmentCost(metaclass=PoolMeta): + __name__ = 'sale.sale' + + def get_vsf(self): + pool = Pool() + Tax = pool.get('account.tax') + item = super().get_vsf() + if self.carrier: + cost = self.compute_shipment_cost() + cost_line = self.get_shipment_cost_line(cost) + taxes = Tax.compute(cost_line.taxes, cost, 1) + cost += sum(t['amount'] for t in taxes) + cost = float(self.currency.round(cost)) + item['grand_total'] += cost + item['total_segments'].insert(1, { + 'code': 'shipping', + 'title': gettext('web_shop_vue_storefront.msg_shipping'), + 'value': cost, + }) + for segment in item['total_segments']: + if segment['code'] == 'grand_total': + segment['value'] += cost + return item + + def set_vsf_shipping_methods(self, data): + pool = Pool() + Country = pool.get('country.country') + Address = pool.get('party.address') + try: + country, = Country.search([ + ('code', '=', data['address']['country_id']), + ]) + except ValueError: + raise BadRequest() + if not self.shipment_address: + self.shipment_address = Address() + self.shipment_address.country = country + + def set_vsf(self, data, user): + pool = Pool() + Carrier = pool.get('carrier') + super().set_vsf(data, user) + if 'addressInformation' in data: + if data['addressInformation']['shipping_carrier_code']: + try: + carrier_id = int( + data['addressInformation']['shipping_carrier_code']) + except ValueError: + raise BadRequest() + try: + carrier, = Carrier.search([ + ('id', '=', carrier_id), + ], limit=1) + except ValueError: + raise BadRequest() + else: + carrier = None + self.carrier = carrier + + +class Line(TaxableMixin, metaclass=PoolMeta): + __name__ = 'sale.line' + + @property + def vsf_tax_amount(self): + return sum( + (v['amount'] for v in self._get_taxes().values()), Decimal(0)) + + def get_vsf_user_order_history(self): + amount_incl_tax = self.amount + self.vsf_tax_amount + digits = self.__class__.unit_price.digits + price_incl_tax = ( + amount_incl_tax / Decimal(str(self.quantity)) + ).quantize(Decimal(1) / 10 ** digits[1]) + return { + 'name': self.product.name if self.product else '', + 'sku': self.product.vsf_sku if self.product else '', + 'price_incl_tax': float(price_incl_tax), + 'qty_ordered': self.quantity, + 'row_total_incl_tax': float(amount_incl_tax), + } + + def get_vsf(self): + assert self.product + amount_incl_tax = self.amount + self.vsf_tax_amount + digits = self.__class__.unit_price.digits + price_incl_tax = ( + amount_incl_tax / Decimal(str(self.quantity)) + ).quantize(Decimal(1) / 10 ** digits[1]) + return { + 'item_id': self.id, + 'sku': self.product.vsf_sku, + 'qty': self.quantity, + 'name': self.product.name, + 'price': float(price_incl_tax), + 'product_type': self.product.vsf_type_id, + 'quote_id': self.sale.id, + 'product_option': { + 'extension_attributes': { + }, + }, + } + + def set_vsf(self, data): + pool = Pool() + Product = pool.get('product.product') + try: + self.product, = Product.search([ + ('vsf_sku', '=', data['sku']), + ], limit=1) + except ValueError: + raise BadRequest() + self.quantity = data['qty'] + self.on_change_product() + + +class LineAttribute(metaclass=PoolMeta): + __name__ = 'sale.line' + + def get_vsf_cart(self): + assert self.sale.web_shop + item = super().get_vsf_cart() + if self.product.attributes_set: + product_option = item['product_option'] + extension_attributes = product_option['extension_attributes'] + extension_attributes['configurable_item_options'] = options = [] + for attribute in self.product.attributes_set.attributes: + if attribute not in self.sale.web_shop.attributes: + continue + options.append({ + 'option_id': attribute.vsf_identifier.id, + 'option_value': self.attributes.get(attribute.name), + }) + return item diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..cac919c7b7 --- /dev/null +++ b/setup.py @@ -0,0 +1,146 @@ +#!/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_web_shop_vue_storefront' + +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 = ['elasticsearch', 'python-stdnum >= 1.1.0', 'werkzeug'] +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'), + get_require_version('trytond_product_attribute')] +dependency_links = [] +if minor_version % 2: + dependency_links.append('https://trydevpi.tryton.org/') + +setup(name=name, + version=version, + description='Tryton module to integrate with Vue Storefront', + 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/web_shop_vue_storefront', + }, + keywords='web vue storefront PWA ecommerce', + package_dir={'trytond.modules.web_shop_vue_storefront': '.'}, + packages=( + ['trytond.modules.web_shop_vue_storefront'] + + ['trytond.modules.web_shop_vue_storefront.%s' % p + for p in find_packages()] + ), + package_data={ + 'trytond.modules.web_shop_vue_storefront': (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.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] + web_shop_vue_storefront = trytond.modules.web_shop_vue_storefront + """, + 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..ddb598e785 --- /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.web_shop_vue_storefront.tests.test_web_shop_vue_storefront import suite # noqa: E501 +except ImportError: + from .test_web_shop_vue_storefront import suite + +__all__ = ['suite'] diff --git a/tests/scenario_web_shop_vue_storefront.rst b/tests/scenario_web_shop_vue_storefront.rst new file mode 100644 index 0000000000..1dfa02fc07 --- /dev/null +++ b/tests/scenario_web_shop_vue_storefront.rst @@ -0,0 +1,272 @@ +================================ +Web Shop Vue Storefront Scenario +================================ + +Imports:: + + >>> from decimal import Decimal + >>> from unittest.mock import MagicMock, ANY + + >>> 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_chart, get_accounts) + + >>> from trytond.modules.web_shop_vue_storefront.tests.tools import ( + ... AnyDictWith) + +Patch elasticsearch:: + + >>> from trytond.modules.web_shop_vue_storefront import web + >>> es = MagicMock() + >>> web.VSFElasticsearch = MagicMock(return_value=es) + +Install web_shop_vue_storefront:: + + >>> config = activate_modules( + ... ['web_shop_vue_storefront', 'product_attribute']) + +Create company:: + + >>> Company = Model.get('company.company') + >>> _ = create_company() + >>> company = get_company() + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + +Define a web shop:: + + >>> WebShop = Model.get('web.shop') + >>> web_shop = WebShop(name="Web Shop") + >>> web_shop.type = 'vsf' + >>> web_shop.save() + +Create categories:: + + >>> Category = Model.get('product.category') + >>> category1 = Category(name="Category 1") + >>> category1.save() + >>> sub_category = Category(name="Sub Category", parent=category1) + >>> sub_category.save() + >>> category2 = Category(name="Category 2") + >>> category2.save() + + >>> account_category = Category(name="Account Category") + >>> account_category.accounting = True + >>> account_category.account_expense = accounts['expense'] + >>> account_category.account_revenue = accounts['revenue'] + >>> account_category.save() + +Create attribute set:: + + >>> ProductAttributeSet = Model.get('product.attribute.set') + >>> ProductAttribute = Model.get('product.attribute') + >>> attribute_set = ProductAttributeSet(name="Attributes") + >>> attribute = attribute_set.attributes.new() + >>> attribute.name = 'attr1' + >>> attribute.string = "Attribute 1" + >>> attribute.type_ = 'selection' + >>> attribute.selection = "opt1:Option1\nopt2:Option2" + >>> attribute = attribute_set.attributes.new() + >>> attribute.name = 'attr2' + >>> attribute.string = "Attribute 1" + >>> attribute.type_ = 'boolean' + >>> attribute_set.save() + >>> attribute1, attribute2 = attribute_set.attributes + +Create products:: + + >>> ProductUom = Model.get('product.uom') + >>> unit, = ProductUom.find([('name', '=', 'Unit')]) + >>> ProductTemplate = Model.get('product.template') + >>> Product = Model.get('product.product') + >>> template = ProductTemplate() + >>> template.name = "Product 1" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.list_price = Decimal(10) + >>> template.account_category = account_category + >>> template.categories.append(Category(category1.id)) + >>> template.categories.append(Category(sub_category.id)) + >>> template.save() + >>> product1, = template.products + >>> product1.suffix_code = 'PROD1' + >>> product1.save() + + >>> template = ProductTemplate() + >>> template.name = "Product 2" + >>> template.default_uom = unit + >>> template.type = 'goods' + >>> template.salable = True + >>> template.list_price = Decimal(20) + >>> template.account_category = account_category + >>> template.save() + >>> product2, = template.products + >>> product2.suffix_code = 'PROD2' + >>> product2.save() + + >>> configurable = ProductTemplate() + >>> configurable.name = "Configurable" + >>> configurable.code = "CONF" + >>> configurable.default_uom = unit + >>> configurable.type = 'goods' + >>> configurable.salable = True + >>> configurable.list_price = Decimal(50) + >>> configurable.attribute_set = attribute_set + >>> configurable.account_category = account_category + >>> configurable1, = configurable.products + >>> configurable1.suffix_code = "1" + >>> configurable1.attributes = { + ... 'attr1': 'opt1', + ... 'attr2': True, + ... } + >>> configurable2 = configurable.products.new() + >>> configurable2.suffix_code = "2" + >>> configurable2.attributes = { + ... 'attr1': 'opt2', + ... 'attr2': True, + ... } + >>> configurable.save() + >>> configurable1, configurable2 = configurable.products + +Set categories, products and attributes to web shop:: + + >>> web_shop.categories.extend([ + ... Category(category1.id), + ... Category(sub_category.id), + ... Category(category2.id)]) + >>> web_shop.products.extend([ + ... Product(product1.id), + ... Product(product2.id), + ... Product(configurable1.id), + ... Product(configurable2.id)]) + >>> web_shop.attributes.extend([ + ... ProductAttribute(attribute1.id), + ... ProductAttribute(attribute2.id)]) + >>> web_shop.save() + +Run VSF update:: + + >>> es.reset_mock() + >>> Cron = Model.get('ir.cron') + >>> cron_sync, = Cron.find([ + ... ('method', '=', 'web.shop|vsf_update'), + ... ]) + >>> cron_sync.click('run_once') + >>> es.index.call_count + 8 + >>> es.index.assert_any_call( + ... id=category1.vsf_identifier.id, index='vue_storefront_catalog', + ... doc_type='category', body=AnyDictWith({ + ... 'name': "Category 1", + ... 'parent_id': None, + ... 'url_key': 'category-1', + ... 'url_path': 'category-1', + ... 'level': 1, + ... 'product_count': 1, + ... 'children_data': [AnyDictWith({})], + ... })) + >>> es.index.assert_any_call( + ... id=sub_category.vsf_identifier.id, index='vue_storefront_catalog', + ... doc_type='category', body=AnyDictWith({ + ... 'name': "Sub Category", + ... 'parent_id': category1.vsf_identifier.id, + ... 'url_key': 'sub-category', + ... 'url_path': 'category-1/sub-category', + ... 'level': 2, + ... 'product_count': 1, + ... 'children_data': [], + ... })) + >>> es.index.assert_any_call( + ... id=product1.vsf_identifier.id, index='vue_storefront_catalog', + ... doc_type='product', body=AnyDictWith({ + ... 'name': "Product 1", + ... 'image': '/product/prod1.jpg', + ... 'sku': 'PROD1', + ... 'url_key': 'product-1', + ... 'type_id': 'simple', + ... 'price': 10, + ... 'price_tax': 0, + ... 'price_incl_tax': 10, + ... 'status': 3, + ... 'category_ids': [ANY, ANY], + ... 'category': [AnyDictWith({}), AnyDictWith({})], + ... 'stock': [{ + ... 'is_in_stock': False, + ... 'qty': 0, + ... }], + ... })) + >>> es.index.assert_any_call( + ... id=configurable.vsf_identifier.id, index='vue_storefront_catalog', + ... doc_type='product', body=AnyDictWith({ + ... 'name': "Configurable", + ... 'image': '/product/conf.jpg', + ... 'sku': 'CONF', + ... 'url_key': 'configurable', + ... 'type_id': 'configurable', + ... 'price': 50, + ... 'price_tax': 0, + ... 'price_incl_tax': 50, + ... 'status': 3, + ... 'category_ids': [], + ... 'category': [], + ... 'stock': [{ + ... 'is_in_stock': False, + ... 'qty': 0, + ... }], + ... 'attr1_options': [1, 2], + ... 'attr2_options': [], + ... 'configurable_options': [ + ... AnyDictWith({ + ... 'attribute_code': 'attr1', + ... 'label': "Attribute 1", + ... 'product_id': configurable.vsf_identifier.id, + ... 'values': [ + ... {'value_index': 1, 'label': "Option1"}, + ... {'value_index': 2, 'label': "Option2"}, + ... ], + ... }), + ... AnyDictWith({}), + ... ], + ... 'configurable_children': [ + ... AnyDictWith({'sku': 'CONF1'}), + ... AnyDictWith({'sku': 'CONF2'}), + ... ], + ... })) + >>> es.index.assert_any_call( + ... id=attribute1.vsf_identifier.id, index='vue_storefront_catalog', + ... doc_type='attribute', body=AnyDictWith({ + ... 'attribute_code': 'attr1', + ... 'frontend_input': 'selection', + ... 'frontend_label': "Attribute 1", + ... 'options': [ + ... {'value': 1, 'name': 'opt1', 'label': "Option1"}, + ... {'value': 2, 'name': 'opt2', 'label': "Option2"}, + ... ], + ... })) + +Remove a category, a product and an attribute:: + + >>> _ = web_shop.categories.pop(web_shop.categories.index(category2)) + >>> _ = web_shop.products.pop(web_shop.products.index(product2)) + >>> _ = web_shop.attributes.pop(web_shop.attributes.index(attribute2)) + >>> web_shop.save() + +Run VSF update:: + + >>> es.reset_mock() + >>> Cron = Model.get('ir.cron') + >>> cron_sync, = Cron.find([ + ... ('method', '=', 'web.shop|vsf_update'), + ... ]) + >>> cron_sync.click('run_once') + >>> es.index.call_count + 5 + >>> es.delete.call_count + 3 diff --git a/tests/test_web_shop_vue_storefront.py b/tests/test_web_shop_vue_storefront.py new file mode 100644 index 0000000000..5abe2eec79 --- /dev/null +++ b/tests/test_web_shop_vue_storefront.py @@ -0,0 +1,914 @@ +# 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 contextlib import contextmanager +from decimal import Decimal + +from unittest.mock import patch, ANY + +from werkzeug.exceptions import Unauthorized + +from trytond.pool import Pool +from trytond.tests.test_tryton import doctest_teardown, doctest_checker +from trytond.tests.test_tryton import ModuleTestCase, with_transaction +from trytond.tests.test_tryton import suite as test_suite +from trytond.transaction import Transaction +from trytond.modules.company.tests import create_company, set_company +from ..exceptions import LoginException + +CUSTOMER = { + 'email': 'customer@example.com', + 'firstname': 'John', + 'lastname': 'Doe', + } +ADDRESS = { + 'region': { + 'region': None, + }, + 'country_id': "US", + 'street': [ + "Cliff Street", + "300" + ], + 'telephone': '+1 202-555-0148', + 'postcode': '18503', + 'city': "Scranton", + 'firstname': CUSTOMER['firstname'], + 'lastname': CUSTOMER['lastname'], + } +ADDRESS_COMPANY = ADDRESS.copy() +ADDRESS_COMPANY['company'] = 'Saber' +ADDRESS_COMPANY['vat_id'] = 'BE0500923836' + + +class WebVueStorefrontTestCase(ModuleTestCase): + 'Test Web Shop Vue Storefront module' + module = 'web_shop_vue_storefront' + extras = [ + 'product_attribute', + 'sale_promotion_coupon', + 'sale_shipment_cost', + 'carrier', + ] + maxDiff = None + + @contextmanager + def create_web_shop(self): + pool = Pool() + WebShop = pool.get('web.shop') + Location = pool.get('stock.location') + Party = pool.get('party.party') + + company = create_company() + warehouse, = Location.search([('type', '=', 'warehouse')], limit=1) + web_shop = WebShop(name="Web Shop") + web_shop.company = company + web_shop.currency = company.currency + web_shop.warehouses = [warehouse] + web_shop.type = 'vsf' + web_shop.guest_party = Party(name="Guest") + web_shop.save() + with Transaction().set_context(**web_shop.get_context()): + yield web_shop + + def create_product(self, web_shop, quantity=0, code="CODE"): + pool = Pool() + Template = pool.get('product.template') + Product = pool.get('product.product') + Category = pool.get('product.category') + Uom = pool.get('product.uom') + Location = pool.get('stock.location') + Move = pool.get('stock.move') + + unit, = Uom.search([('name', '=', "Unit")], limit=1) + template = Template(name="Product") + template.type = 'goods' + template.list_price = Decimal(100) + template.default_uom = unit + template.salable = True + template.sale_uom = unit + template.products = [Product(suffix_code=code, web_shops=[web_shop])] + template.account_category = Category(name="Category", accounting=True) + template.save() + product, = template.products + + if quantity: + supplier, = Location.search([('code', '=', 'SUP')]) + storage, = Location.search([('code', '=', 'STO')]) + with set_company(web_shop.company): + move = Move(product=product) + move.uom = unit + move.quantity = quantity + move.from_location = supplier + move.to_location = storage + move.unit_price = Decimal(50) + move.save() + Move.do([move]) + Product.set_vsf_identifier([product]) + return product + + def create_coupon(self, code='CODE'): + pool = Pool() + Promotion = pool.get('sale.promotion') + Coupon = pool.get('sale.promotion.coupon') + + promotion = Promotion(name="10%") + promotion.formula = '0.9 * unit_price' + promotion.coupons = coupon, = [Coupon(name="Promo")] + coupon.numbers = [{'number': code}] + promotion.save() + + def create_carrier( + self, name='Carrier', product_name="Delivery", + price=Decimal('10')): + pool = Pool() + Carrier = pool.get('carrier') + Party = pool.get('party.party') + Template = pool.get('product.template') + Product = pool.get('product.product') + Category = pool.get('product.category') + Uom = pool.get('product.uom') + + unit, = Uom.search([('name', '=', "Unit")], limit=1) + template = Template(name=product_name) + template.type = 'service' + template.list_price = price + template.default_uom = template.sale_uom = unit + template.salable = True + template.products = [Product()] + template.account_category = Category(name="Service", accounting=True) + template.save() + + carrier = Carrier() + carrier.party = Party(name=name) + carrier.carrier_product, = template.products + carrier.save() + return carrier + + @with_transaction(user=0) + def test_user_create(self): + pool = Pool() + User = pool.get('web.user') + with self.create_web_shop() as web_shop: + result = web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "SecretPassword" + }) + users = User.search([]) + + self.assertEqual(result, { + "email": CUSTOMER['email'], + "firstname": CUSTOMER['firstname'], + "lastname": CUSTOMER['lastname'], + "addresses": [], + }) + self.assertEqual(len(users), 1) + + @with_transaction(user=0) + def test_user_login(self): + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + + result = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + + self.assertTrue(result) + + @with_transaction(user=0) + def test_user_login_wrong_password(self): + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + + with self.assertRaises(LoginException): + web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "Bad", + }) + + @with_transaction(user=0) + def test_user_reset_password(self): + pool = Pool() + User = pool.get('web.user') + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "SecretPassword", + }) + + with patch.object(User, 'reset_password') as reset_password: + result = web_shop.POST_vsf_user_reset_password({ + "email": CUSTOMER['email'], + }) + + self.assertFalse(result) + reset_password.assert_called_once() + + @with_transaction(user=0) + def test_user_change_password(self): + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "OldPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "OldPassword", + }) + + result = web_shop.POST_vsf_user_change_password({ + "currentPassword": "OldPassword", + "newPassword": "NewPassword", + }, token=token) + + self.assertFalse(result) + + @with_transaction(user=0) + def test_user_change_password_wrong_token(self): + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "OldPassword", + }) + + with self.assertRaises(Unauthorized): + web_shop.POST_vsf_user_change_password({ + "currentPassword": "BadPassword", + "newPassword": "NewPassword", + }, 'wrong token') + + @with_transaction(user=0) + def test_user_change_password_wrong_password(self): + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "OldPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "OldPassword", + }) + + with self.assertRaises(LoginException): + web_shop.POST_vsf_user_change_password({ + "currentPassword": "BadPassword", + "newPassword": "NewPassword", + }, token=token) + + @with_transaction(user=0) + def test_user_order_history(self): + pool = Pool() + Country = pool.get('country.country') + Country(name="US", code="US").save() + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + cart = web_shop.POST_vsf_cart_create(None, token=token) + web_shop.POST_vsf_order_create({ + 'products': [{ + 'sku': 'CODE', + 'qty': 2, + }], + 'addressInformation': { + 'shippingAddress': ADDRESS, + 'billingAddress': ADDRESS_COMPANY, + 'shipping_method_code': None, + 'shipping_carrier_code': None, + 'payment_method_code': 'cashondelivery', + 'payment_method_additional': {}, + }, + }, cart, token=token) + + items = web_shop.GET_vsf_user_order_history(None, token=token) + + self.assertEqual(items, { + 'items': [{ + 'entity_id': ANY, + 'increment_id': ANY, + 'created_at': ANY, + 'customer_firstname': CUSTOMER['firstname'], + 'customer_lastname': CUSTOMER['lastname'], + 'grand_total': 200, + 'status': "Confirmed", + 'items': [{ + 'name': "Product", + 'sku': 'CODE', + 'price_incl_tax': 100, + 'qty_ordered': 2, + 'row_total_incl_tax': 200, + }], + }], + }) + + @with_transaction(user=0) + def test_user_order_history_wrong_token(self): + with self.create_web_shop() as web_shop: + with self.assertRaises(Unauthorized): + web_shop.GET_vsf_user_order_history(None, 'wrong token') + + @with_transaction(user=0) + def test_user_me(self): + pool = Pool() + Country = pool.get('country.country') + Country(name="US", code="US").save() + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + + result = web_shop.GET_vsf_user_me(None, token=token) + + data = {'customer': CUSTOMER.copy()} + data['customer']['addresses'] = [] + self.assertEqual(result, data['customer']) + + data = {'customer': CUSTOMER.copy()} + data['customer']['addresses'] = [ADDRESS_COMPANY.copy()] + result = web_shop.POST_vsf_user_me(data, token=token) + + data['customer']['addresses'][0]['id'] = ANY + data['customer']['addresses'][0].pop('region') + self.assertEqual(result, data['customer']) + + @with_transaction(user=0) + def test_user_me_wrong_token(self): + with self.create_web_shop() as web_shop: + + with self.assertRaises(Unauthorized): + web_shop.GET_vsf_user_me(None, 'wrong token') + + with self.assertRaises(Unauthorized): + web_shop.POST_vsf_user_me({}, 'wrong token') + + @with_transaction(user=0) + def test_user_me_change_address(self): + pool = Pool() + Address = pool.get('party.address') + Country = pool.get('country.country') + Country(name="US", code="US").save() + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + data = {'customer': CUSTOMER.copy()} + data['customer']['addresses'] = [ADDRESS_COMPANY] + result = web_shop.POST_vsf_user_me(data, token=token) + + data = {'customer': CUSTOMER.copy()} + address = ADDRESS.copy() + address['lastname'] = "Scott" + data['customer']['addresses'] = [address] + result = web_shop.POST_vsf_user_me( + {"customer": result}, token=token) + + inactive_addresses = Address.search([('active', '=', False)]) + self.assertEqual(len(inactive_addresses), 1) + + @with_transaction(user=0) + def test_stock_check(self): + with self.create_web_shop() as web_shop: + product = self.create_product(web_shop, quantity=10) + + result = web_shop.GET_vsf_stock_check(None, product.vsf_sku) + + self.assertEqual(result, { + 'product_id': product.vsf_identifier.id, + 'qty': 10, + 'is_in_stock': True, + }) + + @with_transaction(user=0) + def test_stock_list(self): + with self.create_web_shop() as web_shop: + product1 = self.create_product(web_shop, quantity=10) + product2 = self.create_product(web_shop, quantity=0, code="CODE2") + + result = web_shop.GET_vsf_stock_list( + None, ','.join([p.vsf_sku for p in [product1, product2]])) + + self.assertEqual(result, [{ + 'product_id': product1.vsf_identifier.id, + 'qty': 10, + 'is_in_stock': True, + }, { + 'product_id': product2.vsf_identifier.id, + 'qty': 0, + 'is_in_stock': False, + }]) + + @with_transaction(user=0) + def test_cart_create_without_token(self): + with self.create_web_shop() as web_shop: + cart = web_shop.POST_vsf_cart_create(None) + + self.assertIsInstance(cart, str) + + @with_transaction(user=0) + def test_cart_create_with_token(self): + with self.create_web_shop() as web_shop: + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + + cart = web_shop.POST_vsf_cart_create(None, token=token) + + self.assertIsInstance(cart, int) + + @with_transaction(user=0) + def test_cart_pull_without_token(self): + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + + items = web_shop.GET_vsf_cart_pull(None, cart) + + self.assertEqual(items, [{ + 'item_id': ANY, + 'sku': 'CODE', + 'qty': 1, + 'name': 'Product', + 'price': 100, + 'product_type': 'simple', + 'quote_id': ANY, + 'product_option': { + 'extension_attributes': {}, + }, + }]) + + @with_transaction(user=0) + def test_cart_pull_with_token(self): + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + cart = web_shop.POST_vsf_cart_create(None, token=token) + web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart, token=token) + + items = web_shop.GET_vsf_cart_pull(None, cart, token=token) + + self.assertEqual(items, [{ + 'item_id': ANY, + 'sku': 'CODE', + 'qty': 1, + 'name': 'Product', + 'price': 100, + 'product_type': 'simple', + 'quote_id': ANY, + 'product_option': { + 'extension_attributes': {}, + }, + }]) + + @with_transaction(user=0) + def test_cart_update_without_token(self): + pool = Pool() + SaleLine = pool.get('sale.line') + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + + item = web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + + self.assertEqual(item, { + 'item_id': ANY, + 'sku': 'CODE', + 'qty': 1, + 'name': 'Product', + 'price': 100, + 'product_type': 'simple', + 'quote_id': ANY, + 'product_option': { + 'extension_attributes': {}, + }, + }) + sale_lines = SaleLine.search([]) + self.assertEqual(len(sale_lines), 1) + + @with_transaction(user=0) + def test_cart_update_with_token(self): + pool = Pool() + SaleLine = pool.get('sale.line') + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + cart = web_shop.POST_vsf_cart_create(None, token=token) + + item = web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart, token=token) + + self.assertEqual(item, { + 'item_id': ANY, + 'sku': 'CODE', + 'qty': 1, + 'name': 'Product', + 'price': 100, + 'product_type': 'simple', + 'quote_id': ANY, + 'product_option': { + 'extension_attributes': {}, + }, + }) + sale_lines = SaleLine.search([]) + self.assertEqual(len(sale_lines), 1) + + @with_transaction(user=0) + def test_cart_update2(self): + pool = Pool() + SaleLine = pool.get('sale.line') + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + item = web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + + item = web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 2, + 'item_id': item['item_id'], + }, + }, cart) + + self.assertEqual(item, { + 'item_id': ANY, + 'sku': 'CODE', + 'qty': 2, + 'name': 'Product', + 'price': 100, + 'product_type': 'simple', + 'quote_id': ANY, + 'product_option': { + 'extension_attributes': {}, + }, + }) + sale_lines = SaleLine.search([]) + self.assertEqual(len(sale_lines), 1) + + @with_transaction(user=0) + def test_cart_delete(self): + pool = Pool() + SaleLine = pool.get('sale.line') + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + item = web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + + result = web_shop.POST_vsf_cart_delete({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + 'item_id': item['item_id'], + }, + }, cart) + + self.assertTrue(result) + sale_lines = SaleLine.search([]) + self.assertEqual(len(sale_lines), 0) + + @with_transaction(user=0) + def test_cart_apply_coupon(self): + with self.create_web_shop() as web_shop: + self.create_coupon() + cart = web_shop.POST_vsf_cart_create(None) + + result = web_shop.POST_vsf_cart_apply_coupon(None, cart, 'CODE') + + self.assertTrue(result) + + @with_transaction(user=0) + def test_cart_delete_coupon(self): + with self.create_web_shop() as web_shop: + self.create_coupon() + cart = web_shop.POST_vsf_cart_create(None) + web_shop.POST_vsf_cart_apply_coupon(None, cart, 'CODE') + + result = web_shop.POST_vsf_cart_delete_coupon(None, cart) + + self.assertTrue(result) + + @with_transaction(user=0) + def test_cart_coupon(self): + with self.create_web_shop() as web_shop: + self.create_coupon() + cart = web_shop.POST_vsf_cart_create(None) + web_shop.POST_vsf_cart_apply_coupon(None, cart, 'CODE') + + result = web_shop.POST_vsf_cart_coupon(None, cart) + + self.assertEqual(result, 'CODE') + + @with_transaction(user=0) + def test_cart_coupon_empty(self): + with self.create_web_shop() as web_shop: + cart = web_shop.POST_vsf_cart_create(None) + + result = web_shop.POST_vsf_cart_coupon(None, cart) + + self.assertEqual(result, '') + + @with_transaction(user=0) + def test_cart_totals(self): + with self.create_web_shop() as web_shop: + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + + totals = web_shop.GET_vsf_cart_totals(None, cart) + + self.assertEqual(totals, { + 'grand_total': 100, + 'items': [{ + 'item_id': ANY, + 'sku': 'CODE', + 'qty': 1, + 'name': 'Product', + 'price': 100, + 'product_type': 'simple', + 'quote_id': ANY, + 'product_option': { + 'extension_attributes': { + }, + }, + }], + 'total_segments': [{ + 'code': 'subtotal', + 'title': ANY, + 'value': 100, + }, { + 'code': 'tax', + 'title': ANY, + 'value': 0, + }, { + 'code': 'grand_total', + 'title': ANY, + 'value': 100, + }], + }) + + @with_transaction(user=0) + def test_cart_payment_methods(self): + with self.create_web_shop() as web_shop: + cart = web_shop.POST_vsf_cart_create(None) + + result = web_shop.GET_vsf_cart_payment_methods(None, cart) + + self.assertEqual(result, []) + + @with_transaction(user=0) + def test_cart_shipping_methods(self): + pool = Pool() + Country = pool.get('country.country') + Country(name="US", code="US").save() + with self.create_web_shop() as web_shop: + carrier = self.create_carrier() + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + + methods = web_shop.POST_vsf_cart_shipping_methods( + {'address': {'country_id': 'US'}}, cart) + + self.assertEqual(methods, [{ + 'carrier_code': str(carrier.id), + 'method_code': str(carrier.id), + 'carrier_title': "Carrier", + 'method_title': "Delivery", + 'price_incl_tax': Decimal(10), + }]) + + @with_transaction(user=0) + def test_cart_shipping_information(self): + pool = Pool() + Country = pool.get('country.country') + Country(name="US", code="US").save() + with self.create_web_shop() as web_shop: + carrier = self.create_carrier() + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + + information = web_shop.POST_vsf_cart_shipping_information({ + 'addressInformation': { + 'shipping_address': { + 'country_id': 'US', + }, + 'shipping_method_code': str(carrier.id), + 'shipping_carrier_code': str(carrier.id), + }, + }, cart) + + self.assertEqual(information, { + 'grand_total': 110, + 'items': ANY, + 'total_segments': [{ + 'code': 'subtotal', + 'title': ANY, + 'value': 100, + }, { + 'code': 'shipping', + 'title': ANY, + 'value': 10, + }, { + 'code': 'tax', + 'title': ANY, + 'value': 0, + }, { + 'code': 'grand_total', + 'title': ANY, + 'value': 110, + }], + }) + + @with_transaction(user=0) + def test_order_create(self): + pool = Pool() + Sale = pool.get('sale.sale') + Country = pool.get('country.country') + Country(name="US", code="US").save() + with self.create_web_shop() as web_shop: + carrier = self.create_carrier() + self.create_product(web_shop) + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + cart = web_shop.POST_vsf_cart_create(None, token=token) + web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart, token=token) + + result = web_shop.POST_vsf_order_create({ + 'products': [{ + 'sku': 'CODE', + 'qty': 1, + }], + 'addressInformation': { + 'shippingAddress': ADDRESS, + 'billingAddress': ADDRESS_COMPANY, + 'shipping_method_code': str(carrier.id), + 'shipping_carrier_code': str(carrier.id), + 'payment_method_code': 'cashondelivery', + 'payment_method_additional': {}, + }, + }, cart, token=token) + + self.assertEqual(result, 'OK') + + sale, = Sale.search([]) + self.assertEqual(sale.state, 'confirmed') + self.assertEqual(len(sale.lines), 2) + self.assertEqual(sale.total_amount, Decimal(110)) + + @with_transaction(user=0) + def test_order_create_from_guest(self): + pool = Pool() + Sale = pool.get('sale.sale') + Country = pool.get('country.country') + Country(name="US", code="US").save() + with self.create_web_shop() as web_shop: + carrier = self.create_carrier() + self.create_product(web_shop) + cart = web_shop.POST_vsf_cart_create(None) + web_shop.POST_vsf_cart_update({ + 'cartItem': { + 'sku': 'CODE', + 'qty': 1, + }, + }, cart) + web_shop.POST_vsf_user_create({ + "customer": CUSTOMER, + "password": "TopSecretPassword", + }) + token = web_shop.POST_vsf_user_login({ + "username": CUSTOMER['email'], + "password": "TopSecretPassword", + }) + result = web_shop.POST_vsf_order_create({ + 'products': [{ + 'sku': 'CODE', + 'qty': 1, + }], + 'addressInformation': { + 'shippingAddress': ADDRESS, + 'billingAddress': ADDRESS_COMPANY, + 'shipping_method_code': str(carrier.id), + 'shipping_carrier_code': str(carrier.id), + 'payment_method_code': 'cashondelivery', + 'payment_method_additional': {}, + }, + }, cart, token=token) + + self.assertEqual(result, 'OK') + + sale, = Sale.search([]) + self.assertNotEqual(sale.party, web_shop.guest_party) + self.assertEqual(sale.state, 'confirmed') + self.assertEqual(len(sale.lines), 2) + self.assertEqual(sale.total_amount, Decimal(110)) + + +def suite(): + suite = test_suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + WebVueStorefrontTestCase)) + suite.addTests(doctest.DocFileSuite( + 'scenario_web_shop_vue_storefront.rst', + tearDown=doctest_teardown, encoding='utf-8', + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE, + checker=doctest_checker)) + return suite diff --git a/tests/tools.py b/tests/tools.py new file mode 100644 index 0000000000..adadbefb5c --- /dev/null +++ b/tests/tools.py @@ -0,0 +1,10 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + + +class AnyDictWith(dict): + def __eq__(self, other): + if not isinstance(other, dict): + return False + items = list(sorted(filter(lambda i: i[0] in self, other.items()))) + return list(sorted(self.items())) == items 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..29bb60635c --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,17 @@ +[tryton] +version=5.7.0 +depends: + ir + party + product + sale + web_shop + web_user +extras_depend: + carrier + product_attribute + sale_promotion_coupon + sale_shipment_cost +xml: + web.xml + message.xml diff --git a/view/shop_form.xml b/view/shop_form.xml new file mode 100644 index 0000000000..614eba41c3 --- /dev/null +++ b/view/shop_form.xml @@ -0,0 +1,13 @@ + + + + + + + + diff --git a/web.py b/web.py new file mode 100644 index 0000000000..470256506b --- /dev/null +++ b/web.py @@ -0,0 +1,655 @@ +# 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 functools import wraps + +from elasticsearch import Elasticsearch, VERSION as ES_VERSION + +from trytond.exceptions import RateLimitException +from trytond.i18n import lazy_gettext, gettext +from trytond.model import ModelSQL, Unique, fields +from trytond.pool import PoolMeta, Pool +from trytond.pyson import Eval + +from .exceptions import LoginException, NotFound, BadRequest + + +def migrate_doc_type(func): + @wraps(func) + def wrapper(*args, **kwargs): + if ES_VERSION >= (7,): + kwargs = kwargs.copy() + doc_type = kwargs.pop('doc_type') + kwargs['index'] += '_' + doc_type + return func(*args, **kwargs) + return wrapper + + +class VSFElasticsearch(Elasticsearch): + + @migrate_doc_type + def index(self, **kwargs): + print(kwargs) + return super().index(**kwargs) + + @migrate_doc_type + def delete(self, **kwargs): + return super().delete(**kwargs) + + +def join_name(firstname, lastname): + # Use unbreakable spaces in firstname + # to prevent to split on them + firstname = firstname.replace(' ', ' ') + return ' '.join([firstname, lastname]) + + +def split_name(name): + return (name.split(' ', 1) + [''])[:2] + + +def issubdict(dct, other): + for key, value in dct.items(): + if value != other.get(key): + return False + return True + + +def with_user(required=False): + def decorator(func): + @wraps(func) + def wrapper(*args, **kwargs): + pool = Pool() + User = pool.get('web.user') + token = kwargs.pop('token', None) + if token: + user = User.get_user(token) + else: + user = kwargs.get('user') + if required and not user: + raise LoginException() + kwargs['user'] = user + return func(*args, **kwargs) + return wrapper + return decorator + + +class Shop(metaclass=PoolMeta): + __name__ = 'web.shop' + + vsf_elasticsearch_url = fields.Char( + "Elasticsearch URL", + states={ + 'required': Eval('type') == 'vsf', + 'invisible': Eval('type') != 'vsf', + }, + depends=['type']) + vsf_elasticsearch_index = fields.Char( + "Elasticsearch Index", + states={ + 'required': Eval('type') == 'vsf', + 'invisible': Eval('type') != 'vsf', + }, + depends=['type']) + + @classmethod + def __setup__(cls): + super().__setup__() + cls.type.selection.append(('vsf', "Vue Storefront")) + + @classmethod + def default_vsf_elasticsearch_url(cls): + return 'http://localhost:9200/' + + @classmethod + def default_vsf_elasticsearch_index(cls): + return 'vue_storefront_catalog' + + @classmethod + def view_attributes(cls): + return super().view_attributes() + [ + ('//page[@id="vsf"]', 'states', { + 'invisible': Eval('type') != 'vsf', + }), + ] + + @property + def to_sync(self): + result = super().to_sync + if self.type == 'vsf': + result = True + return result + + def get_vsf_elasticsearch(self): + return VSFElasticsearch(self.vsf_elasticsearch_url) + + @classmethod + def vsf_update(cls, shops=None): + pool = Pool() + Product = pool.get('product.product') + ProductTemplate = pool.get('product.template') + Category = pool.get('product.category') + try: + ProductAttribute = pool.get('product.attribute') + except KeyError: + ProductAttribute = None + if shops is None: + shops = cls.search([ + ('type', '=', 'vsf'), + ]) + cls.lock(shops) + for shop in shops: + es = shop.get_vsf_elasticsearch() + if ProductAttribute: + attributes = shop.get_attributes() + ProductAttribute.set_vsf_identifier(attributes) + categories = shop.get_categories() + Category.set_vsf_identifier(categories) + products, prices, taxes = shop.get_products() + Product.set_vsf_identifier(products) + + templates = set() + for product in products: + if product.vsf_is_configurable(shop): + templates.add(product.template) + continue + entity = product.get_vsf_entity( + shop, price=prices[product.id], tax=taxes[product.id]) + es.index( + index=shop.vsf_elasticsearch_index, + doc_type='product', + id=product.vsf_identifier.id, + body=entity) + templates = ProductTemplate.browse(templates) + ProductTemplate.set_vsf_identifier(templates) + for template in templates: + template_products = template.get_vsf_products(shop) + price, tax = min( + (prices[p.id], taxes[p.id]) for p in template_products) + entity = template.get_vsf_entity(shop, price=price, tax=tax) + entity['configurable_children'] = [ + product.get_vsf_entity( + shop, price=prices[product.id], tax=taxes[product.id]) + for product in template_products] + es.index( + index=shop.vsf_elasticsearch_index, + doc_type='product', + id=template.vsf_identifier.id, + body=entity) + + for category in categories: + entity = category.get_vsf_entity(shop) + es.index( + index=shop.vsf_elasticsearch_index, + doc_type='category', + id=category.vsf_identifier.id, + body=entity) + + if ProductAttribute: + for attribute in attributes: + entity = attribute.get_vsf_entity(shop) + es.index( + index=shop.vsf_elasticsearch_index, + doc_type='attribute', + id=attribute.vsf_identifier.id, + body=entity) + + for product in shop.products_removed: + template = product.template + if template.vsf_identifier: + template_products = product.template.get_vsf_products(shop) + if not template_products: + es.delete( + index=shop.vsf_elasticsearch_index, + doc_type='product', + id=template.vsf_identifier.id) + if product.vsf_identifier: + es.delete( + index=shop.vsf_elasticsearch_index, + doc_type='product', + id=product.vsf_identifier.id) + shop.products_removed = [] + + for category in shop.categories_removed: + if category.vsf_identifier: + es.delete( + index=shop.vsf_elasticsearch_index, + doc_type='category', + id=category.vsf_identifier.id) + shop.categories_removed = [] + + if ProductAttribute: + for attribute in shop.attributes_removed: + if attribute.vsf_identifier: + es.delete( + index=shop.vsf_elasticsearch_index, + doc_type='attribute', + id=attribute.vsf_identifier.id) + shop.attributes_removed = [] + + cls.save(shops) + + def POST_vsf_user_create(self, data): + pool = Pool() + User = pool.get('web.user') + Party = pool.get('party.party') + firstname = data['customer']['firstname'] + lastname = data['customer']['lastname'] + email = data['customer']['email'] + user = User(email=email, password=data['password']) + party = Party(name=join_name(firstname, lastname)) + user.party = party + user.save() + firstname, lastname = split_name(user.party.name) + return { + 'email': user.email, + 'firstname': firstname, + 'lastname': lastname, + 'addresses': [], + } + + def POST_vsf_user_login(self, data): + pool = Pool() + User = pool.get('web.user') + try: + user = User.authenticate(data['username'], data['password']) + except RateLimitException: + raise LoginException(gettext( + 'web_shop_vue_storefront.msg_login_wrong')) + if user: + return user.new_session() + else: + raise LoginException(gettext( + 'web_shop_vue_storefront.msg_login_wrong')) + + def POST_vsf_user_reset_password(self, data): + pool = Pool() + User = pool.get('web.user') + users = User.search([ + ('email', '=', data['email']), + ]) + User.reset_password(users) + + @with_user(required=True) + def POST_vsf_user_change_password(self, data, user): + pool = Pool() + User = pool.get('web.user') + try: + user = User.authenticate(user.email, data['currentPassword']) + except RateLimitException: + raise LoginException(gettext( + 'web_shop_vue_storefront.msg_login_wrong')) + if user: + user.password = data['newPassword'] + user.save() + else: + raise LoginException(gettext( + 'web_shop_vue_storefront.msg_login_wrong')) + + @with_user(required=True) + def GET_vsf_user_order_history( + self, data, user, pageSize='20', currentPage='1'): + pool = Pool() + Sale = pool.get('sale.sale') + try: + pageSize = int(pageSize) + currentPage = int(currentPage) + except ValueError: + raise BadRequest() + sales = Sale.search([ + ('party', '=', user.party), + ('state', 'in', ['confirmed', 'processing', 'done']), + ], + offset=pageSize * (currentPage - 1), + limit=pageSize, + order=[ + ('sale_date', 'DESC'), + ('id', 'DESC'), + ]) + items = [] + for sale in sales: + items.append(sale.get_vsf_user_order_history()) + return {'items': items} + + @with_user(required=True) + def GET_vsf_user_me(self, data, user): + return user.get_vsf() + + @with_user(required=True) + def POST_vsf_user_me(self, data, user): + user.set_vsf(data['customer']) + user.save() + return user.get_vsf() + + def GET_vsf_stock_check(self, data, sku): + try: + return self.GET_vsf_stock_list(data, sku)[0] + except IndexError: + raise NotFound() + + def GET_vsf_stock_list(self, data, skus): + pool = Pool() + Product = pool.get('product.product') + Template = pool.get('product.template') + skus = skus.split(',') + products = Product.search([ + ('vsf_sku', 'in', skus), + ('web_shops', '=', self.id), + ]) + products += Template.search([ + ('vsf_sku', 'in', skus), + ('products.web_shops', '=', self.id), + ]) + return [p.get_vsf_stock() for p in products] + + @with_user() + def POST_vsf_cart_create(self, data, user=None): + party = user.party if user else None + sale = self.get_sale(party) + sale.save() + return sale.vsf_id + + @with_user() + def GET_vsf_cart_pull(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + return [line.get_vsf() for line in sale.lines if line.product] + + @with_user() + def POST_vsf_cart_update(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + SaleLine = pool.get('sale.line') + sale = Sale.search_vsf(cartId, self, user) + if data['cartItem'].get('item_id'): + line = SaleLine(data['cartItem']['item_id']) + if line.sale != sale: + raise BadRequest() + else: + line = SaleLine(sale=sale) + line.set_vsf(data['cartItem']) + line.save() + return line.get_vsf() + + @with_user() + def POST_vsf_cart_delete(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + SaleLine = pool.get('sale.line') + sale = Sale.search_vsf(cartId, self, user) + line = SaleLine(data['cartItem']['item_id']) + if line.sale != sale: + raise BadRequest() + SaleLine.delete([line]) + return True + + @with_user() + def GET_vsf_cart_totals(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + return sale.get_vsf() + + @with_user() + def GET_vsf_cart_payment_methods(self, data, cartId, user=None): + return [] + + @with_user() + def POST_vsf_cart_shipping_methods(self, data, cartId, user=None): + return [] + + @with_user() + def POST_vsf_cart_shipping_information(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + return sale.get_vsf() + + @with_user(required=True) + def POST_vsf_order_create(self, data, cartId, user): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + self.vsf_order_create(data, sale, user) + return 'OK' + + def vsf_order_create(self, data, sale, user): + pool = Pool() + Sale = pool.get('sale.sale') + SaleLine = pool.get('sale.line') + sale.set_vsf(data, user) + sku2lines = { + line.product.vsf_sku: line for line in sale.lines if line.product} + for product in data.get('products', []): + sku = product['sku'] + line = sku2lines.get(sku) + if not line: + line = SaleLine(sale=sale) + sku2lines[sku] = line + line.set_vsf(product) + sale.lines = sku2lines.values() + sale.save() + Sale.quote([sale]) + payment_method = data['addressInformation']['payment_method_code'] + if payment_method == 'cashondelivery': + Sale.confirm([sale]) + return sale + + +class ShopCoupon(metaclass=PoolMeta): + __name__ = 'web.shop' + + @with_user() + def POST_vsf_cart_apply_coupon(self, data, cartId, coupon, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + PromotionCouponNumber = pool.get('sale.promotion.coupon.number') + try: + coupon, = PromotionCouponNumber.search([ + ('number', 'ilike', coupon), + ], limit=1) + except ValueError: + return False + sale.coupons = [coupon] + sale.save() + return True + + @with_user() + def POST_vsf_cart_delete_coupon(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + sale.coupons = [] + sale.save() + return True + + @with_user() + def POST_vsf_cart_coupon(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + if sale.coupons: + return sale.coupons[0].number + else: + return '' + + +class ShopShipmentCost(metaclass=PoolMeta): + __name__ = 'web.shop' + + @with_user() + def POST_vsf_cart_shipping_methods(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + methods = super().POST_vsf_cart_shipping_methods( + data, cartId, user=user) + sale = Sale.search_vsf(cartId, self, user) + sale.set_vsf_shipping_methods(data) + for carrier in sale.available_carriers: + method = carrier.get_vsf() + sale.carrier = carrier + method['price_incl_tax'] = sale.compute_shipment_cost() + methods.append(method) + return methods + + @with_user() + def POST_vsf_cart_shipping_information(self, data, cartId, user=None): + pool = Pool() + Sale = pool.get('sale.sale') + sale = Sale.search_vsf(cartId, self, user) + sale.set_vsf(data, user) + sale.save() + return super().POST_vsf_cart_shipping_information( + data, cartId, user=user) + + +class ShopVSFIdentifier(ModelSQL): + "Web Shop Vue Storefront Identifier" + __name__ = 'web.shop.vsf_identifier' + + record = fields.Reference("Record", 'get_records', required=True) + + @classmethod + def __setup__(cls): + super().__setup__() + t = cls.__table__() + cls._sql_constraints = [ + ('record_unique', Unique(t, t.record), + 'web_shop_vue_storefront.msg_identifier_record_unique'), + ] + + @classmethod + def get_records(cls): + pool = Pool() + Model = pool.get('ir.model') + models = [klass.__name__ for _, klass in pool.iterobject() + if issubclass(klass, ShopVSFIdentifierMixin)] + models = Model.search([ + ('model', 'in', models), + ]) + return [(m.model, m.name) for m in models] + + +class ShopVSFIdentifierMixin: + + vsf_identifier = fields.Many2One( + 'web.shop.vsf_identifier', + lazy_gettext('web_shop_vue_storefront.msg_vsf_identifier'), + ondelete='RESTRICT', readonly=True) + + @classmethod + def set_vsf_identifier(cls, records): + pool = Pool() + Identifier = pool.get('web.shop.vsf_identifier') + for record in records: + if not record.vsf_identifier: + record.vsf_identifier = Identifier(record=record) + cls.save(records) + + +class User(metaclass=PoolMeta): + __name__ = 'web.user' + + def get_vsf(self): + if not self.party: + return { + 'email': self.email, + } + firstname, lastname = split_name(self.party.name) + data = { + 'email': self.email, + 'firstname': firstname, + 'lastname': lastname, + 'addresses': ( + [a.get_vsf() for a in self.party.addresses] + + [a.get_vsf(self.party) for p in self.secondary_parties + for a in p.addresses if p != self.party]), + } + + default_billing = self.invoice_address + if not default_billing: + default_billing = self.party.address_get('invoice') + if default_billing: + data['default_billing'] = default_billing.id + + default_shipping = self.shipment_address + if not default_shipping: + default_shipping = self.party.address_get('delivery') + if default_shipping: + data['default_shipping'] = default_shipping.id + + return data + + def set_vsf(self, data): + pool = Pool() + Party = pool.get('party.party') + Address = pool.get('party.address') + self.email = data['email'] + if not self.party: + self.party = Party() + self.party.name = join_name(data['firstname'], data['lastname']) + + default_billing = None + default_shipping = None + addresses = [] + for address_data in data['addresses']: + address = self.set_vsf_address(address_data, self.party) + addresses.append(address) + if ((address.id and address.id == data.get('default_billing')) + or address_data.get('default_billing')): + default_billing = address + if ((address.id and address.id == data.get('default_shipping')) + or address_data.get('default_shipping')): + default_shipping = address + + if address_data.get('id'): + if address_data['id'] != address.id: + address = Address(address_data['id']) + if (address.party != self.party + and address.party not in self.secondary_parties): + raise BadRequest() + address.active = False + addresses.append(address) + Address.save(addresses) + self.invoice_address = default_billing + self.shipment_address = default_shipping + + def set_vsf_address(self, address_data, party): + pool = Pool() + Party = pool.get('party.party') + Address = pool.get('party.address') + Identifier = pool.get('party.identifier') + + addresses = self.party.addresses + for party in self.secondary_parties: + addresses += party.addresses + + for address in addresses: + if issubdict(address.get_vsf(party), address_data): + return address + + address = Address() + party = address.party = self.party + if address_data.get('company'): + for company_party in self.secondary_parties: + tax_code = ( + company_party.tax_identifier.code + if company_party.tax_identifier else '') + if (company_party.name == address_data['company'] + and (not address_data.get('vat_id') + or tax_code == address_data['vat_id'])): + break + else: + identifier = Identifier() + identifier.set_vsf_tax_identifier( + address_data['vat_id']) + company_party = Party( + name=address_data['company'], + identifiers=[identifier]) + company_party.save() + self.secondary_parties += (company_party,) + self.save() + address.party = company_party + address.set_vsf(address_data, party) + return address diff --git a/web.xml b/web.xml new file mode 100644 index 0000000000..fd8f6375dd --- /dev/null +++ b/web.xml @@ -0,0 +1,18 @@ + + + + + + web.shop + + shop_form + + + + web.shop|vsf_update + + days + + +