konianzero / RestaurantVotingSystem

A restaurant voting system REST API using Spring Boot 2.5

Restaurant Voting System

Spring Boot 2.5.

A restaurant voting system (REST API) for deciding where to have lunch.

• 2 types of users: admin and regular users
• Admin can input a restaurant, and it's lunch menu of the day (2-5 items usually, just a dish name and price)
• Menu changes each day (admins do the updates)
• Users can vote on which restaurant they want to have lunch at
• Only one vote counted per user
• If user votes again the same day:
  • If it is before 11:00 we assume that he changed his mind.
  • If it is after 11:00 then it is too late, vote can't be changed.

Each restaurant provides new menu each day.

---

Project uses:

• Tomcat as web server
• Spring MVC as MVC framework (Controllers)
• Spring Security for separate access for regular users and admins
• HSQLDB for storing data
• Hibernate and Spring Data JPA for working with DB
• Ehcache for caching
• MapStruct for mapping entities from/to transfer objects
• Jackson for processing JSON
• JUnit for testing
• Swagger/OpenAPI 3.0 for API documentation
• Docker to run app in container (Dockerfile)

Application Properties

---

Requirements

• JDK 17
• maven 3
• Docker 20

---

Launch

Local

mvn spring-boot:run

In container

mvn clean package

docker build -t restaurant/voting_system .

docker run --name votingSystem -d --rm -p 8080:8080 restaurant/voting_system:latest

URL: http://localhost:8080/voting

---

Users

Name	Email	Password	Roles
Mike	[e-mail]	admin	Admin, User
Nick	[e-mail]	userpass	User

---

API documentation

Swagger Api Documentation

API	Method	Description	URL	User
Admin	POST	Create user	{URL}/rest/admin/users	Admin
	GET	Get user	{URL}/rest/admin/users/{userId}	Admin
	GET	Get user by Email	{URL}/rest/admin/users/by?email={email}	Admin
	GET	Get all user	{URL}/rest/admin/users	Admin
	UPDATE	Update user	{URL}/rest/admin/users/{userId}	Admin
	DELETE	Delete user	{URL}/rest/admin/users/{userId}	Admin
Profile	POST	Create user	{URL}/rest/profile/register	Not Authorized
	GET	Get user	{URL}/rest/profile	Authorized
	UPDATE	Update user	{URL}/rest/profile	Authorized
	DELETE	Delete user	{URL}/rest/profile	Authorized
Restaurant	POST	Create restaurant	{URL}/rest/restaurants	Admin
	GET	Get restaurant	{URL}/rest/restaurants/{restaurantId}	Authorized
	GET	Get restaurant with today's dishes	{URL}/rest/restaurants/{restaurantId}/today	Authorized
	GET	Get all restaurants	{URL}/rest/restaurants/	Authorized
	GET	Get all restaurants with today's dishes	{URL}/rest/restaurants/today	Authorized
	PUT	Update restaurant	{URL}/rest/restaurants/{restaurantId}	Admin
	DELETE	Delete restaurant	{URL}/rest/restaurants/{restaurantId}	Admin
Dish	POST	Create dish	{URL}/rest/dishes	Admin
	GET	Get dish	{URL}/rest/dishes/{dishId}	Authorized
	GET	Get all dishes by restaurant	{URL}/rest/dishes?restaurantId={restaurantId}	Authorized
	GET	Get all dishes by restaurant and date	{URL}/rest/dishes?restaurantId={restaurantId}&date={date}	Authorized
	PUT	Update dish	{URL}/rest/dishes/{dishId}	Admin
	DELETE	Delete dish	{URL}/rest/dishes/{dishId}	Admin
Vote	PUT	Create vote	{URL}/rest/votes?restaurantId={restaurantId}	Authorized
	GET	Get vote	{URL}/rest/votes/{voteId}	Authorized
	GET	Get last vote of user	{URL}/rest/votes/last	Authorized
	PATCH	Update vote	{URL}/rest/votes?restaurantId={restaurantId}	Authorized

---

CURL commands for the restaurant voting system REST API

You can use IntelliJ IDEA HTTP client with endpoints.http.

