This is a simple microservices-based application which exposes a RESTful API. It is written in Java using the Spring Boot framework. It is intended for use as part of the SESC module at Leeds Beckett University.
- Create Account - create a finance account by passing a student ID.
- Query Account - find a finance account by passing a student ID. The response shows whether the account has an outstanding balance.
- View Invoice - view all invoices or a single invoice, by invoice ID.
- Create Invoice - create a new outstanding invoice by passing a student ID.
- Pay Invoice - pay an outstanding invoice.
- Cancel Invoice - cancel an outstanding invoice.
The application integrates with a MariaDB relational database.
Scripts to create the database schema can be found in the migrations folder and are run automatically by docker-compose.
The application integrates with the Student microservice via REST.
- When a student is created, a request is sent to this application to create an account.
- When a student enrols in a course, a request is sent to this application to create an invoice.
- When checking the eligibility to graduate, a request is sent to this application to see if there are any outstanding invoices.
The application integrates with the Library microservice via REST.
- When a book is returned late, a fine is issued. A request is sent to this application to create an invoice.
- The invoice must be paid via this application's Payment Portal.
- Rename the
.env.examplefile inside thefinancedirectory to.env: - From the
financedirectory, run the app and db services:
docker-compose up
Download Postman from https://www.postman.com/ and import the collections found in the finance/postman directory.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.
Copyright (c) 2021 Thalita Vergilio
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.