diff --git a/.gitignore b/.gitignore index 68bc17f..51e9d59 100644 --- a/.gitignore +++ b/.gitignore @@ -1,160 +1,160 @@ -# 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/ -.webassets-cache - -# 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 - -# pdm -# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. -#pdm.lock -# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it -# in version control. -# https://pdm.fming.dev/#use-with-ide -.pdm.toml - -# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm -__pypackages__/ - -# Celery stuff -celerybeat-schedule -celerybeat.pid - -# SageMath parsed files -*.sage.py - -# Environments -.env -.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/ - -# PyCharm -# JetBrains specific template is maintained in a separate JetBrains.gitignore that can -# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore -# and can be added to the global gitignore or merged into this file. For a more nuclear -# option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ +# 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/ +.webassets-cache + +# 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 + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.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/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ diff --git a/AUTHOR.md b/AUTHOR.md index 45e9c31..99cecbc 100644 --- a/AUTHOR.md +++ b/AUTHOR.md @@ -1,7 +1,7 @@ -# AUTHORS - -David Gregs [udohdavid27@gmail.com](mailto:udohdavid27@gmail.com) - -Otueh Chibueze [Beze4luv@yahoo.com](mailto:Beze4luv@yahoo.com) - -Topman Paul-Dike [topman4loveworld@gmail.com](mailto:topman4loveworld@gmail.com) +# AUTHORS + +David Gregs [udohdavid27@gmail.com](mailto:udohdavid27@gmail.com) + +Otueh Chibueze [Beze4luv@yahoo.com](mailto:Beze4luv@yahoo.com) + +Topman Paul-Dike [topman4loveworld@gmail.com](mailto:topman4loveworld@gmail.com) diff --git a/LICENSE b/LICENSE index f288702..3877ae0 100644 --- a/LICENSE +++ b/LICENSE @@ -1,674 +1,674 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - 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. - - - Copyright (C) - - 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 . - -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: - - Copyright (C) - 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 -. - - 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 -. + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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: + + Copyright (C) + 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 +. + + 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 +. diff --git a/README.md b/README.md index 6e672f1..13b2b66 100644 --- a/README.md +++ b/README.md @@ -1,98 +1,98 @@ -# tradeQuick -*An app that let people within a locality buy/sell used items (ALX portfolio project)* - -**Web URL:** [https://tradequick.vercel.app](https://tradequick.vercel.app) - -![the_landing_page](https://github.com/tpauldike/rough_work/blob/main/designs/tradeQuick-landing-page.jpg) - -## About the project -The web app is a market place for selling used items that someone else might be interested in, the seller uploads certain information such as the photos of it, -description and price and the buyer can either comment on the post or send private message. -**Disclaimer:** -1. Every user's security is in his hands. All users are to deal with people within their locality or close range and meet in public places before paying for -the goods. -3. The risk of purchasing spoilt or bad items is entirely the users. He/she must test the item very well (if possible) before paying for it. -4. It is safer to buy from store owners but any user can sell or buy on the app, so everyone has got to be very careful while dealing with anyone, as we are -not responsible for the outcome of the deal. - -### Features -1. Logo and attractive user interface -2. Contents are available to the public (Read only) -3. No transaction except authenticated -4. User sign up and authentication -5. User account management (viewing, updating and deleting own account) -6. Items management (viewing, uploading, editing and deleting own items, and marking the sold ones as sold) -7. Search for items (public) -8. Social interaction - - Comment on items for sale - - like/dislike items for sale - - Chat privately with the seller -7. Compulsory mobile number verification -8. SMS and email notifications, based on the user's preference. - -### Extras -- Support/help -- Portfolio (about the team) -- About (about the app) -- Contact us - -### Scope -Version 1.0 of the app is designed to be used within Nigeria only - -## Team -**Front End** -- [Topman Paul-Dike](https://github.com/tpauldike) - -**Back End** -- [David Gregs](https://github.com/davidgregs87) -- [Otueh Chibueze](https://github.com/OChibu) - -## Technologies - -### Programming Languages Used -**Front End** -- `HTML` -- `CSS` -- `JavaScript` - -**API** -- `Python` (`Flask`) - -**Database** -- `MySQL` - -### Third Party Services -1. Cloudinary (for photo uploads) -2. Google authentication -3. Facebook authentication -4. Brevo (mailing/SMS services) - -## Usage/Installation -To install and run the app locally or in a development environment, follow the instructions below: -### Front End -```bash -# Clone the git repository -:$ git clone https://github.com/tpauldike/tradeQuick.git - -# Move into the directory -:$ cd tradeQuick - -# Open it with your code editor (VScode for instance) -:$ code . - -# Make sure you have the live server extension installed, then render index.html on your browser -# You may as well change the environment variables in the scripts to that of the local server, you're using. -``` - -> To have the app server and the database-serrver running locally as well , follow the instructions for server installation below: - -### Back End -*(instructions unavailable at the moment...)* - -## Authors -The file [AUTHOR.md](./AUTHOR.md) contains the names of the authors and their email addresses. - -Feel free to contribute to the project, outside contributors from February 2024 and not before then, please. You may refer to [CONTRIBUTION.md](./CONTRIBUTION.md) -to know how to make an acceptable contribution to this project - -###### © 2023 tradeQuick. All rights reserved. +# tradeQuick +*An app that let people within a locality buy/sell used items (ALX portfolio project)* + +**Web URL:** [https://tradequick.vercel.app](https://tradequick.vercel.app) + +![the_landing_page](https://github.com/tpauldike/rough_work/blob/main/designs/tradeQuick-landing-page.jpg) + +## About the project +The web app is a market place for selling used items that someone else might be interested in, the seller uploads certain information such as the photos of it, +description and price and the buyer can either comment on the post or send private message. +**Disclaimer:** +1. Every user's security is in his hands. All users are to deal with people within their locality or close range and meet in public places before paying for +the goods. +3. The risk of purchasing spoilt or bad items is entirely the users. He/she must test the item very well (if possible) before paying for it. +4. It is safer to buy from store owners but any user can sell or buy on the app, so everyone has got to be very careful while dealing with anyone, as we are +not responsible for the outcome of the deal. + +### Features +1. Logo and attractive user interface +2. Contents are available to the public (Read only) +3. No transaction except authenticated +4. User sign up and authentication +5. User account management (viewing, updating and deleting own account) +6. Items management (viewing, uploading, editing and deleting own items, and marking the sold ones as sold) +7. Search for items (public) +8. Social interaction + - Comment on items for sale + - like/dislike items for sale + - Chat privately with the seller +7. Compulsory mobile number verification +8. SMS and email notifications, based on the user's preference. + +### Extras +- Support/help +- Portfolio (about the team) +- About (about the app) +- Contact us + +### Scope +Version 1.0 of the app is designed to be used within Nigeria only + +## Team +**Front End** +- [Topman Paul-Dike](https://github.com/tpauldike) + +**Back End** +- [David Gregs](https://github.com/davidgregs87) +- [Otueh Chibueze](https://github.com/OChibu) + +## Technologies + +### Programming Languages Used +**Front End** +- `HTML` +- `CSS` +- `JavaScript` + +**API** +- `Python` (`Flask`) + +**Database** +- `MySQL` + +### Third Party Services +1. Cloudinary (for photo uploads) +2. Google authentication +3. Facebook authentication +4. Brevo (mailing/SMS services) + +## Usage/Installation +To install and run the app locally or in a development environment, follow the instructions below: +### Front End +```bash +# Clone the git repository +:$ git clone https://github.com/tpauldike/tradeQuick.git + +# Move into the directory +:$ cd tradeQuick + +# Open it with your code editor (VScode for instance) +:$ code . + +# Make sure you have the live server extension installed, then render index.html on your browser +# You may as well change the environment variables in the scripts to that of the local server, you're using. +``` + +> To have the app server and the database-serrver running locally as well , follow the instructions for server installation below: + +### Back End +*(instructions unavailable at the moment...)* + +## Authors +The file [AUTHOR.md](./AUTHOR.md) contains the names of the authors and their email addresses. + +Feel free to contribute to the project, outside contributors from February 2024 and not before then, please. You may refer to [CONTRIBUTION.md](./CONTRIBUTION.md) +to know how to make an acceptable contribution to this project + +###### © 2023 tradeQuick. All rights reserved. diff --git a/client-side/index.html b/client-side/index.html deleted file mode 100644 index 9f5a717..0000000 --- a/client-side/index.html +++ /dev/null @@ -1,74 +0,0 @@ - - - - - - - - - - - - - - - tradeQuick - - -
-
-
- -
-

tradeQuick

-
- -
- -
- -
- -
-
-
-
- -
-

© 2023 tradeQuick. All rights reserved.

