├── .gitignore ├── COPYING ├── README.rst ├── registration_api ├── __init__.py ├── models.py ├── serializers.py ├── templates │ └── registration_api │ │ ├── activation_email.txt │ │ └── activation_email_subject.txt ├── tests.py ├── urls.py ├── utils.py └── views.py ├── setup.py └── tests ├── __init__.py ├── runtests.py └── settings.py /.gitignore: -------------------------------------------------------------------------------- 1 | *~ 2 | *.pyc 3 | *.html 4 | MANIFEST 5 | /dist 6 | /build 7 | /django_registration_rest_framework.egg-info 8 | *.egg -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 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 | 635 | Copyright (C) 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 | Copyright (C) 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.rst: -------------------------------------------------------------------------------- 1 | .. note:: THIS REPOSITORY IS *NOT* MAINTAINED ANYMORE. 2 | 3 | ==================================== 4 | Django Registration Rest Framework 5 | ==================================== 6 | Clone of Django Resgistration flow for Django Rest Framework 7 | 8 | Based on 9 | ======== 10 | 11 | StackOverflow answer http://stackoverflow.com/a/19337404 12 | 13 | and 14 | 15 | django-registration https://django-registration.readthedocs.org/ 16 | 17 | Install 18 | ======= 19 | 20 | .. code-block:: 21 | 22 | $ git clone git@github.com:tucarga/django-registration-rest-framework.git 23 | 24 | $ pip install -e django-registration-rest-framework 25 | 26 | Usage 27 | ===== 28 | 29 | settings.py 30 | ----------- 31 | 32 | .. code-block:: python 33 | 34 | INSTALLED_APPS = 35 | ... 36 | 'registration_api', 37 | ... 38 | 39 | # This setting is mandatory 40 | REGISTRATION_API_ACTIVATION_SUCCESS_URL = '/' 41 | 42 | urls.py 43 | ------- 44 | 45 | .. code-block:: python 46 | 47 | urlpatterns = patterns( 48 | ... 49 | url(r'^accounts_api/', include('registration_api.urls')), 50 | ... 51 | ) 52 | 53 | Front-end 54 | --------- 55 | From your front-end or mobile application send a post to the register 56 | url 'accounts_api/register/'. The fields depends on your `AUTH_USER_MODEL` but should be 57 | something like 58 | 59 | .. code-block:: json 60 | 61 | [{"username": "john", "email": "john@example.com", "password": "verylongpassword"}] 62 | 63 | This will trigger an email to the addess specified by the user. When 64 | the user follows the link the account is activated. 65 | 66 | 67 | Test 68 | ==== 69 | .. code-block:: 70 | 71 | $ python tests/runtests.py [TestsCase[.test_method]] 72 | 73 | or 74 | 75 | .. code-block:: 76 | 77 | $ python setup.py test 78 | -------------------------------------------------------------------------------- /registration_api/__init__.py: -------------------------------------------------------------------------------- 1 | version = (0, 2, 2) 2 | 3 | 4 | def get_version(): 5 | """returns a pep compliant version number""" 6 | return '.'.join(str(i) for i in version) 7 | 8 | __version__ = get_version() 9 | -------------------------------------------------------------------------------- /registration_api/models.py: -------------------------------------------------------------------------------- 1 | import datetime 2 | 3 | from django.conf import settings 4 | from django.db import models 5 | from django.utils.timezone import now as datetime_now 6 | from django.utils.translation import ugettext_lazy as _ 7 | 8 | 9 | class RegistrationProfile(models.Model): 10 | """ 11 | A simple profile which stores an activation key for use during 12 | user account registration. 13 | 14 | """ 15 | ACTIVATED = u"ALREADY_ACTIVATED" 16 | 17 | user = models.OneToOneField(settings.AUTH_USER_MODEL, unique=True, verbose_name=_('user'), related_name='api_registration_profile') 18 | activation_key = models.CharField(_('activation key'), max_length=40) 19 | 20 | def activation_key_expired(self): 21 | """ 22 | Determine whether this ``RegistrationProfile``'s activation 23 | key has expired, returning a boolean -- ``True`` if the key 24 | has expired. 25 | Key expiration is determined by a two-step process: 26 | 1. If the user has already activated, the key will have been 27 | reset to the string constant ``ACTIVATED``. Re-activating 28 | is not permitted, and so this method returns ``True`` in 29 | this case. 30 | 31 | 2. Otherwise, the date the user signed up is incremented by 32 | the number of days specified in the setting 33 | ``REGISTRATION_API_ACCOUNT_ACTIVATION_DAYS`` (which should be 34 | the number of days after signup during which a user is allowed 35 | to activate their account); if the result is less than or 36 | equal to the current date, the key has expired and this method 37 | returns ``True``. 38 | 39 | """ 40 | 41 | # utils imported here to avoid circular import 42 | import utils 43 | 44 | expiration_date = datetime.timedelta( 45 | days=utils.get_settings('REGISTRATION_API_ACCOUNT_ACTIVATION_DAYS')) 46 | return self.activation_key == self.ACTIVATED or \ 47 | (self.user.date_joined + expiration_date <= datetime_now()) 48 | -------------------------------------------------------------------------------- /registration_api/serializers.py: -------------------------------------------------------------------------------- 1 | from django.contrib.auth import get_user_model 2 | 3 | from rest_framework import serializers 4 | 5 | 6 | class UserSerializer(serializers.ModelSerializer): 7 | 8 | class Meta: 9 | model = get_user_model() 10 | 11 | def to_native(self, obj): 12 | """Remove password field when serializing an object""" 13 | ret = super(UserSerializer, self).to_native(obj) 14 | del ret['password'] 15 | return ret 16 | -------------------------------------------------------------------------------- /registration_api/templates/registration_api/activation_email.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alej0varas/django-registration-rest-framework/27e0dd6ad414d8dcd473c3cd4c481349de171bc9/registration_api/templates/registration_api/activation_email.txt -------------------------------------------------------------------------------- /registration_api/templates/registration_api/activation_email_subject.txt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alej0varas/django-registration-rest-framework/27e0dd6ad414d8dcd473c3cd4c481349de171bc9/registration_api/templates/registration_api/activation_email_subject.txt -------------------------------------------------------------------------------- /registration_api/tests.py: -------------------------------------------------------------------------------- 1 | from urllib import urlencode 2 | import mock 3 | 4 | from django.conf import settings 5 | from django.contrib.auth import get_user_model 6 | from django.contrib.auth.models import AnonymousUser 7 | from django.contrib.sites.models import Site 8 | from django.core.exceptions import ImproperlyConfigured 9 | from django.core.urlresolvers import reverse 10 | from django.http import HttpRequest 11 | from django.test import TestCase 12 | from django.test.utils import override_settings 13 | from django.utils.datastructures import MergeDict 14 | 15 | from rest_framework import status 16 | from rest_framework.response import Response 17 | 18 | from registration_api import utils 19 | from registration_api.models import RegistrationProfile 20 | from registration_api.serializers import UserSerializer 21 | from registration_api.views import activate, register 22 | 23 | 24 | class WsgiHttpRequest(HttpRequest): 25 | def __init__(self, *args, **kwargs): 26 | super(WsgiHttpRequest, self).__init__(*args, **kwargs) 27 | self.user = AnonymousUser() 28 | self.session = {} 29 | self.META = {} 30 | self.GET = {} 31 | self.POST = {} 32 | 33 | def _get_request(self): 34 | if not hasattr(self, '_request'): 35 | self._request = MergeDict(self.POST, self.GET) 36 | return self._request 37 | REQUEST = property(_get_request) 38 | 39 | def _get_raw_post_data(self): 40 | if not hasattr(self, '_raw_post_data'): 41 | self._raw_post_data = urlencode(self.POST) 42 | return self._raw_post_data 43 | 44 | def _set_raw_post_data(self, data): 45 | self._raw_post_data = data 46 | self.POST = {} 47 | raw_post_data = property(_get_raw_post_data, _set_raw_post_data) 48 | 49 | 50 | def MockHttpRequest(path='/', method='GET', GET=None, POST=None, META=None, user=None): 51 | if GET is None: 52 | GET = {} 53 | if POST is None: 54 | POST = {} 55 | else: 56 | method = 'POST' 57 | if META is None: 58 | META = { 59 | 'REMOTE_ADDR': '127.0.0.1', 60 | 'SERVER_PORT': '8000', 61 | 'HTTP_REFERER': '', 62 | 'SERVER_NAME': 'testserver', 63 | } 64 | if user is not None: 65 | user = user 66 | 67 | request = WsgiHttpRequest() 68 | request.path = request.path_info = path 69 | request.method = method 70 | request.META = META 71 | request.GET = GET 72 | request.POST = POST 73 | request.user = user 74 | return request 75 | 76 | 77 | EXPECTED_VALID_USER_FIELDS = [f.name for f in get_user_model()._meta.fields] 78 | POST_DATA = {'username': 'john', 'email': 'john@example.com', 79 | 'password': 'verylongpassword'} 80 | VALID_DATA = dict( 81 | [(k, v) for k, v in POST_DATA.items() 82 | if k in EXPECTED_VALID_USER_FIELDS]) 83 | INVALID_DATA = VALID_DATA.copy() 84 | INVALID_DATA.pop('password') 85 | 86 | 87 | class UtilsTests(TestCase): 88 | 89 | def test_VALID_USER_FIELDS(self): 90 | 91 | self.assertListEqual(sorted(utils.VALID_USER_FIELDS), 92 | sorted(EXPECTED_VALID_USER_FIELDS)) 93 | 94 | def test_get_user_data(self): 95 | valid_data = {'id': 1} 96 | mock_data = valid_data.copy() 97 | mock_data.update({'invalid_field': 0}) 98 | 99 | data = utils.get_user_data(mock_data) 100 | 101 | self.assertEqual(valid_data, data) 102 | 103 | @mock.patch('registration_api.utils.send_activation_email') 104 | @mock.patch('registration_api.utils.create_profile') 105 | def test_create_inactive_user(self, mock_create_profile, mock_send_activation_email): 106 | site = Site.objects.get() 107 | user_model = get_user_model() 108 | with mock.patch.object(user_model.objects, 'create_user') as mock_create_user: 109 | mock_create_user.return_value = get_user_model()(**VALID_DATA) 110 | user = utils.create_inactive_user(**VALID_DATA) 111 | 112 | if hasattr(user, 'username'): 113 | mock_create_user.assert_called_with(VALID_DATA['username'], 114 | VALID_DATA['email'], 115 | VALID_DATA['password']) 116 | else: 117 | mock_create_user.assert_called_with(VALID_DATA['email'], 118 | VALID_DATA['password']) 119 | mock_create_profile.assert_called_with(user) 120 | self.assertFalse(user.is_active) 121 | self.assertTrue(user.pk) 122 | mock_send_activation_email.assert_called_with(user, site) 123 | 124 | @mock.patch('registration_api.utils.create_activation_key') 125 | @mock.patch('registration_api.models.RegistrationProfile.objects.create') 126 | def test_create_profile(self, mock_create, mock_create_activation_key): 127 | mock_create.return_value = RegistrationProfile() 128 | activation_key = 'activationkey' 129 | mock_create_activation_key.return_value = activation_key 130 | user = get_user_model()(**VALID_DATA) 131 | 132 | registration_profile = utils.create_profile(user) 133 | 134 | self.assertIsInstance(registration_profile, RegistrationProfile) 135 | mock_create_activation_key.assert_called_with(user) 136 | mock_create.assert_called_with(user=user, 137 | activation_key=activation_key) 138 | 139 | def test_create_activation_key(self): 140 | user = get_user_model().objects.create(**VALID_DATA) 141 | 142 | activation_key = utils.create_activation_key(user) 143 | 144 | self.assertTrue(activation_key) 145 | self.assertEqual(len(activation_key), 40) 146 | 147 | def test_activate_user(self): 148 | user = utils.create_inactive_user(**VALID_DATA) 149 | 150 | user = utils.activate_user(user.api_registration_profile.activation_key) 151 | 152 | self.assertTrue(user.is_active) 153 | 154 | def test_send_activations_email(self): 155 | user = get_user_model().objects.create(**VALID_DATA) 156 | RegistrationProfile.objects.create(user=user, activation_key='asdf') 157 | site = Site.objects.get() 158 | subject = '' 159 | message = '' 160 | 161 | with mock.patch.object(user, 'email_user') as mock_email_user: 162 | utils.send_activation_email(user, site) 163 | 164 | mock_email_user.assert_called_with( 165 | subject, message, settings.DEFAULT_FROM_EMAIL) 166 | 167 | def test_get_settings(self): 168 | value = utils.get_settings('REGISTRATION_API_ACCOUNT_ACTIVATION_DAYS') 169 | 170 | self.assertEqual( 171 | value, 172 | utils.DEFAULT_SETTINGS['REGISTRATION_API_ACCOUNT_ACTIVATION_DAYS']) 173 | 174 | @override_settings(REGISTRATION_API_ACTIVATION_SUCCESS_URL=None) 175 | def test_get_settings_ImproperlyConfigured(self): 176 | self.assertRaises(ImproperlyConfigured, utils.get_settings, 177 | 'REGISTRATION_API_ACTIVATION_SUCCESS_URL') 178 | 179 | 180 | class UserSerializerTests(TestCase): 181 | 182 | def test_model(self): 183 | self.assertEqual(UserSerializer.Meta.model, get_user_model()) 184 | 185 | 186 | class RegisterAPIViewTests(TestCase): 187 | 188 | @mock.patch('registration_api.utils.get_user_data') 189 | @mock.patch('registration_api.utils.create_inactive_user') 190 | @mock.patch('registration_api.views.UserSerializer') 191 | @mock.patch('registration_api.views.Response') 192 | def test_valid_registration(self, mock_Response, mock_UserSerializer, mock_create_incative_user, mock_get_user_data): 193 | created_user = 'user' 194 | mock_Response.return_value = Response() 195 | mock_userserializer_instance = mock.Mock() 196 | mock_userserializer_instance.data = VALID_DATA 197 | mock_UserSerializer.return_value = mock_userserializer_instance 198 | mock_userserializer_instance.is_valid.return_value = True 199 | mock_create_user = mock.Mock() 200 | mock_create_user.return_value = created_user 201 | mock_objects = mock.Mock() 202 | mock_objects.create_user = mock_create_user 203 | mock_user_model = mock.Mock() 204 | mock_user_model.objects = mock_objects 205 | mock_get_user_data.return_value = VALID_DATA 206 | 207 | request = MockHttpRequest(POST=VALID_DATA) 208 | 209 | register(request) 210 | 211 | mock_UserSerializer.assert_called_with(data=VALID_DATA) 212 | mock_Response.assert_called_with( 213 | utils.USER_CREATED_RESPONSE_DATA, 214 | status=status.HTTP_201_CREATED) 215 | mock_create_incative_user.assert_called_with(**VALID_DATA) 216 | 217 | @mock.patch('registration_api.views.UserSerializer') 218 | @mock.patch('registration_api.views.Response') 219 | def test_invalid_registration(self, mock_Response, mock_UserSerializer): 220 | mock_Response.return_value = Response() 221 | mock_userserializer_instance = mock.Mock() 222 | mock_UserSerializer.return_value = mock_userserializer_instance 223 | mock_userserializer_instance.is_valid.return_value = False 224 | mock_userserializer_instance._errors = {} 225 | 226 | request = MockHttpRequest(POST=VALID_DATA) 227 | 228 | register(request) 229 | 230 | mock_UserSerializer.assert_called_with(data=VALID_DATA) 231 | mock_Response.assert_called_with( 232 | mock_userserializer_instance._errors, 233 | status=status.HTTP_400_BAD_REQUEST) 234 | 235 | def test_functional(self): 236 | url = reverse('registration_api_register') 237 | 238 | response = self.client.post(url, VALID_DATA) 239 | 240 | self.assertEqual(201, response.status_code) 241 | self.assertTrue(get_user_model().objects.get()) 242 | self.assertFalse(get_user_model().objects.get().is_active) 243 | self.assertTrue(RegistrationProfile.objects.get()) 244 | 245 | def test_functional_invalid(self): 246 | url = reverse('registration_api_register') 247 | 248 | response = self.client.post(url, INVALID_DATA) 249 | 250 | self.assertEqual(400, response.status_code) 251 | self.assertFalse(get_user_model().objects.filter()) 252 | 253 | 254 | class ActivateViewTests(TestCase): 255 | 256 | def test_activate(self): 257 | user = utils.create_inactive_user(**VALID_DATA) 258 | request = MockHttpRequest() 259 | 260 | response = activate( 261 | request, 262 | activation_key=user.api_registration_profile.activation_key) 263 | user = get_user_model().objects.get(pk=user.pk) 264 | 265 | self.assertTrue(user.is_active) 266 | self.assertEqual(user.api_registration_profile.activation_key, 267 | RegistrationProfile.ACTIVATED) 268 | self.assertEqual(response.status_code, 269 | status.HTTP_302_FOUND) 270 | self.assertEqual(response['location'], 271 | utils.get_settings('REGISTRATION_API_ACTIVATION_SUCCESS_URL')) 272 | 273 | @override_settings(REGISTRATION_API_ACTIVATION_SUCCESS_URL=None) 274 | def test_activate__without_ACTIVATE_REDIRECT_URL(self): 275 | user = utils.create_inactive_user(**VALID_DATA) 276 | request = MockHttpRequest() 277 | 278 | self.assertRaises( 279 | ImproperlyConfigured, 280 | activate, 281 | request, 282 | activation_key=user.api_registration_profile.activation_key) 283 | -------------------------------------------------------------------------------- /registration_api/urls.py: -------------------------------------------------------------------------------- 1 | from django.conf.urls import patterns, url 2 | 3 | 4 | urlpatterns = patterns( 5 | '', 6 | url(r'^register/$', 7 | 'registration_api.views.register', 8 | name='registration_api_register'), 9 | url(r'^activate/(?P\w+)/$', 10 | 'registration_api.views.activate', 11 | name='registration_activate'), 12 | ) 13 | -------------------------------------------------------------------------------- /registration_api/utils.py: -------------------------------------------------------------------------------- 1 | import hashlib 2 | import random 3 | import re 4 | 5 | from django.conf import settings 6 | from django.contrib.auth import get_user_model 7 | from django.contrib.sites.models import Site 8 | from django.core.exceptions import ImproperlyConfigured 9 | from django.template.loader import render_to_string 10 | 11 | from .models import RegistrationProfile 12 | 13 | from django.db import transaction 14 | # django 1.6, 1.5 and 1.4 supports 15 | try: 16 | atomic_decorator = transaction.atomic 17 | except AttributeError: 18 | atomic_decorator = transaction.commit_on_success 19 | 20 | 21 | SHA1_RE = re.compile('^[a-f0-9]{40}$') 22 | DEFAULT_SETTINGS = { 23 | 'REGISTRATION_API_ACCOUNT_ACTIVATION_DAYS': 7, 24 | } 25 | 26 | 27 | def get_settings(key): 28 | setting = getattr(settings, key, DEFAULT_SETTINGS.get(key, None)) 29 | if setting is None: 30 | raise ImproperlyConfigured("The %s setting must not be empty." % key) 31 | return setting 32 | 33 | 34 | USER_CREATED_RESPONSE_DATA = { 35 | 'activation_days': get_settings('REGISTRATION_API_ACCOUNT_ACTIVATION_DAYS') 36 | } 37 | 38 | 39 | def get_valid_user_fields(): 40 | fields = [] 41 | for f in get_user_model()._meta.fields: 42 | fields.append(f.name) 43 | return fields 44 | 45 | 46 | VALID_USER_FIELDS = get_valid_user_fields() 47 | 48 | 49 | def get_user_data(data): 50 | user_data = {} 51 | for field, data in data.items(): 52 | if field in VALID_USER_FIELDS: 53 | user_data.update({field: data}) 54 | return user_data 55 | 56 | 57 | @atomic_decorator 58 | def create_inactive_user(username=None, email=None, password=None): 59 | user_model = get_user_model() 60 | if username is not None: 61 | new_user = user_model.objects.create_user(username, email, password) 62 | else: 63 | new_user = user_model.objects.create_user(email=email, password=password) 64 | new_user.is_active = False 65 | new_user.save() 66 | create_profile(new_user) 67 | site = Site.objects.get_current() 68 | send_activation_email(new_user, site) 69 | return new_user 70 | 71 | 72 | def create_profile(user): 73 | activation_key = create_activation_key(user) 74 | registration_profile = RegistrationProfile.objects.create( 75 | user=user, activation_key=activation_key) 76 | return registration_profile 77 | 78 | 79 | def create_activation_key(user): 80 | username = getattr(user, user.USERNAME_FIELD) 81 | salt_bytes = str(random.random()).encode('utf-8') 82 | salt = hashlib.sha1(salt_bytes).hexdigest()[:5] 83 | 84 | hash_input = (salt + username).encode('utf-8') 85 | activation_key = hashlib.sha1(hash_input).hexdigest() 86 | return activation_key 87 | 88 | 89 | def activate_user(activation_key): 90 | """ 91 | Validate an activation key and activate the corresponding 92 | ``User`` if valid. 93 | If the key is valid and has not expired, return the ``User`` 94 | after activating. 95 | If the key is not valid or has expired, return ``False``. 96 | If the key is valid but the ``User`` is already active, 97 | return ``False``. 98 | To prevent reactivation of an account which has been 99 | deactivated by site administrators, the activation key is 100 | reset to the string constant ``RegistrationProfile.ACTIVATED`` 101 | after successful activation. 102 | 103 | """ 104 | # Make sure the key we're trying conforms to the pattern of a 105 | # SHA1 hash; if it doesn't, no point trying to look it up in 106 | # the database. 107 | if SHA1_RE.search(activation_key): 108 | try: 109 | profile = RegistrationProfile.objects.get( 110 | activation_key=activation_key) 111 | except RegistrationProfile.DoesNotExist: 112 | return False 113 | if not profile.activation_key_expired(): 114 | user = profile.user 115 | user.is_active = True 116 | user.save() 117 | profile.activation_key = RegistrationProfile.ACTIVATED 118 | profile.save() 119 | return user 120 | return False 121 | 122 | 123 | def send_activation_email(user, site): 124 | """ 125 | Send an activation email to the ``user``. 126 | The activation email will make use of two templates: 127 | 128 | ``registration/activation_email_subject.txt`` 129 | This template will be used for the subject line of the 130 | email. Because it is used as the subject line of an email, 131 | this template's output **must** be only a single line of 132 | text; output longer than one line will be forcibly joined 133 | into only a single line. 134 | 135 | ``registration/activation_email.txt`` 136 | This template will be used for the body of the email. 137 | 138 | These templates will each receive the following context 139 | variables: 140 | 141 | ``activation_key`` 142 | The activation key for the new account. 143 | 144 | ``expiration_days`` 145 | The number of days remaining during which the account may 146 | be activated. 147 | 148 | ``site`` 149 | An object representing the site on which the user 150 | registered; depending on whether ``django.contrib.sites`` 151 | is installed, this may be an instance of either 152 | ``django.contrib.sites.models.Site`` (if the sites 153 | application is installed) or 154 | ``django.contrib.sites.models.RequestSite`` (if 155 | not). Consult the documentation for the Django sites 156 | framework for details regarding these objects' interfaces. 157 | 158 | """ 159 | ctx_dict = {'activation_key': user.api_registration_profile.activation_key, 160 | 'expiration_days': get_settings('REGISTRATION_API_ACCOUNT_ACTIVATION_DAYS'), 161 | 'site': site} 162 | subject = render_to_string('registration_api/activation_email_subject.txt', 163 | ctx_dict) 164 | # Email subject *must not* contain newlines 165 | subject = ''.join(subject.splitlines()) 166 | message = render_to_string('registration_api/activation_email.txt', 167 | ctx_dict) 168 | user.email_user(subject, message, settings.DEFAULT_FROM_EMAIL) 169 | -------------------------------------------------------------------------------- /registration_api/views.py: -------------------------------------------------------------------------------- 1 | from django.http import HttpResponseRedirect 2 | 3 | from rest_framework import status 4 | from rest_framework.decorators import api_view, permission_classes 5 | from rest_framework.permissions import AllowAny 6 | from rest_framework.response import Response 7 | 8 | import utils 9 | from serializers import UserSerializer 10 | 11 | 12 | VALID_USER_FIELDS = utils.get_valid_user_fields() 13 | 14 | 15 | @api_view(['POST']) 16 | @permission_classes((AllowAny, )) 17 | def register(request): 18 | serialized = UserSerializer(data=request.POST) 19 | if serialized.is_valid(): 20 | user_data = utils.get_user_data(request.POST) 21 | utils.create_inactive_user(**user_data) 22 | return Response(utils.USER_CREATED_RESPONSE_DATA, 23 | status=status.HTTP_201_CREATED) 24 | else: 25 | return Response(serialized._errors, status=status.HTTP_400_BAD_REQUEST) 26 | 27 | 28 | def activate(request, activation_key=None): 29 | """ 30 | Given an an activation key, look up and activate the user 31 | account corresponding to that key (if possible). 32 | 33 | """ 34 | utils.activate_user(activation_key) 35 | # if not activated 36 | success_url = utils.get_settings('REGISTRATION_API_ACTIVATION_SUCCESS_URL') 37 | if success_url is not None: 38 | return HttpResponseRedirect(success_url) 39 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup 2 | 3 | from setuptools import find_packages 4 | 5 | from registration_api import __version__ 6 | 7 | 8 | setup(name='django-registration-rest-framework', 9 | version=__version__, 10 | packages=find_packages(), 11 | requires=['djangorestframework'], 12 | test_suite='tests.runtests.runtests', 13 | install_requires=['djangorestframework==2.3.10'], 14 | tests_require=[ 15 | 'mock==1.0.1', 16 | 'Django>=1.5', 17 | ], 18 | url='https://github.com/tucarga/django-registration-rest-framework', 19 | author='Alejandro Varas', 20 | author_email='alej0varas@gmail.com', 21 | keywords='django registration rest framework', 22 | description=('Clone of Django Resgistration flow for Django Rest ' 23 | 'Framework',), 24 | license='GPL', 25 | classifiers=[ 26 | 'Development Status :: 1 - Planning', 27 | 'Intended Audience :: Developers', 28 | 'Framework :: Django', 29 | 'Operating System :: POSIX :: Linux', 30 | 'Programming Language :: Python', 31 | 'Natural Language :: English', 32 | ('License :: OSI Approved :: ' 33 | 'GNU General Public License v3 or later (GPLv3+)'), 34 | 'Topic :: Software Development :: Libraries', 35 | ], 36 | ) 37 | -------------------------------------------------------------------------------- /tests/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/alej0varas/django-registration-rest-framework/27e0dd6ad414d8dcd473c3cd4c481349de171bc9/tests/__init__.py -------------------------------------------------------------------------------- /tests/runtests.py: -------------------------------------------------------------------------------- 1 | import os 2 | import sys 3 | 4 | os.environ['DJANGO_SETTINGS_MODULE'] = 'settings' 5 | 6 | test_dir = os.path.dirname(__file__) 7 | sys.path.insert(0, test_dir) 8 | 9 | from django.test.runner import DiscoverRunner 10 | 11 | 12 | def runtests(): 13 | 14 | if sys.argv[0] == 'runtests.py' and len(sys.argv) == 2: 15 | suite = ['registration_api.tests.' + sys.argv[1]] 16 | else: 17 | suite = [] 18 | 19 | test_runner = DiscoverRunner() 20 | failures = test_runner.run_tests(suite, verbosity=1, interactive=True) 21 | 22 | sys.exit(failures) 23 | 24 | 25 | if __name__ == '__main__': 26 | runtests() 27 | -------------------------------------------------------------------------------- /tests/settings.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | 4 | DIRNAME = os.path.dirname(__file__) 5 | DATABASES = {'default': {'ENGINE': 'django.db.backends.sqlite3', 6 | 'NAME': os.path.join(DIRNAME, 'database.db'), 7 | }, 8 | } 9 | DEBUG = True 10 | DATABASES = DATABASES 11 | INSTALLED_APPS = ('django.contrib.auth', 12 | 'django.contrib.contenttypes', 13 | 'django.contrib.sessions', 14 | 'django.contrib.admin', 15 | 'django.contrib.sites', 16 | 'registration_api', 17 | # 'custom_user', 18 | ) 19 | # AUTH_USER_MODEL = 'custom_user.EmailUser' 20 | ROOT_URLCONF = 'registration_api.urls' 21 | 22 | SECRET_KEY = 'not-secret' 23 | SITE_ID = 1 24 | 25 | REGISTRATION_API_ACTIVATION_SUCCESS_URL = '/' 26 | 27 | REST_FRAMEWORK = { 28 | 'DEFAULT_PERMISSION_CLASSES': ( 29 | 'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly', 30 | ) 31 | } 32 | --------------------------------------------------------------------------------