initial commit
gitea/ants-hub/pipeline/head This commit looks good Details

This commit is contained in:
Benjamin Dauvergne 2023-04-02 21:16:59 +02:00
commit 5d3e537c26
60 changed files with 3553 additions and 0 deletions

7
.gitignore vendored Normal file
View File

@ -0,0 +1,7 @@
build
dist
.coverage
htmlcov
pylint.out
*.pyc
*.sqlite3

32
.pre-commit-config.yaml Normal file
View File

@ -0,0 +1,32 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
- repo: https://github.com/asottile/pyupgrade
rev: v3.1.0
hooks:
- id: pyupgrade
args: ['--keep-percent-format', '--py37-plus']
- repo: https://github.com/adamchainz/django-upgrade
rev: 1.10.0
hooks:
- id: django-upgrade
args: ['--target-version', '2.2']
- repo: https://github.com/psf/black
rev: 22.3.0
hooks:
- id: black
args: ['--target-version', 'py37', '--skip-string-normalization', '--line-length', '110']
- repo: https://github.com/PyCQA/isort
rev: 5.12.0
hooks:
- id: isort
args: ['--profile', 'black', '--line-length', '110']
- repo: https://github.com/rtts/djhtml
rev: 'v1.5.2'
hooks:
- id: djhtml
args: ['--tabwidth', '2']
- repo: https://git.entrouvert.org/pre-commit-debian.git
rev: v0.1
hooks:
- id: pre-commit-debian

661
COPYING Normal file
View File

@ -0,0 +1,661 @@
GNU AFFERO GENERAL PUBLIC LICENSE
Version 3, 19 November 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.
A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate. Many developers of free software are heartened and
encouraged by the resulting cooperation. However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.
The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community. It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server. Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.
An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals. This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU Affero General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Remote Network Interaction; Use with the GNU General Public License.
Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software. This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source. For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code. There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<http://www.gnu.org/licenses/>.

58
Jenkinsfile vendored Normal file
View File

@ -0,0 +1,58 @@
@Library('eo-jenkins-lib@main') import eo.Utils
pipeline {
agent any
options { disableConcurrentBuilds() }
environment {
TMPDIR = "/tmp/$BUILD_TAG"
}
stages {
stage('Unit Tests') {
steps {
sh "tox"
}
post {
always {
script {
utils = new Utils()
utils.publish_coverage('coverage.xml')
utils.publish_coverage_native('index.html')
utils.publish_pylint('pylint.out')
}
mergeJunitResults()
}
}
}
stage('Packaging') {
steps {
script {
env.SHORT_JOB_NAME=sh(
returnStdout: true,
// given JOB_NAME=gitea/project/PR-46, returns project
// given JOB_NAME=project/main, returns project
script: '''
echo "${JOB_NAME}" | sed "s/gitea\\///" | awk -F/ '{print $1}'
'''
).trim()
if (env.GIT_BRANCH == 'main' || env.GIT_BRANCH == 'origin/main') {
sh "sudo -H -u eobuilder /usr/local/bin/eobuilder -d bullseye ${SHORT_JOB_NAME}"
} else if (env.GIT_BRANCH.startsWith('hotfix/')) {
sh "sudo -H -u eobuilder /usr/local/bin/eobuilder -d bullseye --branch ${env.GIT_BRANCH} --hotfix ${SHORT_JOB_NAME}"
}
}
}
}
}
post {
always {
script {
utils = new Utils()
utils.mail_notify(currentBuild, env, 'ci+jenkins-ants-hub@entrouvert.org')
}
}
cleanup {
sh "rm -rf ${env.TMPDIR}"
cleanWs()
}
}
}

9
MANIFEST.in Normal file
View File

@ -0,0 +1,9 @@
# locales
recursive-include src/ants_hub/locale *.po *.mo
# schemas
recursive-include src/ants_hub/api/static/schemas *.json
include COPYING README
include MANIFEST.in
include VERSION

47
README Normal file
View File

@ -0,0 +1,47 @@
ANTS-Hub
========
Hub pour servir une base de rende-vous CNI/Passeport au service centralisé de prise de rendez-vous de l'ANTS (https://rendez-vous-api.france-identite.fr/docs).
Local server
------------
To run a pre-configured local instances, do:
tox -e runserver
Login/password are admin/admin.
Tests
-----
Unit tests are written using py.test, and its pytest-django support library. To run them use tox.
tox
Code Style
----------
black is used to format the code, using thoses parameters:
black --target-version py37 --skip-string-normalization --line-length 110
isort is used to format the imports, using those parameters:
isort --profile black --line-length 110
pyupgrade is used to automatically upgrade syntax, using those parameters:
pyupgrade --keep-percent-format --py37-plus
djhtml is used to automatically indent html files, using those parameters:
djhtml --tabwidth 2
django-upgrade is used to automatically upgrade Django syntax, using those parameters:
django-upgrade --target-version 2.2
There is .pre-commit-config.yaml to use pre-commit to automatically run these tools
before commits. (execute `pre-commit install` to install the git hook.)

26
debian/ants-hub-manage vendored Executable file
View File

@ -0,0 +1,26 @@
#!/bin/sh
NAME=ants-hub
MANAGE=/usr/lib/$NAME/manage.py
# load Debian default configuration
export ANTS_HUB_SETTINGS_FILE=/usr/lib/$NAME/debian_config.py
# check user
if test x$1 = x"--forceuser"
then
shift
elif test $(id -un) != "$NAME"
then
echo "error: must use $0 with user ${NAME}"
exit 1
fi
if test $# -eq 0
then
python3 ${MANAGE} help
exit 1
fi
python3 ${MANAGE} "$@"

6
debian/ants-hub.dirs vendored Normal file
View File

@ -0,0 +1,6 @@
/etc/ants-hub
/etc/ants-hub/settings.d
/usr/lib/ants-hub
/var/lib/ants-hub/collectstatic
/var/lib/ants-hub/media
/var/log/ants-hub

2
debian/ants-hub.docs vendored Normal file
View File

@ -0,0 +1,2 @@
COPYING
README

4
debian/ants-hub.install vendored Normal file
View File

@ -0,0 +1,4 @@
debian/ants-hub-manage /usr/bin
debian/debian_config.py /usr/lib/ants-hub
debian/settings.py /etc/ants-hub
debian/uwsgi.ini /etc/ants-hub

43
debian/ants-hub.postinst vendored Normal file
View File

@ -0,0 +1,43 @@
#! /bin/sh
set -e
NAME="ants-hub"
USER=$NAME
GROUP=$NAME
case "$1" in
configure)
# make sure the administrative user exists
if ! getent passwd $USER >/dev/null; then
adduser --disabled-password --quiet --system \
--no-create-home --home /var/lib/$NAME \
--gecos "$NAME user" --group $USER
fi
# ensure dirs ownership
chown $USER:$GROUP /var/log/$NAME
chown $USER:$GROUP /var/lib/$NAME/collectstatic
chown $USER:$GROUP /var/lib/$NAME/media
# create a secret file
SECRET_FILE=/var/lib/$NAME/secret
if [ ! -f $SECRET_FILE ]; then
echo -n "Generating Django secret..." >&2
cat /dev/urandom | tr -dc [:alnum:]-_\!\%\^:\; | head -c70 > $SECRET_FILE
chown root:$GROUP $SECRET_FILE
chmod 0440 $SECRET_FILE
fi
;;
abort-upgrade|abort-remove|abort-deconfigure)
;;
*)
echo "postinst called with unknown argument \`$1'" >&2
exit 1
;;
esac
#DEBHELPER#
exit 0

25
debian/ants-hub.service vendored Normal file
View File

@ -0,0 +1,25 @@
[Unit]
Description=ANTS-Hub
After=network.target postgresql.service
Wants=postgresql.service
[Service]
Environment=ANTS_HUB_SETTINGS_FILE=/usr/lib/%p/debian_config.py
Environment=LANG=C.UTF-8
User=%p
Group=%p
ExecStartPre=/usr/bin/ants-hub-manage migrate --noinput
ExecStartPre=/usr/bin/ants-hub-manage collectstatic --noinput
ExecStart=/usr/bin/uwsgi --ini /etc/%p/uwsgi.ini
ExecReload=/bin/kill -HUP $MAINPID
KillSignal=SIGQUIT
PrivateTmp=true
Restart=on-failure
RuntimeDirectory=ants-hub
Type=notify
NotifyAccess=all
RestartSec=1min
[Install]
WantedBy=multi-user.target

5
debian/changelog vendored Normal file
View File

@ -0,0 +1,5 @@
ants-hub (0.1) unstable; urgency=low
* Initial release
-- Benjamin Dauvergne <bdauvergne@entrouvert.org> Sun, 2 Apr 2023 21:10:00 +0200

27
debian/control vendored Normal file
View File

@ -0,0 +1,27 @@
Source: ants-hub
Maintainer: Benjamin Dauvergne <bdauvergne@entrouvert.org>
Section: python
Priority: optional
Build-Depends: debhelper-compat (= 12),
dh-python,
python3-all,
python3-django,
python3-setuptools,
Standards-Version: 3.9.6
Package: python3-ants-hub
Architecture: all
Depends: python3-django (>= 3.2),
python3-requests,
${misc:Depends},
${python3:Depends},
Description: ANTS Hub for rendez-vous
Package: ants-hub
Architecture: all
Depends: python3-ants-hub (= ${binary:Version}),
python3-psycopg2,
uwsgi,
uwsgi-plugin-python3,
${misc:Depends},
Description: ANTS Hub for rendez-vous

72
debian/debian_config.py vendored Normal file
View File

@ -0,0 +1,72 @@
# This file is sourced by "execfile" from ants_hub.settings
import glob
import os
PROJECT_NAME = 'ants-hub'
ETC_DIR = '/etc/%s' % PROJECT_NAME
VAR_DIR = '/var/lib/%s' % PROJECT_NAME
# collecstatic destination
STATIC_ROOT = os.path.join(VAR_DIR, 'collectstatic')
# media destination
MEDIA_ROOT = os.path.join(VAR_DIR, 'media')
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(VAR_DIR, 'db.sqlite3'),
}
}
ADMINS = (('ANTS-Hub Administrator', 'root@localhost'),)
EMAIL_SUBJECT_PREFIX = '[%s] ' % PROJECT_NAME
LOGGING = {
'version': 1,
'formatters': {
'syslog': {
'format': '%(levelname)s %(name)s %(message)s',
},
},
'handlers': {
'syslog': {
'level': 'DEBUG',
'address': '/dev/log',
'class': 'logging.handlers.SysLogHandler',
'formatter': 'syslog',
},
'mail_admins': {
'level': 'ERROR',
'class': 'django.utils.log.AdminEmailHandler',
'include_html': True,
},
},
'loggers': {
'': {
'level': 'ERROR',
'handlers': ['mail_admins'],
},
'ants_hub': {
'level': 'INFO',
'handlers': ['syslog'],
'propagate': True,
},
},
}
# HTTPS Security
CSRF_COOKIE_SECURE = True
CSRF_COOKIE_HTTPONLY = True
CSRF_COOKIE_SAMESITE = 'Strict'
SESSION_COOKIE_SECURE = True
SESSION_COOKIE_SAMESITE = 'Strict'
SESSION_COOKIE_HTTPONLY = True
with open(os.path.join(VAR_DIR, 'secret')) as fd:
SECRET_KEY = fd.read()
main_settings_py = os.path.join(ETC_DIR, 'settings.py')
for filename in [main_settings_py] + sorted(glob.glob(os.path.join(ETC_DIR, 'settings.d', '*.py'))):
with open(filename) as fd:
exec(fd.read())

