diff --git a/.env b/.env new file mode 100644 index 0000000..3445257 --- /dev/null +++ b/.env @@ -0,0 +1,6 @@ +POSTGRES_USER=acacia +POSTGRES_PASSWORD=acacia +POSTGRES_DB=acacia +POSTGRES_HOST=db +PGDATA=/tmp/data +DB_NAME=acacia \ No newline at end of file diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..ebe3fdc --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,27 @@ +name: CI + +on: + pull_request: + branches: + - master + - release/* + - develop + +jobs: + test: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@master + - name: Setup enviroment + run: docker-compose up -d --build + - name: Run tests + run: docker exec acacia_backend bash -c "cd src/ && coverage run manage.py test && coverage xml -o cov.xml" + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v1.0.2 + with: + token: ${{secrets.CODECOV_TOKEN}} + file: ./src/cov.xml + flags: unittests + name: codecov-umbrella \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8ad12b6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,11 @@ +### Django ### +*.log +*.pot +*.pyc +__pycache__/ +local_settings.py +db.sqlite3 +media +.vscode/ +env/ +migrations/ \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..ea82bd9 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,49 @@ +# Código de Conduta + +## Propósito +O projeto é mantido por estudantes durante a execução das disciplinas +de Engenharia de Produto de Software e Métodos de Desenvolvimento de Software +da Universidade de Brasília. +Sendo assim, frisamos a importância de promover um ambiente aberto e acolhedor, +nós mantenedores e contribuidores nos comprometemos a fazer participação em nosso +projeto e nossa comunidade provendo uma experiência livre de assédio para todos. + + +## Nossas Responsabilidades +Os mantenedores desse projeto são responsáveis por prestar esclarecimentos em +casos de dúvidas relacionadas ao código de conduta e também por ações em resposta +a comportamentos inadequados. +No caso de testemunhar comportamentos inadequados, +estes devem ser reportados imediatamente, sendo os responsáveis do repositório +obrigados a manter confidencialidade sobre a pessoa que reportar. + +## Exemplos de comportamentos esperados e que contribuem com o projeto + +* Uso de linguagem acolhedora e inclusiva +* Respeito aos diferentes pontos de vista +* Aceitar críticas construtivas +* Demonstrar empatia com os membros da comunidade + +## Exemplos de comportamentos inaceitáveis + +* Uso de conotações sexuais +* Comentários depreciativos que ataquem pessoas ou grupos +* Assédio público ou privado +* Publicação de conteúdo privado de terceiro sem prévia autorização +* Outras condutas consideradas inapropriadas em um ambiente profissional + + +## Escopo + +Esse Código de Conduta é aplicado dentro do projeto e em locais públicos onde +um indivíduo esteja representando o projeto ou sua comunidade. Exemplos +são um e-mail oficial sobre o projeto, ou participação em eventos como representante. + + +## Atribuição + +Esse código de conduta é uma adaptação de [Contributor Covenant][homepage], version 1.4, +disponível em [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..8d510fc --- /dev/null +++ b/Dockerfile @@ -0,0 +1,11 @@ +FROM python:3.7 + +ENV PYTHONUNBUFFERED 1 + +RUN mkdir /code +WORKDIR /code + +COPY requirements.txt ./ +RUN pip install --no-cache-dir -r requirements.txt + +COPY . . diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0ad25db --- /dev/null +++ b/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published + by the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +. diff --git a/README.md b/README.md deleted file mode 100644 index fcaf7a7..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# 2019.2-TimeBolinho \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..20f698e --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,33 @@ +version: '3.7' + +volumes: + pgdata: + +services: + + db: + image: postgres + volumes: + - postgres_data:/var/lib/postgresql/data + + acacia-back: + container_name: acacia_backend + build: + context: . + dockerfile: Dockerfile + command: bash -c " + cd src/ && + python manage.py makemigrations && + python manage.py migrate && + chmod +x scripts/create_superuser.sh && + ./scripts/create_superuser.sh && + python manage.py runserver 0.0.0.0:8080" + ports: + - "8080:8080" + volumes: + - .:/code + depends_on: + - db + +volumes: + postgres_data: diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md new file mode 100644 index 0000000..1480f99 --- /dev/null +++ b/docs/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Como contribuir + +Antes de enviar uma alteração para este repositório, +coloque-se como responsável por ela via issues do github. Verifique se você +está seguindo nossa política de branches e commits e se sua branch segue a checklist de +pull request: +* Os commits seguem o padrão de estilo desse projeto. +* A branch está conforme nossa política. +* Houve sucesso na integração continua. +* Os critérios de aceitação foram cumpridos. +* Foram realizados testes (sendo o caso) que cobrem as funcionalidades entregues. + + +Este repositório possui um código de conduta que deverá ser seguido em todas as +interações com ele. + +## Processo de criação de issues + +1. Verifique se não existe issue que já adereça o que você pretender colocar. +2. Ao criar a issue, espere a resposta de uns dos responsáveis pelo repositório +para sua aprovação. + +## Processo de Pull Request + +1. Execute em sua máquina os testes que existiam antes da sua alteração, e apenas +envie o Pull Request caso ainda estejam passando. +2. Espere o processo da integração continua, como uma segunda verificação. +3. Ao criar o Pull Request, siga o template disponível em docs/pull_request_template.md +4. Selecione um desenvolvedor do projeto para revisar o seu Pull Request, além disso ele +será revisado pelo scrum master,apenas +então ele poderá ser aceito. + + + +Obrigada por querer contribuir com o projeto <3! diff --git a/docs/README.md b/docs/README.md index fcaf7a7..fc2049b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,71 @@ -# 2019.2-TimeBolinho \ No newline at end of file +

+ +[![codecov](https://codecov.io/gh/fga-eps-mds/2019.2-Acacia/branch/develop/graph/badge.svg)](https://codecov.io/gh/fga-eps-mds/2019.2-Acacia) + +## Visão geral + +Acácia propõe-se a facilitar a criação de uma comunidade voluntária em torno da agricultura urbana, diminuindo o desperdício de comida e difundindo conhecimento em plantio e colheita neste ambiente. Para tal, a ferramenta conecta pessoas que possuem plantas frutíferas em local urbano, voluntários de colheita e beneficiários que buscam doações de alimentos, para que estes possam trabalhar juntos, com colheita colaborativa. + +Este repositório tem como objetivo o desenvolvimento, a manutenção e a evolução do produto nomeado **Acácia**, uma aplicação web, que segue o conceito [Mobile first](https://digitalks.com.br/artigos/mobile-first-e-o-que-voce-realmente-precisa-saber-respeito/) e tem o intuito de auxiliar no processo de colheita colaborativa em áreas urbanas. Ele é baseado em um sistema já existente, o [Saskatoon](https://github.com/tiagovaz/saskatoon) utilizado pelo coletivo [LES FRUITS DÉFENDUS](https://santropolroulant.org/en/what-is-the-roulant/collectives/fruits-defendus/) em Montreal - que facilita a relação entre proprietários de árvores frutíferas, voluntários para colheita e beneficiários das doações dessas frutas, visando a redução do desperdício de comida. + + + +## Como contribuir + + + +Para contribuir com este projeto basta seguir: + +- [Guia de Contribuição](https://fga-eps-mds.github.io/2019.2-Acacia/#/contributing) + +- [Código de Conduta](https://fga-eps-mds.github.io/2019.2-Acacia/#/code-of-conduct) + +- [Guia de Instalação](#guia-de-instalação) + +- [Políticas de Contribuição](https://fga-eps-mds.github.io/2019.2-Acacia/#/policies) + +- [Template para criação de issues](https://github.com/fga-eps-mds/2019.2-Acacia/tree/develop/.github/ISSUE_TEMPLATE) + +- [Template para criação de pull requests](https://github.com/fga-eps-mds/2019.2-Acacia/blob/develop/.github/PULL_REQUEST_TEMPLATE.md) + + + +## Guia de Instalação + + + +Essa aplicação tem seu ambiente configurado através de conteiners [Docker](https://www.docker.com), portanto, tem como pré-requisitos a instalação do [Docker](https://www.docker.com/get-started) e [Docker-compose](https://docs.docker.com/compose/install/). + +Também é necessário ter o [Git](https://git-scm.com) instalado para clonar o repositório. + + + +#### Back-end: + +Clonar o repositório: + + + +`git clone https://github.com/fga-eps-mds/2019.2-Acacia.git` + + + +Execução do conteiner: + + + +`docker-compose up` + + + +Após esses passos a aplicação deverá estar acessível em: + + + +`localhost:8080` + + + +#### Front-end: + +Para instalar a camada front-end da aplicação basta seguir os passos de instalação descritos [aqui](https://github.com/fga-eps-mds/2019.2-Acacia-Frontend) \ No newline at end of file diff --git a/docs/_sidebar.md b/docs/_sidebar.md deleted file mode 100644 index 0d3a4a8..0000000 --- a/docs/_sidebar.md +++ /dev/null @@ -1,5 +0,0 @@ - - -* [Home](/) -* [Políticas do Repositório](policies.md) -* [Termo de Abertura](project_charter.md) diff --git a/docs/img/logo.svg b/docs/img/logo.svg new file mode 100644 index 0000000..2eced04 --- /dev/null +++ b/docs/img/logo.svg @@ -0,0 +1 @@ +Ativo 4 \ No newline at end of file diff --git a/docs/img/monocromatica_1.svg b/docs/img/monocromatica_1.svg new file mode 100644 index 0000000..d25c38f --- /dev/null +++ b/docs/img/monocromatica_1.svg @@ -0,0 +1,3 @@ + + + diff --git a/docs/img/monocromatica_2.svg b/docs/img/monocromatica_2.svg new file mode 100644 index 0000000..956cdc4 --- /dev/null +++ b/docs/img/monocromatica_2.svg @@ -0,0 +1,3 @@ + + + diff --git "a/docs/img/svg_monocrom\303\241tica_black_background.svg" "b/docs/img/svg_monocrom\303\241tica_black_background.svg" new file mode 100644 index 0000000..45ea6b7 --- /dev/null +++ "b/docs/img/svg_monocrom\303\241tica_black_background.svg" @@ -0,0 +1 @@ +Ativo 8 \ No newline at end of file diff --git "a/docs/img/svg_monocrom\303\241tica_blue_background.svg" "b/docs/img/svg_monocrom\303\241tica_blue_background.svg" new file mode 100644 index 0000000..64e0b59 --- /dev/null +++ "b/docs/img/svg_monocrom\303\241tica_blue_background.svg" @@ -0,0 +1 @@ +Ativo 9 \ No newline at end of file diff --git "a/docs/img/svg_monocrom\303\241tica_white_background.svg" "b/docs/img/svg_monocrom\303\241tica_white_background.svg" new file mode 100644 index 0000000..7548b8f --- /dev/null +++ "b/docs/img/svg_monocrom\303\241tica_white_background.svg" @@ -0,0 +1 @@ +Ativo 6 \ No newline at end of file diff --git a/docs/img/wordmark_1.svg b/docs/img/wordmark_1.svg new file mode 100644 index 0000000..b8c86b5 --- /dev/null +++ b/docs/img/wordmark_1.svg @@ -0,0 +1 @@ +Ativo 1ACÁCIA \ No newline at end of file diff --git a/docs/img/wordmark_1_white.svg b/docs/img/wordmark_1_white.svg new file mode 100644 index 0000000..5fe4afa --- /dev/null +++ b/docs/img/wordmark_1_white.svg @@ -0,0 +1 @@ +Ativo 22ACÁCIA \ No newline at end of file diff --git a/docs/img/wordmark_2.svg b/docs/img/wordmark_2.svg new file mode 100644 index 0000000..4ab372d --- /dev/null +++ b/docs/img/wordmark_2.svg @@ -0,0 +1 @@ +Ativo 2ACÁCIA \ No newline at end of file diff --git a/docs/img/wordmark_2_white.svg b/docs/img/wordmark_2_white.svg new file mode 100644 index 0000000..a339f14 --- /dev/null +++ b/docs/img/wordmark_2_white.svg @@ -0,0 +1 @@ +Ativo 23ACÁCIA \ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 2fcfc95..0000000 --- a/docs/index.html +++ /dev/null @@ -1,22 +0,0 @@ - - - - - Document - - - - - - -
- - - - diff --git a/docs/policies.md b/docs/policies.md deleted file mode 100644 index 0715aee..0000000 --- a/docs/policies.md +++ /dev/null @@ -1,144 +0,0 @@ -# Políticas do Repositório -## Histórico de versão - -| Data | Versão | Modificação | Autor | -| :- | :- | :- | :- | -| 23/08/2019 | 1.0 | Criação da primeira versão do documento | Vítor Cardoso | -| 03/09/2019 | 1.1 | Tradução do documento para português | Vítor Cardoso | - -## Introdução - -Este documento tem como objetivo explicar os procedimentos a serem feitos para que as políticas deste repositório sejam seguidas adequadamente. - -Aqui se encontram: - -- Política de Branch -- Política de Commits - -## Políticas de Branch - -Branches devem seguir as seguintes regras explicadas neste tópico: - -Breve explicação sobre o fluxo de trabalho: - -- A branch **master** representa uma versão estável do produto, contendo código já testado e versionado, pronto para ser entregue ao usuário final ou cliente. Essa branch parte da branch **develop** através de pull requests aprovados no fim de cada release. - - Regras: - - 1. Existe apenas uma branch **master**. - 2. **Não** são permitidos commits feitos diretamente na **master**. - - -- A branch **develop** contém a versão mais atualizada do código que está sendo desenvolvido. Essa branch está sempre sincronizada com a **master** e é base para as branches **feature**. - - Regras: - - 1. Existe apenas uma branch **develop**. - 2. Essa branch está sempre sincronizada com a branch **master**. - - -- As branches **feature** representam as funcionalidades do sistema a serem desenvolvidas, elas devem ter a branch **develop** como sua origem e fim. - - Regras: - - 1. Essa branch sempre é criada a partir da branch **develop**. - 2. Essa branch sempre é mesclada à branch **develop**. - - Regras de nomenclatura: - - `feature/issueID-titulo-da-issue` - - -- A branch **release** representa o conjunto de funcionalidades provenientes de um ponto específico da branch **develop**. Essa branch contém funcionalidades prontas que, provavelmente, estarão presentes na próxima versão estável do produto. Apenas **bug fixes** são permitidos nessa branch. - - Regras: - - 1. Essa branch sempre é criada a partir da branch **develop**. - 2. Essa branch sempre é mesclada às branches **develop** e **master**. - 3. Essa branch aceita apenas mesclagens de branches do tipo **bugfix**. - - Regras de nomenclatura: - - `release/vNúmero-da-versão` - - - - -- As branches do tipo **bugfix** são utilizadas para implementar soluções para bugs, encontrados através de testes realizados em releases específicas, na branch **release**. Isso significa que a branch **bugfix** deve ter a branch **release** como sua origem e fim. - - Regras: - - 1. Essa branch sempre é criada a partir da branch **release**. - 2. Essa branch sempre é mesclada na branch **release**. - - Regras de nomenclatura: - - `bugfix/issueID-titulo-da-issue` - - - - A branch **hotfix** é utilizada para implementar soluções para problemas urgentes encontrados no ambiente de produção. Isso significa que essa branch deve ter a branch **master** como sua orgigem e fim. - - -- Regras: - - 1. Essa branch sempre é criada a partir da branch **master**. -2. Essa branch sempre é mesclada à branch **master**. - - Regras de nomenclatura: - - `hotfix/issueID-titulo-da-issue` - - - - -Observações: O título da issue utilizado no nome das branches deve ser mantido em português. - - - Imagens para ajudar a visualizar o fluxo de trabalho descrito: - - ![](https://fpy.cz/pub/slides/git-workshop/images/gitflow.png) - - ![](https://miro.medium.com/max/640/0*FTwKYpFGADX-5Y0O) - -## Políticas de Commits -Commits devem ser escritos de forma clara e breve, em Inglês, descrevendo as alterações feitas. - -Regras para escrita das mensagens nos commits: - -``` -#issueID Mensagem breve descrevendo alterações - -Mensagem mais detalhada sobre o que foi feito neste commit. (Opcional) -``` - -É possível fechar uma issue automaticamente adicionando a palavra chave "Fix" antes do id da issue: - -`Fix #issueID Concise Message` - -O caractere "#", por padrão, representa uma linha de comentário no arquivo de mensagem do commit. Para evitar problemas, é necessário alterar o caractere com o seguinte comando: - -`git config --local core.commentChar auto` - -Caso deseje utilizar um outro caractere específico para definir uma linha de comentário, basta substituir a palavra "auto" pelo caractere desejado. - -A mensagem principal do commit deve ser escrita no modo imperativo. Aqui estão alguns exemplos: - -Maus exemplos: - -`Renamed the iVars and removed the common prefix.` - -`Creating branch policies document ` - -Bons exemplos: - -`Rename the iVars to remove the common prefix. ` - -`Create branch policies document` - - -## Referências - -[Git-flow Applied to a Real Project](https://medium.com/empathyco/git-flow-applied-to-a-real-project-c08037e28f88) - -[Writing git commit message](https://365git.tumblr.com/post/3308646748/writing-git-commit-messages) diff --git a/docs/project_charter.md b/docs/project_charter.md deleted file mode 100644 index ca71d98..0000000 --- a/docs/project_charter.md +++ /dev/null @@ -1,96 +0,0 @@ -# Termo de abertura - -# 1. Introdução - -Este documento inicia formalmente o projeto do Sistema de Colheita Colaborativa. Nas próximas sessões são detalhados: o que este projeto visa realizar, a oportunidade de negócio identificada, o escopo de atuação, os envolvidos (*stakeholders*), características de riscos, restrições e de custos, entregáveis, prazos e as ferramentas utilizadas no processo de desenvolvimento. Tais descrições visam elucidar a viabilidade do projeto. - -# 2. Descrição do Projeto - -O projeto visa auxiliar no processo de Colheita Colaborativa em áreas urbanas, facilitando a relação entre proprietários de árvores frutíferas, voluntários para colheita e locais que possam receber doações destas frutas, visando então a diminuição do desperdício de comida. Ele é baseado em um sistema já existente, o [Saskatoon](https://github.com/tiagovaz/saskatoon) utilizado pelo coletivo [LES FRUITS DÉFENDUS](https://santropolroulant.org/en/what-is-the-roulant/collectives/fruits-defendus/) em Montreal. - - -# 3. Propósito do Projeto - -Este projeto possui como objetivos: - -- Auxiliar na diminuição do desperdício de comida -- Aumentar o acesso a comida local -- Facilitar a disseminação de conhecimento de colheita e plantio de árvores frutíferas urbanas -- Facilitar o conhecimento de feiras e troca de conhecimento entre produtores de agricultura familiar e urbana - - -# 4. Oportunidade de Negócios - -No texto dos Objetivos de Desenvolvimento Sustentável (ODS) da [ONU](https://nacoesunidas.org/pos2015/agenda2030/) coloca-se a importância da erradicação da pobreza é um grande e importante desafio global para o desenvolvimento sustentável. - -Observa-se ainda, no [ODS 2](https://nacoesunidas.org/pos2015/ods2/) - Fome zero e Agricultura Sustentável a necessidade de: "*Acabar com a fome, alcançar a segurança alimentar e melhoria da nutrição e promover a agricultura sustentável* ". - -Desta forma, uma das possíveis soluções é o fomento da agricultura urbana. A agricultura urbana permite a valorização de espaços limitados permitindo a construção de laços de vida comunitário por meio da produção de alimentos voltados para o autoconsumo, assim também diversificando a dieta de famílias. Desta forma, diminui-se os riscos de insegurança alimentar e nutricional e permite a comunidade desenvolver-se de forma sustentável e autogerida [1][2]. - - -O projeto [Saskatoon](https://github.com/tiagovaz/saskatoon) está inserido neste contexto da agricultura urbana, em Montreal. Embora a agricultura urbana seja também desenvolvida no Brasil, principalmente em áreas com populações socialmente marginalizadas [2], ainda não foi identificado pela equipe um produto que auxilie na gerência de colheita colaborativa ou distribuição de produtos agrícolas destes grupos ou para divulgação de feiras de produção familiar e troca de conhecimentos sobre plantio e colheita. - -# 5. Escopo do Projeto - -Plataforma web responsiva, troca de informações entre pessoas em relação a agricultura urbana - -# 6. Equipe e Papéis - -## 6.1. Envolvidos - -A equipe é compostas por alunos da disciplina de Métodos de Desenvolvimento de Software (MDS) e Engenharia de Produto de Software (EPS) responsáveis por diferentes papéis, sendo os membros de MDS alocados em papéis de desenvolvimento e os estudantes de EPS em papéis de gerência descritos a seguir em tabela. - -| Papel | Responsabilidade | Estudante | -| :---: | :--------------: | :-----------: | -| Desenvolvedor | O desenvolvedor tem como papel desenvolver, testar, garantir a qualidade e entrega do produto |Hugo Sobral de Lima Salomão, Durval Carvalho de Souza, João Pedro Silva de Carvalho, Leonardo da Silva Gomes, Renato Britto Araújo| -| DevOps | Responsável pela configuração dos diferentes ambiente necessários do projetos tais como de desenvolvimento, de homologação e de produção, assim como automatização de testes, integração e deploy e entrega contínua. | Vitor Cardoso Xoteslem | -| Arquiteto de Software | No contexto da disciplina, atuará de maneira a analisar se a arquitetura de microserviços é viável para o projeto e dará suporte para as atividades do DevOps. |Shayane Marques Alcântara| -| Scrum Master | É um facilitador da equipe, responsável por retirar possíveis impedimentos que possam comprometer o andamento do projeto. |Martha Dantas Silva | -| Product Owner | Responsável por passar a visão do produto para a equipe, assim como priorizar a ordem de desenvolvimento do sistema de acordo com as necessidades elicitadas. |Fabíola Malta Fleury | - -Além destes, existem outros envolvidos: - - - Consultor de visão de produto: O mantenedor do projeto [Saskatoon](https://github.com/tiagovaz/saskatoon), Tiago Vaz, está familiarizado com o seu contexto e seus funcionários e está disponível para auxiliar no desenvolvimento do projeto, embora não possa participar presencialmente - - Professora: Possui como objetivo auxiliar o desenvolvimento do projeto para que os estudantes conheçam e pratiquem definições necessárias para o cumprimento do plano de ensino das disciplinas. - -## 6.2. Usuários - -| Nome| Descrição | -| :---: | :-----------------------: | -| Agricultores urbanos| Donos de plantações que disponibilizarão seu plantio para que seja realizada a colheita. | -| Voluntários de colheita| Pessoas que disponibilizam ao menos duas horas para realizar a colheita.| -|Líderes de colheita|Pessoas que já possuem experiência na colheita, são responsáveis pela escolha dos voluntários e trabalham em conjunto com eles.| -|Beneficiários| Entidades que recebem a parcela da comida como doação| - -# 7. Metodologia de Desenvolvimento - -O processo do desenvolvimento deste projeto é baseado nas metodologias ágeis do Lean, Scrum e XP (eXtreme Programming). São utilizadas conforme o contexto da disciplina, com espaço para adaptações à necessidades da equipe. - - -# 8. Prazo e Custo - -O projeto terá uma duração de um total de 16 sprints. A primeira sprint teve inicio no dia 13 de Agosto de 2019, de maneira que a última sprint será iniciada no dia 25 de novembro de 2019, totalizando 4 meses de duração de projeto. Durante esse período, haverão duas datas de entregas importantes, sendo elas denominadas releases. Uma ocorrerá na Sprint 7, que inicia-se dia 30 de setembro, enquanto outra ocorrerá na Sprint 16, a partir do dia 25 de novembro. - - -O custo do projeto foi calculado utilizando os seguintes valores, em reais: - -| Nome | Custo | Quantidade | Custo Mensal | Custo Total | -| :--: | :---: | :--------: | :----------: | :---------: | -| Desenvolvedores Júnior | 3500 | 5 | 17.500 | 70.000| -| Engenheiros de Produto | 6500 | 4 | 26.000 | 104.000 | -| |||| 174.000| - -Os valores para os salários foram obtidos a partir de salários de pessoas que exercem cargos semelhantes em Brasília. - -# 9. Estratégia de Comunicação - -Para comunicação interna da equipe são utilizados: o aplicativo Telegram, Hangouts, aulas e reuniões presenciais. - -Para comunicação com outros envolvidos são utilizados e-mails, hangouts e o github. - - -# Referências - -[1] ALMEIDA, Daniela. Agricultura urbana e segurança alimentar em Belo Horizonte: cultivando uma cidade sustentável. **Revista Agriculturas: experiencias em agroecologia.**, v. 1, p. 25-28, 2004. - -[2] AQUINO, Adriana María de; ASSIS, Renato Linhares de. Agricultura orgânica em áreas urbanas e periurbanas com base na agroecologia. **Ambiente & sociedade**, v. 10, n. 1, p. 137-150, 2007. diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..4e4ab77 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,8 @@ +Django==2.2.4 +djangorestframework==3.10 +django-phonenumber-field==3.0 +phonenumbers==8.10 +psycopg2==2.8.3 +django-cors-headers==3.1.0 +djangorestframework-simplejwt +coverage diff --git a/docs/.nojekyll b/src/acacia/__init__.py similarity index 100% rename from docs/.nojekyll rename to src/acacia/__init__.py diff --git a/src/acacia/settings.py b/src/acacia/settings.py new file mode 100644 index 0000000..579560b --- /dev/null +++ b/src/acacia/settings.py @@ -0,0 +1,160 @@ +""" +Django settings for acacia project. + +Generated by 'django-admin startproject' using Django 2.2.5. + +For more information on this file, see +https://docs.djangoproject.com/en/2.2/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/2.2/ref/settings/ +""" + +import os +from scripts.wait_for_db import start_services +from django.utils.translation import ugettext_lazy as _ + +from .wait_db import start_services + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'o8i1rj77rfrpx5x@#6pad8=sn@wl9ri)-uh5#r7f_jrh-ki&mh' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = ['0.0.0.0'] + +AUTH_USER_MODEL = 'users.User' + +# Application definition +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + + # libs + 'phonenumber_field', + 'rest_framework', + 'rest_framework.authtoken', + 'corsheaders', + + # my apps + 'users', +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', + 'corsheaders.middleware.CorsMiddleware', + 'django.middleware.common.CommonMiddleware', +] + +ROOT_URLCONF = 'acacia.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + + +WSGI_APPLICATION = 'acacia.wsgi.application' + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.postgresql_psycopg2', + 'NAME': 'postgres', + 'USER': 'postgres', + 'HOST': 'db', + 'PORT': '5432', + } +} + +# STARTS SERVICES THAT DJANGO DEPENDS E.G. postgres +start_services() + +LANGUAGES = ( + ('en-us', _('English')), + ('pt-br', _('Brazilian Portuguese')), + ('fr-CA', _('French Canadian')), +) + + +# Password validation +# https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/2.2/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/2.2/howto/static-files/ + +STATIC_URL = '/static/' + + +REST_FRAMEWORK = { + 'DEFAULT_AUTHENTICATION_CLASSES': [ + 'rest_framework_simplejwt.authentication.JWTAuthentication', + ] +} + +# CORS headers to responses + +CORS_ORIGIN_WHITELIST = [ + "http://localhost:8080", + "http://localhost:8000", + "http://0.0.0.0:8080", + "http://0.0.0.0:8000", +] diff --git a/src/acacia/urls.py b/src/acacia/urls.py new file mode 100644 index 0000000..240f371 --- /dev/null +++ b/src/acacia/urls.py @@ -0,0 +1,22 @@ +"""acacia URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/2.2/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: path('', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: path('', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.urls import include, path + 2. Add a URL to urlpatterns: path('blog/', include('blog.urls')) +""" +from django.contrib import admin +from django.urls import path, include + +urlpatterns = [ + path('admin/', admin.site.urls), + path('users/', include('users.urls')), +] \ No newline at end of file diff --git a/src/acacia/wait_db.py b/src/acacia/wait_db.py new file mode 100644 index 0000000..fdf9b2e --- /dev/null +++ b/src/acacia/wait_db.py @@ -0,0 +1,56 @@ +import importlib +import os +import time + +import logging + +SERVICES_STARTED = False + +log = logging.getLogger('ej') + + +def start_services(): + global SERVICES_STARTED + + if SERVICES_STARTED: + return + + start_postgres() + + SERVICES_STARTED = True + + +def start_postgres(): + # settings_path = os.environ['DJANGO_SETTINGS_MODULE'] + # settings = importlib.import_module(settings_path) + + # db = settings.DATABASES['default'] + dbname = 'postgres' # db['NAME'] + user = 'postgres' # db['USER'] + password = '' # db['PASSWORD'] + host = 'db' # db['HOST'] + + for _ in range(100): + if can_connect(dbname, user, password, host): + log.info("Postgres is available. Continuing...") + return + log.warning('Postgres is unavailable. Retrying in 0.5 seconds') + time.sleep(0.5) + + log.critical('Maximum number of attempts connecting to postgres database') + raise RuntimeError('could not connect to database') + + +def can_connect(dbname, user, password, host): + import psycopg2 + + try: + psycopg2.connect( + dbname=dbname, + user=user, + password=password, + host=host + ) + except psycopg2.OperationalError: + return False + return True diff --git a/src/acacia/wsgi.py b/src/acacia/wsgi.py new file mode 100644 index 0000000..17a39b7 --- /dev/null +++ b/src/acacia/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for acacia project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'acacia.settings') + +application = get_wsgi_application() diff --git a/src/manage.py b/src/manage.py new file mode 100755 index 0000000..b20b651 --- /dev/null +++ b/src/manage.py @@ -0,0 +1,21 @@ +#!/usr/bin/env python +"""Django's command-line utility for administrative tasks.""" +import os +import sys + + +def main(): + os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'acacia.settings') + try: + from django.core.management import execute_from_command_line + except ImportError as exc: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) from exc + execute_from_command_line(sys.argv) + + +if __name__ == '__main__': + main() diff --git a/src/scripts/create_superuser.sh b/src/scripts/create_superuser.sh new file mode 100755 index 0000000..6c6fc17 --- /dev/null +++ b/src/scripts/create_superuser.sh @@ -0,0 +1,9 @@ +# default superuser +# email: 'admin@admin.com' +# password: 'password' +echo " +from django.contrib.auth import get_user_model; +User = get_user_model(); + +if not len(User.objects.all()): + User.objects.create_superuser(username='admin', email='admin@admin.com', password='password')" | python manage.py shell diff --git a/src/scripts/wait_for_db.py b/src/scripts/wait_for_db.py new file mode 100644 index 0000000..7534f13 --- /dev/null +++ b/src/scripts/wait_for_db.py @@ -0,0 +1,60 @@ +import importlib +import os +import time + +import logging + +SERVICES_STARTED = False + +log = logging.getLogger('ej') + + +def start_services(): + global SERVICES_STARTED + + if SERVICES_STARTED: + return + + start_postgres() + + SERVICES_STARTED = True + + + +log = logging.getLogger('ej') + + +def start_postgres(): + settings_path = os.environ['DJANGO_SETTINGS_MODULE'] + settings = importlib.import_module(settings_path) + + db = settings.DATABASES['default'] + dbname = db['NAME'] + user = db['USER'] + host = db['HOST'] + + for _ in range(100): + if can_connect(dbname, user, host): + log.info("Postgres is available. Continuing...") + return + log.warning('Postgres is unavailable. Retrying in 0.5 seconds') + time.sleep(0.5) + + log.critical('Maximum number of attempts connecting to postgres database') + raise RuntimeError('could not connect to database') + + +def can_connect(dbname, user, host): + import psycopg2 + + try: + psycopg2.connect( + dbname=dbname, + user=user, + host=host + ) + + except psycopg2.OperationalError: + return False + + return True \ No newline at end of file diff --git a/src/users/__init__.py b/src/users/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/users/admin.py b/src/users/admin.py new file mode 100644 index 0000000..8e61bcf --- /dev/null +++ b/src/users/admin.py @@ -0,0 +1,15 @@ +from django.contrib import admin +from .models import User + +class UserAdmin(admin.ModelAdmin): + list_display = ( + 'email', + 'phone_number', + 'birth', + 'email', + 'username', + ) + + search_fields = ('email',) + +admin.site.register(User, UserAdmin) \ No newline at end of file diff --git a/src/users/apps.py b/src/users/apps.py new file mode 100644 index 0000000..4ce1fab --- /dev/null +++ b/src/users/apps.py @@ -0,0 +1,5 @@ +from django.apps import AppConfig + + +class UsersConfig(AppConfig): + name = 'users' diff --git a/src/users/migrations/0001_initial.py b/src/users/migrations/0001_initial.py new file mode 100644 index 0000000..6855393 --- /dev/null +++ b/src/users/migrations/0001_initial.py @@ -0,0 +1,50 @@ +# Generated by Django 2.2.4 on 2019-09-24 19:30 + +import django.contrib.auth.models +import django.contrib.auth.validators +from django.db import migrations, models +import django.utils.timezone +import phonenumber_field.modelfields + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ('auth', '0011_update_proxy_permissions'), + ] + + operations = [ + migrations.CreateModel( + name='User', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('password', models.CharField(max_length=128, verbose_name='password')), + ('last_login', models.DateTimeField(blank=True, null=True, verbose_name='last login')), + ('is_superuser', models.BooleanField(default=False, help_text='Designates that this user has all permissions without explicitly assigning them.', verbose_name='superuser status')), + ('username', models.CharField(error_messages={'unique': 'A user with that username already exists.'}, help_text='Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.', max_length=150, unique=True, validators=[django.contrib.auth.validators.UnicodeUsernameValidator()], verbose_name='username')), + ('first_name', models.CharField(blank=True, max_length=30, verbose_name='first name')), + ('last_name', models.CharField(blank=True, max_length=150, verbose_name='last name')), + ('is_staff', models.BooleanField(default=False, help_text='Designates whether the user can log into this admin site.', verbose_name='staff status')), + ('is_active', models.BooleanField(default=True, help_text='Designates whether this user should be treated as active. Unselect this instead of deleting accounts.', verbose_name='active')), + ('date_joined', models.DateTimeField(default=django.utils.timezone.now, verbose_name='date joined')), + ('email', models.EmailField(max_length=254, unique=True, verbose_name='email address')), + ('phone_number', phonenumber_field.modelfields.PhoneNumberField(blank=True, max_length=128, region=None)), + ('bio', models.TextField(blank=True)), + ('birth', models.DateField(blank=True, null=True)), + ('speaks_french', models.BooleanField(default=False, help_text='Designates If the user speaks French.', verbose_name='speaks french')), + ('speaks_english', models.BooleanField(default=False, help_text='Designates If the user speaks English.', verbose_name='speaks english')), + ('groups', models.ManyToManyField(blank=True, help_text='The groups this user belongs to. A user will get all permissions granted to each of their groups.', related_name='user_set', related_query_name='user', to='auth.Group', verbose_name='groups')), + ('user_permissions', models.ManyToManyField(blank=True, help_text='Specific permissions for this user.', related_name='user_set', related_query_name='user', to='auth.Permission', verbose_name='user permissions')), + ], + options={ + 'verbose_name': 'user', + 'verbose_name_plural': 'users', + 'abstract': False, + }, + managers=[ + ('objects', django.contrib.auth.models.UserManager()), + ], + ), + ] diff --git a/src/users/migrations/__init__.py b/src/users/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/src/users/models.py b/src/users/models.py new file mode 100644 index 0000000..2154ef1 --- /dev/null +++ b/src/users/models.py @@ -0,0 +1,44 @@ +from django.db import models +from django.contrib.auth.models import AbstractUser +from django.utils.translation import gettext_lazy as _ +from phonenumber_field.modelfields import PhoneNumberField + + +class User(AbstractUser): + + email = models.EmailField( + _('email address'), + unique=True, + blank=False, + error_messages={ + 'unique': 'A user with that email already exists.', + } + ) + + phone_number = PhoneNumberField(blank=True, null=True) + bio = models.TextField(blank=True, null=True) + birth = models.DateField(blank=True, null=True) + + is_verified = models.BooleanField( + 'verified', + default=True, + help_text=( + 'Set to true when the user have verified its email address.' + ) + ) + + speaks_french = models.BooleanField( + _('speaks french'), + default=False, + help_text=_('Designates If the user speaks French.'), + ) + + speaks_english = models.BooleanField( + _('speaks english'), + default=False, + help_text=_('Designates If the user speaks English.'), + ) + + EMAIL_FIELD = 'email' + USERNAME_FIELD = 'email' + REQUIRED_FIELDS = ['username'] \ No newline at end of file diff --git a/src/users/serializers.py b/src/users/serializers.py new file mode 100644 index 0000000..ac78c53 --- /dev/null +++ b/src/users/serializers.py @@ -0,0 +1,96 @@ + +# Django +from django.conf import settings + +# Models +from .models import User + +# Django Rest Framework +from rest_framework import serializers +from rest_framework.validators import UniqueValidator + + +class UserSignUpSerializer(serializers.Serializer): + + username = serializers.CharField( + required=True, + label="Username", + ) + + email = serializers.EmailField( + required=True, + validators=[UniqueValidator(queryset=User.objects.all())], + #unique=True, + label="Email Address", + ) + + password = serializers.CharField( + write_only=True, + required=True, + label="Password", + style={'input_type': 'password'}, + ) + + confirm_password = serializers.CharField( + write_only=True, + required=True, + label="Confirm Password", + style={'input_type': 'password'} + ) + + class Meta: + model = User + fields = ['username', 'email', 'password', 'confirm_password'] + + #def validate_email(self, email): + # if User.objects.filter(email=email).exists(): + # raise serializers.ValidationError('Email já cadastrado') + # return email + + + def validate_password(self, password): + min_length = getattr(settings, 'PASSWORD_MIN_LENGTH', 8) + if len(password) < min_length: + raise serializers.ValidationError( + 'A senha deve ter no mínimo %s caracteres' % (min_length) + ) + return password + + def validate_confirm_password(self, password_confirmation): + data = self.get_initial() + password = data.get('password') + if password != password_confirmation: + raise serializers.ValidationError('As senhas devem corresponder') + return password_confirmation + + def validate_username(self, username): + if User.objects.filter(username=username).exists(): + raise serializers.ValidationError('Usuário com este nome já cadastrado') + return username + + def create(self, validated_data): + + # this fields dont belongs to this class + validated_data.pop('confirm_password') + + user = User.objects.create_user(**validated_data, + is_verified=False + ) + + # TODO: SEND CONFIRMATION EMAIL + + return user + +class UserModelSerializer(serializers.ModelSerializer): + class Meta: + model = User + fields = [ + 'username', + 'email', + 'password', + 'phone_number', + 'bio', + 'birth', + 'speaks_french', + 'speaks_english', + ] \ No newline at end of file diff --git a/src/users/tests.py b/src/users/tests.py new file mode 100644 index 0000000..dff5b7b --- /dev/null +++ b/src/users/tests.py @@ -0,0 +1,210 @@ +import json + +from rest_framework.test import APITestCase +from django.urls import reverse +from django.db import IntegrityError + + +class UserRegistrationAPIViewTestCase(APITestCase): + url = reverse('users:register') + + def test_different_password_on_password_confirmation(self): + """ + Test to try to create a user with a wrong verification password + """ + + user_data = { + "username": "vitas", + "email": "vitas@iAmGreat.com", + "password": "VitasIsNice", + "confirm_password": "VitasIsAwesome" + } + + response = self.client.post(self.url, user_data) + self.assertEqual(400, response.status_code) + + + def test_password_less_than_8_characters(self): + """ + Test to try to create a user with a password less than 8 characters + """ + + user_data = { + "username": "vitas", + "email": "vitas@iAmGreat.com", + "password": "HiVitas", + "confirm_password": "HiVitas" + } + + response = self.client.post(self.url, user_data) + self.assertEqual(400, response.status_code) + + + def test_unique_email_validation(self): + """ + Test to try to create a user with a registered email + """ + + user1_data = { + "username": "vitas", + "email": "vitas@iAmGreat.com", + "password": "VitasIsAwesome", + "confirm_password": "VitasIsAwesome" + } + user2_data = { + "username": "Reanu_Reves", + "email": "vitas@iAmGreat.com", + "password": "cyberpunk2077", + "confirm_password": "cyberpunk2077" + } + response = self.client.post(self.url, user1_data) + self.assertEqual(201, response.status_code) + with self.assertRaises(IntegrityError): + response = self.client.post(self.url, user2_data) + + + def test_unique_username_validation(self): + """ + Test to try to create a user with a registered username + """ + + user_data = { + "username": "vitas", + "email": "vitas@iAmGreat.com", + "password": "VitasIsAwesome", + "confirm_password": "VitasIsAwesome" + } + + response = self.client.post(self.url, user_data) + self.assertEqual(201, response.status_code) + + user_data = { + "username": "vitas", + "email": "keanu@reeves.com", + "password": "cyberpunk2077", + "confirm_password": "cyberpunk2077" + } + + response = self.client.post(self.url, user_data) + self.assertEqual(400, response.status_code) + + + def test_user_registration(self): + """ + Test to create a user with valid data + """ + + user_data = { + "username": "keanu_reeves", + "email": "keanu@reeves.com", + "password": "cyberpunk2077", + "confirm_password": "cyberpunk2077" + } + + response = self.client.post(self.url, user_data) + self.assertEqual(201, response.status_code) + + +class UserAuthenticationAPIViewTestCase(APITestCase): + + # SETUP + + + signup_url = reverse('users:register') + token_url = reverse('users:token_obtain_pair') + refresh_url = reverse('users:token_refresh') + + user_cleber = { + "username": "cleber", + "email": "cleber@gmail.com", + "password": "cleber123", + "confirm_password": "cleber123" + } + + + def create_user(self, user=user_cleber): + """ + Set's up user in database. + """ + + self.assertEqual(201, self.client.post( + self.signup_url, user).status_code, msg='User setup failed') + + + def authenticate_user(self, user=user_cleber): + """ + Authenticates a set up user and returns it's tokens + """ + + response = self.client.post( + self.token_url, {"email": user['email'], "password": user['password']}) + self.assertEqual(200, response.status_code, msg='User authentication failed') + return response.data + + # TESTS + + + def test_authenticate_valid_user(self): + """ + Test authentication of valid user + """ + + self.create_user(self.user_cleber) + + authentication_data = { + "email": self.user_cleber['email'], + "password": self.user_cleber['password'], + } + + response = self.client.post(self.token_url, authentication_data) + self.assertEqual(200, response.status_code, + msg='Response not 200 (' + str(response.status_code) + ')') + self.assertIsNotNone(response.data['access'], msg='No access token found') + self.assertIsNotNone(response.data['refresh'], msg='No refresh token found') + + + def test_failed_password_authentication(self): + """ + Tests if wrong password does now allow access to user + """ + + self.create_user(self.user_cleber) + + authentication_data = { + "email": self.user_cleber['email'], + "password": "asdfghjkl", # Wrong password + } + + response = self.client.post(self.token_url, authentication_data) + self.assertEqual(401, response.status_code, msg='Unexpected response code (' + + str(response.status_code) + '), expecting 401') + + + def test_failed_email_authentication(self): + """ + Tests if wrong password does now allow access to user + """ + + self.create_user(self.user_cleber) + + authentication_data = { + "email": 'batata@gmail.com', # Wrong email + "password": self.user_cleber['password'], + } + + response = self.client.post(self.token_url, authentication_data) + self.assertEqual(401, response.status_code, msg='Unexpected response code (' + + str(response.status_code) + '), expecting 401') + + + def test_get_access_token_from_valid_refresh_token(self): + """ + Tests if a valid refresh token can get a new instance of a access token + """ + + self.create_user(self.user_cleber) + tokens = self.authenticate_user(self.user_cleber) + + response = self.client.post(self.refresh_url, {"refresh": tokens['refresh']}) + self.assertEqual(200, response.status_code) + self.assertIsNotNone(response.data['access'], msg='No access token found') diff --git a/src/users/urls.py b/src/users/urls.py new file mode 100644 index 0000000..d7eb35b --- /dev/null +++ b/src/users/urls.py @@ -0,0 +1,19 @@ +# Django +from django.urls import path, include + +# Viewsets +from .viewsets import UserRegistrationAPIView + +# Simple JWT +from rest_framework_simplejwt.views import ( + TokenObtainPairView, + TokenRefreshView, +) + +app_name = 'users' + +urlpatterns = [ + path('signup/', UserRegistrationAPIView.as_view(), name='register'), + path('token/', TokenObtainPairView.as_view(), name='token_obtain_pair'), + path('token/refresh/', TokenRefreshView.as_view(), name='token_refresh'), +] \ No newline at end of file diff --git a/src/users/viewsets.py b/src/users/viewsets.py new file mode 100644 index 0000000..41bfe49 --- /dev/null +++ b/src/users/viewsets.py @@ -0,0 +1,24 @@ + +# Django Rest Framework +from rest_framework import status +from rest_framework import permissions +from rest_framework.response import Response +from rest_framework.decorators import action +from rest_framework.generics import CreateAPIView +from rest_framework.authtoken.models import Token + +# Models +from .models import User + +# Serializers +from .serializers import UserSignUpSerializer + + +class UserRegistrationAPIView(CreateAPIView): + """ + Endpoint for user registration + """ + + permission_classes = (permissions.AllowAny, ) + serializer_class = UserSignUpSerializer + queryset = User.objects.all() \ No newline at end of file