Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rajagopal28/stocks-splurge

A java spring-boot based REST application to handle stocks based CRUD operations with some locking techniques to prevent short time stock data manipulation.
https://github.com/rajagopal28/stocks-splurge

dependency-injection inversion-of-control jpa-hibernate mvc-pattern rest-api single-page-app single-responsibility-principle spring-boot spring-mvc stocks tdd-java test-pyramid

Last synced: 26 days ago
JSON representation

A java spring-boot based REST application to handle stocks based CRUD operations with some locking techniques to prevent short time stock data manipulation.

Host: GitHub
URL: https://github.com/rajagopal28/stocks-splurge
Owner: rajagopal28
License: mit
Created: 2021-11-11T14:23:46.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2021-11-15T06:22:57.000Z (about 3 years ago)
Last Synced: 2024-11-15T16:12:33.655Z (3 months ago)
Topics: dependency-injection, inversion-of-control, jpa-hibernate, mvc-pattern, rest-api, single-page-app, single-responsibility-principle, spring-boot, spring-mvc, stocks, tdd-java, test-pyramid
Language: Java
Homepage:
Size: 3.22 MB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Stocks Splurge - Stock data REST API
A java spring-boot based REST application to handle stocks based CRUD operations with some locking techniques to prevent short time stock data manipulation.
It is a minimal Proof of concept that adheres to the requirements mentioned in [Here](./Requirements.md)

### Key aspects related to implementation:
- Employing test driven development practice while building application - Each module goes through the `red` -> `fix` -> `green` -> `refactor` cycle
- Intensive unit tests - Mocktio based unit tests to observe interactions of various actors
- Separation of concerns - Modular approach on top of MVC paradigm in giving specific responsibility to each module in the application
- *Persistence layer* powered by jpa/hibernate libraies taking care of the data persistence with simplified ORM capabilities mapping to relational entities.
- *Service layer* to handle data persistence and business logics required to invoke the what3words api with the location data supplied
- *Controller* to handle all the endpoint calls to process the data from users.
- *Models* to keep track of data that is processed by the system.
- *ControllerAdvice* to handle all the user defined exceptions handled at the runtime to send proper response code to users to better understand the flow.
- Dependency resolution with Spring-Boot's Auto-configuration and dependency resolution.
- MVC test to support integration testing of the entire Spring Application.
- Lombok - used annotation based pre-processing to reduce a lot of boilerplate code that can be deferred to compile time.
- H2 in memory data base along with the persistence capabilities in java/spring-boot to enable in-memory data management.
- Minimal UI : Single page UI with the stock CRUD operations created using jQuery UI with essential aspects with javascript and css. With my very minimal knowledge on styling and css I used jQuery UI to create a simpler app in a really limited amount of time.

## TDD - Red->Green->Refactor cycle
![TDD Diagram](./images/red-green-refactor.png)

## REST APIs

#### Post new Stock to system
##### Request
```http
POST /api/stocks HTTP/1.1
Host: localhost:8080
Content-Type: application/json

{
"name":"PCNQ",
"currentPrice": 12.45
}
```
### Request format:
*name* – the name of the company stock in the system.
*currentPrice* - the price of that particular stock.

##### Response
Returns: The created stock object with reference details.

200 – in case of success
400 – if the request is missing the name or invalid price.
208 – if the name given to update is found in system for other stock.
422 – if one of the fields sent is empty or wrong.
403 - if the request is to update/delte the stock within the lock window.

```http
HTTP/1.1 201 Created
Content-Type: application/json

{
"id": 1,
"name": "PCNQ",
"currentPrice": 12.45,
"timeCreated": 1636817934,
"lastUpdated": 1636817934
}

```

```http
HTTP/1.1 208 Already reported
Content-Type: application/json

```

```http
HTTP/1.1 422 Unprocessable Entity
Content-Type: application/json

{
"message": "Invalid request data passed!"
}

```

#### Get Particular stock in the system with ID
##### Response
Returns: The created stock object with reference details.

200 – in case of success
204 – if the given id is not in the system.

```http
GET /api/stocks/1 HTTP/1.1
Host: localhost:8080

{
"id": 1,
"name": "PCNQ",
"currentPrice": 12.45,
"timeCreated": 1636817934,
"lastUpdated": 1636817934
}
```

```http
HTTP/1.1 204 No content
Content-Type: application/json

```

#### Get List of all stocks in the system.
##### Response
Returns: The list of created stock objects with reference details.
200 – in case of success

```http
GET /api/stocks/ HTTP/1.1
Host: localhost:8080

[{
"id": 1,
"name": "PCNQ",
"currentPrice": 12.45,
"timeCreated": 1636817934,
"lastUpdated": 1636817934
},{
"id": 2,
"name": "ADYN",
"currentPrice": 45.87,
"timeCreated": 1636817934,
"lastUpdated": 1636817934
}]
```

