diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000000000000000000000000000000000000..3c3629e647f5ddf82548912e337bea9826b434af --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100755 index 0000000000000000000000000000000000000000..856c92566b84694fa204b31811c6a02f256c23e0 --- /dev/null +++ b/CODEOWNERS @@ -0,0 +1,2 @@ +# General code owners +* @konnectors/maintainers diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100755 index 0000000000000000000000000000000000000000..c9937347d2a9b941e9738bd6c45bcf0b260a7764 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,69 @@ +How to contribute to Cozy Connector? +==================================== + +Thank you for your interest in contributing to Cozy! There are many ways to contribute, and we appreciate all of them. + + +Security Issues +--------------- + +If you discover a security issue, please bring it to our attention right away! Please **DO NOT** file a public issue, instead send your report privately to security AT cozycloud DOT cc. + +Security reports are greatly appreciated and we will publicly thank you for it. We currently do not offer a paid security bounty program, but are not ruling it out in the future. + + +Bug Reports +----------- + +While bugs are unfortunate, they're a reality in software. We can't fix what we don't know about, so please report liberally. If you're not sure if something is a bug or not, feel free to file a bug anyway. + +Opening an issue is as easy as following [this link][issues] and filling out the fields. Here are some things you can write about your bug: + +- A short summary +- What did you try, step by step? +- What did you expect? +- What did happen instead? +- What is the version of the Cozy Connector? + + +Pull Requests +------------- + +Please keep in mind that: + +- Pull-Requests point to the `master` branch +- You need to cover your code and feature by tests +- You may add documentation in the `/docs` directory to explain your choices if needed +- We recommend to use [task lists][checkbox] to explain steps / features in your Pull-Request description +- You do __not__ need to build app to submit a PR + +### Workflow + +Pull requests are the primary mechanism we use to change Cozy. GitHub itself has some [great documentation][pr] on using the Pull Request feature. We use the _fork and pull_ model described there. + +- [ ] clone the repository with `git clone` +- [ ] add a remote to your profile with `git remote add fork` +- [ ] create a new branch for the work with `git checkout --branch my-branch origin/master` +- [ ] add some changes with `git add --patch .` +- [ ] create at least one commit with `git commit --message '{fix,feat,chore,test,doc}: a 70 character long description of the changes'` +- [ ] check styleguide, formating, linting and tests +- [ ] push to your remote with `git push fork my-branch` +- [ ] create a Pull-Request with a detailed description + + +Writing documentation +--------------------- + +Documentation improvements are very welcome. We try to keep a good documentation in the `/docs` folder. But, you know, we are developers, we can forget to document important stuff that look obvious to us. And documentation can always be improved. + + +Community +--------- + +You can help us by making our community even more vibrant. For example, you can write a blog post, take some videos, answer the questions on [the forum][forum], organize new meetups, and speak about what you like in Cozy! + + + +[issues]: ../../issues +[pr]: https://help.github.com/categories/collaborating-with-issues-and-pull-requests/ +[forum]: https://forum.cozy.io/ diff --git a/LICENSE b/LICENSE new file mode 100755 index 0000000000000000000000000000000000000000..dbbe3558157f5861bff35dcb37b328b679b0ccfd --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +<http://www.gnu.org/licenses/>. diff --git a/assets/icon.png b/assets/icon.png new file mode 100755 index 0000000000000000000000000000000000000000..534c6d405b346ffec12cbcd1c490f0a0604f9014 Binary files /dev/null and b/assets/icon.png differ diff --git a/bin/generate_travis_deploy_key b/bin/generate_travis_deploy_key new file mode 100755 index 0000000000000000000000000000000000000000..dcd7ce4206b35dcdae2a8bdaa6867d41a234b3bd --- /dev/null +++ b/bin/generate_travis_deploy_key @@ -0,0 +1,52 @@ +#!/bin/bash + +set -e + +if [ -z "$GITHUB_TOKEN" ]; then + echo "" + echo "GITHUB_TOKEN environment variable is missing" + echo "" + echo "TRAVIS DEPLOY KEY GENERATOR" + echo "" + echo "What it does : generate a new private and public key, add the public key as a deploy key + with write access to the origin remote github repository, encrypt the private key as + github_deploy_key.enc and add the configuration necessary to use it in .travis.yml file" + echo "" + echo "Use it like this:" + echo "" + echo " GITHUB_TOKEN=\`cat ~/secret/GITHUB_TOKEN\` ./generate_travis_deploy_key" + echo "" + echo "where ~/secret/GITHUB_TOKEN is a file containing a github token with write access to the current repository : (origin)" + echo "" + echo "You must have the travis executable installed on your system and available in the PATH" + echo "" + exit +fi + +url="$(git config --get remote.origin.url)" +owner="$(echo $url | cut -d: -f2 | cut -d/ -f1)" +reponame="$(echo $url | cut -d/ -f2 | cut -d. -f1)" + +# generate a new private and public key +ssh-keygen -t rsa -b 4096 -f github_deploy_key -N '' -C $url -q 1>/dev/null + +pubkey="$(cat github_deploy_key.pub)" + +# add the PUBLIC key to the github repository as a deploy key with write access +curl https://api.github.com/repos/$owner/$reponame/keys -H "Authorization: token $GITHUB_TOKEN" --data @- << EOF +{ + "title": "travis deploy key", + "key": "$pubkey", + "read_only": false +} +EOF + +# Synchronize Travis to get latest repo +travis sync --pro +# use travis to encrypt the private key as github_deploy_key.enc and remove the private key +travis encrypt-file github_deploy_key --pro --add --no-interactive -w /tmp/github_deploy_key -f +git add github_deploy_key.enc + +# cleaning +rm github_deploy_key +rm github_deploy_key.pub diff --git a/bin/generate_travis_deploy_key.ps1 b/bin/generate_travis_deploy_key.ps1 new file mode 100755 index 0000000000000000000000000000000000000000..9ba21d70f7851f5cdcf0568a49da77d16589c9e3 --- /dev/null +++ b/bin/generate_travis_deploy_key.ps1 @@ -0,0 +1,69 @@ +param([String]$github_token = $env:GITHUB_TOKEN) +$ErrorActionPreference = "Stop" + +function cut { + param( + [Parameter(ValueFromPipeline = $True)] [string]$inputobject, + [string]$delimiter, + [int]$fieldIndex + ) + + process { + return ($inputobject -split $delimiter)[$fieldIndex - 1] + } +} + +if (!$github_token) { + echo "" + echo "GITHUB_TOKEN environment variable is missing" + echo "" + echo "TRAVIS DEPLOY KEY GENERATOR" + echo "" + echo "What it does : generate a new private and public key, add the public key as a deploy key +with write access to the origin remote github repository, encrypt the private key as +github_deploy_key.enc and add the configuration necessary to use it in .travis.yml file" + echo "" + echo "Use it like this:" + echo "" + echo " $env:GITHUB_TOKEN=""GITHUB_TOKEN""" + echo " .\generate_travis_deploy_key.ps1" + echo "" + echo "Or like this:" + echo "" + echo " .\generate_travis_deploy_key.ps1 ""GITHUB_TOKEN""" + echo "" + echo "where ""GITHUB_TOKEN"" is a github token with write access to the current repository : (origin)" + echo "" + echo "You must have the travis executable installed on your system and available in the PATH" + echo "" + echo "You also must be authenticated on travis cli (travis login --auto)" + echo "" + exit +} + +$url = "$(git config --get remote.origin.url)" +$owner = "$(echo $url | cut -d / -f 4)" +$reponame = "$(echo $url | cut -d / -f 5 | cut -d \. -f 1)" + +# generate a new private and public key +ssh-keygen -t rsa -b 4096 -f github_deploy_key -N System.String -C "$url" -q + +$pubkey = "$(cat github_deploy_key.pub)" + +# add the PUBLIC key to the github repository as a deploy key with write access +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +curl https://api.github.com/repos/$owner/$reponame/keys -H @{"Authorization" = "token $github_token"} -Method "POST" -Body @" +{ + "title": "travis deploy key", + "key": "$pubkey", + "read_only": false +} +"@ + +# use travis to encrypt the private key as github_deploy_key.enc and remove the private key +travis encrypt-file github_deploy_key --pro --add --no-interactive -w /tmp/github_deploy_key -f +git add github_deploy_key.enc + +# cleaning +rm github_deploy_key +rm github_deploy_key.pub diff --git a/github_deploy_key.enc b/github_deploy_key.enc new file mode 100755 index 0000000000000000000000000000000000000000..77d5c89b98c0e374a78c13cdb069152e935957e5 Binary files /dev/null and b/github_deploy_key.enc differ diff --git a/konnector-dev-config.json b/konnector-dev-config.json new file mode 100755 index 0000000000000000000000000000000000000000..5258d6ff3c610b18fe8e5cd85348714d893b5cdb --- /dev/null +++ b/konnector-dev-config.json @@ -0,0 +1,7 @@ +{ + "COZY_URL": "http://cozy.tools:8080", + "fields": { + "login": "grdf_adict_bas", + "password": "wGe0MW13k" + } +} \ No newline at end of file diff --git a/manifest.konnector b/manifest.konnector new file mode 100755 index 0000000000000000000000000000000000000000..daba285ddd66e6c8d9ab0d7a94fd5c84295876b9 --- /dev/null +++ b/manifest.konnector @@ -0,0 +1,89 @@ +{ + "version": "1.0.0", + "name": "Connector template", + "type": "konnector", + "language": "node", + "icon": "icon.png", + "slug": "template", + "source": "git@github.com:konnectors/template.git", + "editor": "Cozy", + "vendor_link": "Link to the target website", + "categories": ["others"], + "fields": { + "login": { + "type": "text" + }, + "password": { + "type": "password" + }, + "advancedFields": { + "folderPath": { + "advanced": true, + "isRequired": false + } + } + }, + "data_types": [ + "bill" + ], + "screenshots": [], + "permissions": { + "bank operations": { + "type": "io.cozy.bank.operations" + }, + "bills": { + "type": "io.cozy.bills" + }, + "files": { + "type": "io.cozy.files" + }, + "accounts": { + "type": "io.cozy.accounts" + } + }, + "developer": { + "name": "Cozy Cloud", + "url": "https://cozy.io" + }, + "langs": ["fr", "en"], + "locales": { + "fr": { + "short_description": "Récupère la liste de livres", + "long_description": "Récupère la liste de livre sur le site exemple", + "permissions": { + "bank operations": { + "description": "Utilisé pour relier les factures à des operations bancaires" + }, + "bills": { + "description": "Utilisé pour sauver les données des factures" + }, + "files": { + "description": "Utilisé pour sauvegarder les factures" + }, + "accounts": { + "description": "Utilisé pour obtenir les données du compte" + } + } + }, + "en": { + "short_description": "Fetch a list of books", + "long_description": "Fetch a list of books from the example website", + "permissions": { + "bank operations": { + "description": "Required to link bank operations to bills" + }, + "bills": { + "description": "Required to save the bills data" + }, + "files": { + "description": "Required to save the bills" + }, + "accounts": { + "description": "Required to get the account's data" + } + } + } + }, + "banksTransactionRegExp": "\\bbooks\\b", + "manifest_version": "2" +} diff --git a/package.json b/package.json new file mode 100755 index 0000000000000000000000000000000000000000..3156d7b446e9c3f731a4cdfdeffa41551b525f04 --- /dev/null +++ b/package.json @@ -0,0 +1,56 @@ +{ + "name": "cozy-konnector-template", + "version": "1.0.0", + "description": "", + "repository": { + "type": "git", + "url": "git@github.com:konnectors/template.git" + }, + "keywords": [], + "author": "Cozy Cloud", + "license": "AGPL-3.0", + "main": "./src/index.js", + "eslintConfig": { + "extends": [ + "cozy-app" + ] + }, + "eslintIgnore": [ + "build", + "data" + ], + "husky": { + "hooks": { + "pre-commit": "yarn lint" + } + }, + "scripts": { + "start": "node ./src/index.js", + "dev": "cozy-konnector-dev", + "standalone": "cozy-konnector-standalone", + "pretest": "npm run clean", + "clean": "rm -rf ./data", + "build": "webpack", + "lint": "eslint --fix .", + "deploy": "git-directory-deploy --directory build/ --branch ${DEPLOY_BRANCH:-build} --repo=${DEPLOY_REPOSITORY:-$npm_package_repository_url}", + "cozyPublish": "cozy-app-publish --token $REGISTRY_TOKEN --build-commit $(git rev-parse ${DEPLOY_BRANCH:-build})", + "travisDeployKey": "./bin/generate_travis_deploy_key" + }, + "dependencies": { + "axios": "^0.20.0", + "cozy-konnector-libs": "4.34.5", + "moment": "^2.29.0", + "moment-timezone": "^0.5.31" + }, + "devDependencies": { + "copy-webpack-plugin": "6.1.1", + "cozy-app-publish": "0.25.0", + "cozy-jobs-cli": "1.13.6", + "eslint-config-cozy-app": "1.6.0", + "git-directory-deploy": "1.5.1", + "husky": "4.3.0", + "svgo": "1.3.2", + "webpack": "4.44.2", + "webpack-cli": "3.3.12" + } +} diff --git a/src/index.js b/src/index.js new file mode 100755 index 0000000000000000000000000000000000000000..b3aec27996a08a1d7d9e188748b8075cbbbbaaf5 --- /dev/null +++ b/src/index.js @@ -0,0 +1,398 @@ +const { + BaseKonnector, + addData, + hydrateAndFilter, + log, + utils +} = require('cozy-konnector-libs') +const axios = require('axios'); +const https = require("https"); //optional for ssl issue + +const moment = require('moment') +require('moment-timezone') + +moment.locale('fr') // set the language +moment.tz.setDefault('Europe/Paris') // set the timezone + +const startDate = moment() + .startOf('year') + .subtract(3, 'year') + .subtract(1, 'day') + .format('MM/DD/YYYY') +const endDate = moment().format('MM/DD/YYYY') +const timeRange = ['day', 'month', 'year'] +const rangeDate = { + day: { + doctype: 'com.grandlyon.grdf.day', + keys: ['year', 'month', 'day'] + }, + month: { + doctype: 'com.grandlyon.grdf.month', + keys: ['year', 'month'] + }, + year: { + doctype: 'com.grandlyon.grdf.year', + keys: ['year'] + } +} + + +module.exports = new BaseKonnector(start) + +// The start function is run by the BaseKonnector instance only when it got all the account +// information (fields). When you run this connector yourself in "standalone" mode or "dev" mode, +// the account information come from ./konnector-dev-config.json file +// cozyParameters are static parameters, independents from the account. Most often, it can be a +// secret api key. +async function start(fields, cozyParameters) { + log('info', 'Authenticating ...') + if (cozyParameters) log('debug', 'Found COZY_PARAMETERS') + const grdfToken = await authenticate(fields.login, fields.password) + log('info', 'Successfully logged in') + + //Get the PCE of the client + log('info', 'Retrieve the PCE') + const grdfPCE = await getPCE(grdfToken) + // The BaseKonnector instance expects a Promise as return of the function + log('info', 'Fetching the data') + const periodeValeur = '' //TO REPLACE + const grdfData = await getData(grdfToken, grdfPCE, periodeValeur) + + if (grdfData && grdfData.length > 0) { + log('info', 'Process grdf daily data') + const processedLoadData = await processData( + grdfData, + 'com.grandlyon.grdf.day', + ['year', 'month', 'day'] + ) + log('info', 'Agregate grdf load data for month and year') + await agregateMonthAndYearData(processedLoadData) + } else { + log('info', 'No consent or data for load curve') + } + // Here we use the saveBills function even if what we fetch are not bills, + // but this is the most common case in connectors + log('info', 'Saving data to Cozy') + +} + +// This shows authentication using the [signin function](https://github.com/konnectors/libs/blob/master/packages/cozy-konnector-libs/docs/api.md#module_signin) +// even if this in another domain here, but it works as an example +async function authenticate(username, password) { + var myHeaders = new Headers(); + myHeaders.append("Content-Type", "application/x-www-form-urlencoded"); + + var urlencoded = new URLSearchParams(); + urlencoded.append("grant_type", "client_credentials"); + urlencoded.append("client_id", username); + urlencoded.append("client_secret", password); + urlencoded.append("scope", "/adict/bas/v1"); + +//optional for ssl issue + const agent = new https.Agent({ + rejectUnauthorized: false + }) + + var requestOptions = { + method: 'POST', + headers: myHeaders, + body: urlencoded, + redirect: 'follow', + agent + }; + + const rep = await fetch("https://sofit-sso-oidc.grdf.fr/openam/oauth2/realms/externeGrdf/access_token", requestOptions).then(response => response.text()) + .then(result => { + result = JSON.parse(result) + console.log(result.access_token) + return result.access_token + }) + .catch(error => { + throw new Error(error.message) + + }); + return rep +} +async function getPCE(token){ + var myHeaders = new Headers(); + myHeaders.append("Content-Type", "application/json"); + myHeaders.append("Authorization", "Bearer " + token); + + var urlencoded = new URLSearchParams(); + + var requestOptions = { + method: 'GET', + headers: myHeaders, + body: urlencoded, + redirect: 'follow' + }; + + const rep = await fetch("https://api.grdf.fr/adict/bas/v2/droits_acces", requestOptions) + .then(response => response.text()) + .then(result => { + result = JSON.parse(result) + //const accesClient = JSON.parse(result.liste_acces) + console.log(result.liste_acces[0].id_pce) + return result.liste_acces[0].id_pce + }) + .catch(error => console.log('error', error)); + return rep + } +//Retrieve data from grdf API +async function getData(token, idPCE, periodeValeur){ + //LOG USE TO GET SOME DATA IN TEST MOD + periodeValeur = 2018; + idPCE = 11300000000002; + //REPLACE FOR PROD + + var myHeaders = new Headers(); + myHeaders.append("Content-Type", "application/json"); + myHeaders.append("Authorization", "Bearer " + token); + + var requestOptions = { + method: 'GET', + headers: myHeaders, + redirect: 'follow' + }; + var urlFinal = periodeValeur.length == 0 ? "date_debut="+ startDate +"&date_fin=" + endDate : "periode="+ periodeValeur; + var url = "https://api.grdf.fr/adict/bas/v2/pce/"+ idPCE +"/donnees_consos_publiees?" + urlFinal; + const rep = await fetch(url, requestOptions) + .then(response => response.text()) + .then(result => { + console.log(result) + return result + }) + + .catch(error => console.log('error', error)); + return rep; +} + +/** + * Parse data + * Remove existing data from DB using hydrateAndFilter + * Store filtered data + * Return the list of filtered data + */ +async function processData(data, doctype, filterKeys) { + const parsedData = JSON.parse(data) + console.log("parsedData") + console.log(parsedData) + const intervalData = parsedData.consommation + console.log("intervalData") + console.log(intervalData) + const formatedData = await formateData(intervalData, doctype) + // Remove data for existing days into the DB + const filteredData = await hydrateAndFilter(formatedData, doctype, { + keys: filterKeys + }) + // Store new day data + await storeData(filteredData, doctype, filterKeys) + return filteredData +} + +/** + * Save data in the right doctype db and prevent duplicated keys + */ +async function storeData(data, doctype, filterKeys) { + log('debug', doctype, 'Store into') + const filteredDocuments = await hydrateAndFilter(data, doctype, { + keys: filterKeys + }) + return await addData(filteredDocuments, doctype) +} + +/** + * Format data for DB storage + * Remove bad data + */ +async function formateData(data, doctype) { + log('info', 'Formating data') + + return data.map(record => { + let date = moment(record.date, 'YYYY/MM/DD h:mm:ss') + if (record.value != -2) { + const load = + doctype === 'com.grandlyon.grdf.minute' + ? record.value / 2 + : record.value + if (doctype === 'com.grandlyon.grdf.minute') { + date = date.subtract(30, 'minute') + } + return { + load: parseFloat(load / 1000), + year: parseInt(date.format('YYYY')), + month: parseInt(date.format('M')), + day: parseInt(date.format('D')), + hour: parseInt(date.format('H')), + minute: parseInt(date.format('m')) + } + } + }) +} + +/** + * Agregate data from load data (every 30 min) to Hourly data + */ +async function agregateHourlyData(data) { + // Sum year and month values into object with year or year-month as keys + if (data && data.length > 0) { + let hourData = {} + data.forEach(element => { + let key = + element.year + + '-' + + element.month + + '-' + + element.day + + '-' + + element.hour + key in hourData + ? (hourData[key] += element.load) + : (hourData[key] = element.load) + }) + // Agregation for Month data + const agregatedMonthData = await buildAgregatedData( + hourData, + 'com.grandlyon.grdf.hour' + ) + await storeData(agregatedMonthData, 'com.grandlyon.grdf.hour', [ + 'year', + 'month', + 'day', + 'hour' + ]) + } +} +/** + * Agregate data from daily data to monthly and yearly data + */ +async function agregateMonthAndYearData(data) { + // Sum year and month values into object with year or year-month as keys + if (data && data.length > 0) { + let monthData = {} + let yearData = {} + data.forEach(element => { + element.year + '-' + element.month in monthData + ? (monthData[element.year + '-' + element.month] += element.load) + : (monthData[element.year + '-' + element.month] = element.load) + element.year in yearData + ? (yearData[element.year] += element.load) + : (yearData[element.year] = element.load) + }) + // Agregation for Month data + const agregatedMonthData = await buildAgregatedData( + monthData, + 'com.grandlyon.enedis.month' + ) + await storeData(agregatedMonthData, 'com.grandlyon.enedis.month', [ + 'year', + 'month' + ]) + // Agregation for Year data + const agregatedYearData = await buildAgregatedData( + yearData, + 'com.grandlyon.enedis.year' + ) + await storeData(agregatedYearData, 'com.grandlyon.enedis.year', ['year']) + } +} + + + +/** + * Retrieve and remove old data for a specific doctype + * Return an Array of agregated data + */ +async function buildAgregatedData(data, doctype) { + let agregatedData = [] + for (let [key, value] of Object.entries(data)) { + const data = await buildDataFromKey(doctype, key, value) + const oldValue = await resetInProgressAggregatedData(data, doctype) + data.load += oldValue + agregatedData.push(data) + } + return agregatedData +} + +/** + * Format an entry for DB storage + * using key and value + * For year doctype: key = "YYYY" + * For month doctype: key = "YYYY-MM" + */ +async function buildDataFromKey(doctype, key, value) { + let year, month, day, hour + if (doctype === 'com.grandlyon.grdf.year') { + year = key + month = 1 + day = 0 + hour = 0 + } else if (doctype === 'com.grandlyon.grdf.month') { + const split = key.split('-') + year = split[0] + month = split[1] + day = 0 + hour = 0 + } else { + const split = key.split('-') + year = split[0] + month = split[1] + day = split[2] + hour = split[3] + } + return { + load: Math.round(value * 10000) / 10000, + year: parseInt(year), + month: parseInt(month), + day: parseInt(day), + hour: parseInt(hour), + minute: 0 + } +} + +/** + * Function handling special case. + * The temporary aggregated data need to be remove in order for the most recent one te be saved. + * ex for com.grandlyon.grdf.year : + * { load: 76.712, year: 2020, ... } need to be replace by + * { load: 82.212, year: 2020, ... } after grdf data reprocess + */ +async function resetInProgressAggregatedData(data, doctype) { + // /!\ Warning: cannot use mongo queries because not supported for dev by cozy-konnectors-libs + log('debug', doctype, 'Remove aggregated data for') + const result = await cozyClient.data.findAll(doctype) + if (result && result.length > 0) { + // Filter data to remove + var filtered = [] + if (doctype === 'com.grandlyon.grdf.year') { + // Yearly case + filtered = result.filter(function(el) { + return el.year == data.year + }) + } else if (doctype === 'com.grandlyon.grdf.month') { + // Monthly case + filtered = result.filter(function(el) { + return el.year == data.year && el.month == data.month + }) + } else { + // Hourly case + filtered = result.filter(function(el) { + return ( + el.year == data.year && + el.month == data.month && + el.day == data.day && + el.hour == data.hour + ) + }) + } + // Remove data + let sum = 0.0 + for (const doc of filtered) { + sum += doc.load + log('debug', doc, 'Removing this entry for ' + doctype) + await cozyClient.data.delete(doctype, doc) + } + return sum + } + return 0.0 +} diff --git a/src/zombie.js b/src/zombie.js new file mode 100755 index 0000000000000000000000000000000000000000..19ac544b99aff4cbaddfcaf1524feacf75e0e152 --- /dev/null +++ b/src/zombie.js @@ -0,0 +1,115 @@ +const { + BaseKonnector, + scrape, + saveBills, + log, + utils, + errors +} = require('cozy-konnector-libs') + +const Browser = require('cozy-konnector-libs/dist/libs/CozyBrowser') +const browser = new Browser() +const cheerio = require('cheerio') + +const VENDOR = 'template' +const baseUrl = 'http://books.toscrape.com' + +module.exports = new BaseKonnector(start) + +// The start function is run by the BaseKonnector instance only when it got all the account +// information (fields). When you run this connector yourself in "standalone" mode or "dev" mode, +// the account information come from ./konnector-dev-config.json file +// cozyParameters are static parameters, independents from the account. Most often, it can be a +// secret api key. +async function start(fields, cozyParameters) { + log('info', 'Authenticating ...') + if (cozyParameters) log('debug', 'Found COZY_PARAMETERS') + await authenticate(fields.login, fields.password) + log('info', 'Successfully logged in') + + log('info', 'Fetching the list of documents') + await browser.visit(`${baseUrl}/index.html`) + + const $ = cheerio.load(browser.html()) + log('info', 'Parsing list of documents') + const documents = await parseDocuments($) + + // Here we use the saveBills function even if what we fetch are not bills, + // but this is the most common case in connectors + log('info', 'Saving data to Cozy') + await saveBills(documents, fields, { + // This is a bank identifier which will be used to link bills to bank operations. These + // identifiers should be at least a word found in the title of a bank operation related to this + // bill. It is not case sensitive. + identifiers: ['books'], + sourceAccount: this.accountId, + sourceAccountIdentifier: fields.login + }) +} + +// This shows authentication using the [signin function](https://github.com/konnectors/libs/blob/master/packages/cozy-konnector-libs/docs/api.md#module_signin) +// even if this in another domain here, but it works as an example +async function authenticate(username, password) { + await browser.visit('http://quotes.toscrape.com/login') + await browser.fill('#username', username) + await browser.fill('#password', password) + await browser.pressButton(`[type=submit]`) + + if ( + !browser.redirected || + browser.location._url !== 'http://quotes.toscrape.com/' + ) { + log('error', browser.query('.error').innerHTML) + throw new Error(errors.LOGIN_FAILED) + } +} + +// The goal of this function is to parse a HTML page wrapped by a cheerio instance +// and return an array of JS objects which will be saved to the cozy by saveBills +// (https://github.com/konnectors/libs/blob/master/packages/cozy-konnector-libs/docs/api.md#savebills) +function parseDocuments($) { + // You can find documentation about the scrape function here: + // https://github.com/konnectors/libs/blob/master/packages/cozy-konnector-libs/docs/api.md#scrape + const docs = scrape( + $, + { + title: { + sel: 'h3 a', + attr: 'title' + }, + amount: { + sel: '.price_color', + parse: normalizePrice + }, + fileurl: { + sel: 'img', + attr: 'src', + parse: src => `${baseUrl}/${src}` + } + }, + 'article' + ) + return docs.map(doc => ({ + ...doc, + // The saveBills function needs a date field + // even if it is a little artificial here (these are not real bills) + date: new Date(), + currency: 'EUR', + filename: `${utils.formatDate(new Date())}_${VENDOR}_${doc.amount.toFixed( + 2 + )}EUR${doc.vendorRef ? '_' + doc.vendorRef : ''}.jpg`, + vendor: VENDOR, + metadata: { + // It can be interesting to add the date of import. This is not mandatory but may be + // useful for debugging or data migration + importDate: new Date(), + // Document version, useful for migration after change of document structure + version: 1 + } + })) +} + +// Convert a price string to a float +function normalizePrice(price) { + return parseFloat(price.replace('£', '').trim()) +}