diff --git a/.coveragerc b/.coveragerc new file mode 100644 index 0000000..895e291 --- /dev/null +++ b/.coveragerc @@ -0,0 +1,5 @@ +[report] +omit = + */site-packages/* + */python?.?/* + ckan/* diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml new file mode 100644 index 0000000..9621d28 --- /dev/null +++ b/.github/workflows/test.yml @@ -0,0 +1,48 @@ +name: Tests +on: [push, pull_request] +jobs: + test: + runs-on: ubuntu-latest + container: + # The CKAN version tag of the Solr and Postgres containers should match + # the one of the container the tests run on. + # You can switch this base image with a custom image tailored to your project + image: openknowledge/ckan-dev:2.9 + services: + solr: + image: ckan/ckan-solr-dev:2.9 + postgres: + image: ckan/ckan-postgres-dev:2.9 + env: + POSTGRES_USER: postgres + POSTGRES_PASSWORD: postgres + POSTGRES_DB: postgres + options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5 + redis: + image: redis:3 + + env: + CKAN_SQLALCHEMY_URL: postgresql://ckan_default:pass@postgres/ckan_test + CKAN_DATASTORE_WRITE_URL: postgresql://datastore_write:pass@postgres/datastore_test + CKAN_DATASTORE_READ_URL: postgresql://datastore_read:pass@postgres/datastore_test + CKAN_SOLR_URL: http://solr:8983/solr/ckan + CKAN_REDIS_URL: redis://redis:6379/1 + + steps: + - uses: actions/checkout@v2 + - name: Install requirements + # Install any extra requirements your extension has here (dev requirements, other extensions etc) + run: | + pip install -r requirements.txt + pip install -r dev-requirements.txt + pip install -e . + - name: Setup extension + # Extra initialization steps + run: | + # Replace default path to CKAN core config file with the one on the container + sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini + + ckan -c test.ini db init + - name: Run tests + run: pytest --ckan-ini=test.ini --cov=ckanext.let_me_in --disable-warnings ckanext/let_me_in + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8570dc5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,42 @@ +.ropeproject +node_modules +bower_components + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] + +# C extensions +*.so + +# Distribution / packaging +.Python +env/ +build/ +develop-eggs/ +dist/ +sdist/ +*.egg-info/ +.installed.cfg +*.egg + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.coverage +.cache +nosetests.xml +coverage.xml + +# Sphinx documentation +docs/_build/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..58777e3 --- /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/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..6b9d09b --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,5 @@ +include README.rst +include LICENSE +include requirements.txt +recursive-include ckanext/let_me_in *.html *.json *.js *.less *.css *.mo *.yml +recursive-include ckanext/let_me_in/migration *.ini *.py *.mako diff --git a/README.md b/README.md new file mode 100644 index 0000000..3bf3397 --- /dev/null +++ b/README.md @@ -0,0 +1,123 @@ +[![Tests](https://github.com/mutantsan/ckanext-let-me-in/workflows/Tests/badge.svg?branch=main)](https://github.com/mutantsan/ckanext-let-me-in/actions) + +# ckanext-let-me-in + +**TODO:** Put a description of your extension here: What does it do? What features does it have? Consider including some screenshots or embedding a video! + + +## Requirements + +**TODO:** For example, you might want to mention here which versions of CKAN this +extension works with. + +If your extension works across different versions you can add the following table: + +Compatibility with core CKAN versions: + +| CKAN version | Compatible? | +| --------------- | ------------- | +| 2.6 and earlier | not tested | +| 2.7 | not tested | +| 2.8 | not tested | +| 2.9 | not tested | + +Suggested values: + +* "yes" +* "not tested" - I can't think of a reason why it wouldn't work +* "not yet" - there is an intention to get it working +* "no" + + +## Installation + +**TODO:** Add any additional install steps to the list below. + For example installing any non-Python dependencies or adding any required + config settings. + +To install ckanext-let-me-in: + +1. Activate your CKAN virtual environment, for example: + + . /usr/lib/ckan/default/bin/activate + +2. Clone the source and install it on the virtualenv + + git clone https://github.com/mutantsan/ckanext-let-me-in.git + cd ckanext-let-me-in + pip install -e . + pip install -r requirements.txt + +3. Add `let-me-in` to the `ckan.plugins` setting in your CKAN + config file (by default the config file is located at + `/etc/ckan/default/ckan.ini`). + +4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu: + + sudo service apache2 reload + + +## Config settings + +None at present + +**TODO:** Document any optional config settings here. For example: + + # The minimum number of hours to wait before re-checking a resource + # (optional, default: 24). + ckanext.let_me_in.some_setting = some_default_value + + +## Developer installation + +To install ckanext-let-me-in for development, activate your CKAN virtualenv and +do: + + git clone https://github.com/mutantsan/ckanext-let-me-in.git + cd ckanext-let-me-in + python setup.py develop + pip install -r dev-requirements.txt + + +## Tests + +To run the tests, do: + + pytest --ckan-ini=test.ini + + +## Releasing a new version of ckanext-let-me-in + +If ckanext-let-me-in should be available on PyPI you can follow these steps to publish a new version: + +1. Update the version number in the `setup.py` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers. + +2. Make sure you have the latest version of necessary packages: + + pip install --upgrade setuptools wheel twine + +3. Create a source and binary distributions of the new version: + + python setup.py sdist bdist_wheel && twine check dist/* + + Fix any errors you get. + +4. Upload the source distribution to PyPI: + + twine upload dist/* + +5. Commit any outstanding changes: + + git commit -a + git push + +6. Tag the new release of the project on GitHub with the version number from + the `setup.py` file. For example if the version number in `setup.py` is + 0.0.1 then do: + + git tag 0.0.1 + git push --tags + +## License + +[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html) diff --git a/ckanext/__init__.py b/ckanext/__init__.py new file mode 100644 index 0000000..ed48ed0 --- /dev/null +++ b/ckanext/__init__.py @@ -0,0 +1,9 @@ +# encoding: utf-8 + +# this is a namespace package +try: + import pkg_resources + pkg_resources.declare_namespace(__name__) +except ImportError: + import pkgutil + __path__ = pkgutil.extend_path(__path__, __name__) diff --git a/ckanext/let_me_in/__init__.py b/ckanext/let_me_in/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ckanext/let_me_in/cli.py b/ckanext/let_me_in/cli.py new file mode 100644 index 0000000..c14bb29 --- /dev/null +++ b/ckanext/let_me_in/cli.py @@ -0,0 +1,33 @@ +from __future__ import annotations + +import logging + +import click + +import ckan.plugins.toolkit as tk + +logger = logging.getLogger(__name__) + +__all__ = [ + "letmein", +] + + +@click.group(short_help="Let me in!") +def letmein(): + pass + + +@letmein.command() +@click.argument("user", required=True) +def uli(user: str): + """Create a one-time login link for a user""" + + try: + result = tk.get_action("lmi_generate_otl")({"ignore_auth": True}, {"user": user}) + except tk.ValidationError as e: + return click.secho(e.error_summary, fg="red") + + click.echo() + click.echo("Your one-time login link has been generated") + click.secho(result["url"], fg="green") diff --git a/ckanext/let_me_in/logic/action.py b/ckanext/let_me_in/logic/action.py new file mode 100644 index 0000000..add9425 --- /dev/null +++ b/ckanext/let_me_in/logic/action.py @@ -0,0 +1,37 @@ +from __future__ import annotations + +from datetime import datetime as dt +from datetime import timedelta as td +from typing import cast + +import jwt + +import ckan.plugins.toolkit as tk +from ckan import types, model +from ckan.logic import validate + +import ckanext.let_me_in.logic.schema as schema +import ckanext.let_me_in.utils as lmi_utils + + +@validate(schema.lmi_generate_otl) +def lmi_generate_otl( + context: types.Context, data_dict: types.DataDict +) -> types.ActionResult.AnyDict: + """Generate a one-time login link for a specified user + + :param user: username of user_id + :type user: string + """ + tk.check_access("lmi_generate_otl", context, data_dict) + + user = cast(model.User, model.User.get(data_dict["user"])) + + token_data = { + "user_id": user.id, + "exp": dt.utcnow() + td(hours=24) + } + + token = jwt.encode(token_data, lmi_utils.get_secret(True), algorithm="HS256") + + return {"url": tk.url_for("lmi.login_with_token", token=token, _external=True)} diff --git a/ckanext/let_me_in/logic/auth.py b/ckanext/let_me_in/logic/auth.py new file mode 100644 index 0000000..6fb8bf9 --- /dev/null +++ b/ckanext/let_me_in/logic/auth.py @@ -0,0 +1,10 @@ +from __future__ import annotations + + +from ckan import types + + +def lmi_generate_otl( + context: types.Context, data_dict: types.DataDict +) -> types.AuthResult: + return {"success": False} diff --git a/ckanext/let_me_in/logic/schema.py b/ckanext/let_me_in/logic/schema.py new file mode 100644 index 0000000..888bbfe --- /dev/null +++ b/ckanext/let_me_in/logic/schema.py @@ -0,0 +1,13 @@ +from __future__ import annotations + +from typing import Any, Dict + +from ckan.logic.schema import validator_args + + +Schema = Dict[str, Any] + + +@validator_args +def lmi_generate_otl(not_empty, unicode_safe, user_id_or_name_exists) -> Schema: + return {"user": [not_empty, unicode_safe, user_id_or_name_exists]} diff --git a/ckanext/let_me_in/plugin.py b/ckanext/let_me_in/plugin.py new file mode 100644 index 0000000..43a6ce6 --- /dev/null +++ b/ckanext/let_me_in/plugin.py @@ -0,0 +1,15 @@ +import ckan.plugins as p +import ckan.plugins.toolkit as tk + + +@tk.blanket.actions +@tk.blanket.cli +@tk.blanket.auth_functions +@tk.blanket.blueprints +class LetMeInPlugin(p.SingletonPlugin): + p.implements(p.IConfigurer) + + # IConfigurer + + def update_config(self, config_): + pass diff --git a/ckanext/let_me_in/templates/.gitignore b/ckanext/let_me_in/templates/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/ckanext/let_me_in/tests/__init__.py b/ckanext/let_me_in/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/ckanext/let_me_in/tests/test_plugin.py b/ckanext/let_me_in/tests/test_plugin.py new file mode 100644 index 0000000..0f76bb8 --- /dev/null +++ b/ckanext/let_me_in/tests/test_plugin.py @@ -0,0 +1,56 @@ +""" +Tests for plugin.py. + +Tests are written using the pytest library (https://docs.pytest.org), and you +should read the testing guidelines in the CKAN docs: +https://docs.ckan.org/en/2.9/contributing/testing.html + +To write tests for your extension you should install the pytest-ckan package: + + pip install pytest-ckan + +This will allow you to use CKAN specific fixtures on your tests. + +For instance, if your test involves database access you can use `clean_db` to +reset the database: + + import pytest + + from ckan.tests import factories + + @pytest.mark.usefixtures("clean_db") + def test_some_action(): + + dataset = factories.Dataset() + + # ... + +For functional tests that involve requests to the application, you can use the +`app` fixture: + + from ckan.plugins import toolkit + + def test_some_endpoint(app): + + url = toolkit.url_for('myblueprint.some_endpoint') + + response = app.get(url) + + assert response.status_code == 200 + + +To temporary patch the CKAN configuration for the duration of a test you can use: + + import pytest + + @pytest.mark.ckan_config("ckanext.myext.some_key", "some_value") + def test_some_action(): + pass +""" +import ckanext.let_me_in.plugin as plugin + + +@pytest.mark.ckan_config("ckan.plugins", "let_me_in") +@pytest.mark.usefixtures("with_plugins") +def test_plugin(): + assert plugin_loaded("let_me_in") diff --git a/ckanext/let_me_in/utils.py b/ckanext/let_me_in/utils.py new file mode 100644 index 0000000..4508950 --- /dev/null +++ b/ckanext/let_me_in/utils.py @@ -0,0 +1,19 @@ +from __future__ import annotations + +from typing import cast + +from ckan.lib.api_token import _get_secret +from ckan import model + + +def get_secret(encode: bool) -> str: + """Return a secret string for a jwt encode/decode + + We're using an internal func here, ideally, we either need to write a custom + one or to contribute into CKAN and make it public""" + return _get_secret(encode) + + +def get_user(user_id: str) -> model.User: + """Get a user by its ID""" + return cast(model.User, model.User.get(user_id)) diff --git a/ckanext/let_me_in/views.py b/ckanext/let_me_in/views.py new file mode 100644 index 0000000..0e17be5 --- /dev/null +++ b/ckanext/let_me_in/views.py @@ -0,0 +1,35 @@ +from __future__ import annotations + +import logging +from datetime import datetime as dt + +import jwt + +from ckan.plugins import toolkit as tk +from flask import Blueprint + +import ckanext.let_me_in.utils as lmi_utils + +log = logging.getLogger(__name__) +lmi = Blueprint("lmi", __name__) + + +@lmi.route("/lmi/") +def login_with_token(token): + try: + data = jwt.decode(token, lmi_utils.get_secret(False), algorithms=["HS256"]) + + if dt.utcnow() > dt.fromtimestamp(data["exp"]): + raise (jwt.ExpiredSignatureError) + + tk.login_user(lmi_utils.get_user(data["user_id"])) + tk.h.flash_success("You have been logged in.") + + except jwt.ExpiredSignatureError: + tk.h.flash_error(tk._("The login link has expired. Please request a new one.")) + except jwt.DecodeError: + tk.h.flash_error(tk._("Invalid login link.")) + else: + return tk.h.redirect_to("user.me") + + return tk.h.redirect_to("user.login") diff --git a/dev-requirements.txt b/dev-requirements.txt new file mode 100644 index 0000000..eac82b4 --- /dev/null +++ b/dev-requirements.txt @@ -0,0 +1 @@ +pytest-ckan diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e69de29 diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..a3ff99f --- /dev/null +++ b/setup.cfg @@ -0,0 +1,61 @@ +[metadata] +name = ckanext-let-me-in +version = 0.0.1 +description = An extension that generates a one-time login link for a user +long_description = file: README.md +long_description_content_type = text/markdown +url = https://github.com/mutantsan/ckanext-let-me-in +author = Oleksandr Cherniavskyi +author_email = mutantsan@gmail.com +license = AGPL +classifiers = + Development Status :: 4 - Beta + License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+) + Programming Language :: Python :: 3.8 + Programming Language :: Python :: 3.9 + Programming Language :: Python :: 3.10 +keywords = CKAN + +[options] +packages = find: +namespace_packages = ckanext +install_requires = +include_package_data = True + +[options.entry_points] +ckan.plugins = + let_me_in = ckanext.let_me_in.plugin:LetMeInPlugin + +babel.extractors = + ckan = ckan.lib.extract:extract_ckan + +[options.extras_require] + +[extract_messages] +keywords = translate isPlural +add_comments = TRANSLATORS: +output_file = ckanext/let_me_in/i18n/ckanext-let_me_in.pot +width = 80 + +[init_catalog] +domain = ckanext-let_me_in +input_file = ckanext/let_me_in/i18n/ckanext-let_me_in.pot +output_dir = ckanext/let_me_in/i18n + +[update_catalog] +domain = ckanext-let_me_in +input_file = ckanext/let_me_in/i18n/ckanext-let_me_in.pot +output_dir = ckanext/let_me_in/i18n +previous = true + +[compile_catalog] +domain = ckanext-let_me_in +directory = ckanext/let_me_in/i18n +statistics = true + +[tool:pytest] +filterwarnings = + ignore::sqlalchemy.exc.SADeprecationWarning + ignore::sqlalchemy.exc.SAWarning + ignore::DeprecationWarning +addopts = --ckan-ini test.ini diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..4d26df7 --- /dev/null +++ b/setup.py @@ -0,0 +1,16 @@ +# -*- coding: utf-8 -*- +from setuptools import setup + +setup( + # If you are changing from the default layout of your extension, you may + # have to change the message extractors, you can read more about babel + # message extraction at + # http://babel.pocoo.org/docs/messages/#extraction-method-mapping-and-configuration + message_extractors={ + 'ckanext': [ + ('**.py', 'python', None), + ('**.js', 'javascript', None), + ('**/templates/**.html', 'ckan', None), + ], + } +) diff --git a/test.ini b/test.ini new file mode 100644 index 0000000..9c299aa --- /dev/null +++ b/test.ini @@ -0,0 +1,45 @@ +[DEFAULT] +debug = false +smtp_server = localhost +error_email_from = ckan@localhost + +[app:main] +use = config:../ckan/test-core.ini + +# Insert any custom config settings to be used when running your extension's +# tests here. These will override the one defined in CKAN core's test-core.ini +ckan.plugins = let_me_in + + +# Logging configuration +[loggers] +keys = root, ckan, sqlalchemy + +[handlers] +keys = console + +[formatters] +keys = generic + +[logger_root] +level = WARN +handlers = console + +[logger_ckan] +qualname = ckan +handlers = +level = INFO + +[logger_sqlalchemy] +handlers = +qualname = sqlalchemy.engine +level = WARN + +[handler_console] +class = StreamHandler +args = (sys.stderr,) +level = NOTSET +formatter = generic + +[formatter_generic] +format = %(asctime)s %(levelname)-5.5s [%(name)s] %(message)s