├── .coveragerc
├── .gitignore
├── LICENSE
├── README.rst
├── db.sqlite3
├── runcheckmigration
├── runisort
├── runtests.py
├── setup.cfg
├── setup.py
├── template_library
├── __init__.py
├── admin.py
├── apps.py
├── celery.py
├── generics.py
├── migrations
│ └── __init__.py
├── models.py
├── serializers.py
├── tests.py
├── urls.py
└── views.py
└── tests
├── __init__.py
├── manage.py
├── settings.py
├── urls.py
└── wsgi.py
/.coveragerc:
--------------------------------------------------------------------------------
1 | [run]
2 | omit =
3 | /*/test*
4 | /tests
5 | /*/__init__.py
6 | /setup.py
7 | /*/migrations/*
8 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Byte-compiled / optimized / DLL files
2 | __pycache__/
3 | *.py[cod]
4 | *$py.class
5 | *.swp
6 |
7 | # C extensions
8 | *.so
9 |
10 | # Distribution / packaging
11 | .Python
12 | env/
13 | build/
14 | develop-eggs/
15 | dist/
16 | downloads/
17 | eggs/
18 | .eggs/
19 | lib/
20 | lib64/
21 | parts/
22 | sdist/
23 | var/
24 | wheels/
25 | *.egg-info/
26 | .installed.cfg
27 | *.egg
28 |
29 | # PyInstaller
30 | # Usually these files are written by a python script from a template
31 | # before PyInstaller builds the exe, so as to inject date/other infos into it.
32 | *.manifest
33 | *.spec
34 |
35 | # Installer logs
36 | pip-log.txt
37 | pip-delete-this-directory.txt
38 |
39 | # Unit test / coverage reports
40 | htmlcov/
41 | .tox/
42 | .coverage
43 | .coverage.*
44 | .cache
45 | nosetests.xml
46 | coverage.xml
47 | *.cover
48 | .hypothesis/
49 |
50 | # Translations
51 | *.mo
52 | *.pot
53 |
54 | # Django stuff:
55 | *.log
56 | local_settings.py
57 |
58 | # Flask stuff:
59 | instance/
60 | .webassets-cache
61 |
62 | # Scrapy stuff:
63 | .scrapy
64 |
65 | # Sphinx documentation
66 | docs/_build/
67 |
68 | # PyBuilder
69 | target/
70 |
71 | # Jupyter Notebook
72 | .ipynb_checkpoints
73 |
74 | # pyenv
75 | .python-version
76 |
77 | # celery beat schedule file
78 | celerybeat-schedule
79 |
80 | # SageMath parsed files
81 | *.sage.py
82 |
83 | # dotenv
84 | .env
85 |
86 | # virtualenv
87 | .venv
88 | venv/
89 | ENV/
90 |
91 | # Spyder project settings
92 | .spyderproject
93 | .spyproject
94 |
95 | # Rope project settings
96 | .ropeproject
97 |
98 | # mkdocs documentation
99 | /site
100 |
101 | # mypy
102 | .mypy_cache/
103 |
104 | # other
105 | *.DS_Store*
106 | *~
107 | ._*
108 | local_settings.py
109 | *.db
110 | *.tar.gz
111 |
--------------------------------------------------------------------------------
/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 |
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 | OpenWISP Template Library Backend
2 | =================================
3 |
4 | .. contents:: **Table of Contents**:
5 | :backlinks: none
6 | :depth: 3
7 |
8 | ------------
9 |
10 | Project goals
11 | -------------
12 | The main objective of this project is to provide a backend in django for the OpenWISP `library frontend
13 | `_
14 | It uses `openwisp-controller `_
15 | to handle template creation, list and search of public templates, view template
16 | details and ``django-rest-auth`` for user registration and management.
17 |
18 | Dependencies
19 | ------------
20 |
21 | * Python >= 3.6
22 |
23 | Installation
24 | ------------
25 | Install sqlite:
26 |
27 | .. code-block:: shell
28 |
29 | sudo apt-get install sqlite3 libsqlite3-dev openssl libssl-dev
30 |
31 |
32 | Fork and clone the project and from the project's root directory,
33 |
34 | install celery
35 |
36 | .. code-block:: shell
37 |
38 | pip install celery
39 |
40 | Install project's dependencies
41 |
42 | .. code-block:: shell
43 |
44 | python setup.py develop
45 |
46 | we need to make sure the gsoc2019 branch of the ``django-netjsonconfig`` and
47 | ``openwisp-controller`` repos are installed.
48 | if they are not, you can get them installed with the following commands
49 |
50 | .. code-block:: shell
51 |
52 | pip install --upgrade git+git://github.com/openwisp/openwisp-controller.git@gsoc2019#egg=openwisp_controller
53 | pip install --upgrade git+git://github.com/openwisp/django-netjsonconfig.git@gsoc2019#egg=django_netjsonconfig
54 | pip install --upgrade git+git://github.com/openwisp/openwisp-users.git@master#egg=openwisp_users
55 | pip install --upgrade git+git://github.com/openwisp/openwisp-utils.git@master#egg=openwisp_utils
56 |
57 | Run migrations, create super user and start the server
58 |
59 | .. code-block:: shell
60 |
61 | python tests/manage.py makemigrations
62 | python tests/manage.py migrate
63 | python tests/manage.py createsuperuser
64 | python tests/manage.py runserver
65 |
66 | Make sure the redis server is running and then start the celery tasks
67 |
68 | .. code-block:: shell
69 |
70 | celery -A template_library worker -l info
71 |
72 | We should now have this backend running on ``http://localhost:8000/`` and the frontend to which it is connected to,
73 | should be running on ``http://localhost:3000/`` . if this is not, you can get it up and running by
74 | following the instructions from the `library frontend
75 | `_
76 |
77 | * login to the admin interface and change the ``site`` domain from example.com to ``http://localhost:8000``.
78 | * Create a Facebook and Google ``social application`` with the appropriate providers. You can use the following ``ID`` and ``secret`` for the social application making sure the site url is ``http://localhost:8000``
79 |
80 | .. code-block::
81 |
82 | Facebook_client_id = 451356895715832
83 | Facebook_client_secret = b4bf9d52d91e802b94aec5e4ccd87849
84 | Google_client_id= 949742045903-rt3svj9go2qhdu7q8nijlhnud4frb0gg.apps.googleusercontent.com
85 | Google_client_secret = TxXfb0ixcuylgd2k59-6Dyce
86 |
87 |
88 | Settings
89 | --------
90 | If you wish to deploy this application, then the following settings
91 | need to be adjusted
92 |
93 | ``CORS_ORIGIN_WHITELIST``
94 | .........................
95 | +--------------+-----------------------------------------------+
96 | | **type**: | ``list`` |
97 | +--------------+-----------------------------------------------+
98 | | **default**: | .. code-block:: |
99 | | | |
100 | | | [ |
101 | | | "http://localhost:8000", |
102 | | | "http://localhost:3000" |
103 | | | ] |
104 | +--------------+-----------------------------------------------+
105 |
106 | This sets the Cross-Origin Resource sharing white list to the
107 | backend and frontend respectively
108 |
109 | ``CSRF_TRUSTED_ORIGINS``
110 | ........................
111 | +--------------+-----------------------------------------------+
112 | | **type**: | ``list`` |
113 | +--------------+-----------------------------------------------+
114 | | **default**: | .. code-block:: |
115 | | | |
116 | | | [ |
117 | | | "localhost:8000", |
118 | | | "localhost:3000" |
119 | | | ] |
120 | +--------------+-----------------------------------------------+
121 |
122 | This sets the CSRF trusted origins to the backend and frontend respectively
123 |
124 | ``LOGIN_URL``
125 | .............
126 | +--------------+------------------------------------------------+
127 | | **type**: | ``string`` |
128 | +--------------+------------------------------------------------+
129 | | **default**: | .. code-block:: |
130 | | | |
131 | | | "http://localhost:3000/login" |
132 | | | |
133 | | | |
134 | +--------------+------------------------------------------------+
135 |
136 | This sets the LOGIN_URL to that of the frontend
137 |
138 |
139 | Contributing
140 | ------------
141 | Please read the `OpenWISP contributing guidelines
142 | `_
143 |
144 | 1. Announce your intentions in the `OpenWISP Mailing List `_
145 | 2. Fork this repo and install it
146 | 3. Follow `PEP8, Style Guide for Python Code`_
147 | 4. Write code
148 | 5. Write tests for your code
149 | 6. Ensure all tests pass
150 | 7. Ensure test coverage does not decrease
151 | 8. Document your changes
152 | 9. Send pull request
153 |
154 | .. _PEP8, Style Guide for Python Code: http://www.python.org/dev/peps/pep-0008/
155 |
--------------------------------------------------------------------------------
/db.sqlite3:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/openwisp/openwisp-template-library-backend/e4448282cd5cdb43132773b01104eca7053262d8/db.sqlite3
--------------------------------------------------------------------------------
/runcheckmigration:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | set -e
3 |
4 | checkmigrations --migration-path ./template_library/migrations/ || exit 1
5 |
--------------------------------------------------------------------------------
/runisort:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | set -e
3 | isort --check-only --recursive --diff || exit 1
4 |
--------------------------------------------------------------------------------
/runtests.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | # -*- coding: utf-8 -*-
3 |
4 | import os
5 | import sys
6 |
7 | sys.path.insert(0, "tests")
8 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
9 |
10 | if __name__ == "__main__":
11 | from django.core.management import execute_from_command_line
12 | args = sys.argv
13 | args.insert(1, "test")
14 | args.insert(2, "template_library")
15 | execute_from_command_line(args)
16 |
--------------------------------------------------------------------------------
/setup.cfg:
--------------------------------------------------------------------------------
1 | [bdist_wheel]
2 | universal=1
3 |
4 | [isort]
5 | known_third_party = django
6 | known_first_party = openwisp_controller,openwisp_users
7 | line_length=110
8 | default_section = THIRDPARTY
9 | skip = migrations
10 |
11 | [flake8]
12 | exclude = *migrations*,
13 | ./tests/*settings*.py
14 | max-line-length = 110
15 | # W503: line break before or after operator
16 | # W504: line break after or after operator
17 | # W605: invalid escape sequence
18 | ignore = W605, W503, W504
19 |
--------------------------------------------------------------------------------
/setup.py:
--------------------------------------------------------------------------------
1 | import os
2 | import sys
3 |
4 | from setuptools import find_packages, setup
5 | from template_library import get_version
6 |
7 | with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as readme:
8 | README = readme.read()
9 |
10 |
11 | if sys.argv[-1] == 'publish':
12 | # delete any *.pyc, *.pyo and __pycache__
13 | os.system('find . | grep -E "(__pycache__|\.pyc|\.pyo$)" | xargs rm -rf')
14 | os.system("python setup.py sdist bdist_wheel")
15 | os.system("twine upload -s dist/*")
16 | os.system("rm -rf dist build")
17 | args = {'version': get_version()}
18 | print("You probably want to also tag the version now:")
19 | print(" git tag -a %(version)s -m 'version %(version)s'" % args)
20 | print(" git push --tags")
21 | sys.exit()
22 |
23 |
24 | setup(
25 | name='template-library',
26 | version=get_version(),
27 | packages=find_packages(exclude=['tests', 'docs']),
28 | include_package_data=True,
29 | license='GPL3',
30 | description='Backend for the template library website',
31 | long_description=README,
32 | url='https://github.com/openwisp/openwisp-template-library-backend',
33 | author='Noumbissi Valere Gille Geovan',
34 | author_email='noumbissivalere@gmail.com',
35 | install_requires=[
36 | 'django-allauth<0.37.0,>=0.35.0',
37 | 'djangorestframework<3.8,>=3.3',
38 | 'django-cors-headers==3.1.0',
39 | 'django-rest-auth==0.9.5',
40 | 'autobahn==19.6.1',
41 | 'redis>=3.3.5',
42 | 'django<2.1,>=1.11',
43 | 'requests==2.22.0',
44 | 'openwisp-controller>=0.3.2',
45 | 'django-netjsonconfig>=0.8.1',
46 | 'openwisp-users>=0.1.10',
47 | 'openwisp-utils>=0.2.2',
48 | ],
49 | extras_require={
50 | 'test': [
51 | 'flake8<=3.6.0',
52 | 'isort<=4.3.4',
53 | 'coverage',
54 | 'coveralls',
55 | 'mock==3.0.5',
56 | ],
57 | },
58 | classifiers=[
59 | 'Development Status :: 3 - Alpha',
60 | 'Environment :: Web Environment',
61 | 'Topic :: Internet :: WWW/HTTP',
62 | 'Topic :: System :: Networking',
63 | 'Intended Audience :: Administrators',
64 | 'License :: OSI Approved :: GPL-3 License',
65 | 'Operating System :: OS Independent',
66 | 'Framework :: Django',
67 | 'Programming Language :: Python :: 3.6',
68 | ],
69 | )
70 |
--------------------------------------------------------------------------------
/template_library/__init__.py:
--------------------------------------------------------------------------------
1 | from __future__ import absolute_import, unicode_literals
2 |
3 | from .celery import app as celery_app
4 |
5 | __all__ = ['celery_app']
6 |
7 | VERSION = (0, 1, 0, 'alpha')
8 | __version__ = VERSION # alias
9 |
10 |
11 | def get_version():
12 | version = '%s.%s' % (VERSION[0], VERSION[1])
13 | if VERSION[2]:
14 | version = '%s.%s' % (version, VERSION[2])
15 | if VERSION[3:] == ('alpha', 0):
16 | version = '%s pre-alpha' % version
17 | else:
18 | if VERSION[3] != 'final':
19 | version = '%s %s' % (version, VERSION[3])
20 | return version
21 |
22 |
23 | default_app_config = 'template_library.apps.TemplateLibraryConfig'
24 |
--------------------------------------------------------------------------------
/template_library/admin.py:
--------------------------------------------------------------------------------
1 | from allauth.account.admin import EmailAddressAdmin
2 | from allauth.account.models import EmailAddress
3 | from allauth.socialaccount.admin import SocialAccountAdmin, SocialAppAdmin, SocialTokenAdmin
4 | from allauth.socialaccount.models import SocialAccount, SocialApp, SocialToken
5 | from django.contrib import admin
6 |
7 | from openwisp_controller.config.models import Device
8 | from openwisp_users.models import Group
9 |
10 | # unregister unwanted models
11 | admin.site.unregister(Device)
12 | admin.site.unregister(Group)
13 | # Register wanted and needed module
14 | admin.site.register(EmailAddress, EmailAddressAdmin)
15 | admin.site.register(SocialApp, SocialAppAdmin)
16 | admin.site.register(SocialAccount, SocialAccountAdmin)
17 | admin.site.register(SocialToken, SocialTokenAdmin)
18 |
--------------------------------------------------------------------------------
/template_library/apps.py:
--------------------------------------------------------------------------------
1 | from django.apps import AppConfig
2 |
3 |
4 | class TemplateLibraryConfig(AppConfig):
5 | name = 'template_library'
6 |
--------------------------------------------------------------------------------
/template_library/celery.py:
--------------------------------------------------------------------------------
1 | from __future__ import absolute_import, unicode_literals
2 |
3 | import os
4 |
5 | from celery import Celery
6 |
7 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'tests.settings')
8 |
9 | app = Celery('template_library')
10 | app.config_from_object('django.conf:settings', namespace='CELERY')
11 | app.autodiscover_tasks()
12 |
--------------------------------------------------------------------------------
/template_library/generics.py:
--------------------------------------------------------------------------------
1 | from rest_framework.generics import ListCreateAPIView, RetrieveUpdateDestroyAPIView, get_object_or_404
2 | from rest_framework.permissions import IsAuthenticated, IsAuthenticatedOrReadOnly
3 | from rest_framework.response import Response
4 |
5 | from .serializers import OrganizationCreateUpdateSerializer, OrganizationSerializer
6 |
7 |
8 | class BaseOrganizationListCreateAPIView(ListCreateAPIView):
9 | serializer_class = OrganizationSerializer
10 | permission_classes = (IsAuthenticated, )
11 |
12 | def post(self, request, *args, **kwargs):
13 | options = {
14 | 'description': request.POST.get('description', None),
15 | 'name': request.POST.get('name', None),
16 | 'slug': request.POST.get('slug', None),
17 | 'email': request.POST.get('email', None),
18 | 'url': request.POST.get('url', None)
19 | }
20 | serializer = OrganizationSerializer(data=options)
21 | if serializer.is_valid():
22 | org = serializer.save()
23 | success = {
24 | 'org_success': 'Organization was successfully created'
25 | }
26 | self.org_user_model.objects.create(organization=org, user=request.user)
27 | return Response(data=success)
28 | else:
29 | errors = {
30 | 'org_errors': serializer.errors
31 | }
32 | return Response(data=errors, status=400)
33 |
34 | def get_queryset(self):
35 | orgs = self.org_model.objects.filter(users=self.request.user)
36 | return orgs
37 |
38 |
39 | class BaseOrganizationUpdateDeleteAPIView(RetrieveUpdateDestroyAPIView):
40 | serializer_class = OrganizationCreateUpdateSerializer
41 | permission_classes = (IsAuthenticatedOrReadOnly,)
42 |
43 | def get_object(self):
44 | return get_object_or_404(self.org_model, pk=self.kwargs['pk'], users=self.request.user)
45 |
--------------------------------------------------------------------------------
/template_library/migrations/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/openwisp/openwisp-template-library-backend/e4448282cd5cdb43132773b01104eca7053262d8/template_library/migrations/__init__.py
--------------------------------------------------------------------------------
/template_library/models.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/openwisp/openwisp-template-library-backend/e4448282cd5cdb43132773b01104eca7053262d8/template_library/models.py
--------------------------------------------------------------------------------
/template_library/serializers.py:
--------------------------------------------------------------------------------
1 | from openwisp_utils.api.serializers import ValidatedModelSerializer
2 |
3 | from openwisp_users.models import Organization
4 |
5 |
6 | class OrganizationSerializer(ValidatedModelSerializer):
7 |
8 | class Meta:
9 | model = Organization
10 | fields = "__all__"
11 |
12 |
13 | class OrganizationCreateUpdateSerializer(ValidatedModelSerializer):
14 |
15 | class Meta:
16 | model = Organization
17 | exclude = ('is_active',)
18 |
--------------------------------------------------------------------------------
/template_library/tests.py:
--------------------------------------------------------------------------------
1 | import json
2 |
3 | from allauth.socialaccount.models import SocialApp
4 | from django.contrib.auth import get_user_model
5 | from django.contrib.sites.models import Site
6 | from django.urls import reverse
7 | from mock import Mock, patch
8 | from rest_framework.test import APIClient, APITestCase
9 |
10 | from openwisp_users.models import Organization
11 | from openwisp_users.tests.utils import TestOrganizationMixin
12 |
13 |
14 | class TestAPI(APITestCase, TestOrganizationMixin):
15 |
16 | client = APIClient()
17 |
18 | def setUp(self):
19 | social_app = SocialApp.objects.create(
20 | provider='facebook',
21 | name='Facebook',
22 | client_id='123123123',
23 | secret='321321321',
24 | )
25 |
26 | google_social_app = SocialApp.objects.create(
27 | provider='google',
28 | name='Google',
29 | client_id='11223344',
30 | secret='55667788',
31 | )
32 |
33 | site = Site.objects.get_current()
34 | social_app.sites.add(site)
35 | google_social_app.sites.add(site)
36 |
37 | @patch('requests.get')
38 | def test_social_auth(self, mocked_get):
39 | # fake response for facebook call
40 | resp_body = {
41 | "id": "123123123123",
42 | "first_name": "test",
43 | "gender": "male",
44 | "last_name": "user",
45 | "link": "https://www.facebook.com/test.user",
46 | "locale": "en_US",
47 | "name": "test user",
48 | "timezone": 2,
49 | "updated_time": "2014-08-13T10:14:38+0000",
50 | "username": "test.user",
51 | "verified": True
52 | }
53 | response = Mock()
54 | response.status_code = 200
55 | response.json.return_value = resp_body
56 | mocked_get.return_value = response
57 | users_count = get_user_model().objects.all().count()
58 | payload = {
59 | 'access_token': 'abc123'
60 | }
61 |
62 | response = self.client.post(reverse('fb_login'), data=payload, status_code=200)
63 | self.assertIn('key', str(response.content))
64 | self.assertEqual(get_user_model().objects.all().count(), users_count + 1)
65 |
66 | # make sure that second request will not create a new user
67 | response = self.client.post(reverse('fb_login'), data=payload, status_code=200)
68 | self.assertIn('key', str(response.content))
69 | self.assertEqual(get_user_model().objects.all().count(), users_count + 1)
70 |
71 | @patch('requests.get')
72 | def _twitter_social_auth(self, mocked_get):
73 | # fake response for google call
74 | resp_body = {
75 | "id": "123123123123",
76 | }
77 |
78 | response = Mock()
79 | response.status_code = 200
80 | response.json.return_value = resp_body
81 | mocked_get.return_value = response
82 |
83 | users_count = get_user_model().objects.all().count()
84 | payload = {
85 | 'access_token': 'abc123',
86 | 'token_secret': '1111222233334444'
87 | }
88 |
89 | self.client.post(reverse('google_login'), data=payload)
90 |
91 | self.assertIn('key', str(response.content))
92 | self.assertEqual(get_user_model().objects.all().count(), users_count + 1)
93 |
94 | # make sure that second request will not create a new user
95 | self.client.post(reverse('google_login'), data=payload, status_code=200)
96 | self.assertIn('key', str(response.content))
97 | self.assertEqual(get_user_model().objects.all().count(), users_count + 1)
98 |
99 | @patch('allauth.account.views.ConfirmEmailView.post')
100 | def test_signup_redirect(self, mocked_post):
101 | mocked_post.return_value = None
102 | key = 'Mw:1hltk5:gwIwN2aQWMbmi3fnUD8e4qGI_5c'
103 | path = reverse('confirm_email', args=[key])
104 | response = self.client.post(path)
105 | mocked_post.assert_called_once()
106 | self.assertEqual(response.status_code, 302)
107 |
108 | def test_api_list_org(self):
109 | user = self._create_admin()
110 | org1 = self._create_org(name='org1', slug='org1')
111 | org1.add_user(user)
112 | path = reverse('list_orgs')
113 | self.client.force_login(user)
114 | response = self.client.get(path)
115 | self.assertContains(response, 'org1')
116 |
117 | def test_api_detail_org(self):
118 | user = self._create_admin()
119 | org1 = self._create_org(name='org1', slug='org1')
120 | org1.add_user(user)
121 | path = reverse('org_detail', args=[org1.pk])
122 | self.client.force_login(user)
123 | response = self.client.get(path)
124 | self.assertContains(response, 'org1')
125 |
126 | def test_api_create_org(self):
127 | user = self._create_admin()
128 | data = {
129 | 'description': 'some description',
130 | 'name': 'org1',
131 | 'email': 'org1@gmail.com',
132 | 'url': 'http://org1.com',
133 | 'slug': 'org1'
134 | }
135 | path = reverse('list_orgs')
136 | self.client.force_login(user)
137 | response = self.client.post(path, data=data)
138 | queryset = Organization.objects.filter(name='org1')
139 | self.assertEqual(queryset.count(), 1)
140 | self.assertEqual(response.status_code, 200)
141 | # test create an org which already exist
142 | response = self.client.post(path, data=data)
143 | self.assertContains(response, 'org_errors', status_code=400)
144 |
145 | def test_api_edit_org(self):
146 | user = self._create_admin()
147 | org = self._create_org(name='org1', slug='org1')
148 | org.add_user(user)
149 | path = reverse('org_detail', args=[org.pk])
150 | self.client.force_login(user)
151 | self.client.put(path, data=json.dumps({'slug': 'org11', 'name': 'org11'}),
152 | content_type='application/json')
153 | queryset = Organization.objects.filter(slug='org11')
154 | self.assertEqual(queryset.count(), 1)
155 | self.client.delete(path)
156 | queryset = Organization.objects.filter(name='org2')
157 | self.assertEqual(queryset.count(), 0)
158 |
--------------------------------------------------------------------------------
/template_library/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf.urls import include, url
2 |
3 | from . import views
4 |
5 | urlpatterns = [
6 | url(r'^rest-auth/google/$',
7 | views.google_login,
8 | name='google_login'),
9 | url(r'^rest-auth/facebook/$',
10 | views.fb_login,
11 | name='fb_login'),
12 | url(r'^rest-auth/',
13 | include('rest_auth.urls')),
14 | url(r'^', include('django.contrib.auth.urls')),
15 | url(r'^rest-auth/registration/',
16 | include('rest_auth.registration.urls')),
17 | url(r'^accounts/confirm-email/(?P[-:\w]+)/$',
18 | views.confirm_email,
19 | name='confirm_email'),
20 | url(r'^accounts/',
21 | include('openwisp_users.accounts.urls')),
22 | url(r'^orgs/$',
23 | views.list_orgs,
24 | name='list_orgs'),
25 | url(r'^orgs/(?P[^/]+)/$',
26 | views.org_detail,
27 | name='org_detail'),
28 | ]
29 |
--------------------------------------------------------------------------------
/template_library/views.py:
--------------------------------------------------------------------------------
1 | from allauth.account.views import ConfirmEmailView as BaseConfirmEmailView
2 | from allauth.socialaccount.providers.facebook.views import FacebookOAuth2Adapter
3 | from allauth.socialaccount.providers.google.views import GoogleOAuth2Adapter
4 | from django.shortcuts import redirect
5 | from django.conf import settings
6 | from rest_auth.registration.views import SocialLoginView
7 |
8 | from openwisp_users.models import Organization, OrganizationUser
9 |
10 | from .generics import BaseOrganizationListCreateAPIView, BaseOrganizationUpdateDeleteAPIView
11 |
12 |
13 | class OrganizationListCreateAPIView(BaseOrganizationListCreateAPIView):
14 | queryset = Organization.objects.all()
15 | org_model = Organization
16 | org_user_model = OrganizationUser
17 |
18 |
19 | class OrganizationRetrieveUpdateDeleteAPIView(BaseOrganizationUpdateDeleteAPIView):
20 | queryset = Organization.objects.all()
21 | org_model = Organization
22 |
23 |
24 | class FacebookLogin(SocialLoginView):
25 | adapter_class = FacebookOAuth2Adapter
26 |
27 |
28 | class GoogleLogin(SocialLoginView):
29 | adapter_class = GoogleOAuth2Adapter
30 |
31 |
32 | class ConfirmEmailView(BaseConfirmEmailView):
33 | """
34 | Override default email confirmation view to
35 | redirect users to login after confirming email
36 | """
37 |
38 | def post(self, *args, **kwargs):
39 | super(ConfirmEmailView, self).post(*args, **kwargs)
40 | return redirect(settings.LOGIN_URL)
41 |
42 |
43 | list_orgs = OrganizationListCreateAPIView.as_view()
44 | org_detail = OrganizationRetrieveUpdateDeleteAPIView.as_view()
45 | confirm_email = ConfirmEmailView.as_view()
46 | fb_login = FacebookLogin.as_view()
47 | google_login = GoogleLogin.as_view()
48 |
--------------------------------------------------------------------------------
/tests/__init__.py:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/openwisp/openwisp-template-library-backend/e4448282cd5cdb43132773b01104eca7053262d8/tests/__init__.py
--------------------------------------------------------------------------------
/tests/manage.py:
--------------------------------------------------------------------------------
1 | #!/usr/bin/env python
2 | import os
3 | import sys
4 |
5 | if __name__ == '__main__':
6 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'settings')
7 | from django.core.management import execute_from_command_line
8 | execute_from_command_line(sys.argv)
9 |
--------------------------------------------------------------------------------
/tests/settings.py:
--------------------------------------------------------------------------------
1 | import os
2 | import sys
3 |
4 | TESTING = sys.argv[1:2] == ['test']
5 | BASE_DIR = os.path.dirname(os.path.abspath(__file__))
6 |
7 | SECRET_KEY = '$dg0km-gvg0$=&8v3m+qtz0#%uoj=iuyuexnhn0^^9djq3e8'
8 |
9 | DEBUG = True
10 |
11 | ALLOWED_HOSTS = []
12 |
13 |
14 | INSTALLED_APPS = [
15 | 'django.contrib.auth',
16 | 'django.contrib.contenttypes',
17 | 'django.contrib.sessions',
18 | 'django.contrib.messages',
19 | 'django.contrib.staticfiles',
20 | 'corsheaders',
21 | # openwisp admin theme
22 | 'openwisp_utils.admin_theme',
23 | # rest framework
24 | 'rest_framework',
25 | 'rest_framework.authtoken',
26 | 'rest_auth',
27 | # allauth
28 | 'django.contrib.sites',
29 | 'allauth',
30 | 'allauth.account',
31 | 'allauth.socialaccount',
32 | 'rest_auth.registration',
33 | 'openwisp_users',
34 | # admin
35 | 'django.contrib.admin',
36 | 'allauth.socialaccount.providers.facebook',
37 | 'allauth.socialaccount.providers.google',
38 | # template library
39 | 'openwisp_controller.pki',
40 | 'openwisp_controller.config',
41 | 'template_library'
42 | ]
43 |
44 | AUTH_USER_MODEL = 'openwisp_users.User'
45 | SITE_ID = '1'
46 |
47 | REST_FRAMEWORK = {
48 | 'DEFAULT_AUTHENTICATION_CLASSES': [
49 | 'rest_framework.authentication.TokenAuthentication',
50 | 'rest_framework.authentication.SessionAuthentication',
51 | ],
52 | }
53 |
54 | MIDDLEWARE = [
55 | 'corsheaders.middleware.CorsMiddleware',
56 | 'django.middleware.security.SecurityMiddleware',
57 | 'django.contrib.sessions.middleware.SessionMiddleware',
58 | 'django.middleware.common.CommonMiddleware',
59 | 'django.middleware.csrf.CsrfViewMiddleware',
60 | 'django.contrib.auth.middleware.AuthenticationMiddleware',
61 | 'django.contrib.messages.middleware.MessageMiddleware',
62 | 'django.middleware.clickjacking.XFrameOptionsMiddleware',
63 | ]
64 |
65 | CORS_ORIGIN_WHITELIST = [
66 | "http://localhost:8000",
67 | "http://localhost:3000"
68 | ]
69 |
70 | CSRF_TRUSTED_ORIGINS = [
71 | "localhost:8000",
72 | "localhost:3000"
73 | ]
74 |
75 | ROOT_URLCONF = 'tests.urls'
76 |
77 | TEMPLATES = [
78 | {
79 | 'BACKEND': 'django.template.backends.django.DjangoTemplates',
80 | 'DIRS': [],
81 | 'APP_DIRS': True,
82 | 'OPTIONS': {
83 | 'context_processors': [
84 | 'django.template.context_processors.debug',
85 | 'django.template.context_processors.request',
86 | 'django.contrib.auth.context_processors.auth',
87 | 'django.contrib.messages.context_processors.messages',
88 | ],
89 | },
90 | },
91 | ]
92 |
93 | WSGI_APPLICATION = 'wsgi.application'
94 |
95 | DATABASES = {
96 | 'default': {
97 | 'ENGINE': 'django.db.backends.sqlite3',
98 | 'NAME': 'template_library.db',
99 | }
100 | }
101 |
102 |
103 | LANGUAGE_CODE = 'en-us'
104 |
105 | TIME_ZONE = 'UTC'
106 | USE_I18N = True
107 | USE_L10N = True
108 | USE_TZ = True
109 |
110 | STATIC_URL = '/static/'
111 |
112 | if not TESTING:
113 | CELERY_BROKER_URL = 'redis://localhost/1'
114 | else:
115 | CELERY_TASK_ALWAYS_EAGER = True
116 | CELERY_TASK_EAGER_PROPAGATES = True
117 | CELERY_BROKER_URL = 'memory://'
118 |
119 | # during development only
120 | EMAIL_BACKEND = 'django.core.mail.backends.console.EmailBackend'
121 |
122 | ACCOUNT_EMAIL_REQUIRED = True
123 | ACCOUNT_EMAIL_VERIFICATION = 'mandatory'
124 | LOGIN_ON_EMAIL_CONFIRMATION = False
125 | ACCOUNT_EMAIL_CONFIRMATION_ANONYMOUS_REDIRECT_URL = None
126 | LOGIN_URL = 'http://localhost:3000/login'
127 |
--------------------------------------------------------------------------------
/tests/urls.py:
--------------------------------------------------------------------------------
1 | from django.conf import settings
2 | from django.conf.urls import include, url
3 | from django.contrib import admin
4 | from django.contrib.staticfiles.urls import staticfiles_urlpatterns
5 |
6 | urlpatterns = [
7 | url(r'^admin/', admin.site.urls),
8 | url(r'^', include('template_library.urls')),
9 | url(r'^', include('openwisp_controller.config.api.urls', namespace='api'))
10 | ]
11 |
12 |
13 | urlpatterns += staticfiles_urlpatterns()
14 |
15 | if 'debug_toolbar' in settings.INSTALLED_APPS and settings.DEBUG:
16 | import debug_toolbar
17 | urlpatterns += [url(r'^__debug__/', include(debug_toolbar.urls))]
18 |
--------------------------------------------------------------------------------
/tests/wsgi.py:
--------------------------------------------------------------------------------
1 | import os
2 |
3 | from django.core.wsgi import get_wsgi_application
4 |
5 | os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'settings')
6 |
7 | application = get_wsgi_application()
8 |
--------------------------------------------------------------------------------