From 8670fac321d82c1c1c99233bf98f0be4f826c36f Mon Sep 17 00:00:00 2001 From: doubleface Date: Fri, 31 Mar 2017 18:24:15 +0200 Subject: [PATCH] init --- .editorconfig | 24 ++ .gitignore | 2 + LICENSE | 661 ++++++++++++++++++++++++++++++++++++++ README.md | 79 +++++ README_migration.md | 36 +++ gettoken.js | 48 +++ index.js | 9 + konnector.js | 1 + lib/base_konnector.js | 60 ++++ lib/cozyclient.js | 29 ++ lib/fetcher.js | 47 +++ lib/filter_existing.js | 53 +++ lib/manifest.js | 16 + lib/naming.js | 57 ++++ lib/save_data_and_file.js | 125 +++++++ manifest.konnectors | 35 ++ models/bill.js | 47 +++ models/cozy_instance.js | 51 +++ models/file.js | 63 ++++ models/folder.js | 78 +++++ package.json | 23 ++ 21 files changed, 1544 insertions(+) create mode 100644 .editorconfig create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100644 README_migration.md create mode 100644 gettoken.js create mode 100644 index.js create mode 100644 konnector.js create mode 100644 lib/base_konnector.js create mode 100644 lib/cozyclient.js create mode 100644 lib/fetcher.js create mode 100644 lib/filter_existing.js create mode 100644 lib/manifest.js create mode 100644 lib/naming.js create mode 100644 lib/save_data_and_file.js create mode 100644 manifest.konnectors create mode 100644 models/bill.js create mode 100644 models/cozy_instance.js create mode 100644 models/file.js create mode 100644 models/folder.js create mode 100644 package.json diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..10b71ac --- /dev/null +++ b/.editorconfig @@ -0,0 +1,24 @@ +# editorconfig.org +# editorconfig is a unified configuration file that all editors can take +# into account +root = true + +[*] +charset = utf-8 +end_of_line = lf +trim_trailing_whitespace = true +insert_final_newline = true +indent_style = space +indent_size = 2 + +[*.coffee] +indent_size = 4 + +[*.jade] +trim_trailing_whitespace = false + +[*.pug] +trim_trailing_whitespace = false + +[*.styl] +indent_size = 4 diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..f8ca8af --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +node_modules/* +token.json diff --git a/LICENSE b/LICENSE new file mode 100644 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. + 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. + + + Copyright (C) + + 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 . + +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 +. diff --git a/README.md b/README.md new file mode 100644 index 0000000..e4c1a89 --- /dev/null +++ b/README.md @@ -0,0 +1,79 @@ +[Cozy][cozy] +======================================= + +What's Cozy? +------------ + +![Cozy Logo](https://cdn.rawgit.com/cozy/cozy-guidelines/master/templates/cozy_logo_small.svg) + +[Cozy] is a platform that brings all your web services in the same private space. With it, your webapps and your devices can share data easily, providing you with a new experience. You can install Cozy on your own hardware where no one's tracking you. + + +What's this new konnector? +---------------------------------- + + + +### Open a Pull-Request + +If you want to work on Bouygues Telecom Konnector and submit code modifications, feel free to open pull-requests! See the [contributing guide][contribute] for more information about how to properly open pull-requests. + +### Hack + +If you have a running accessible cozy-stack you can test your the konnector without installing +and/or updating the konnector in the cozy-stack : + +You first need an installed nodejs (LTS version is fine) + +Then run : + +```sh +export COZY_URL=http://cozy.local:8080 +node gettoken.js $COZY_URL +``` + +Replace http://cozy.local:8080 by your real cozy url if needed. + +Follow the described procedure and you will get a token.json file. + +Then just run : + +```sh +export COZY_CREDENTIALS=$( + + +### Get in touch + +You can reach the Cozy Community by: + +- Chatting with us on IRC [#cozycloud on Freenode][freenode] +- Posting on our [Forum] +- Posting issues on the [Github repos][github] +- Say Hi! on [Twitter] + + +License +------- + + is developed by @doubleface and distributed under the [AGPL v3 license][agpl-3.0]. + +[cozy]: https://cozy.io "Cozy Cloud" +[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.html +[freenode]: http://webchat.freenode.net/?randomnick=1&channels=%23cozycloud&uio=d4 +[forum]: https://forum.cozy.io/ +[github]: https://github.com/cozy/ +[twitter]: https://twitter.com/mycozycloud diff --git a/README_migration.md b/README_migration.md new file mode 100644 index 0000000..836cb5c --- /dev/null +++ b/README_migration.md @@ -0,0 +1,36 @@ +# How to migrate your existing konnector easily? + +## Intro + +This doc describes how you can migrate a v2 konnector to a V3 konnector as easily as possible. At +the moment, it applies only to login/password konnectors (not OAuth ones especially). + + +## Convert Coffeescript to es2015 code (if needed) + +There are still a lot of konnectors which are coded in coffeescript. We do not intent to support +coffeescript in this new version of cozy, and it would be good to do it for your konnector (but you +can still compile with coffeescript if you want and it is not supported by this document). + +Just run : + +```sh +npm install -g decaffeinate +decaffeinate --keep-commonjs konnector.coffee +``` + +Now you have a nice konnector.js file ! + +There may be some small problems though. Each time the ''.?'' was used, a _guardxx_ function will be generated. It works but a human +intervention will make it more easy to read. + +## Remove code related to kresus + +Kresus is not supported (yet?) in cozy v3, then it is not possible to link you bills to you bank +operations. Just remove code calling the linkBankOperation lib. + +## You can test your konnector! + +Most of the libs used by konnectors have been migrated to use cozy-client-js instead of v2 code and +are directly available in the lib directory of this template. Oh yes for that you need to execute a +tiny search and replace from '../lib' to './lib' in your konnector code and you will be done. diff --git a/gettoken.js b/gettoken.js new file mode 100644 index 0000000..638b71a --- /dev/null +++ b/gettoken.js @@ -0,0 +1,48 @@ +const http = require('http') +const path = require('path') +const {Client, MemoryStorage} = require('cozy-client-js') +const manifest = require('./lib/manifest') + +const cozyURL = process.argv[2] ? process.argv[2] : 'http://cozy.local:8080' + +const scopes = manifest.getScopes(path.join(__dirname, 'manifest.konnectors')) + +function onRegistered (client, url) { + let server + return new Promise((resolve) => { + server = http.createServer((request, response) => { + if (request.url.indexOf('/do_access') === 0) { + console.log('Received access from user with url', request.url) + resolve(request.url) + response.end() + } + }) + server.listen(3333, () => { + console.log('Please visit the following url to authorize the application: ', url) + }) + }) + .then( + (url) => { server.close(); return url }, + (err) => { server.close(); throw err } + ) +} + +const cozy = new Client({ + cozyURL, + oauth: { + storage: new MemoryStorage(), + clientParams: { + redirectURI: 'http://localhost:3333/do_access', + softwareID: 'foobar', + clientName: 'client', + scopes: scopes + }, + onRegistered: onRegistered + } +}) + +cozy.authorize().then((creds) => { + require('fs').writeFileSync(path.join(__dirname, '/token.json'), JSON.stringify(creds)) + console.log('File saved in ' + path.join(__dirname, '/token.json')) + process.exit() +}) diff --git a/index.js b/index.js new file mode 100644 index 0000000..d1dfcbb --- /dev/null +++ b/index.js @@ -0,0 +1,9 @@ +const konnector = require('./konnector') +const phoneNumber = process.argv[2] +const password = process.argv[3] +const folderPath = process.argv[4] + +konnector.fetch({login, password, folderPath}, err => { + console.log('The konnector has been run') + if (err) console.log(err, 'There was an error') +}) diff --git a/konnector.js b/konnector.js new file mode 100644 index 0000000..cde1382 --- /dev/null +++ b/konnector.js @@ -0,0 +1 @@ +// putt your konnector code here diff --git a/lib/base_konnector.js b/lib/base_konnector.js new file mode 100644 index 0000000..f941dcd --- /dev/null +++ b/lib/base_konnector.js @@ -0,0 +1,60 @@ +'use strict' + +const _ = require('lodash') +const printit = require('printit') +const slugify = require('cozy-slug') +const fetcher = require('./fetcher') + +module.exports = { + + /* + * Add common features to given konnector: + * + * * build its slug. + * * build description translation key based on slug. + * * add a dedicated logger. + * * Change the array model to object (dirty hack to ensure backward + * compatibility). + * * Add a default fetch function that runs operations set at konnector + * level. + */ + createNew: function (konnector) { + var slug = slugify(konnector.slug || konnector.name) + slug = slug.replace(/(-|\.)/g, '_') + + var logger = printit({ + prefix: konnector.name, + date: true + }) + + var modelsObj = {} + konnector.models.forEach((model) => { + modelsObj[model.displayName.toLowerCase()] = model + }) + + return _.assignIn(konnector, { + slug: slug, + description: `konnector description ${slug}`, + logger: logger, + models: modelsObj, + + fetch: function (requiredFields, callback) { + var importer = fetcher.new() + konnector.fetchOperations.forEach(operation => { + importer.use(operation) + }) + importer.args(requiredFields, {}, {}) + importer.fetch((err, fields, entries) => { + if (err) { + konnector.logger.error('Import failed.') + callback(err) + } else { + konnector.logger.info('Import succeeded.') + callback(null, entries.notifContent) + } + }) + } + + }) + } +} diff --git a/lib/cozyclient.js b/lib/cozyclient.js new file mode 100644 index 0000000..8e0892d --- /dev/null +++ b/lib/cozyclient.js @@ -0,0 +1,29 @@ +const {Client, MemoryStorage} = require('cozy-client-js') + +// COZY_CREDENTIALS +let credentials = null +try { + credentials = JSON.parse(process.env.COZY_CREDENTIALS) +} catch (err) { + console.log(`Please provide proper COZY_CREDENTIALS environment variable. ${process.env.COZY_CREDENTIALS} is not OK`) + process.exit(1) +} + +// COZY_URL +if (process.env.COZY_URL === undefined) { + console.log(`Please provide COZY_URL environment variable.`) + process.exit(1) +} + +credentials.token.toAuthHeader = function () { + return 'Bearer ' + credentials.client.registrationAccessToken +} + +const cozy = new Client({ + cozyURL: process.env.COZY_URL, + oauth: {storage: new MemoryStorage()} +}) + +cozy.saveCredentials(credentials.client, credentials.token) + +module.exports = cozy diff --git a/lib/fetcher.js b/lib/fetcher.js new file mode 100644 index 0000000..46bfc8d --- /dev/null +++ b/lib/fetcher.js @@ -0,0 +1,47 @@ +const ware = require('ware') + +// Class to handle the layer of the fetching operation. Basically it runs a set +// of function and make sure they all share the same parameters. +// +// Example that runs to functions logIn and parsePage. +// +// fetcher.new() +// .use(logIn) +// .use(parsePage) +// .args(requiredFields, {}, {}) +// .fetch (err, fields, entries) -> +// log.info "Import finished" +class Fetcher { + constructor () { + this.ware = ware() + } + + // Set arguments to give to all layers. + args () { + this.args = arguments + return this + } + + // Add a layer to use. A layer is a function to execute while fetching. + use (operation) { + this.ware.use(operation) + return this + } + + // Run fetching by running layers one by one. + fetch (callback) { + let args = [].slice.call(this.args) + args.push(callback) + + return this.ware.run.apply(this.ware, args) + } + + // Return all set layers. + getLayers () { + return this.ware.fns + } +} + +module.exports = { + new: () => new Fetcher() +} diff --git a/lib/filter_existing.js b/lib/filter_existing.js new file mode 100644 index 0000000..563c7e7 --- /dev/null +++ b/lib/filter_existing.js @@ -0,0 +1,53 @@ +// Returns a fetcher layer that adds a new array field to the second function +// parameter. +// This array contains all entries that are not already stored in the +// database. To know if an entry has no match in the database, it checks if +// date fields are the same. +// +// It expects a field called "fetched" as field of the second parameter. This +// field contains the entries to filter. +// +module.exports = (log, model, suffix, vendor) => { + return function (requiredFields, entries, body, next) { + entries.filtered = [] + + // Set vendor automatically if not given + if ((vendor == null) && (entries.fetched.length > 0)) { + ({ vendor } = entries.fetched[0]) + } + + // Get current entries + return model.all(function (err, entryObjects) { + let hash + if (err) { return next(err) } + const entryHash = {} + + // Build an hash where key is the date and valie is the entry + for (let entry of Array.from(entryObjects)) { + // If a vendor parameter is given, entry should be of given + // vendor to be added to the hash (useful for bills). + if (vendor != null) { + if (entry.vendor === vendor) { + hash = `${entry.date.format('YYYY-MM-DD')}T00:00:00.000Z` + entryHash[hash] = entry + } + + // Simply add the entry + } else { + hash = `${entry.date.format('YYYY-MM-DD')}T00:00:00.000Z` + entryHash[hash] = entry + } + } + + // Keep only non already existing entries. + entries.filtered = entries.fetched.filter(function (entry) { + hash = `${entry.date.format('YYYY-MM-DD')}T00:00:00.000Z` + return (entryHash[hash] == null) + }) + + // Keep only entries matching current vendor. + entries.filtered = entries.filtered.filter(entry => entry.vendor === vendor) + return next() + }) + } +} diff --git a/lib/manifest.js b/lib/manifest.js new file mode 100644 index 0000000..8201973 --- /dev/null +++ b/lib/manifest.js @@ -0,0 +1,16 @@ +const fs = require('fs') + +module.exports = { + getScopes(manifestPath) { + // get the permissions from the manifest.konnector file + const permissions = JSON.parse(fs.readFileSync(manifestPath)).permissions + + // convert the permissions into scopes + let scopes = [] + for (let key in permissions) { + scopes.push(permissions[key].type) + } + + return scopes + } +} diff --git a/lib/naming.js b/lib/naming.js new file mode 100644 index 0000000..a804867 --- /dev/null +++ b/lib/naming.js @@ -0,0 +1,57 @@ +// Simple library to build right names depending on parameters +module.exports = { + // Return a file name for a given and a given set of parameters (options). + // Use mainly for bill naming. + // + // + // Exemple of expected parameters and output: + // + // entry = + // date: today + // orderId: '123456' + // travel: 'paris_lyon' + // + // options = + // vendor: 'telecom' + // dateFormat: 'YYYYMMDD' + // extension: 'txt' + // others: ['orderId', 'travel'] + // + // naming.getEntryFileName will return: + // + // "YYYYMMDD_telecom_123456_paris_lyon.txt" + // + getEntryFileName (entry, options) { + let name = '' + const { date } = entry + + if (date && (typeof (options) === 'string')) { + name = `${date.format('YYYYMM')}_${options}.pdf` + } else { + // Build date prefix. + if (date) { + if (options.dateFormat != null) { + name = date.format(options.dateFormat) + } else { + name = date.format('YYYYMM') + } + } + + // Add vendor name. + name += `_${options.vendor}` + + // Add optional information. + if (options.others != null) { + for (let parameter of Array.from(options.others)) { + if (entry[parameter] != null) { name += `_${entry[parameter]}` } + } + } + + // Add extension. + const extension = options.extension || 'pdf' + name = `${name}.${extension}` + } + + return name + } +} diff --git a/lib/save_data_and_file.js b/lib/save_data_and_file.js new file mode 100644 index 0000000..51f217f --- /dev/null +++ b/lib/save_data_and_file.js @@ -0,0 +1,125 @@ +const async = require('async') +const naming = require('./naming') +const moment = require('moment') +const Folder = require('../models/folder') +const File = require('../models/file') + +// Fetcher layer that creates an object in database for each entry. If a field +// named pdfurl is is set on the entry, it downloads the file and creates a Cozy +// File in the folder given in the options object. +// +// It expects to find the list of entries in the "filtered" field. If the +// filtered field is null, it checks for the "fetched" field. +module.exports = (log, model, options, tags) => { + return function (requiredFields, entries, body, next) { + const entriesToSave = entries.filtered || entries.fetched + const path = requiredFields.folderPath + + const normalizedPath = path.charAt(0) === '/' + ? path : `/${path}` + + // For each entry... + return async.eachSeries(entriesToSave, function (entry, callback) { + if (!(entry.date instanceof moment)) { + log.info('Bill creation aborted') + return callback('Moment instance expected for date field') + } + + const fileName = naming.getEntryFileName(entry, options) + const entryLabel = entry.date.format('MMYYYY') + + function createFileAndSaveData (entry, entryLabel) { + File.isPresent(`${normalizedPath}/${fileName}`, (err, result) => { + if (err) return callback(err) + if (result === false) { + const { pdfurl } = entry + + return Folder.mkdirp(normalizedPath, function () { + if (options.requestoptions) { + options.requestoptions.entry = entry + } + return File.createNew(fileName, normalizedPath, pdfurl, tags, + onCreated, options.requestoptions) + }) + } else { + onCreated() + } + }) + } + + function onCreated (err) { + if (err) { + log.raw(err) + log.info(`File for ${entryLabel} not created.`) + } + return callback(null) + } + + log.info(`import for entry ${entryLabel} started.`) + if (entry.pdfurl != null) { + // It creates a file for the PDF. + return createFileAndSaveData(entry, entryLabel) + } else { + // If there is no file link set, it saves only data. + log.info(`No file to download for ${entryLabel}.`) + } + }, function (err) { + if (err) { + log.error(err) + return next() + } + + const opts = { + entries: entries.fetched, + folderPath: normalizedPath, + nameOptions: options, + tags, + model, + log + } + return checkForMissingFiles(opts, () => next()) + }) + } +} + +// For each entry, ensure that the corresponding file exists in the Cozy Files +// application. If it doesn't exist, it creates the file by downloading it +// from its url. +var checkForMissingFiles = function (options, callback) { + const {entries, folderPath, nameOptions, tags, log} = options + + return async.eachSeries(entries, function (entry, done) { + const fileName = naming.getEntryFileName(entry, nameOptions) + let path = `${folderPath}/${fileName}` + + // Check if the file is there. + return File.isPresent(path, function (err, isPresent) { + if (err) { + log.error(err) + return done() + } + // If it's there, it does nothing. + if (isPresent || (entry.pdfurl == null)) { return done() } + + // If it's not there, it creates it. + const url = entry.pdfurl + path = folderPath + + return Folder.mkdirp(path, () => + File.createNew(fileName, path, url, tags, function (err, file) { + if (err) { + log.error('An error occured while creating file') + return log.raw(err) + } else { + done() + } + }) + ) + }) + }, err => { + if (err) { + log.error(err) + } + return callback() + }) +} diff --git a/manifest.konnectors b/manifest.konnectors new file mode 100644 index 0000000..b83c607 --- /dev/null +++ b/manifest.konnectors @@ -0,0 +1,35 @@ +{ + "version": "1.0.0", + "name": "konnector name", + "type": "node", + "slug": "konnectorslug", + "description": "description", + "source": "git://github.com/cozy/cozy-konnector-thename.git", + "locales": { + "fr": { + "description": "Récupère toutes vos factures", + "permissions": { + "bills": { + "description": "Utilisé pour sauvegarder les données de facturation" + }, + "files": { + "description": "Utilisé pour sauvegarder les factures" + } + } + } + }, + "permissions": { + "bills": { + "description": "Required to save the bills data", + "type": "io.cozy.bills" + }, + "files": { + "description": "Required to save the bills", + "type": "io.cozy.files" + } + }, + "developer": { + "name": "yourname", + "url": "your web site" + } +} diff --git a/models/bill.js b/models/bill.js new file mode 100644 index 0000000..ec9d953 --- /dev/null +++ b/models/bill.js @@ -0,0 +1,47 @@ +const cozy = require('../lib/cozyclient') +const moment = require('moment') + +module.exports = { + displayName: "Bill", + all(callback) { + cozy.authorize() + .then(() => { + return cozy.data.defineIndex("io.cozy.bills", ["date"]) + }) + .then((index) => { + return cozy.data.query(index, {"selector": {date: {"$gt": 0}}}) + }) + .then(bills => { + bills = bills.map(bill => { + bill.date = moment(bill.date) + return bill + }) + callback(null, bills) + }) + .catch(err => { + callback(err) + }) + }, + create(entry, callback) { + cozy.data.create("io.cozy.bills", entry) + .then(() => callback()) + .catch(err => callback(err)) + } +} + +// module.exports = Bill = cozydb.getModel('Bill', { +// type: String, +// subtype: String, +// date: Date, +// vendor: String, +// amount: Number, +// plan: String, +// pdfurl: String, +// binaryId: String, +// fileId: String, +// content: String, +// isRefund: Boolean, +// clientId: String, // Client number in vendor CRM +// number: String, // Bill Id, in vendor CRM +// docTypeVersion: String +// }) // Document traceability : appName_Konnector-version diff --git a/models/cozy_instance.js b/models/cozy_instance.js new file mode 100644 index 0000000..52276b7 --- /dev/null +++ b/models/cozy_instance.js @@ -0,0 +1,51 @@ +let CozyInstance +const americano = require('cozydb') + +// Required to get locale and domain data. +module.exports = CozyInstance = americano.getModel('CozyInstance', { + id: String, + domain: String, + locale: String, + connectedOnce: Boolean, + background: String +} +) + +// Retrieve cozy instance object. +CozyInstance.first = callback => { + CozyInstance.request('all', function (err, instances) { + if (err) { + return callback(err) + } else if (!instances || (instances.length === 0)) { + return callback(null, null) + } else { + return callback(null, instances[0]) + } + }) +} + +// Extract locale parameter from instance object. +CozyInstance.getLocale = callback => +CozyInstance.request('all', function (err, instances) { + if (err) { console.log(err) } + return callback(null, __guard__(instances != null ? instances[0] : undefined, x => x.locale) || 'en') +}) + +// Extract URL parameter from instance object. +CozyInstance.getURL = callback => +CozyInstance.first(function (err, instance) { + if (err) { + return callback(err) + } else if ((instance != null ? instance.domain : undefined)) { + const url = instance.domain + .replace('http://', '') + .replace('https://', '') + return callback(null, `https://${url}/`) + } else { + return callback(new Error('No instance domain set')) + } +}) + +function __guard__ (value, transform) { + return (typeof value !== 'undefined' && value !== null) ? transform(value) : undefined +} diff --git a/models/file.js b/models/file.js new file mode 100644 index 0000000..18b398e --- /dev/null +++ b/models/file.js @@ -0,0 +1,63 @@ +const request = require('request') +const log = require('printit')({prefix: 'konnectors'}) +const cozy = require('../lib/cozyclient') + +module.exports = { + isPresent (fullPath, callback) { + cozy.files.statByPath(fullPath) + .then(file => { + callback(null, true) + }) + .catch(err => callback(null, false)) + }, + createNew (fileName, path, url, tags, callback, requestoptions) { + cozy.files.statByPath(path) + .then(folder => { + let options = {} + if (requestoptions) { + options = requestoptions + if (typeof options.form === 'function') { + options.form = options.form(options.entry) + } + options.uri = url + } else { + options = { + uri: url, + method: 'GET', + jar: true + } + } + + log.info(`Downloading file at ${url}...`) + return cozy.files.create(request(options), {name: fileName, dirID: folder._id}) + }) + .then(thefile => { + callback(null, thefile) + }) + .catch(err => callback(err)) + } +} + +// Required to save file fetched via a konnector. +// module.exports = (File = americano.getModel('File', { +// path: String, +// name: String, +// creationDate: String, +// lastModification: String, +// class: String, +// mime: String, +// size: Number, +// binary: Object, +// modificationHistory: Object, +// clearance: [Object], +// tags: [String] +// })) +// File.byFullPath = (params, callback) => { +// File.request('byFullPath', params, callback) +// } + +// Tells if a file is already stored in the Cozy at the given path. + +// Create a new File object that will be displayed inside the file application. +// The binary attached to the file is downloaded from a given url. +// Given tags are associated with the newly created file. diff --git a/models/folder.js b/models/folder.js new file mode 100644 index 0000000..57a4e07 --- /dev/null +++ b/models/folder.js @@ -0,0 +1,78 @@ +const async = require('async') +const log = require('printit')({prefix: 'konnectors'}) +const cozy = require('../lib/cozyclient') + +// Folder model is used to list the list of available folders in the user's +// Cozy. It's required for konnectors that download files like bill PDFs. +module.exports = { + mkdirp (path, callback) { + const cleanPath = path.charAt(0) === '/' ? path.substring(1) : path + if (cleanPath.length === 0) { return callback(new Error('empty path')) } + + const folders = cleanPath.split('/') + const createFolder = (folder, callback) => { + const folderIndex = folders.indexOf(folder) + return this.mkdir({ + name: folder, + path: [''].concat(folders.slice(0, folderIndex)).join('/') + }, callback) + } + + return async.eachSeries(folders, createFolder, callback) + }, + mkdir ({name, path}, callback) { + if (name.length === 0) { return callback(null, {path}) } + + return this.isPresent({name, path}, (err, isPresent) => { + if (err) return callback(err) + if (isPresent) { + return callback(null, {name, path}) + } else { + return this.createNewFolder({name, path}, callback) + } + }) + }, + isPresent ({name, path}, callback) { + cozy.files.statByPath(`${path}/${name}`) + .then(folder => { + callback(null, true) + }) + .catch(err => callback(null, false)) + }, + createNewFolder (folder, callback) { + const path = (folder.path !== '') ? folder.path : '/' + cozy.files.statByPath(path) + .then(file => { + return cozy.files.createDirectory({name: folder.name, dirID: file._id}) + }) + .then(() => { + callback(null, folder) + }) + .catch(err => callback(err)) + } +} + +// module.exports = (Folder = americano.getModel('Folder', { +// path: String, +// name: String +// })) + +// Get full path for given folder. +// Folder.prototype.getFullPath = function () { +// return `${this.path}/${this.name}` +// } + +// Return folder list ordered by full path. +// Folder.all = callback => +// Folder.request('byFullPath', function (err, folders) { +// if (err) { return callback(err) } +// return callback(null, folders) +// }) + +// Folder.allPath = callback => +// Folder.all(function (err, folders) { +// if (err) { return callback(err) } +// folders = folders.map(folder => folder.getFullPath()) +// return callback(err, folders) +// }) + diff --git a/package.json b/package.json new file mode 100644 index 0000000..ec4dd96 --- /dev/null +++ b/package.json @@ -0,0 +1,23 @@ +{ + "name": "cozy-konnector-newkonnectorname", + "version": "1.0.0", + "description": "", + "keywords": [], + "author": "", + "license": "AGPL-3.0", + "dependencies": { + "btoa": "^1.1.2", + "cheerio": "^0.22.0", + "core-js": "^2.4.1", + "cozy-client-js": "^0.1.8", + "isomorphic-fetch": "^2.2.1", + "node-polyglot": "^2.2.2", + "pouchdb": "^6.1.2", + "pouchdb-find": "^0.10.5", + "printit": "^0.1.20", + "regenerator-runtime": "^0.10.3", + "request": "^2.81.0", + "request-json": "^0.6.1", + "ware": "^1.3.0" + } +}