2
debian/python3-ants-hub.docs vendored Normal file
View File

@ -0,0 +1,2 @@
COPYING
README

12
debian/rules vendored Executable file
View File

@ -0,0 +1,12 @@
#!/usr/bin/make -f
# -*- makefile -*-
export PYBUILD_DISABLE=test
export PYBUILD_NAME=ants-hub
%:
dh $@ --with python3 --buildsystem=pybuild
override_dh_install:
mv $(CURDIR)/debian/python3-ants-hub/usr/bin/manage.py debian/ants-hub/usr/lib/ants-hub/
dh_install

45
debian/settings.py vendored Normal file
View File

@ -0,0 +1,45 @@
# SECURITY WARNING: don't run with debug turned on in production!
# DEBUG = False
# TEMPLATE_DEBUG = False
# ADMINS = (
# ('ANTS-Hub Administrator', 'root@localhost'),
# )
# ALLOWED_HOSTS must be correct in production!
# See https://docs.djangoproject.com/en/dev/ref/settings/#allowed-hosts
# ALLOWED_HOSTS = [
# '*',
# ]
# Databases
# DATABASES = {
# 'default': {
# 'ENGINE': 'django.db.backends.sqlite3',
# 'NAME': os.path.join(VAR_DIR, 'db.sqlite3'),
# }
# }
# EMAIL_SUBJECT_PREFIX = '[ants-hub] '
# LANGUAGE_CODE = 'fr-fr'
# TIME_ZONE = 'Europe/Paris'
# Email configuration
# EMAIL_SUBJECT_PREFIX = '[ants-hub] '
# SERVER_EMAIL = 'root@ants-hub.example.org'
# DEFAULT_FROM_EMAIL = 'webmaster@ants-hub.example.org'
# SMTP configuration
# EMAIL_HOST = 'localhost'
# EMAIL_HOST_USER = ''
# EMAIL_HOST_PASSWORD = ''
# EMAIL_PORT = 25
# HTTPS Security
# CSRF_COOKIE_SECURE = True
# CSRF_COOKIE_HTTPONLY = True
# CSRF_COOKIE_SAMESITE = 'Strict'
# SESSION_COOKIE_SECURE = True
# SESSION_COOKIE_SAMESITE = 'Strict'
# SESSION_COOKIE_HTTPONLY = True

28
debian/uwsgi.ini vendored Normal file
View File

@ -0,0 +1,28 @@
[uwsgi]
auto-procname = true
procname-prefix-spaced = ants-hub
plugin = python3
module = ants_hub.wsgi:application
http-socket = /run/ants-hub/http.sock
chmod-socket = 666
vacuum = true
master = true
processes = 3
threads = 10
harakiri = 30
max-requests = 10000
buffer-size = 32768
py-tracebacker = /run/ants-hub/py-tracebacker.sock.
stats = /run/ants-hub/stats.sock
memory-report = true
ignore-sigpipe = true
if-file = /etc/ants-hub/uwsgi-local.ini
include = /etc/ants-hub/uwsgi-local.ini
endif =

19
fixtures/admin.json Normal file
View File

@ -0,0 +1,19 @@
[
{
"fields" : {
"date_joined" : "2023-04-02T22:29:05.422Z",
"email" : "admin@example.com",
"first_name" : "",
"groups" : [],
"is_active" : true,
"is_staff" : true,
"is_superuser" : true,
"last_login" : null,
"last_name" : "",
"password" : "pbkdf2_sha256$260000$RfNtK3OfsmtxWKMc52r6wP$DRJf3Y2KA1tl6GPSr7+z6XJvmo2i3rg3vIDYr2uyFi0=",
"user_permissions" : [],
"username" : "admin"
},
"model" : "auth.user"
}
]

84
fixtures/example1.json Normal file
View File

@ -0,0 +1,84 @@
[
{
"model": "data.raccordement",
"fields": {
"name": "Plateforme X",
"apikey": "01a549058c1143ed98848ab79403ff99",
"notes": "",
"created": "2023-04-03T10:14:27.915Z",
"last_update": "2023-04-03T10:14:27.915Z"
}
},
{
"model": "data.collectivite",
"fields": {
"raccordement": [
"Plateforme X"
],
"nom": "Saint-Didier",
"source_id": "saint-didier",
"url": "",
"logo_url": "",
"rdv_url": "",
"gestion_url": "",
"annulation_url": "",
"created": "2023-04-03T10:14:42.795Z",
"last_update": "2023-04-03T10:14:42.795Z"
}
},
{
"model": "data.lieu",
"fields": {
"collectivite": [
"saint-didier",
"Plateforme X"
],
"nom": "Mairie",
"source_id": "mairie",
"numero_rue": "2 rue du four",
"code_postal": "99999",
"ville": "Saint-Didier",
"longitude": 1.0,
"latitude": 1.0,
"url": "",
"logo_url": "",
"rdv_url": "",
"gestion_url": "",
"annulation_url": "",
"created": "2023-04-03T10:15:06.265Z",
"last_update": "2023-04-03T10:15:06.265Z"
}
},
{
"model": "data.plage",
"fields": {
"lieu": [
"mairie",
"saint-didier",
"Plateforme X"
],
"date": "2023-04-03",
"horaires": "08:00-12:00,14:00-17:00",
"duree": 15,
"type_de_rdv": 3,
"created": "2023-04-03T10:15:41.013Z",
"last_update": "2023-04-03T10:15:41.013Z"
}
},
{
"model": "data.rendezvous",
"fields": {
"lieu": [
"mairie",
"saint-didier",
"Plateforme X"
],
"identifiant_predemande": "abcd",
"date": "2023-04-03T10:15:00Z",
"gestion_url": "",
"annulation_url": "",
"created": "2023-04-03T10:16:04.786Z",
"last_update": "2023-04-03T10:16:04.786Z"
}
}
]

4
fixtures/settings.py Normal file
View File

@ -0,0 +1,4 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
SECRET_KEY = 'abcd'
ANTS_HUB_X_HUB_RDV_AUTH_TOKEN = 'xyz'

9
manage.py Executable file
View File

@ -0,0 +1,9 @@
#!/usr/bin/env python
import os
import sys
if __name__ == "__main__":
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "ants_hub.settings")
from django.core.management import execute_from_command_line
execute_from_command_line(sys.argv)

28
scripts/check-migrations.sh Executable file
View File

@ -0,0 +1,28 @@
#!/bin/bash
set -e
# https://stackoverflow.com/questions/49778988/makemigrations-in-dev-machine-without-database-instance
CHECK_MIGRATIONS_SETTINGS=`mktemp`
trap "rm -f ${CHECK_MIGRATIONS_SETTINGS}" EXIT
cat <<EOF >${CHECK_MIGRATIONS_SETTINGS}
SECRET_KEY = 'abcd'
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.dummy',
}
}
EOF
APPS=$(python -c 'from django.conf import settings; print(" ".join(p for p in (p.split(".")[-1] for p in settings.INSTALLED_APPS if not p.startswith("django.")) if p not in ["admin", "auth", "contenttypes"]))')
TEMPFILE=`mktemp`
trap "rm -f ${TEMPFILE} ${CHECK_MIGRATIONS_SETTINGS}" EXIT
ANTS_HUB_SETTINGS_FILE=${CHECK_MIGRATIONS_SETTINGS} ./manage.py makemigrations --dry-run --noinput ${APPS} >${TEMPFILE} 2>&1 || true
if ! grep 'No changes detected' -q ${TEMPFILE}; then
echo '!!! Missing migration detected !!!'
cat ${TEMPFILE}
exit 1
else
exit 0
fi

121
scripts/pylint.rc Normal file
View File

@ -0,0 +1,121 @@
[MASTER]
persistent=yes
load-plugins=pylint_django
[MESSAGES CONTROL]
disable=
abstract-method,
arguments-differ,
assignment-from-none,
attribute-defined-outside-init,
bad-super-call,
broad-except,
consider-using-dict-comprehension,
consider-using-set-comprehension,
cyclic-import,
duplicate-code,
exec-used,
fixme,
global-variable-undefined,
import-outside-toplevel,
inconsistent-return-statements,
invalid-name,
keyword-arg-before-vararg,
missing-class-docstring,
missing-function-docstring,
missing-module-docstring,
no-else-return,
no-member,
non-parent-init-called,
not-callable,
possibly-unused-variable,
protected-access,
raise-missing-from,
redefined-argument-from-local,
redefined-builtin,
redefined-outer-name,
signature-differs,
stop-iteration-return,
super-init-not-called,
superfluous-parens,
too-many-ancestors,
too-many-arguments,
too-many-branches,
too-many-instance-attributes,
too-many-lines,
too-many-locals,
too-many-nested-blocks,
too-many-return-statements,
too-many-statements,
undefined-loop-variable,
unnecessary-comprehension,
unspecified-encoding,
unsubscriptable-object,
unsupported-membership-test,
unused-argument,
use-a-generator,
c-extension-no-member,
consider-using-f-string
[REPORTS]
output-format=parseable
[BASIC]
no-docstring-rgx=__.*__|_.*
class-rgx=[A-Z_][a-zA-Z0-9_]+$
function-rgx=[a-zA_][a-zA-Z0-9_]{2,70}$
method-rgx=[a-z_][a-zA-Z0-9_]{2,70}$
const-rgx=(([A-Z_][A-Z0-9_]*)|([a-z_][a-z0-9_]*)|(__.*__)|register|urlpatterns)$
good-names=_,i,j,k,e,x,Run,,setUp,tearDown,r,p,s,v,fd
[TYPECHECK]
# Tells whether missing members accessed in mixin class should be ignored. A
# mixin class is detected if its name ends with "mixin" (case insensitive).
ignore-mixin-members=yes
# List of classes names for which member attributes should not be checked
# (useful for classes with attributes dynamically set).
ignored-classes=
# List of members which are set dynamically and missed by pylint inference
# system, and so shouldn't trigger E0201 when accessed.
generated-members=objects,DoesNotExist,id,pk,_meta,base_fields,context
# List of method names used to declare (i.e. assign) instance attributes
defining-attr-methods=__init__,__new__,setUp
[VARIABLES]
init-import=no
dummy-variables-rgx=_|dummy
good-names=_,i,j,k,e,x,Run,,setUp,tearDown,r,p,s,v,fd
[SIMILARITIES]
min-similarity-lines=6
ignore-comments=yes
ignore-docstrings=yes
[MISCELLANEOUS]
notes=FIXME,XXX,TODO
[FORMAT]
max-line-length=160
max-module-lines=2000
indent-string=' '
[DESIGN]
max-args=10
max-locals=15
max-returns=6
max-branches=12
max-statements=50
max-parents=7
max-attributes=7
min-public-methods=0
max-public-methods=50