-
-
- - - diff --git a/client-side/scripts/index.js b/client-side/scripts/index.js deleted file mode 100644 index 5b9a05f..0000000 --- a/client-side/scripts/index.js +++ /dev/null @@ -1,8 +0,0 @@ -document.addEventListener('DOMContentLoaded', function () { - const mobileMenuToggle = document.getElementById('mobile-menu'); - const navList = document.querySelector('.nav-list'); - - mobileMenuToggle.addEventListener('click', function () { - navList.classList.toggle('show'); - }); - }); \ No newline at end of file diff --git a/client-side/site.webmanifest b/client-side/site.webmanifest deleted file mode 100644 index 45dc8a2..0000000 --- a/client-side/site.webmanifest +++ /dev/null @@ -1 +0,0 @@ -{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"} \ No newline at end of file diff --git a/client-side/android-chrome-192x192.png b/client-side/static/images/android-chrome-192x192.png similarity index 100% rename from client-side/android-chrome-192x192.png rename to client-side/static/images/android-chrome-192x192.png diff --git a/client-side/android-chrome-512x512.png b/client-side/static/images/android-chrome-512x512.png similarity index 100% rename from client-side/android-chrome-512x512.png rename to client-side/static/images/android-chrome-512x512.png diff --git a/client-side/apple-touch-icon.png b/client-side/static/images/apple-touch-icon.png similarity index 100% rename from client-side/apple-touch-icon.png rename to client-side/static/images/apple-touch-icon.png diff --git a/client-side/assets/banner.jpg b/client-side/static/images/banner copy.jpg similarity index 100% rename from client-side/assets/banner.jpg rename to client-side/static/images/banner copy.jpg diff --git a/client-side/static/images/banner.jpg b/client-side/static/images/banner.jpg new file mode 100644 index 0000000..c5a11e2 Binary files /dev/null and b/client-side/static/images/banner.jpg differ diff --git a/client-side/static/images/default copy.png b/client-side/static/images/default copy.png new file mode 100644 index 0000000..b16d29d Binary files /dev/null and b/client-side/static/images/default copy.png differ diff --git a/client-side/static/images/default.png b/client-side/static/images/default.png new file mode 100644 index 0000000..b16d29d Binary files /dev/null and b/client-side/static/images/default.png differ diff --git a/client-side/static/images/dp 1.jpg b/client-side/static/images/dp 1.jpg new file mode 100644 index 0000000..a69b6c0 Binary files /dev/null and b/client-side/static/images/dp 1.jpg differ diff --git a/client-side/static/images/dp 2.jpg b/client-side/static/images/dp 2.jpg new file mode 100644 index 0000000..cc33be7 Binary files /dev/null and b/client-side/static/images/dp 2.jpg differ diff --git a/client-side/static/images/dp 3.jpg b/client-side/static/images/dp 3.jpg new file mode 100644 index 0000000..7b8da2e Binary files /dev/null and b/client-side/static/images/dp 3.jpg differ diff --git a/client-side/favicon-16x16.png b/client-side/static/images/favicon-16x16.png similarity index 100% rename from client-side/favicon-16x16.png rename to client-side/static/images/favicon-16x16.png diff --git a/client-side/favicon-32x32.png b/client-side/static/images/favicon-32x32.png similarity index 100% rename from client-side/favicon-32x32.png rename to client-side/static/images/favicon-32x32.png diff --git a/client-side/favicon.ico b/client-side/static/images/favicon.ico similarity index 100% rename from client-side/favicon.ico rename to client-side/static/images/favicon.ico diff --git a/client-side/static/images/gadget1.jpg b/client-side/static/images/gadget1.jpg new file mode 100644 index 0000000..7075caf Binary files /dev/null and b/client-side/static/images/gadget1.jpg differ diff --git a/client-side/static/images/gadget2.jpg b/client-side/static/images/gadget2.jpg new file mode 100644 index 0000000..a6cd957 Binary files /dev/null and b/client-side/static/images/gadget2.jpg differ diff --git a/client-side/static/images/gadget3.jpg b/client-side/static/images/gadget3.jpg new file mode 100644 index 0000000..1c6d301 Binary files /dev/null and b/client-side/static/images/gadget3.jpg differ diff --git a/client-side/static/images/images (4).jpg b/client-side/static/images/images (4).jpg new file mode 100644 index 0000000..c011066 Binary files /dev/null and b/client-side/static/images/images (4).jpg differ diff --git a/client-side/static/images/images (5).jpg b/client-side/static/images/images (5).jpg new file mode 100644 index 0000000..0e8354d Binary files /dev/null and b/client-side/static/images/images (5).jpg differ diff --git a/client-side/static/images/images.jpg b/client-side/static/images/images.jpg new file mode 100644 index 0000000..fb51dd6 Binary files /dev/null and b/client-side/static/images/images.jpg differ diff --git a/client-side/assets/logo.png b/client-side/static/images/logo.png similarity index 100% rename from client-side/assets/logo.png rename to client-side/static/images/logo.png diff --git a/client-side/tradeQuick_logo.png b/client-side/static/images/logo1.png similarity index 100% rename from client-side/tradeQuick_logo.png rename to client-side/static/images/logo1.png diff --git a/client-side/static/images/photo-1491933382434-500287f9b54b.avif b/client-side/static/images/photo-1491933382434-500287f9b54b.avif new file mode 100644 index 0000000..d383ed3 Binary files /dev/null and b/client-side/static/images/photo-1491933382434-500287f9b54b.avif differ diff --git a/client-side/static/images/photo-1615655406736-b37c4fabf923.avif b/client-side/static/images/photo-1615655406736-b37c4fabf923.avif new file mode 100644 index 0000000..f530831 Binary files /dev/null and b/client-side/static/images/photo-1615655406736-b37c4fabf923.avif differ diff --git a/client-side/assets/search.png b/client-side/static/images/search.png similarity index 100% rename from client-side/assets/search.png rename to client-side/static/images/search.png diff --git a/client-side/static/profile_pics/33696f5f-01fa-486c-b460-aa2b192f4c3e.jpg b/client-side/static/profile_pics/33696f5f-01fa-486c-b460-aa2b192f4c3e.jpg new file mode 100644 index 0000000..75631f9 Binary files /dev/null and b/client-side/static/profile_pics/33696f5f-01fa-486c-b460-aa2b192f4c3e.jpg differ diff --git a/client-side/static/profile_pics/ce58b6f9-fbe8-4e67-b64a-f39f6e49fbda.jpg b/client-side/static/profile_pics/ce58b6f9-fbe8-4e67-b64a-f39f6e49fbda.jpg new file mode 100644 index 0000000..75631f9 Binary files /dev/null and b/client-side/static/profile_pics/ce58b6f9-fbe8-4e67-b64a-f39f6e49fbda.jpg differ diff --git a/client-side/static/scripts/login.js b/client-side/static/scripts/login.js new file mode 100644 index 0000000..136d423 --- /dev/null +++ b/client-side/static/scripts/login.js @@ -0,0 +1,39 @@ +document.addEventListener('DOMContentLoaded', function () { + // Get references to form and buttons + const loginForm = document.getElementById('loginForm'); + const LoginBtn = document.getElementById('login-btn'); + // Function to handle form submission + const handleLogin = async (event) => { + // Collect form data + const formData = new FormData(loginForm); + const urlSearchParams = new URLSearchParams(formData); + try { + // Make a POST request to your API endpoint + const response = await fetch('http://localhost:5000/auth/user/login', { + method: 'POST', + body: formData, + headers: { + 'Content-Type': 'application/x-www-form-urlencoded', + }, + body: urlSearchParams, + }); + + // Handle the response + if (response.ok) { + const user = await response.json(); + console.log('User login:', user); + // Add any additional logic for successful login + } else { + const error = await response.json(); + console.error('Login failed:', error); + // Handle login error + } + } catch (error) { + console.error('An error occurred during login:', error); + // Handle general error + } + }; + + // Attach event listener to the form + LoginBtn.addEventListener('click', handleLogin); +}); diff --git a/client-side/static/scripts/register.js b/client-side/static/scripts/register.js new file mode 100644 index 0000000..3a4f122 --- /dev/null +++ b/client-side/static/scripts/register.js @@ -0,0 +1,62 @@ +document.addEventListener('DOMContentLoaded', function () { + // Get references to form and buttons + const registrationForm = document.getElementById('registration-form'); + const registerBtn = document.getElementById('register-btn'); + const googleSignupBtn = document.getElementById('google-signup-btn'); + const facebookSignupBtn = document.getElementById('facebook-signup-btn'); + + // Function to handle form submission + const handleRegistration = async () => { + // Collect form data + const formData = new FormData(registrationForm); + const urlSearchParams = new URLSearchParams(formData); + try { + // Make a POST request to your API endpoint + const response = await fetch('http://localhost:5000/api/v1/users', { + method: 'POST', + body: formData, + headers: { + 'Content-Type': 'application/x-www-form-urlencoded', + }, + body: urlSearchParams, + }); + + // Handle the response + if (response.ok) { + const user = await response.json(); + console.log('User registered:', user); + // Add any additional logic for successful registration + } else { + const error = await response.json(); + console.error('Registration failed:', error); + // Handle registration error + } + } catch (error) { + console.error('An error occurred during registration:', error); + // Handle general error + } + }; + + // Function to handle Google signup + const handleGoogleSignup = () => { + // Add logic for Google signup + }; + + // Function to handle Facebook signup + const handleFacebookSignup = () => { + // Add logic for Facebook signup + }; + + // Attach event listeners + registerBtn.addEventListener('click', handleRegistration); + googleSignupBtn.addEventListener('click', handleGoogleSignup); + facebookSignupBtn.addEventListener('click', handleFacebookSignup); +}); + +document.addEventListener('DOMContentLoaded', function () { + const passwordInput = document.getElementById('password'); // Replace 'password' with the actual ID of your password input + + document.getElementById('show-password').addEventListener('change', function () { + passwordInput.type = this.checked ? 'text' : 'password'; + }); +}); diff --git a/client-side/styles/common.css b/client-side/styles/common.css index 5d88872..b4dafbe 100644 --- a/client-side/styles/common.css +++ b/client-side/styles/common.css @@ -220,4 +220,4 @@ footer { footer { margin-top: 10px; } -} */ +} */ \ No newline at end of file diff --git a/client-side/styles/temporary.css b/client-side/styles/temporary.css index 25929dd..f4684d7 100644 --- a/client-side/styles/temporary.css +++ b/client-side/styles/temporary.css @@ -1,17 +1,17 @@ -marquee { - display: flex; - justify-content: center; - align-items: center; - height: 50px; - background-color: #f8f9fa; - margin-bottom: 20px; - } - - @media (max-width: 768px) { - marquee { - font-size: 14px; - } - footer { - position: static; - } +marquee { + display: flex; + justify-content: center; + align-items: center; + height: 50px; + background-color: #f8f9fa; + margin-bottom: 20px; + } + + @media (max-width: 768px) { + marquee { + font-size: 14px; + } + footer { + position: static; + } } \ No newline at end of file diff --git a/client-side/templates/home.html b/client-side/templates/home.html new file mode 100644 index 0000000..64d31b6 --- /dev/null +++ b/client-side/templates/home.html @@ -0,0 +1,429 @@ + + + + + + Home + + + + + + +
+
+
Logo + tradeQuick +
+
+
User avatar +
+
+
+ Banner Image +

Buy and Sell Used + Items +

+
+
+ +
+

Newest Deals!

+
+
+
item image +

Game Essentials

+

Created perfectly for you. Enjoy + the best quality from our top product.

+

$79.99

+
+
+
+
+
item image +

iPhone 15

+

This is the latest iPhone series, + with far more nicer features you can be sure + of luxury in your hands.

+

$99.99

+
+
+
+
+
item image +

Digital Watch

+

Watches never lie get yourself one + today!.

+

$99.99

+
+
+
+
+
item image +

Samsung Z fold

+

It's never too late to grab + yourself one of samsumg's finest series, promo runs + while stocks lasts!.

+

$79.99

+
+
+
+
+
item image +

Headset

+

Listen to great music with our new + headsets in town, rush and order yours..

+

$59.99

+
+
+
+
+
item image +

Apple Essentials +

+

A one time offer to get yourself an + apple product to aid you in you day to day + life.

+

$99.99

+
+
+
+
+
See More
+
+
+ +
+ + + \ No newline at end of file diff --git a/client-side/templates/index.html b/client-side/templates/index.html new file mode 100644 index 0000000..e2d72fe --- /dev/null +++ b/client-side/templates/index.html @@ -0,0 +1,521 @@ + + + + + + tradeQuick + + + + + + +
+
+
Logo + + tradeQuick
+
+
+ +
+
+ Banner Image +

Buy and Sell Used + Items +

+
+
+
item image +
+

Game Essentials

+

Created perfectly for you. Enjoy the best quality from our top product.

+
$99.99 +
+
+
+
+
item image +
+

iPhone 15

+

This is the latest iPhone series, with far more nicer features you can be sure + of luxury in your hands.

+
$89.99 +
+
+
+
+
item image +
+

Digital Watch

+

Watches never lie get yourself one today!.

+
$79.99 +
+
+
+
+
item image +
+

Samsung Z fold

+

It's never too late to grab yourself one of samsumg's finest series, promo runs + while stocks lasts!.

+
$69.99 +
+
+
+
+
item image +
+

Headset

+

Listen to great music with our new headsets in town, rush and order yours..

+
$69.99 +
+
+
+
+
item image +
+

Apple Essentials

+

A one time offer to get yourself an apple product to aid you in you day to day + life.

+
$69.99 +
+
+
+
+
+
+ See More +
+
+
+
User Image +
+

David Gregs

+
+ + + + + + + + + + + + + + +
+

tradeQuick is the best y'all check em out.

+
+
+
+
+
User Image +
+

Top-man Paul

+
+ + + + + + + + + + + + + + +
+

All in one place app, great work you guys are putting out there.

+
+
+
+
+
User Image +
+

Chibueze Ochibu

+
+ + + + + + + + + + + + + + +
+

I never thought I would find a place where I could do so much at a + time. nice work tradeQuick!.

+

+
+
+
+
+ + + + \ No newline at end of file diff --git a/client-side/templates/login.html b/client-side/templates/login.html new file mode 100644 index 0000000..624b6a9 --- /dev/null +++ b/client-side/templates/login.html @@ -0,0 +1,157 @@ + + + + + + + Login + + + + + + + + + {% with messages = get_flashed_messages(with_categories=true) %} + {% if messages %} +
+ {% for category, message in messages %} +
+

+ {{ message }} +

+
+ {% endfor %} +
+ {% endif %} + {% endwith %} +
+
+
tradeQuick Logo +

tradeQuick

+
+

+ Enter your email and password to login to your account. +

+
+
+
+
+ + +
+
+ + +
+
+ + Forgot password? +
+
+ +
+
+
+
+

Don't have an account? Sign + up

+
+
+ + + + + \ No newline at end of file diff --git a/client-side/templates/new.html b/client-side/templates/new.html new file mode 100644 index 0000000..c960c5f --- /dev/null +++ b/client-side/templates/new.html @@ -0,0 +1,149 @@ + + + + + + Document + + + + + + +
+
+
tradeQuick Logo +

tradeQuick

+
+

+ Enter your email and password to login to your account. +

+
+
+
+
+
Forgot password?
+
+
+ +
+
+

Don't have an account? Sign up

+
+ + + + + + +
+ +
+ + +
+
+ +

Welcome back, User!

\ No newline at end of file diff --git a/client-side/templates/register.html b/client-side/templates/register.html new file mode 100644 index 0000000..1012782 --- /dev/null +++ b/client-side/templates/register.html @@ -0,0 +1,270 @@ + + + + + + + Register + + + + + + + + + {% with messages = get_flashed_messages() %} + {% if messages %} +
+ {% for message in messages %} +
+ {{ message[1] }} +
+ {% endfor %} +
+ {% endif %} + {% endwith %} +
+
+
Logo +
+

+ Register to tradeQuick +

+

+ Start your journey with us. +

+
+
+
+
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+ + +
+ +
+
+ + +
+ +
+
+
+ + +
+
+
+

+ By registering, you agree to our Terms of + Service and Privacy Policy. +

+
+
+ + +
+
+ +
+
+
+

Already have an account? Login

+
+
+
+ + + + \ No newline at end of file diff --git a/server-side/.gitignore b/server-side/.gitignore new file mode 100644 index 0000000..be75cbc --- /dev/null +++ b/server-side/.gitignore @@ -0,0 +1,3 @@ +.vscode/ +.env +__pycache__/ \ No newline at end of file diff --git a/server-side/API_DOCUMENTATION.md b/server-side/API_DOCUMENTATION.md new file mode 100644 index 0000000..9fa0a5d --- /dev/null +++ b/server-side/API_DOCUMENTATION.md @@ -0,0 +1,431 @@ +## TradeQuick + +**This web app is a market place for selling used items that someone else might be interested in, the seller uploads certain information such as the photos of it, description and price and the buyer can either comment on the post or send private message. This is a document that is describing or explaining every API endpoint(TradeQuick) and it's usage.** + +### Users + +#### GET http://0.0.0.0:5000/api/v1/users + +##### Description + +* This endpoint does not require authentication. +* This endpoint retrieves all registered users. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/users" +``` + +#### POST http://0.0.0.0:5000/api/v1/users + +##### Description + +* This endpoint does not require authentication. +* Creates a new user with the data below +* This will also automtically create a default avatar for you as your profile pics +which you can update later to the photo you would like to use. + +| key | value | +|:----------------:|:-------------:| +| fullname | John Doe | +| email |johnd@gmail.com| +| password | 1234 | +| gender | male | +| about | wefsdwewed | +| phone1 | 232-442-646 | +| phone2 | 731-843-742 | +| address | 23D3 cray ave| +| town | old town | +| city | new city | +| state | CA | + +Example usage could be like this; +``` +curl -XPOST 'http://0.0.0.0:5000/api/v1/users' \ +--form 'fullname="Glory Maurice"' \ +--form 'email="glo.maurice@gmail.com"' \ +--form 'gender="Female"' \ +--form 'password="1234"' \ +--form 'about="I love Jesus"' \ +--form 'phone1="232-323-2322"' \ +--form 'address="23d32 bradway ave"' \ +--form 'photo="new_pic.png"' \ +--form 'town="maryland"' \ +--form 'city="boston"' \ +--form 'state="NY"' +``` +* This values are mock data that are used for this example purpose only. + +#### POST http://0.0.0.0:5000/api/v1/users/login + +##### Description + +* This endpoint creates a new login session for a user with their email and password +* With this session created users are authenticated automatically. + +Example usage could be like this; +``` +curl -XPOST 'http://0.0.0.0:5000/api/v1/users/login' \ +--form 'email="enola.fish@gmail.com"' \ +--form 'password="1234"' +``` + + +#### GET http://0.0.0.0:5000/api/v1/users/ + +##### Description + +* This endpoint requires authentication which will be the current user to carry out this operation. +* This endpoint retrieves a registered user based on their user_id. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/users/" +``` + +#### GET http://0.0.0.0:5000/api/v1/users/me + +##### Description + +* This endpoint requires authentication which will be the current user to carry out this operation. +* This endpoint gets the current authenticated user. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/users/me" +``` + +#### POST http://0.0.0.0:5000/api/v1/users/logout + +##### Description + +* This endpoint logs out a user and deletes the authenticated session + +Example usage could be like this; +``` +curl -XPOST "http://0.0.0.0:5000/api/v1/users/logout" +``` + + +#### POST http://0.0.0.0:5000/api/v1/users/ + +##### Description + +* This endpoint requires authentication which will be the current user to carry out this operation. +* This endpoint reset a user password based on their user_id. +* The field below are required to reset their password + +| key | value | +|:------------:|:-------------:| +| email |johnd@gmail.com| +| password | 1234 | +| new_password | pass1234 | + +Example usage could be like this; +``` +curl -XPOST "http://0.0.0.0:5000/api/v1/users/" +--form 'email="johnd@gmail.com"' \ +--form 'password="1234"' \ +--form 'new_password="new_pass1234"' +``` + + +#### DELETE http://0.0.0.0:5000/api/v1/users/ + +##### Description + +* This endpoint requires authentication which will be the current user to carry out this operation. +* This endpoint deletes the current user entire account and it's relations. + +Example usage could be like this; +``` +curl -XDELETE "http://0.0.0.0:5000/api/v1/users/" +``` + +#### PUT http://0.0.0.0:5000/api/v1/users/ + +##### Description + +* This endpoint requires authentication which will be the current user to carry out this operation. +* This endpoint updates the information of the user. +* This endpoint updates any information the user might want to change + +Example usage could be like this; +``` +curl -XPUT "http://0.0.0.0:5000/api/v1/users/19ebfab1-db5d-499c-95a5-fb74cbfd5d44" -H "Content-type: multipart/form-data" \ +-F "fullname=Kayla Fisher" \ +-F "phone1=341-545-2342" \ +-F "about=God is working it out" \ +-F"address=34D newton ave" \ +-F "town=New Haven" \ +-F "city=Los Angeles" \ +-F "state=CA" \ +-F "photo=@../server-side/api/v1/views/landscape.jpg" +``` + + +### Items + +#### GET http://0.0.0.0:5000/api/v1/items + +##### Description + +* This endpoint does not requires authentication. +* This endpoint retrieves all item posted by all registered users. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/items" +``` + +#### POST http://0.0.0.0:5000/api/v1/items + +##### Description + +* This endpoint requires authentication. +* This endpoint post an item for sale by a registered user. + +| key | value | +|:----------------:|:-------------:| +| item_name | Watch | +| description |Quality and durable watch| +| price | 1000000 | +| photo1 | 3v-a42-6e4.jpg| +| photo2 | 32-df-23ds.jpg| +| photo3 | 3df-2ecwsd.jpg| + +Example usage could be like this; +``` +curl -XPOST "http://0.0.0.0:5000/api/v1/items" +-H "Content-type: multipart/form-data" \ +-F "item_name=Watch" \ +-F "description=Quality and durable watch" \ +-F "price=100000" \ +-F "photo1=@../path/to/gadget1.jpg" \ +-F "photo2=@../path/to/gadget2.jpg" +``` + +#### GET http://0.0.0.0:5000/api/v1/items/ + +##### Description + +* This endpoint does not require authentication. +* This endpoint retrieves all items posted by a user based on their user_id. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/items/" +``` + +#### GET http://0.0.0.0:5000/api/v1/item/ + +##### Description + +* This endpoint does not require authentication. +* This endpoint retrieves an item posted by a user based on it's item_id. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/item/" +``` + +#### PUT http://0.0.0.0:5000/api/v1/items/ + +##### Description + +* This endpoint requires authentication. +* This endpoint updates an item based on it's item_id. + +Example usage could be like this; +``` +curl -XPUT "http://0.0.0.0:5000/api/v1/items/" +-H "Content-type: multipart/form-data" \ +-F "item_name=TV" \ +-F "description=LG 42 inch HDMI Tv" \ +-F "price=150000" \ +-F "photo1=@../path/to/TV1.jpg" \ +-F "photo2=@../path/to/TV2.jpg" +``` + +#### DELETE http://0.0.0.0:5000/api/v1/items/ + +##### Description + +* This endpoint requires authentication. +* This endpoint deletes an item posted by a user based on it's item_id. + +Example usage could be like this; +``` +curl -XDELETE "http://0.0.0.0:5000/api/v1/item/" +``` + +### Ratings + +#### POST http://0.0.0.0:5000/api/v1/ratings + +##### Description + +* This endpoint requires authentication. +* This endpoint post a new rating. + +Example usage could be like this; +``` +curl -XPOST "http://0.0.0.0:5000/api/v1/ratings" \ +-H "Content-type: multipart/form-data" \ +-F "user_id=19ebfab1-db5d-499c-95a5-fb74cbfd5d44" \ +-F "comment=I love this watch" \ +-F "rating=4" +``` + +#### GET http://0.0.0.0:5000/api/v1/ratings + +##### Description + +* This endpoint does not require authentication. +* This endpoint retrieves all ratings posted by all registered users. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/ratings" +``` + +### Likes + +#### POST http://0.0.0.0:5000/api/v1/likes/0 + +##### Description + +* This endpoint requires authentication +* Passing the parameter 0 or 1 set dislike or like an item respectively +* Sending a post request twice with the same parameter undo the dislike or like and sets it to like or dislike respectively. + +Example usage could be like this; +``` +curl -XPOST "http://0.0.0.0:5000/api/v1/likes/0" -d "user_id=&item_id=" --cookie="" +``` + +#### GET http://0.0.0.0:5000/api/v1/likes/ + +##### Description + +* This endpoint requires authentication. +* This endpoint retrieves all likes and dislikes based on an item_id. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/likes/" --cookie="" +``` + +### Comments + +#### POST http://0.0.0.0:5000/api/v1/comments + +##### Description + +* This endpoint requires authentication. +* This endpoint post a new comment. + +Example usage could be like this; +``` +curl -XPOST "http://0.0.0.0:5000/api/v1/comments" \ +-H "Content-type: multipart/form-data" \ +-F "commenter=19ebfab1-db5d-499c-95a5-fb74cbfd5d44" \ +-F "comment=I love this TV" \ +-F "item_id=a2585ea3-dd0b-451a-83a6-a1ee52c02580" +``` + +#### PATCH http://0.0.0.0:5000/api/v1/comments/ + +##### Description + +* This endpoint requires authentication. +* This endpoint updates a comment based on their comment_id. + +Example usage could be like this; +``` +curl -XPATCH "http://0.0.0.0:5000/api/v1/comments/" -d "comment=Do you have the latest one?" --cookie= +``` + +#### http://0.0.0.0:5000/api/v1/comments/ + +##### Description + +* This endpoint requires authentication. +* This endpoint retreives a comment based on the item_id. + +Example usage could be like this; +``` +curl "http://0.0.0.0:5000/api/v1/comments/ --cookie= +``` + +#### DELETE http://0.0.0.0:5000/api/v1/comments/comment_id + +##### Description + +* This endpoint requires authentication. +* This endpoint deletes a comment based on the comment_id. + +Example usage could be like this; +``` +curl -XDELETE "http://0.0.0.0:5000/api/v1/comments/ --cookie= +``` + +### Chats + +#### POST http://0.0.0.0:5000/api/v1/messages + +##### Description + +* This endpoint requires authentication. +* This endpoint post a new message. + +Example usage could be like this; +``` +curl -XPOST "http://0.0.0.0:5000/api/v1/messages \ +-H "Content-type: multipart/form-data" \ +-F "sender_id=" \ +-F "receiver_id=" \ +-F "message=I love this TV" \ +--cookie= +``` + +#### PATCH http://0.0.0.0:5000/api/v1/messages/message_id + +##### Description + +* This endpoint requires authentication. +* This endpoint updates an already sent message based on the message_id. + +Example usage could be like this; +``` +curl -XPATCH "http://0.0.0.0:5000/api/v1/messages \ +-H "Content-type: multipart/form-data" \ +-F "message=Do you have more of this TV?" \ +--cookie= +``` + +#### DELETE http://0.0.0.0:5000/api/v1/messages/message_id + +##### Description + +* This endpoint requires authentication. +* This endpoint deletes a message based on the message_id. + +Example usage could be like this; +``` +curl -XDELETE "http://0.0.0.0:5000/api/v1/messages/message_id --cookie= +``` + +#### DELETE http://0.0.0.0:5000/api/v1/messages/user_id + +##### Description + +* This endpoint requires authentication. +* This endpoint deletes all message posted by a user. + +Example usage could be like this; +``` +curl -XDELETE "http://0.0.0.0:5000/api/v1/messages/user_id --cookie= +``` + +###### © 2023 tradeQuick. All rights reserved. \ No newline at end of file diff --git a/server-side/Project.code-workspace b/server-side/Project.code-workspace new file mode 100644 index 0000000..407c760 --- /dev/null +++ b/server-side/Project.code-workspace @@ -0,0 +1,8 @@ +{ + "folders": [ + { + "path": "../.." + } + ], + "settings": {} +} \ No newline at end of file diff --git a/server-side/README.md b/server-side/README.md new file mode 100644 index 0000000..55e5757 --- /dev/null +++ b/server-side/README.md @@ -0,0 +1 @@ +**Read through the API_DOCUMENTATION.md file to understand the usage of TradeQuick's API** diff --git a/client-side/about.html b/server-side/api/__init__.py similarity index 100% rename from client-side/about.html rename to server-side/api/__init__.py diff --git a/client-side/portfolio.html b/server-side/api/v1/__init__.py similarity index 100% rename from client-side/portfolio.html rename to server-side/api/v1/__init__.py diff --git a/server-side/api/v1/app.py b/server-side/api/v1/app.py new file mode 100644 index 0000000..7f41714 --- /dev/null +++ b/server-side/api/v1/app.py @@ -0,0 +1,117 @@ +""" +App Initialiser +""" + +from flask import Flask, jsonify, abort, request, flash, redirect, url_for, render_template +from flask_cors import (CORS, cross_origin) +from api.v1.views import app_views +from api.v1.views import auth +from dotenv import load_dotenv +from os import getenv +import os +from models.db import DBStorage + + +db = DBStorage() + + +load_dotenv() + + +app = Flask( + __name__, template_folder='/mnt/c/Users/udohd/Project/tradeQuick/client-side/templates', static_folder='/mnt/c/Users/udohd/Project/tradeQuick/client-side/static', static_url_path='/static') +app.register_blueprint(app_views) +app.register_blueprint(auth) +app.config['SECRET_KEY'] = getenv("API_SECRET_KEY") +CORS(app, resources={r"/api/v1/*": {"origins": "*"}}) +auth = None +AUTH_TYPE = getenv("AUTH_TYPE") +if AUTH_TYPE == "auth": + from api.v1.auth.auth import Auth + auth = Auth() +if AUTH_TYPE == "basic_auth": + from api.v1.auth.basic_auth import BasicAuth + auth = BasicAuth() +if AUTH_TYPE == "session_auth": + from api.v1.auth.session_auth import SessionAuth + auth = SessionAuth() +if AUTH_TYPE == "session_exp_auth": + from api.v1.auth.session_exp_auth import SessionExpAuth + auth = SessionExpAuth() +if AUTH_TYPE == "session_db_auth": + from api.v1.auth.session_db_auth import SessionDBAuth + auth = SessionDBAuth() + + +@app.teardown_appcontext +def close_db(error): + """ + close database session + """ + with db: + db.close() + + +@app.errorhandler(404) +def not_found(error) -> str: + """ Not found handler + """ + return jsonify({"error": "Not found"}), 404 + + +@app.errorhandler(401) +def unauthorized(error) -> str: + """ Unauthorized handler + """ + return jsonify({"error": "Unauthorized"}), 401 + + +@app.errorhandler(403) +def forbidden(error) -> str: + """ Forbidden handler + """ + return jsonify({"error": "Forbidden"}), 403 + + +@app.before_request +def before_request_func(): + """ Before request handler + """ + + excluded_paths = ['/api/v1/status/', + '/api/v1/unauthorized/', + '/api/v1/forbidden/', + '/api/v1/users/login/', + '/api/v1/users/', + '/api/v1/items/', + '/api/v1/signup/', + '/api/v1/login/', + '/auth/signup/', + '/auth/login/', + '/static/images/logo.png/', + '/static/images/logo1.png/', + '/static/scripts/register.js/', + '/static/scripts/login.js/', + '/favicon.ico/', + '/logo.png', + '/auth/user/login/', + '/static/images/banner.jpg/', + ] + if auth is None: + pass + else: + setattr(request, 'current_user', auth.current_user(request)) + if auth.require_auth(request.path, excluded_paths): + pass + if auth.authorization_header(request) is None and auth.session_cookie(request) is None: + flash('Session expired. Please login again', 'danger') + return redirect(url_for('auth.login_page')) + if auth.current_user(request) is None: + flash('Session expired. Please login again', 'danger') + return redirect(url_for('auth.login_page')) + + +if __name__ == "__main__": + host = getenv("API_HOST", "0.0.0.0") + port = getenv("API_PORT", "5000") + app.run(host=host, port=port, debug=True) diff --git a/server-side/api/v1/auth/__init__.py b/server-side/api/v1/auth/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/server-side/api/v1/auth/auth.py b/server-side/api/v1/auth/auth.py new file mode 100644 index 0000000..dedc641 --- /dev/null +++ b/server-side/api/v1/auth/auth.py @@ -0,0 +1,53 @@ +""" +Auth class +""" + +from typing import List, TypeVar + + +class Auth: + """ + Auth class + """ + + def require_auth(self, path: str, excluded_paths: List[str]) -> bool: + """ + require_auth + """ + if path is None: + return True + if excluded_paths is None or excluded_paths == []: + return True + if path[-1] != '/': + path += '/' + if path in excluded_paths: + return False + else: + return True + + def authorization_header(self, request=None) -> str: + """ + authorization_header + """ + if request is None: + return None + value = request.headers.get('Authorization') + if value is None or value == '': + return None + else: + return value + + def current_user(self, request=None) -> TypeVar('User'): + """ + current_user + """ + return None + + def session_cookie(self, request=None): + """ + - Returns a cookie value from a requests + """ + if request is None: + return None + cookie_value = request.cookies.get('_my_session_id') + return cookie_value diff --git a/server-side/api/v1/auth/basic_auth.py b/server-side/api/v1/auth/basic_auth.py new file mode 100644 index 0000000..e5adf06 --- /dev/null +++ b/server-side/api/v1/auth/basic_auth.py @@ -0,0 +1,85 @@ +""" +This file contains the basic authentication for the API +""" + +import base64 +from flask import abort, jsonify, request, abort +from api.v1.auth.auth import Auth +from typing import TypeVar + + +class BasicAuth(Auth): + """ + BasicAuth class + """ + + def extract_base64_authorization_header(self, authorization_header: str) -> str: + """ + extract_base64_authorization_header + """ + if authorization_header is None: + return None + if type(authorization_header) is not str: + return None + split_header = authorization_header.split(' ') + if split_header[0] != 'Basic': + return None + if len(split_header) < 2: + return None + return split_header[1] + + def decode_base64_authorization_header(self, base64_authorization_header: str) -> str: + """ + decode_base64_authorization_header + """ + if base64_authorization_header is None: + return None + if type(base64_authorization_header) is not str: + return None + try: + return base64.b64decode(base64_authorization_header).decode('utf-8') + except Exception: + return None + + def extract_user_credentials(self, decoded_base64_authorization_header: str) -> (str, str): + """ + extract_user_credentials + """ + if decoded_base64_authorization_header is None: + return None, None + if type(decoded_base64_authorization_header) is not str: + return None, None + if ':' not in decoded_base64_authorization_header: + return None, None + split_header = decoded_base64_authorization_header.split(':') + return split_header[0], split_header[1] + + def user_object_from_credentials(self, user_email: str, user_pwd: str) -> TypeVar('User'): + """ + user_object_from_credentials + """ + if user_email is None or user_pwd is None: + return None + if type(user_email) is not str or type(user_pwd) is not str: + return None + + from models.db import DBStorage + DB = DBStorage() + with DB: + user = DB.find_user_by_email(user_email) + if user is None: + return None + if user.password == user_pwd: + return jsonify(user.to_dict()), 200 + + def current_user(self, request=None) -> TypeVar('User'): + """ + Load the user from the request + """ + auth_header = self.authorization_header(request) + extract_base64 = self.extract_base64_authorization_header(auth_header) + decode_base64 = self.decode_base64_authorization_header(extract_base64) + user_credentials = self.extract_user_credentials(decode_base64) + user_object = self.user_object_from_credentials( + user_credentials[0], user_credentials[1]) + return user_object diff --git a/server-side/api/v1/auth/session_auth.py b/server-side/api/v1/auth/session_auth.py new file mode 100644 index 0000000..9321e17 --- /dev/null +++ b/server-side/api/v1/auth/session_auth.py @@ -0,0 +1,58 @@ +from api.v1.auth.auth import Auth +from uuid import uuid4 +from typing import TypeVar + + +class SessionAuth(Auth): + """ + - Session Auth Implementation Class + """ + user_id_by_session_id = {} + + def create_session(self, user_id: str = None) -> str: + """ + A method that creates a Session ID for a user_id + """ + if user_id and isinstance(user_id, str): + session_id = str(uuid4()) + self.user_id_by_session_id[session_id] = user_id + return session_id + return None + + def user_id_for_session_id(self, session_id: str = None) -> str: + """ + A method that returns a User ID based on a Session ID + """ + if session_id and isinstance(session_id, str): + return self.user_id_by_session_id.get(session_id) + return None + + def current_user(self, request=None) -> TypeVar('User'): + """ + - Overloads Auth and retrieves User instance for a request + """ + from models.db import DBStorage + db = DBStorage() + try: + session_cookie = self.session_cookie(request) + user_id = self.user_id_for_session_id(session_cookie) + with db: + user = db.find_user_by_id(user_id) + return user + except Exception: + return None + + def destroy_session(self, request=None): + """ + - Deletes the user session / logout + """ + if request is None: + return False + sess_cookie = self.session_cookie(request) + if sess_cookie is None: + return False + user_id = self.user_id_for_session_id(sess_cookie) + if user_id is None: + return False + del self.user_id_by_session_id[sess_cookie] + return True diff --git a/server-side/api/v1/auth/session_db_auth.py b/server-side/api/v1/auth/session_db_auth.py new file mode 100644 index 0000000..307df73 --- /dev/null +++ b/server-side/api/v1/auth/session_db_auth.py @@ -0,0 +1,102 @@ +from api.v1.auth.session_exp_auth import SessionExpAuth +from datetime import datetime, timedelta +import os +from dotenv import load_dotenv + +load_dotenv() + + +class SessionDBAuth(SessionExpAuth): + """ + - SessionDBAuth class + """ + + def __init__(self) -> None: + try: + session_duration = int(os.getenv('SESSION_DURATION')) + except Exception: + session_duration = 0 + self.session_duration = session_duration + + def create_session(self, user_id=None): + session_id = super().create_session(user_id) + if session_id is None or not session_id: + return None + try: + from models.db import DBStorage + db = DBStorage() + session_data = { + "user_id": user_id, + "session_id": session_id + } + with db: + session = db.create_session(session_data) + if session is None: + return None + db.save() + db.close() + return session.session_id + except Exception as e: + print(e) + return None + + def user_id_for_session_id(self, session_id=None): + """ + - User ID for session ID + """ + try: + if session_id is None: + return None + + from models.db import DBStorage + db = DBStorage() + with db: + session = db.find_session_by_id(session_id) + if session is None: + return None + + if self.session_duration > 0: + created_at = session.created_at + if not created_at: + return None + + expiration_time = created_at + \ + timedelta(minutes=self.session_duration) + + if expiration_time < datetime.now(): + try: + db.delete_session(session) + except Exception as e: + print(f"Error during session deletion: {e}") + return None + return None # Session expired, return None + db.save() + db.close() + + return session.user_id + + except Exception as e: + print(f"Error during user_id_for_session_id: {e}") + return None + + def destroy_session(self, request=None): + """ + - Destroy session + """ + try: + session_id = self.session_cookie(request) + if session_id is None: + return False + from models.db import DBStorage + db = DBStorage() + with db: + session = db.find_session_by_id(session_id) + if session is None: + return False + db.delete_session(session) + db.save() + db.close() + return True + except Exception as e: + print(e) + return False diff --git a/server-side/api/v1/auth/session_exp_auth.py b/server-side/api/v1/auth/session_exp_auth.py new file mode 100644 index 0000000..6cd92f6 --- /dev/null +++ b/server-side/api/v1/auth/session_exp_auth.py @@ -0,0 +1,61 @@ +""" +A module for session expiration +""" +from api.v1.auth.session_auth import SessionAuth +import os +from datetime import datetime, timedelta + + +class SessionExpAuth(SessionAuth): + """ + A session expiration class + """ + + def __init__(self) -> None: + try: + session_duration = int(os.getenv('SESSION_DURATION')) + except Exception: + session_duration = 0 + self.session_duration = session_duration + + def create_session(self, user_id=None): + session_id = super().create_session(user_id) + if session_id is None or not session_id: + return None + session_dict = { + "user_id": user_id, + "created_at": datetime.now() + } + + self.user_id_by_session_id[session_id] = session_dict + return session_id + + def user_id_for_session_id(self, session_id=None): + """ + - User ID for session ID + """ + try: + if session_id is None: + return None + sess_info = self.user_id_by_session_id.get(session_id) + if not sess_info: + return None + + if self.session_duration <= 0: + user_id = sess_info.get("user_id") + return user_id + + created_at = sess_info.get("created_at") + if not created_at: + return None + + expiration_time = created_at + \ + timedelta(seconds=self.session_duration) + if expiration_time < datetime.now(): + return None + + user_id = sess_info.get("user_id") + return user_id + except Exception as e: + print(e) + return None diff --git a/server-side/api/v1/views/__init__.py b/server-side/api/v1/views/__init__.py new file mode 100644 index 0000000..7f8a63e --- /dev/null +++ b/server-side/api/v1/views/__init__.py @@ -0,0 +1,14 @@ +""" DocDocDocDocDocDoc +""" +from flask import Blueprint + +app_views = Blueprint("app_views", __name__, url_prefix="/api/v1") +auth = Blueprint("auth", __name__, url_prefix="/auth") + +from api.v1.views.items import * +from api.v1.views.chats import * +from api.v1.views.likes import * +from api.v1.views.comments import * +from api.v1.views.ratings import * +from api.v1.views.users import * +from api.v1.views.index import * diff --git a/server-side/api/v1/views/chats.py b/server-side/api/v1/views/chats.py new file mode 100644 index 0000000..585faff --- /dev/null +++ b/server-side/api/v1/views/chats.py @@ -0,0 +1,124 @@ +from flask import abort, request, jsonify +from os import getenv +from api.v1.views import app_views + + + +@app_views.route('/messages', methods=['POST'], strict_slashes=False) +def create_message(): + """ + - Create a new message + """ + message_data = {} + sender_id = request.form.get('sender_id') + receiver_id = request.form.get('receiver_id') + message = request.form.get('message') + if not sender_id: + abort(400, "Missing sender_id") + if not receiver_id: + abort(400, "Missing receiver_id") + if not message: + abort(400, "Missing message") + message_data['sender_id'] = sender_id + message_data['receiver_id'] = receiver_id + message_data['message'] = message + + from models.db import DBStorage + db = DBStorage() + try: + with db: + auth_user = request.current_user + receiver = db.find_user_by_id(message['receiver_id']) + if auth_user is not None: + if auth_user.user_id != message_data['sender_id']: + abort(401, "Unauthorized") + if receiver is None: + abort(404, "No user found for that ID") + new_message = db.create_message(message_data) + if not new_message: + abort(404, "Error creating message") + db.save() + return jsonify(new_message.to_dict()), 201 + except Exception as e: + abort(400) + + +@app_views.route('/messages/', methods=['PATCH'], strict_slashes=False) +def update_message(message_id): + from models.db import DBStorage + db = DBStorage() + message_data = {} + message = request.form.get('message') + if not message: + abort(400, "Missing message") + message_data['message'] = message + try: + with db: + auth_user = request.current_user + new_message = db.get_messages_by_message_id(message_id) + if not new_message: + abort(404, "message not found") + if auth_user is not None: + if auth_user.user_id != new_message.sender_id: + abort(401, "Unauthorized") + new_message.message = message_data['message'] + db.save() + return jsonify(new_message.to_dict()), 200 + except Exception as e: + print(e) + abort(401) + + +@app_views.route('/message/', methods=['DELETE'], strict_slashes=False) +def delete_message(message_id): + """ + - Delete a message + """ + from models.db import DBStorage + db = DBStorage() + try: + with db: + auth_user = request.current_user + message = db.get_messages_by_message_id(message_id) + if not message: + abort(404, "message not found") + if auth_user is not None: + if auth_user.user_id != message.sender_id: + abort(401, "Unauthorized") + db.delete(message) + db.save() + return jsonify({}), 200 + except Exception as e: + abort(401) + + +@app_views.route('/messages/', methods=['DELETE'], strict_slashes=False) +def delete_all_user_chat(user_id): + """ + - Delete all messages from a user + """ + from models.db import DBStorage + db = DBStorage() + try: + with db: + auth_user = request.current_user + + # Retrieve messages + messages = db.get_messages_by_user_id(user_id) + + # Check if there are no messages + if not messages: + abort(404, "Messages not found") + + # Check sender authorization and delete messages + for message in messages: + if auth_user is not None and auth_user.user_id != message.sender_id: + abort(401, "Unauthorized") + db.delete(message) + + # Save changes after all messages have been deleted + db.save() + return jsonify({}), 200 + except Exception as e: + print(e) + return jsonify({}), 200 diff --git a/server-side/api/v1/views/comments.py b/server-side/api/v1/views/comments.py new file mode 100644 index 0000000..c6c0005 --- /dev/null +++ b/server-side/api/v1/views/comments.py @@ -0,0 +1,115 @@ +from flask import abort, request, jsonify +from dotenv import load_dotenv +from os import getenv +from api.v1.views import app_views + +load_dotenv() + + +@app_views.route('/comments', methods=['POST'], strict_slashes=False) +def comments(): + """Create a new comment""" + from models.db import DBStorage + db = DBStorage() + comment_data = {} + + commenter = request.form.get('commenter') + item_id = request.form.get('item_id') + comment = request.form.get('comment') + if not commenter: + abort(400, "Missing commenter") + if not item_id: + abort(400, "Missing item_id") + if not comment: + abort(400, "Missing comment") + + comment_data['commenter'] = commenter + comment_data['item_id'] = item_id + comment_data['comment'] = comment + + try: + with db: + auth_user = request.current_user + if auth_user is not None: + if auth_user.user_id != comment_data['commenter']: + abort(401, "Unauthorized") + new_comment = db.create_comment(comment_data) + if not new_comment: + abort(400, "Error creating comment") + db.save() + return jsonify(new_comment.to_dict()), 201 + except Exception as e: + abort(401) + + +@app_views.route('/comments/', methods=['PATCH'], strict_slashes=False) +def update_comment(comment_id): + """Update a comment""" + from models.db import DBStorage + db = DBStorage() + comment_data = {} + + comment = request.form.get('comment') + if not comment: + abort(400, "Missing comment") + + comment_data['comment'] = comment + + try: + with db: + auth_user = request.current_user + comment = db.get_comments_by_comment_id(comment_id) + if not comment: + abort(404, "Comment not found") + if auth_user is not None: + if auth_user.user_id != comment.commenter: + abort(401, "Unauthorized") + comment.comment = comment_data['comment'] + db.save() + return jsonify(comment.to_dict()), 200 + except Exception as e: + print(e) + abort(401) + + +@app_views.route('/comments/', methods=['GET'], strict_slashes=False) +def get_comments(item_id): + """Get comments for an item""" + from models.db import DBStorage + db = DBStorage() + try: + with db: + comments = db.get_comments_by_item_id(item_id) + if not comments: + abort(404, "No comments found") + all_comments = [comment.to_dict() for comment in comments] + count_comments = len(all_comments) + response = { + 'count': count_comments, + 'comments': all_comments + } + return jsonify(response), 200 + except Exception as e: + abort(400) + + +@app_views.route('/comments/', methods=['DELETE'], strict_slashes=False) +def delete_comment(comment_id): + """Delete a comment""" + from models.db import DBStorage + db = DBStorage() + try: + with db: + auth_user = request.current_user + comment = db.get_comments_by_comment_id(comment_id) + if not comment: + abort(404, "Comment not found") + if auth_user is not None: + if auth_user.user_id != comment.commenter: + abort(401, "Unauthorized") + db.delete(comment) + db.save() + return jsonify({}), 200 + except Exception as e: + print(e) + abort(401) diff --git a/server-side/api/v1/views/gadget1.jpg b/server-side/api/v1/views/gadget1.jpg new file mode 100644 index 0000000..7075caf Binary files /dev/null and b/server-side/api/v1/views/gadget1.jpg differ diff --git a/server-side/api/v1/views/gadget2.jpg b/server-side/api/v1/views/gadget2.jpg new file mode 100644 index 0000000..a6cd957 Binary files /dev/null and b/server-side/api/v1/views/gadget2.jpg differ diff --git a/server-side/api/v1/views/gadget3.jpg b/server-side/api/v1/views/gadget3.jpg new file mode 100644 index 0000000..1c6d301 Binary files /dev/null and b/server-side/api/v1/views/gadget3.jpg differ diff --git a/server-side/api/v1/views/index.py b/server-side/api/v1/views/index.py new file mode 100644 index 0000000..fe2cc0d --- /dev/null +++ b/server-side/api/v1/views/index.py @@ -0,0 +1,32 @@ +""" +Modules for index endpoints +""" +from api.v1.views import app_views +from flask import abort, jsonify, request, abort + + +@app_views.route('/status', methods=['GET'], strict_slashes=False) +def get_status() -> str: + """ GET /api/v1/status + Return: + - Status OK + """ + return jsonify({"status": "OK"}), 200 + + +@app_views.route('/unauthorized', methods=['GET'], strict_slashes=False) +def unauthorized() -> str: + """ GET /api/v1/unauthorized + Return: + - Unauthorized + """ + abort(401) + + +@app_views.route('/forbidden', methods=['GET'], strict_slashes=False) +def forbidden() -> str: + """ GET /api/v1/forbidden + Return: + - Forbidden + """ + abort(403) diff --git a/server-side/api/v1/views/items.py b/server-side/api/v1/views/items.py new file mode 100644 index 0000000..4028a3a --- /dev/null +++ b/server-side/api/v1/views/items.py @@ -0,0 +1,173 @@ +from api.v1.views import app_views +from flask import abort, request, jsonify +from os import getenv +from api.v1.views.users import save_picture + + + + +@app_views.route('/items', methods=['POST'], strict_slashes=False) +def new_item(): + """Create a new item""" + from models.db import DBStorage + db = DBStorage() + item_data = {} + + user_id = request.form.get('user_id') + item_name = request.form.get('item_name') + description = request.form.get('description') + price = request.form.get('price') + photo1 = request.files.get('photo1') + photo2 = request.files.get('photo2') + photo3 = request.files.get('photo3') + if not user_id: + abort(400, "Missing user_id") + if not item_name: + abort(400, "Missing item name") + if not description: + abort(400, "Missing description") + if not price: + abort(400, "Missing price") + if not photo1: + abort(400, "Missing photo1") + + pics_fn1 = save_picture(photo1) + pics_fn2 = save_picture(photo2) + pics_fn3 = save_picture(photo3) + + item_data['user_id'] = user_id + item_data['item_name'] = item_name + item_data['description'] = description + item_data['price'] = price + item_data['photo1'] = pics_fn1 + item_data['photo2'] = pics_fn2 + item_data['photo3'] = pics_fn3 + + try: + with db: + auth_user = request.current_user + if auth_user is not None: + if auth_user.user_id != item_data['user_id']: + return jsonify({"error": "Unauthorized"}), 401 + item = db.create_item(item_data) + print(f"Item successfully created for {item_data['user_id']}") + db.save() + return jsonify(item.to_dict()), 201 + except Exception as e: + print(e) + abort(400) + + +@app_views.route('/items', methods=['GET'], strict_slashes=False) +def retreive_items(): + """Get all items""" + from models.db import DBStorage + db = DBStorage() + try: + with db: + items = db.get_items() + item_data = [item.to_dict() for item in items] + return jsonify(item_data), 200 + except Exception as e: + print(e) + + +@app_views.route('/items/', methods=['GET'], strict_slashes=False) +def get_items_by_user_id(user_id): + """ + - Get all items by user_id + """ + from models.db import DBStorage + db = DBStorage() + try: + with db: + items = db.get_items_by_user_id(user_id) + items_data = [item.to_dict() for item in items] + return jsonify(items_data), 200 + except Exception as e: + abort(400) + + +@app_views.route('/item/', methods=['GET'], strict_slashes=False) +def get_item_by_item_id(item_id): + """ + - Get item by item_id + """ + from models.db import DBStorage + db = DBStorage() + try: + with db: + items = db.find_items_by_item_id(item_id) + if items is None: + abort(404) + item_data = items.to_dict() + return jsonify(item_data), 200 + except Exception as e: + print(e) + abort(400) + + +@app_views.route('/items/', methods=['PUT'], strict_slashes=False) +def update_item_by_item_id(item_id): + """ + - Update item by item_id + """ + from models.db import DBStorage + db = DBStorage() + item_data = {} + + item_name = request.form.get('item_name') + description = request.form.get('description') + price = request.form.get('price') + photo1 = request.files.get('photo1') + photo2 = request.files.get('photo2') + photo3 = request.files.get('photo3') + + pic_fn1 = save_picture(photo1) + pic_fn2 = save_picture(photo2) + pic_fn3 = save_picture(photo3) + + item_data['item_name'] = item_name + item_data['description'] = description + item_data['price'] = price + item_data['photo1'] = pic_fn1 + item_data['photo2'] = pic_fn2 + item_data['photo3'] = pic_fn3 + + + try: + with db: + item = db.find_items_by_item_id(item_id) + if item is None: + abort(404) + item.item_name = item_data['item_name'] + item.description = item_data['description'] + item_data.price = item_data['price'] + item_data.photo1 = item_data['photo1'] + item_data.photo2 = item_data['photo2'] + item_data.photo3 = item_data['photo3'] + print(f"Item successfully updated for {item_data['user_id']}") + db.save() + return jsonify({}), 200 + except Exception as e: + print(e) + return jsonify({}), 400 + + +@app_views.route('/items/', methods=['DELETE'], strict_slashes=False) +def delete_item_by_item_id(item_id): + """ + - Delete item by item_id + """ + from models.db import DBStorage + db = DBStorage() + try: + with db: + item = db.find_items_by_item_id(item_id) + if item is None: + abort(404) + db.delete(item) + db.save() + return jsonify({}), 200 + except Exception as e: + abort(400) diff --git a/server-side/api/v1/views/landscape.jpg b/server-side/api/v1/views/landscape.jpg new file mode 100644 index 0000000..75631f9 Binary files /dev/null and b/server-side/api/v1/views/landscape.jpg differ diff --git a/server-side/api/v1/views/likes.py b/server-side/api/v1/views/likes.py new file mode 100644 index 0000000..45655fe --- /dev/null +++ b/server-side/api/v1/views/likes.py @@ -0,0 +1,73 @@ +from flask import abort, request, jsonify +from os import getenv +from collections import Counter +from api.v1.views import app_views + + +@app_views.route('/likes/', methods=['POST'], strict_slashes=False) +def likes(status): + """Create a new like""" + from models.db import DBStorage + db = DBStorage() + like_data = {} + + get_user_id = request.form.get('user_id') + get_item_id = request.form.get('item_id') + if not get_user_id: + abort(400, "Missing user_id") + if not get_item_id: + abort(400, "Missing item_id") + + like_data['user_id'] = get_user_id + like_data['item_id'] = get_item_id + like_data['liked'] = status + + try: + with db: + like_user = db.get_user_like(like_data['item_id'], like_data['user_id']) + auth_user = request.current_user + if not auth_user: + abort(401) + if auth_user.user_id != like_data['user_id']: + abort(401) + if not like_user: + new_like = db.create_like(like_data) + db.save() + if not new_like: + abort(400, "Error creating like") + return jsonify(new_like.to_dict()), 201 + else: + if like_user.liked == status: + like_user.liked = 1 - status + else: + like_user.liked = status + db.save() + return jsonify(like_user.to_dict()), 200 + except Exception as e: + print(e) + abort(401) + + +@app_views.route('likes/', methods=['GET'], strict_slashes=False) +def get_likes(item_id): + """Get likes by item_id""" + from models.db import DBStorage + db = DBStorage() + try: + with db: + count = 0 + likes = db.get_like_by_item_id_all(item_id) + if not likes: + return jsonify([]) + all_likes = [like.to_dict() for like in likes] + c = Counter() + for count in all_likes: + c[count['liked']] += 1 + response = { + 'liked': c[True], + 'dislike': c[False] + } + return jsonify(response), 200 + except Exception as e: + print(e) + abort(400) \ No newline at end of file diff --git a/server-side/api/v1/views/passport.jpg b/server-side/api/v1/views/passport.jpg new file mode 100644 index 0000000..7921218 Binary files /dev/null and b/server-side/api/v1/views/passport.jpg differ diff --git a/server-side/api/v1/views/ratings.py b/server-side/api/v1/views/ratings.py new file mode 100644 index 0000000..90e9da9 --- /dev/null +++ b/server-side/api/v1/views/ratings.py @@ -0,0 +1,56 @@ +from flask import abort, request, jsonify +from dotenv import load_dotenv +from os import getenv +from api.v1.views import app_views + +load_dotenv() + + +@app_views.route('/ratings', methods=['POST'], strict_slashes=False) +def create_rating(): + """Create a new rating""" + from models.db import DBStorage + db = DBStorage() + rating_data = {} + + new_user_id = request.form.get('user_id') + user_comment = request.form.get('comment') + user_rating = request.form.get('rating') + if new_user_id is None: + abort(400, "Missing user_id") + if user_comment is None: + abort(400, "Missing comment") + if user_rating is None: + abort(400, "Missing rating") + + rating_data['user_id'] = new_user_id + rating_data['comment'] = user_comment + rating_data['rating'] = user_rating + + try: + with db: + auth_user = request.current_user + if auth_user is not None: + if auth_user.user_id != rating_data['user_id']: + return jsonify({"error": "Unauthorized"}), 401 + rating = db.create_rating(rating_data) + print(f"Rating successfully created for {rating_data['user_id']}") + db.save() + return jsonify(rating.to_dict()), 201 + except Exception as e: + print(e) + abort(400) + + +@app_views.route('/ratings', methods=['GET'], strict_slashes=False) +def get_all_ratings(): + """Get all ratings""" + from models.db import DBStorage + db = DBStorage() + try: + with db: + ratings = db.get_all_ratings() + ratings_data = [rating.to_dict() for rating in ratings] + return jsonify(ratings_data), 200 + except Exception as e: + abort(400) diff --git a/server-side/api/v1/views/users.py b/server-side/api/v1/views/users.py new file mode 100644 index 0000000..6868ebc --- /dev/null +++ b/server-side/api/v1/views/users.py @@ -0,0 +1,403 @@ +""" +Modules for users endpoints +""" +from api.v1.views import app_views +from api.v1.views import auth +from flask import abort, jsonify, request, abort, render_template, redirect, url_for, flash, session +import os +from uuid import uuid4 +from bcrypt import hashpw, gensalt, checkpw +import cloudinary +from cloudinary.uploader import upload +from dotenv import load_dotenv +from datetime import datetime, timedelta + +load_dotenv() + +CLOUDNAME = os.getenv("CLOUD_NAME") +API_KEY = os.getenv("API_KEY") +API_SECRET = os.getenv("API_SECRET") + +cloudinary.config( + cloud_name=CLOUDNAME, + api_key=API_KEY, + api_secret=API_SECRET +) + + +@app_views.route('/users', methods=['GET'], strict_slashes=False) +def get_users(): + """ GET /api/v1/users + Return: + - All users + """ + from models.db import DBStorage + db = DBStorage() + try: + with db: + users = db.find_all_users() + users_data = [{"user_id": user.user_id, "fullname": user.fullname, + "email": user.email, "verified": user.verified, "gender": user.gender, + "phone1": user.phone1, "about": user.about, "address": user.address, + "city": user.city, "town": user.town, "state": user.state, + "created_at": user.created_at, "updated_at": user.updated_at} for user in users] + return jsonify(users_data), 200 + except Exception as e: + abort(404) + + +@app_views.route('/users/', methods=['GET'], strict_slashes=False) +def get_user_by_id(user_id): + """ + - Get user based on user_id + """ + from models.db import DBStorage + db = DBStorage() + + # Check if user_id is None + try: + if user_id is None: + abort(404) + if user_id == 'me': + if request.current_user is None: + abort(404) + user = request.current_user + user_data = {"user_id": user.user_id, "fullname": user.fullname, + "about": user.about, "address": user.address, + "email": user.email, "verified": user.verified, "gender": user.gender, + "city": user.city, "town": user.town, "state": user.state, + "created_at": user.created_at, "updated_at": user.updated_at} + return jsonify(user_data), 200 + with db: + auth_user = request.current_user + user = db.find_user_by_id(user_id) + if user is None: + abort(404) + if auth_user is not None: + if auth_user.user_id != user.user_id: + return jsonify({"error": "Unauthorized"}), 401 + db.save() + return jsonify(user.to_dict()), 200 + except Exception as e: + # Log the exception for debugging purposes + print(f"Error: {e}") + # Return an error response + return jsonify({"error": "Not Found"}), 404 + + +@app_views.route('/users', methods=['POST'], strict_slashes=False) +def post_user(): + """ + - Post a new user + """ + from models.db import DBStorage + db = DBStorage() + user_data = {} + + user_fullname = request.form.get('fullname') + user_verified = request.form.get('verified') + user_email = request.form.get('email') + user_password = request.form.get('password') + user_gender = request.form.get('gender') + user_phone1 = request.form.get('phone1') + user_phone2 = request.form.get('phone2') + user_about = request.form.get('about') + user_address = request.form.get('address') + user_town = request.form.get('town') + user_city = request.form.get('city') + user_state = request.form.get('state') + + if user_fullname is None: + return jsonify({"error": "fullname missing"}), 400 + if user_email is None: + return jsonify({"error": "email missing"}), 400 + if user_password is None: + return jsonify({"error": "password missing"}), 400 + if user_gender is None: + return jsonify({"error": "gender missing"}), 400 + if user_phone1 is None: + return jsonify({"error": "phone1 missing"}), 400 + if user_about is None: + return jsonify({"error": "about missing"}), 400 + if user_address is None: + return jsonify({"error": "address missing"}), 400 + if user_town is None: + return jsonify({"error": "town missing"}), 400 + if user_city is None: + return jsonify({"error": "city missing"}), 400 + if user_state is None: + return jsonify({"error": "state missing"}), 400 + user_data['fullname'] = user_fullname + user_data['email'] = user_email + user_data['verified'] = user_verified + user_data['password'] = user_password + user_data['gender'] = user_gender + user_data['phone1'] = user_phone1 + user_data['phone2'] = user_phone2 + user_data['about'] = user_about + user_data['address'] = user_address + user_data['town'] = user_town + user_data['city'] = user_city + user_data['state'] = user_state + try: + with db: + hashed_password = hashpw( + user_data['password'].encode('utf-8'), gensalt()) + user_data['password'] = hashed_password + user = db.create_user(user_data) + print(f"User created successfully for {user.fullname}") + db.save() + return jsonify(user.to_dict()), 201 + except Exception as e: + abort(404) + + +@app_views.route('/users/login', methods=['POST'], strict_slashes=False) +def login_user(): + """ + - Login a user + """ + from models.db import DBStorage + db = DBStorage() + try: + user_email = request.form.get('email') + user_password = request.form.get('password') + if user_email is None: + return jsonify({"error": "email missing"}), 400 + if user_password is None: + return jsonify({"error": "password missing"}), 400 + with db: + user = db.find_user_by_email(user_email) + if user is None: + return jsonify({"error": "Invalid login details"}), 401 + if not checkpw(user_password.encode('utf-8'), user.password.encode('utf-8')): + return jsonify({"error": "Invalid login details"}), 401 + from api.v1.auth.session_db_auth import SessionDBAuth + session_auth = SessionDBAuth() + session_id = session_auth.create_session(user.user_id) + response = jsonify(user.to_dict()) + cookie_name = os.getenv('SESSION_NAME') + response.set_cookie(cookie_name, session_id) + db.save() + return response, 200 + except Exception as e: + abort(404) + + +@auth.route('/signup', methods=['GET'], strict_slashes=False) +def signup(): + """ + - Login a user + """ + return render_template('register.html') + + +@auth.route('/login', methods=['GET'], strict_slashes=False) +def login_page(): + """ + - Login a user + """ + return render_template('login.html') + + +@auth.route('/home', methods=['GET'], strict_slashes=False) +def get_home(): + """ + - fetch home page + """ + return render_template('index.html') + + +@auth.route('/user/login', methods=['POST'], strict_slashes=False) +def login_user(): + """ + - Login a user + """ + from models.db import DBStorage + db = DBStorage() + try: + user_email = request.form.get('email') + user_password = request.form.get('password') + if user_email is None: + flash("Email is missing", 'danger') + return redirect(url_for('auth.login_page')) + if user_password is None: + flash("Password is missing", 'danger') + return redirect(url_for('auth.login_page')) + with db: + user = db.find_user_by_email(user_email) + if user is None or not checkpw(user_password.encode('utf-8'), user.password.encode('utf-8')): + flash("Invalid login details!", 'danger') + return redirect(url_for('auth.login_page')) + from api.v1.auth.session_db_auth import SessionDBAuth + session_auth = SessionDBAuth() + session_id = session_auth.create_session(user.user_id) + response = redirect(url_for('auth.get_home')) + cookie_name = os.getenv('SESSION_NAME') + response.set_cookie(cookie_name, session_id) + db.save() + return response + except Exception as e: + flash("An error occurred", 'error') + return redirect(url_for('auth.login_page')) + + +@app_views.route('/users/logout', methods=['POST'], strict_slashes=False) +def logout_user(): + """ + - Logout a user + """ + try: + from api.v1.auth.session_db_auth import SessionDBAuth + session_auth = SessionDBAuth() + session_auth.destroy_session(request) + return jsonify({}), 200 + except Exception as e: + abort(404) + + +@app_views.route('/users/', methods=['POST'], strict_slashes=False) +def put_user(user_id): + """ + - Update a user + """ + from models.db import DBStorage + db = DBStorage() + try: + user_email = request.form.get('email') + user_password = request.form.get('password') + new_password = request.form.get('new_password') + + if user_email is None: + return jsonify({"error": "email missing"}), 400 + if user_password is None: + return jsonify({"error": "password missing"}), 400 + if new_password is None: + return jsonify({"error": "new_password missing"}), 400 + with db: + auth_user = request.current_user + user = db.find_user_by_id(user_id) + if user is None: + abort(404) + if not checkpw(user_password.encode('utf-8'), user.password.encode('utf-8')): + return jsonify({"error": "wrong password"}), 401 + if auth_user is not None: + if auth_user.user_id != user.user_id: + return jsonify({"error": "Unauthorized"}), 401 + hashed_password = hashpw(new_password.encode('utf-8'), gensalt()) + user.password = hashed_password + db.save() + return jsonify(user.to_dict()), 201 + except Exception as e: + abort(401) + + +@app_views.route('/users/', methods=['DELETE'], strict_slashes=False) +def delete_user(user_id): + """ + - Delete a user + """ + from models.db import DBStorage + db = DBStorage() + try: + with db: + auth_user = request.current_user + user = db.find_user_by_id(user_id) + sess = db.find_session_by_id_by_user_id(user_id) + + if user is None: + return jsonify({"error": "User not found"}), 404 + if sess is None: + return jsonify({"error": "No session found for that user"}), 404 + if auth_user is not None: + if auth_user.user_id != user.user_id: + return jsonify({"error": "Unauthorized"}), 401 + + db.delete_session(sess) + db.delete_user(user) + db.save() + return jsonify({}), 204 # 204 No Content for successful deletion + except Exception as e: + return jsonify({"error": "Internal Server Error"}), 500 + + +def save_picture(form_picture): + """ + - Save the picture + """ + try: + pics_id = str(uuid4()) + _, f_ext = os.path.splitext(form_picture.filename) + + allowed_extensions = {'.png', '.jpg', '.jpeg'} + + if f_ext.lower() in allowed_extensions: + picture_fn = pics_id + f_ext + + # Upload image to cloudinary + res = upload(form_picture, public_id=picture_fn) + + # Extract the public ID from the Cloudinary response + cloudinary_public_id = res['public_id'] + + # We return the public ID incase we want to store it in the db + return cloudinary_public_id + else: + return None + except Exception as e: + print(e) + + +@app_views.route('/users/', methods=['PUT'], strict_slashes=False) +def update_user_by_user_id(user_id): + """ + - Update a user + """ + from models.db import DBStorage + db = DBStorage() + user_data = {} + + user_fullname = request.form.get('fullname') + user_phone1 = request.form.get('phone1') + user_phone2 = request.form.get('phone2') + user_about = request.form.get('about') + user_address = request.form.get('address') + user_town = request.form.get('town') + user_city = request.form.get('city') + user_state = request.form.get('state') + user_photo = request.files.get('photo') + + pics_fn = save_picture(user_photo) + + user_data['fullname'] = user_fullname + user_data['phone1'] = user_phone1 + user_data['phone2'] = user_phone2 + user_data['about'] = user_about + user_data['address'] = user_address + user_data['town'] = user_town + user_data['city'] = user_city + user_data['state'] = user_state + user_data['photo'] = pics_fn + try: + with db: + auth_user = request.current_user + user = db.find_user_by_id(user_id) + if user is None: + abort(404) + if auth_user is not None: + if auth_user.user_id != user.user_id: + return jsonify({"error": "Unauthorized"}), 401 + user.about = user_data['about'] + user.address = user_data['address'] + user.city = user_data['city'] + user.town = user_data['town'] + user.state = user_data['state'] + user.fullname = user_data['fullname'] + user.phone1 = user_data['phone1'] + user.phone2 = user_data['phone2'] + user.photo = user_data['photo'] + db.save() + return jsonify(user.to_dict()), 200 + except Exception as e: + print(e) + abort(404) diff --git a/server-side/models/__init__.py b/server-side/models/__init__.py new file mode 100644 index 0000000..d3f5a12 --- /dev/null +++ b/server-side/models/__init__.py @@ -0,0 +1 @@ + diff --git a/server-side/models/db.py b/server-side/models/db.py new file mode 100644 index 0000000..db824be --- /dev/null +++ b/server-side/models/db.py @@ -0,0 +1,412 @@ +from os import getenv +from dotenv import load_dotenv +from sqlalchemy import create_engine +from sqlalchemy.orm import sessionmaker, scoped_session +from models.tables import Base +from sqlalchemy.pool import QueuePool +from sqlalchemy import inspect + +load_dotenv() + +database = getenv("dbName") +user = getenv("dbUser") +host = getenv("dbHost") +password = getenv("dbPasswd") +port = getenv("dbPort") + + +def create_engine_with_session(): + """Create SQLAlchemy engine and scoped session.""" + engine = create_engine( + f'mysql+mysqldb://{user}:{password}@{host}:{port}/{database}', pool_pre_ping=True, poolclass=QueuePool, pool_size=5, max_overflow=10) + session_factory = sessionmaker(bind=engine, expire_on_commit=False) + Session = scoped_session(session_factory) + return engine, Session + + +class DBStorage: + def __init__(self): + """Initialize the DBStorage instance.""" + self.__engine, self.__session = create_engine_with_session() + Base.metadata.create_all(self.__engine) + + def __enter__(self): + return self + + def __exit__(self, exc_type, exc_value, traceback): + self.close() + + def all(self, cls=None): + """Return a dictionary of all objects of a given class.""" + objects = {} + for name, class_ in inspect.getmembers(Base.classes): + if cls is None or cls == class_: + objs = self.__session.query(class_).all() + for obj in objs: + key = f'{type(obj).__name__}.{obj.id}' + objects[key] = obj + return objects + + def new(self, obj): + """Add a new object to the session.""" + if obj: + self.__session.add(obj) + + def save(self): + """Commit changes to the database.""" + try: + self.__session.commit() + except Exception as e: + print(f"Error during save: {e}") + self.__session.rollback() + raise e + + def delete(self, obj=None): + """Delete an object from the session.""" + try: + if obj: + self.__session.delete(obj) + except Exception as e: + print(f"Error during delete: {e}") + self.__session.rollback() + raise e + + def reload(self): + """Create all tables and reset the session.""" + Base.metadata.create_all(self.__engine) + self.__session = scoped_session(sessionmaker( + bind=self.__engine, expire_on_commit=False)) + + def close(self): + """Close the session.""" + self.__session.close() + + def find_user_by_email(self, email): + """Find a user by email.""" + from models.tables import User + try: + return self.__session.query(User).filter_by(email=email).first() + except Exception as e: + print(f"Error during find_user_by_email: {e}") + return None + + def find_user_by_id(self, user_id): + """Find a user by id.""" + from models.tables import User + try: + return self.__session.query(User).filter_by(user_id=user_id).first() + except Exception as e: + print(f"Error during find_user_by_id: {e}") + return None + + def find_all_users(self): + """Find all users.""" + from models.tables import User + try: + return self.__session.query(User).all() + except Exception as e: + print(f"Error during find_all_users: {e}") + return None + + def create_user(self, user_data): + """Create a user.""" + from models.tables import User + try: + user = User(**user_data) + self.new(user) + self.save() + return user + except Exception as e: + print(f"Error during create_user: {e}") + return None + + def create_session(self, session_data): + """Create a session.""" + from models.tables import UserSession + try: + session = UserSession(**session_data) + self.new(session) + self.save() + return session + except Exception as e: + print(f"Error during create_session: {e}") + return None + + def find_session_by_id(self, session_id): + """Find a session by id.""" + from models.tables import UserSession + try: + return self.__session.query(UserSession).filter_by(session_id=session_id).first() + except Exception as e: + print(f"Error during find_session_by_id: {e}") + return None + + def find_session_by_id_by_user_id(self, user_id): + """Find a session by user_id.""" + from models.tables import UserSession + try: + return self.__session.query(UserSession).filter_by(user_id=user_id).first() + except Exception as e: + print(f"Error during find_session_by_id: {e}") + return None + + def delete_session(self, session): + """Delete a session.""" + from models.tables import UserSession + try: + self.delete(session) + self.save() + except Exception as e: + print(f"Error during delete_session: {e}") + + def delete_user(self, user): + """Delete a user.""" + from models.tables import User + try: + self.delete(user) + self.save() + except Exception as e: + print(f"Error during delete_user: {e}") + + def create_item(self, item_data): + """Create an item.""" + from models.tables import Item + try: + item = Item(**item_data) + self.new(item) + self.save() + return item + except Exception as e: + print(f"Error during create_item: {e}") + return None + + def get_items(self): + """Get all items.""" + from models.tables import Item + try: + return self.__session.query(Item).all() + except Exception as e: + print(f"Error during get_items: {e}") + return None + + def get_items_by_user_id(self, user_id): + """ + - Retreive all items by user_id + """ + from models.tables import Item + try: + return self.__session.query(Item).filter_by(user_id=user_id).all() + except Exception as e: + print(f"Error during get_items_by_user_id: {e}") + return None + + def item_by_item_id(self, item_id): + """ + - Retreive an item by item_id + """ + from models.tables import Item + try: + return self.__session.query(Item).filter_by(item_id=item_id).first() + except Exception as e: + print(f"Error during get_item_by_item_id: {e}") + return None + + def find_items_by_item_id(self, item_id): + """ + - Retreive an item by item_id + """ + from models.tables import Item + try: + return self.__session.query(Item).filter_by(item_id=item_id).first() + except Exception as e: + print(f"Error during get_item_by_item_id: {e}") + return None + + def update_item_by_item_id(self, item_id, item_data): + """ + - Update an item by item_id + """ + from models.tables import Item + try: + item = self.__session.query( + Item).filter_by(item_id=item_id).first() + for key, value in item_data.items(): + setattr(item, key, value) + self.save() + return item + except Exception as e: + print(f"Error during update_item_by_item_id: {e}") + return None + + def delete_item_by_item_id(self, item_id): + """ + - Delete an item by item_id + """ + from models.tables import Item + try: + item = self.__session.query( + Item).filter_by(item_id=item_id).first() + self.delete(item) + self.save() + except Exception as e: + print(f"Error during delete_item_by_item_id: {e}") + return None + + def create_rating(self, rating_data): + """ + - Create a rating + """ + from models.tables import Rating + try: + rating = Rating(**rating_data) + self.new(rating) + self.save() + return rating + except Exception as e: + print(f"Error during create_rating: {e}") + return None + + def get_all_ratings(self): + """ + - Retreive all ratings + """ + from models.tables import Rating + try: + return self.__session.query(Rating).all() + except Exception as e: + print(f"Error during get_all_ratings: {e}") + return None + + def get_ratings_by_user_id(self, user_id): + """ + - Retrieve ratings based on user_id + """ + from models.tables import Rating + try: + return self.__session.query(Rating).filter_by(user_id=user_id).first() + except Exception as e: + print(f"Error during retriving ratings: {e}") + return None + + def create_like(self, like_data): + """ + - Create a like + """ + from models.tables import Like + try: + like = Like(**like_data) + self.new(like) + self.save() + return like + except Exception as e: + print(f"Error during create_like: {e}") + return None + + def get_like_by_item_id(self, item_id): + """ + - Retrieve like by item_id + """ + from models.tables import Like + try: + return self.__session.query(Like).filter_by(item_id=item_id).first() + except Exception as e: + print(f"Error during get_like_by_user_id: {e}") + return None + + + def get_user_like(self, item_id, user_id): + """ + get a specified user like + """ + from models.tables import Like + try: + results = self.__session.query(Like).filter_by(item_id=item_id).all() + for result in results: + if result.user_id == user_id: + return result + except Exception as e: + print(f"Error during error fetching like data: {e}") + return None + + def get_like_by_item_id_all(self, item_id): + """ + - Retrieve like by item_id + """ + from models.tables import Like + try: + return self.__session.query(Like).filter_by(item_id=item_id).all() + except Exception as e: + print(f"Error during get_like_by_user_id: {e}") + return None + + def create_comment(self, comment_data): + """ + - Create a comment + """ + from models.tables import Comment + try: + comment = Comment(**comment_data) + self.new(comment) + self.save() + return comment + except Exception as e: + print(f"Error during create_comment: {e}") + return None + + def get_comments_by_comment_id(self, comment_id): + """ + - Retrieve comment by comment_id + """ + from models.tables import Comment + try: + return self.__session.query(Comment).filter_by(comment_id=comment_id).first() + except Exception as e: + print(f"Error during get_comment: {e}") + return None + + def get_comments_by_item_id(self, item_id): + """ + - Retrieve comment by item_id + """ + from models.tables import Comment + try: + return self.__session.query(Comment).filter_by(item_id=item_id).all() + except Exception as e: + print(f"Error during get_comment: {e}") + return None + + def create_message(self, message_data): + """ + - Create new message + """ + from models.tables import Chat + try: + message = Chat(**message_data) + self.new(message) + self.save() + return message + except Exception as e: + print(f"Error during create_message: {e}") + return None + + def get_messages_by_message_id(self, message_id): + """ + - Retreive a message based on their messsage_id + """ + from models.tables import Chat + try: + return self.__session.query(Chat).filter_by(message_id=message_id).first() + except Exception as e: + print(f"Error during get_messages: {e}") + return None + + def get_messages_by_user_id(self, sender_id): + """ + - Retreive all messages based on their user_id + """ + from models.tables import Chat + try: + return self.__session.query(Chat).filter_by(sender_id=sender_id).all() + except Exception as e: + print(f"Error during get_messages: {e}") + return None diff --git a/server-side/models/tables.py b/server-side/models/tables.py new file mode 100644 index 0000000..b8e78c9 --- /dev/null +++ b/server-side/models/tables.py @@ -0,0 +1,238 @@ +from uuid import uuid4 +import datetime +from sqlalchemy import Column, String, Boolean, Enum, Text, TIMESTAMP, Index, Integer, ForeignKey, CheckConstraint, DateTime +from sqlalchemy.sql import func +from sqlalchemy.orm import relationship, DeclarativeBase +import os + + +class Base(DeclarativeBase): + """Base class for all models""" + pass + + +class BaseModel: + """Base Model class""" + created_at = Column(DateTime, nullable=False, + default=datetime.datetime.utcnow()) + updated_at = Column(DateTime, nullable=False, + default=datetime.datetime.utcnow(), onupdate=datetime.datetime.utcnow()) + + +class User(BaseModel, Base): + """User class""" + __tablename__ = 'users' + user_id = Column(String(60), nullable=False, + primary_key=True, default=lambda: str(uuid4())) + fullname = Column(String(30), nullable=False) + verified = Column(Boolean, nullable=False, default=False) + email = Column(String(225), nullable=False, unique=True) + password = Column(String(225), nullable=False) + gender = Column(Enum('Male', 'Female', 'Other'), nullable=False) + phone1 = Column(String(15), nullable=False) + phone2 = Column(String(15)) + about = Column(Text) + address = Column(String(50), nullable=False) + town = Column(String(30), nullable=False) + city = Column(String(30), nullable=False) + state = Column(String(20), nullable=False) + photo = Column(String(225), nullable=False, default=os.path.join(os.path.dirname(__file__), '..', '..', 'client-side', 'assets', 'default.png')) + items = relationship('Item', back_populates='user', cascade='all, delete-orphan') + ratings = relationship('Rating', back_populates='user', cascade='all, delete-orphan') + likes = relationship('Like', back_populates='user', cascade='all, delete-orphan') + comments = relationship('Comment', back_populates='user', cascade='all, delete-orphan') + # Define the sent_messages relationship + sent_messages = relationship('Chat', foreign_keys='Chat.sender_id', + back_populates='sender', cascade='all, delete-orphan') + + # Define the received_messages relationship + received_messages = relationship( + 'Chat', foreign_keys='Chat.receiver_id', back_populates='receiver', cascade='all, delete-orphan') + + __table_args__ = (Index('idx_users_user_id', 'user_id'),) + + def to_dict(self): + """Convert user object to dictionary""" + user_dict = { + 'user_id': self.user_id, + 'fullname': self.fullname, + 'verified': self.verified, + 'email': self.email, + 'gender': self.gender, + 'phone1': self.phone1, + 'phone2': self.phone2, + 'about': self.about, + 'address': self.address, + 'town': self.town, + 'city': self.city, + 'state': self.state, + } + return user_dict + + +class Item(BaseModel, Base): + """Item class""" + __tablename__ = 'items' + item_id = Column(String(36), nullable=False, primary_key=True, + default=lambda: str(uuid4())) + user_id = Column(String(36), ForeignKey('users.user_id', ondelete='CASCADE'), + nullable=False) + item_name = Column(String(20), nullable=False) + price = Column(Integer, nullable=False) + description = Column(String(200), nullable=False) + photo1 = Column(String(225), nullable=False) + photo2 = Column(String(225)) + photo3 = Column(String(225)) + sold = Column(Boolean, nullable=False, default=False) + created_at = Column(TIMESTAMP, default=func.now(), nullable=False) + updated_at = Column(TIMESTAMP, default=func.now(), + onupdate=func.now(), nullable=False) + + # Define a relationship with the User class + user = relationship('User', back_populates='items') + likes = relationship('Like', back_populates='items') + comments = relationship('Comment', back_populates='items') + + __table_args__ = (Index('idx_items_item_id', 'item_id'),) + + def to_dict(self): + """Convert item object to dictionary""" + item_dict = { + 'user_id': self.user_id, + 'item_name': self.item_name, + 'description': self.description, + 'price': self.price, + 'photo1': self.photo1, + 'photo2': self.photo2, + 'photo3': self.photo3, + 'sold': self.sold, + } + return item_dict + + +class Comment(BaseModel, Base): + """Comment class""" + __tablename__ = 'comments' + comment_id = Column(String(36), nullable=False, primary_key=True, + default=lambda: str(uuid4())) + commenter = Column(String(36), ForeignKey( + 'users.user_id', ondelete='CASCADE'), nullable=False) + item_id = Column(String(36), ForeignKey( + 'items.item_id', ondelete='CASCADE'), nullable=False) + comment = Column(Text, nullable=False) + created_at = Column(TIMESTAMP, default=func.now(), nullable=False) + updated_at = Column(TIMESTAMP, default=func.now(), + onupdate=func.now(), nullable=False) + + # Define relationships with User and Item classes + user = relationship('User', back_populates='comments') + items = relationship('Item', back_populates='comments') + + def to_dict(self): + """Convert rating object to dictionary""" + comment_dict = { + 'comment_id': self.comment_id, + 'item_id': self.item_id, + 'commenter': self.commenter, + 'comment': self.comment, + 'created_at': self.created_at, + } + return comment_dict + + +class Chat(BaseModel, Base): + """Chat class""" + __tablename__ = 'chats' + message_id = Column(String(36), nullable=False, primary_key=True, + default=lambda: str(uuid4())) + sender_id = Column(String(36), ForeignKey('users.user_id', ondelete='CASCADE'), + nullable=False) + receiver_id = Column(String(36), ForeignKey( + 'users.user_id', ondelete='CASCADE'), nullable=False) + message = Column(Text, nullable=False) + created_at = Column(TIMESTAMP, default=func.now(), nullable=False) + updated_at = Column(TIMESTAMP, default=func.now(), + onupdate=func.now(), nullable=False) + + # Define relationships with User classes + sender = relationship('User', foreign_keys=[ + sender_id], back_populates='sent_messages') + receiver = relationship('User', foreign_keys=[ + receiver_id], back_populates='received_messages') + + def to_dict(self): + """ + - Convert chat object to dictionary + """ + chat_data = { + 'message_id': self.message_id, + 'sender_id': self.sender_id, + 'receiver_id': self.receiver_id, + 'message': self.message, + 'created_at': self.created_at, + } + return chat_data + + +class Like(BaseModel, Base): + """Like class""" + __tablename__ = 'likes' + + item_id = Column(String(36), ForeignKey('items.item_id', ondelete='CASCADE'), + nullable=False, primary_key=True) + user_id = Column(String(36), ForeignKey('users.user_id', ondelete='CASCADE'), + nullable=False, primary_key=True) + liked = Column(Boolean, nullable=False) + created_at = Column(TIMESTAMP, default=func.now(), nullable=False) + updated_at = Column(TIMESTAMP, default=func.now(), + onupdate=func.now(), nullable=False) + + # Define relationships with User and Item class + user = relationship('User', back_populates='likes') + items = relationship('Item', back_populates='likes') + + def to_dict(self): + """Convert rating object to dictionary""" + like_dict = { + 'user_id': self.user_id, + 'item_id': self.item_id, + 'liked': self.liked, + 'created_at': self.created_at, + } + return like_dict + + +class Rating(Base): + """Rating class""" + __tablename__ = 'ratings' + + rating_id = Column(String(36), primary_key=True, + default=lambda: str(uuid4())) + user_id = Column(String(36), ForeignKey( + 'users.user_id', ondelete='CASCADE'), nullable=False) + rating = Column(Enum('1', '2', '3', '4', '5'), nullable=False) + comment = Column(String(225)) + created_at = Column(TIMESTAMP, default=func.now(), nullable=False) + + # Define a relationship with the User class + user = relationship('User', back_populates='ratings') + + def to_dict(self): + """Convert rating object to dictionary""" + user_dict = { + 'user_id': self.user_id, + 'rating': self.rating, + 'comment': self.comment, + } + return user_dict + + +class UserSession(Base): + """ + UserSession model class + """ + __tablename__ = 'user_sessions' + + user_id = Column(String(60), nullable=False) + session_id = Column(String(60), primary_key=True, nullable=False) + created_at = Column(TIMESTAMP, default=func.now(), nullable=False) diff --git a/server-side/requirements.txt b/server-side/requirements.txt new file mode 100644 index 0000000..589302b --- /dev/null +++ b/server-side/requirements.txt @@ -0,0 +1,10 @@ +Flask==3.0.0 +Flask-Cors==4.0.0 +Jinja2==3.1.2 +mysqlclient==2.1.1 +pycodestyle==2.6.0 +python-dotenv==1.0.0 +requests==2.18.4 +SQLAlchemy==2.0.23 +Werkzeug==3.0.1 + diff --git a/server-side/tradequick.sql b/server-side/tradequick.sql index 374d813..ce72981 100644 --- a/server-side/tradequick.sql +++ b/server-side/tradequick.sql @@ -1,5 +1,5 @@ -- The MySQL syntax for implementing the database schema for tradeQuick application --- Create database and use it +-- Create database and make use of it CREATE DATABASE IF NOT EXISTS tradequick; USE tradequick; @@ -95,9 +95,9 @@ CREATE TABLE IF NOT EXISTS ratings ( rating_id VARCHAR(36) NOT NULL, user_id VARCHAR(36) NOT NULL, - rating INT CHECK (rating > 0 AND rating <= 5) NOT NULL, + rating ENUM('1', '2', '3', '4', '5') NOT NULL, comment VARCHAR(225), created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, PRIMARY KEY (rating_id), FOREIGN KEY (user_id) REFERENCES users (user_id) - ); \ No newline at end of file + );