From 1bad96629ee3f002b05d2a753790dc0fa308cf9e Mon Sep 17 00:00:00 2001 From: rpapin <rpapin@grandlyon.com> Date: Mon, 28 Sep 2020 10:12:01 +0200 Subject: [PATCH] Init Project --- .gitignore | 1 + CODEOWNERS | 2 + CONTRIBUTING.md | 69 +++ LICENSE | 661 +++++++++++++++++++++++++++++ assets/icon.png | Bin 0 -> 12212 bytes bin/generate_travis_deploy_key | 52 +++ bin/generate_travis_deploy_key.ps1 | 69 +++ data/importedData.json | 12 + github_deploy_key.enc | Bin 0 -> 3248 bytes konnector-dev-config.json | 7 + manifest.konnector | 89 ++++ package.json | 56 +++ src/index.js | 398 +++++++++++++++++ src/zombie.js | 115 +++++ 14 files changed, 1531 insertions(+) create mode 100644 .gitignore create mode 100755 CODEOWNERS create mode 100755 CONTRIBUTING.md create mode 100755 LICENSE create mode 100755 assets/icon.png create mode 100755 bin/generate_travis_deploy_key create mode 100755 bin/generate_travis_deploy_key.ps1 create mode 100644 data/importedData.json create mode 100755 github_deploy_key.enc create mode 100755 konnector-dev-config.json create mode 100755 manifest.konnector create mode 100755 package.json create mode 100755 src/index.js create mode 100755 src/zombie.js diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/CODEOWNERS b/CODEOWNERS new file mode 100755 index 0000000..856c925 --- /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 0000000..c993734 --- /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 0000000..dbbe355 --- /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 GIT binary patch literal 12212 zcmeAS@N?(olHy`uVBq!ia0y~yU^oH79Bd2>3~M9S&0}EDul96t45^s&W-fb#Nci{v z=VK2ziAM;eWKP_+fGLPYP@sDGjYWYMGJJfJa`s0EN4wN64ixrP61!sJs##VmD(2#- zz~#lhwE2?A2IV(@?YV#b>kXVabMDQVt$%I!&%ggWbLaPYcWv+Q{40|hpitZrrYE(I z&w0;TR;Td%^8f!h6patu5Ks)5`lr0-A*Vu#cyf%)e37YvG4qO5E#C&!l-0d*-j@45 zM`0W93!k1st}7frUws$leWg2}vBB)*qpwl@Q|kU^y?2j(w9e&<amu15^MIt=4d)tm zZtT5u$iM8&Ov7B)FQ4@)R2WJY2l#G(9=l<A|L*@e#=*DUkEU8?e(l{lgRxk2Pun8) zL<#xx4$WV=`R6jT^qGXu-IkYqVaALl9lK4guYO=EV$0EdX4alV#TSp;&vE3)kz8@_ z!tKNM4oXwLtZ5NqdlkMwfTNhjKhCh`+mz7h0!*^YZaFa6%DiP~Wqk1D%Np(S8ClDX z7YlGOv-n57G^#$eD!IYIneD8iyY>1+3CEhMFsG$Fw_b;6us9j-Ti0kSUb{<|Rp8Rp z$i*C2WZ$y+YU-Z0jtH6e*(2?38B;}$^o5Hv{(n67mcgUDb(yLCY}L$Y#<?0*0#ZL~ zu02c4<8$7=;p)CwtCsCuwJR(s>()}IZ8<M8G^SN%syzGgI9Q9LKlL)(na6X#eG8X8 zzKmCvv(-W4z;#2XZ)SPN%%<h}*?#Sr^JYz~?9W|$-v}shZ_CYQeSGNE@2NK<D^E(6 zZk=kL_f&m(s;G+iwJTv-W@4U;1UNX;eB)l4JU)EYc*>DSog4>d<W_qG-8=MH*8b1+ zwhtRV_<H6@E9+~pe3E11|8iL{YFBT;Yx9~FGds7kGu+saE1dY@cU^2uM8quF`Blbd zYTEiwlVXBGw&wIsmKR~FWG+rt{Pgj|XO4M$k_??rtQTJMC9&t@%jSo(>w0!e2}XxZ zR8PCDptn$fgFzx&s=0mp{MRb`BO8C+3Y#pTP`oWSiMgjRFeWG@BrNXKNAJ#yp5Nb3 z-<&J-x+JTyr-0Ak<A-mvA3l~dkW_qedYkPWCg*J$ny>sXZe3yjc%7Tr#$3MW60b&{ zvhU_GyFc`YdPLf=Gwj-w%fJ1gudc3F`?dV}`{JgETz$D~il6EP&*c3Da^@y4yp0=k z85mY<&h4*hloy@))NSt0l7jLdFYlhriB{IOYITr#YZEGV?&iLOcaD5}eeTmtNfz;` zPv6`S+*MH-Rpumo`<Q`mdzqMVvh>%dpX>jfx^}CSk?BJE?RkAHY&G`U>ZQ-?zn!@s z88hwnfo--v7ZX`GrJa0O=xoEp7rf*5+6I}g8$Bm(zMeN%^5`~2p9>GK{ZQ}!d+6`0 zkH??4?_hU1?ISbyH$(fj_0<PHu0Ae5f40rHZpIvGXLH$SChKQzTzhKQ()R1V68}Ed z^&H@uz*Bvk?>4_MTO!NeSlRY-MH{5A*gikkdz!a*t8CKYjm{h?uWsneZqwuKzxF=! z*Fv7^qr0zeo%(#zW&O4|oAQd{|NoqA86C=|FS*Cw_UFQ0?PKP4`DX&&ulpL{8|uvN zptfDQvhCNhdBSdIr2oFTc=*YhrYTyITTW^e{e34Kwfn>L+HaqwiW}d?FuXXFkt{JU z<i5W3^r_Q}9H&Ug%1;-W`u|sb+~ywv4<<A=9+%wOsIcfrM`!jnR@XiM^6lO+iZ$P5 z+Vdti*8RiRo?}LP&-60R>hdoBmjAQ#->f%#u1KlfP7>NF>QV3@YxT{`)8;ca+~YA1 zt*}+Ddw%kBb-j3O_rCw@+V||;oA|fMc)Q>McAndp`F@-;_dfQmPrtAJx$r)@##xWu z&&_+M^5vJk!x_2N2PL?^yXVMN{#gH>Yer7H<`X{!H8rO%ACElsuCZY<Q*hB_h~AyR zV;cGMq~J;Or2hG$vU_5J!#_58?3^q8c$&p6i~Q6>YKxXU{kQka>QKAe9X6-0zg=o{ zth{ac>c<;Se!G^}IH^AA#G3R)t0%7JZ_oet(64e^jBe(MsSam)azpsv|M<<Jknrl* zoyC(L-Qm5>r}szE_OX}o%|mHSx8JpwEeTU-kUKNuI-i97jGZU8h8ISj3*O`^`_^`f z82kS%2d><y(q+gnN|v89bLWLhufocA$!@RG8FtQG!tNiH_WkIZ|1K+5X7VlEo!9em zZu0VSU2EC@pWo=(>kHjot+#XwQ}F$W+c|0*Ds%KU$og*Yb?NZ!`epU&&pj8d)c2v& zAFlY{7ALIg`tQb<N0k%jZk^4$sQMyf<5h?07oB&PU*1(_Z0)G`Zovsxej%I6qZe)l zhs|YXs9Jn6xnjn&sT&f1-*dI@K3$w?X_lC%(Xt^{bGbl6&iiG_7Pi?7UsvpEGgx-a zEOy$NzYn?DtJmi<HoVi&)j!miCnGAhPqXb=Rc8BVrl03u-EZG%>1WaQf_G_fbm)ZL z)o&YrE{y!CxrII2*m&E^ZC_`<$f&h_ELd{=ui2{X)A~AhA3P6_nfJTr-LAK5VtB9V z{;u4&Z`)TJh7^bJy%Gh^m%a*5p4MJdGI5>N%!bQMH#fe!!=nD%(LK|4Qs2dwrqRpK z3&(b+nQ$$fdBE-Qg}y5iEGJq|mN6XuI<tFDZTIOS>6tmlZtGr1_<Oy*&W(Z5B<#12 zt#RV1Cey`!mm<{H7JOTAa+hkmxW!HWt|k65J6^1xyxXnHH$?jQ77G=T=}+x=qFy`- z{kq_j__A9oR<7llyYs}&$(e;79sYeQKJkU{+f=1p_c-7XerIhS-?!#P*K{rai28oL z$oITTU|*ho@7nt=@6E(-oLjK+lvZHUlX}0HTYH}$JDU;~=HIk@O@Z`l={<4r>#rAB zy;{9ax8Jh(<%Lxnl4nQkoPO~7+pB*+N6vosa~Hb~bHlunE0H17KHt8?TNi)rN@&5W z6ocg~kKVrJ-TZf(+pO6)eq9cfKlbC<EqOaBZ7-XHzkDr{lNI0mc(h&ri|$(IB^KX4 z?pR@z|8$kEah;C-`DHhqKJmysP>=Xtzke>9!<LwEJ*~5yHUfK14D9~hojqq$n=#YF z*WWJP`Q=+Oqw;pHeP(5yw!Ui0>+|#Twe-#_ZaJy0eXNHg#Qg0`n`2w=e+U#?b}jF1 zyU?Ll*Hp{!pi4>TMDG9o{bnY&;2bW$T(u3M|I$9bOP!{+?*0Ws89lAjoiV!(>hD;# zu1WZ(grs=K_TBSm?R0p-)u0>r`eX5u7RKw$3xawIZ!Juo9rc{Ky=;lxvgC+X##8+A zw{3F%PkdjL`ICXixcXF4ZqGz!hKPM-Hv8q6MHJ-x_^mfZ>U|Pq^N&-TWBYXWX9k4{ z+w@KrXlE=u?Q`-!->fZ%I2507H24ZA<TBi8VpRDT91t>XuF!muvoAKxENirwwY&87 z^GB~AzcNVa+545DoZ-diea$Tr1)@wR7#-{`ZTri#xLA5y?U%}!ppfOghYqUUd-pHx zzTVH;>0F1Bm#pPZF62>|Ct9`sL4h$tO8V2~F@Ao#OP-}=<-|k<8m;xdyM^<}l@N~C z%iet0T=4Y<6UUkttEOwXrrx~Iu3Pdq>e^eaALi}bmgiMg{*S*Va_@w9%%<A&hh9t) zs(O~OMaFcdX=dwfamU&G645u;GO7Hw7UY+||F`bnsfnlO**rb6Ve94MufJx_xVTUF z>aMbjA0`xDw&nTC5^Vds|5H%#)f4{bcPV{+)DvRM5x;%<sq?d4?ImAGoSl44Kr7+E z(nNRXH2Epb%G`4&Motdr<DIwZ5d)LT*F7y<TenVK_&JR4-=<~jnm!pSt*n|5Z+7%g z#+}QLj5A+NXliHg&--L6aqe7PL(@0U^IjS(4&t(J+0Ul@ak?EH5PJ2+`&;=M_P-9@ zGY)yZKt;gw{6}w(H+sdw4{KKOdb7GkviH@Re@XbUOeXABxWkMuYg%53@f`nsyZR>+ z_rmE_86W4?+We`G^R=!1c=B?)Zp!Ikp%e3X3*%?cys5K1Xd2t9Z|(V#H5xW96Te0H z?U*^YVE*x7tG5ZyEoB+5q}<)-qVkUK@O-y<{Cl0Y>0~y7nwV#gU#{1eHq13_I`ns9 zv<<)f%>b>}+eAIwqn<rw>zUeTb*s{kLFG4hYE)F!I*CNVo1NAx4|k;<GrODa8!4)~ zm_zbEQ{tV+VO4Wta^`6MFn@V-5u4eOk3zjSCx^Su;LO=QS<}T!!F%72P^0GtD!Ed* z3*@Z#TgxANemeS_F{_o;u?@wKTMZIkTNP=ac=1}lUePpPO-CR<KmSGc%QM%yuKssO zk}<exd!jSfT4ciG!wm}RSDIe#@pj^@=6-&D&)Gek_WltH&A-pjJ5lE`+w2Y755MHw zY^+ZNqJH?L-);*NsCgi5VLjo+;}(`h%adE!_<49Ho-&ZyxVh~2g+0?v)Ag%0f2c1z zcFm?bdprNlZI4Cm<Qf%!S-G{Co#eEfxp(Vr_7!ipXsSCfxY;o?|K6P2&XmOSjibbI z&AHhBoJ<>pqIL_O%Jlb8aMBh(XZiR+qi~9}sS9Ij&7HqX?CyG-mt8wjGi!na&zBxc z!|xTc!O4o74+@A}XxrJT`@BxOHa5x5*W_G?{>w89<yk!HCjHva7Ju36q{Ho7Obn5? zX7>p*ESRT1-OiN3;px+4eTEOt3||-w_RWs0S|!6E9&+`$=rxmPlkM~lnsFSMmMeXa zNpZfKmVlnxo+oar7@1~#w4JKUbN4v!%grTh3KDz`9<tkCB%3|F`oD%xA}Rl_weYN( z?EfzxNqu@4c$4wvhTMbE3R`aahA3!Vx_OABhh^O|?#6kW|2fRAWK^q}elaS`ZJ)_p z$5&h&ZeLAhlz&#=`LM)j+ZMH_IiBZkPWIe-rrl@~lit6umYVr196Z>ar!n>%Z(7te z_oT()mGgdI`&6OP@$hq2R@5rD$G>L$^88oUBi1g*=Rae!-QqVYuLWc7IVrPO*Erev zmgqlhEZJtj`0R@G<$EPH=l$L0+%q_v9WU44Za48`;<<G;a%bkg+NxiDuVb@fS<}ZY ztsG04&uqN^O0}hCRs?@j;l3@`F7O@l%$cpQus<Q^{K-QT@+<$$D~^!wQo3O9(0cuh zXM6KA|9-A!Kc~L_)`Y;SRZXF@Rq_)JV-D}R_CQvqX@<Y>D@Pa4i!+06I~ymun;qYj zd)Vasg^$5|`R_dZSY3B)m&L!%uCnX%J};|!t3TtBs8wTbGM~)jds8z4l?>;rsZ4lv z>r)BCgP=>3(~mB_`TS<q9hdd{?}aA|m))HCQ<j+_blV#RhwuB;g!^<Q%72D4?zhh_ zZaB2*+WoF?Cq4&#Sh4Kv^4qNw95!(W&F|Rw!++)3MVvh!MK5m62vd9cj7`q=S+C9a z_}bjp=Wp&v_mx|cv>??u|6a#t@v~oTQzo1L<9#%Fk@OLX_|(O3w>LWeNe^?>T06Of z!+!tM_HDd6-#mB8$R2guEq|-6;+&*dEjNSA&5U>{0fpn1hZk>Fi*DmdTKqTr<;96P zTYihhwaDMwH21~f7S>On_x0}7H`wKHQ|DJjm6ho){z&sz$=gp|+4p~rF@wVS?OS_( z?K*2|e57#U%r(+>vX_6&ww+kIJO5J8#n!v(W<q@4-mgyl*ciOKEND}g8<*E-u{h7J z37H*#1j|;l9F`HAlcuwCDUTzAlygq_oKG7gbCph)sqT+-%)FNrx$URfA^*QFr`kQ) z`>b~umriZn__jRd^hL+e+@BLYKj)-Wtxs5TvgW#DT=x0R)uB@aUkU52mo41)<+(_t zS(T2-cYWsA$16AGd=_m@y}7zsd{>@Ia9dEy(U!&i=aW-)CjY5ke{sjV-wLm1WD9;z zxw>HIKZmRR?e2G781|-KUFLJ}$G3al|7yEe3#FC?9lCD1;rXpp_Tt8Sb0)uC)N-+& z-7iG>?dB<YPir?nUVPp#Vdl}Lha^@V>TBVdxYXiJNbJ?;Jsnop6OSq~F1%OV<`#b; z#B|cl#49(ZbX2qV<w><Mo_@3ah{U@!x4sE3t>Bu%bX;`$b2|ry)V^<V!7HYybMkTD zxA^#Aqc5jX#_M_?`H$DPXWjks!i)KMqyST}wzB-3Ir3_od#`_4)8fT&qF~GSS$f?v zril-w)7|55RQGyCp4wPhzRrF-XJQI7hw)Fz`CaSWYIh~yfArYL^n+Q=Z@t3J=3jri z+I_QJ;=XqFI^l#kpTMu7GiAL!&+jTa9+D88rME$nuR+4H^}{J++17cnhx&54mItvf zRh-t}K3|W?WS_4%PbahU#e8?O@6n$R_b{I^`B3&{>zdHo-+J9i$}Vcv3SSlfPIK|J z+pQBFyF2&ULFS3kZwwifIs5-TpJ_91et*0CQftjAEJ^84&6*C1T)N7-bmwdP=$Ef| zeZNu8%Cq&OACt{C-Dg1!j5iy5m~6M{PAXl^{{P3ijDM#No?}g|%w}{pwcYy2{C}hR zmXgI=R=AuzdG{BuwA0cUYnuy?v~&NJRZsYOynD{|l&8zD7+pA4z0u%9fbq4`)Y`T4 zbbCr;#Am;(KC$QdnN!|-|9?F6@AbA8mao?yX}3CL^EqYy_`c%U(au@tgQVn-%GXcn z7g%ZFaF$`m#@riCQy4xdGfd!E5HUq!YIJOPUFZ~vQY&lwsaJW{aUWA_k;;fZpL&^X z+sbw4x$jn1321Xpj8oiF6!=|Iz~WXz{u8qshxh9<%wTMom!iSZ5Pgg9+%`So$upgw zSF)~}+?VVSrEqX^_^vbaHch(nEGX31^~VzbwW%8)xz21f`)uQ8o&VrWqm`NE=kMF) zI(P0bdbIECZVS0t)jsjpE0ks$CAvG$Ief@@-DFMYst(i7hx0w!|DHML|MZaLy6=y^ z9CUZgxqU!1rpli??RML@6DNMo{!-e$b8`4(zIrb&g<n=~9y^z|PRUyM_0ZLi6`N91 zIs>k5%|0)8Z4G<aGp=8^t}&LaS~n-|QQv;Id&}b#3KixjoVXZ1L8#-xt+PA=FE6ht ze>`cC<y_uX%UidX-<Ak>l=krd&z%2A@j|46p5`wzHifOy{R}>D*4*`wy`-WlAgyiA zZgk%Hb?y<aneQ5c7nZL-IETCUq*++oo&SETvb8*xhiu+hq+B|^eToCm*B+1OPfwik zfA;6d^^o(G61U9?cp2yazVBJ)Xq4GF;cH?L)5gt3s&|`3QkLCQh<2OC^LqOo8G(q+ zx$M^+IC9#)M(cg<4oz9`C_1Hf#uSGiReM`h-U^1>tx+kloTtn3hf!G4MpWVa2bMpK zlW&+ks-1EzeA(XI+ka{&d`&#m_s}|_$%@G(tErh${kWRjhFw3e%gKK!kw3eQH|FS~ z<-awy<yOc~pR6pG*faU$6vqZ1_Ua#kcDfD`3d_`-@`V<9MR$64bt!z_v!?L+=U{e+ zH7te`*aZ~y%WWT>JHoa|<<dcgDQA0H<6Pv`bSA8SR{z@Xl7NQZ*{5If-Z+OA=4bZ( zDQB7@x2nr>y7aSBuTw=Hza#8-JGRu$+~6RU6@4OYW|o%LNpIyyw`Ccn=0>Tv+14#y zns(%6XH{Y3J>E?ZSIl{1%eg*9P>h4g$BfgfFs6t_eDR_G{EYkUp9?V;@;1iRD}#Kn zXi0~9!@`yj#U2j-E1l0Y-f%T|yj_s2llDZ2XRgAM8@B2U^K+SRF*B<@&*t#CRkN#> zgVQDc`V9_&og1rSf=pfq9=*-XoTMtUyyoEF_ZoVdT{(Uts<p9?=efwKSRGk(>1<J) zg3Q^PBZeDnYTQF=dM|vKmB63m;*tBGVR6!>)D-^dL1G0WM_vZ+71}Uk&-#}yFWhM6 zSj#ryU7D-sMAMYh8yfDU_M|eNt9LKFe&TnOe0I2#ov()iN21o_0L}NJr(4vv@lIf# zw>g)A(c`z2+KbCB&lO}t6lP5BblBM%Q{%p*mRImg<{~D=DZ#&ZpExMQ`1qYN75Khi z+2!PQ4%b)eS^}RWqXmEORJgS?@~7TywSu{NNtQqQ43>UrXc3d|;A%OP#sBQj54+7u zn|gAkcbx0p#PP1)T_X5ojoXRkGle<a=6GDc#<%^ZS;KFIbM@{Lidy=~QPl#MvLEWs zI9}N}<yy>sc81WL+Xq7p9_&uty7JEdIsw)A#ar25PB5`sd!*{Cmr<{bzW)d5DgEX) zJH1~Wi*s*Y;owo8=;fg!zWa*1xB2EthT(D+QA+Cfd6zxOZmE)8#H4t?RZ&Nr>7<UO zWWV9Q^V?)&n3=Dnip_sgb3!d+cbDT+3!a73?TVQuHXGXrt&;vUYqj(z*PPo2O;^4C z{AiW*=UF$mHA_qp`f%Y^^91|62FGP5BbF>&U^MOX#^zLC$E6)5Z=%H(7Uj>oCig^< zmD!@c|AFXI)B5=g42HMM3fOy2zY6l-l*`Jg@k2_fq@`_z!wMPm3DS)zQ|GQ)S07V3 zGuL{D)8WUv3ume>&p7o>MOfp9l-iTaEUZl{=9Es9ZuD4DG2xH&ZL@;bNwc;b&bjR% zq-D#Y2x?EQ*^|A5)#!$8!{_pu@z0Bn-FwUsaB`b$PBUY8%-Nf+X4gbk|Jd<+;<v3m zcSL@%1jUAX)|rbY`n7jgPX4rOzqE0ezkjZ``1Q=pb6UOgqT<S9<@$E~=Wm%{dDCd? z_tTs|O)gq;Of_G9r}c_uQEHh}Xze^3U%$+yyX?LniJ$&_V&9B&j4OUfEv$aSQa$05 z*MTSN;(k^9I62orC1(F;caE*K@|EoSJ#>F0E8h+aIC%T+{59*hhFqU2?6uF?L*eGn zmFF1~gBFGgJd2!AIZr$0?9Z=Nfmg5c=G<1y=2|UuUH#eHhb1a!${QI@@NP7ivh9}% zqlZkG%grS{4hd#AY&Tf1G?IDf^6FDBZ@;$H*>_ckA9vlDd{WzNV=lYso;ysTf=(*W zchA_MFD%wEZJyA|FFP3)B&lssn>(?K`^uH)ox$(_nC+j;vo$Ve|KH!@roB7o^v8WN z)A3pRd-7SU3G-@OK{`)-yDRPCe$h<$#)LkO^P(=>>rU(qtyB|Wu#k<9@S1mLSGARa zT5>es?Y4lUJ_*(hIWwhaa)Jw;uG5<yoz!dO`}Se_>no?+lhfy((&?MW+3@t!+gp5R zB~{g%`j4HlJGxEr(u3Cz#XUBi=zg>*=g{&goZKpUFOMW2m=PnA>%d&Y<`bYE-WL6* z^y%cs<?mF_zKKZRYM{4fm(g#JLwAyMqLp~>y%RQJn4mq=NaFFN9ZNC}Im&t5)mXD` zwZd&t<yc$cpv>}}CmOx$>eHsoiEuEJmva|P7nvWk;eS%Y9r?8vFPj!-L?2P&i<DPW zov`MQ$feT_wQFOa#3=~%shqhR8#;gY)LiQ&OLr;0Z&wa~_Aco*pVf=(w@zj&g;OSf zNep7z86E8zrSR=q-n^941yh?h28V}Sy%Wj8P*f_inD@_$Zx7$PvL`RoNxv<$OCV|& zuS#^=8ve;b9(i>}nT;=AetBiUlvxvW^V4J2@3MyG`{yg9ua5Rl&dZbC|F`9MUz_?= z*|dWP8}eOlZU5x)%V4KsSlp(RNq$-rB%BgnJbrilrOSkr&a*%4-km>Pyhd6sd``mc zY2Pv`f(jp<Z?W9AQSyHIieCTujCIo(I&z}=F0J`<CCG@?gLBEVI@PdaPYyr%!8hlH z^ERIAC$(%N%dE0?#RrBy^6`0lOm%ZYhR&|(5;D^a?&`08qH^-8`@6?)?IspzJrDmd ztK#_T*QY#nw@m2k7Og5dJU`_$hwkrwg=jaq6Ky#+$}hg(zBoMX`^r`4@9I`2ZqA*Y zvM%uMgx$Z-pPp~=X7`iw70cT0a4J?V?9cr_G3E4|{$KC-H>G;$PTc#b=*Z$4h7Bse zY}o#!y!~$6<9dD3PI=83E}t)RzPeeik4{<i+=iP$^3;x>yH!nBwx5svUltwtwzSeC z&P7t5-+u1b?s|P@7aIc(wmHvbS0p-b)AgDt+TB&`dDPpfAw<1ro^`WV^e30hxA(VJ zpX-klRg=1|z4(cXK*9vqW%m#DOqyK${g{sd-(G{XN_X*gmi>bB&!{N#akf6Kobqnx z1gj@syQcJX8$L@j+kA3Lp-`3Xlh@yVEnT*5(P4RpJ+Tv;^23+N^gYbC&pG?OMC8S; zK9Lue{Fj1^rC1m)&DA;ZVa3DDRHsbeET>H0TT2(M+Hqw!ztuB?SGgZbt4j;FeE!vy zvvYs`pYK9bziIGpthw{I<eL89y=^u8E%Udll^p)Ts1VX-=w~e<Hz^=!VsTW-)@1(u zDj&A4+5N>(()_?VqlAF-@AlqhNL1W%FV*4w54nvJ&e{4?V*frlxAn~JiQz`xezB|b zPCTy3;>`S5IDbK++6HM!o64gGEfbUzbR0OoW>}wbu+mugWA=OdOWn&2jx1LZ;N(0m zrEJjeem(I>`qk2>>0NpMWF^Hu2bYxP8GWDp{zA*XWv2e|x4onVE;0Ps-|<+V;ltro zZGV2vYTLtC!uIB`#mwEMzYD%h|M%?g9Okd3y~i(1T_*i_+T(k|Th#(Jy(2*l*&pZT zZPIGX`dQw{*me2Sx^s~`idf#3YCq7kHjDdExJgoijbRJ>Zw~8S7u9uYf^DX5nsQmb zLrD3t!Linm)BCwu5}u{lez^3}cBgyW4)#-3sveC!A3yS#SnN~(?yo+(QAzCxBSZP4 z$$kNRTq|6*CO9X{nu*`wI>Wk6F64EEeAcR2-|Xc66(42TXues9!*xM`Lj0LoTP~%3 zydxiUHN<r8%q-_A5<Bf*)x2<B^;Gk_LfSF2Sx(vE?5mz~F8cX#%2f5*JAZ#0-sxkK zRQ~DPynLO7r^#)d&^K#h=AL0On{s=>mF6Eie%F6^{Ofc070Hl)*(><V_&*%ycyxKQ zkX7xI!+j0~+2=R@)p1&KK4_wwZ|LPi^+(i$yG|9K6Pf<>RGO&v!xxXaBP98k2ZeD- zUC-s+)aTiyAadS=(fng6@0*=vHxI@zEKxmOHr3$Q`vaX>OZsgl$|cF(nzw5fYoW)5 zKRMTqz17*Wy20&Pz0ObGRBb*^T@HTxEyk&)H;b0EMI4l0x9NN7_w=`Nn^PX$JAd%` zsh>0Mrxdn0GoF3JvD0A5_RhccH?sD(tKApZ{-|`>SYO!ht-~sI$*00wW=u*od6e>W zV|d16HS?RRMYbd+KV9}J#kN5Hc3IEYxjQ?~d~RXgRPZlL*4cJ3zh<PXI>(uG-oKan zbB#qNJbs+HcE99n!T(=NdzR_SY>sMw@wtWdQG#WiU~KgNOG(#`-<+Q-Ei&QonF}+u z4KMAo;*s7z;l<$=zt3E{u_3xXElYN(sTp1{mb0#Cn7`~rl*#gDb%~59rG49a&z;__ zSYypy?|kLbB2ES=h6rYcOa%r}p0(*4LgHo%Z`;FDed~(Y8h(2g2Y$u}ieW)jGeRXo znHeVSufE{AQtfk@$nxS@6}x|DO1{`SZ|x%%F{Xz~*51>7BUx9zJtnH4B2a6a%-%KA zW#*#UGdl}ZV!HX#Z%+v4dAU18nz?A>_Al}a?!Rr`$FXo9!-eQsXK$2W{62r5S{vj3 zdu$ESq5k>z&**gc9kVH1rBN$AbxUPWf}%j*lT$AqtG=q~^cP>UO}c5y1-lcsRNL)7 ze&x91+?`p{c%*s{lZpM*(#^l3!nA%xU8{ZTbNst|!<*kT{9g1LiYc)y+qCUzZNh=6 z3>wy(pQM;MSr{+=5yH0LQ8V_6z*nDZ+m6WAOPq4fShwbOt^A@R9sbvHxNqIQSKLx1 z!15$G#*oj=h}$E5-TRBV3*O!-G&{EVxl&6_9AA5!BvZ$ynHkR<8hRKGtmuFFW8tL# z_wS`NJ^63K+iF|5J#YR`-JKcnDTP-<XU1qda9Bv#Oqk&>yf<)#`dmYw2A>(LA}@JI zNd4p!dSS`G-CX*4pFt5L!_G6MpV(p<5-RTBOIE4>&3O3!%%$o=URnS8_STx~?c1f; z9}pzDNr8b;_^THuWZ3eoecZ+7cU-l<_1-4uTm1`W)_twOaOK-fYbTR?+b^>URNR>D zH{p*ibHnn`ua)&FQ|8>zJauE1XMS+UxBFde96wD08w(7j<aM>pzo|X$eQWn&_J!rw zZzQlNbRV7`vvhakwy!eGZ`VKPdHcQIe6!d2mQ)e<xhFJiLw%g@p4G3`*K>TaOf9gn z;3L<Xkkuy6Z}ywX=4^jcz2uV9ORcoyY+pAUOYV05Wd5}E(#9EYCWJ2P$z{Fr`tVnV zj_l>~97`P(v;@x0U2wF)^MArI+t}T_TYl>t2)UftHZ5xXLk8U~`UlHQRP-k-{5y@+ z>ifSJL7B<F7EbvRzo`3FkjGvF!vnc22}kBkoucsMatljPaP+yIJB(DH-fUSPc#HE- zDcjfIIomdFJ1oR<;D>ArABTVR+Uo@;<Kqt-nx=-nj214czd1Wp%=JZ`tEZ>mo|!8r zl&lC)Te(j8+2xjd3ugXYnIc?a<oD*P@bXR@^U@3Z9%SCDKE-;A@4ogCNA8-&#>3Mx z?^SDE=l4?CvR$xR_ZQFSw28{v{WJW9g+1av$udkx;_)(;(0aVyZO><BE=P{Vzt;2r z$gBFg)o$72!&WDRbg#cymU7Fw<nfnPR|5ZDXZPCoxm?k!$Ah(Dx6#&jwFxKApYv7| zDQKDCko7+N(d(HXt(ThhsCAv%d|otkk8RwPxi2IBW?ptpx6QThb>O&@k{_$iteEb9 z+rQucw@1mrb0u%0t6xm|WK)=!`7QFM^!Kv7l;i&+YWGjNz-0H(^VQKK%<Ts5YOl?M zll%Am%%8QYEp~auyZ=SE7BFXWEDU@Tajnv^q0L`<%l~8Tan<6PtEB$EzH@c$pZfo4 zZyMgm_ShA4ytv%LTJ+87$l}{eD`PzV+=#jT<%j%X+gjb#>*Cp$%zc+__Rjsmy(~|4 zCdpf~eSRcHI^43X)qP#xv1H+|LObzqm$|$?*IO4WKN7t7+%tA(?S+WhuU|iu@3|p+ z`LoPhn>OVGhA$(-U)B8nGyk;u-@|?8rHzg{x0XDRS1>l;ZMoQ?=W_QdA?>DRI@@R2 zmR{9lFi5zn)ARoShWw9jE`5?YbX~<me)H{(4|5tOU(jyaQuyWbkD@bc-v=hY&!1@# zw5~zS;M$(O7f)}0@8l5Vwsm=<bmVk(y+36pn)jEM@R>fE{wMzDFSpMtrYxQO+~45I za@+P_ul$7XN3OeY?Rn$W;P4l>=Kg(rZma3kY9_m_O0~94K@Ti0Zau-hj?cNII^$#P ziYd#vQ$<<W)J`o}!o)SPfTy@xbVJFDTfd|?`UYm6)91d{7xm%EOXo{|N>jhKmo0f? zB+g+!eHq^_4gCs6*O{_*=KV1ViR+p6>V)2^7w~@F_%=9X+Gp<zPSbyeoDSxT(|wrr z>SnjyyvC|mcTFW;dv?^d&$9Abu<&qmdudWe*ozj?U8|Hf6ux6(Q`0(9x8+*;j9^dS z+|(CMrdO)^!Y?G<Jja{PER(a>NsuYl>eb}7W$8&Lc6^eVXEUY0TV~S3g}cP~cdcIh zpVxg>d_u)9j>C)D47Z%<yb)?Dc%!=H@sS#4hF6!3^v?gx(%s4V^Y((bmwAf#4dM(E zuQD~?yLOo|@LqRDp0$JK-Dp>xV*%5?GoAW0i?P^8-Rl&CEzcB(<;#UKzC3U&=e<{L z|MK$jq>MGfhyPaVes~bay=B9`$sha$m<+ZBu?b6yKKPhXpx!f^QPFFsG2?<&D~#S> z*k^C{&TEHQq}pD?Aij-p%eUAp|9E5Rh3>1ol?(6geib71YW7z*haK*fArZ6oMwa|N za3s%b*EHKLKek=E(Imi>yHDtal-5?OFmCszM-ovQ&3oO$FNkYw|0bms8@PKt<5ayB zUnA@EQw@GO><m@lmoG?mbh;G%MfS?tub&m9^qz@Ned^M+PX5EIRZA{kaqhl9|A^}9 zKd)zgy#G&Z@3Y7M|7`i7GqbkuTf!RqE0+!3zFpIM_U)S9xtiEy#VvD}gjQ>wa%TwO z<`C~*=k`48`qcRI=lpZ`9yoOU?b3~<rC<D?scmyCxpDD}jC18b?j7M*&fK~kekphc zSLlLvJKOh*f6WrpI9GLWRzQUpgYDU=jtMK7Vs~A9?BtqixnKA0gYT}sv97C&xpnXE zdih$?lIPop*W3+f;_fMi*YA|p|2VbUwDjrDnUyOuBY&R!X<B;ZT-d}`Vdi7oH<q1z zs9$T#RCZx2=Z`m?5_!wb4>oJvv=r@UPq-M)%5#>(FY06i<2x~P=R`N*j#Q05a%?s) z?yl!930|C=zs+@u#LkSf+h*Ed3{{+45T+nh7gL{CV*hXfN6QOttFry8Sh?~{94{NE zsjE-g=_Y@E-GYnF+XCN2SBB`fMRT5)kat^E!n&d44b!f+kmc<8jE6UWS<`Zo`&y5c zYy8qLhu*ALSAFhMFS4Ti>JGInWzy{ew$JzPTK)OJfe^_lQvzRm2@3bAzO-z~i*@ww z|G7Tg=t$uE#s%9pwN7N^^!$5ln$}wDN3U*usg>i|@$kjWyZ>HqKX2t9y_DxbW}}D4 zPSIc%hLe5YnwMQnT|Y@Et2EB}^S12|7qcft&Goie!2ROOl8?T(`R-n=SS$Q<R?)9x zQ620TR&O`Dv8yaMwsi8IfQ%=uH!e;nto|Qy`e(@fIpQ5HU)HoFv1nXcvD~%ZG}JeF z*Q=)=1u|Z1GsZ7qc{FX?UUr?QB1bPcNmhMT+tBS}JZav>ot)mbh0}cw@cK+Scx);6 z3u$d;|IT}X6{WeAML$l?cbBsfo8*;!l;_|}%M-I_NZu~7-=qAs+@WJ)z%Sji5?-I< z99$W<{uS;l-r4(x?^NuKpHcB9i5`~!r(9YhtC$h%X0|nS;qL7fb6?DixAfQ6JD+R5 z$|`(9x7-uauf1E(e&kd?WV*FfeinDm-hYzH;Z-WOUi^QzEetm|Wl1tT@Ok-+f)dxx z=9f|@^D@4wO<I_otzR@hLSIR+)olLtT^H47Cclu>yuA75cQ%O!nK4OEHsx<;*VWNH z{qV#(5yK~|*emDmoE-N3U&gCVn>i+^PJU}st<<)=^=v@sEgt<_oiVR%)<nM!X!o6G zCv^C}_<i{Uv5~9}_g!|D_FeRynpkb9XYu9uw7}ns_w7EM<9tRT-1fxlJ16$l*sK1% z6kisWcegs@r6ogv-MkNRQ$pjuX^G|TzAyAVE0ZlF@7MF<DmNR0EffCUdF&gqOQGV@ zjZf=0XWR`5d@Z#0fR|*I^%mXhMl~XPSFSLzE_pg_rLkVj-_>(Yw#{(KtDbOurp>R@ zb=~`K?AiWObK1?nQ<kMmNWF@RI`3(lC$RmU;D)=^dmf!sE_@x=zsrn&OG)K|m8)HD z_n8Yu8N~emdZ4Snf8O7h%g#upcJL_*WXwHqdzH?t-EXDctJjOFIIYrJF#Xw<GcCHe zzw5?D>!cU=mMd;|USqy8e~sw;{@>1DUSvK#%J}VY6(hgh3lDvUKILOxFYdf!KHa>n zweIWeC)*QlE9`o)fp1IR$AyM=a*gdf3fz}Ae^&UGmGa@1eA>K}+X8AYHZV1As}=s5 zI{)7uhm6<1M4^ilj|I#ww0?Sg?e6FAb@Wa@E!mcs`QidoWoz?=;M9lex35QX<V@Fe zV)5kF(>i-|TkZWvp)VsjeRHG_o6L1mSU<z$Tlc@@_A`I(oH<ga#I)q#HrpcBWBlEx ziWZ$aB6CZ$u4;RXjPSx{Kh+80KX&|<Ui0%;f2dc|M|Fk^Q*)~={Dk>G9tx|sudR&< z3Q@g%?8GcT%?aT>1$+V(6~E7aDEvOZMZjW1F8}lc3^NNm1M82fxcx1))ZEmOTYY0u zF!z&Ewcg)*_V1l~dx_ab1@55MRDt`RZg&J#-Q3cjEtm24>fRR?r?*}D!Iq1LbzxG5 z=3+|n{Pz8klf&!zJZyF<zZKofY}jC7_2$L1_#|QFB=1xA=anzryhz|g^@p<WmtQ77 zHM?`O@<#x-vNk`1O6V5RnV<H>@jkXL*ZTBm-SYUJvnPD_3CtIXRZo8Xgss)VL%=3A zb-(4m)#=+-bf_ybFy8()fsuKNmg&d7_x-=#WkghXaNYiPf}5)`z`_5x#Mh05hTArl z6u(-Te&zhRQ)}(x&!6C9{MC?qJL+J;@?Gnc)V1v`_dbkEz14f@$?TbxCtJ6&T<+8S z@n3_*N!jqY{QMxt3Z2<zCdnnY$`{?TFw1@6p;0z9^T~~sv1`<=c<sLmzcwpT5wYbs zE5m*E?`enY6<X4{;a8{0&onvz%-QVLyA>K$0<(Um-e2X)u%oecnRGqx<SlC({H%US z?LVWr>O^G=<57zn)qTzlDU+u2C$F%oFiA;yQt$jZ^<rGQlcE5d$9b<6EDb#F)$3mx zNgV4se8}9-sv;+t>G0bUFA=814$v}cg9j4q)%y7?3l6(TOE^C~_+bJk`(g9W87tx& zlO~<Bu$$NT>$RAyRXf9+jI|PndrNOO9XqDtdS~g@IM)9T7n==y3Nz0=-jO}=w~5J@ z)4D8X%nVzfc}#43<sH6w+Pb@Dk2i05)52FhxnEnON<h-+m}Y=-%JKK7rL&@*F@x5d z^Kbd#RlP6j=f!C|v<1KN%v|w+SA;2%apBbNUEcQ}-UF>NYqtF}hhf6cY{?xeHpdvg z3mkG?wEE&q$g(s2qp8oA+a=xn;&=Q%Hv_}}|1+<zuZ!023}#?pVDNPHb6Mw<&;$U& C{&#Tz literal 0 HcmV?d00001 diff --git a/bin/generate_travis_deploy_key b/bin/generate_travis_deploy_key new file mode 100755 index 0000000..dcd7ce4 --- /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 0000000..9ba21d7 --- /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/data/importedData.json b/data/importedData.json new file mode 100644 index 0000000..9d52397 --- /dev/null +++ b/data/importedData.json @@ -0,0 +1,12 @@ +{ + "io.cozy.files": [], + "io.cozy.accounts": [ + { + "_id": "default_account_id", + "auth": { + "login": "grdf_adict_bas", + "password": "wGe0MW13k" + } + } + ] +} \ No newline at end of file diff --git a/github_deploy_key.enc b/github_deploy_key.enc new file mode 100755 index 0000000000000000000000000000000000000000..77d5c89b98c0e374a78c13cdb069152e935957e5 GIT binary patch literal 3248 zcmb2ji;Bo9+dPYV&ig*kyQ@@RINX`)b?xl7fQjyh4U3;GYy8<h>oa%7chQH{x3!<u z_XJM9yk_r@TPHRrEij!r&2Yi*n>^}UA6K~_T61};;JO0;i5IG(|1JH!c8g@zu429^ z)lW`8lfQGlF*?EFT<=DyIT9)^aSF~l#d(r!-`VW~J4!YiEPSH${!L!_S?7<A*I&)O z=(Dkr+f{Re%$6q}G8dB{OinKT_)To~x9UAVyUp)dBqwQZ<y#T5@2T)}?%kh{WK6pH ze!ob>a?y9^x~%_4tvvHU)NWxxeA4#(ZE}Au$}IMq`P*mKPqF%b{&!hB^QyCs=AKhr zxL#S{cI(mYdCjwwzfJ#s>Q_Lg_yn&H^KV8>DzEGFGO7?b{HEV@e)XH;l^44dThFl; zt#mVcP<K<cb&LKhMh1?o*8GL$5$n#Y=KOj-TWMRIYuw2jPuO-yt<63!d;HkeutWd8 zP5z>Ph+}=t<G4fbY`V`(`}g5#@|@M3vF2C)vb`yiUAZq}-QwJne@<@Yo_(iPR@~{R zkLQzn`!AP0;Ru@%^0R#YVy@2~lDsq4F8%FqzGL<JOOw0RS$4f%IqMQbvrF$1xk+#9 z53W^h_58hVK_yeDL%qrb`{1stE5o=~e5>y3`1YzT*)eO&$Hm_+q{P<MEKj)GC%$J# zaa6`m$CQYD;Yk5Zj2lH`e`UUG{;ek*$1^*~p<Mg7(!C#k+!I<iCcKv4vv1S7pof0u zI|ZL_H&M?x{HVHU>E!G7M}Ek73$0ekQPfm;x?zvmkJF3w{|BfVy5^|7-YspvX8y_T zx^>~<s|5v3=6z^O()jIq@x>+gm|d$|xlbi|W!9uUZ`i&_`H#YhucC}UE&13F?kiLE zKfL#HuE@Nj_569w&$IaIw(d_#`?4aX?)8q?KM(G_vs$WGao?@_!Dr`7eP>-NL>*t1 z)VXTx<a3=}8~6I2VxnZExWt~y&`lHfTzMqnRIsbyY~cBwGs+h3XHo8&II+)+dCzu6 z9%<=4JUQm!yvLip*Rp7B@94~5)9Lws8drG#1g~~W)(1O|3I2ZEW~A`dYvJXLrSp!@ zoZj^=>(=r1O{J=<CZ6BCue<41`E&94x&_xxIDLDwaJKCB*XuV-S$y>ukM5oaEB)*j zM=Zbjr*TecweW+G*StI2D}HReRP1d2`eWbfY5#lVI>fZ^ayzYJD1B}(##_he8Ws0x zHsh=cv46?Bix*8eVqcN%Y8Spda+=VMSmRui86MleJltVv!#nN5_ouRVK2*&M|EwL7 zeVa{8LD2K^<64c*>UGOmj`N$mQ-7az=)klGA%Zh6DEcS}^6JKXTasDjIO#_UYo+FC z!&!2#_x<aNJD@#dd*Y+;yAx_QhF!@sjNAW^p?T}f-PH<L+;-iZA{edvs4ur9v;9M_ zA<wK`9<D`&vP=(VCRs;KnYJsWJ>;ZVEbsfWqmQ;-)nF3xD{9n_jlRF=`P=O;1HPYX z5YOj*dNd&UQ^5X6z1zG|ix<fmN=)^8p`QAy&0xaC=M$~Hg8N-E_N+Rvq%y2ayvE?~ z$%JL0bNIg-)cy0jaN*t2opp;vP6=O}>+PQZzaz`;45!|qX5|#858VsrSUsLpJCQFS zGg2go@!O^26CPRG{P*B@Gxa#<u>Y#4no;vM)&mpvIbDr#((<rwTfX_>yBB%Mac7r) z>fQG}g-`#uGQ&qLo7ybC2fDlu>sPh7KYe}5h-r=A)||9+qD%GVmI^=F;kfjWbbGUM zWc-d~&)n(jY%e?OsLt8O)xRQM_*}MSLzRtnSMWo@FDF#=Cnj4s9MJi_M*Wp|+^NNX zZuC9wx?d@pICpzYX@I?_eNctSN==@tk2YmDNfmp{Xjmg&we8`1m&pt7HiZ3j%qj2M zTd`couA)bbXO-kPi`YPBn;(D9^pqD0=Y(%)6>LB7LEU|3>G2mc!msm8nOF4T;WM^d zYb!cEE_H^lk}a0v%u9{R=k%Gct+=B#ebu=H)1p?x87qZ&rDx`rithOs{E^q;<I`eU z-&Tp9nAVQ>hnQb#HM6aHn_KndkN33O(_1Zb3^>_^iw&O^%5LTORQG@0WNxpe%HCHu zt#@B~z+;wilF)ve^#Y30F^^?7ad=PsG2PCw!B4I5;GTnfyESB#ZapYv@_v40#Z~@9 zmD@V;DLccqHm>K-Kcx5S*zwgbpBTR>UXW)dv#Idm?h`xieb8^c_<7}%gnLPgyL_#F z<-DnmPq1XGmrL@qpWImUBv9t;f7N^S-nY^Yt$!}5XYZQh@p_ksEYo%_ZqcI*DtT)e zf{(tn)p4mku;fE=C)ZP9^_|PN^N64O(tfB^GU8tHrWJ?#uFQX)Gi8&s-;*i3zC2CT zI*{!D{9Dt6Gj}eq?zfzKQ-Wdo%P=F0|A#Gurz<`>cVu7lBJL+i-T!`ke6d01p4o-Z z`JpSN*W4B?$~140+A{6w!usq58OhG?AM|%7#lKkir|ex+jCZVr*CpKqb@{_gdp`6$ zw(RQRtgdda`<PLxk^M)ZqW^~Ao1p#oLf^P_hsoq*`^x;@oN2A>uW{?fC4n`|J7()I zUiN-fkoPI|xTj3-7N6o-Sm5mTO@Gp|lp7aMC%?R;Z>-;<TD$2ft77MKuG1~c8Fo6K z<dSh-Wc&KwUv>Vyc?Y$-A57^LXh_$1e<tjHli6xj&H_%)Q^y`fO>}Dt+PLk;bk9BQ zLT;y1XHEaPZ_Z+0JAsc^cnWGC$nZ)1mYA?=u8*Kh&dfNgO|=!JGT96-{=J{R@Y;@D z|3Vas45rW3SP?#d(q<W-ou_wCJHUPTv-!jBoWkpij>yDblP)xTo~dcvFB7{aEJ*0q zmHc;W91lpRI=%Za%U4Xj{0v7)#=U#f58s+{WA2pywJTn2diwgHn%A<2T6zpSRxxf_ zvW=NZ$5Z4sPvwI-QD;x=WzT)fe@Xd&uvFhuIlkl@o;`<y7ymTy7B@dJ|9<BY31%%r z6CMr)`FlIJZDzEPo}>K0Zu@VYwLBZGHvN3xZ`yU>i<!gbz9`dY-3M6yc607~tEhKx zUsk%XFnfsO61N9ScF9T3vrm-Vm@Pi_)-8rjM}mU0w@a$IH1YqNef6xS*OV<nOMdFt zU%kKo`j-~p{H?q~u_n{H7f!qPa0Xk&irF{bu6Y-?_`t{Jb$Lg*(+<uxWZ;(h$Mlqo z%XLm*&9NZ64OLQQF^^rD%}swzeV=M_sIJMUb8X11pW2R>-LsBQ?fCVqu=BaAM)~5j zkEO-eoc1~1vd+}APV89xHggg~Mn$IiX8C~TL*=fASA3cE>+R%JFS$RR{~o*hK7E*z zeXBR}SnV$kiO*LvPMr7oePd&g<+ivvo(!g*=U1MV34OT2sX$7;WY!ro0qG>>`sgz+ z+^0Xjt8c8cvP1R7?7Qu}Earltl7iADmZ}R{TlLKxEO#j#;r6m^S2EkWLVgzilKB-2 zE}g7eIpNLSiO-{FHML!-V=<T`V$j5I^s>YCxS?*?Z@u(c>`Z$73-exb`tCL8+Pu<M zu*e`NMVrNSi}b8y0l5kPzSN4&-s1TrVoR9OnJrsO=U2a!&pMrVS+Vok<7dz3-nC)n zc)^{ldF|;+wvF%WlT?rB3chuz(%ACjcl~<T=F}sNm#Z^_^ZrN28EjnrtwO%4-d8Q( zAxvPG&+&T22k+OhsA?38Ci0o>7ERs0|H8a|p}u#vuY4ot|D|$9b=cjVr?wrBTKA~q znp=<9)QM7aR@|M^tsk;=jo;MMU&O8*ZZ@2loPL&N;&aCb^QNs4>&cqe^ESWyP~faL z8|1y$J)W;+7ggiawdFxW%%L;aqReM#Sk1fj#qUYI-!$W<OIJ*s|5q&8k+bXIl_=)J zmRXAPwpN}vd9=7x*ID`}Pp#OS2-BMfdd^JyW%7da!io?!mVH*+c4iiEU+W28Jyq=2 z+&K;VdG21^a;ZurW8Ku(&)vA@s$TN^l(jRfWBb!XCSJ>GT9|q+ub(4$@n6|Jb4mX9 zCHIfFy8pj_=FURBncw&7Nh?n;+nXe!G||sQ_=VrG+ct+cetzfpV{3!mt|q^2+dgUR zQu%B8ZNdKI2UvMiWSk%5AKGxuZ%5|cYuh?*wz-^Wsq9~G`(k?i4bS?{GZ(hUnm0e= zbk<4fxFN)_O)O>FWfPWH!lmE%tzJ&LJ-KqB#E%1giT!WxJ`CyR+5F){c<7Sf9y-#` zB~NtZ$4#HNQ<t||Z$dW1EvBe~ZRUqV3%l1z9adlAa^hd(-iYe{y;Ce?-pxA8Vku>G z{l|}$RbN)Hbv~UN^7P{5&HRfj{v-#i`lU5X&Sk~osaL`ewWhKqKP}sR>y4(nhs1<q z{HYd4J*L~c%`11$cMAHozw}Y$j5hX2z35LS5x=t|PngVV_HVX&CHR~1`dO{mw&h<Z z|DAUwpj%8bZ~GFD$+nttvJ2KQu>L$B`~8>Y{cUXrovWw671$BG`JvpoGdDUHDr`5n GnFIjx5ol8Y literal 0 HcmV?d00001 diff --git a/konnector-dev-config.json b/konnector-dev-config.json new file mode 100755 index 0000000..5258d6f --- /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 0000000..daba285 --- /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 0000000..3156d7b --- /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 0000000..b3aec27 --- /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 0000000..19ac544 --- /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()) +} -- GitLab