brijq / NodeJsAPIAssessment

Assessment using Node JS

NodeJsAPIAssessment

Background

Teachers need a system where they can perform administrative functions for their students. Teachers and students are identified by their email addresses.

Prerequistes

If you are running via Local Machine Method

1. Please ignore app.yaml as this file is meant for Google Cloud App Engine Deploy File

2. Please ignore Dockerfile and .dockerignore as this file is meant for Google Cloud Cloud Run Deploy File

3. Please ignore .gcloudignore file as this file is meant for Google Cloud version of .gitignore file

4. Please remember to include in Headers [{"key":"Content-Type","value":"application/json","description":""}] when perform Post APIS

5. Please run API GET /testconnect to check for databases connection

6. Default page API will be GET / where you will see the home page of this API Assessment

Before You Begin (Important)

The following SQL Database is hosted in Google Cloud Platform using CloudSQL.

1. These are the following information in the Student Table

+----+--------------+------------------------+-----------+
| id | name         | email                  | suspended |
+----+--------------+------------------------+-----------+
|  1 | StudentBeta  | [e-mail]  | No        |
|  2 | StudentBetty | [e-mail] | No        |
|  3 | StudentAnker | [e-mail] | No        |
|  4 | StudentJon   | [e-mail]   | No        |
|  5 | StudentHon   | [e-mail]   | Yes       |
|  6 | studentMary  | [e-mail]  | Yes       |
+----+--------------+------------------------+-----------+

2. These are the following information in the Teachers Table

+----+----------------+--------------------------+
| id | name           | email                    |
+----+----------------+--------------------------+
|  1 | TeacherAndy    | [e-mail]    |
|  2 | TeacherAlan    | [e-mail]    |
|  3 | TeacherHeather | [e-mail] |
|  4 | TeacherKate    | [e-mail]    |
|  5 | TeacherKen     | [e-mail]     |
|  6 | teacherHoly    | [e-mail]    |
+----+----------------+--------------------------+

3. These are the following information in the Teachers_Students Table

+-----------+-----------+
| teacherid | studentid |
+-----------+-----------+
|         1 |         3 |
|         1 |         2 |
|         4 |         2 |
|         5 |         1 |
|         5 |         2 |
|         5 |         3 |
|         5 |         4 |
|         5 |         5 |
+-----------+-----------+

Steps to access this project ( Two Methods )

Hosted in Google Cloud Platform using App Engine ( Highly Recommended )

1. Just navigate to https://brijqtify.appspot.com

2. The following apis do just replace http://localhost:3000 to https://brijqtify.appspot.com

   • E.g. http://localhost:3000/students/student to https://brijqtify.appspot.com/students/student

Local Machine Method ( Second Method )

1. Run through your local machine (Please note: I will need your ip address of the machine you are running in order to connect to mySQL Database as the SQL instance is running in Google Cloud Platform for security purposes)

2. git clone this project

3. cd /to/your/path

4. npm install ( please check permission as it may vary )

5. npx nodemon or npm install

6. localhost:3000

7. You may use postman and run

User stories

Add a student

• Endpoint: POST /students/student
• Headers: Content-Type: application/json
• Success response status: HTTP 200
• Request body example:

{
  "id": "1"
  "name": "studentName"
  "email": "[e-mail]"
 }

Add a teacher

• Endpoint: POST /teachers/teacher
• Headers: Content-Type: application/json
• Success response status: HTTP 200
• Request body example:

{
  "id": "1"
  "name": "teacherName"
  "email": "[e-mail]"
 }

Add a linker relationship table

• Endpoint: POST /users/linker
• Headers: Content-Type: application/json
• Success response status: HTTP 200
• Request body example:

{
  "teacherid": "1"
  "studentid": "3"
 }

1. As a teacher, I want to register one or more students to a specified teacher.

A teacher can register multiple students. A student can also be registered to multiple teachers.

http://localhost:3000/users/api/register

• Endpoint: POST /users/api/register
• Headers: Content-Type: application/json
• Success response status: HTTP 204
• Request body example:

{
  "teacher": "[e-mail]"
  "students":
    [
      "[e-mail]",
      "[e-mail]"
    ]
}

2. As a teacher, I want to retrieve a list of students common to a given list of teachers (i.e. retrieve students who are registered to ALL of the given teachers).

• Endpoint: GET /users/api/commonstudents
• Success response status: HTTP 200
• Request example 1: GET /api/commonstudents?teacher=teacherken%40gmail.com
• Success response body 1:

{
  "students" :
    [
      "[e-mail]", 
      "[e-mail]",
      "[e-mail]"
    ]
}

• Request example 2: GET /users/api/commonstudents?teacher=teacherken%40gmail.com&teacher=teacherKen%40gmail.com
• Success response body 2:

{
  "students" :
    [
      "[e-mail]", 
      "[e-mail]"
    ]
}

3. As a teacher, I want to suspend a specified student.

• Endpoint: POST /users/api/suspend
• Headers: Content-Type: application/json
• Success response status: HTTP 204
• Request body example:

{
  "student" : "[e-mail]"
}

4. As a teacher, I want to retrieve a list of students who can receive a given notification.

• the teacher who is sending the notification, and
• the text of the notification itself.

To receive notifications from e.g. '[e-mail]', a student:

• MUST NOT be suspended,
• AND MUST fulfill AT LEAST ONE of the following:
  1. is registered with “[e-mail]"
  2. has been @mentioned in the notification

The list of students retrieved should not contain any duplicates/repetitions.

• Endpoint: POST /users/api/retrievefornotifications
• Headers: Content-Type: application/json
• Success response status: HTTP 200
• Request body example 1:

{
  "teacher":  "[e-mail]",
  "notification": "Hello students! @[e-mail] @[e-mail]"
}

• Success response body 1:

{
  "recipients":
    [
      "[e-mail]",
      "[e-mail]", 
      "[e-mail]"
    ]   
}

In the example above, [e-mail] and [e-mail] can receive the notification from [e-mail], regardless whether they are registered to him, because they are @mentioned in the notification text. [e-mail] however, has to be registered to [e-mail].

• Request body example 2:

{
  "teacher":  "[e-mail]",
  "notification": "Hey everybody"
}

• Success response body 2:

{
  "recipients":
    [
      "[e-mail]"
    ]   
}