veerao05 / besedo Goto Github PK

To build 3 rest points to perform following operations:

1. One endpoint to ingest an JSON object with the following format. Fields have length constraint on min/max, email is required and only one of title and body is required.
2. One endpoint to return this data, considering that the dataset will contain a large number of entries. Filtering should also be possible, by a single field, one of id, email, title or body.
3. One endpoint that returns a CSV file that is a report on the ingested items, composed of two columns, the first one being the id of the item and the second one being the amount of vowels contained in the body.

(back to top)

Following are the technologies used to build the framework.

(back to top)

Clone the repository

git clone https://github.com/veerao05/besedo.git

Setting up the workspace

After cloning the Repository it can be placed anywhere on your local hard drive.

For building and running the application you need:

• JDK 1.8
• Maven 3
• H2

cd <path_of_backend_repo>
mvn clean install
Ex: <MainPath>/besedo/

1. Locally

Run BesedoMainApplication.java file

2. Docker

To Build the Docker image:  
cd <MainPath>/besedo/ 
docker build  --tag=besedo:latest . 

To Run the springboot application in container: 
docker run --name=besedo -it -e DATABASE_SERVER=jdbc:h2:mem:testdb -dp 8080:8080 -v ${PWD}/logs:/besedo/logs besedo:latest

To see the container logs:
docker logs -f --tail 10 besedo

To enter inside the container: 
docker exec -it besedo  sh

To stop the container:
docker stop besedo

To delete all the stopped container:
docker container rm $(docker ps -a -q)

To delete the image:
docker rmi <image-id>

To obtain image id:
docker images

Here are some url samples for pagination (with/without filter):

/api/data: using default page and size

/api/data?page=1&size=5: using 1st page and 5 size

/api/data?size=5: using default value for page

/api/data?id=1&page=1&size=3: pagination & filter by id

/api/data?title=Senior Engineer&csv=false: pagination & filter by ‘title’ status

/api/data?csv=true: to generate csv report

. Sorting

. SQL Db

. Error Code Handling

. Additional Junit

. Update and Delete endpoints

• Add any suggestions

See the open issues for a full list of proposed features (and known issues).

(back to top)

Improvements given:

1. Exceptions handling using spring
2. Global exception handling
3. CSV reader null pointer on getBody()
4. Load on get mapping can be done using indexing/search DB should be used.
5. Load on Post mapping can be done through queues/Spring Batch
6. if (data.charAt(i) == 'a' || data.charAt(i) == 'e' || data.charAt(i) == 'i' || data.charAt(i) == 'o' || data.charAt(i) == 'u') { count++; }. Use lamda expression
7. Dont try to throw exceptions from Helper class(Bottom class) . How do you handle the exceptions thrown from bottom class in Upper class.
8. Why Query is used why not getbyId or getByEmail was used? It can be used , to provide pagination all in one method use query here. Alternative is HSQL/getbyId or getByEmail
9. findDataList(String id, String email, String title, String body, Pageable pageable, boolean csv) - could have used all the paramaters in one class object.
10. Since @lombok.Data is used , controller could have used controller injection. so use @RequiredArgsConstructor
11. Unit test cases for Controller and service/business layer
12. Entity is directly exposed . so use view object instead of exposing Entity.
13. POST request didnt not return any response message.
14. countVowels(data.getBody()) - handle Null pointer exception in case of GetBody null.
15. email is required and only one of title and body is required. - Didnt understand the question properly here.
16. Exception handling with different codes could have been done better to the clients.
17. Handling duplicate records.
18. Why inbuilt CSV library was used?
19. Why Java8 was used why not JAVA16?

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/SampleFeature)
3. Commit your Changes (git commit -m 'Add some SampleFeature')
4. Push to the Branch (git push origin feature/SampleFeature)
5. Open a Pull Request

(back to top)

Your Name - VeenaRao and Email:[email protected]

Project Link: https://github.com/veerao05/besedo

(back to top)

List of resources used for project reference.

• Img Shields
• GitHub Pages

(back to top)