1. Restaurant

   Create restaurant

   curl -X POST -d '{"name":"Restaurant3","address":"ул. Зеленая, д.20"}' -H 'Content-Type:application/json;charset=UTF-8' http://localhost:8080/voting/rest/restaurants --user [e-mail]:admin

   Get restaurant

   curl -X GET http://localhost:8080/voting/rest/restaurants/100002 --user [e-mail]:userpass

   Get restaurant with today's dishes

   curl -X GET http://localhost:8080/voting/rest/restaurants/100002/today --user [e-mail]:userpass

   Get all restaurants

   curl -X GET http://localhost:8080/voting/rest/restaurants/ --user [e-mail]:userpass

   Get all restaurants with today's dishes

   curl -X GET http://localhost:8080/voting/rest/restaurants/today --user [e-mail]:userpass

   Update restaurant

   curl -X PUT -d '{"id":100002,"name":"RestOne","address":"ул. Мира, 67"}' -H 'Content-Type: application/json' http://localhost:8080/voting/rest/restaurants/100002 --user [e-mail]:admin

   Delete restaurant

   curl -X DELETE http://localhost:8080/voting/rest/restaurants/100002 --user [e-mail]:admin

2. Dish

   Create dish

   curl -X POST -d '{"restaurantId":100002,"name":"Sandwich","price":6}' -H 'Content-Type:application/json;charset=UTF-8' http://localhost:8080/voting/rest/dishes --user [e-mail]:admin

   Get dish

   curl -X GET http://localhost:8080/voting/rest/dishes/100016 --user [e-mail]:userpass

   Get all dishes by restaurant

   curl -X GET http://localhost:8080/voting/rest/dishes?restaurantId=100003 --user [e-mail]:userpass

   Get all dishes by restaurant and date

   curl -X GET "http://localhost:8080/voting/rest/dishes?restaurantId=100003&date=2021-10-31" --user [e-mail]:userpass

   Update dish

   curl -X PUT -d '{"id":100016,"restaurantId":100003,"name":"Sandwich with tune","price":8}' -H 'Content-Type: application/json' http://localhost:8080/voting/rest/dishes/100004 --user [e-mail]:admin

   Delete dish

   curl -X DELETE http://localhost:8080/voting/rest/dishes/100004 --user [e-mail]:admin

3. User

   3.1 Admin

   Create user

   curl -X POST -d '{"name":"New","email":"[e-mail]","password":"password","enabled":true,"roles":["USER"]}' -H 'Content-Type:application/json;charset=UTF-8' http://localhost:8080/voting/rest/admin/users --user [e-mail]:admin

   Get user

   curl -X GET http://localhost:8080/voting/rest/admin/users/100001 --user [e-mail]:admin

   Get user by Email

   curl -X GET http://localhost:8080/voting/rest/admin/users/by?email=[e-mail] --user [e-mail]:admin

   Get all users

   curl -X GET http://localhost:8080/voting/rest/admin/users --user [e-mail]:admin

   Update user

   curl -X PUT -d '{"id":100001,"name":"NewAdmin","email":"[e-mail]","password":"password","enabled":true,"roles":["USER","ADMIN"]}' -H 'Content-Type: application/json' http://localhost:8080/voting/rest/admin/users/100001 --user [e-mail]:admin

   Delete user

   curl -X DELETE http://localhost:8080/voting/rest/admin/users/100001 --user [e-mail]:admin

   3.2 User

   Register user

   curl -X POST -d '{"name":"Other","email":"[e-mail]","password":"password"}' -H 'Content-Type:application/json;charset=UTF-8' http://localhost:8080/voting/rest/profile/register

   Get user

   curl -X GET http://localhost:8080/voting/rest/profile --user [e-mail]:password

   Update user

   curl -X PUT -d '{"name":"UpdatedUser","email":"[e-mail]","password":"passupdate"}' -H 'Content-Type: application/json' http://localhost:8080/voting/rest/profile --user [e-mail]:userpass

   Delete user

   curl -X DELETE http://localhost:8080/voting/rest/profile --user [e-mail]:userpass

4. Vote

   Create vote

   curl -X POST -H 'Content-Type: application/json' http://localhost:8080/voting/rest/votes?restaurantId=100002 --user [e-mail]:password

   Get own votes

   curl -X GET http://localhost:8080/voting/rest/votes --user [e-mail]:password

   Get last vote of user

   curl -X GET http://localhost:8080/voting/rest/votes/last --user [e-mail]:password

   Update vote

   curl -X PUT -H 'Content-Type: application/json' http://localhost:8080/voting/rest/votes?restaurantId=100003 --user [e-mail]:password