aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--.dockerignore25
-rw-r--r--.editorconfig12
-rw-r--r--.env.example14
-rw-r--r--.gitignore152
-rw-r--r--Dockerfile40
-rw-r--r--LICENSE674
-rw-r--r--README.md217
-rw-r--r--config.py43
-rw-r--r--database/db.py12
-rw-r--r--database/models.py92
-rw-r--r--docker-compose.yml31
-rw-r--r--entrypoint.sh21
-rw-r--r--main.py24
-rw-r--r--requirements.dev.txt36
-rw-r--r--requirements.txt23
-rw-r--r--routes/auth.py57
-rw-r--r--routes/heroes.py433
-rw-r--r--routes/users.py186
-rw-r--r--test/heroes.delete.http6
-rw-r--r--test/heroes.get.http6
-rw-r--r--test/heroes.post.http167
-rw-r--r--test/test.py10
-rw-r--r--test/users.post.http45
-rw-r--r--utils/decorators.py22
-rw-r--r--utils/errors.py155
-rw-r--r--wsgi.py7
26 files changed, 2510 insertions, 0 deletions
diff --git a/.dockerignore b/.dockerignore
new file mode 100644
index 0000000..9dfe948
--- /dev/null
+++ b/.dockerignore
@@ -0,0 +1,25 @@
+__pycache__
+*.pyc
+*.pyo
+*.pyd
+*.env
+*.aws
+*.ssh
+.Python
+env/
+venv/
+pip-log.txt
+pip-delete-this-directory.txt
+.tox
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.log
+.git
+.mypy_cache
+.pytest_cache
+*.md
+.dockerignore
diff --git a/.editorconfig b/.editorconfig
new file mode 100644
index 0000000..ad1b622
--- /dev/null
+++ b/.editorconfig
@@ -0,0 +1,12 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.py]
+indent_style = space
+indent_size = 4
diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..9f584f6
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,14 @@
+# APP
+API_DEBUG=False
+DB_NAME=heroes # changeme
+DB_HOST=127.0.0.1
+DB_PORT=27017
+DB_USER=root
+DB_PASS=example # changeme
+DB_AUTH=admin # changeme
+JWT_SECRET_KEY=eo7aiHie4aeth4eteeho7ahC7yeetohsi7a # changeme
+USER_ENABLE_REGISTER=True # changeme
+
+# GUNICORN
+GUNICORN_TIMEOUT=30
+GUNICORN_NUM_WORKERS=4
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..c8b59c8
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,152 @@
+### Flask ###
+instance/*
+!instance/.gitignore
+.webassets-cache
+.env
+
+### Flask.Python Stack ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+# Usually these files are written by a python script from a template
+# before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+# For a library or package, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+# However, in case of collaboration, if having platform-specific dependencies or dependencies
+# having no cross-platform support, pipenv may install dependencies that don't work, or not
+# install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+# This is especially recommended for binary packages to ensure reproducibility, and is more
+# commonly ignored for libraries.
+# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+*.bak
diff --git a/Dockerfile b/Dockerfile
new file mode 100644
index 0000000..66377f9
--- /dev/null
+++ b/Dockerfile
@@ -0,0 +1,40 @@
+FROM python:3-alpine AS base
+LABEL MAINTAINER="heckyel@riseup.net"
+
+FROM base AS builder
+
+ENV LANG C.UTF-8
+ENV LC_ALL C.UTF-8
+
+RUN apk add --no-cache musl-dev build-base make gcc g++ libffi-dev
+ARG APP_DIR="/srv/app"
+
+RUN mkdir --parents "$APP_DIR"
+
+WORKDIR "$APP_DIR"
+
+COPY database /srv/app
+COPY routes /srv/app
+COPY utils /srv/app
+COPY config.py /srv/app
+COPY main.py /srv/app
+COPY wsgi.py /srv/app
+COPY requirements.txt /srv/app
+
+RUN pip install --no-cache-dir --upgrade pip
+RUN pip install --no-cache-dir --prefix=/install wheel gunicorn
+RUN pip install --no-cache-dir --prefix=/install -r requirements.txt
+
+FROM base
+
+WORKDIR /srv/app
+
+COPY --from=builder /install /usr/local
+COPY --from=builder /srv/app /srv/app
+
+EXPOSE 5000
+
+COPY entrypoint.sh /
+RUN chmod u+x /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..94a9ed0
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,674 @@
+ GNU GENERAL PUBLIC LICENSE
+ Version 3, 29 June 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 General Public License is a free, copyleft license for
+software and other kinds of works.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+the GNU General Public License is 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. We, the Free Software Foundation, use the
+GNU General Public License for most of our software; it applies also to
+any other work released this way by its authors. You can apply it to
+your programs, too.
+
+ 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.
+
+ To protect your rights, we need to prevent others from denying you
+these rights or asking you to surrender the rights. Therefore, you have
+certain responsibilities if you distribute copies of the software, or if
+you modify it: responsibilities to respect the freedom of others.
+
+ For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must pass on to the recipients the same
+freedoms that you received. You must make sure that they, too, receive
+or can get the source code. And you must show them these terms so they
+know their rights.
+
+ Developers that use the GNU GPL protect your rights with two steps:
+(1) assert copyright on the software, and (2) offer you this License
+giving you legal permission to copy, distribute and/or modify it.
+
+ For the developers' and authors' protection, the GPL clearly explains
+that there is no warranty for this free software. For both users' and
+authors' sake, the GPL requires that modified versions be marked as
+changed, so that their problems will not be attributed erroneously to
+authors of previous versions.
+
+ Some devices are designed to deny users access to install or run
+modified versions of the software inside them, although the manufacturer
+can do so. This is fundamentally incompatible with the aim of
+protecting users' freedom to change the software. The systematic
+pattern of such abuse occurs in the area of products for individuals to
+use, which is precisely where it is most unacceptable. Therefore, we
+have designed this version of the GPL to prohibit the practice for those
+products. If such problems arise substantially in other domains, we
+stand ready to extend this provision to those domains in future versions
+of the GPL, as needed to protect the freedom of users.
+
+ Finally, every program is threatened constantly by software patents.
+States should not allow patents to restrict development and use of
+software on general-purpose computers, but in those that do, we wish to
+avoid the special danger that patents applied to a free program could
+make it effectively proprietary. To prevent this, the GPL assures that
+patents cannot be used to render the program non-free.
+
+ 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 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. Use with the GNU Affero General Public License.
+
+ 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 Affero 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 special requirements of the GNU Affero General Public License,
+section 13, concerning interaction through a network will apply to the
+combination as such.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU 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 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 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 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 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 General Public License for more details.
+
+ You should have received a copy of the GNU 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 the program does terminal interaction, make it output a short
+notice like this when it starts in an interactive mode:
+
+ <program> Copyright (C) <year> <name of author>
+ This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+ This is free software, and you are welcome to redistribute it
+ under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License. Of course, your program's commands
+might be different; for a GUI interface, you would use an "about box".
+
+ 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 GPL, see
+<http://www.gnu.org/licenses/>.
+
+ The GNU General Public License does not permit incorporating your program
+into proprietary programs. If your program is a subroutine library, you
+may consider it more useful to permit linking proprietary applications with
+the library. If this is what you want to do, use the GNU Lesser General
+Public License instead of this License. But first, please read
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0bb5bc9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,217 @@
+# HEROES API
+
+Make your Heroes API
+
+## Installation
+
+### Standar installation
+
+heroeapi require of **python packages** and **MongoDB** for work.
+
+After running your **MongoDB** set configuration:
+
+Write `.env` file:
+
+```sh
+API_DEBUG=False
+DB_NAME=heroes # changeme
+DB_HOST=127.0.0.1
+DB_PORT=27017
+DB_USER=root # changeme
+DB_PASS=example # changeme
+DB_AUTH=admin
+JWT_SECRET_KEY=eo7aiHie4aeth4eteeho7ahC7yeetohsi7a # changeme
+USER_ENABLE_REGISTER=True
+```
+
+```console
+$ git clone https://c.hgit.ga/software/heroeapi.git
+```
+
+```console
+$ virtualenv -p python3 venv
+```
+
+```console
+$ pip install -r requirements.txt
+```
+
+```console
+$ python wsgi.py
+```
+
+### Docker Compose
+
+Set configuration file `.env` on **heroeapi app** and `.db.env` **mongo database**
+
+Write `.env`:
+
+```sh
+# APP
+API_DEBUG=False
+DB_NAME=heroes # changeme
+DB_HOST=127.0.0.1
+DB_PORT=27017
+DB_USER=root
+DB_PASS=example # changeme
+DB_AUTH=admin
+JWT_SECRET_KEY=eo7aiHie4aeth4eteeho7ahC7yeetohsi7a # changeme
+USER_ENABLE_REGISTER=True
+
+# GUNICORN
+GUNICORN_TIMEOUT=30
+GUNICORN_NUM_WORKERS=4
+```
+
+Write `.db.env`:
+
+```sh
+MONGO_INITDB_ROOT_USERNAME=root # changeme
+MONGO_INITDB_ROOT_PASSWORD=example # changeme
+MONGO_INITDB_DATABASE=admin
+```
+
+Write `docker-compose.yml`:
+
+```yaml
+version: '3'
+
+services:
+ app:
+ image: rusian/heroeapi
+ container_name: heroeapi
+ env_file: .env
+ networks:
+ - heroeapi
+ ports:
+ - "5000:5000"
+ tty: true
+ restart: "always"
+
+ mongo:
+ image: mongo:4.4.12-focal
+ container_name: heroeapi_db
+ restart: always
+ command: [--auth]
+ env_file:
+ - .db.env
+ networks:
+ - heroeapi
+ volumes:
+ - ./heroeapi_db:/data/db
+ ports:
+ - "27017:27017"
+
+networks:
+ default:
+ name: heroeapi
+```
+
+```console
+$ docker-compose up -d
+```
+
+### Generate image from build
+
+```console
+$ docker build --tag rusian/heroesapi -f Dockerfile .
+```
+
+## Usage
+
+Check `test` directory for some examples.
+Remember that you must first create the **user** to be able to add a **Hero**
+
+## API References
+
+#### Heroes
+
+| Reference | Method | Purpose |
+|--------------------------------|--------|----------------------------------------------------------------------------|
+| /api/v1/heroes | GET | Returns all information of the character. |
+| /api/v1/heroes/:id | GET | Search by character id. Returns all information of the character. |
+| /api/v1/heroes/:id | POST | Add of information of the character (only Admin) |
+| /api/v1/heroes/:id | DELETE | Delete character by id (only Admin) |
+| /api/v1/heroes/:id | PUT | Update character by id (only Admin) |
+| /api/v1/heroes/:id/powerstats | GET | Returns JSON Array of all powerstats of given character. |
+| /api/v1/heroes/:id/biography | GET | Returns JSON Array of character's biography. |
+| /api/v1/heroes/:id/appearance | GET | Returns JSON Array of character's appearance. |
+| /api/v1/heroes/:id/work | GET | Returns JSON Array of character's work i.e. occupation and operation base. |
+| /api/v1/heroes/:id/connections | GET | Returns JSON Array of character's connections. |
+| /api/v1/heroes/:id/image | GET | Returns image url of the character. |
+| /api/v1/heroes/search/name | GET | Search character by name. Returns character id. |
+
+
+###### /api/v1/heroes/id/powerstats
+
+This API call provides all powerstats for the given character. The powerstats are as follows:
+
+- Intelligence
+- Strength
+- Speed
+- Durability
+- Power
+- Combat
+
+###### /api/v1/heroes/id/biography
+
+This API call gives the biographical stats of the character. They are:
+
+- Full Name
+- Alter Egos
+- Aliases
+- Place of Birth
+- First Appearance
+- Publisher
+- Alignment
+
+###### /api/v1/heroes/id/appearance
+
+This API call provides the appearance of the character. The various statistics are :
+
+- Gender
+- Race
+- Height
+- Weight
+- Eye Color
+- Hair Color
+
+###### /api/v1/heroes/id/work
+
+This API lists the work/occupation of the character. They are:
+
+- Occupation
+- Base of operation
+
+###### /api/v1/heroes/id/connections
+
+This call lists out the connections of the character.
+
+- Group Affiliation
+- Relatives
+
+###### /api/v1/heroes/id/image
+
+This provides the image for the character, if exists.
+
+- image
+
+###### /api/v1/heroes/search/name
+
+This API call helps you in finding the character-id of a character by searching it's name.
+
+#### Users
+
+| Reference | Method | Purpose |
+|---------------------|--------|-----------------------------------------------|
+| /api/v1/users | GET | Returns all information of users (only Admin) |
+| /api/v1/users/:id | GET | Search by character id (only Admin) |
+| /api/v1/users/:id | POST | Add of information of the user (only Admin) |
+| /api/v1/users/:id | DELETE | Delete user by id (only Admin) |
+| /api/v1/users/:id | PUT | Update user by id (only Admin) |
+| /api/v1/auth/signup | POST | Create user |
+| /api/v1/auth/token | POST | Generate Token |
+
+## LICENSE
+
+This work is licensed under the [GNU GPLv3+](LICENSE)
diff --git a/config.py b/config.py
new file mode 100644
index 0000000..8c6c1e0
--- /dev/null
+++ b/config.py
@@ -0,0 +1,43 @@
+"""
+Config
+"""
+from os import getenv
+from os.path import (
+ join,
+ dirname
+)
+from dotenv import load_dotenv
+
+dotenv_path = join(dirname(__file__), '.env')
+load_dotenv(dotenv_path)
+
+
+class DevelopmentConfig():
+ DEBUG = getenv("API_DEBUG")
+ HOST = getenv("DB_HOST")
+ PORT = getenv("DB_PORT")
+ NAME = getenv("DB_NAME")
+ USER = getenv("DB_USER")
+ PASS = getenv("DB_PASS")
+ AUTH = getenv("DB_AUTH")
+ MONGODB_SETTINGS = {
+ 'host': (f"mongodb://{USER}:{PASS}@{HOST}:{PORT}/"
+ f"{NAME}?authSource={AUTH}")
+ }
+ JWT_SECRET_KEY = getenv("JWT_SECRET_KEY")
+
+
+settings = {
+ 'development': DevelopmentConfig
+}
+
+
+# Simple, enable/disable user register
+if getenv("USER_ENABLE_REGISTER") == "False":
+ check_register = False
+elif getenv("USER_ENABLE_REGISTER") == "True":
+ check_register = True
+else:
+ ex = getenv("USER_ENABLE_REGISTER")
+ raise ValueError(f"Invalid environment USER_ENABLE_REGISTER={ex}. "
+ f"Please set False or True")
diff --git a/database/db.py b/database/db.py
new file mode 100644
index 0000000..ec8c146
--- /dev/null
+++ b/database/db.py
@@ -0,0 +1,12 @@
+"""
+Database
+"""
+# from flask_pymongo import PyMongo
+# mongo = PyMongo()
+
+from flask_mongoengine import MongoEngine
+db = MongoEngine()
+
+
+def initialize_db(app):
+ db.init_app(app)
diff --git a/database/models.py b/database/models.py
new file mode 100644
index 0000000..fe87e18
--- /dev/null
+++ b/database/models.py
@@ -0,0 +1,92 @@
+"""
+Models
+"""
+import mongoengine_goodjson as gj
+from mongoengine.fields import (
+ EmailField,
+ ListField,
+ StringField,
+ URLField
+)
+from mongoengine import (
+ BooleanField,
+ EmbeddedDocument,
+ EmbeddedDocumentField,
+ ReferenceField,
+ CASCADE,
+ PULL
+)
+from werkzeug.security import (
+ generate_password_hash,
+ check_password_hash
+)
+
+
+class PowerstatsModel(EmbeddedDocument):
+ intelligence = StringField(required=True, max_length=3)
+ strength = StringField(required=True, max_length=3)
+ speed = StringField(required=True, max_length=3)
+ durability = StringField(required=True, max_length=3)
+ power = StringField(required=True, max_length=3)
+ combat = StringField(required=True, max_length=3)
+
+
+class BiographyModel(EmbeddedDocument):
+ fullname = StringField(required=True, unique=True, max_length=100)
+ alteregos = StringField(required=True, max_length=100)
+ aliases = ListField(required=True, max_length=100)
+ placeofbirth = StringField(required=True, max_length=100)
+ firstappearance = StringField(required=True, max_length=100)
+ publisher = StringField(required=True, max_length=50)
+ alignment = StringField(required=True, max_length=10)
+
+
+class AppearanceModel(EmbeddedDocument):
+ gender = StringField(required=True, max_length=10)
+ race = StringField(required=True, max_length=20)
+ height = ListField(required=True, max_length=30)
+ weight = ListField(required=True, max_length=30)
+ eyecolor = StringField(required=True, max_length=20)
+ haircolor = StringField(required=True, max_length=20)
+
+
+class WorkModel(EmbeddedDocument):
+ occupation = StringField(required=True, max_length=100)
+ base = StringField(required=True, max_length=100)
+
+
+class ConnectionModel(EmbeddedDocument):
+ groupaffiliation = StringField(required=True, max_length=255)
+ relatives = StringField(required=True, max_length=255)
+
+
+class ImageModel(EmbeddedDocument):
+ url = URLField(required=True, max_length=255)
+
+
+class HeroeModel(gj.Document):
+ name = StringField(required=True, max_length=50)
+ powerstats = EmbeddedDocumentField(PowerstatsModel, required=True)
+ biography = EmbeddedDocumentField(BiographyModel, required=True)
+ appearance = EmbeddedDocumentField(AppearanceModel, required=True)
+ work = EmbeddedDocumentField(WorkModel, required=True)
+ connections = EmbeddedDocumentField(ConnectionModel, required=True)
+ image = EmbeddedDocumentField(ImageModel, required=True)
+ added_by = ReferenceField('UserModel')
+
+
+class UserModel(gj.Document):
+ username = StringField(required=True, unique=True, max_length=50)
+ email = EmailField(required=True, unique=True, max_length=50)
+ password = StringField(required=True)
+ admin = BooleanField(required=True)
+ heroes = ListField(ReferenceField('HeroeModel', reverse_delete_rule=PULL))
+
+ def hash_password(self):
+ self.password = generate_password_hash(self.password).decode('utf8')
+
+ def check_password(self, password):
+ return check_password_hash(self.password, password)
+
+
+UserModel.register_delete_rule(HeroeModel, 'added_by', CASCADE)
diff --git a/docker-compose.yml b/docker-compose.yml
new file mode 100644
index 0000000..c788f43
--- /dev/null
+++ b/docker-compose.yml
@@ -0,0 +1,31 @@
+version: '3'
+
+services:
+ app:
+ image: rusian/heroeapi
+ container_name: heroeapi
+ env_file: .env
+ networks:
+ - heroeapi
+ ports:
+ - "5000:5000"
+ tty: true
+ restart: "always"
+
+ mongo:
+ image: mongo:4.4.12-focal
+ container_name: heroeapi_db
+ restart: always
+ command: [--auth]
+ env_file:
+ - .db.env
+ networks:
+ - heroeapi
+ volumes:
+ - ./heroeapi_db:/data/db
+ ports:
+ - "27017:27017"
+
+networks:
+ default:
+ name: heroeapi
diff --git a/entrypoint.sh b/entrypoint.sh
new file mode 100644
index 0000000..5a12698
--- /dev/null
+++ b/entrypoint.sh
@@ -0,0 +1,21 @@
+#!/usr/bin/env sh
+
+if [ ! -f "/srv/app/.env" ]; then
+ cat > /srv/app/.env <<- EOF
+API_DEBUG=${API_DBUG:-False}
+DB_NAME=${DB_NAME:-heroes}
+DB_HOST=${DB_HOST:-127.0.0.1}
+DB_PORT=${DB_PORT:-27017}
+DB_USER=${DB_USER:-root}
+DB_PASS=${DB_PASS:-example}
+DB_AUTH=${DB_AUTH:-admin}
+JWT_SECRET_KEY=${JWT_SECRET_KEY:-eo7aiHie4aeth4eteeho7ahC7yeetohsi7a}
+USER_ENABLE_REGISTER=${USER_ENABLE_REGISTER:-True}
+GUNICORN_TIMEOUT=${GUNICORN_TIMEOUT:-30}
+GUNICORN_NUM_WORKERS=${GUNICORN_NUM_WORKERS:-4}
+EOF
+fi
+
+cd /srv/app || exit
+
+exec gunicorn -b "0.0.0.0:5000" --timeout "${GUNICORN_TIMEOUT:-30}" --workers "${GUNICORN_NUM_WORKERS:-4}" wsgi:app
diff --git a/main.py b/main.py
new file mode 100644
index 0000000..a313cac
--- /dev/null
+++ b/main.py
@@ -0,0 +1,24 @@
+"""
+Provides heroes API
+"""
+from flask import Flask
+from flask_jwt_extended import JWTManager
+from config import settings
+from database.db import initialize_db
+from routes.heroes import heroes
+from routes.users import users
+from routes.auth import auth
+
+
+app = Flask(__name__)
+app.config.from_object(settings['development'])
+app.register_blueprint(heroes, url_prefix="/api/v1/")
+app.register_blueprint(users, url_prefix="/api/v1/")
+app.register_blueprint(auth, url_prefix="/api/v1/")
+initialize_db(app)
+
+jwt = JWTManager(app)
+
+
+if __name__ == '__main__':
+ app.run()
diff --git a/requirements.dev.txt b/requirements.dev.txt
new file mode 100644
index 0000000..2c0fc85
--- /dev/null
+++ b/requirements.dev.txt
@@ -0,0 +1,36 @@
+astroid==2.9.3
+click==8.0.4
+dateutils==0.6.12
+dnspython==2.2.1
+email-validator==1.1.3
+flake8==4.0.1
+Flask==2.0.3
+Flask-JWT-Extended==4.3.1
+flask-mongoengine==1.0.0
+Flask-PyMongo==2.3.0
+Flask-WTF==1.0.0
+gunicorn==20.1.0
+idna==3.3
+isort==5.10.1
+itsdangerous==2.1.0
+Jinja2==3.0.3
+lazy-object-proxy==1.7.1
+MarkupSafe==2.1.0
+mccabe==0.6.1
+mongoengine==0.24.0
+mongoengine-goodjson==1.1.8
+platformdirs==2.5.1
+pycodestyle==2.8.0
+pyflakes==2.4.0
+PyJWT==2.3.0
+pylint==2.12.2
+pymongo==3.12.3
+python-dateutil==2.8.2
+python-dotenv==0.19.2
+pytz==2021.3
+six==1.16.0
+toml==0.10.2
+typing_extensions==4.1.1
+Werkzeug==2.0.3
+wrapt==1.13.3
+WTForms==3.0.1
diff --git a/requirements.txt b/requirements.txt
new file mode 100644
index 0000000..d78cbf9
--- /dev/null
+++ b/requirements.txt
@@ -0,0 +1,23 @@
+click==8.0.4
+dateutils==0.6.12
+dnspython==2.2.1
+email-validator==1.1.3
+Flask==2.0.3
+Flask-JWT-Extended==4.3.1
+flask-mongoengine==1.0.0
+Flask-PyMongo==2.3.0
+Flask-WTF==1.0.0
+idna==3.3
+itsdangerous==2.1.0
+Jinja2==3.0.3
+MarkupSafe==2.1.0
+mongoengine==0.24.0
+mongoengine-goodjson==1.1.8
+PyJWT==2.3.0
+pymongo==3.12.3
+python-dateutil==2.8.2
+python-dotenv==0.19.2
+pytz==2021.3
+six==1.16.0
+Werkzeug==2.0.3
+WTForms==3.0.1
diff --git a/routes/auth.py b/routes/auth.py
new file mode 100644
index 0000000..bb3798e
--- /dev/null
+++ b/routes/auth.py
@@ -0,0 +1,57 @@
+"""
+Routes - Users
+"""
+import datetime
+import json
+from flask import (
+ Blueprint,
+ Response,
+ request
+)
+from flask_jwt_extended import create_access_token
+from database.models import UserModel
+from mongoengine.errors import (
+ FieldDoesNotExist,
+ NotUniqueError,
+ ValidationError
+)
+from utils.errors import (
+ unauthorized_error,
+ user_already_exists_error,
+ internal_server_error,
+ schema_validation_error
+)
+
+auth = Blueprint("auth", __name__)
+
+
+@auth.route('/auth/token', methods=['POST'])
+def login():
+ """Receive data for login"""
+ try:
+ body = request.get_json()
+ user = UserModel.objects.get(email=body.get('email'))
+ authorized = user.check_password(body.get('password'))
+ if not authorized:
+ raise PermissionError("Check your password or email")
+ expires = datetime.timedelta(days=7)
+ access_token = create_access_token(
+ identity=str(user.id),
+ expires_delta=expires
+ )
+ except PermissionError as e:
+ return unauthorized_error(e)
+ except (FieldDoesNotExist, ValidationError) as e:
+ return schema_validation_error(e)
+ except NotUniqueError as e:
+ return user_already_exists_error(e)
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=json.dumps({
+ "token": access_token
+ }),
+ status=200,
+ mimetype="applications/json"
+ )
diff --git a/routes/heroes.py b/routes/heroes.py
new file mode 100644
index 0000000..9b631a5
--- /dev/null
+++ b/routes/heroes.py
@@ -0,0 +1,433 @@
+"""
+Routes - Heroes
+"""
+import json
+from flask import (
+ Blueprint,
+ Response,
+ request
+)
+from flask_jwt_extended import (
+ jwt_required,
+ get_jwt_identity
+)
+from database.models import (
+ PowerstatsModel,
+ BiographyModel,
+ AppearanceModel,
+ WorkModel,
+ ConnectionModel,
+ ImageModel,
+ HeroeModel,
+ UserModel
+)
+from mongoengine.errors import (
+ FieldDoesNotExist,
+ NotUniqueError,
+ DoesNotExist,
+ ValidationError,
+ InvalidQueryError
+)
+from utils.errors import (
+ heroe_already_exists_error,
+ updating_heroe_error,
+ internal_server_error,
+ schema_validation_error,
+ not_data_found
+)
+from utils.decorators import superuser
+from bson.objectid import ObjectId
+
+heroes = Blueprint("heroes", __name__)
+
+
+@heroes.route('/heroes', methods=['POST'])
+@jwt_required()
+@superuser
+def create_heroe():
+ """Receive data for create heroe"""
+ try:
+ user_id = get_jwt_identity()
+ user = UserModel.objects.get(id=user_id)
+ powerstats = PowerstatsModel(
+ intelligence=request.json['powerstats']['intelligence'],
+ strength=request.json['powerstats']['strength'],
+ speed=request.json['powerstats']['speed'],
+ durability=request.json['powerstats']['durability'],
+ power=request.json['powerstats']['power'],
+ combat=request.json['powerstats']['combat']
+ )
+ biography = BiographyModel(
+ fullname=request.json['biography']['full-name'],
+ alteregos=request.json['biography']['alter-egos'],
+ aliases=request.json['biography']['aliases'],
+ placeofbirth=request.json['biography']['place-of-birth'],
+ firstappearance=request.json['biography']['first-appearance'],
+ publisher=request.json['biography']['publisher'],
+ alignment=request.json['biography']['alignment']
+ )
+ appearance = AppearanceModel(
+ gender=request.json['appearance']['gender'],
+ race=request.json['appearance']['race'],
+ height=request.json['appearance']['height'],
+ weight=request.json['appearance']['weight'],
+ eyecolor=request.json['appearance']['eye-color'],
+ haircolor=request.json['appearance']['hair-color']
+ )
+ work = WorkModel(
+ occupation=request.json['work']['occupation'],
+ base=request.json['work']['base']
+ )
+ connections = ConnectionModel(
+ groupaffiliation=request.json['connections']['group-affiliation'],
+ relatives=request.json['connections']['relatives']
+ )
+ image = ImageModel(
+ url=request.json['image']['url']
+ )
+ heroe = HeroeModel(
+ name=request.json['name'].capitalize(),
+ powerstats=powerstats,
+ biography=biography,
+ appearance=appearance,
+ work=work,
+ connections=connections,
+ image=image,
+ added_by=user
+ ).save()
+ # update user collection
+ user.update(push__heroes=heroe)
+ user.save()
+ except (FieldDoesNotExist, ValidationError) as e:
+ return schema_validation_error(e)
+ except NotUniqueError as e:
+ return heroe_already_exists_error(e)
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ data = {
+ '_id': str(heroe.id),
+ "name": heroe.name,
+ }
+ return Response(
+ response=json.dumps(data),
+ status=201,
+ mimetype="applications/json"
+ )
+
+
+@heroes.route('/heroes', methods=['GET'])
+@jwt_required()
+def get_some_heroes():
+ """Get all heroes"""
+ try:
+ heroe = HeroeModel.objects()
+ if len(heroe) > 0:
+ response = heroe.exclude('added_by').to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response,
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>', methods=['GET'])
+@jwt_required()
+def get_some_heroe(id):
+ """Get heroe by id"""
+ try:
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects(id=id)
+ else:
+ raise DoesNotExist
+ if len(heroe) > 0:
+ data = heroe.exclude('added_by').to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>/powerstats', methods=['GET'])
+@jwt_required()
+def get_powerstats_heroe(id):
+ """Get heroe by id"""
+ try:
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects.get(id=id).powerstats
+ else:
+ raise DoesNotExist
+ if len(heroe) > 0:
+ data = heroe.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>/biography', methods=['GET'])
+@jwt_required()
+def get_biography_heroe(id):
+ """Get heroe by id"""
+ try:
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects.get(id=id).biography
+ else:
+ raise DoesNotExist
+ if len(heroe) > 0:
+ data = heroe.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>/appearance', methods=['GET'])
+@jwt_required()
+def get_appearance_heroe(id):
+ """Get heroe by id"""
+ try:
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects.get(id=id).appearance
+ else:
+ raise DoesNotExist
+ if len(heroe) > 0:
+ data = heroe.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>/work', methods=['GET'])
+@jwt_required()
+def get_work_heroe(id):
+ """Get heroe by id"""
+ try:
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects.get(id=id).work
+ else:
+ raise DoesNotExist
+ if len(heroe) > 0:
+ data = heroe.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>/connections', methods=['GET'])
+@jwt_required()
+def get_connections_heroe(id):
+ """Get heroe by id"""
+ try:
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects.get(id=id).connections
+ else:
+ raise DoesNotExist
+ if len(heroe) > 0:
+ data = heroe.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>/image', methods=['GET'])
+@jwt_required()
+def get_image_heroe(id):
+ """Get heroe by id"""
+ try:
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects.get(id=id).image
+ else:
+ raise DoesNotExist
+ if len(heroe) > 0:
+ data = heroe.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/search/<name>', methods=['GET'])
+@jwt_required()
+def get_some_heroe_name(name):
+ """Search heroe by name"""
+ try:
+ name = name.capitalize()
+ heroe = HeroeModel.objects.filter(name=name)
+ if len(heroe) > 0:
+ data = heroe.exclude('added_by').to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response=(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>', methods=['DELETE'])
+@jwt_required()
+@superuser
+def delete_some_heroe(id):
+ """Delete heroe by id"""
+ try:
+ user_id = get_jwt_identity()
+ if ObjectId.is_valid(id):
+ heroe = HeroeModel.objects.get(id=id, added_by=user_id)
+ heroe.delete()
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ _heroe = str(heroe.id)
+ data = {
+ "msg": f"Heroe: {_heroe}, was deleted"
+ }
+ return Response(
+ response=json.dumps(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@heroes.route('/heroes/<id>', methods=['PUT'])
+@jwt_required()
+@superuser
+def put_heroe(id):
+ """Receive data for update heroe"""
+ try:
+ user_id = get_jwt_identity()
+ heroe = HeroeModel.objects.get(id=id, added_by=user_id)
+ powerstats = PowerstatsModel(
+ intelligence=request.json['powerstats']['intelligence'],
+ strength=request.json['powerstats']['strength'],
+ speed=request.json['powerstats']['speed'],
+ durability=request.json['powerstats']['durability'],
+ power=request.json['powerstats']['power'],
+ combat=request.json['powerstats']['combat']
+ )
+ biography = BiographyModel(
+ fullname=request.json['biography']['full-name'],
+ alteregos=request.json['biography']['alter-egos'],
+ aliases=request.json['biography']['aliases'],
+ placeofbirth=request.json['biography']['place-of-birth'],
+ firstappearance=request.json['biography']['first-appearance'],
+ publisher=request.json['biography']['publisher'],
+ alignment=request.json['biography']['alignment']
+ )
+ appearance = AppearanceModel(
+ gender=request.json['appearance']['gender'],
+ race=request.json['appearance']['race'],
+ height=request.json['appearance']['height'],
+ weight=request.json['appearance']['weight'],
+ eyecolor=request.json['appearance']['eye-color'],
+ haircolor=request.json['appearance']['hair-color']
+ )
+ work = WorkModel(
+ occupation=request.json['work']['occupation'],
+ base=request.json['work']['base']
+ )
+ connections = ConnectionModel(
+ groupaffiliation=request.json['connections']['group-affiliation'],
+ relatives=request.json['connections']['relatives']
+ )
+ image = ImageModel(
+ url=request.json['image']['url']
+ )
+ heroe.update(
+ name=request.json['name'].capitalize(),
+ powerstats=powerstats,
+ biography=biography,
+ appearance=appearance,
+ work=work,
+ connections=connections,
+ image=image
+ )
+ except InvalidQueryError as e:
+ return schema_validation_error(e)
+ except DoesNotExist as e:
+ return updating_heroe_error(e)
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ data = {
+ '_id': str(heroe.id),
+ "name": heroe.name,
+ }
+ return Response(
+ response=json.dumps(data),
+ status=201,
+ mimetype="applications/json"
+ )
diff --git a/routes/users.py b/routes/users.py
new file mode 100644
index 0000000..add310c
--- /dev/null
+++ b/routes/users.py
@@ -0,0 +1,186 @@
+"""
+Routes - Users
+"""
+import json
+from flask import (
+ Blueprint,
+ Response,
+ request
+)
+from flask_jwt_extended import (
+ jwt_required
+)
+from config import check_register
+from database.models import UserModel
+from mongoengine.errors import (
+ FieldDoesNotExist,
+ NotUniqueError,
+ DoesNotExist,
+ ValidationError,
+ InvalidQueryError
+)
+from utils.decorators import superuser
+from utils.errors import (
+ user_already_exists_error,
+ internal_server_error,
+ schema_validation_error,
+ not_data_found,
+ disable_register_error
+)
+from werkzeug.security import generate_password_hash
+from bson.objectid import ObjectId
+
+
+users = Blueprint("users", __name__)
+
+
+@users.route('/auth/signup', methods=['POST'])
+def create_user():
+ """Receive data for create user"""
+ try:
+ if check_register:
+ username = request.json['username'].lower()
+ email = request.json['email']
+ password = generate_password_hash(
+ request.json['password']
+ )
+ admin = request.json["admin"]
+ user = UserModel(
+ username=username,
+ email=email,
+ password=password,
+ admin=admin
+ ).save()
+ else:
+ raise PermissionError("Registration disabled")
+ except PermissionError as e:
+ return disable_register_error(e)
+ except (FieldDoesNotExist, ValidationError) as e:
+ return schema_validation_error(e)
+ except NotUniqueError as e:
+ return user_already_exists_error(e)
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ data = {
+ '_id': str(user.id),
+ "username": user.username,
+ }
+ return Response(
+ response=json.dumps(data),
+ status=201,
+ mimetype="applications/json"
+ )
+
+
+@users.route('/users', methods=['GET'])
+@jwt_required()
+@superuser
+def get_users():
+ """Get all users"""
+ try:
+ response = UserModel.objects()
+ if len(response) > 0:
+ response = response.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response,
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@users.route('/users/<query>', methods=['GET'])
+@jwt_required()
+@superuser
+def get_user(query):
+ """Get all users"""
+ try:
+ if ObjectId.is_valid(query):
+ response = UserModel.objects.get(id=query)
+ else:
+ response = UserModel.objects.filter(username=query)
+ if len(response) > 0:
+ response = response.to_json()
+ else:
+ raise DoesNotExist
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ return Response(
+ response,
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@users.route('/users/<id>', methods=['DELETE'])
+@jwt_required()
+@superuser
+def delete_user(id):
+ """Delete user by id"""
+ try:
+ if ObjectId.is_valid(id):
+ user = UserModel.objects.get(id=id)
+ user.delete()
+ except DoesNotExist:
+ return not_data_found()
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ _user = str(user.id)
+ data = {
+ "msg": f"User: {_user}, was deleted"
+ }
+ return Response(
+ response=json.dumps(data),
+ status=200,
+ mimetype="application/json"
+ )
+
+
+@users.route('/users/<id>', methods=['PUT'])
+@jwt_required()
+@superuser
+def put_user(id):
+ """Receive data for update user"""
+ try:
+ username = request.json['username'].lower()
+ email = request.json['email']
+ password = generate_password_hash(
+ request.json['password']
+ )
+ admin = request.json["admin"]
+
+ if ObjectId.is_valid(id):
+ user = UserModel.objects.get(id=id)
+ user.update(
+ username=username,
+ email=email,
+ password=password,
+ admin=admin
+ )
+ except InvalidQueryError as e:
+ return schema_validation_error(e)
+ except NotUniqueError as e:
+ return user_already_exists_error(e)
+ except Exception as e:
+ return internal_server_error(e)
+ else:
+ _user = str(user.id)
+ data = {
+ "msg": f"User: {_user}, was updated"
+ }
+ return Response(
+ response=json.dumps(data),
+ status=201,
+ mimetype="applications/json"
+ )
diff --git a/test/heroes.delete.http b/test/heroes.delete.http
new file mode 100644
index 0000000..950575d
--- /dev/null
+++ b/test/heroes.delete.http
@@ -0,0 +1,6 @@
+# -*- restclient -*-
+
+DELETE http://localhost:5000/api/v1/heroes/<id>
+Authorization: Bearer <token>
+User-Agent: Emacs27
+Accept-Encoding: compress, gzip, json
diff --git a/test/heroes.get.http b/test/heroes.get.http
new file mode 100644
index 0000000..5026166
--- /dev/null
+++ b/test/heroes.get.http
@@ -0,0 +1,6 @@
+# -*- restclient -*-
+
+GET http://localhost:5000/api/v1/heroes
+Authorization: Bearer <token>
+User-Agent: Emacs27
+Accept-Encoding: compress, gzip, json
diff --git a/test/heroes.post.http b/test/heroes.post.http
new file mode 100644
index 0000000..462516c
--- /dev/null
+++ b/test/heroes.post.http
@@ -0,0 +1,167 @@
+# -*- restclient -*-
+
+#
+# Create Heroes
+#
+
+# Iroman
+POST http://localhost:5000/api/v1/heroes
+Authorization: Bearer <token>
+Content-Type: application/json
+
+{
+ "name": "Ironman",
+ "powerstats": {
+ "intelligence": "100",
+ "strength": "85",
+ "speed": "58",
+ "durability": "85",
+ "power": "100",
+ "combat": "64"
+ },
+ "biography": {
+ "full-name": "Tony Stark",
+ "alter-egos": "No alter egos found.",
+ "aliases": [
+ "Iron Knight",
+ "Hogan Potts",
+ "Spare Parts Man",
+ "Cobalt Man II",
+ "Crimson Dynamo",
+ "Ironman"
+ ],
+ "place-of-birth": "Long Island, New York",
+ "first-appearance": "Tales of Suspence #39 (March, 1963)",
+ "publisher": "Marvel Comics",
+ "alignment": "good"
+ },
+ "appearance": {
+ "gender": "Male",
+ "race": "Human",
+ "height": [
+ "6'6",
+ "198 cm"
+ ],
+ "weight": [
+ "425 lb",
+ "191 kg"
+ ],
+ "eye-color": "Blue",
+ "hair-color": "Black"
+ },
+ "work": {
+ "occupation": "Inventor, Industrialist; former United States Secretary of Defense",
+ "base": "Seattle, Washington"
+ },
+ "connections": {
+ "group-affiliation": "Avengers, Illuminati, Stark Resilient; formerly S.H.I.E.L.D., leader of Stark Enterprises, the Pro-Registration Superhero Unit, New Avengers, Mighty Avengers, Hellfire Club, Force Works, Avengers West Coast, United States Department of Defense.",
+ "relatives": "Howard Anthony Stark (father, deceased), Maria Stark (mother, deceased), Morgan Stark (cousin), Isaac Stark (ancestor)"
+ },
+ "image": {
+ "url": "https://www.superherodb.com/pictures2/portraits/10/100/85.jpg"
+ }
+}
+
+# Zoom
+POST http://localhost:5000/api/v1/heroes
+Authorization: Bearer <token>
+Content-Type: application/json
+{
+ "name": "Zoom",
+ "powerstats": {
+ "intelligence": "50",
+ "strength": "10",
+ "speed": "100",
+ "durability": "28",
+ "power": "100",
+ "combat": "28"
+ },
+ "biography": {
+ "full-name": "Hunter Zolomon",
+ "alter-egos": "No alter egos found.",
+ "aliases": [
+ "-"
+ ],
+ "place-of-birth": "-",
+ "first-appearance": "Flash Secret Files #3",
+ "publisher": "DC Comics",
+ "alignment": "bad"
+ },
+ "appearance": {
+ "gender": "Male",
+ "race": "null",
+ "height": [
+ "6'1",
+ "185 cm"
+ ],
+ "weight": [
+ "181 lb",
+ "81 kg"
+ ],
+ "eye-color": "Red",
+ "hair-color": "Brown"
+ },
+ "work": {
+ "occupation": "-",
+ "base": "Keystone City, Kansas"
+ },
+ "connections": {
+ "group-affiliation": "Secret Society of Super Villains, formerly Keystone Police Department, F.B.I.",
+ "relatives": "Ashley Zolomon (ex-wife)"
+ },
+ "image": {
+ "url": "https://www.superherodb.com/pictures2/portraits/10/100/1384.jpg"
+ }
+}
+
+# A-Bomb
+POST http://localhost:5000/api/v1/heroes
+Authorization: Bearer <token>
+Content-Type: application/json
+{
+ "name": "A-Bomb",
+ "powerstats": {
+ "intelligence": "38",
+ "strength": "100",
+ "speed": "17",
+ "durability": "80",
+ "power": "24",
+ "combat": "64"
+ },
+ "biography": {
+ "full-name": "Richard Milhouse Jones",
+ "alter-egos": "No alter egos found.",
+ "aliases": [
+ "Rick Jones"
+ ],
+ "place-of-birth": "Scarsdale, Arizona",
+ "first-appearance": "Hulk Vol 2 #2 (April, 2008) (as A-Bomb)",
+ "publisher": "Marvel Comics",
+ "alignment": "good"
+ },
+ "appearance": {
+ "gender": "Male",
+ "race": "Human",
+ "height": [
+ "6'8",
+ "203 cm"
+ ],
+ "weight": [
+ "980 lb",
+ "441 kg"
+ ],
+ "eye-color": "Yellow",
+ "hair-color": "No Hair"
+ },
+ "work": {
+ "occupation": "Musician, adventurer, author; formerly talk show host",
+ "base": "-"
+ },
+ "connections": {
+ "group-affiliation": "Hulk Family; Excelsior (sponsor), Avengers (honorary member); formerly partner of the Hulk, Captain America and Captain Marvel; Teen Brigade; ally of Rom",
+ "relatives": "Marlo Chandler-Jones (wife); Polly (aunt); Mrs. Chandler (mother-in-law); Keith Chandler, Ray Chandler, three unidentified others (brothers-in-law); unidentified father (deceased); Jackie Shorr (alleged mother; unconfirmed)"
+ },
+ "image": {
+ "url": "https://www.superherodb.com/pictures2/portraits/10/100/10060.jpg"
+ }
+}
diff --git a/test/test.py b/test/test.py
new file mode 100644
index 0000000..c541803
--- /dev/null
+++ b/test/test.py
@@ -0,0 +1,10 @@
+"""
+Test
+"""
+# import requests
+
+# BASE = "http://127.0.0.1:5000"
+
+# response = requests.post(f"{BASE}/api/v1/heroes")
+
+# print(response.json())
diff --git a/test/users.post.http b/test/users.post.http
new file mode 100644
index 0000000..f9de355
--- /dev/null
+++ b/test/users.post.http
@@ -0,0 +1,45 @@
+# -*- restclient -*-
+
+#
+# Create User for make Heroe
+#
+
+# Register - Admin User
+POST http://localhost:5000/api/v1/auth/signup
+Content-Type: application/json
+
+{
+ "username": "admin",
+ "email": "admin@example.com",
+ "password": "adminpass",
+ "admin": true
+}
+
+# Register - Standar User
+POST http://localhost:5000/api/v1/auth/signup
+Content-Type: application/json
+
+{
+ "username": "user",
+ "email": "user@example.com",
+ "password": "userpass",
+ "admin": false
+}
+
+# Generate Token for User admin
+POST http://localhost:5000/api/v1/auth/token
+Content-Type: application/json
+
+{
+ "email": "admin@example.com",
+ "password": "adminpass"
+}
+
+# Generate Token for User Standar
+POST http://localhost:5000/api/v1/auth/token
+Content-Type: application/json
+
+{
+ "email": "user@example.com",
+ "password": "userpass"
+}
diff --git a/utils/decorators.py b/utils/decorators.py
new file mode 100644
index 0000000..3b12ead
--- /dev/null
+++ b/utils/decorators.py
@@ -0,0 +1,22 @@
+"""
+Decorators
+"""
+# from config import only_get
+from utils.errors import error_method
+from database.models import UserModel
+from flask_jwt_extended import get_jwt_identity
+
+
+def superuser(func):
+ def wrapper(*args, **kwargs):
+ """Check if user is admin"""
+ user_id = get_jwt_identity()
+ user_admin = UserModel.objects(id=user_id, admin=True)
+ if user_admin:
+ return func(*args, **kwargs)
+ else:
+ response = error_method()
+ return response
+
+ wrapper.__name__ = func.__name__
+ return wrapper
diff --git a/utils/errors.py b/utils/errors.py
new file mode 100644
index 0000000..ab6f1d5
--- /dev/null
+++ b/utils/errors.py
@@ -0,0 +1,155 @@
+"""
+Code Errors reference:
+ - https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
+ - https://developer.mozilla.org/es/docs/Web/HTTP/Status
+"""
+import json
+from flask import (
+ Response
+)
+
+
+def internal_server_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Something went wrong",
+ "_desc": str(e)
+ }),
+ status=500,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def schema_validation_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Request is missing required fields",
+ "_desc": str(e)
+ }),
+ status=400,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def unauthorized_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Invalid username or password",
+ "_desc": str(e)
+ }),
+ status=401,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def disable_register_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Unauthorized create user",
+ "_desc": str(e)
+ }),
+ status=401,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def error_method():
+ response = Response(
+ response=json.dumps({
+ "msg": "Method unauthorized for your user"
+ }),
+ status=401,
+ mimetype="applications/json"
+ )
+ return response
+
+
+# Status 204 does not show any msg
+def not_data_found():
+ response = Response(
+ status=204,
+ mimetype="applications/json"
+ )
+ return response
+
+
+# #####
+# Heroe
+# #####
+def heroe_already_exists_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Heroe with given full-name already exists",
+ "_desc": str(e)
+ }),
+ status=400,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def updating_heroe_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Updating heroe added by other is forbidden",
+ "_desc": str(e)
+ }),
+ status=403,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def deleting_heroe_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Deleting heroe added by other is forbidden",
+ "_desc": str(e)
+ }),
+ status=403,
+ mimetype="applications/json"
+ )
+ return response
+
+
+# #####
+# User
+# #####
+def user_already_exists_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "User with given username or email already exists",
+ "_desc": str(e)
+ }),
+ status=400,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def updating_user_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Updating user added by other is forbidden",
+ "_desc": str(e)
+ }),
+ status=403,
+ mimetype="applications/json"
+ )
+ return response
+
+
+def deleting_user_error(e):
+ response = Response(
+ response=json.dumps({
+ "msg": "Deleting user added by other is forbidden",
+ "_desc": str(e)
+ }),
+ status=403,
+ mimetype="applications/json"
+ )
+ return response
diff --git a/wsgi.py b/wsgi.py
new file mode 100644
index 0000000..c7b8cf5
--- /dev/null
+++ b/wsgi.py
@@ -0,0 +1,7 @@
+"""
+wsgi.py
+"""
+from main import app
+
+if __name__ == "__main__":
+ app.run()