READ ME (GoReviewAPI 🍕)

GoReview is a restaurant review website API, which will help you make up your mind before you eat 😋

Who we are

We are the team behind Go Review:

• Veron 🍜

  • Github : https://github.com/veron-eng
  • Linkedin : https://www.linkedin.com/in/veron-sundaram/

• Migle 🧁

  • Github : https://github.com/migleambr
  • Linkedin : https://www.linkedin.com/in/migle-ambrazeviciute/

• Vilte 🍧

  • Github : https://github.com/VilteNor
  • Linkedin : https://www.linkedin.com/in/viltenor/

Project Overview

This collaborative project was completed as part of the Bright Network Technology Academy programme. This project aimed to build a back end for a restaurant review website, it consisted of a User who would log on to the website, and then place a review on one of their most recently visited restaurants.

In the review the user can create a new restaurant if the restaurant is not already in the database, other functionality included in the review section are:

• the user can also give a rating out of 5
• give a rating of the price of the restaurant
• an optional message
• can attach lables to the review including, different types of accesible features and diet

The API was created using Java, and Spring boot, as well as, using Postman for testing.

Table of Contents

• Instructions for Initial Setup
• UML and ERD Diagrams
• Minimum Viable Product (MVP)
• Extensions
• Plain Old Java Objects (POJOs)
• HTTP Requests

Step-By-Step Instructions for Initial Setup

1. Make sure that you have installed Java.
2. Clone this repository : git clone git@github.com:VilteNor/GoReviewAPI.git and open in you Java IDE
3. Create a database called go_review
4. If you don't already have it, download Postman so that you can interact with the API, the HTTP queries you will make will be on : localhost:8081/(command inserted here)

UML and ERD Diagrams:

Minimum Viable Product (MVP):

For our MVP we wanted to create an app with CRUD funtionality with 3x classes:

• Users
• Restaurants
• Reviews

Extensions:

For our extentions we wanted to add the following functionality:

• get the average rating for each restaurant.
• create a moderator class, where when the user completes a review it will enter a pending section and be later reviewed by the moderator.
• don't let a user write a review to the same restaurant for at least 7 days.
• retrieve a list of restaurants by using an inputted enum.
• retrieve a list of reviews by using an inputted enum.

Plain Old Java Objects (POJOs):

pojo	type	input structure
Users	-Id: long - username: String - fullName: String - email: String - reviews: list	{ "username": "veron02", "fullname": "veron sundaram" "email":"veron@gmail.com" }
Restaurants	- Id: long - name: String - location : String - reviews : list	{ "name": "pizza express", "location": "new york" }
Reviews	- Id: long - restaurant : Restaurant - optionalMessage : String - username: User - dateOfVisit : String - optional enums : accessibility, pricing, cuisine, dietary requirements, rating	{ "dateOfVisit":"09/08/89", "rating" : "COMPLETELY_DISSATISFIED", "accessibility": ["ACCESSIBLE_MENU", "ACCESSIBLE_BATHROOMS", "CHILD_FRIENDLY"], "optionalMessage":"food was amazing " }
Reply	+ message: String	N/a

HTTP Requests:

User:

Request Type	Request Path	Description
POST	localhost:8080/users	Add a new user
GET	localhost:8080/users	Get all users
GET	localhost:8080/users/{id}	Get user by id
PATCH	localhost:8080/users/{id}/email	Update user's email
PATCH	localhost:8080/users/{id}/fullName	Update user's full name
DELETE	localhost:8080/users/{id}	Delete a user

@POST requests

To add a new user via a POST request in Postman, use JSON raw format and the following notations:

{
    "username" : "migle_ambr",
    "fullName" : "Migle Ambrazeviciute,
    "email" : "migle@gmail.com"
}

@PATCH requests

To update the user's details (either email or full name) via a PATCH request in Postman, use JSON raw format and the following notations:

{
    "email" : "migle_new_email@gmail.com"
}

Restaurant:

Request Type	Request Path	Description
POST	localhost:8080/restaurants	Add a new restaurant
GET	localhost:8080/restaurants	Get all restaurants
GET	localhost:8080/restaurants/{id}	Get restaurant by id
GET	localhost:8080/restaurants/cuisine	Get all restaurants by cuisine
GET	localhost:8080/restaurants/rating/{id}	Get average rating for a restaurant
DELETE	localhost:8080/restaurants/{id}	Delete a restaurant

@POST requests

To add a new restaurant via a POST request in Postman, use JSON raw format and the following notations (including an optional enum for cuisine):

{
    "name" : "Zizzi",
    "location" : "London",
    "cuisine" : "ITALIAN"
}

@GET requests

To get all restaurants and their associated reviews by a specific cuisine enum via a GET request in Postman, use JSON raw format and the following notation:

"ITALIAN"

Review:

Request Type	Request Path	Description
POST	localhost:8080/reviews?username={username}&restaurantId={restaurantId}	Submit a new review
GET	localhost:8080/reviews	Get all reviews
GET	localhost:8080/reviews/{id}	Get review by id
GET	localhost:8080/reviews/users/{id}	Get all reviews submited by a user
GET	localhost:8080/reviews/username/{username}	Get all reviews by username
GET	localhost:8080/reviews/restaurant/{id}	Get all reviews by restaurant id
GET	localhost:8080/reviews/diet	Get all reviews by diet type
GET	localhost:8080/reviews/accessibility	Get all reviews by accessibility type
GET	localhost:8080/reviews/pricing	Get all reviews by pricing
GET	localhost:8080/reviews/rating	Get all reviews by rating
DELETE	localhost:8080/reviews/{id}	Delete a review

@POST requests

To add a new review via a POST request in Postman, use JSON raw format and the following notations (including optional enums for diet, accessibility and pricing):

{
    "dateOfVisit":"6/4/2022",
    "rating": "GOOD",
    "optionalMessage": "would come back again :)",
    "diet" : [
        "DAIRY_FREE",
        "NUT_FREE"
    ],
    "accessibility" : [
        "ACCESSIBLE_BATHROOMS",
        "ACCESSIBLE_MENU"
    ],
    "pricing" : "£££"
}

@GET requests

To get all reviews by a specific diet, accessibility, pricing or rating enum via a GET request in Postman, use JSON raw format and the following notation:

"GOOD"

Testing:

The project was tested through postman. The application created is the HTTP client and many http requests were wriiten as a way to test if the expected reponces were recieved, preventing bugs and improving performance.

Here is an example of an example test:

Final Comments:

If we were to add further implementations to the project, we would add:

• more of our extentions, but were not able to due to time constraints
• authentication and security features to our website through spring security
• some J-unit tests, or have worked in TDD style manner.

We would also like to acknowledge the BNTA team, and all the trainers for their amazing support during the program!