├── .gitignore ├── .travis.yml ├── CHANGELOG ├── LICENSE ├── README.md ├── manage.py ├── requirements_test.txt ├── rest_invitations ├── __init__.py ├── app_settings.py ├── models.py ├── serializers.py ├── urls.py ├── utils.py └── views.py ├── setup.cfg ├── setup.py ├── test_settings.py ├── test_urls.py ├── tests ├── __init__.py └── tests.py └── tox.ini /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | 103 | .idea -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: false 2 | language: python 3 | python: 4 | - "3.5" 5 | - "3.6" 6 | - "3.7" 7 | - "3.8" 8 | 9 | cache: 10 | directories: 11 | - $HOME/.cache/pip 12 | - $TRAVIS_BUILD_DIR/.tox 13 | 14 | install: 15 | - pip install --upgrade pip wheel setuptools 16 | - pip install tox-travis coveralls 17 | 18 | branches: 19 | - develop 20 | - master 21 | 22 | script: tox 23 | 24 | after_success: 25 | - coveralls 26 | -------------------------------------------------------------------------------- /CHANGELOG: -------------------------------------------------------------------------------- 1 | 0.1.0 (2018-02-26) 2 | ---------------- 3 | 4 | - First release 5 | 6 | 0.1.1 (2018-07-27) 7 | ---------------- 8 | 9 | - Handle delete operation on InvitationViewSet 10 | 11 | 12 | 0.1.2 (2020-04-29) 13 | ---------------- 14 | 15 | - DRF 3.10 support 16 | - Drop support for python 2.7 and python 3.4 17 | - Add support for python 3.8 18 | - Add support for django 3.0 19 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ## django-rest-invitations 2 | 3 | 4 | [![Build Status](https://travis-ci.org/fmarco/django-rest-invitations.svg?branch=master)](https://travis-ci.org/fmarco/django-rest-invitations) 5 | 6 | [![Coverage Status](https://coveralls.io/repos/fmarco/django-rest-invitations/badge.svg?branch=master&service=github)](https://coveralls.io/github/fmarco/django-rest-invitations?branch=master) 7 | 8 | Rest customizable extension for [django-invitations](https://github.com/bee-keeper/django-invitations) 9 | 10 | Supported Python versions: 11 | 12 | * 3.5 13 | * 3.6 14 | * 3.7 15 | * 3.8 16 | 17 | Supported Django versions: 18 | 19 | * Django 1.11 20 | * Django 2.0 21 | * Django 3.0 22 | 23 | Supported DRF versions: 24 | 25 | * at least DRF 3.10 or greater 26 | 27 | ### Requirements 28 | 29 | Make a proper setup for django-invitations. 30 | 31 | 32 | ### Installation 33 | 34 | ``` 35 | # Add to settings.py, INSTALLED_APPS 36 | 'rest_framework', 37 | 'invitations', 38 | 'rest_invitations' 39 | 40 | # Append to urls.py 41 | url(r'^', include('rest_invitations.urls')) 42 | ``` 43 | 44 | ### Configuration 45 | 46 | * `INVITATION_SERIALIZER_READ` (default=`rest_invitations.serializers.InvitationReadSerializer`) 47 | 48 | Path. Serializer class for invitations (read) 49 | 50 | * `INVITATION_SERIALIZER_WRITE` (default=`rest_invitations.serializers.InvitationWriteSerializer`) 51 | 52 | Path. Serializer class for invitations (write) 53 | 54 | * `INVITATION_SERIALIZER_WRITE_BULK` (default=`rest_invitations.serializers.InvitationBulkWriteSerializer`) 55 | 56 | Path. Serializer class for invitations (bulk write) 57 | 58 | * `INVITATION_API_BASE_URL` (default=`invitations`) 59 | 60 | String. Base api url. 61 | 62 | * `INVITATION_SEND_URL` (default=`send`) 63 | 64 | String. Set up url on send endpoint 65 | 66 | * `INVITATION_CREATE_AND_SEND_URL` (default=`create-and-send`) 67 | 68 | String. Set up url on create_and_send endpoint 69 | 70 | * `INVITATION_SEND_MULTIPLE_URL` (default=`send-multiple`) 71 | 72 | String. Set up url on send_multiple endpoint 73 | 74 | * `INVITATION_ACCEPT_INVITE_URL` (default=`accept-invite`) 75 | 76 | String. Set up url for accept_invitation endpoint 77 | 78 | 79 | ### APIs (examples with default values) 80 | 81 | * `Invitations list` 82 | 83 | - /invitations/ (list, create) 84 | 85 | body request (create): email (string) 86 | 87 | * `Invitation detail` 88 | 89 | - /invitations/``/ (retrieve, destroy) 90 | 91 | * `Invitation send` 92 | 93 | - /invitations/``/send/ (post) 94 | 95 | body request: None 96 | 97 | * `Invitation create and send` 98 | 99 | - /invitations/create-and-send/ (post) 100 | 101 | body request: email (string) 102 | 103 | * `Invitation multiple send` 104 | 105 | - /invitations/send-multiple/ (post) 106 | 107 | body request: email: list of strings 108 | 109 | * `Accept invitation` 110 | 111 | - /invitations/accept-invite/``/ (get) 112 | 113 | 114 | 115 | ### Contributions 116 | 117 | Feel free to contribute! 118 | -------------------------------------------------------------------------------- /manage.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | import os 3 | os.environ['DJANGO_SETTINGS_MODULE'] = 'test_settings' 4 | 5 | from django.core import management 6 | 7 | if __name__ == "__main__": 8 | management.execute_from_command_line() -------------------------------------------------------------------------------- /requirements_test.txt: -------------------------------------------------------------------------------- 1 | coverage>=3.7.1 2 | -------------------------------------------------------------------------------- /rest_invitations/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fmarco/django-rest-invitations/9a9278069744c1374cdffca1b24c91734af2c41b/rest_invitations/__init__.py -------------------------------------------------------------------------------- /rest_invitations/app_settings.py: -------------------------------------------------------------------------------- 1 | from django.conf import settings 2 | from invitations.utils import get_invitation_model 3 | 4 | from .serializers import \ 5 | InvitationBulkWriteSerializer as DefaultInvitationBulkWriteSerializer 6 | from .serializers import \ 7 | InvitationReadSerializer as DefaultInvitationReadSerializer 8 | from .serializers import \ 9 | InvitationWriteSerializer as DefaultInvitationWriteSerializer 10 | from .utils import import_callable 11 | 12 | # Serializers 13 | InvitationReadSerializer = import_callable( 14 | getattr( 15 | settings, 16 | 'INVITATION_SERIALIZER_READ', 17 | DefaultInvitationReadSerializer 18 | ) 19 | ) 20 | InvitationWriteSerializer = import_callable( 21 | getattr( 22 | settings, 23 | 'INVITATION_SERIALIZER_WRITE', 24 | DefaultInvitationWriteSerializer 25 | ) 26 | ) 27 | InvitationBulkWriteSerializer = import_callable( 28 | getattr( 29 | settings, 30 | 'INVITATION_SERIALIZER_WRITE_BULK', 31 | DefaultInvitationBulkWriteSerializer 32 | ) 33 | ) 34 | 35 | # Urls 36 | API_BASE_URL = getattr( 37 | settings, 'INVITATION_API_BASE_URL', 'invitations' 38 | ) 39 | ACCEPT_INVITE_URL = getattr( 40 | settings, 'INVITATION_ACCEPT_INVITE_URL', 'accept-invite' 41 | ) 42 | SEND_URL = getattr( 43 | settings, 'INVITATION_SEND_URL', 'send' 44 | ) 45 | CREATE_AND_SEND_URL = getattr( 46 | settings, 'INVITATION_CREATE_AND_SEND_URL', 'create-and-send' 47 | ) 48 | SEND_MULTIPLE_URL = getattr( 49 | settings, 'INVITATION_SEND_MULTIPLE_URL', 'send-multiple' 50 | ) 51 | 52 | # Get Invitation model 53 | InvitationModel = get_invitation_model() 54 | -------------------------------------------------------------------------------- /rest_invitations/models.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fmarco/django-rest-invitations/9a9278069744c1374cdffca1b24c91734af2c41b/rest_invitations/models.py -------------------------------------------------------------------------------- /rest_invitations/serializers.py: -------------------------------------------------------------------------------- 1 | from django.contrib.auth import get_user_model 2 | from django.utils.translation import ugettext_lazy as _ 3 | from invitations.adapters import get_invitations_adapter 4 | from invitations.exceptions import (AlreadyAccepted, AlreadyInvited, 5 | UserRegisteredEmail) 6 | from invitations.utils import get_invitation_model 7 | from rest_framework import serializers 8 | 9 | InvitationModel = get_invitation_model() 10 | 11 | 12 | errors = { 13 | "already_invited": _("This e-mail address has already been" 14 | " invited."), 15 | "already_accepted": _("This e-mail address has already" 16 | " accepted an invite."), 17 | "email_in_use": _("An active user is using this e-mail address"), 18 | } 19 | 20 | 21 | class EmailListField(serializers.ListField): 22 | child = serializers.EmailField() 23 | 24 | 25 | class InvitationWriteSerializer(serializers.ModelSerializer): 26 | class Meta: 27 | model = InvitationModel 28 | fields = ('email',) 29 | 30 | def _validate_invitation(self, email): 31 | if InvitationModel.objects.all_valid().filter( 32 | email__iexact=email, accepted=False): 33 | raise AlreadyInvited 34 | elif InvitationModel.objects.filter( 35 | email__iexact=email, accepted=True): 36 | raise AlreadyAccepted 37 | elif get_user_model().objects.filter(email__iexact=email): 38 | raise UserRegisteredEmail 39 | else: 40 | return True 41 | 42 | def validate_email(self, email): 43 | email = get_invitations_adapter().clean_email(email) 44 | 45 | try: 46 | self._validate_invitation(email) 47 | except(AlreadyInvited): 48 | raise serializers.ValidationError(errors["already_invited"]) 49 | except(AlreadyAccepted): 50 | raise serializers.ValidationError(errors["already_accepted"]) 51 | except(UserRegisteredEmail): 52 | raise serializers.ValidationError(errors["email_in_use"]) 53 | return email 54 | 55 | def create(self, validate_data): 56 | return InvitationModel.create(**validate_data) 57 | 58 | 59 | class InvitationReadSerializer(serializers.ModelSerializer): 60 | class Meta: 61 | model = InvitationModel 62 | fields = '__all__' 63 | 64 | 65 | class InvitationBulkWriteSerializer(InvitationWriteSerializer): 66 | 67 | email = EmailListField() 68 | 69 | class Meta(InvitationWriteSerializer.Meta): 70 | model = InvitationModel 71 | fields = InvitationWriteSerializer.Meta.fields 72 | 73 | def validate_email(self, email_list): 74 | if len(email_list) == 0: 75 | raise serializers.ValidationError( 76 | _('You must add one or more email addresses') 77 | ) 78 | for email in email_list: 79 | email = get_invitations_adapter().clean_email(email) 80 | try: 81 | self._validate_invitation(email) 82 | except(AlreadyInvited): 83 | raise serializers.ValidationError(errors["already_invited"]) 84 | except(AlreadyAccepted): 85 | raise serializers.ValidationError(errors["already_accepted"]) 86 | except(UserRegisteredEmail): 87 | raise serializers.ValidationError(errors["email_in_use"]) 88 | return email_list 89 | -------------------------------------------------------------------------------- /rest_invitations/urls.py: -------------------------------------------------------------------------------- 1 | from django.conf.urls import include, url 2 | from rest_framework import routers 3 | 4 | from .app_settings import ACCEPT_INVITE_URL, API_BASE_URL 5 | from .views import InvitationViewSet, accept_invitation 6 | 7 | router = routers.SimpleRouter() 8 | router.register(r'{0}'.format(API_BASE_URL), InvitationViewSet) 9 | 10 | invitations_patterns = ( 11 | [ 12 | url( 13 | r'^{0}/{1}/(?P\w+)/?$'.format( 14 | API_BASE_URL, ACCEPT_INVITE_URL 15 | ), 16 | accept_invitation, 17 | name='accept-invite' 18 | ), 19 | ], 20 | 'invitations' 21 | ) 22 | 23 | urlpatterns = router.urls + [ 24 | url(r'^', include(invitations_patterns)), 25 | ] 26 | -------------------------------------------------------------------------------- /rest_invitations/utils.py: -------------------------------------------------------------------------------- 1 | from importlib import import_module 2 | 3 | 4 | def import_callable(path): 5 | if hasattr(path, '__call__'): 6 | return path 7 | else: 8 | module, attr_name = path.rsplit('.', 1) 9 | print(module, attr_name) 10 | return getattr(import_module(module), attr_name) 11 | -------------------------------------------------------------------------------- /rest_invitations/views.py: -------------------------------------------------------------------------------- 1 | from django.contrib import messages 2 | from invitations.adapters import get_invitations_adapter 3 | from invitations.app_settings import app_settings as invitations_settings 4 | from invitations.signals import invite_accepted 5 | from rest_framework import mixins, status, viewsets 6 | from rest_framework.decorators import action, api_view, permission_classes 7 | from rest_framework.permissions import AllowAny, IsAuthenticated 8 | from rest_framework.response import Response 9 | 10 | from .app_settings import (CREATE_AND_SEND_URL, SEND_MULTIPLE_URL, SEND_URL, 11 | InvitationBulkWriteSerializer, InvitationModel, 12 | InvitationReadSerializer, InvitationWriteSerializer) 13 | 14 | 15 | class InvitationViewSet( 16 | mixins.RetrieveModelMixin, 17 | mixins.ListModelMixin, 18 | mixins.CreateModelMixin, 19 | mixins.DestroyModelMixin, 20 | viewsets.GenericViewSet 21 | ): 22 | queryset = InvitationModel.objects.all() 23 | permission_classes = [IsAuthenticated] 24 | 25 | def get_serializer_class(self): 26 | if self.action in ['list', 'retrieve']: 27 | return InvitationReadSerializer 28 | elif self.action == 'send_multiple': 29 | return InvitationBulkWriteSerializer 30 | return InvitationWriteSerializer 31 | 32 | def _prepare_and_send(self, invitation, request): 33 | invitation.inviter = request.user 34 | invitation.save() 35 | invitation.send_invitation(request) 36 | 37 | @action( 38 | detail=True, 39 | methods=['post'], permission_classes=[IsAuthenticated], 40 | url_path=SEND_URL 41 | ) 42 | def send(self, request, pk=None): 43 | invitation = self.get_object() 44 | self._prepare_and_send(invitation, request) 45 | content = {'detail': 'Invite sent'} 46 | return Response(content, status=status.HTTP_200_OK) 47 | 48 | @action( 49 | detail=False, 50 | methods=['post'], permission_classes=[IsAuthenticated], 51 | url_path=CREATE_AND_SEND_URL 52 | ) 53 | def create_and_send(self, request): 54 | serializer = self.get_serializer(data=request.data) 55 | serializer.is_valid(raise_exception=True) 56 | email = serializer.data['email'] 57 | invitation = InvitationModel.create(email=email, inviter=request.user) 58 | self._prepare_and_send(invitation, request) 59 | content = {'detail': 'Invite sent'} 60 | return Response(content, status=status.HTTP_200_OK) 61 | 62 | @action( 63 | detail=False, 64 | methods=['post'], permission_classes=[IsAuthenticated], 65 | url_path=SEND_MULTIPLE_URL 66 | ) 67 | def send_multiple(self, request): 68 | serializer = self.get_serializer(data=request.data) 69 | serializer.is_valid(raise_exception=True) 70 | inviter = request.user 71 | for email in serializer.data['email']: 72 | invitation = InvitationModel.create(email=email, inviter=inviter) 73 | self._prepare_and_send(invitation, request) 74 | content = {'detail': 'Invite(s) sent'} 75 | return Response(content, status=status.HTTP_200_OK) 76 | 77 | 78 | @api_view(('POST', 'GET')) 79 | @permission_classes((AllowAny,)) 80 | def accept_invitation(request, key): 81 | def get_object(): 82 | try: 83 | return InvitationModel.objects.get(key=key.lower()) 84 | except InvitationModel.DoesNotExist: 85 | return None 86 | 87 | invitation = get_object() 88 | 89 | login_data = { 90 | 'LOGIN_REDIRECT': invitations_settings.LOGIN_REDIRECT 91 | } 92 | signup_data = { 93 | 'SIGNUP_REDIRECT': invitations_settings.SIGNUP_REDIRECT 94 | } 95 | 96 | if invitations_settings.GONE_ON_ACCEPT_ERROR and \ 97 | (not invitation or 98 | (invitation and (invitation.accepted or 99 | invitation.key_expired()))): 100 | return Response(status=status.HTTP_410_GONE) 101 | 102 | if not invitation: 103 | get_invitations_adapter().add_message( 104 | request, 105 | messages.ERROR, 106 | 'invitations/messages/invite_invalid.txt' 107 | ) 108 | return Response(login_data, status=status.HTTP_200_OK) 109 | 110 | if invitation.accepted: 111 | get_invitations_adapter().add_message( 112 | request, 113 | messages.ERROR, 114 | 'invitations/messages/invite_already_accepted.txt', 115 | { 116 | 'email': invitation.email 117 | } 118 | ) 119 | return Response(login_data, status=status.HTTP_200_OK) 120 | 121 | if invitation.key_expired(): 122 | get_invitations_adapter().add_message( 123 | request, 124 | messages.ERROR, 125 | 'invitations/messages/invite_expired.txt', 126 | { 127 | 'email': invitation.email 128 | } 129 | ) 130 | return Response(signup_data, status=status.HTTP_200_OK) 131 | 132 | if not invitations_settings.ACCEPT_INVITE_AFTER_SIGNUP: 133 | invitation.accepted = True 134 | invitation.save() 135 | invite_accepted.send(sender=None, email=invitation.email) 136 | get_invitations_adapter().add_message( 137 | request, 138 | messages.SUCCESS, 139 | 'invitations/messages/invite_accepted.txt', 140 | { 141 | 'email': invitation.email 142 | } 143 | ) 144 | signup_data.update( 145 | { 146 | 'account_verified_email': invitation.email 147 | } 148 | ) 149 | return Response( 150 | signup_data, 151 | status=status.HTTP_200_OK 152 | ) 153 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [metadata] 2 | description-file = README.md -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from setuptools import setup, find_packages 2 | 3 | 4 | setup( 5 | name='django-rest-invitations', 6 | version='0.1.2', 7 | author='Marco Federighi', 8 | author_email='federighi.marco@gmail.com', 9 | url='http://github.com/fmarco/django-rest-invitations', 10 | description='Create a set of REST API endpoints to handle invitations', 11 | packages=find_packages(), 12 | keywords=['django', 'invitation', 'django-allauth', 'invite', 'rest', 'django-rest-framework', 'drf', 'invitations'], 13 | zip_safe=False, 14 | install_requires=[ 15 | 'djangorestframework>=3.10', 16 | 'django-invitations==1.9.3' 17 | ], 18 | include_package_data=True, 19 | classifiers=[ 20 | 'Framework :: Django', 21 | 'Intended Audience :: Developers', 22 | 'Intended Audience :: System Administrators', 23 | 'Operating System :: OS Independent', 24 | 'Topic :: Software Development' 25 | ], 26 | ) -------------------------------------------------------------------------------- /test_settings.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | import django 3 | 4 | SECRET_KEY = 'sosecret' 5 | SITE_ID = 1 6 | 7 | DATABASES = { 8 | 'default': { 9 | 'ENGINE': 'django.db.backends.sqlite3', 10 | 'NAME': ':memory:', 11 | } 12 | } 13 | 14 | ROOT_URLCONF = 'test_urls' 15 | 16 | if django.VERSION >= (1, 8): 17 | TEMPLATES = [ 18 | { 19 | 'BACKEND': 'django.template.backends.django.DjangoTemplates', 20 | 'DIRS': [], 21 | 'APP_DIRS': True, 22 | 'OPTIONS': { 23 | 'context_processors': [ 24 | 'django.template.context_processors.debug', 25 | 'django.template.context_processors.request', 26 | 'django.contrib.auth.context_processors.auth', 27 | 'django.contrib.messages.context_processors.messages' 28 | ], 29 | }, 30 | }, 31 | ] 32 | else: 33 | TEMPLATE_CONTEXT_PROCESSORS = ( 34 | "django.contrib.auth.context_processors.auth", 35 | "django.core.context_processors.debug", 36 | "django.core.context_processors.i18n", 37 | "django.core.context_processors.media", 38 | "django.core.context_processors.static", 39 | "django.core.context_processors.request", 40 | "django.contrib.messages.context_processors.messages", 41 | ) 42 | 43 | 44 | MIDDLEWARE = ( 45 | 'django.contrib.sessions.middleware.SessionMiddleware', 46 | 'django.middleware.common.CommonMiddleware', 47 | 'django.middleware.csrf.CsrfViewMiddleware', 48 | 'django.contrib.auth.middleware.AuthenticationMiddleware', 49 | 'django.contrib.messages.middleware.MessageMiddleware', 50 | 'django.middleware.clickjacking.XFrameOptionsMiddleware', 51 | ) 52 | 53 | EMAIL_BACKEND = 'django.core.mail.backends.locmem.EmailBackend' 54 | 55 | INSTALLED_APPS = ( 56 | 'django.contrib.auth', 57 | 'django.contrib.admin', 58 | 'django.contrib.contenttypes', 59 | 'django.contrib.sessions', 60 | 'django.contrib.sites', 61 | 'django.contrib.messages', 62 | 'invitations', 63 | 'rest_framework', 64 | 'rest_invitations' 65 | ) 66 | AUTHENTICATION_BACKENDS = ( 67 | 'django.contrib.auth.backends.ModelBackend', 68 | ) -------------------------------------------------------------------------------- /test_urls.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | from django.conf.urls import include, url 3 | from django.contrib import admin 4 | 5 | 6 | urlpatterns = [ 7 | url(r'^admin/', admin.site.urls), 8 | url(r'^', include('rest_invitations.urls')) 9 | ] 10 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/fmarco/django-rest-invitations/9a9278069744c1374cdffca1b24c91734af2c41b/tests/__init__.py -------------------------------------------------------------------------------- /tests/tests.py: -------------------------------------------------------------------------------- 1 | from django.contrib.auth import get_user_model 2 | from django.core import mail 3 | from django.urls import reverse 4 | from django.utils import timezone 5 | from invitations.utils import get_invitation_model 6 | from rest_framework import status 7 | from rest_framework.test import APITestCase 8 | 9 | User = get_user_model() 10 | Invitation = get_invitation_model() 11 | 12 | 13 | class TestInvitationAPI(APITestCase): 14 | 15 | @classmethod 16 | def setUpClass(cls): 17 | super(TestInvitationAPI, cls).setUpClass() 18 | cls.user = User.objects.create_user( 19 | email='user@example.org', username='test_user', password='test' 20 | ) 21 | 22 | def test_invitation_send(self): 23 | self.assertEqual(len(mail.outbox), 0) 24 | invitation = Invitation.create(email='invited@example.org') 25 | url = reverse('invitation-send', kwargs={'pk': invitation.pk}) 26 | response = self.client.post(url, format='json') 27 | self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) 28 | self.assertEqual(len(mail.outbox), 0) 29 | self.client.login(username=self.user.username, password='test') 30 | url = reverse('invitation-send', kwargs={'pk': invitation.pk}) 31 | response = self.client.post(url, format='json') 32 | self.assertEqual(response.status_code, status.HTTP_200_OK) 33 | self.assertEqual(len(mail.outbox), 1) 34 | 35 | def test_invitation_create_and_send(self): 36 | self.assertEqual(len(mail.outbox), 0) 37 | self.assertEqual(Invitation.objects.count(), 0) 38 | url = reverse('invitation-create-and-send') 39 | data = {} 40 | response = self.client.post(url, data, format='json') 41 | self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) 42 | self.assertEqual(Invitation.objects.count(), 0) 43 | self.client.login(username=self.user.username, password='test') 44 | response = self.client.post(url, data, format='json') 45 | self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) 46 | self.assertEqual(Invitation.objects.count(), 0) 47 | self.assertEqual(len(mail.outbox), 0) 48 | data = {'email': 'invite@me.org'} 49 | response = self.client.post(url, data, format='json') 50 | self.assertEqual(response.status_code, status.HTTP_200_OK) 51 | self.assertEqual(len(mail.outbox), 1) 52 | self.assertEqual(Invitation.objects.count(), 1) 53 | 54 | def test_invitation_send_multiple(self): 55 | self.assertEqual(len(mail.outbox), 0) 56 | self.assertEqual(Invitation.objects.count(), 0) 57 | url = reverse('invitation-send-multiple') 58 | data = {} 59 | response = self.client.post(url, data, format='json') 60 | self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN) 61 | self.assertEqual(Invitation.objects.count(), 0) 62 | self.client.login(username=self.user.username, password='test') 63 | response = self.client.post(url, data, format='json') 64 | self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) 65 | self.assertEqual(Invitation.objects.count(), 0) 66 | self.assertEqual(len(mail.outbox), 0) 67 | data = {'email': []} 68 | response = self.client.post(url, data, format='json') 69 | self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) 70 | self.assertEqual(len(mail.outbox), 0) 71 | self.assertEqual(Invitation.objects.count(), 0) 72 | data = {'email': ['invite@me.org', 'invite2@alt.com']} 73 | response = self.client.post(url, data, format='json') 74 | self.assertEqual(response.status_code, status.HTTP_200_OK) 75 | self.assertEqual(len(mail.outbox), 2) 76 | self.assertEqual(Invitation.objects.count(), 2) 77 | data = {'email': ['invite@me.org', 'invite2@alt.com']} 78 | response = self.client.post(url, data, format='json') 79 | self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) 80 | self.assertEqual(len(mail.outbox), 2) 81 | self.assertEqual(Invitation.objects.count(), 2) 82 | data = {'email': ['invite@me.org']} 83 | response = self.client.post(url, data, format='json') 84 | self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) 85 | self.assertEqual(len(mail.outbox), 2) 86 | self.assertEqual(Invitation.objects.count(), 2) 87 | data = {'email': ['invite2@alt.com']} 88 | response = self.client.post(url, data, format='json') 89 | self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) 90 | self.assertEqual(len(mail.outbox), 2) 91 | self.assertEqual(Invitation.objects.count(), 2) 92 | 93 | def test_invitation_accept(self): 94 | invitation = Invitation.create( 95 | email='invited@email.org', 96 | inviter=self.user 97 | ) 98 | invitation_pk = invitation.pk 99 | invitation.sent = timezone.now() 100 | invitation.save() 101 | url = reverse('invitations:accept-invite', kwargs={'key': 'something'}) 102 | data = {} 103 | response = self.client.post(url, data, format='json') 104 | self.assertEqual(response.status_code, status.HTTP_410_GONE) 105 | self.assertFalse(invitation.accepted) 106 | url = reverse( 107 | 'invitations:accept-invite', 108 | kwargs={'key': invitation.key} 109 | ) 110 | response = self.client.post(url, data, format='json') 111 | self.assertEqual(response.status_code, status.HTTP_200_OK) 112 | invitation = Invitation.objects.get(pk=invitation_pk) 113 | self.assertTrue(invitation.accepted) 114 | response = self.client.post(url, data, format='json') 115 | self.assertEqual(response.status_code, status.HTTP_410_GONE) 116 | 117 | def tearDown(self): 118 | self.client.logout() 119 | -------------------------------------------------------------------------------- /tox.ini: -------------------------------------------------------------------------------- 1 | [tox] 2 | envlist = 3 | py35-django{111,22} 4 | py36-django{111,22,30} 5 | py37-django{111,22,3} 6 | py38-django{22,3} 7 | flake8 8 | isort 9 | 10 | [testenv] 11 | setenv = 12 | PYTHONWARNINGS = all 13 | deps = 14 | -rrequirements_test.txt 15 | django111: Django>=1.11.17,<2.0 16 | django22: Django>=2.2.6 17 | django3: Django>=3.0.1 18 | commands = 19 | python -V 20 | coverage run manage.py test --settings=test_settings 21 | coverage report 22 | 23 | [testenv:flake8] 24 | skip_install = True 25 | deps=flake8 26 | commands=flake8 rest_invitations tests --exclude=migrations 27 | 28 | [testenv:isort] 29 | deps = isort 30 | commands = isort -c -rc -df rest_invitations tests 31 | skip_install = true 32 | 33 | [coverage:run] 34 | include = rest_invitations* 35 | --------------------------------------------------------------------------------