#### Delete Particular stock in the system with ID
##### Response
Returns: The created stock object with reference details.

200 – in case of success
204 – if the given id is not in the system.
403 - if the request is to update/delete the stock within the lock window.

```http
DELTE /api/stocks/1 HTTP/1.1
Host: localhost:8080

{
"id": 1,
"name": "PCNQ",
"currentPrice": 12.45,
"timeCreated": 1636817934,
"lastUpdated": 1636817934
}
```

```http
HTTP/1.1 204 No content
Content-Type: application/json

```

```http
HTTP/1.1 402 Forbidden
Content-Type: application/json

{
"message": "Cannot manipulate stock within Lock window!"
}

```

#### Update Stock name or price in the system with ID
##### Request
```http
PUT /api/stocks/1 HTTP/1.1
Host: localhost:8080
Content-Type: application/json

{
"name":"PCNQ2",
"currentPrice": 23.32
}
```
### Request format:
*name* – the name of the company stock in the system.
*currentPrice* - the price of that particular stock.

##### Response
Returns: The created stock object with reference details.

```http
HTTP/1.1 200 OK
Content-Type: application/json

{
"id": 1,
"name": "PCNQ2",
"currentPrice": 23.32,
"timeCreated": 1636817934,
"lastUpdated": 1636817934
}

```

```http
HTTP/1.1 208 Already reported
Content-Type: application/json

```

```http
HTTP/1.1 400 Bad Request
Content-Type: application/json

{
"message": "Blank request cannot be updated!"
}

```

```http
HTTP/1.1 402 Forbidden
Content-Type: application/json

{
"message": "Cannot manipulate stock within Lock window!"
}

```

### Single page UI
#### Home
![Home](./images/web/home.png)

#### Add Stock
![Add-Stock](./images/web/new-stock.png)

![Add-Stock](./images/web/new-stock-warning.png)

#### Update Stock
![Update-Stock](./images/web/update-stock.png)

![Update-Stock](./images/web/update-stock-warning.png)

![Update-Stock](./images/web/update-stock-error.png)

#### Delete Stock
![Delete-Stock](./images/web/delete-stock-warning.png)

![Delete-Stock](./images/web/delete-stock-error.png)

### Test Coverage
![TestCoverage](./images/test-coverage-1.png)

![TestCoverage](./images/test-coverage-2.png)

![TestCoverage](./images/test-coverage-3.png)

### Dependencies
![Dependencies](./images/dependencies-1.png)

![Dependencies](./images/dependencies-2.png)

![Dependencies](./images/dependencies-3.png)

## Testing
This application is build following TDD principles and are rich with various integration/unit tests based on test pyramids
To run all the tests:

```bash
mvn clean test
```

## Build
In order to build this application, run the following maven command.
```bash
mvn clean package
```
### installing the packages
With Tests:
```bash
$ mvn clean install -U
```
### running tests
Unit tests:
```bash
$ mvn test
```

## running the app locally in localhost:8080
Application Server:
```bash
$ java target/stocks-splurge-1.0.0.jar
```

> Developed in Jetbrain's IntelliJ IDE

## References
- mocktio failing for API class: https://stackoverflow.com/a/58200905
- json name setting: https://stackoverflow.com/q/40969156
- `handlerExceptionResolver` not found bean issue : https://stackoverflow.com/a/56121977
- json ignore fields: https://www.baeldung.com/jackson-ignore-null-fields
- integration testing: https://stackoverflow.com/a/35402975
- Mock external API call :
- https://stackoverflow.com/questions/20504399/testing-springs-requestbody-using-spring-mockmvc
- using wiremock : https://stackoverflow.com/a/40908543
- using easymock: https://stackoverflow.com/a/61685017
- assert json content in mvc testing : https://stackoverflow.com/a/41670634
- serving html/static content via rest controller : https://stackoverflow.com/a/47170750
- spring-boot jpa with h2 in-memory:
- https://spring.io/guides/gs/accessing-data-jpa/
- https://www.baeldung.com/spring-boot-h2-database
- jquery UI:
- Modal: https://api.jqueryui.com/dialog/
- closing modal: https://stackoverflow.com/a/58323185
- dynamic string with data from variable:
- $.ajax : https://www.w3schools.com/jquery/ajax_post.asp
- https://stackoverflow.com/a/2845487
- error handling: https://stackoverflow.com/q/377644
- events on dynamic buttons: https://stackoverflow.com/a/20030230
- js date from epoch time: https://stackoverflow.com/a/8016205
- dynamically changed accordion content not applying effect issue: https://stackoverflow.com/a/31584133

## License

MIT