CS546 Lab6 -A Restaurant API Solved

12/14/21, 11:46 PM Lab 6

You will use the following folder structure for the data module. You may need other files to handle the connection to the database as well.

  ./
  ../data/
  ../data/restaurants.js
  ../data/index.js
  ../data/reviews.js
  ../routes/
  ../routes/restaurants.js
  ../routes/index.js
  ../routes/reviews.js
  ../app.js
  ../package.json

I also recommend having your database settings centralized in files, such as:

  ./
  ../config/
  ../config/mongoConnection.js
  ../config/mongoCollections.js

Database Structure

You will use a database with the following structure:

The database will be called FirstName_LastName_lab6
The collection you use to store restaurants will be called restaurants you will store a sub-document of reviews

restaurants

The schema for restaurants is now as followed:

  {
      _id: ObjectId,

      name: string,
      location: string,
      phoneNumber: string (xxx-xxx-xxxx format),
      website: string (must contain full url http://www.patrickseats.com),
      priceRange: string (from $ to $$$$),
      cuisines: [strings],
      overallRating: number (from 0 to 5 this will be a computed average from all the reviews posted f

  or a restaurant,
      the initial value of this field will be 0 when a restaurant is created),
      serviceOptions: {dineIn: Boolean, takeOut: Boolean, delivery: Boolean},
      reviews: [] (an array of review objects, you will initialize this field to be an empty array whe

  n a restaurant is created)
  }

The **_id** field will be automatically generated by MongoDB, so you do not need to provide it.

The _id field will be automatically generated by MongoDB when a restaurant is inserted, so you do not need to provide it when a restaurant is created.

https://sit.instructure.com/courses/50148/assignments/273386 2/12

12/14/21, 11:46 PM Lab 6

 create(name, location, phoneNumber, website, priceRange, cuisines, serviceOptions) Note: notice we no
longer pass overallRating into the function since that will be a computed field
getAll()
get(id)

remove(id)
update (id, name, location, phoneNumber, website, priceRange, cuisines, serviceOptions)  Note: this is
the new function you will create

For the functions you did in lab 4, all the same input requirements apply in this lab, for new update function, those requirements are stated below.

NOTE: For create: We no longer will need to pass in overallRating like we did in lab 4 since that will now be a computed average field of all ratings. When a restaurant is created, in your DB function, you will initialize the reviews array to be an empty array (since there can’t be reviews of a restaurant until the restaurant is in the system). You will also initialize overallRating to be 0 when a restaurant is created.

async update(id, name, location, phoneNumber, website,

priceRange, cuisines, serviceOptions)

This function will update all the data of the restaurant currently in the database.

If id, name, location, phoneNumber, website, priceRange, cuisines, serviceOptions are not provided at all, the method should throw. (All fields need to have valid values);

If id, name, location, phoneNumber, website, priceRange are not strings or are empty strings, the method should throw.

If phoneNumber does not follow this format: xxx-xxx-xxxx, the method will throw.
If website does not contain http://www. and end in a .com , and have at least 5 characters in-between

the http://www. and .com this method will throw.
If priceRange is not between ‘ $ ‘ to ‘ $$$$ ‘, this method will throw.

If cuisines is not an array and if it does not have at least one element in it that is a valid string , or are empty strings the method should throw.

If serviceOptions is not an object , the method should throw.
If serviceOptions.dineIn, serviceOptions.takeOut, serviceOptions.delivery are not in the object, the

method should throw.

If serviceOptions.dineIn, serviceOptions.takeOut, serviceOptions.delivery is not a boolean, the method should throw.

https://sit.instructure.com/courses/50148/assignments/273386 4/12

12/14/21, 11:46 PM Lab 6

If the update succeeds, return the entire restaurant object as it is after it is updated.

data/reviews.js

In reviews.js, you will create and export 4 methods. Create, Read (one for getting all and also one getting by id), and Delete. You must do FULL error handling and input checking for ALL functions as you have in previous labs, checking if input is supplied, correct type, range etc. and throwing errors when you encounter bad input.

Function Names:

 create(restaurantId, title, reviewer, rating, dateOfReview, review)
getAll(restaurantId)
get(reviewId)
remove(reviewId)

async create(restaurantId, title, reviewer, rating, dateOfReview, review);

This async function will return to the newly created restaurant object, with all of the properties listed above.

If restaurantId, title, reviewer, rating, dateOfReview, review are not provided at all, the method should throw. (All fields need to have valid values);

If restaurantId, title, reviewer, dateOfReview, review are not strings or are empty strings, the method should throw.

If the restaurantId provided is not a valid ObjectId , the method should throw

If the restaurant doesn’t exists with that restaurantId , the method should throw

If rating is not a number that’s value is 1-5, the method will throw.

If dateOfReview is not a valid date string, the method will throw.

if dateOfReview is prior or after the current day’s date, the method should throw. (you can’t leave a review yesterday or before yesterday, and you can’t leave a review in the future)

Note: FOR ALL INPUTS: Strings with empty spaces are NOT valid strings. So no cases of ” ” are valid.

NOTE: When a review is added, you must calculate/re-calculate the average of all reviews and update the overallRating field in the main document to be the average of all the review ratings.

async getAll(restaurantId);

https://sit.instructure.com/courses/50148/assignments/273386 5/12