4
scripts/pylint.sh Executable file
View File

@ -0,0 +1,4 @@
#!/bin/bash
set -e
pylint -f parseable --rcfile ./scripts/pylint.rc "$@" | tee pylint.out; test $PIPESTATUS -eq 0

144
setup.py Normal file
View File

@ -0,0 +1,144 @@
#! /usr/bin/env python
#
'''
Setup script for ANTS-Hub
'''
import glob
import os
import subprocess
import sys
try:
from setuptools import Command
from setuptools.command.build import build as _build
except ImportError:
from distutils.cmd import Command
from distutils.command.build import build as _build
from setuptools import find_packages, setup
from setuptools.command.install_lib import install_lib as _install_lib
from setuptools.command.sdist import sdist as _sdist
class compile_translations(Command):
description = 'compile message catalogs to MO files via django compilemessages'
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
curdir = os.getcwd()
try:
os.environ.pop('DJANGO_SETTINGS_MODULE', None)
from django.core.management import call_command
for dir in glob.glob('src/*'):
for path, dirs, files in os.walk(dir):
if 'locale' not in dirs:
continue
os.chdir(os.path.realpath(path))
call_command('compilemessages')
os.chdir(curdir)
except ImportError:
print
sys.stderr.write('!!! Please install Django >= 1.4 to build translations')
print
print
os.chdir(curdir)
class build(_build):
sub_commands = [('compile_translations', None)] + _build.sub_commands
class sdist(_sdist):
sub_commands = [('compile_translations', None)] + _sdist.sub_commands
def run(self):
print("creating VERSION file")
if os.path.exists('VERSION'):
os.remove('VERSION')
version = get_version()
version_file = open('VERSION', 'w')
version_file.write(version)
version_file.close()
_sdist.run(self)
print("removing VERSION file")
if os.path.exists('VERSION'):
os.remove('VERSION')
class install_lib(_install_lib):
def run(self):
self.run_command('compile_translations')
_install_lib.run(self)
def get_version():
"""Use the VERSION, if absent generates a version with git describe, if not
tag exists, take 0.0- and add the length of the commit log.
"""
if os.path.exists('VERSION'):
with open('VERSION') as v:
return v.read()
if os.path.exists('.git'):
p = subprocess.Popen(
['git', 'describe', '--dirty=.dirty', '--match=v*'],
stdout=subprocess.PIPE,
stderr=subprocess.PIPE,
)
result = p.communicate()[0]
if p.returncode == 0:
result = result.decode('ascii').strip()[1:] # strip spaces/newlines and initial v
if '-' in result: # not a tagged version
real_number, commit_count, commit_hash = result.split('-', 2)
version = '%s.post%s+%s' % (real_number, commit_count, commit_hash)
else:
version = result
return version
else:
return '0.0.post%s' % len(subprocess.check_output(['git', 'rev-list', 'HEAD']).splitlines())
return '0.0'
with open('README') as fd:
long_description = fd.read()
setup(
name="ants-hub",
version=get_version(),
license="AGPLv3+",
description='ANTS-Hub',
long_description=long_description,
url="http://dev.entrouvert.org/projects/ants-hub/",
author="Entr'ouvert",
maintainer="Benjamin Dauvergne",
maintainer_email="bdauvergne@entrouvert.com",
scripts=('manage.py',),
packages=find_packages('src'),
package_dir={
'': 'src',
},
include_package_data=True,
install_requires=[
'django>=3.2,<3.3',
'jsonschema<4',
'requests',
],
classifiers=[
"License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
"Operating System :: OS Independent",
"Programming Language :: Python",
],
cmdclass={
'build': build,
'install_lib': install_lib,
'compile_translations': compile_translations,
'sdist': sdist,
},
)

0
src/ants_hub/__init__.py Normal file
View File

33
src/ants_hub/admin.py Normal file
View File

@ -0,0 +1,33 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
from django.conf import settings
from django.contrib import admin
from django.contrib.auth import get_user_model
from django.contrib.auth.admin import UserAdmin
from django.utils.module_loading import autodiscover_modules
from django.views.decorators.cache import never_cache
if 'mellon' in settings.INSTALLED_APPS:
import mellon.views as mellon_views # pylint: disable=import-error
else:
mellon_views = None
class AdminSite(admin.AdminSite):
@never_cache
def login(self, request, extra_context=None):
if mellon_views:
return mellon_views.login(request)
return super().login(request, extra_context=extra_context)
@never_cache
def logout(self, request, extra_context=None):
if mellon_views:
return mellon_views.logout(request)
return super().logout(request, extra_context=extra_context)
site = AdminSite()
if not mellon_views:
site.register(get_user_model(), UserAdmin)
autodiscover_modules('admin', register_to=site)

View File

View File

@ -0,0 +1,209 @@
{
"$id": "https://entrouvert.com/ants-hub-push-schema.json",
"title": "Format du endpoint PUSH pour le HUB ANTS",
"type": "object",
"properties": {
"collectivites": {
"type": "array",
"items": {
"$ref": "#/$defs/collectivite"
}
}
},
"$defs": {
"collectivite": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Identifiant de la collectivit\u00e9 \u00e0 la source (chrono)"
},
"nom": {
"type": "string"
},
"url": {
"description": "URL g\u00e9n\u00e9rale du portail de la collectivit\u00e9",
"$ref": "#/$defs/url"
},
"logo_url": {
"description": "URL du logo de la collectivit\u00e9",
"$ref": "#/$defs/url"
},
"rdv_url": {
"$ref": "#/$defs/url",
"description": "URL g\u00e9n\u00e9rique pour la prise de rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs our le URLs pour les lieux si elles sont absentes."
},
"gestion_url": {
"$ref": "#/$defs/url",
"description": "URL g\u00e9n\u00e9rique pour la gestion des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs de gestion si elles sont absentes."
},
"annulation_url": {
"$ref": "#/$defs/url",
"description": "URL g\u00e9n\u00e9rique pour l'annulation des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs d'annulation si elles sont absentes."
},
"lieux": {
"type": "array",
"items": {
"$ref": "#/$defs/lieu"
}
}
}
},
"type-rdv": {
"enum": [
"CNI",
"PASSPORT",
"CNI-PASSPORT",
"RETRIEVAL"
]
},
"lieu": {
"type": "object",
"required": [
"id"
],
"additionalProperties": false,
"dependentRequired": {
"latitude": [
"longitude"
],
"longitude": [
"latitude"
]
},
"properties": {
"id": {
"type": "string",
"description": "Identifiant du lieu \u00e0 la source (chrono)"
},
"nom": {
"type": "string"
},
"numero_rue": {
"type": "string"
},
"code_postal": {
"type": "string"
},
"ville": {
"type": "string"
},
"longitude": {
"type": "number"
},
"latitude": {
"type": "number"
},
"url": {
"description": "URL g\u00e9n\u00e9rale du portail de la collectivit\u00e9 pour ce lieu",
"$ref": "#/$defs/url"
},
"rdv_url": {
"$ref": "#/$defs/url",
"description": "URL g\u00e9n\u00e9rique pour la prise de rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs si elles sont absentes"
},
"gestion_url": {
"$ref": "#/$defs/url",
"description": "URL g\u00e9n\u00e9rique pour la gestion des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs de gestion si elles sont absentes"
},
"annulation_url": {
"$ref": "#/$defs/url",
"description": "URL g\u00e9n\u00e9rique pour l'annulation des rendez-vous pour la collectivit\u00e9. Remplace toutes les autres URLs d'annulation si elles sont absentes"
},
"plages": {
"type": "array",
"items": {
"$ref": "#/$defs/plage"
}
},
"rdvs": {
"type": "array",
"items": {
"$ref": "#/$defs/rdv"
}
}
}
},
"plage": {
"type": "object",
"required": [
"date",
"types_rdv"
],
"additionalProperties": false,
"description": "Plage de rendez-vous disponibles",
"properties": {
"date": {
"type": "string",
"format": "date",
"description": "Date de la plage, format YYYY-MM-DD"
},
"heure_debut": {
"type": "string",
"format": "time",
"description": "Heure de d\u00e9but de la plage format, HH:MM"
},
"heure_fin": {
"type": "string",
"format": "time",
"description": "Heure de fin de la plage format, HH:MM"
},
"duree": {
"type": "number",
"description": "Dur\u00e9e des rendez-vous en minutes enti\u00e8res"
},
"personnes": {
"type": "number",
"description": "Nombre maximum de personnes pour ces rendez-vous",
"minimum": 1,
"maximum": 4
},
"types_rdv": {
"type": "array",
"items": {
"$ref": "#/$defs/type-rdv"
}
}
}
},
"rdv": {
"type": "object",
"required": [
"id",
"date"
],
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Identifiant de la pr\u00e9-demande ANTS"
},
"date": {
"type": "string",
"format": "datetime",
"description": "Date du rendez-vous format YYYY-MM-DDTHH:MM:SS"
},
"annule": {
"type": "boolean",
"description": "Si vrai, indique que le rendez-vous a été annulé"
},
"gestion_url": {
"description": "URL optionnelle de gestion du rendez-vous, si absent l'URL du lieu ou de la collectivit\u00e9 est utilis\u00e9e",
"$ref": "#/$defs/url"
},
"annulation_url": {
"description": "URL optionnelle d'annulation du rendez-vous, si absent l'URL du lieu ou de la collectivit\u00e9 est utilis\u00e9e",
"$ref": "#/$defs/url"
}
}
},
"url": {
"type": "string",
"format": "uri"
}
}
}

19
src/ants_hub/api/urls.py Normal file
View File

