Paz1506 / VotingSystem

Simple project (for training course). The voting system for restaurants. Simple implementation of REST API for interaction with the frontend/any client.

Voting system (simple project for training course)

Task: Design and implement a REST API using Hibernate/Spring/SpringMVC (or Spring-Boot) without frontend. Build a voting system for deciding where to have lunch.

Conditions:

• 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 asume 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.

P.S.: Asume that your API will be used by a frontend developer to build frontend on top of that.

Technologies used:

• Java 8
• Spring 5: Core, WebMVC, Data JPA, Security, Test
• Hibernate 5 ORM
• Logback
• EHcache 3
• JUnit, AssertJ
• Jackson to work with JSON data
• HSQLDB database
• Maven for build & dependency management

The application was started and tested on tomcat 8

Note: In application uses basic authorization, which is not recommended for real projects.

Application API

Requests for API:

• User-requests - allowed to the user with role USER
• Admin-requests - allowed only to the user with role of ADMIN

Note: Admin requests have prefix /admin

Note: The application provides compatibility with different versions. The version is specified in the query path: /v1.0

User cURL requests:

Type	Request	Description
Restaurants
GET	curl -s -X GET http://localhost:8080/v1.0/restaurants --user [e-mail]:1234	Get restaurants in which the menu is published for the current day. If the restaurant is not published menu for the current day, it is not returned.
GET	curl -s -X GET http://localhost:8080/v1.0/restaurants/1 --user [e-mail]:1234	Get restaurant by id.
Menus
GET	curl -s -X GET http://localhost:8080/v1.0/restaurants/1/menus --user [e-mail]:1234	Get the entire restaurant menu published for the current day.
GET	curl -s -X GET http://localhost:8080/v1.0/restaurants/1/menus/5 --user [e-mail]:1234	Get menu by menu id & restaurant id.
Dishes
GET	curl -s -X GET http://localhost:8080/v1.0/admin/menus/5/dishes --user [e-mail]:1234	Get all dishes in the menu for the current day.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/menus/5/dishes/12 --user [e-mail]:1234	Get dish by menu id & restaurant id.
Votes
POST	curl -s -X POST http://localhost:8080/v1.0/restaurants/1/votes --user [e-mail]:1234	Voting of the user for the restaurant. Voting is strictly up to 11:00 AM current day.
GET	curl -s -X GET http://localhost:8080/v1.0/restaurants/1/votes/count --user [e-mail]:1234	Get count of restaurant votes for the current day, if the time is after 11:00 AM. If the time is before, returns -1.

Admin cURL requests:

Type	Request	Description
Restaurants
GET	curl -s -X GET http://localhost:8080/v1.0/admin/restaurants --user [e-mail]:1234	Get all restaurants.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/restaurants/1 --user [e-mail]:1234	Get restaurant by id.
POST	curl -s -X POST -d "{\"name\":\"rest_test\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants --user [e-mail]:1234	Create new restaurant.
POST	curl -s -X DELETE -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants/2 --user [e-mail]:1234	Delete restaurant 2.
DELETE	curl -s -X POST -d "{\"id\":\"1\", \"name\":\"updated_1\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants --user [e-mail]:1234	Update restaurant 1.
Menus
GET	curl -s -X GET http://localhost:8080/v1.0/admin/restaurants/1/menus --user [e-mail]:1234	Get all menus by restaurant id.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/restaurants/1/menus/5 --user [e-mail]:1234	Get menu 5 by restaurant 1 .
GET	curl -s -X GET http://localhost:8080/v1.0/admin/menus/5 --user [e-mail]:1234	Get menu 5.
POST	curl -s -X POST -d "{\"name\": \"new_menu_restaurant\",\"date\": \"2018-05-22T10:01\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants/1/menus --user [e-mail]:1234	Create new menu for restaurant 1.
POST	curl -s -X POST -d "{\"id\": \"5\", \"name\": \"updated_menu_5\",\"date\": \"2018-05-22T10:01\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants/1/menus --user [e-mail]:1234	Update menu 5 for restaurant 1.
DELETE	curl -s -X DELETE -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants/1/menus/5 --user [e-mail]:1234	Delete menu by id.
Dishes
GET	curl -s -X GET http://localhost:8080/v1.0/admin/restaurants/1/menus/5/dishes --user [e-mail]:1234	Get all dishes by menu 5 restaurant 1.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/menus/5/dishes --user [e-mail]:1234	Get all dishes by menu 5.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/restaurants/1/menus/5/dishes/12 --user [e-mail]:1234	Get dish 12 menu 5 restaurant 1.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/dishes/12 --user [e-mail]:1234	Get dish 12.
POST	curl -s -X POST -d "{\"name\": \"new_dish\",\"price\": \"777\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants/1/menus/5/dishes --user [e-mail]:1234	Create new dish for menu 5 & restaurant 1.
POST	curl -s -X POST -d "{\"name\": \"new_dish\",\"price\": \"777\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/menus/5/dishes --user [e-mail]:1234	Create new dish for menu 5.
POST	curl -s -X POST -d "{\"id\":\"12\",\"name\": \"upd_dish\",\"price\": \"777\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/restaurants/1/menus/5/dishes --user [e-mail]:1234	Update dish 12 for menu 5 & restaurant 1.
POST	curl -s -X POST -d "{\"id\":\"12\",\"name\": \"upd_dish\",\"price\": \"888\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/menus/5/dishes --user [e-mail]:1234	Update dish 12 for menu 5.
DELETE	curl -s -X DELETE -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/dishes/12 --user [e-mail]:1234	Delete dish by id.
Users
GET	curl -s -X GET http://localhost:8080/v1.0/admin/users --user [e-mail]:1234	Get all users.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/users/20 --user [e-mail]:1234	Get user by id.
POST	curl -s -X POST -d "{\"name\": \"newuser\", \"email\": \"[e-mail]\", \"password\": \"12345\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/users --user [e-mail]:1234	Create new user
POST	curl -s -X POST -d "{\"id\":\"19\", \"name\": \"updated19\", \"email\": \"[e-mail]\", \"password\": \"123456\"}" -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/users --user [e-mail]:1234	Update user
DELETE	curl -s -X DELETE -H "Content-Type:application/json;charset=UTF-8" http://localhost:8080/v1.0/admin/users/22 --user [e-mail]:1234	Delete user by id.
Votes
GET	curl -s -X GET http://localhost:8080/v1.0/admin/restaurants/1/votes --user [e-mail]:1234	Get all restaurant votes.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/users/19/votes --user [e-mail]:1234	Get all user votes.
GET	curl -s -X GET http://localhost:8080/v1.0/admin/votes/23 --user [e-mail]:1234	Get vote by id.
GET	curl -s -X GET "http://localhost:8080/v1.0/admin/restaurants/1/votes/count?startDate=2000-01-01&startTime=00:00:00&endDate=2020-01-01&endTime=23:59:59" --user [e-mail]:1234	Get count votes with time filtering. Params: startDate, endDate, startTime, endTime. If parameters not present, return count votes of current day.