diff --git a/.github/workflows/ci-cd.yml b/.github/workflows/ci-cd.yml new file mode 100644 index 00000000..789989f1 --- /dev/null +++ b/.github/workflows/ci-cd.yml @@ -0,0 +1,44 @@ +name: CI/CD + +on: + push: + branches: [ main ] + pull_request: + branches: [ main ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Java 17 + uses: actions/setup-java@v1 + with: + java-version: 17 + - name: Build with Maven + run: mvn -B package --file pom.xml + env: + CUCUMBER_PUBLISH_TOKEN: ${{ secrets.CUCUMBER_PUBLISH_TOKEN }} + CUCUMBER_PUBLISH_ENABLED: true + - uses: superfly/flyctl-actions/setup-flyctl@master + - name: Deploy to fly.io + if: success() && github.ref == 'refs/heads/main' + run: flyctl deploy --remote-only + env: + FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} + - name: Login to DockerHub + if: success() && github.ref == 'refs/heads/main' + uses: docker/login-action@v1 + with: + username: ${{ secrets.DOCKERHUB_USERNAME }} + password: ${{ secrets.DOCKERHUB_TOKEN }} + - name: Push to Docker Hub + if: success() && github.ref == 'refs/heads/main' + id: docker_build + uses: docker/build-push-action@v2 + with: + context: . + push: true + tags: | + udlepssoftarch/mypets-gei-api:${{ github.sha }} + udlepssoftarch/mypets-gei-api:latest diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..7ed0d6b6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,32 @@ +target/ +!.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 00000000..77480826 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,8 @@ +FROM ibm-semeru-runtimes:open-17-jre-focal + +WORKDIR /home/app + +ADD ./target/*.jar ./app.jar + +EXPOSE 8080 +CMD java $JAVA_OPTS -Dspring.profiles.active=$PROFILE -jar app.jar diff --git a/EntitiesModel.puml b/EntitiesModel.puml new file mode 100644 index 00000000..e243271f --- /dev/null +++ b/EntitiesModel.puml @@ -0,0 +1,15 @@ +@startuml + +class User extends UriEntity implements UserDetails { + username : String + password : String + email : String +} + +class UriEntity { + uri : String +} + +User "1" --right-- "*" Resource : owner < + +@enduml diff --git a/HELP.md b/HELP.md new file mode 100644 index 00000000..4c40df5f --- /dev/null +++ b/HELP.md @@ -0,0 +1,27 @@ +# Getting Started + +### Reference Documentation +For further reference, please consider the following sections: + +* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html) +* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/2.6.3/maven-plugin/reference/html/) +* [Create an OCI image](https://docs.spring.io/spring-boot/docs/2.6.3/maven-plugin/reference/html/#build-image) +* [Rest Repositories](https://docs.spring.io/spring-boot/docs/2.6.3/reference/htmlsingle/#howto-use-exposing-spring-data-repositories-rest-endpoint) +* [Spring HATEOAS](https://docs.spring.io/spring-boot/docs/2.6.3/reference/htmlsingle/#boot-features-spring-hateoas) +* [Spring Security](https://docs.spring.io/spring-boot/docs/2.6.3/reference/htmlsingle/#boot-features-security) +* [Spring Data JPA](https://docs.spring.io/spring-boot/docs/2.6.3/reference/htmlsingle/#boot-features-jpa-and-spring-data) +* [Validation](https://docs.spring.io/spring-boot/docs/2.6.3/reference/htmlsingle/#boot-features-validation) +* [Spring Boot DevTools](https://docs.spring.io/spring-boot/docs/2.6.3/reference/htmlsingle/#using-boot-devtools) + +### Guides +The following guides illustrate how to use some features concretely: + +* [Accessing JPA Data with REST](https://spring.io/guides/gs/accessing-data-rest/) +* [Accessing Neo4j Data with REST](https://spring.io/guides/gs/accessing-neo4j-data-rest/) +* [Accessing MongoDB Data with REST](https://spring.io/guides/gs/accessing-mongodb-data-rest/) +* [Building a Hypermedia-Driven RESTful Web Service](https://spring.io/guides/gs/rest-hateoas/) +* [Securing a Web Application](https://spring.io/guides/gs/securing-web/) +* [Spring Boot and OAuth2](https://spring.io/guides/tutorials/spring-boot-oauth2/) +* [Authenticating a User with LDAP](https://spring.io/guides/gs/authenticating-ldap/) +* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/) + diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/LICENSE @@ -0,0 +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 +. diff --git a/README.md b/README.md new file mode 100644 index 00000000..9ee8b88c --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# MyPets GEI API + +Template for a Spring Boot project including Spring REST, HATEOAS, JPA, etc. Additional details: [HELP.md](HELP.md) + +[![Open Issues](https://img.shields.io/github/issues-raw/UdL-EPS-SoftArch/mypets-gei-api?logo=github)](https://github.com/orgs/UdL-EPS-SoftArch/projects/20) +[![CI/CD](https://github.com/UdL-EPS-SoftArch/mypets-gei-api/actions/workflows/ci-cd.yml/badge.svg)](https://github.com/UdL-EPS-SoftArch/mypets-gei-api/actions) +[![CucumberReports: UdL-EPS-SoftArch](https://messages.cucumber.io/api/report-collections/faed8ca5-e474-4a1a-a72a-b8e2a2cd69f0/badge)](https://reports.cucumber.io/report-collections/faed8ca5-e474-4a1a-a72a-b8e2a2cd69f0) +[![Deployment status](https://img.shields.io/uptimerobot/status/m792691238-18db2a43adf8d8ded474f885)](https://mypets-gei-api.fly.dev/users) + +## Vision + +**For** ... **who** want to ... +**the project** ... **is an** ... +**that** allows ... +**Unlike** other ... + +## Features per Stakeholder + +| USER | ADMIN | +|---------------------|----------------------| +| Register | | +| Login | | +| Logout | | +| | | + +## Entities Model + +![EntityModelsDiagram](http://www.plantuml.com/plantuml/svg/5Sqn3W8X40NGtbFe0M1wgxNOJXEJZGT061SI6CZC9rvVjthbMmn1CLizNOh4EXDFhUSC3BiIQVZwlI3FzpJMs0KiyB4tUgMxMv-Rs_e7DusPR6YHtO7Rg05CBHXOQHKK5BP7JrpzEAA59Vtz0G00?v0) + diff --git a/fly.toml b/fly.toml new file mode 100644 index 00000000..e087d24e --- /dev/null +++ b/fly.toml @@ -0,0 +1,19 @@ +app = "mypets-gei-api" + +[env] + JAVA_OPTS = "-XX:MaxRAM=70m" + SERVER_FORWARD_HEADERS_STRATEGY = "NATIVE" + SPRING_PROFILES_ACTIVE = "flyio" + +[[services]] + internal_port = 8080 + protocol = "tcp" + + [[services.ports]] + force_https = true + handlers = ["http"] + port = 80 + + [[services.ports]] + handlers = ["tls", "http"] + port = 443 diff --git a/pom.xml b/pom.xml new file mode 100644 index 00000000..5c7f7ff8 --- /dev/null +++ b/pom.xml @@ -0,0 +1,140 @@ + + + 4.0.0 + + org.springframework.boot + spring-boot-starter-parent + 3.2.2 + + + cat.udl.eps.softarch + mypets-gei-api + 0.0.1-SNAPSHOT + mypets-gei-api + MyPets GEI API + + 17 + + + + org.springframework.boot + spring-boot-starter-data-jpa + + + org.springframework.boot + spring-boot-starter-data-rest + + + org.springframework.boot + spring-boot-starter-hateoas + + + org.springframework.boot + spring-boot-starter-mail + + + org.springframework.boot + spring-boot-starter-security + + + org.springframework.security + spring-security-data + + + org.springframework.boot + spring-boot-starter-validation + + + org.springframework.data + spring-data-rest-hal-explorer + + + + org.springframework.boot + spring-boot-devtools + runtime + true + + + com.fasterxml.jackson.datatype + jackson-datatype-jsr310 + + + org.apache.tomcat + tomcat-jdbc + + + com.h2database + h2 + runtime + + + org.postgresql + postgresql + runtime + + + org.projectlombok + lombok + true + + + org.springframework.boot + spring-boot-starter-test + test + + + org.springframework.security + spring-security-test + test + + + io.cucumber + cucumber-junit + 7.13.0 + test + + + io.cucumber + cucumber-java + 7.13.0 + test + + + io.cucumber + cucumber-spring + 7.13.0 + test + + + org.junit.vintage + junit-vintage-engine + test + + + org.hamcrest + hamcrest-core + + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + + + + org.projectlombok + lombok + + + + + + + + diff --git a/src/main/java/cat/udl/eps/softarch/demo/MyPets.java b/src/main/java/cat/udl/eps/softarch/demo/MyPets.java new file mode 100644 index 00000000..9e00a5a8 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/MyPets.java @@ -0,0 +1,13 @@ +package cat.udl.eps.softarch.demo; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class MyPets { + + public static void main(String[] args) { + SpringApplication.run(MyPets.class, args); + } + +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/config/AuthenticationConfig.java b/src/main/java/cat/udl/eps/softarch/demo/config/AuthenticationConfig.java new file mode 100644 index 00000000..ba7b1ea9 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/config/AuthenticationConfig.java @@ -0,0 +1,30 @@ +package cat.udl.eps.softarch.demo.config; + +import cat.udl.eps.softarch.demo.domain.User; +import cat.udl.eps.softarch.demo.repository.UserRepository; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Configuration; +import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder; +import org.springframework.security.config.annotation.authentication.configuration.GlobalAuthenticationConfigurerAdapter; + +@Configuration +public class AuthenticationConfig extends GlobalAuthenticationConfigurerAdapter { + + @Value("${default-password}") + String defaultPassword; + + final BasicUserDetailsService basicUserDetailsService; + final UserRepository userRepository; + + public AuthenticationConfig(BasicUserDetailsService basicUserDetailsService, UserRepository userRepository) { + this.basicUserDetailsService = basicUserDetailsService; + this.userRepository = userRepository; + } + + @Override + public void init(AuthenticationManagerBuilder auth) throws Exception { + auth + .userDetailsService(basicUserDetailsService) + .passwordEncoder(User.passwordEncoder); + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/config/BasicUserDetailsService.java b/src/main/java/cat/udl/eps/softarch/demo/config/BasicUserDetailsService.java new file mode 100644 index 00000000..f9790865 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/config/BasicUserDetailsService.java @@ -0,0 +1,23 @@ +package cat.udl.eps.softarch.demo.config; + +import cat.udl.eps.softarch.demo.repository.UserRepository; +import org.springframework.security.core.userdetails.UserDetails; +import org.springframework.security.core.userdetails.UserDetailsService; +import org.springframework.security.core.userdetails.UsernameNotFoundException; +import org.springframework.stereotype.Component; + +@Component +public class BasicUserDetailsService implements UserDetailsService { + + final UserRepository userRepository; + + public BasicUserDetailsService(UserRepository userRepository) { + this.userRepository = userRepository; + } + + @Override + public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { + return userRepository.findById(username) + .orElseThrow(() -> new UsernameNotFoundException("User not found: " + username)); + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/config/DBInitialization.java b/src/main/java/cat/udl/eps/softarch/demo/config/DBInitialization.java new file mode 100644 index 00000000..f2fd97f6 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/config/DBInitialization.java @@ -0,0 +1,44 @@ +package cat.udl.eps.softarch.demo.config; +import cat.udl.eps.softarch.demo.domain.User; +import cat.udl.eps.softarch.demo.repository.UserRepository; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Configuration; +import jakarta.annotation.PostConstruct; +import java.util.Arrays; + +@Configuration +public class DBInitialization { + @Value("${default-password}") + String defaultPassword; + @Value("${spring.profiles.active:}") + private String activeProfiles; + private final UserRepository userRepository; + + public DBInitialization(UserRepository userRepository) { + this.userRepository = userRepository; + } + + @PostConstruct + public void initializeDatabase() { + // Default user + if (!userRepository.existsById("demo")) { + User user = new User(); + user.setEmail("demo@sample.app"); + user.setId("demo"); + user.setPassword(defaultPassword); + user.encodePassword(); + userRepository.save(user); + } + if (Arrays.asList(activeProfiles.split(",")).contains("test")) { + // Testing instances + if (!userRepository.existsById("test")) { + User user = new User(); + user.setEmail("test@sample.app"); + user.setId("test"); + user.setPassword(defaultPassword); + user.encodePassword(); + userRepository.save(user); + } + } + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/config/DatabaseConfig.java b/src/main/java/cat/udl/eps/softarch/demo/config/DatabaseConfig.java new file mode 100644 index 00000000..4b94f2c2 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/config/DatabaseConfig.java @@ -0,0 +1,32 @@ +package cat.udl.eps.softarch.demo.config; + +import org.apache.tomcat.jdbc.pool.DataSource; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Profile; + +import java.net.URI; +import java.net.URISyntaxException; + +/** + * Created by http://rhizomik.net/~roberto/ + */ +@Configuration +@Profile("flyio") +public class DatabaseConfig { + @Bean + public DataSource dataSource() throws URISyntaxException { + URI dbUri = new URI(System.getenv("DATABASE_URL")); + + String username = dbUri.getUserInfo().split(":")[0]; + String password = dbUri.getUserInfo().split(":")[1]; + String dbUrl = "jdbc:postgresql://" + dbUri.getHost() + ':' + dbUri.getPort() + dbUri.getPath(); + + DataSource basicDataSource = new DataSource(); + basicDataSource.setUrl(dbUrl); + basicDataSource.setUsername(username); + basicDataSource.setPassword(password); + + return basicDataSource; + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/config/RestValidationConfig.java b/src/main/java/cat/udl/eps/softarch/demo/config/RestValidationConfig.java new file mode 100644 index 00000000..327ce81e --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/config/RestValidationConfig.java @@ -0,0 +1,25 @@ +package cat.udl.eps.softarch.demo.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.context.annotation.Primary; +import org.springframework.data.rest.core.event.ValidatingRepositoryEventListener; +import org.springframework.data.rest.webmvc.config.RepositoryRestConfigurer; +import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean; + +@Configuration +public class RestValidationConfig implements RepositoryRestConfigurer { + + @Bean + @Primary + LocalValidatorFactoryBean validator() { + return new LocalValidatorFactoryBean(); + } + + @Override + public void configureValidatingRepositoryEventListener( + ValidatingRepositoryEventListener validatingListener) { + validatingListener.addValidator("beforeCreate", validator()); + validatingListener.addValidator("beforeSave", validator()); + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/config/WebSecurityConfig.java b/src/main/java/cat/udl/eps/softarch/demo/config/WebSecurityConfig.java new file mode 100644 index 00000000..083de609 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/config/WebSecurityConfig.java @@ -0,0 +1,61 @@ +package cat.udl.eps.softarch.demo.config; + +import java.util.Arrays; +import java.util.List; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.HttpMethod; +import org.springframework.security.config.annotation.method.configuration.EnableMethodSecurity; +import org.springframework.security.config.annotation.web.builders.HttpSecurity; +import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; +import org.springframework.security.config.http.SessionCreationPolicy; +import org.springframework.security.data.repository.query.SecurityEvaluationContextExtension; +import org.springframework.security.web.SecurityFilterChain; +import org.springframework.web.cors.CorsConfiguration; +import org.springframework.web.cors.CorsConfigurationSource; +import org.springframework.web.cors.UrlBasedCorsConfigurationSource; + +@Configuration +@EnableWebSecurity +@EnableMethodSecurity +public class WebSecurityConfig { + @Value("${allowed-origins}") + String[] allowedOrigins; + + @Bean + protected SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { + http.authorizeHttpRequests((auth) -> auth + .requestMatchers(HttpMethod.GET, "/identity").authenticated() + .requestMatchers(HttpMethod.POST, "/users").anonymous() + .requestMatchers(HttpMethod.POST, "/users/*").denyAll() + .requestMatchers(HttpMethod.POST, "/**/*").authenticated() + .requestMatchers(HttpMethod.PUT, "/**/*").authenticated() + .requestMatchers(HttpMethod.PATCH, "/**/*").authenticated() + .requestMatchers(HttpMethod.DELETE, "/**/*").authenticated() + .anyRequest().permitAll()) + .csrf((csrf) -> csrf.disable()) + .sessionManagement((session) -> session.sessionCreationPolicy(SessionCreationPolicy.STATELESS)) + .cors((cors) -> cors.configurationSource(corsConfigurationSource())) + .httpBasic((httpBasic) -> httpBasic.realmName("demo")); + return http.build(); + } + + @Bean + CorsConfigurationSource corsConfigurationSource() { + CorsConfiguration corsConfiguration = new CorsConfiguration(); + corsConfiguration.setAllowedOriginPatterns(Arrays.asList(allowedOrigins)); + corsConfiguration.setAllowedMethods(Arrays.asList("GET", "POST", "PUT", "PATCH", "DELETE", "OPTIONS")); + corsConfiguration.setAllowedHeaders(List.of("*")); + corsConfiguration.setAllowCredentials(true); + UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(); + source.registerCorsConfiguration("/**", corsConfiguration); + return source; + } + + @Bean + public SecurityEvaluationContextExtension securityEvaluationContextExtension() { + return new SecurityEvaluationContextExtension(); + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/controller/IdentityController.java b/src/main/java/cat/udl/eps/softarch/demo/controller/IdentityController.java new file mode 100644 index 00000000..d4f174f4 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/controller/IdentityController.java @@ -0,0 +1,22 @@ +package cat.udl.eps.softarch.demo.controller; + +import cat.udl.eps.softarch.demo.domain.User; +import org.springframework.data.rest.webmvc.BasePathAwareController; +import org.springframework.data.rest.webmvc.PersistentEntityResource; +import org.springframework.data.rest.webmvc.PersistentEntityResourceAssembler; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.web.bind.annotation.RequestMapping; +import org.springframework.web.bind.annotation.ResponseBody; + +@BasePathAwareController +public class IdentityController { + + @RequestMapping("/identity") + public @ResponseBody + PersistentEntityResource getAuthenticatedUserIdentity( + PersistentEntityResourceAssembler resourceAssembler) { + User user = (User) SecurityContextHolder.getContext().getAuthentication().getPrincipal(); + + return resourceAssembler.toFullResource(user); + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/domain/UriEntity.java b/src/main/java/cat/udl/eps/softarch/demo/domain/UriEntity.java new file mode 100644 index 00000000..087a06e1 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/domain/UriEntity.java @@ -0,0 +1,49 @@ +package cat.udl.eps.softarch.demo.domain; + +import com.fasterxml.jackson.annotation.JsonIdentityInfo; +import com.fasterxml.jackson.annotation.JsonIgnore; +import com.fasterxml.jackson.annotation.ObjectIdGenerators; +import java.io.Serializable; +import jakarta.persistence.MappedSuperclass; +import jakarta.persistence.Version; +import org.atteo.evo.inflector.English; +import org.springframework.data.domain.Persistable; +import org.springframework.util.StringUtils; + +/** + * Created by http://rhizomik.net/~roberto/ + */ +@MappedSuperclass +@JsonIdentityInfo(generator=ObjectIdGenerators.PropertyGenerator.class, property="uri") +public abstract class UriEntity implements Persistable { + + /** + * The uri string value. + */ + private String uri; + /** + * The value of the entity version. + */ + @Version + private Long version; + + /** + * Method that builds the uri and returns it in string format. + * @return Uri with uncapitalize letters in plural with name and id of the entity + */ + + public String getUri() { + return "/" + English.plural(StringUtils.uncapitalize(this.getClass().getSimpleName())) + "/" + getId(); + } + + + /** + * Method that checks if the version is null or not and returns it in boolean format. + * @return a boolean value if the version of the entity is null or not. + */ + @Override + @JsonIgnore + public boolean isNew() { + return version == null; + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/domain/User.java b/src/main/java/cat/udl/eps/softarch/demo/domain/User.java new file mode 100644 index 00000000..885707b3 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/domain/User.java @@ -0,0 +1,78 @@ +package cat.udl.eps.softarch.demo.domain; + +import com.fasterxml.jackson.annotation.JsonProperty; + +import jakarta.persistence.*; +import jakarta.validation.constraints.Email; +import jakarta.validation.constraints.NotBlank; + +import com.fasterxml.jackson.annotation.JsonValue; +import lombok.Data; +import lombok.EqualsAndHashCode; +import org.hibernate.validator.constraints.Length; +import org.springframework.security.core.GrantedAuthority; +import org.springframework.security.core.authority.AuthorityUtils; +import org.springframework.security.core.userdetails.UserDetails; +import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; +import org.springframework.security.crypto.password.PasswordEncoder; + +import java.util.Collection; + +@Entity +@Table(name = "DemoUser") //Avoid collision with system table User +@Data +@EqualsAndHashCode(callSuper = true) +public class User extends UriEntity implements UserDetails { + + public static PasswordEncoder passwordEncoder = new BCryptPasswordEncoder(); + + @Id + private String id; + + @NotBlank + @Email + @Column(unique = true) + private String email; + + @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) + @NotBlank + @Length(min = 8, max = 256) + private String password; + + @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) + private boolean passwordReset; + + public void encodePassword() { + this.password = passwordEncoder.encode(this.password); + } + + @Override + public String getUsername() { return id; } + + @Override + @JsonValue(value = false) + @JsonProperty(access = JsonProperty.Access.READ_ONLY) + public Collection getAuthorities() { + return AuthorityUtils.commaSeparatedStringToAuthorityList("ROLE_USER"); + } + + @Override + public boolean isAccountNonExpired() { + return true; + } + + @Override + public boolean isAccountNonLocked() { + return true; + } + + @Override + public boolean isCredentialsNonExpired() { + return true; + } + + @Override + public boolean isEnabled() { + return true; + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/handler/UserEventHandler.java b/src/main/java/cat/udl/eps/softarch/demo/handler/UserEventHandler.java new file mode 100644 index 00000000..e562d7ad --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/handler/UserEventHandler.java @@ -0,0 +1,75 @@ +package cat.udl.eps.softarch.demo.handler; + +import cat.udl.eps.softarch.demo.domain.User; +import cat.udl.eps.softarch.demo.repository.UserRepository; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.data.rest.core.annotation.HandleAfterCreate; +import org.springframework.data.rest.core.annotation.HandleAfterDelete; +import org.springframework.data.rest.core.annotation.HandleAfterLinkSave; +import org.springframework.data.rest.core.annotation.HandleAfterSave; +import org.springframework.data.rest.core.annotation.HandleBeforeCreate; +import org.springframework.data.rest.core.annotation.HandleBeforeDelete; +import org.springframework.data.rest.core.annotation.HandleBeforeLinkSave; +import org.springframework.data.rest.core.annotation.HandleBeforeSave; +import org.springframework.data.rest.core.annotation.RepositoryEventHandler; +import org.springframework.stereotype.Component; + +@Component +@RepositoryEventHandler +public class UserEventHandler { + + final Logger logger = LoggerFactory.getLogger(User.class); + + final UserRepository userRepository; + + public UserEventHandler(UserRepository userRepository) { + this.userRepository = userRepository; + } + + @HandleBeforeCreate + public void handleUserPreCreate(User user) { + logger.info("Before creating: {}", user.toString()); + } + + @HandleBeforeSave + public void handleUserPreSave(User user) { + logger.info("Before updating: {}", user.toString()); + } + + @HandleBeforeDelete + public void handleUserPreDelete(User user) { + logger.info("Before deleting: {}", user.toString()); + } + + @HandleBeforeLinkSave + public void handleUserPreLinkSave(User user, Object o) { + logger.info("Before linking: {} to {}", user.toString(), o.toString()); + } + + @HandleAfterCreate + public void handleUserPostCreate(User user) { + logger.info("After creating: {}", user.toString()); + user.encodePassword(); + userRepository.save(user); + } + + @HandleAfterSave + public void handleUserPostSave(User user) { + logger.info("After updating: {}", user.toString()); + if (user.isPasswordReset()) { + user.encodePassword(); + } + userRepository.save(user); + } + + @HandleAfterDelete + public void handleUserPostDelete(User user) { + logger.info("After deleting: {}", user.toString()); + } + + @HandleAfterLinkSave + public void handleUserPostLinkSave(User user, Object o) { + logger.info("After linking: {} to {}", user.toString(), o.toString()); + } +} diff --git a/src/main/java/cat/udl/eps/softarch/demo/repository/UserRepository.java b/src/main/java/cat/udl/eps/softarch/demo/repository/UserRepository.java new file mode 100644 index 00000000..46a8a106 --- /dev/null +++ b/src/main/java/cat/udl/eps/softarch/demo/repository/UserRepository.java @@ -0,0 +1,25 @@ +package cat.udl.eps.softarch.demo.repository; + +import cat.udl.eps.softarch.demo.domain.User; +import org.springframework.data.repository.CrudRepository; +import org.springframework.data.repository.PagingAndSortingRepository; +import org.springframework.data.repository.query.Param; +import org.springframework.data.rest.core.annotation.RepositoryRestResource; + +import java.util.List; + +@RepositoryRestResource +public interface UserRepository extends CrudRepository, PagingAndSortingRepository { + + /* Interface provides automatically, as defined in + * https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/CrudRepository.html + * and + * https://docs.spring.io/spring-data/commons/docs/current/api/org/springframework/data/repository/PagingAndSortingRepository.html + * the methods: count, delete, deleteAll, deleteById, existsById, findAll, findAllById, findById, save, saveAll,... + * + * Additional methods like findByUsernameContaining can be defined following: + * https://docs.spring.io/spring-data/jpa/docs/current/reference/html/#jpa.query-methods.query-creation + */ + + List findByIdContaining(@Param("text") String text); +} diff --git a/src/main/resources/application-flyio.yml b/src/main/resources/application-flyio.yml new file mode 100644 index 00000000..25f73f14 --- /dev/null +++ b/src/main/resources/application-flyio.yml @@ -0,0 +1,9 @@ +allowed-origins: "https://mypets-gei.fly.dev, https://deploy-preview-*--mypets-gei.fly.dev" + +logging: + level: + org: + hibernate: error + springframework.core: error + springframework.web: error + root: error diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 00000000..73f38dee --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,6 @@ +allowed-origins: http://localhost:4200 +default-password: password +spring: + h2: + console: + enabled: false diff --git a/src/test/java/cat/udl/eps/softarch/demo/CucumberTest.java b/src/test/java/cat/udl/eps/softarch/demo/CucumberTest.java new file mode 100644 index 00000000..eb613f91 --- /dev/null +++ b/src/test/java/cat/udl/eps/softarch/demo/CucumberTest.java @@ -0,0 +1,11 @@ +package cat.udl.eps.softarch.demo; + +import io.cucumber.junit.Cucumber; +import io.cucumber.junit.CucumberOptions; +import org.junit.runner.RunWith; + +@RunWith(Cucumber.class) +@CucumberOptions(plugin={"pretty"}, features="src/test/resources") +public class CucumberTest { + +} diff --git a/src/test/java/cat/udl/eps/softarch/demo/MyPetsTests.java b/src/test/java/cat/udl/eps/softarch/demo/MyPetsTests.java new file mode 100644 index 00000000..b6290bbe --- /dev/null +++ b/src/test/java/cat/udl/eps/softarch/demo/MyPetsTests.java @@ -0,0 +1,13 @@ +package cat.udl.eps.softarch.demo; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class MyPetsTests { + + @Test + void contextLoads() { + } + +} diff --git a/src/test/java/cat/udl/eps/softarch/demo/steps/AuthenticationStepDefs.java b/src/test/java/cat/udl/eps/softarch/demo/steps/AuthenticationStepDefs.java new file mode 100644 index 00000000..0093dc78 --- /dev/null +++ b/src/test/java/cat/udl/eps/softarch/demo/steps/AuthenticationStepDefs.java @@ -0,0 +1,36 @@ +package cat.udl.eps.softarch.demo.steps; + +import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.anonymous; +import static org.springframework.security.test.web.servlet.request.SecurityMockMvcRequestPostProcessors.httpBasic; + +import io.cucumber.java.Before; +import io.cucumber.java.en.Given; +import org.springframework.test.web.servlet.request.RequestPostProcessor; + +public class AuthenticationStepDefs { + + public static String currentUsername; + public static String currentPassword; + + @Before + public void setup() { + // Clear authentication credentials at the start of every test. + AuthenticationStepDefs.currentPassword = ""; + AuthenticationStepDefs.currentUsername = ""; + } + + static RequestPostProcessor authenticate() { + return currentUsername!=null ? httpBasic(currentUsername, currentPassword) : anonymous(); + } + + @Given("^I login as \"([^\"]*)\" with password \"([^\"]*)\"$") + public void iLoginAsWithPassword(String username, String password) { + AuthenticationStepDefs.currentUsername = username; + AuthenticationStepDefs.currentPassword = password; + } + + @Given("^I'm not logged in$") + public void iMNotLoggedIn() { + currentUsername = currentPassword = null; + } +} diff --git a/src/test/java/cat/udl/eps/softarch/demo/steps/RegisterStepDefs.java b/src/test/java/cat/udl/eps/softarch/demo/steps/RegisterStepDefs.java new file mode 100644 index 00000000..e505cb67 --- /dev/null +++ b/src/test/java/cat/udl/eps/softarch/demo/steps/RegisterStepDefs.java @@ -0,0 +1,112 @@ +package cat.udl.eps.softarch.demo.steps; + +import static org.hamcrest.Matchers.is; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.post; +import static org.springframework.test.web.servlet.result.MockMvcResultHandlers.print; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import cat.udl.eps.softarch.demo.domain.User; +import cat.udl.eps.softarch.demo.repository.UserRepository; +import io.cucumber.java.en.And; +import io.cucumber.java.en.Given; +import io.cucumber.java.en.When; +import org.json.JSONObject; +import org.junit.Assert; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.http.MediaType; + +import java.nio.charset.StandardCharsets; + +public class RegisterStepDefs { + + @Autowired + private StepDefs stepDefs; + + @Autowired + private UserRepository userRepository; + + @Given("^There is no registered user with username \"([^\"]*)\"$") + public void thereIsNoRegisteredUserWithUsername(String user) { + Assert.assertFalse("User \"" + + user + "\"shouldn't exist", + userRepository.existsById(user)); + } + + @Given("^There is a registered user with username \"([^\"]*)\" and password \"([^\"]*)\" and email \"([^\"]*)\"$") + public void thereIsARegisteredUserWithUsernameAndPasswordAndEmail(String username, String password, String email) { + if (!userRepository.existsById(username)) { + User user = new User(); + user.setEmail(email); + user.setId(username); + user.setPassword(password); + user.encodePassword(); + userRepository.save(user); + } + } + + @And("^I can login with username \"([^\"]*)\" and password \"([^\"]*)\"$") + public void iCanLoginWithUsernameAndPassword(String username, String password) throws Throwable { + AuthenticationStepDefs.currentUsername = username; + AuthenticationStepDefs.currentPassword = password; + + stepDefs.result = stepDefs.mockMvc.perform( + get("/identity", username) + .accept(MediaType.APPLICATION_JSON) + .with(AuthenticationStepDefs.authenticate())) + .andDo(print()) + .andExpect(status().isOk()); + } + + @And("^I cannot login with username \"([^\"]*)\" and password \"([^\"]*)\"$") + public void iCannotLoginWithUsernameAndPassword(String username, String password) throws Throwable { + AuthenticationStepDefs.currentUsername = username; + AuthenticationStepDefs.currentPassword = password; + + stepDefs.result = stepDefs.mockMvc.perform( + get("/identity", username) + .accept(MediaType.APPLICATION_JSON) + .with(AuthenticationStepDefs.authenticate())) + .andDo(print()) + .andExpect(status().isUnauthorized()); + } + + @When("^I register a new user with username \"([^\"]*)\", email \"([^\"]*)\" and password \"([^\"]*)\"$") + public void iRegisterANewUserWithUsernameEmailAndPassword(String username, String email, String password) throws Throwable { + User user = new User(); + user.setId(username); + user.setEmail(email); + + stepDefs.result = stepDefs.mockMvc.perform( + post("/users") + .contentType(MediaType.APPLICATION_JSON) + .content(new JSONObject( + stepDefs.mapper.writeValueAsString(user) + ).put("password", password).toString()) + .characterEncoding(StandardCharsets.UTF_8) + .accept(MediaType.APPLICATION_JSON) + .with(AuthenticationStepDefs.authenticate())) + .andDo(print()); + } + + @And("^It has been created a user with username \"([^\"]*)\" and email \"([^\"]*)\", the password is not returned$") + public void itHasBeenCreatedAUserWithUsername(String username, String email) throws Throwable { + stepDefs.result = stepDefs.mockMvc.perform( + get("/users/{username}", username) + .accept(MediaType.APPLICATION_JSON) + .with(AuthenticationStepDefs.authenticate())) + .andDo(print()) + .andExpect(jsonPath("$.email", is(email))) + .andExpect(jsonPath("$.password").doesNotExist()); + } + + @And("^It has not been created a user with username \"([^\"]*)\"$") + public void itHasNotBeenCreatedAUserWithUsername(String username) throws Throwable { + stepDefs.result = stepDefs.mockMvc.perform( + get("/users/{username}", username) + .accept(MediaType.APPLICATION_JSON) + .with(AuthenticationStepDefs.authenticate())) + .andExpect(status().isNotFound()); + } +} diff --git a/src/test/java/cat/udl/eps/softarch/demo/steps/StepDefs.java b/src/test/java/cat/udl/eps/softarch/demo/steps/StepDefs.java new file mode 100644 index 00000000..be0a0928 --- /dev/null +++ b/src/test/java/cat/udl/eps/softarch/demo/steps/StepDefs.java @@ -0,0 +1,71 @@ +package cat.udl.eps.softarch.demo.steps; + +import static org.hamcrest.Matchers.containsString; +import static org.hamcrest.Matchers.hasItem; +import static org.hamcrest.Matchers.is; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +import cat.udl.eps.softarch.demo.MyPets; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule; +import io.cucumber.java.Before; +import io.cucumber.java.en.And; +import io.cucumber.java.en.Then; +import io.cucumber.spring.CucumberContextConfiguration; +import org.junit.runner.RunWith; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootContextLoader; +import org.springframework.security.test.web.servlet.setup.SecurityMockMvcConfigurers; +import org.springframework.test.annotation.DirtiesContext; +import org.springframework.test.context.ActiveProfiles; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.test.context.web.WebAppConfiguration; +import org.springframework.test.web.servlet.MockMvc; +import org.springframework.test.web.servlet.ResultActions; +import org.springframework.test.web.servlet.setup.MockMvcBuilders; +import org.springframework.web.context.WebApplicationContext; + +@ContextConfiguration( + classes = {MyPets.class}, + loader = SpringBootContextLoader.class +) +@DirtiesContext +@RunWith(SpringRunner.class) +@WebAppConfiguration +@ActiveProfiles("Test") +@CucumberContextConfiguration +public class StepDefs { + + @Autowired + protected WebApplicationContext wac; + + protected MockMvc mockMvc; + + protected ResultActions result; + + protected ObjectMapper mapper = new ObjectMapper(); + + @Before + public void setup() { + this.mockMvc = MockMvcBuilders + .webAppContextSetup(this.wac) + .apply(SecurityMockMvcConfigurers.springSecurity()) + .build(); + this.mapper.registerModule(new JavaTimeModule()); + } + + @Then("^The response code is (\\d+)$") + public void theResponseCodeIs(int code) throws Throwable { + result.andExpect(status().is(code)); + } + + @And("^The error message is \"([^\"]*)\"$") + public void theErrorMessageIs(String message) throws Throwable { + if (result.andReturn().getResponse().getContentAsString().isEmpty()) + result.andExpect(status().reason(is(message))); + else + result.andExpect(jsonPath("$..message", hasItem(containsString(message)))); + } +} diff --git a/src/test/resources/features/RegisterUser.feature b/src/test/resources/features/RegisterUser.feature new file mode 100644 index 00000000..3f6be1fb --- /dev/null +++ b/src/test/resources/features/RegisterUser.feature @@ -0,0 +1,60 @@ +Feature: Register User + In order to use the app + As a user + I want to register myself and get an account + + Scenario: Register new user + Given There is no registered user with username "user" + And I'm not logged in + When I register a new user with username "user", email "user@sample.app" and password "password" + Then The response code is 201 + And It has been created a user with username "user" and email "user@sample.app", the password is not returned + And I can login with username "user" and password "password" + + Scenario: Register existing username + Given There is a registered user with username "user" and password "existing" and email "user@sample.app" + And I'm not logged in + When I register a new user with username "user", email "user@sample.app" and password "newpassword" + Then The response code is 409 + And I cannot login with username "user" and password "newpassword" + + Scenario: Register user when already authenticated + Given I login as "demo" with password "password" + When I register a new user with username "user", email "user@sample.app" and password "password" + Then The response code is 403 + And It has not been created a user with username "user" + + Scenario: Register user with empty password + Given I'm not logged in + When I register a new user with username "user", email "user@sample.app" and password "" + Then The response code is 400 + And The error message is "must not be blank" + And It has not been created a user with username "user" + + Scenario: Register user with empty email + Given I'm not logged in + When I register a new user with username "user", email "" and password "password" + Then The response code is 400 + And The error message is "must not be blank" + And It has not been created a user with username "user" + + Scenario: Register user with invalid email + Given I'm not logged in + When I register a new user with username "user", email "userasample.app" and password "password" + Then The response code is 400 + And The error message is "must be a well-formed email address" + And It has not been created a user with username "user" + + Scenario: Register user with password shorter than 8 characters + Given I'm not logged in + When I register a new user with username "user", email "user@sample.app" and password "pass" + Then The response code is 400 + And The error message is "length must be between 8 and 256" + And It has not been created a user with username "user" + + Scenario: Register user with an existing email + Given There is a registered user with username "user" and password "password" and email "user@sample.app" + And I'm not logged in + When I register a new user with username "user2", email "user@sample.app" and password "password2" + Then The response code is 409 + And I can login with username "user" and password "password"