@ -0,0 +1,19 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
from django.urls import path
from .views import ants, chrono
# ANTS API
urlpatterns = [
path('ants/getManagedMeetingPoints', ants.get_managed_meeting_points),
path('ants/availableTimeSlots', ants.available_time_slots),
path('ants/searchApplicationIds', ants.search_application_ids),
]
# Chrono API
urlpatterns += [
path('chrono/ping/', chrono.ping),
path('chrono/rendez-vous-disponibles/', chrono.rendez_vous_disponibles),
path('chrono/predemandes/', chrono.predemandes),
]

View File

View File

@ -0,0 +1,161 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import datetime
import functools
import secrets
from django.conf import settings
from django.http import JsonResponse
from ants_hub.data.models import Lieu, Plage, RendezVous, TypeDeRdv
def authenticate(func):
@functools.wraps(func)
def wrapper(request, *args, **kwargs):
header = request.headers.get('X-Hub-Rdv-Auth-Token', '')
if not header:
return JsonResponse("Missing X-HUB-RDV-AUTH-TOKEN header", status=401, safe=False)
setting = settings.ANTS_HUB_X_HUB_RDV_AUTH_TOKEN
if not setting:
return JsonResponse("X-HUB-RDV-AUTH-TOKEN header invalid", status=401, safe=False)
if not secrets.compare_digest(header, setting):
return JsonResponse("X-HUB-RDV-AUTH-TOKEN header invalid", status=401, safe=False)
return func(request, *args, **kwargs)
return wrapper
@authenticate
def get_managed_meeting_points(request):
lieux = []
for lieu in Lieu.objects.select_related('collectivite'):
d = {
'id': str(lieu.id),
'name': lieu.nom,
'longitude': lieu.longitude,
'latitude': lieu.latitude,
'public_entry_address': lieu.numero_rue,
'zip_code': lieu.code_postal,
'city_name': lieu.ville,
}
website = lieu.url or lieu.collectivite.url
if website:
d['website'] = website
city_logo = lieu.logo_url or lieu.collectivite.logo_url
if city_logo:
d['city_logo'] = city_logo
lieux.append(d)
return JsonResponse(lieux, safe=False)
def available_time_slots_parse_qs(request):
meeting_point_ids = request.GET.getlist('meeting_point_ids')
if not meeting_point_ids:
raise ValueError('missing meeting_point_ids')
try:
meeting_point_ids = map(int, map(str.strip, meeting_point_ids))
except ValueError:
raise ValueError('invalid meeting_point_ids')
start_date = request.GET.get('start_date', '').strip()
if not start_date:
raise ValueError('missing start_date')
try:
start_date = datetime.datetime.strptime(start_date, '%Y-%m-%d').date()
except ValueError:
raise ValueError('invalid start_date')
if start_date < datetime.date.today():
start_date = datetime.date.today()
end_date = request.GET.get('end_date', '').strip()
if not end_date:
raise ValueError('missing end_date')
try:
end_date = datetime.datetime.strptime(end_date, '%Y-%m-%d').date()
except ValueError:
raise ValueError('invalid end_date')
if end_date < start_date:
raise ValueError('end_date must be >= start_date')
end_date = min(end_date, start_date + datetime.timedelta(days=180))
reason = request.GET.get('reason', 'CNI').strip()
if reason:
try:
reason = TypeDeRdv.from_label(reason)
except ValueError:
reason = TypeDeRdv.CNI
try:
documents_number = int(request.GET.get('documents_number', '').strip())
except (ValueError, TypeError):
documents_number = 1
return meeting_point_ids, start_date, end_date, reason, documents_number
@authenticate
def available_time_slots(request):
try:
meeting_point_ids, start_date, end_date, reason, documents_number = available_time_slots_parse_qs(
request
)
except ValueError as e:
return JsonResponse(
{
'detail': [
{
'loc': 'query-string',
'msg': str(e),
'type': 'bad request',
}
]
},
status=422,
)
types_de_rdv = [reason]
if reason in (TypeDeRdv.CNI, TypeDeRdv.PASSPORT):
types_de_rdv.append(TypeDeRdv.CNI_PASSPORT)
elif reason == TypeDeRdv.CNI_PASSPORT:
types_de_rdv.append(TypeDeRdv.CNI)
types_de_rdv.append(TypeDeRdv.PASSPORT)
rdv_by_lieu = {}
qs = Plage.objects.filter(lieu__id__in=meeting_point_ids)
qs = qs.filter(type_de_rdv__in=types_de_rdv)
qs = qs.filter(date__gte=start_date, date__lte=end_date)
qs = qs.filter(persones__gte=documents_number)
qs = qs.select_related('lieu', 'lieu__collectivite')
for plage in qs.order_by('lieu', 'date'):
for time_slot in plage.available_time_slots():
time_slot['callback_url'] = request.build_absolute_uri(time_slot['callback_url'])
rdv_by_lieu.setdefault(str(plage.lieu_id), []).append(time_slot)
return JsonResponse(rdv_by_lieu)
@authenticate
def search_application_ids(request):
application_ids = map(str.strip, request.GET.getlist('application_ids'))
application_ids = filter(None, application_ids)
application_ids = filter(lambda x: len(x) < 64, application_ids)
if not application_ids:
return JsonResponse(
{
'detail': [
{
'loc': 'query-string',
'msg': 'missing application_ids',
'type': 'bad request',
}
]
},
status=422,
)
rdv_by_identifiant_predemande = {}
qs = RendezVous.objects.filter(identifiant_predemande__in=application_ids)
qs = qs.select_related('lieu', 'lieu__collectivite')
for rdv in qs:
rdv_by_identifiant_predemande.setdefault(rdv.identifiant_predemande, []).append(
{
'meeting_point': rdv.lieu.nom,
'datetime': rdv.date.isoformat(),
'management_url': request.build_absolute_uri(rdv.make_gestion_url()),
'annulation_url': request.build_absolute_uri(rdv.make_annulation_url()),
}
)
return JsonResponse(rdv_by_identifiant_predemande)

View File

