https://github.com/joeltadeu/atm-simulator
This project contains basic operations to simulate a ATM machine as get account balance and dispense money using a microservice architecture with spring-boot, sprinc-contract-test and java 17
https://github.com/joeltadeu/atm-simulator
docker docker-compose h2-database java17 spring-boot spring-cloud-contract spring-feign
Last synced: 8 months ago
JSON representation
This project contains basic operations to simulate a ATM machine as get account balance and dispense money using a microservice architecture with spring-boot, sprinc-contract-test and java 17
- Host: GitHub
- URL: https://github.com/joeltadeu/atm-simulator
- Owner: joeltadeu
- Created: 2022-02-01T01:30:11.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-02-08T00:44:53.000Z (over 3 years ago)
- Last Synced: 2025-01-07T12:45:15.382Z (9 months ago)
- Topics: docker, docker-compose, h2-database, java17, spring-boot, spring-cloud-contract, spring-feign
- Language: Java
- Homepage:
- Size: 153 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ATM machine
## Overview:
We all know how ATM machines work… don’t we? You are tasked with developing software for one that:
should initialize with the following accounts:
| Account Number | PIN | Opening Balance | Overdraft |
|----------------|----------|:-------------------:|-------------|
| 123456789 | 1234 | 800 | 200 |
| 987654321 | 4321 | 1230 | 150 |
### Business rules ###
* should initialize with €1500 made up of 10 x €50s, 30 x €20s, 30 x €10s and 20 x €5s
* should not dispense funds if the pin is incorrect,
* cannot dispense more money than it holds,
* cannot dispense more funds than customer have access to
* should not expose the customer balance if the pin is incorrect,
* should only dispense the exact amounts requested,
* should dispense the minimum number of notes per withdrawal,
The application should receive the data, process the operations, and then output the results, it is responsible for validating customer account details and performing basic operations as described by API requirements:
* Create a Rest API (curl, postman, browser) that should be able to request a balance check along with maximum withdrawal amount (if any),
* User should be able to request a withdrawal. If successful - details of the notes that would be dispensed along with remaining balance,
* If anything goes wrong, user should receive meaningful message, and there should be no changes in user’s account,
Assume application will be distributed as Docker image. Provide Dockerfile, but don’t waste too much time for building and testing docker image, focus on functionality.
Assume importance levels:
* Code working as described in requirements,
* Application is building with mvn install or gradle build command (or any basic build command working on behalf of programming language you choose),
* Unit tests are included. Coverage level depends on time you have left to complete the assignment, but we would like to see business logic (service layer) coverage at 60%,
* Other things you would like to implement for this project (ex. Database, application test coverage over 90%, API for gathering different statistics, UI or whatever else you think would make your application extraordinary)
## Architecture:
### EndPoints ###
| Service | EndPoint | Port | Method | Description |
|-----------|---------------------------------------|:----:|:------:|---------------------------------------|
| ATM | /v1/atm/dispense | 7500 | POST | Dispense amount requested by the user |
| ATM | /v1/atm/balance | 7500 | GET | Get balance from account |
| Account | /v1/accounts/{accountNumber}/balance | 7501 | GET | Get balance from account |
| Account | /v1/accounts/{accountNumber}/withdraw | 7501 | PUT | Withdraw money from account |
| Account | /v1/accounts/{accountNumber}/deposit | 7501 | PUT | Deposit money to account |
### Documentation and examples ###
### Swagger
- **ATM** : http://localhost:7500/swagger-ui.html
- **Accounts** : http://localhost:7501/swagger-ui.html
### Postman collection
## Build & Run
to build
```
mvn clean package
```
build docker images and containers and run containers
```
docker-compose up --build
```
stop the dockerized services
```
docker-compose stop
```
In docker-compose.yml file:
- ATM Service : **__7500__** port is mapped to **__7500__** port of host
- Account Service : **__7501__** port is mapped to **__7501__** port of host
## Versions
### 1.0.0
- Spring-Boot 2.6.3
- Spring Cloud Contract Test
- Java 17