Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danijeldragicevic/account-rest-service
Service who manages employee's accounts and their salaries.
https://github.com/danijeldragicevic/account-rest-service
gradle h2-database hyperskill-solutions java-11 project-lombok spring-boot spring-mvc spring-security spring-validation
Last synced: about 1 month ago
JSON representation
Service who manages employee's accounts and their salaries.
- Host: GitHub
- URL: https://github.com/danijeldragicevic/account-rest-service
- Owner: danijeldragicevic
- License: apache-2.0
- Created: 2022-12-30T13:36:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-13T16:08:46.000Z (almost 2 years ago)
- Last Synced: 2024-11-07T10:35:53.655Z (3 months ago)
- Topics: gradle, h2-database, hyperskill-solutions, java-11, project-lombok, spring-boot, spring-mvc, spring-security, spring-validation
- Language: Java
- Homepage:
- Size: 117 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Account REST Service
Backend service who manages employee's accounts and their salaries.
Service is able to:
- register new users,
- manage their passwords and roles,
- give access to the employee's payrolls,
- displays information about all users and
- log information security events.
Service use embedded H2 database and Basic authentication.
# Technology
- Java 11
- Spring Boot 2.7.1 (Spring Web MVC, Spring Data Jpa, Spring Security, Spring Validation, Project Lombok, H2 database)
- Gradle 7.4
# To run application:
Navigate to the project root directory and run **./gradlew bootRun**
# Exposed endpoints:
By default, service will run on **http://localhost:28852**
Following endpoints will be exposed:
| Methods | Urls | Anonymous | User | Accountant | Administrator | Auditor | Action |
|---------|------------------------|-----------|------|------------|---------------|---------|--------------------------------------------|
| GET | /h2 | + | + | + | + | + | Access to the local database |
| POST | /api/auth/signup | + | + | + | + | + | Allows the user to register on the service |
| POST | /api/auth/changepass | - | + | + | + | - | Changes a user password |
| GET | /api/admin/user/ | - | - | - | + | - | Displays information about all users |
| PUT | /api/admin/user/role | - | - | - | + | - | Changes user role |
| PUT | /api/admin/user/access | - | - | - | + | - | Lock or unlock user |
| DELETE | /api/admin/user/:email | - | - | - | + | - | Deletes a user by it's :email |
| POST | /api/acct/payments | - | - | + | - | - | Uploads payrolls for multiple users |
| PUT | /api/acct/payments | - | - | + | - | - | Updates payment information for one user |
| GET | /api/empl/payment | - | + | + | + | + | Gives access to the employee's payrolls |
| GET | /api/security/events | - | - | - | - | + | Show security events of the service |
# Examples
**Example 1:** POST /api/auth/signup
First user created on the system will get ADMINISTRATOR role, every other user created will get USER role.
Additional roles can be provided to the user(s).
Service will check are all the fields filled with data, as well as whether the user already exists in the system.
Also service expects that every user have email of **acme.com** domain.
Password will be checked against a **set of breached passwords**.
For testing purposes, here is the list of breached passwords that is hardcoded in the application:
```
"PasswordForJanuary", "PasswordForFebruary", "PasswordForMarch", "PasswordForApril",
"PasswordForMay", "PasswordForJune", "PasswordForJuly", "PasswordForAugust",
"PasswordForSeptember", "PasswordForOctober", "PasswordForNovember", "PasswordForDecember"
```
In case of error, response with appropriate HTTP status will be returned, with the following body structure:
```
{
"timestamp": "",
"status": ,
"error": "",
"message": "",
"path": ""
}
```
Request body (1st user):
```
{
"name": "John",
"lastname": "Doe",
"email": "[email protected]",
"password": "123456789ABC"
}
```
Response: 200 OK.
Response body:
```
{
"id": 1,
"name": "John",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_ADMINISTRATOR"
]
}
```
Request body (2nd user):
```
{
"name": "Jane",
"lastname": "Doe",
"email": "[email protected]",
"password": "123456789ABC"
}
```
Response: 200 OK.
Response body:
```
{
"id": 2,
"name": "Jane",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_USER"
]
}
```
Request body (3rd user):
```
{
"name": "Judy",
"lastname": "Doe",
"email": "[email protected]",
"password": "123456789ABC"
}
```
Response: 200 OK.
Response body:
```
{
"id": 3,
"name": "Judy",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_USER"
]
}
```
Request body (4th user):
```
{
"name": "James",
"lastname": "Doe",
"email": "[email protected]",
"password": "123456789ABC"
}
```
Response: 200 OK.
Response body:
```
{
"id": 4,
"name": "James",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_USER"
]
}
```
**Example 2:** POST /api/auth/changepass
With the correct authentication: username = "[email protected]", password = "123456789ABC".
New password must be different from the old one.
Password will be checked against a **[set of breached passwords](README.md#Examples)**.
Request body:
```
{
"new_password": "123456789DEF"
}
```
Response: 200 OK.
Response body:
```
{
"email": "[email protected]",
"status": "The password has been updated successfully."
}
```
**Example 3:** GET/api/admin/user
With the correct authentication: username = "[email protected]", password = "123456789DEF".
Response: 200 OK.
Response body:
```
[
{
"id": 1,
"name": "John",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_ADMINISTRATOR"
]
},
{
"id": 2,
"name": "Jane",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_USER"
]
},
{
"id": 3,
"name": "Judy",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_USER"
]
},
{
"id": 4,
"name": "James",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_USER"
]
}
]
```
**Example 4:** PUT /api/admin/user/role
With the correct authentication: username = "[email protected]", password = "123456789DEF".
Request body:
```
{
"user": "[email protected]",
"role": "ACCOUNTANT",
"operation": "GRANT"
}
```
Response 200 OK.
Response body:
```
{
"id": 3,
"name": "Judy",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_ACCOUNTANT",
"ROLE_USER"
]
}
```
Request body:
```
{
"user": "[email protected]",
"role": "AUDITOR",
"operation": "GRANT"
}
```
Response 200 OK.
Response body:
```
{
"id": 4,
"name": "James",
"lastname": "Doe",
"email": "[email protected]",
"roles": [
"ROLE_AUDITOR",
"ROLE_USER"
]
}
```
Service recognises two groups of roles:
- administrative role (ADMINISTRATOR) and
- business roles (USER, ACCOUNTANT and AUDITOR).
Those two groups can not be combined, which means that the user from administrative group,
can not have role from the business group and vice versa. In case it is attempted, bad request will be returned:
```
{
"timestamp": "2023-01-11",
"status": 400,
"error": "Bad Request",
"message": "The user cannot combine administrative and business roles!",
"path": "/api/admin/user/role"
}
```
In case that unknown role or operation is requested, bad request similar to this will be returned:
```
{
"timestamp": "2023-01-11",
"status": 400,
"error": "Bad Request",
"message": "Operation field should be GRANT or REMOVE.",
"path": "/api/admin/user/role"
}
```
**Example 4:** PUT /api/admin/user/access
With the correct authentication: username = "[email protected]", password = "123456789DEF".
Request body:
```
{
"user": "[email protected]",
"operation": "LOCK"
}
```
Response 200 OK.
Response body:
```
{
"status": "User [email protected] is locked!"
}
```
Administrator can not be locked. In case it is attempted, bad request will be returned:
```
{
"timestamp": "2023-01-11",
"status": 400,
"error": "Bad Request",
"message": "Can't lock the ADMINISTRATOR!",
"path": "/api/admin/user/access"
}
```
**Example 5:** DELETE /api/admin/user/[email protected]
With the correct authentication: username = "[email protected]", password = "123456789DEF".
Response 200 OK.
Response body:
```
{
"user": "[email protected]",
"status": "Deleted successfully!"
}
```
Administrator can not be removed. In case it is attempted, bad request will be returned:
```
{
"timestamp": "2023-01-11",
"status": 400,
"error": "Bad Request",
"message": "Can't remove ADMINISTRATOR role!",
"path": "/api/admin/user/[email protected]"
}
```
**Example 6:** POST /api/acct/payments
With the correct authentication: username = "[email protected]", password = "123456789ABC".
Request body:
```
[
{
"employee": "[email protected]",
"period": "01-2021",
"salary": 1234
},
{
"employee": "[email protected]",
"period": "01-2021",
"salary": 5678
},
{
"employee": "[email protected]",
"period": "01-2021",
"salary": 9876
}
]
```
Response 200 OK.
Response body:
```
{
"status": "Added successfully!"
}
```
Service will check are all the fields filled with data.
Service will check are there duplicate entries, i.e. are there two salaries for the same user on a same month.
Also, service expects date in the format MM-YYYY and salary to be non-negative number.
In case it is attempted, similar error will be thrown:
```
{
"timestamp": "2023-01-11",
"status": 400,
"error": "Bad Request",
"message": "payments[0].employee: Employee can not be empty!, payments[1].period: Wrong date!, payments[2].salary: Salary must be non negative!",
"path": "/api/acct/payments"
}
```
**Example 7:** PUT /api/acct/payments
With the correct authentication: username = "[email protected]", password = "123456789ABC".
Request body:
```
{
"employee": "[email protected]",
"period": "01-2021",
"salary": 9999
}
```
Response 200 OK.
Response body:
```
{
"status": "Updated successfully!"
}
```
Service will check are all the fields filled with data.
Service will check is there already existing payment that we want to update, i.e. payment for requested user on a specified month.
Also, service expects date in the format MM-YYYY and salary to be non-negative number.
In case it is attempted, similar error will be thrown:
```
{
"timestamp": "2023-01-11",
"status": 400,
"error": "Bad Request",
"message": "Payment does not exists!",
"path": "/api/acct/payments"
}
```
**Example 8:** GET /api/empl/payment
With authentication credentials of existing user, e.g. username = "[email protected]", password = "123456789DEF".
Response 200 OK.
Response body:
```
[
{
"name": "John",
"lastname": "Doe",
"period": "January-2021",
"salary": "99 dollar(s) 99 cent(s)"
}
]
```
Service will respond with the salary information for the user who requested it.
If user does not exist or entered credentials are not correct, error will be thrown:
```
{
"timestamp": "2023-01-11",
"status": 401,
"error": "Unauthorized",
"message": "Username or password are not correct!",
"path": "/api/empl/payment"
}
```
**Example 9:** GET /api/security/events
With the correct authentication: username = "[email protected]", password = "123456789ABC".
Application logs following security events:
| Description | Event name |
|--------------------------------------------------------------|-----------------|
| A user has been successfully registered | CREATE_USER |
| A user has changed the password successfully | CHANGE_PASSWORD |
| A user is trying to access a resource without access rights | ACCESS_DENIED |
| Failed authentication | LOGIN_FAILED |
| A role is granted to a user | GRANT_ROLE |
| A role has been revoked | REMOVE_ROLE |
| The Administrator has locked the user | LOCK_USER |
| The Administrator has unlocked the user | UNLOCK_USER |
| The Administrator has deleted a user | DELETE_USER |
| A user has been blocked on suspicion of a brute force attack | BRUTE_FORCE |
The composition of the security event fields is:
```
{
"date": "",
"action": "",
"subject": "",
"object": "",
"path": ""
}
```
If user made more than three failed login attempts, BRUTE_FORCE event will be registered and that user will be locked.
Response 200 OK.
Response body:
```
[
{
"id": 1,
"date": "2023-01-11",
"action": "CREATE_USER",
"subject": "Anonymous",
"object": "[email protected]",
"path": "/api/auth/signup"
},
{
"id": 2,
"date": "2023-01-11",
"action": "CREATE_USER",
"subject": "Anonymous",
"object": "[email protected]",
"path": "/api/auth/signup"
},
{
"id": 3,
"date": "2023-01-11",
"action": "CREATE_USER",
"subject": "Anonymous",
"object": "[email protected]",
"path": "/api/auth/signup"
},
{
"id": 4,
"date": "2023-01-11",
"action": "CREATE_USER",
"subject": "Anonymous",
"object": "[email protected]",
"path": "/api/auth/signup"
},
{
"id": 5,
"date": "2023-01-11",
"action": "CHANGE_PASSWORD",
"subject": "[email protected]",
"object": "[email protected]",
"path": "/api/auth/changepass"
},
{
"id": 6,
"date": "2023-01-11",
"action": "GRANT_ROLE",
"subject": "[email protected]",
"object": "Grant role ROLE_ACCOUNTANT to [email protected]",
"path": "/api/admin/user/role"
},
{
"id": 7,
"date": "2023-01-11",
"action": "GRANT_ROLE",
"subject": "[email protected]",
"object": "Grant role ROLE_AUDITOR to [email protected]",
"path": "/api/admin/user/role"
},
{
"id": 8,
"date": "2023-01-11",
"action": "LOCK_USER",
"subject": "[email protected]",
"object": "Lock user [email protected]",
"path": "/api/admin/user/access"
},
{
"id": 9,
"date": "2023-01-11",
"action": "DELETE_USER",
"subject": "[email protected]",
"object": "[email protected]",
"path": "/api/admin/user/[email protected]"
},
{
"id": 10,
"date": "2023-01-11",
"action": "LOGIN_FAILED",
"subject": "[email protected]",
"object": "/api/acct/payments",
"path": "/api/acct/payments"
},
{
"id": 11,
"date": "2023-01-11",
"action": "LOGIN_FAILED",
"subject": "[email protected]",
"object": "/api/acct/payments",
"path": "/api/acct/payments"
},
{
"id": 12,
"date": "2023-01-11",
"action": "LOGIN_FAILED",
"subject": "[email protected]",
"object": "/api/acct/payments",
"path": "/api/acct/payments"
},
{
"id": 13,
"date": "2023-01-11",
"action": "BRUTE_FORCE",
"subject": "[email protected]",
"object": "/api/acct/payments",
"path": "/api/acct/payments"
},
{
"id": 14,
"date": "2023-01-11",
"action": "LOCK_USER",
"subject": "[email protected]",
"object": "Lock user [email protected]",
"path": "/api/acct/payments"
}
]
```
# Licence
[](https://opensource.org/licenses/Apache-2.0)