@ -0,0 +1,289 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import base64
import binascii
import collections
import datetime
import functools
import json
import os
import jsonschema
from django.core.exceptions import ValidationError
from django.db.transaction import atomic
from django.http import JsonResponse
from django.utils.timezone import now
from django.views.decorators.csrf import csrf_exempt
from django.views.generic import View
from ants_hub.data.models import Collectivite, Horaire, HoraireList, Lieu, Raccordement, RendezVous, TypeDeRdv
with open(os.path.join(os.path.dirname(__file__), '..', 'static', 'schemas', 'rdv-disponibles.json')) as fd:
RENDEZ_VOUS_DISPONIBLES_SCHEMA = json.load(fd)
def authenticate(func):
@functools.wraps(func)
def wrapper(request, *args, **kwargs):
header = request.headers.get('Authorization', '').encode()
if not header:
return JsonResponse("Missing Authorization header", status=401, safe=False)
auth = header.split()
if not auth or auth[0].lower() != b'basic' or len(auth) != 2:
return JsonResponse("Invalid Authorization header", status=401, safe=False)
try:
auth_decoded = base64.b64decode(auth[1]).decode()
except (TypeError, UnicodeDecodeError, binascii.Error):
return JsonResponse("Invalid Authorization header", status=401, safe=False)
apikey = auth_decoded.split(':', 1)[0]
raccordement = Raccordement.objects.get_by_apikey(apikey)
if not raccordement:
return JsonResponse("Invalid API key", status=401, safe=False)
request.raccordement = raccordement
return func(request, *args, **kwargs)
return wrapper
@authenticate
def ping(request):
return JsonResponse({'err': 0})
class RendezVousDisponibleView(View):
def get(self, request):
collectivites_data = []
for collectivite in request.raccordement.collectivites.prefetch_related('lieux').order_by('created'):
lieux_data = []
collectivite_data = {
'id': collectivite.source_id,
'nom': collectivite.nom,
'url': collectivite.url,
'created': collectivite.created.isoformat(),
'last_update': collectivite.created.isoformat(),
'lieux': lieux_data,
'nombre_de_lieux': collectivite.lieux.count(),
'nombre_de_pre_demandes_actives': RendezVous.objects.filter(
date__lt=now(), lieu__collectivite=collectivite
).count(),
}
for key in ['logo_url', 'rdv_url', 'gestion_url', 'annulation_url']:
if getattr(collectivite, key, None):
collectivite_data[key] = getattr(collectivite, key)
for lieu in collectivite.lieux.order_by('created'):
lieu_data = {
'id': lieu.source_id,
'nom': lieu.nom,
'numero_rue': lieu.numero_rue,
'code_postal': lieu.code_postal,
'ville': lieu.ville,
'longitude': lieu.longitude,
'latitude': lieu.latitude,
'nombre_de_pre_demandes_actives': lieu.rdvs.filter(date__lt=now()).count(),
'nombre_de_jours_avec_rdv_disponibles': lieu.plages.filter(date__lt=now())
.distinct('date')
.count(),
}
for key in ['url', 'logo_url', 'rdv_url', 'gestion_url', 'annulation_url']:
if getattr(lieu, key, None):
lieu_data[key] = getattr(collectivite, key)
lieux_data.append(lieu_data)
collectivites_data.append(collectivite_data)
return JsonResponse(
{
'err': 0,
'collectivites': collectivites_data,
}
)
collectivites_created = 0
collectivites_updated = 0
lieux_created = 0
lieux_updated = 0
plage_created = 0
plage_deleted = 0
rdv_created = 0
rdv_deleted = 0
def handle_rdv_payload(self, lieu, rdv):
try:
identifiant_predemande = rdv.pop('id')
date = datetime.datetime.fromisoformat(rdv.pop('date'))
annule = bool(rdv.pop('annule', False))
except ValueError as e:
raise ValidationError('rdv %s invalid: %s' % (rdv, e))
if annule:
_, count_by_model = lieu.rdvs.filter(
identifiant_predemande=identifiant_predemande, date=date
).delete()
self.rdv_deleted += count_by_model['data.RendezVous']
return
_, created = lieu.rdvs.update_or_create(
identifiant_predemande=identifiant_predemande, date=date, defaults=rdv
)
self.rdv_created += bool(created)
def handle_plages_payload(self, lieu, plages):
by_date_and_type_and_personnes = collections.defaultdict(set)
full = set()
for plage in plages:
try:
date = datetime.date.fromisoformat(plage['date'])
types_rdv = [TypeDeRdv.from_label(typ) for typ in plage['types_rdv']]
if not types_rdv:
types_rdv = [TypeDeRdv.CNI]
personnes = plage.get('personnes', 1)
if not plage.get('heure_debut'):
full.update((date, t, personnes) for t in types_rdv)
continue
heure_debut = datetime.time.fromisoformat(plage['heure_debut'])
heure_fin = datetime.time.fromisoformat(plage['heure_fin'])
duree = int(plage['duree'])
if heure_fin < heure_debut:
raise ValueError('heure de fin inférieure à heure de début')
if datetime.datetime.combine(date, heure_fin) - datetime.datetime.combine(
date, heure_debut
) < datetime.timedelta(minutes=duree):
raise ValueError('différence heure de début et de fin inférieure à la durée')
for t in types_rdv:
by_date_and_type_and_personnes[(date, t, personnes)].add((heure_debut, heure_fin, duree))
except ValueError as e:
raise ValidationError('plage %s: %s' % (plage, e))
for x in set(by_date_and_type_and_personnes) | full:
date, type_rdv, personnes = x
_, count_by_model = lieu.plages.filter(date=date, type_de_rdv=type_rdv).delete()
if x in full:
self.plage_deleted += count_by_model['data.Plage']
continue
values = by_date_and_type_and_personnes.get(x)
durees = list({duree for heure_debut, heure_fin, duree in values})
if len(durees) > 1:
raise ValidationError(
'plages %s: la durée varie pour les mêmes rendez-vous du même lieu' % values
)
duree = durees[0]
horaires = HoraireList()
for start, end, _ in values:
try:
horaires.append(Horaire(start=start, end=end))
except ValueError:
raise ValidationError('plages %s-%s: les périodes se chevauchent' % (date, values))
lieu.plages.create(
date=date, type_de_rdv=type_rdv, personnes=personnes, horaires=horaires, duree=duree
)
self.plage_created += 1
def handle_lieu_payload(self, collectivite, payload):
source_id = payload.pop('id')
plages = payload.pop('plages', [])
rdvs = payload.pop('rdvs', [])
try:
lieu = collectivite.lieux.get(source_id=source_id)
updated = False
for key in payload:
if getattr(lieu, key) != payload[key]:
setattr(lieu, key, payload[key])
updated = True
lieu.full_clean()
if updated:
lieu.save()
self.lieux_updated += 1
except Lieu.DoesNotExist:
lieu = Lieu(collectivite=collectivite, source_id=source_id, **payload)
lieu.full_clean()
lieu.save()
self.lieux_created += 1
self.handle_plages_payload(lieu, plages)
for rdv in rdvs:
self.handle_rdv_payload(lieu, rdv)
def handle_collectivite_payload(self, raccordement, payload):
source_id = payload.pop('id')
lieux_payload = payload.pop('lieux', [])
try:
collectivite = raccordement.collectivites.get(source_id=source_id)
updated = False
for key in payload:
if getattr(collectivite, key) != payload[key]:
setattr(collectivite, key, payload[key])
updated = True
collectivite.full_clean()
if updated:
collectivite.save()
self.collectivites_updated += 1
except Collectivite.DoesNotExist:
collectivite = Collectivite(raccordement=raccordement, source_id=source_id, **payload)
collectivite.full_clean()
collectivite.save()
self.collectivites_created += 1
for lieu_payload in lieux_payload:
self.handle_lieu_payload(collectivite, lieu_payload)
def post(self, request):
try:
payload = json.loads(request.body)
except ValueError:
return JsonResponse({'err': 'invalid-json'}, status=400)
try:
jsonschema.validate(payload, RENDEZ_VOUS_DISPONIBLES_SCHEMA)
except jsonschema.ValidationError as e:
return JsonResponse({'err': 'invalid-json', 'detail': e.message}, status=400)
try:
with atomic():
# prevent concurrent updates to the data of the same raccordement
request.raccordement.lock()
for collectivite in payload.get('collectivites', []):
self.handle_collectivite_payload(request.raccordement, collectivite)
except (ValueError, ValidationError) as e:
return JsonResponse(
{
'err': 1,
'error': str(e),
}
)
return JsonResponse(
{
'err': 0,
'data': {
'collectivites_created': self.collectivites_created,
'collectivites_updated': self.collectivites_updated,
'lieux_created': self.lieux_created,
'lieux_updated': self.lieux_updated,
'plage_created': self.plage_created,
'plage_deleted': self.plage_deleted,
'rdv_created': self.rdv_created,
'rdv_deleted': self.rdv_deleted,
},
}
)
rendez_vous_disponibles = csrf_exempt(authenticate(RendezVousDisponibleView.as_view()))
@csrf_exempt
@authenticate
def predemandes(request):
if request.method == 'GET':
return get_predemandes(request)
elif request.method == 'POST':
return post_predemandes(request)
return JsonResponse({'err': 'method-no-allowed'}, status=405)
def get_predemandes(request):
return JsonResponse({'err': 0})
@atomic
def post_predemandes(request):
return JsonResponse({'err': 0})

View File

View File

@ -0,0 +1,24 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
from django.contrib import admin
from ants_hub.admin import site
from . import models
class RaccordementAdmin(admin.ModelAdmin):
list_display = ['name', 'short_apikey']
search_fields = ['name']
def short_apikey(self, instance):
return instance.apikey[:4] + ''
short_apikey.short_description = 'API key'
site.register(models.Raccordement, RaccordementAdmin)
site.register(models.Collectivite)
site.register(models.Lieu)
site.register(models.Plage)
site.register(models.RendezVous)

View File

@ -0,0 +1,256 @@
# Generated by Django 3.2.18 on 2023-04-03 15:18
import uuid
import django.core.validators
import django.db.models.deletion
from django.db import migrations, models
import ants_hub.data.models
class Migration(migrations.Migration):
initial = True
dependencies = []
operations = [
migrations.CreateModel(
name='Collectivite',
fields=[
(
'id',
models.BigAutoField(
auto_created=True, primary_key=True, serialize=False, verbose_name='ID'
),
),
('nom', ants_hub.data.models.CharField(verbose_name='Nom')),
(
'source_id',
ants_hub.data.models.CharField(verbose_name='Identifiant de la collectivité à la source'),
),
('url', ants_hub.data.models.URLField(verbose_name='URL du portail')),
('logo_url', ants_hub.data.models.URLField(blank=True, verbose_name='URL du logo')),
(
'rdv_url',
ants_hub.data.models.URLField(blank=True, verbose_name='URL de prise de rendez-vous '),
),
(
'gestion_url',
ants_hub.data.models.URLField(blank=True, verbose_name='URL de gestion des rendez-vous'),
),
(
'annulation_url',
ants_hub.data.models.URLField(
blank=True, verbose_name="URL d'annulation des rendez-vous"
),
),
('created', models.DateTimeField(auto_now_add=True, verbose_name='Création')),
('last_update', models.DateTimeField(auto_now=True, verbose_name='Dernière mise à jour')),
],
options={
'verbose_name': 'collectivité',
'verbose_name_plural': 'collectivités',
'db_table': 'ants_hub_collectivite',
},
),
migrations.CreateModel(
name='Lieu',
fields=[
(
'id',
models.BigAutoField(
auto_created=True, primary_key=True, serialize=False, verbose_name='ID'
),
),
('nom', ants_hub.data.models.CharField(verbose_name='Nom')),
('source_id', ants_hub.data.models.CharField(verbose_name='Identifiant du lieu à la source')),
('numero_rue', ants_hub.data.models.CharField(verbose_name='Numéro rue')),
('code_postal', ants_hub.data.models.CharField(verbose_name='Code postal')),
('ville', ants_hub.data.models.CharField(verbose_name='Ville')),
('longitude', models.FloatField(verbose_name='Longitude')),
('latitude', models.FloatField(verbose_name='Latitude')),
('url', ants_hub.data.models.URLField(blank=True, verbose_name='URL du portail')),
('logo_url', ants_hub.data.models.URLField(blank=True, verbose_name='URL du logo')),
(
'rdv_url',
ants_hub.data.models.URLField(blank=True, verbose_name='URL de prise de rendez-vous '),
),
(
'gestion_url',
ants_hub.data.models.URLField(blank=True, verbose_name='URL de gestion des rendez-vous'),
),
(
'annulation_url',
ants_hub.data.models.URLField(
blank=True, verbose_name="URL d'annulation des rendez-vous"
),
),
('created', models.DateTimeField(auto_now_add=True, verbose_name='Création')),
('last_update', models.DateTimeField(auto_now=True, verbose_name='Dernière mise à jour')),
(
'collectivite',
models.ForeignKey(
on_delete=django.db.models.deletion.PROTECT,
related_name='lieux',
to='data.collectivite',
verbose_name='Collectivité',
),
),
],
options={
'verbose_name': 'lieu',
'verbose_name_plural': 'lieux',
'db_table': 'ants_hub_lieu',
'unique_together': {('collectivite', 'nom'), ('collectivite', 'source_id')},
},
),
migrations.CreateModel(
name='Raccordement',
fields=[
(
'uuid',
models.UUIDField(
default=uuid.uuid4,
editable=False,
primary_key=True,
serialize=False,
verbose_name='UUID',
),
),
('name', ants_hub.data.models.CharField(unique=True, verbose_name='Nom')),
(
'apikey',
ants_hub.data.models.CharField(
default=ants_hub.data.models.generate_apikey,
help_text='Écrire "NEW" pour en générer une nouvelle.',
unique=True,
verbose_name='API key',
),
),
(
'apikey_digest',
models.UUIDField(db_index=True, editable=False, verbose_name="Condensat de l'API key"),
),
('notes', models.TextField(blank=True, verbose_name='Notes')),
('created', models.DateTimeField(auto_now_add=True, verbose_name='Création')),
('last_update', models.DateTimeField(auto_now=True, verbose_name='Dernière mise à jour')),
],
options={
'verbose_name': 'raccordement',
'verbose_name_plural': 'raccordements',
'db_table': 'ants_hub_raccordement',
'ordering': ('name',),
},
),
migrations.CreateModel(
name='RendezVous',
fields=[
(
'uuid',
models.UUIDField(
default=uuid.uuid4,
editable=False,
primary_key=True,
serialize=False,
verbose_name='UUID',
),
),
(
'identifiant_predemande',
ants_hub.data.models.CharField(db_index=True, verbose_name='Identifiant de prédemande'),
),
('date', models.DateTimeField(verbose_name='Date')),
(
'gestion_url',
ants_hub.data.models.URLField(blank=True, verbose_name='URL de gestion des rendez-vous'),
),
(
'annulation_url',
ants_hub.data.models.URLField(
blank=True, verbose_name="URL d'annulation des rendez-vous"
),
),
('created', models.DateTimeField(auto_now_add=True, verbose_name='Création')),
('last_update', models.DateTimeField(auto_now=True, verbose_name='Dernière mise à jour')),
(
'lieu',
models.ForeignKey(
on_delete=django.db.models.deletion.CASCADE,
related_name='rdvs',
to='data.lieu',
verbose_name='Lieu',
),
),
],
options={
'verbose_name': 'rendez-vous',
'verbose_name_plural': 'rendez-vous',
'db_table': 'ants_hub_rendez_vous',
},
),
migrations.AddField(
model_name='collectivite',
name='raccordement',
field=models.ForeignKey(
on_delete=django.db.models.deletion.PROTECT,
related_name='collectivites',
to='data.raccordement',
verbose_name='Raccordement',
),
),
migrations.CreateModel(
name='Plage',
fields=[
(
'id',
models.BigAutoField(
auto_created=True, primary_key=True, serialize=False, verbose_name='ID'
),
),
('date', models.DateField(verbose_name='Date')),
('horaires', ants_hub.data.models.HoraireField(verbose_name='Horaire')),
('duree', models.SmallIntegerField(verbose_name='Durée')),
(
'type_de_rdv',
ants_hub.data.models.TypeDeRdvField(
choices=[(1, 'CNI'), (2, 'PASSPORT'), (3, 'CNI-PASSPORT')],
verbose_name='Type de rendez-vous',
),
),
(
'personnes',
models.SmallIntegerField(
default=1,
validators=[
django.core.validators.MinValueValidator(1),
django.core.validators.MaxValueValidator(4),
],
verbose_name='Nombre de personnes maximum',
),
),
('created', models.DateTimeField(auto_now_add=True, verbose_name='Création')),
('last_update', models.DateTimeField(auto_now=True, verbose_name='Dernière mise à jour')),
(
'lieu',
models.ForeignKey(
on_delete=django.db.models.deletion.CASCADE,
related_name='plages',
to='data.lieu',
verbose_name='Lieu',
),
),
],
options={
'verbose_name': 'plage',
'verbose_name_plural': 'plages',
'db_table': 'ants_hub_plage',
'unique_together': {('type_de_rdv', 'date', 'lieu')},
},
),
migrations.AlterUniqueTogether(
name='collectivite',
unique_together={('raccordement', 'nom'), ('raccordement', 'source_id')},
),
]

