commit 20ffbe0c3536551cd7ee6103fdacd348498d2c83 Author: Cédric Krier Date: Sun Apr 2 00:40:05 2017 +0200 Initial commit issue6043 review32811002 diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000000..c4fd423e94 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,9 @@ +image: python:all +env: + - POSTGRESQL_URI=postgresql://postgres@127.0.0.1:5432/ + - MYSQL_URI=mysql://root@127.0.0.1:3306/ +script: + - pip install tox + - tox -e "{py27,py33,py34,py35}-{sqlite,postgresql}" --skip-missing-interpreters +services: + - postgres diff --git a/COPYRIGHT b/COPYRIGHT new file mode 100644 index 0000000000..62c54144bc --- /dev/null +++ b/COPYRIGHT @@ -0,0 +1,15 @@ +Copyright (C) 2016 Cédric Krier +Copyright (C) 2016 B2CK SPRL. + +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/INSTALL b/INSTALL new file mode 100644 index 0000000000..96c80d7d16 --- /dev/null +++ b/INSTALL @@ -0,0 +1,36 @@ +Installing trytond_sale_subscription +==================================== + +Prerequisites +------------- + + * Python 2.7 or later (http://www.python.org/) + * trytond (http://www.tryton.org/) + * trytond_account (http://www.tryton.org/) + * trytond_account_invoice (http://www.tryton.org/) + * trytond_company (http://www.tryton.org/) + * trytond_currency (http://www.tryton.org/) + * trytond_product (http://www.tryton.org/) + * trytond_sale (http://www.tryton.org/) + * python-dateutil (http://labix.org/python-dateutil) + +Installation +------------ + +Once you've downloaded and unpacked the trytond_sale_subscription source +release, enter the directory where the archive was unpacked, and run: + + python setup.py install + +Note that you may need administrator/root privileges for this step, as +this command will by default attempt to install module to the Python +site-packages directory on your system. + +For advanced options, please refer to the easy_install and/or the distutils +documentation: + + http://setuptools.readthedocs.io/en/latest/easy_install.html + http://docs.python.org/inst/inst.html + +To use without installation, extract the archive into ``trytond/modules`` with +the directory name sale_subscription. 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..fb91042a77 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,13 @@ +include INSTALL +include README +include COPYRIGHT +include CHANGELOG +include LICENSE +include tryton.cfg +include *.xml +include view/*.xml +include *.odt +include locale/*.po +include doc/* +include icons/* +include tests/*.rst diff --git a/README b/README new file mode 100644 index 0000000000..e909388bee --- /dev/null +++ b/README @@ -0,0 +1,35 @@ +trytond_sale_subscription +========================= + +The sale_subscription module of the Tryton application platform. + +Installing +---------- + +See INSTALL + +Support +------- + +If you encounter any problems with Tryton, please don't hesitate to ask +questions on the Tryton bug tracker, mailing list, wiki or IRC channel: + + http://bugs.tryton.org/ + http://groups.tryton.org/ + http://wiki.tryton.org/ + irc://irc.freenode.net/tryton + +License +------- + +See LICENSE + +Copyright +--------- + +See COPYRIGHT + + +For more information please visit the Tryton web site: + + http://www.tryton.org/ diff --git a/__init__.py b/__init__.py new file mode 100644 index 0000000000..bbc14b96de --- /dev/null +++ b/__init__.py @@ -0,0 +1,31 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +from trytond.pool import Pool +from . import configuration +from . import recurrence +from . import service +from . import subscription +from . import invoice + + +def register(): + Pool.register( + configuration.Configuration, + configuration.ConfigurationSequence, + recurrence.RecurrenceRuleSet, + recurrence.RecurrenceRule, + service.Service, + subscription.Subscription, + subscription.Line, + subscription.LineConsumption, + subscription.CreateLineConsumptionStart, + subscription.CreateSubscriptionInvoiceStart, + invoice.InvoiceLine, + module='sale_subscription', type_='model') + Pool.register( + subscription.CreateLineConsumption, + subscription.CreateSubscriptionInvoice, + module='sale_subscription', type_='wizard') + Pool.register( + module='sale_subscription', type_='report') diff --git a/configuration.py b/configuration.py new file mode 100644 index 0000000000..208e4dbc74 --- /dev/null +++ b/configuration.py @@ -0,0 +1,54 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.model import fields +from trytond.pool import PoolMeta, Pool +from trytond.pyson import Eval + +__all__ = ['Configuration', 'ConfigurationSequence'] + + +class Configuration: + __metaclass__ = PoolMeta + __name__ = 'sale.configuration' + + subscription_sequence = fields.MultiValue(fields.Many2One( + 'ir.sequence', "Subscription Sequence", required=True, + domain=[ + ('company', 'in', + [Eval('context', {}).get('company', -1), None]), + ('code', '=', 'sale.subscription'), + ])) + + @classmethod + def multivalue_model(cls, field): + pool = Pool() + if field == 'subscription_sequence': + return pool.get('sale.configuration.sequence') + return super(Configuration, cls).multivalue_model(field) + + @classmethod + def default_subscription_sequence(cls, **pattern): + return cls.multivalue_model( + 'subscription_sequence').default_subscription_sequence() + + +class ConfigurationSequence: + __metaclass__ = PoolMeta + __name__ = 'sale.configuration.sequence' + subscription_sequence = fields.Many2One( + 'ir.sequence', "Subscription Sequence", required=True, + domain=[ + ('company', 'in', [Eval('company', -1), None]), + ('code', '=', 'sale.subscription'), + ], + depends=['company']) + + @classmethod + def default_subscription_sequence(cls): + pool = Pool() + ModelData = pool.get('ir.model.data') + try: + return ModelData.get_id( + 'sale_subscription', 'sequence_subscription') + except KeyError: + return None diff --git a/configuration.xml b/configuration.xml new file mode 100644 index 0000000000..e0bf63a80a --- /dev/null +++ b/configuration.xml @@ -0,0 +1,32 @@ + + + + + + Subscription + sale.subscription + + + + + + + + + + + + Subscription + sale.subscription + + + + sale.configuration + + configuration_form + + + diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..6dd4e9e0cf --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,84 @@ +Sale Subscription Module +######################## + +The sale subscription module defines subscription, services and recurrence rule +models. + +Subscription +************ + +A subscription defines how some recurring services are periodically invoiced. +The invoice is generated based on the consumption of each services. Here is the +extensive list of the fields: + +- Party: The customer. +- Invoice Address: The invoice address of the customer. +- Number: The internal reference of the subscription. +- Reference: The optional external reference of the subscription. +- Description: An optional description for the subscription. +- Start Date: The date at which the subscription starts. +- End Date: The optional end date of the subscription. +- Invoice Start Date: The date at which the invoice starts to be generated. +- Invoice Recurrence: The definition of the invoicing recurrence. +- Payment Term: The payment term to apply on the invoices. +- Currency: Define the currency to use for the subscription. All service prices + will be computed accordingly. +- Lines: + + - Service: A required reference to the service subscribed. + - Description: The description of the service subscribed. + - Consumption Recurrence: The optional recurrence of consumption of the + service. + - Quantity: The quantity consumed on each occurrence. + - Unit: The unit of measure of the quantity. + - Unit Price: The unit price of the service expressed in the currency of + the subscription. + - Start Date: An optional later start date than the subscription. + - End Date: An optional earlier end date than the subscription. + +- States: The state of the subscription. May take one of the following values: + Draft, Quotation, Running, Closed, Canceled. +- Company: The company which issue the sale order. + +A running subscription can be modified by going back to draft and edit. Some +field may not more be editable if the consumption has already started. +The draft subscription is momentary stopped until it is set back to running. + +The consumptions are created by schedulers or by a wizard. +Idem for the creation of the invoices. + +Service +******* + +A subscription service defines the default consumption of a product. It is +composed of the fields: + +- Product: A product of type service. +- Consumption Recurrence: The recurrence at which the service is consumed. +- Consumption Delay: A delay to apply between the date the consumption is + created and the date of the consumption. + +Recurrence Rule +*************** + +It defines combination of rules which compute the occurrence dates. + +- Name: The name of the rule. +- Rules: + + - Exclusive: Define if the rule excludes the resulted dates. + - Frequency: Daily, Weekly, Monthly, Yearly. + - Interval: The interval of the frequency + - By Week Day: Defines the list of weekdays where the recurrence will be + applied. + - By Month Day: Defines the list of month days to apply the recurrence to. + - By Year Day: Defines the list of year days to apply the recurrence to. + - By Week Number: Defines the list of week numbers (ISO8601) to apply the + recurrence to. + - By Month: Defines the list of months to apply the recurrence to. + - By Position: Defines the list of occurrence positions. + - Week Start Day. + +The computation of occurrences is base on the `python-dateutil library`_. + +.. _`python-dateutil library`: https://dateutil.readthedocs.io/en/stable/rrule.html diff --git a/invoice.py b/invoice.py new file mode 100644 index 0000000000..aba9eb0fd1 --- /dev/null +++ b/invoice.py @@ -0,0 +1,26 @@ +# 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, PoolMeta + +__all__ = ['InvoiceLine'] + + +class InvoiceLine: + __metaclass__ = PoolMeta + __name__ = 'account.invoice.line' + + @property + def origin_name(self): + pool = Pool() + SubscriptionLine = pool.get('sale.subscription.line') + name = super(InvoiceLine, self).origin_name + if isinstance(self.origin, SubscriptionLine): + name = (self.origin.subscription.reference + or self.origin.subscription.rec_name) + return name + + @classmethod + def _get_origin(cls): + models = super(InvoiceLine, cls)._get_origin() + models.append('sale.subscription.line') + return models diff --git a/recurrence.py b/recurrence.py new file mode 100644 index 0000000000..d90e68090a --- /dev/null +++ b/recurrence.py @@ -0,0 +1,220 @@ +# 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 dateutil.rrule import MO, TU, WE, TH, FR, SA, SU +from dateutil.rrule import YEARLY, MONTHLY, WEEKLY, DAILY +from dateutil.rrule import rrule, rruleset + +from trytond.model import ModelSQL, ModelView, fields +from trytond.transaction import Transaction + +__all__ = ['RecurrenceRuleSet', 'RecurrenceRule'] +WEEKDAYS = { + 'MO': MO, + 'TU': TU, + 'WE': WE, + 'TH': TH, + 'FR': FR, + 'SA': SA, + 'SU': SU, + } +FREQUENCIES = { + 'yearly': YEARLY, + 'monthly': MONTHLY, + 'weekly': WEEKLY, + 'daily': DAILY, + } + + +class RecurrenceRuleSet(ModelSQL, ModelView): + "Subscription Recurrence Rule Set" + __name__ = 'sale.subscription.recurrence.rule.set' + + name = fields.Char( + "Name", required=True, translate=True, + help="The main identifier of the rule set.") + rules = fields.One2Many( + 'sale.subscription.recurrence.rule', 'set_', "Rules") + + @classmethod + def default_rules(cls): + if Transaction().user == 0: + return [] + return [{}] + + def rruleset(self, dtstart): + set_ = rruleset(**self._rruleset()) + for rule in self.rules: + if not rule.exclusive: + set_.rrule(rule.rrule(dtstart)) + else: + set_.exrule(rule.rrule(dtstart)) + return set_ + + def _rruleset(self): + return {} + + +class RecurrenceRule(ModelSQL, ModelView): + "Subscription Recurrence Rule" + __name__ = 'sale.subscription.recurrence.rule' + + set_ = fields.Many2One( + 'sale.subscription.recurrence.rule.set', "Set", + required=True, select=True, + help="Add the rule below the set.") + freq = fields.Selection([ + ('yearly', 'Yearly'), + ('monthly', 'Monthly'), + ('weekly', 'Weekly'), + ('daily', 'Daily'), + ], "Frequency", sort=False, required=True) + interval = fields.Integer("Interval", required=True) + byweekday = fields.Char( + "By Week Day", + help="A comma separated list of integers or weekday (MO, TU etc).") + bymonthday = fields.Char( + "By Month Day", + help="A comma separated list of integers.") + byyearday = fields.Char( + "By Year Day", + help="A comma separated list of integers.") + byweekno = fields.Char( + "By Week Number", + help="A comma separated list of integers (ISO8601).") + bymonth = fields.Char( + "By Month", + help="A comma separated list of integers.") + bysetpos = fields.Char( + "By Position", + help="A comma separated list of integers.") + wkst = fields.Selection([ + (None, ''), + ('0', 'Monday'), + ('1', 'Tuesday'), + ('2', 'Wednesday'), + ('3', 'Thursday'), + ('4', 'Friday'), + ('5', 'Saturday'), + ('6', 'Sunday'), + ], "Week Start Day", sort=False) + + exclusive = fields.Boolean("Exclusive") + + @classmethod + def __setup__(cls): + super(RecurrenceRule, cls).__setup__() + cls._error_messages.update({ + 'invalid_byweekday': ( + '"By Week Day" (%(byweekday)s) is not valid.'), + 'invalid_bymonthday': ( + '"By Month Day" (%(bymonthday)s) is not valid.'), + 'invalid_byyearday': ( + '"By Year Day" (%(byyearday)s) is not valid.'), + 'invalid_byweekno': ( + '"By Week Number" (%(byweekno)s) is not valid.'), + 'invalid_bymonth': ( + '"By Month" (%(bymonth)s) is not valid.'), + 'invalid_bysetpos': ( + '"By Position" (%(bysetpos)s) is not valie.'), + }) + + @classmethod + def default_interval(cls): + return 1 + + @classmethod + def default_exclusive(cls): + return False + + def rrule(self, dtstart): + return rrule(**self._rrule(dtstart)) + + def _rrule(self, dtstart): + return { + 'dtstart': dtstart, + 'freq': FREQUENCIES[self.freq], + 'interval': self.interval, + 'byweekday': self._byweekday, + 'bymonthday': self._bymonthday, + 'byyearday': self._byyearday, + 'byweekno': self._byweekno, + 'bymonth': self._bymonth, + 'bysetpos': self._bysetpos, + 'wkst': int(self.wkst) if self.wkst else None, + } + + @property + def _byweekday(self): + if not self.byweekday: + return None + byweekday = [] + for weekday in self.byweekday.split(','): + try: + weekday = int(weekday) + except ValueError: + pass + else: + if 0 <= weekday <= len(WEEKDAYS): + byweekday.append(weekday) + continue + else: + raise ValueError('Invalid weekday') + try: + cls = WEEKDAYS[weekday[:2]] + except KeyError: + ValueError('Invalid weekday') + if not weekday[2:]: + byweekday.append(cls) + else: + byweekday.append(cls(int(weekday[3:-1]))) + return byweekday + + @property + def _bymonthday(self): + if not self.bymonthday: + return None + return [int(md) for md in self.bymonthday.split(',')] + + @property + def _byyearday(self): + if not self.byyearday: + return None + return [int(yd) for yd in self.byyearday.split(',')] + + @property + def _byweekno(self): + if not self.byweekno: + return None + return [int(wn) for wn in self.byweekno.split(',')] + + @property + def _bymonth(self): + if not self.bymonth: + return None + return [int(m) for m in self.bymonth.split(',')] + + @property + def _bysetpos(self): + if not self.bysetpos: + return None + positions = [] + for setpos in self.bysetpos.split(','): + setpos = int(setpos) + if -366 <= setpos <= 366: + positions.append(setpos) + else: + raise ValueError('Invalid setpos') + return positions + + def pre_validate(self): + for name in ['byweekday', 'bymonthday', 'byyearday', 'byweekno', + 'bymonth', 'bysetpos']: + self.check_by(name) + + def check_by(self, name): + try: + getattr(self, '_%s' % name) + except ValueError: + self.raise_user_error('invalid_%s' % name, { + name: getattr(self, name), + }) diff --git a/recurrence.xml b/recurrence.xml new file mode 100644 index 0000000000..54d6b6a5e0 --- /dev/null +++ b/recurrence.xml @@ -0,0 +1,82 @@ + + + + + + sale.subscription.recurrence.rule.set + form + recurrence_rule_set_form + + + + sale.subscription.recurrence.rule.set + tree + recurrence_rule_set_list + + + + Subscription Recurrence Rule Sets + sale.subscription.recurrence.rule.set + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + sale.subscription.recurrence.rule + form + recurrence_rule_form + + + + sale.subscription.recurrence.rule + tree + recurrence_rule_list + + + + + + + + + + + + + + + + + + + diff --git a/service.py b/service.py new file mode 100644 index 0000000000..1dc7ab513c --- /dev/null +++ b/service.py @@ -0,0 +1,31 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. +from trytond.model import ModelSQL, ModelView, fields +from trytond.pyson import Eval + +__all__ = ['Service'] + + +class Service(ModelSQL, ModelView): + "Subscription Service" + __name__ = 'sale.subscription.service' + + product = fields.Many2One( + 'product.product', "Product", required=True, + domain=[ + ('type', '=', 'service'), + ]) + consumption_recurrence = fields.Many2One( + 'sale.subscription.recurrence.rule.set', "Consumption Recurrence") + consumption_delay = fields.TimeDelta("Consumption Delay", + states={ + 'invisible': ~Eval('consumption_recurrence'), + }, + depends=['consumption_recurrence']) + + def get_rec_name(self, name): + return self.product.rec_name + + @classmethod + def search_rec_name(self, name, clause): + return [('product.rec_name',) + tuple(clause[1:])] diff --git a/service.xml b/service.xml new file mode 100644 index 0000000000..9f12cafd8d --- /dev/null +++ b/service.xml @@ -0,0 +1,53 @@ + + + + + + sale.subscription.service + form + service_form + + + + sale.subscription.service + tree + service_list + + + + Subscription Services + sale.subscription.service + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/setup.py b/setup.py new file mode 100644 index 0000000000..04b7e80306 --- /dev/null +++ b/setup.py @@ -0,0 +1,129 @@ +#!/usr/bin/env python +# 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 setuptools import setup +import re +import os +import io +try: + from configparser import ConfigParser +except ImportError: + from ConfigParser import ConfigParser + + +def read(fname): + return io.open( + os.path.join(os.path.dirname(__file__), fname), + 'r', encoding='utf-8').read() + + +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.readfp(open('tryton.cfg')) +info = dict(config.items('tryton')) +for key in ('depends', 'extras_depend', 'xml'): + if key in info: + info[key] = info[key].strip().splitlines() +version = info.get('version', '0.0.1') +major_version, minor_version, _ = version.split('.', 2) +major_version = int(major_version) +minor_version = int(minor_version) +name = 'trytond_sale_subscription' + +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)) + +requires = ['python-dateutil'] +for dep in info.get('depends', []): + if not re.match(r'(ir|res)(\W|$)', dep): + requires.append(get_require_version('trytond_%s' % dep)) +requires.append(get_require_version('trytond')) + +tests_require = [get_require_version('proteus')] +dependency_links = [] +if minor_version % 2: + # Add development index for testing with proteus + dependency_links.append('https://trydevpi.tryton.org/') + +setup(name=name, + version=version, + description='Tryton module for subscription', + long_description=read('README'), + author='Tryton', + author_email='issue_tracker@tryton.org', + url='http://www.tryton.org/', + download_url=download_url, + keywords='tryton sale subscription', + package_dir={'trytond.modules.sale_subscription': '.'}, + packages=[ + 'trytond.modules.sale_subscription', + 'trytond.modules.sale_subscription.tests', + ], + package_data={ + 'trytond.modules.sale_subscription': (info.get('xml', []) + + ['tryton.cfg', 'view/*.xml', 'locale/*.po', '*.odt', + '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 :: French', + 'Natural Language :: German', + 'Natural Language :: Hungarian', + 'Natural Language :: Italian', + 'Natural Language :: Polish', + 'Natural Language :: Portuguese (Brazilian)', + 'Natural Language :: Russian', + 'Natural Language :: Slovenian', + 'Natural Language :: Spanish', + 'Operating System :: OS Independent', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3.3', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + 'Programming Language :: Python :: Implementation :: CPython', + 'Programming Language :: Python :: Implementation :: PyPy', + 'Topic :: Office/Business', + 'Topic :: Office/Business :: Financial :: Accounting', + ], + license='GPL-3', + install_requires=requires, + dependency_links=dependency_links, + zip_safe=False, + entry_points=""" + [trytond.modules] + sale_subscription = trytond.modules.sale_subscription + """, + test_suite='tests', + test_loader='trytond.test_loader:Loader', + tests_require=tests_require, + use_2to3=True, + convert_2to3_doctests=[ + 'tests/scenario_sale_subscription.rst', + ], + ) diff --git a/subscription.py b/subscription.py new file mode 100644 index 0000000000..eb72ccb3c3 --- /dev/null +++ b/subscription.py @@ -0,0 +1,836 @@ +# 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 datetime +from decimal import Decimal +from itertools import groupby + +from sql import operators, Literal +from sql.conditionals import Coalesce + +from trytond.model import ModelSQL, ModelView, Workflow, fields, \ + sequence_ordered +from trytond.pool import Pool +from trytond.pyson import Eval, If, Bool +from trytond.transaction import Transaction +from trytond.wizard import Wizard, StateView, StateAction, StateTransition, \ + Button + +from trytond.modules.product import price_digits + +__all__ = ['Subscription', 'Line', 'LineConsumption', + 'CreateLineConsumption', 'CreateLineConsumptionStart', + 'CreateSubscriptionInvoice', 'CreateSubscriptionInvoiceStart'] +STATES = [ + ('draft', 'Draft'), + ('quotation', 'Quotation'), + ('running', 'Running'), + ('closed', 'Closed'), + ('canceled', 'Canceled'), + ] + + +class Subscription(Workflow, ModelSQL, ModelView): + "Subscription" + __name__ = 'sale.subscription' + _rec_name = 'number' + + company = fields.Many2One( + 'company.company', "Company", required=True, select=True, + states={ + 'readonly': Eval('state') != 'draft', + }, + domain=[ + ('id', If(Eval('context', {}).contains('company'), '=', '!='), + Eval('context', {}).get('company', -1)), + ], + depends=['state'], + help="Make the subscription belong to the company.") + + number = fields.Char( + "Number", readonly=True, select=True, + help="The main identification of the subscription.") + # TODO revision + reference = fields.Char( + "Reference", select=True, + help="The identification of an external origin.") + description = fields.Char("Description", + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state']) + + party = fields.Many2One( + 'party.party', "Party", required=True, + states={ + 'readonly': ((Eval('state') != 'draft') + | (Eval('lines', [0]) & Eval('party'))), + }, + depends=['state'], + help="The party who subscribes.") + invoice_address = fields.Many2One( + 'party.address', "Invoice Address", + domain=[ + ('party', '=', Eval('party')), + ], + states={ + 'readonly': Eval('state') != 'draft', + 'required': ~Eval('state').in_(['draft']), + }, + depends=['party', 'state']) + payment_term = fields.Many2One( + 'account.invoice.payment_term', "Payment Term", + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state']) + + currency = fields.Many2One( + 'currency.currency', "Currency", required=True, + states={ + 'readonly': ((Eval('state') != 'draft') + | (Eval('lines', [0]) & Eval('currency', 0))), + }, + depends=['state']) + + start_date = fields.Date( + "Start Date", required=True, + states={ + 'readonly': ((Eval('state') != 'draft') + | Eval('next_invoice_date')), + }, + depends=['state', 'next_invoice_date']) + end_date = fields.Date( + "End Date", + domain=['OR', + ('end_date', '>=', If( + Bool(Eval('start_date')), + Eval('start_date', datetime.date.min), + datetime.date.min)), + ('end_date', '=', None), + ], + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['start_date', 'state']) + + invoice_recurrence = fields.Many2One( + 'sale.subscription.recurrence.rule.set', "Invoice Recurrence", + required=True, + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state']) + invoice_start_date = fields.Date("Invoice Start Date", + states={ + 'readonly': ((Eval('state') != 'draft') + | Eval('next_invoice_date')), + }, + depends=['state', 'next_invoice_date']) + next_invoice_date = fields.Date("Next Invoice Date", readonly=True) + + lines = fields.One2Many( + 'sale.subscription.line', 'subscription', "Lines", + states={ + 'readonly': Eval('state') != 'draft', + }, + depends=['state']) + + state = fields.Selection( + STATES, "State", readonly=True, required=True, + help="The current state of the subscription.") + + @classmethod + def __setup__(cls): + super(Subscription, cls).__setup__() + cls._order = [ + ('start_date', 'DESC'), + ('id', 'DESC'), + ] + cls._transitions |= set(( + ('draft', 'canceled'), + ('draft', 'quotation'), + ('quotation', 'canceled'), + ('quotation', 'draft'), + ('quotation', 'running'), + ('running', 'draft'), + ('running', 'closed'), + ('canceled', 'draft'), + )) + cls._buttons.update({ + 'cancel': { + 'invisible': ~Eval('state').in_(['draft', 'quotation']), + 'icon': 'tryton-cancel', + }, + 'draft': { + 'invisible': Eval('state').in_(['draft', 'closed']), + 'icon': If(Eval('state') == 'canceled', + 'tryton-clear', 'tryton-go-previous'), + }, + 'quote': { + 'invisible': Eval('state') != 'draft', + 'readonly': ~Eval('lines', []), + 'icon': 'tryton-go-next', + }, + 'run': { + 'invisible': Eval('state') != 'quotation', + 'icon': 'tryton-go-next', + }, + }) + + @classmethod + def default_company(cls): + return Transaction().context.get('company') + + @classmethod + def default_currency(cls): + pool = Pool() + Company = pool.get('company.company') + company = cls.default_company() + if company: + return Company(company).currency.id + + @classmethod + def default_state(cls): + return 'draft' + + @fields.depends('party') + def on_change_party(self): + self.invoice_address = None + if self.party: + self.invoice_address = self.party.address_get(type='invoice') + self.payment_term = self.party.customer_payment_term + + @classmethod + def set_number(cls, subscriptions): + pool = Pool() + Sequence = pool.get('ir.sequence') + Config = pool.get('sale.configuration') + + config = Config(1) + for subscription in subscriptions: + if subscription.number: + continue + subscription.number = Sequence.get_id( + config.subscription_sequence.id) + cls.save(subscriptions) + + def compute_next_invoice_date(self): + start_date = self.invoice_start_date or self.start_date + date = self.next_invoice_date or self.start_date + rruleset = self.invoice_recurrence.rruleset(start_date) + dt = datetime.datetime.combine(date, datetime.time()) + inc = (start_date == date) and not self.next_invoice_date + next_date = rruleset.after(dt, inc=inc) + return next_date.date() + + @classmethod + def copy(cls, subscriptions, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('state', 'draft') + default.setdefault('number') + default.setdefault('next_invoice_date') + return super(Subscription, cls).copy(subscriptions, default=default) + + @classmethod + @ModelView.button + @Workflow.transition('canceled') + def cancel(cls, subscriptions): + pass + + @classmethod + @ModelView.button + @Workflow.transition('draft') + def draft(cls, subscriptions): + pass + + @classmethod + @ModelView.button + @Workflow.transition('quotation') + def quote(cls, subscriptions): + cls.set_number(subscriptions) + + @classmethod + @ModelView.button + @Workflow.transition('running') + def run(cls, subscriptions): + pool = Pool() + Line = pool.get('sale.subscription.line') + lines = [] + for subscription in subscriptions: + if not subscription.next_invoice_date: + subscription.next_invoice_date = ( + subscription.compute_next_invoice_date()) + for line in subscription.lines: + if (line.next_consumption_date is None + and not line.consumed): + line.next_consumption_date = ( + line.compute_next_consumption_date()) + lines.extend(subscription.lines) + Line.save(lines) + cls.save(subscriptions) + + @classmethod + def process(cls, subscriptions): + to_close = [] + for subscription in subscriptions: + if all(l.next_consumption_date is None + for l in subscription.lines): + to_close.append(subscription) + cls.close(to_close) + + @classmethod + @Workflow.transition('closed') + def close(cls, subscriptions): + pass + + @classmethod + def generate_invoice(cls, date=None): + pool = Pool() + Date = pool.get('ir.date') + Consumption = pool.get('sale.subscription.line.consumption') + Invoice = pool.get('account.invoice') + InvoiceLine = pool.get('account.invoice.line') + + if date is None: + date = Date.today() + + consumptions = Consumption.search([ + ('invoice_line', '=', None), + ('line.subscription.next_invoice_date', '<=', date), + ('line.subscription.state', 'in', ['running', 'closed']), + ], + order=[ + ('line.subscription.id', 'DESC'), + ]) + + def keyfunc(consumption): + return consumption.line.subscription + invoices = {} + lines = {} + for subscription, consumptions in groupby(consumptions, key=keyfunc): + invoices[subscription] = invoice = subscription._get_invoice() + lines[subscription] = Consumption.get_invoice_lines( + consumptions, invoice) + + all_invoices = invoices.values() + Invoice.save(all_invoices) + + all_invoice_lines = [] + for subscription, invoice in invoices.iteritems(): + invoice_lines, _ = lines[subscription] + for line in invoice_lines: + line.invoice = invoice + all_invoice_lines.extend(invoice_lines) + InvoiceLine.save(all_invoice_lines) + + all_consumptions = [] + for values in lines.itervalues(): + for invoice_line, consumptions in zip(*values): + for consumption in consumptions: + assert not consumption.invoice_line + consumption.invoice_line = invoice_line + all_consumptions.append(consumption) + Consumption.save(consumptions) + + Invoice.update_taxes(all_invoices) + + subscriptions = cls.search([ + ('next_invoice_date', '<=', date), + ]) + for subscription in subscriptions: + if subscription.state == 'running': + while subscription.next_invoice_date <= date: + subscription.next_invoice_date = ( + subscription.compute_next_invoice_date()) + else: + subscription.next_invoice_date = None + cls.save(subscriptions) + + def _get_invoice(self): + pool = Pool() + Invoice = pool.get('account.invoice') + invoice = Invoice( + company=self.company, + type='out', + party=self.party, + invoice_address=self.invoice_address, + currency=self.currency, + account=self.party.account_receivable, + ) + invoice.on_change_type() + invoice.payment_term = self.payment_term + return invoice + + +class Line(sequence_ordered(), ModelSQL, ModelView): + "Subscription Line" + __name__ = 'sale.subscription.line' + _rec_name = 'description' + + subscription = fields.Many2One( + 'sale.subscription', "Subscription", required=True, select=True, + ondelete='CASCADE', + states={ + 'readonly': ((Eval('subscription_state') != 'draft') + & Bool(Eval('subscription'))), + }, + depends=['subscription_state'], + help="Add the line below the subscription.") + subscription_state = fields.Function( + fields.Selection(STATES, "Subscription State"), + 'on_change_with_subscription_state') + subscription_start_date = fields.Function( + fields.Date("Subscription Start Date"), + 'on_change_with_subscription_start_date') + subscription_end_date = fields.Function( + fields.Date("Subscription End Date"), + 'on_change_with_subscription_end_date') + + service = fields.Many2One( + 'sale.subscription.service', "Service", required=True, + states={ + 'readonly': Eval('subscription_state') != 'draft', + }, + depends=['subscription_state']) + description = fields.Text("Description", required=True, + states={ + 'readonly': Eval('subscription_state') != 'draft', + }, + depends=['subscription_state']) + + quantity = fields.Float( + "Quantity", digits=(16, Eval('unit_digits', 2)), + states={ + 'readonly': Eval('subscription_state') != 'draft', + 'required': Bool(Eval('consumption_recurrence')), + }, + depends=[ + 'unit_digits', 'subscription_state', 'consumption_recurrence']) + unit = fields.Many2One( + 'product.uom', "Unit", required=True, + states={ + 'readonly': Eval('subscription_state') != 'draft', + }, + domain=[ + If(Bool(Eval('service_unit_category')), + ('category', '=', Eval('service_unit_category')), + ('category', '!=', -1)), + ], + depends=['subscription_state', 'service_unit_category']) + unit_digits = fields.Function( + fields.Integer("Unit Digits"), 'on_change_with_unit_digits') + service_unit_category = fields.Function( + fields.Many2One('product.uom.category', "Service Unit Category"), + 'on_change_with_service_unit_category') + + unit_price = fields.Numeric( + "Unit Price", digits=price_digits, + states={ + 'readonly': Eval('subscription_state') != 'draft', + }, + depends=['subscription_state']) + + consumption_recurrence = fields.Many2One( + 'sale.subscription.recurrence.rule.set', "Consumption Recurrence", + states={ + 'readonly': Eval('subscription_state') != 'draft', + }, + depends=['subscription_state']) + consumption_delay = fields.TimeDelta( + "Consumption Delay", + states={ + 'readonly': Eval('subscription_state') != 'draft', + 'invisible': ~Eval('consumption_recurrence'), + }, + depends=['subscription_state', 'consumption_recurrence']) + next_consumption_date = fields.Date("Next Consumption Date", readonly=True) + next_consumption_date_delayed = fields.Function( + fields.Date("Next Consumption Delayed"), + 'get_next_consumption_date_delayed') + consumed = fields.Boolean("Consumed") + start_date = fields.Date( + "Start Date", + domain=['OR', + ('start_date', '>=', Eval('subscription_start_date')), + ('start_date', '=', None), + ], + states={ + 'readonly': ((Eval('subscription_state') != 'draft') + | Eval('consumed')), + }, + depends=['subscription_start_date', 'subscription_state', 'consumed']) + end_date = fields.Date( + "End Date", + domain=['OR', [ + If(Bool(Eval('subscription_end_date')), + ('end_date', '<=', Eval('subscription_end_date')), + ('end_date', '>=', Eval('start_date'))), + If(Bool(Eval('next_consumption_date')), + ('end_date', '>=', Eval('next_consumption_date')), + ('end_date', '>=', Eval('start_date'))), + ], + ('end_date', '=', None), + ], + states={ + 'readonly': ((Eval('subscription_state') != 'draft') + | (~Eval('next_consumption_date') & Eval('consumed'))), + }, + depends=['subscription_end_date', 'start_date', + 'next_consumption_date', 'subscription_state', 'consumed']) + + @fields.depends('subscription', '_parent_subscription.state') + def on_change_with_subscription_state(self, name=None): + if self.subscription: + return self.subscription.state + + @fields.depends('subscription', '_parent_subscription.start_date') + def on_change_with_subscription_start_date(self, name=None): + if self.subscription: + return self.subscription.start_date + + @fields.depends('subscription', '_parent_subscription.end_date') + def on_change_with_subscription_end_date(self, name=None): + if self.subscription: + return self.subscription.end_date + + @classmethod + def default_quantity(cls): + return 1 + + @fields.depends('unit') + def on_change_with_unit_digits(self, name=None): + if self.unit: + return self.unit.digits + return 2 + + @fields.depends('service') + def on_change_with_service_unit_category(self, name=None): + if self.service: + return self.service.product.default_uom_category.id + + @fields.depends('service', 'quantity', 'unit', 'description', + 'subscription', '_parent_subscription.currency', + '_parent_subscription.party', '_parent_subscription.start_date') + def on_change_service(self): + pool = Pool() + Product = pool.get('product.product') + + if not self.service: + self.consumption_recurrence = None + self.consumption_delay = None + return + + party = None + party_context = {} + if self.subscription and self.subscription.party: + party = self.subscription.party + if party.lang: + party_context['language'] = party.lang.code + + product = self.service.product + category = product.sale_uom.category + if not self.unit or self.unit.category != category: + self.unit = product.sale_uom + self.unit_digits = product.sale_uom.digits + + with Transaction().set_context(self._get_context_sale_price()): + self.unit_price = Product.get_sale_price( + [product], self.quantity or 0)[product.id] + if self.unit_price: + self.unit_price = self.unit_price.quantize( + Decimal(1) / 10 ** self.__class__.unit_price.digits[1]) + + if not self.description: + with Transaction().set_context(party_context): + self.description = Product(product.id).rec_name + + self.consumption_recurrence = self.service.consumption_recurrence + self.consumption_delay = self.service.consumption_delay + + def _get_context_sale_price(self): + context = {} + if getattr(self, 'subscription', None): + if getattr(self.subscription, 'currency', None): + context['currency'] = self.subscription.currency.id + if getattr(self.subscription, 'party', None): + context['customer'] = self.subscription.party.id + if getattr(self.subscription, 'start_date', None): + context['sale_date'] = self.subscription.start_date + if self.unit: + context['uom'] = self.unit.id + elif self.service: + context['uom'] = self.service.sale_uom.id + # TODO tax + return context + + def get_next_consumption_date_delayed(self, name=None): + if self.next_consumption_date and self.consumption_delay: + return self.next_consumption_date + self.consumption_delay + return self.next_consumption_date + + @classmethod + def default_consumed(cls): + return False + + @classmethod + def domain_next_consumption_date_delayed(cls, domain, tables): + field = cls.next_consumption_date_delayed._field + table, _ = tables[None] + name, operator, value = domain + Operator = fields.SQL_OPERATORS[operator] + column = ( + table.next_consumption_date + Coalesce( + table.consumption_delay, datetime.timedelta())) + expression = Operator(column, field._domain_value(operator, value)) + if isinstance(expression, operators.In) and not expression.right: + expression = Literal(False) + elif isinstance(expression, operators.NotIn) and not expression.right: + expression = Literal(True) + expression = field._domain_add_null( + column, operator, value, expression) + return expression + + @classmethod + def generate_consumption(cls, date=None): + pool = Pool() + Date = pool.get('ir.date') + Consumption = pool.get('sale.subscription.line.consumption') + Subscription = pool.get('sale.subscription') + + if date is None: + date = Date.today() + + remainings = all_lines = cls.search([ + ('consumption_recurrence', '!=', None), + ('next_consumption_date_delayed', '<=', date), + ('subscription.state', '=', 'running'), + ]) + + consumptions = [] + subscription_ids = set() + while remainings: + lines, remainings = remainings, [] + for line in lines: + consumptions.append( + line.get_consumption(line.next_consumption_date)) + line.next_consumption_date = ( + line.compute_next_consumption_date()) + line.consumed = True + if line.next_consumption_date is None: + subscription_ids.add(line.subscription.id) + elif line.get_next_consumption_date_delayed() <= date: + remainings.append(line) + + Consumption.save(consumptions) + cls.save(all_lines) + Subscription.process(Subscription.browse(list(subscription_ids))) + + def get_consumption(self, date): + pool = Pool() + Consumption = pool.get('sale.subscription.line.consumption') + return Consumption(line=self, quantity=self.quantity, date=date) + + def compute_next_consumption_date(self): + if not self.consumption_recurrence: + return None + start_date = self.start_date or self.subscription.start_date + date = self.next_consumption_date or start_date + rruleset = self.consumption_recurrence.rruleset(start_date) + dt = datetime.datetime.combine(date, datetime.time()) + inc = (start_date == date) and not self.next_consumption_date + next_date = rruleset.after(dt, inc=inc).date() + for end_date in [self.end_date, self.subscription.end_date]: + if end_date: + if next_date > end_date: + return None + return next_date + + @classmethod + def copy(cls, lines, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('consumed') + return super(Line, cls).copy(lines, default=default) + + +class LineConsumption(ModelSQL, ModelView): + "Subscription Line Consumption" + __name__ = 'sale.subscription.line.consumption' + + line = fields.Many2One( + 'sale.subscription.line', "Line", required=True, select=True, + ondelete='RESTRICT') + quantity = fields.Float( + "Quantity", digits=(16, Eval('unit_digits', 2)), + depends=['unit_digits']) + unit_digits = fields.Function( + fields.Integer("Unit Digits"), 'on_change_with_unit_digits') + date = fields.Date("Date", required=True) + invoice_line = fields.Many2One( + 'account.invoice.line', "Invoice Line", readonly=True) + + @classmethod + def __setup__(cls): + super(LineConsumption, cls).__setup__() + cls._order.insert(0, ('date', 'DESC')) + cls._error_messages.update({ + 'modify_invoiced_consumption': ( + "You can not modify invoiced consumption."), + 'delete_invoiced_consumption': ( + "You can not delete invoiced consumption."), + 'missing_account_revenue': ('Product "%(product)s" ' + 'misses a revenue account.'), + }) + + @fields.depends('line') + def on_change_with_unit_digits(self, name=None): + if self.line and self.line.unit: + return self.line.unit.digits + return 2 + + @classmethod + def copy(cls, consumptions, default=None): + if default is None: + default = {} + else: + default = default.copy() + default.setdefault('invoice_line') + return super(LineConsumption, cls).copy(consumptions, default=default) + + @classmethod + def write(cls, *args): + if any(c.invoice_line + for consumptions in args[::2] + for c in consumptions): + cls.raise_user_error('modify_invoiced_consumption') + super(LineConsumption, cls).write(*args) + + @classmethod + def delete(cls, consumptions): + if any(c.invoice_line for c in consumptions): + cls.raise_user_error('delete_invoiced_consumption') + super(LineConsumption, cls).delete(consumptions) + + @classmethod + def get_invoice_lines(cls, consumptions, invoice): + "Return a list of lines and a list of consumptions" + pool = Pool() + InvoiceLine = pool.get('account.invoice.line') + + lines, grouped_consumptions = [], [] + consumptions = sorted(consumptions, key=cls._group_invoice_key) + for key, sub_consumptions in groupby( + consumptions, key=cls._group_invoice_key): + sub_consumptions = list(sub_consumptions) + line = InvoiceLine(**dict(key)) + line.invoice_type = 'out' + line.type = 'line' + line.quantity = sum(c.quantity for c in sub_consumptions) + + line.account = line.product.account_revenue_used + if not line.account: + cls.raise_user_error('missing_account_revenue', { + 'product': line.product.rec_name, + }) + + taxes = [] + pattern = line._get_tax_rule_pattern() + party = invoice.party + for tax in line.product.customer_taxes_used: + if party.customer_tax_rule: + tax_ids = party.customer_tax_rule.apply(tax, pattern) + if tax_ids: + taxes.extend(tax_ids) + continue + taxes.append(tax.id) + if party.customer_tax_rule: + tax_ids = party.customer_tax_rule.apply(None, pattern) + if tax_ids: + taxes.extend(tax_ids) + line.taxes = taxes + + lines.append(line) + grouped_consumptions.append(sub_consumptions) + return lines, grouped_consumptions + + @classmethod + def _group_invoice_key(cls, consumption): + return ( + ('company', consumption.line.subscription.company), + ('unit', consumption.line.unit), + ('product', consumption.line.service.product), + ('unit_price', consumption.line.unit_price), + ('description', consumption.line.description), + ('origin', consumption.line), + ) + + +class CreateLineConsumption(Wizard): + "Create Subscription Line Consumption" + __name__ = 'sale.subscription.line.consumption.create' + start = StateView( + 'sale.subscription.line.consumption.create.start', + 'sale_subscription.line_consumption_create_start_view_form', [ + Button("Cancel", 'end', 'tryton-cancel'), + Button("Create", 'create_', 'tryton-ok', default=True), + ]) + create_ = StateAction( + 'sale_subscription.act_subscription_line_consumption_form') + + def do_create_(self, action): + pool = Pool() + Line = pool.get('sale.subscription.line') + Line.generate_consumption(date=self.start.date) + return action, {} + + def transition_create_(self): + return 'end' + + +class CreateLineConsumptionStart(ModelView): + "Create Subscription Line Consumption" + __name__ = 'sale.subscription.line.consumption.create.start' + + date = fields.Date("Date") + + @classmethod + def default_date(cls): + pool = Pool() + Date = pool.get('ir.date') + return Date.today() + + +class CreateSubscriptionInvoice(Wizard): + "Create Subscription Invoice" + __name__ = 'sale.subscription.create_invoice' + start = StateView( + 'sale.subscription.create_invoice.start', + 'sale_subscription.create_invoice_start_view_form', [ + Button("Cancel", 'end', 'tryton-cancel'), + Button("Create", 'create_', 'tryton-ok', default=True), + ]) + create_ = StateTransition() + + def transition_create_(self): + pool = Pool() + Subscription = pool.get('sale.subscription') + Subscription.generate_invoice(date=self.start.date) + return 'end' + + +class CreateSubscriptionInvoiceStart(ModelView): + "Create Subscription Invoice" + __name__ = 'sale.subscription.create_invoice.start' + + date = fields.Date("Date") + + @classmethod + def default_date(cls): + pool = Pool() + Date = pool.get('ir.date') + return Date.today() diff --git a/subscription.xml b/subscription.xml new file mode 100644 index 0000000000..bd4bfb2ef7 --- /dev/null +++ b/subscription.xml @@ -0,0 +1,349 @@ + + + + + + sale.subscription + form + subscription_form + + + + sale.subscription + tree + subscription_list + + + + Subscriptions + sale.subscription + + + + + + + + + + + + + Draft + + + + + + + Quotation + + + + + + + Running + + + + + + All + + + + + + + + + + + + Subscriptions + sale.subscription + + + + form_relate + party.party,-1 + + + + + + + + + + + + + + + + + + + + + + + + + draft + + + + + + + + + run + + + + + + + + + sale.subscription.line + form + subscription_line_form + + + + sale.subscription.line + tree + + subscription_line_list + + + + sale.subscription.line + tree + + subscription_line_list_sequence + + + + + + + + + + + + + + + + + + + + sale.subscription.line.consumption + form + subscription_line_consumption_form + + + + sale.subscription.line.consumption + tree + subscription_line_consumption_list + + + + Consumptions + sale.subscription.line.consumption + + + + + + + + + + + + + + Consumptions + sale.subscription.line.consumption + + + + form_relate + sale.subscription,-1 + + + + + Consumptions + sale.subscription.line.consumption + + + + form_relate + sale.subscription.line,-1 + + + + + + + + + + + + + + + + + + + + + Create Line Consumptions + sale.subscription.line.consumption.create + + + + + + + + + + sale.subscription.line.consumption.create.start + form + line_consumption_create_start_form + + + + user_cron_subscription_line_consumption + Cron Subscription Line Consumption + + + + + + + + + + Generate Subscription Line Consumptions + + + + + days + + + sale.subscription.line + generate_consumption + + + + Create Subscription Invoices + sale.subscription.create_invoice + + + + + + + + + + sale.subscription.create_invoice.start + form + create_invoice_start_form + + + + user_cron_subscription_invoice + Cron Subscription Invoice + + + + + + + + + + + + + + Generate Subscription Invoices + + + + + days + + + sale.subscription + generate_invoice + + + + diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000000..3f572594c8 --- /dev/null +++ b/tests/__init__.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. + +try: + from trytond.modules.sale_subscription.tests.test_sale_subscription \ + import suite +except ImportError: + from .test_sale_subscription import suite + +__all__ = ['suite'] diff --git a/tests/scenario_sale_subscription.rst b/tests/scenario_sale_subscription.rst new file mode 100644 index 0000000000..23e1bfacfc --- /dev/null +++ b/tests/scenario_sale_subscription.rst @@ -0,0 +1,192 @@ +========================== +Sale Subscription Scenario +========================== + +Imports:: + + >>> import datetime + >>> from decimal import Decimal + >>> from dateutil.relativedelta import relativedelta + >>> from proteus import Model, Wizard + >>> from trytond.tests.tools import activate_modules + >>> from trytond.modules.company.tests.tools import create_company, \ + ... get_company + >>> from trytond.modules.account.tests.tools import create_chart, \ + ... get_accounts + +Install sale_subscription:: + + >>> config = activate_modules('sale_subscription') + +Create company:: + + >>> _ = create_company() + >>> company = get_company() + +Create sale user:: + + >>> User = Model.get('res.user') + >>> Group = Model.get('res.group') + + >>> sale_user = User() + >>> sale_user.name = 'Sale' + >>> sale_user.login = 'sale' + >>> sale_user.main_company = company + >>> sale_group, = Group.find([('name', '=', 'Sales')]) + >>> sale_user.groups.append(sale_group) + >>> sale_user.save() + +Create product user:: + + >>> product_user = User() + >>> product_user.name = 'Product' + >>> product_user.login = 'product' + >>> product_user.main_company = company + >>> product_group, = Group.find([('name', '=', 'Product Administration')]) + >>> product_user.groups.append(product_group) + >>> product_user.save() + +Create chart of accounts:: + + >>> _ = create_chart(company) + >>> accounts = get_accounts(company) + >>> revenue = accounts['revenue'] + +Create party:: + + >>> Party = Model.get('party.party') + + >>> customer = Party(name='Customer') + >>> customer.save() + +Create subscription recurrence rule sets:: + + >>> RecurrenceRuleSet = Model.get('sale.subscription.recurrence.rule.set') + + >>> monthly = RecurrenceRuleSet(name='Monthly') + >>> rule, = monthly.rules + >>> rule.freq = 'monthly' + >>> rule.interval = 1 + >>> monthly.save() + + >>> daily = RecurrenceRuleSet(name='Daily') + >>> rule, = daily.rules + >>> rule.freq = 'daily' + >>> rule.interval = 1 + >>> daily.save() + +Create subscription service:: + + >>> Service = Model.get('sale.subscription.service') + >>> ProductTemplate = Model.get('product.template') + >>> Product = Model.get('product.product') + >>> Uom = Model.get('product.uom') + + >>> unit, = Uom.find([('name', '=', 'Unit')]) + >>> product = Product() + >>> template = ProductTemplate() + >>> template.name = 'Rental' + >>> template.default_uom = unit + >>> template.type = 'service' + >>> template.list_price = Decimal('10') + >>> template.cost_price = Decimal('4') + >>> template.cost_method = 'fixed' + >>> template.account_revenue = revenue + >>> template.save() + >>> product.template = template + >>> product.save() + + >>> service = Service() + >>> service.product = product + >>> service.consumption_recurrence = daily + >>> service.save() + +Subscribe:: + + >>> Subscription = Model.get('sale.subscription') + + >>> subscription = Subscription() + >>> subscription.party = customer + >>> subscription.start_date = datetime.date(2016, 1, 1) + >>> subscription.invoice_start_date = datetime.date(2016, 2, 1) + >>> subscription.invoice_recurrence = monthly + >>> line = subscription.lines.new() + >>> line.service = service + >>> line.quantity = 10 + + >>> subscription.click('quote') + >>> subscription.state + u'quotation' + >>> subscription.click('run') + >>> subscription.state + u'running' + +Create line consumption:: + + >>> LineConsumption = Model.get('sale.subscription.line.consumption') + + >>> line_consumption_create = Wizard( + ... 'sale.subscription.line.consumption.create') + >>> line_consumption_create.form.date = datetime.date(2016, 1, 31) + >>> line_consumption_create.execute('create_') + + >>> len(LineConsumption.find([])) + 31 + + >>> subscription.reload() + >>> line, = subscription.lines + >>> line.next_consumption_date + datetime.date(2016, 2, 1) + +Create subscription invoice:: + + >>> Invoice = Model.get('account.invoice') + + >>> create_invoice = Wizard('sale.subscription.create_invoice') + >>> create_invoice.form.date = datetime.date(2016, 2, 1) + >>> create_invoice.execute('create_') + + >>> invoice, = Invoice.find([]) + >>> line, = invoice.lines + >>> line.quantity + 310.0 + >>> line.unit_price + Decimal('10.0000') + + >>> subscription.reload() + >>> subscription.next_invoice_date + datetime.date(2016, 3, 1) + +Close subscription:: + + >>> subscription.click('draft') + >>> subscription.state + u'draft' + >>> subscription.end_date = datetime.date(2016, 1, 31) + >>> subscription.click('quote') + >>> subscription.click('run') + >>> subscription.state + u'running' + + >>> line_consumption_create = Wizard( + ... 'sale.subscription.line.consumption.create') + >>> line_consumption_create.form.date = datetime.date(2016, 2, 1) + >>> line_consumption_create.execute('create_') + + >>> len(LineConsumption.find([])) + 32 + + >>> subscription.reload() + >>> line, = subscription.lines + >>> line.next_consumption_date + >>> subscription.state + u'closed' + +Create final subscription invoice:: + + >>> create_invoice = Wizard('sale.subscription.create_invoice') + >>> create_invoice.form.date = datetime.date(2016, 3, 1) + >>> create_invoice.execute('create_') + + >>> len(Invoice.find([])) + 2 diff --git a/tests/test_sale_subscription.py b/tests/test_sale_subscription.py new file mode 100644 index 0000000000..a40aa514ff --- /dev/null +++ b/tests/test_sale_subscription.py @@ -0,0 +1,28 @@ +# This file is part of Tryton. The COPYRIGHT file at the top level of +# this repository contains the full copyright notices and license terms. + +import unittest + +import doctest + +from trytond.tests.test_tryton import ModuleTestCase +from trytond.tests.test_tryton import suite as test_suite +from trytond.tests.test_tryton import doctest_teardown +from trytond.tests.test_tryton import doctest_checker + + +class SaleSubscriptionTestCase(ModuleTestCase): + 'Test Sale Subscription module' + module = 'sale_subscription' + + +def suite(): + suite = test_suite() + suite.addTests(unittest.TestLoader().loadTestsFromTestCase( + SaleSubscriptionTestCase)) + suite.addTests(doctest.DocFileSuite( + 'scenario_sale_subscription.rst', + tearDown=doctest_teardown, encoding='utf-8', + checker=doctest_checker, + optionflags=doctest.REPORT_ONLY_FIRST_FAILURE)) + return suite diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000000..08e43cf13a --- /dev/null +++ b/tox.ini @@ -0,0 +1,18 @@ +[tox] +envlist = {py27,py33,py34,py35}-{sqlite,postgresql,mysql},pypy-{sqlite,postgresql} + +[testenv] +commands = {envpython} setup.py test +deps = + {py27,py33,py34,py35}-postgresql: psycopg2 >= 2.5 + pypy-postgresql: psycopg2cffi >= 2.5 + mysql: MySQL-python + sqlite: sqlitebck +setenv = + sqlite: TRYTOND_DATABASE_URI={env:SQLITE_URI:sqlite://} + postgresql: TRYTOND_DATABASE_URI={env:POSTGRESQL_URI:postgresql://} + mysql: TRYTOND_DATABASE_URI={env:MYSQL_URI:mysql://} + sqlite: DB_NAME={env:SQLITE_NAME::memory:} + postgresql: DB_NAME={env:POSTGRESQL_NAME:test} + mysql: DB_NAME={env:MYSQL_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..c1db0a65a8 --- /dev/null +++ b/tryton.cfg @@ -0,0 +1,16 @@ +[tryton] +version=4.3.0 +depends: + account + account_invoice + company + currency + ir + product + res + sale +xml: + configuration.xml + recurrence.xml + service.xml + subscription.xml diff --git a/view/configuration_form.xml b/view/configuration_form.xml new file mode 100644 index 0000000000..1976dedbff --- /dev/null +++ b/view/configuration_form.xml @@ -0,0 +1,9 @@ + + + + + + diff --git a/view/create_invoice_start_form.xml b/view/create_invoice_start_form.xml new file mode 100644 index 0000000000..2f4c9b991c --- /dev/null +++ b/view/create_invoice_start_form.xml @@ -0,0 +1,10 @@ + + +
+ + + +
diff --git a/view/line_consumption_create_start_form.xml b/view/line_consumption_create_start_form.xml new file mode 100644 index 0000000000..d3ab462b46 --- /dev/null +++ b/view/line_consumption_create_start_form.xml @@ -0,0 +1,11 @@ + + +
+ + + +
diff --git a/view/recurrence_rule_form.xml b/view/recurrence_rule_form.xml new file mode 100644 index 0000000000..c265bd806b --- /dev/null +++ b/view/recurrence_rule_form.xml @@ -0,0 +1,29 @@ + + +
+