View File

431
src/ants_hub/data/models.py Normal file
View File

@ -0,0 +1,431 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import datetime
import hashlib
import secrets
import typing
import uuid
from django import forms
from django.core.exceptions import ValidationError
from django.core.validators import MaxValueValidator, MinValueValidator
from django.db import models
from django.urls import reverse
from django.utils.text import slugify
from django.utils.timezone import is_naive, localtime, make_aware
class CharField(models.TextField):
'''SQL Text column using forms.CharField'''
def formfield(self, **kwargs):
kwargs['widget'] = forms.TextInput
return super().formfield(**kwargs)
class URLField(models.URLField):
'''URLField using a TEXT column for storage'''
def get_internal_type(self):
return 'TextField'
class Horaire(typing.NamedTuple):
start: datetime.time
end: datetime.time
class HoraireList(list):
def __str__(self):
return ','.join(f'{h.start.isoformat()}-{h.end.isoformat()}' for h in self)
def append(self, value):
assert isinstance(value, Horaire)
if self and value.start < self[-1].end:
raise ValueError
super().append(value)
@classmethod
def from_str(cls, value):
try:
terms = value.strip().split(',')
hl = cls()
for term in terms:
start, end = term.split('-', 1)
start = datetime.time.fromisoformat(start)
end = datetime.time.fromisoformat(end)
if end < start:
raise ValueError
hl.append(Horaire(start, end))
return hl
except (ValueError, TypeError):
raise ValueError
class HoraireFormField(forms.CharField):
def to_python(self, value):
if value in self.empty_values:
return None
if isinstance(value, list):
return HoraireList(x if isinstance(x, Horaire) else Horaire(*x) for x in value)
try:
return HoraireList.from_str(value)
except ValueError:
raise ValidationError('Horaires invalides, ex.: 12:00-13:00,14:00-15:00')
class HoraireField(CharField):
def formfield(self, **kwargs):
defaults = {'form_class': HoraireFormField}
defaults.update(**kwargs)
return super().formfield(**defaults)
def get_prep_value(self, value):
return str(value)
def from_db_value(self, value, expression, connection):
return HoraireList.from_str(value)
def to_python(self, value):
if isinstance(value, HoraireList):
return value
if value is None:
return value
if isinstance(value, list):
return HoraireList(Horaire(x) for x in value)
try:
return HoraireList.from_str(value)
except ValueError:
raise ValidationError('Horaires invalides, ex.: 12:00-13:00,14:00-15:00')
class TypeDeRdv(models.IntegerChoices):
CNI = 1, 'CNI'
PASSPORT = 2, 'PASSPORT'
CNI_PASSPORT = 3, 'CNI-PASSPORT'
@classmethod
def from_label(cls, label):
for value, _label in cls.choices:
if label == _label:
return value
raise ValueError(label)
class TypeDeRdvField(models.SmallIntegerField):
def __init__(self, **kwargs):
kwargs['choices'] = TypeDeRdv.choices
super().__init__(**kwargs)
def generate_apikey():
return uuid.uuid4().hex
def make_uuid_from_apikey(apikey):
return uuid.UUID(bytes=hashlib.sha256(apikey.encode()).digest()[:16])
class RaccordementManager(models.Manager):
def get_by_natural_key(self, name):
return self.get(name=name)
def get_by_apikey(self, apikey):
'''Use an hashed version of the apikey for lookup, to prevent timing attacks.'''
apikey = apikey.strip()
guid = make_uuid_from_apikey(apikey)
try:
raccordement = self.get(apikey_digest=guid)
except self.model.DoesNotExist:
return None
if secrets.compare_digest(raccordement.apikey, apikey):
return raccordement
return None
class Raccordement(models.Model):
uuid = models.UUIDField(verbose_name='UUID', default=uuid.uuid4, primary_key=True, editable=False)
name = CharField(verbose_name='Nom', unique=True)
apikey = CharField(
verbose_name='API key',
default=generate_apikey,
unique=True,
help_text='Écrire "NEW" pour en générer une nouvelle.',
)
apikey_digest = models.UUIDField(verbose_name='Condensat de l\'API key', db_index=True, editable=False)
notes = models.TextField(verbose_name="Notes", blank=True)
created = models.DateTimeField(verbose_name='Création', auto_now_add=True)
last_update = models.DateTimeField(verbose_name='Dernière mise à jour', auto_now=True)
objects = RaccordementManager()
def __str__(self):
return f'{self.name}'
def natural_key(self):
return (self.name,)
def clean(self):
if self.apikey.strip() == 'NEW':
self.apikey = generate_apikey()
self.apikey = self.apikey.strip()
if len(self.apikey) < 32:
raise ValidationError('API key doit faire au moins 32 caractères')
def save(self, *args, **kwargs):
self.apikey_digest = make_uuid_from_apikey(self.apikey)
return super().save(*args, **kwargs)
def lock(self):
type(self).objects.filter(pk=self.pk).select_for_update().get()
class Meta:
verbose_name = 'raccordement'
verbose_name_plural = 'raccordements'
ordering = ('name',)
db_table = 'ants_hub_raccordement'
class CollectiviteManager(models.Manager):
def get_by_natural_key(self, source_id, *args):
return self.get(source_id=source_id, raccordement=Raccordement.objects.get_by_natural_key(*args))
class Collectivite(models.Model):
raccordement = models.ForeignKey(
verbose_name='Raccordement', to=Raccordement, related_name='collectivites', on_delete=models.PROTECT
)
nom = CharField(verbose_name='Nom')
source_id = CharField(verbose_name='Identifiant de la collectivité à la source')
url = URLField(verbose_name='URL du portail')
logo_url = URLField(verbose_name='URL du logo', blank=True)
rdv_url = URLField(verbose_name='URL de prise de rendez-vous ', blank=True)
gestion_url = URLField(verbose_name='URL de gestion des rendez-vous', blank=True)
annulation_url = URLField(verbose_name='URL d\'annulation des rendez-vous', blank=True)
created = models.DateTimeField(verbose_name='Création', auto_now_add=True)
last_update = models.DateTimeField(verbose_name='Dernière mise à jour', auto_now=True)
objects = CollectiviteManager()
def __str__(self):
return f'{self.nom}'
def natural_key(self):
return (self.source_id,) + self.raccordement.natural_key()
natural_key.dependencies = ['data.raccordement']
@property
def slug(self):
return slugify(self.nom)
class Meta:
verbose_name = 'collectivité'
verbose_name_plural = 'collectivités'
unique_together = [
['raccordement', 'source_id'],
['raccordement', 'nom'],
]
db_table = 'ants_hub_collectivite'
class LieuManager(models.Manager):
def get_by_natural_key(self, source_id, *args):
return self.get(source_id=source_id, collectivite=Collectivite.objects.get_by_natural_key(*args))
class Lieu(models.Model):
collectivite = models.ForeignKey(
verbose_name='Collectivité', to=Collectivite, related_name='lieux', on_delete=models.PROTECT
)
nom = CharField(verbose_name='Nom')
source_id = CharField(verbose_name='Identifiant du lieu à la source')
numero_rue = CharField(verbose_name='Numéro rue')
code_postal = CharField(verbose_name='Code postal')
ville = CharField(verbose_name='Ville')
longitude = models.FloatField(verbose_name='Longitude')
latitude = models.FloatField(verbose_name='Latitude')
url = URLField(verbose_name='URL du portail', blank=True)
logo_url = URLField(verbose_name='URL du logo', blank=True)
rdv_url = URLField(verbose_name='URL de prise de rendez-vous ', blank=True)
gestion_url = URLField(verbose_name='URL de gestion des rendez-vous', blank=True)
annulation_url = URLField(verbose_name='URL d\'annulation des rendez-vous', blank=True)
created = models.DateTimeField(verbose_name='Création', auto_now_add=True)
last_update = models.DateTimeField(verbose_name='Dernière mise à jour', auto_now=True)
objects = LieuManager()
def __str__(self):
return f'{self.nom} / {self.numero_rue} / {self.ville}'
def natural_key(self):
return (self.source_id,) + self.collectivite.natural_key()
natural_key.dependencies = ['data.collectivite']
@property
def slug(self):
return slugify(self.nom)
def get_rdv_url(self):
return self.rdv_url or self.collectivite.rdv_url or self.url or self.collectivite.url
class Meta:
verbose_name = 'lieu'
verbose_name_plural = 'lieux'
unique_together = [
('collectivite', 'source_id'),
('collectivite', 'nom'),
]
db_table = 'ants_hub_lieu'
class PlageManager(models.Manager):
def get_by_natural_key(self, date, type_de_rdv, *args):
return self.get(date=date, type_de_rdv=type_de_rdv, lieu=Lieu.objects.get_by_natural_key(*args))
class Plage(models.Model):
lieu = models.ForeignKey(verbose_name='Lieu', to=Lieu, related_name='plages', on_delete=models.CASCADE)
date = models.DateField(verbose_name='Date')
horaires = HoraireField(verbose_name='Horaire')
duree = models.SmallIntegerField(verbose_name='Durée')
type_de_rdv = TypeDeRdvField(verbose_name='Type de rendez-vous')
personnes = models.SmallIntegerField(
verbose_name='Nombre de personnes maximum',
default=1,
validators=[MinValueValidator(1), MaxValueValidator(4)],
)
created = models.DateTimeField(verbose_name='Création', auto_now_add=True)
last_update = models.DateTimeField(verbose_name='Dernière mise à jour', auto_now=True)
objects = PlageManager()
def __str__(self):
return f'{self.date.isoformat()} / {self.horaires}'
def natural_key(self):
return (self.date, self.type_de_rdv) + self.lieu.natural_key()
natural_key.dependencies = ['data.lieu']
def _make_rdv_url(self, datetime):
return reverse(
'rdv-redirect',
kwargs={
'collectivite_pk': self.lieu.collectivite.pk,
'collectivite_slug': self.lieu.collectivite.slug,
'lieu_pk': self.lieu.pk,
'lieu_slug': self.lieu.slug,
'date': datetime,
},
)
def available_time_slots(self):
for horaire in self.horaires:
start = datetime.datetime.combine(self.date, horaire.start)
if is_naive(start):
start = make_aware(start)
end = datetime.datetime.combine(self.date, horaire.end)
if is_naive(end):
end = make_aware(end)
start = localtime(start)
end = localtime(end)
while start < end:
yield {
'datetime': start,
'callback_url': self._make_rdv_url(start),
}
start += datetime.timedelta(minutes=self.duree)
class Meta:
verbose_name = 'plage'
verbose_name_plural = 'plages'
unique_together = [
['type_de_rdv', 'date', 'lieu'],
]
db_table = 'ants_hub_plage'
class RendezVousManager(models.Manager):
def get_by_natural_key(self, identifiant_predemande, *args):
return self.get(
identifiant_predemande=identifiant_predemande, lieu=Lieu.objects.get_by_natural_key(*args)
)
class RendezVous(models.Model):
uuid = models.UUIDField(verbose_name='UUID', default=uuid.uuid4, primary_key=True, editable=False)
lieu = models.ForeignKey(verbose_name='Lieu', to=Lieu, related_name='rdvs', on_delete=models.CASCADE)
identifiant_predemande = CharField(verbose_name='Identifiant de prédemande', db_index=True)
date = models.DateTimeField(verbose_name='Date')
gestion_url = URLField(verbose_name='URL de gestion des rendez-vous', blank=True)
annulation_url = URLField(verbose_name='URL d\'annulation des rendez-vous', blank=True)
created = models.DateTimeField(verbose_name='Création', auto_now_add=True)
last_update = models.DateTimeField(verbose_name='Dernière mise à jour', auto_now=True)
objects = RendezVousManager()
def __str__(self):
return f'{self.date} / {self.identifiant_predemande}'
def natural_key(self):
return (self.identifiant_predemande,) + self.lieu.natural_key()
natural_key.dependencies = ['data.lieu']
def make_gestion_url(self):
return reverse(
'gestion-redirect',
kwargs={
'collectivite_pk': self.lieu.collectivite.pk,
'collectivite_slug': self.lieu.collectivite.slug,
'lieu_pk': self.lieu.pk,
'lieu_slug': self.lieu.slug,
'date': self.date,
'rdv_pk': self.pk,
},
)
def get_gestion_url(self):
return (
self.gestion_url
or self.lieu.gestion_url
or self.lieu.collectivite.gestion_url
or self.lieu.rdv_url
or self.lieu.collectivite.rdv_url
or self.lieu.url
or self.lieu.collectivite.url
)
def make_annulation_url(self):
return reverse(
'annulation-redirect',
kwargs={
'collectivite_pk': self.lieu.collectivite.pk,
'collectivite_slug': self.lieu.collectivite.slug,
'lieu_pk': self.lieu.pk,
'lieu_slug': self.lieu.slug,
'date': self.date,
'rdv_pk': self.pk,
},
)
def get_annulation_url(self):
return (
self.annulation_url
or self.lieu.annulation_url
or self.lieu.collectivite.annulation_url
or self.lieu.rdv_url
or self.lieu.collectivite.rdv_url
or self.lieu.url
or self.lieu.collectivite.url
)
class Meta:
verbose_name = 'rendez-vous'
verbose_name_plural = 'rendez-vous'
db_table = 'ants_hub_rendez_vous'

View File

@ -0,0 +1,13 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
msgid ""
msgstr ""
"Project-Id-Version: ants-hub 0.1\n"
"POT-Creation-Date: 2017-03-30 00:47+0200\n"
"PO-Revision-Date: 2023-04-02 22:28+0200\n"
"Last-Translator: Benjamin Dauvergne <bdauvergne@entrouvert.com>\n"
"Language: french\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"Plural-Forms: nplurals=2; plural=(n > 1);\n"

View File

View File

@ -0,0 +1,13 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
from django.core.management.base import BaseCommand
class Command(BaseCommand):
help = 'Create a new apikey'
def add_arguments(self, parser):
parser.add_argument('name')
def handle(self, name, **options):
pass

101
src/ants_hub/settings.py Normal file
View File

@ -0,0 +1,101 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import os
DEBUG = True
ALLOWED_HOSTS = ['*']
# Application definition
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'ants_hub.data',
'ants_hub.api',
]
MIDDLEWARE = [
'django.middleware.security.SecurityMiddleware',
'django.contrib.sessions.middleware.SessionMiddleware',
'django.middleware.common.CommonMiddleware',
'django.middleware.csrf.CsrfViewMiddleware',
'django.contrib.auth.middleware.AuthenticationMiddleware',
'django.contrib.messages.middleware.MessageMiddleware',
'django.middleware.clickjacking.XFrameOptionsMiddleware',
]
ROOT_URLCONF = 'ants_hub.urls'
TEMPLATES = [
{
'BACKEND': 'django.template.backends.django.DjangoTemplates',
'DIRS': [],
'APP_DIRS': True,
'OPTIONS': {
'context_processors': [
'django.template.context_processors.debug',
'django.template.context_processors.request',
'django.contrib.auth.context_processors.auth',
'django.contrib.messages.context_processors.messages',
],
},
},
]
WSGI_APPLICATION = 'ants_hub.wsgi.application'
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': 'db.sqlite3',
}
}
LANGUAGE_CODE = 'fr-fr'
TIME_ZONE = 'Europe/Paris'
USE_I18N = True
USE_L10N = True
USE_TZ = True
STATIC_URL = '/static/'
DEFAULT_AUTO_FIELD = 'django.db.models.BigAutoField'
LOGGING = {
'version': 1,
'disable_existing_loggers': False,
'handlers': {
'stream': {
'level': 'DEBUG',
'class': 'logging.StreamHandler',
'formatter': 'stream',
},
},
'formatters': {
'stream': {
'format': '%(asctime)s %(levelname)s %(name)s: %(message)s',
},
},
'loggers': {
'': {
'handlers': [],
'level': 'DEBUG',
'propagate': True,
},
'ants_hub': {
'handlers': ['stream'],
'level': 'DEBUG',
},
},
}
# ANTS_HUB_X_HUB_RDV_AUTH_TOKEN
ANTS_HUB_X_HUB_RDV_AUTH_TOKEN = None
if 'ANTS_HUB_SETTINGS_FILE' in os.environ:
with open(os.environ['ANTS_HUB_SETTINGS_FILE']) as fd:
exec(fd.read())

56
src/ants_hub/urls.py Normal file
View File

@ -0,0 +1,56 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import datetime
from django.conf import settings
from django.urls import include, path, register_converter
from django.utils.timezone import is_aware
from . import admin, views
class IsoDatetimeConverter:
regex = r'\d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d(Z|\+\d\d:\d\d)'
def to_python(self, value):
dt = datetime.datetime.fromisoformat(value)
if not is_aware(dt):
raise ValueError
return dt
def to_url(self, value):
assert is_aware(value)
return value.isoformat()
register_converter(IsoDatetimeConverter, 'isodatetime')
urlpatterns = [
path('', views.homepage),
path('admin/', admin.site.urls),
path('api/', include('ants_hub.api.urls')),
path(
'rdv/<slug:collectivite_slug>-<int:collectivite_pk>'
'/<slug:lieu_slug>-<int:lieu_pk>/<isodatetime:date>/',
views.rdv_redirect,
name='rdv-redirect',
),
path(
'rdv/<slug:collectivite_slug>-<int:collectivite_pk>'
'/<slug:lieu_slug>-<int:lieu_pk>/<isodatetime:date>/gestion/<slug:rdv_pk>/',
views.gestion_redirect,
name='gestion-redirect',
),
path(
'rdv/<slug:collectivite_slug>-<int:collectivite_pk>'
'/<slug:lieu_slug>-<int:lieu_pk>/<isodatetime:date>/annulation/<slug:rdv_pk>/',
views.annulation_redirect,
name='annulation-redirect',
),
]
if 'mellon' in settings.INSTALLED_APPS:
urlpatterns += [
path('saml/', include('mellon.urls')),
]

30
src/ants_hub/views.py Normal file
View File

@ -0,0 +1,30 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
from django.http import HttpResponseRedirect
from django.shortcuts import get_object_or_404
from ants_hub.data.models import Lieu, RendezVous
def homepage(request):
return HttpResponseRedirect('admin/')
# collectivite_* args are ignored, they are only used for the readibility of the URL
def rdv_redirect(request, *, collectivite_pk, collectivite_slug, lieu_pk, lieu_slug, date):
lieu = get_object_or_404(Lieu.objects.select_related('collectivite'), pk=lieu_pk)
url = lieu.get_rdv_url()
return HttpResponseRedirect(url)
# collectivite_*, lieu_* and date args are ignored, they are only used for the readibility of the URL
def gestion_redirect(request, *, collectivite_pk, collectivite_slug, lieu_pk, lieu_slug, date, rdv_pk):
rendez_vous = get_object_or_404(RendezVous, pk=rdv_pk)
url = rendez_vous.get_gestion_url()
return HttpResponseRedirect(url)
def annulation_redirect(request, *, collectivite_pk, collectivite_slug, lieu_pk, lieu_slug, date, rdv_pk):
rendez_vous = get_object_or_404(RendezVous, pk=rdv_pk)
url = rendez_vous.get_annulation_url()
return HttpResponseRedirect(url)

8
src/ants_hub/wsgi.py Normal file
View File

@ -0,0 +1,8 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import os
from django.core.wsgi import get_wsgi_application
os.environ["DJANGO_SETTINGS_MODULE"] = "ants_hub.settings"
application = get_wsgi_application()

4
test-requirements.txt Normal file
View File

@ -0,0 +1,4 @@
pytest
pytest-cov
pytest-django
django-webtest

0
tests/__init__.py Normal file
View File

0
tests/api/__init__.py Normal file
View File

14
tests/api/test_ants.py Normal file
View File

@ -0,0 +1,14 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import pytest
@pytest.mark.parametrize(
'endpoint', ['getManagedMeetingPoints', 'availableTimeSlots', 'searchApplicationIds']
)
def test_authentication(endpoint, django_app, db, settings):
django_app.get(f'/api/ants/{endpoint}', status=401)
django_app.get(f'/api/ants/{endpoint}', headers={'X-Hub-Rdv-Auth-Token': 'abcd'}, status=401)
settings.ANTS_HUB_X_HUB_RDV_AUTH_TOKEN = 'abcd'
django_app.get(f'/api/ants/{endpoint}', headers={'X-Hub-Rdv-Auth-Token': 'abcd'}, status=(200, 422))

225
tests/api/test_chrono.py Normal file
View File

@ -0,0 +1,225 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
from ants_hub.data.models import Raccordement
def test_ping(django_app, db):
django_app.get('/api/chrono/ping/', status=401)
django_app.set_authorization(('Basic', ('abcd', '')))
django_app.get('/api/chrono/ping/', status=401)
Raccordement.objects.create(name='plateforme', apikey='abcd')
assert django_app.get('/api/chrono/ping/').json == {'err': 0}
def test_rendez_vous_dispomibles(django_app, db):
Raccordement.objects.create(name='plateforme', apikey='abcd')
django_app.set_authorization(('Basic', ('abcd', '')))
assert django_app.get('/api/chrono/rendez-vous-disponibles/').json == {
'err': 0,
'collectivites': [],
}
response = django_app.post_json(
'/api/chrono/rendez-vous-disponibles/',
params={
'collectivites': [
{
'id': 'col1',
'nom': 'Saint-Didier',
'url': 'https://saint-didier.fr/rdv/',
}
]
},
)
assert response.json == {
'err': 0,
'data': {
'collectivites_created': 1,
'collectivites_updated': 0,
'lieux_created': 0,
'lieux_updated': 0,
'plage_created': 0,
'plage_deleted': 0,
'rdv_created': 0,
'rdv_deleted': 0,
},
}
response = django_app.post_json(
'/api/chrono/rendez-vous-disponibles/',
params={
'collectivites': [
{
'id': 'col1',
'lieux': [
{
'id': 'lieu1',
'nom': 'Mairie de Saint-Didier',
'numero_rue': '2 rue du four',
'code_postal': '99999',
'ville': 'Saint-Didier',
'longitude': 1.5,
'latitude': 2.3,
}
],
}
]
},
)
assert response.json == {
'err': 0,
'data': {
'collectivites_created': 0,
'collectivites_updated': 0,
'lieux_created': 1,
'lieux_updated': 0,
'plage_created': 0,
'plage_deleted': 0,
'rdv_created': 0,
'rdv_deleted': 0,
},
}
response = django_app.post_json(
'/api/chrono/rendez-vous-disponibles/',
params={
'collectivites': [
{
'id': 'col1',
'lieux': [
{
'id': 'lieu1',
'plages': [
{
'date': '2023-03-20',
'types_rdv': ['CNI', 'PASSPORT'],
'heure_debut': '08:00+02:00',
'heure_fin': '12:00+02:00',
'duree': 15,
'personnes': 1,
}
],
}
],
}
]
},
)
assert response.json == {
'err': 0,
'data': {
'collectivites_created': 0,
'collectivites_updated': 0,
'lieux_created': 0,
'lieux_updated': 0,
'plage_created': 2,
'plage_deleted': 0,
'rdv_created': 0,
'rdv_deleted': 0,
},
}
response = django_app.post_json(
'/api/chrono/rendez-vous-disponibles/',
params={
'collectivites': [
{
'id': 'col1',
'lieux': [
{
'id': 'lieu1',
'plages': [
{
'date': '2023-03-20',
'types_rdv': ['PASSPORT'],
}
],
}
],
}
]
},
)
assert response.json == {
'err': 0,
'data': {
'collectivites_created': 0,
'collectivites_updated': 0,
'lieux_created': 0,
'lieux_updated': 0,
'plage_created': 0,
'plage_deleted': 1,
'rdv_created': 0,
'rdv_deleted': 0,
},
}
response = django_app.post_json(
'/api/chrono/rendez-vous-disponibles/',
params={
'collectivites': [
{
'id': 'col1',
'lieux': [
{
'id': 'lieu1',
'rdvs': [
{
'id': 'abcd',
'date': '2023-03-20T15:00:00+02:00',
}
],
}
],
}
]
},
)
assert response.json == {
'err': 0,
'data': {
'collectivites_created': 0,
'collectivites_updated': 0,
'lieux_created': 0,
'lieux_updated': 0,
'plage_created': 0,
'plage_deleted': 0,
'rdv_created': 1,
'rdv_deleted': 0,
},
}
response = django_app.post_json(
'/api/chrono/rendez-vous-disponibles/',
params={
'collectivites': [
{
'id': 'col1',
'lieux': [
{
'id': 'lieu1',
'rdvs': [
{
'id': 'abcd',
'date': '2023-03-20T15:00:00+02:00',
'annule': True,
}
],
}
],
}
]
},
)
assert response.json == {
'err': 0,
'data': {
'collectivites_created': 0,
'collectivites_updated': 0,
'lieux_created': 0,
'lieux_updated': 0,
'plage_created': 0,
'plage_deleted': 0,
'rdv_created': 0,
'rdv_deleted': 1,
},
}

1
tests/conftest.py Normal file
View File

@ -0,0 +1 @@
# ANTS-Hub - Copyright (C) Entr'ouvert

3
tests/settings.py Normal file
View File

@ -0,0 +1,3 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
SECRET_KEY = 'abcd'

5
tests/test_admin.py Normal file
View File

@ -0,0 +1,5 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
def test_dummy():
pass

1
tests/test_commands.py Normal file
View File

@ -0,0 +1 @@
# ANTS-Hub - Copyright (C) Entr'ouvert

30
tests/test_misc.py Normal file
View File

@ -0,0 +1,30 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
import datetime
import re
import zoneinfo
import pytest
from ants_hub.urls import IsoDatetimeConverter
@pytest.mark.parametrize(
'value,datetime',
[
(
'2023-03-03T10:00:00+01:00',
datetime.datetime(2023, 3, 3, 10, 0, tzinfo=zoneinfo.ZoneInfo('Europe/Paris')),
),
(
'2023-03-03T10:00:00+00:00',
datetime.datetime(2023, 3, 3, 11, 0, tzinfo=zoneinfo.ZoneInfo('Europe/Paris')),
),
],
)
def test_iso_datetime_converter(value, datetime):
converter = IsoDatetimeConverter()
assert re.match(converter.regex, value)
parsed = converter.to_python(value)
assert parsed == datetime
assert converter.to_url(datetime.astimezone(parsed.tzinfo)) == value

8
tests/test_models.py Normal file
View File

@ -0,0 +1,8 @@
# ANTS-Hub - Copyright (C) Entr'ouvert
from ants_hub.data.models import Raccordement
def test_raccordement(db):
apikey = Raccordement.objects.create(name='Example')
assert len(apikey.apikey) >= 32

95
tox.ini Normal file
View File

@ -0,0 +1,95 @@
[tox]
toxworkdir = {env:TMPDIR:/tmp}/tox-{env:USER}/ants-hub/
envlist =
py3-dj32
code-style
check-migrations
[tox:jenkins]
envlist =
pylint
code-style
check-migrations
update-locales
py3-dj32
[testenv]
usedevelop=true
setenv =
DJANGO_SETTINGS_MODULE=ants_hub.settings
ANTS_HUB_SETTINGS_FILE=tests/settings.py
JUNIT={tty::-o junit_suite_name={envname} --junit-xml=junit-{envname}.xml}
COVERAGE={tty::--junitxml=test_{envname}_results.xml --cov-report xml --cov-report html --cov=src/ants_hub/ --cov-config .coveragerc}
deps =
dj32: django>=3.2,<3.3
-r test-requirements.txt
commands =
python setup.py compile_translations
py.test {posargs:{env:COVERAGE:} {env:JUNIT:} tests/}
[testenv:manage]
usedevelop = True
setenv =
DJANGO_SETTINGS_MODULE=ants_hub.settings
ANTS_HUB_SETTINGS_FILE=fixtures/settings.py
deps =
django-debug-toolbar
ipython
ipdb
commands =
manage.py {posargs:--help}
[testenv:update-locales]
usedevelop = True
setenv =
DJANGO_SETTINGS_MODULE=ants_hub.settings
ANTS_HUB_SETTINGS_FILE=tests/settings.py
deps =
commands =
manage.py makemessages -l fr -i tests
manage.py compilemessages
[testenv:pylint]
basepython = python3
setenv =
DJANGO_SETTINGS_MODULE=ants_hub.settings
ANTS_HUB_SETTINGS_FILE=tests/settings.py
env_bin_dir = scripts
deps =
pylint
pylint-django
-r test-requirements.txt
commands =
{toxinidir}/scripts/pylint.sh src/ants_hub/ tests/
[testenv:code-style]
skip_install = true
deps =
pre-commit
commands =
pre-commit run --all-files --show-diff-on-failure
[testenv:check-migrations]
basepython = python3
usedevelop = True
setenv =
DJANGO_SETTINGS_MODULE=ants_hub.settings
ANTS_HUB_SETTINGS_FILE=fixtures/settings.py
commands =
{toxinidir}/scripts/check-migrations.sh
[testenv:runserver]
usedevelop = True
setenv =
DJANGO_SETTINGS_MODULE=ants_hub.settings
ANTS_HUB_SETTINGS_FILE=fixtures/settings.py
deps =
django-debug-toolbar
commands =
manage.py migrate
manage.py loaddata fixtures/admin.json
manage.py loaddata fixtures/example1.json
manage.py runserver {posargs:9000}
[pytest]
filterwarnings = error