Final project 2018 spring

.editorconfig

@@ -0,0 +1,5 @@
+[*]
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2

.vscode/launch.json

@@ -0,0 +1,19 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach to API",
+      "protocol": "inspector",
+      "address": "localhost",
+      "port": 9222,
+      "localRoot": "${workspaceFolder}/api",
+      "remoteRoot": "/var/api",
+      "restart": true
+    }
+  ]
+}

README.md

@@ -1,48 +1,129 @@
-# AppDev Cloud Services Training
+# AppDev Cloud Services Training: Final Project 2018 Spring
 
-Welcome to AppDev training! We are excited that you chose to learn about cloud
-services, and we hope you enjoy the training. Please read through these
-instructions to get an idea of how this course works, and don't hesitate to
-reach out to Zander if you are confused about anything.
+**Due:** June 4th (Contact Yash if you need an extension)
 
-## How This Training Works
+## Submitting
 
-This repository will serve as the website for the training. There is a section
-(also called a branch) for each day. You can jump to any section in the [table
-of contents][#table-of-contents] below. Each section has the recommended
-readings to be done before the session that day, as well as starter code for
-that day for reference. Generally, you shouldn't replace the code you already
-have with our starter code unless you miss a day of class. It is better for you
-to get used to your own code.
+You will submit this project with GitHub.
 
-## Getting Started
+1.  [Fork this repository.](https://help.github.com/articles/fork-a-repo/)
+2.  [Clone the fork you just made.](https://help.github.com/articles/cloning-a-repository/)
+3.  Switch to the `final-project-2018-spring` branch.
+    * _If you are using Visual Studio Code:_ Click the button at the far left of
+      the bottom bar and pick the branch from the dropdown.
+    * _If you are using the terminal:_ Make sure you are in the directory that
+      you just cloned. Then, run `git checkout final-project-2018-spring`.
+4.  Split off a new branch. You might name it `my-final-project` or something.
+    * _If you are using Visual Studio Code:_ Click the branch button again, but
+      this time, select `+ Create new branch`. Then type in the new branch name.
+    * _If you are using the terminal:_ Run `git checkout -b my-final-project` to
+      create the new branch and switch to it in one go.
+5.  Make your changes and commit them.
+    * _If you are using Visual Studio Code:_ Switch to git panel on the left
+      sidebar. Write a commit message in the textbox describing your changes.
+      Then click the check mark button on the top bar.
+    * _If you are using the terminal:_ Run `git commit --all --message="Describe your changes here"`
+      to commit all your changes with the given message. If that is too wordy
+      for you, you can run `git commit -am "And describe your changes here"`
+      which is a shortcut for the above.
+6.  Push your changes.
+    * _If you are using Visual Studio Code:_ Click the button with up/down
+      arrows right next to the branch button.
+    * _If you are using the terminal:_ Run `git push origin my-final-project` to
+      send your changes to the repository your cloned from (called `origin`
+      here), and to the branch `my-final-project`.
+7.  [Create a pull request.](https://help.github.com/articles/creating-a-pull-request/)
 
-**If you know nothing about git or GitHub**, or maybe you just aren't very
-confident with them, then don't worry. We will learn some of the basics later in
-this training, but for now, you can just download [the starter code for day
-1][day1] as a .zip file with the green download button in the top right.
+You may repeat steps 5 and 6 multiple times if you find that you have
+multiple sets of changes. For example, you might write the documentation,
+commit and push it, then write your code and commit and push that.
 
-**If you are already familiar with git and GitHub**, you should have no problem
-getting started. Just clone this repository and switch to [the day-1
-branch][day1]. We recommend that you then split off a new branch from there,
-just in case you want to refer back to day 1 at some point, but that is up to
-you.
+## The Assignment
 
-### Required Tools
+You will be writing documentation for and implementing a new request handler.
+You should start with the documentation, because the documentation page
+allows you to test your code.
 
-You should try to install all of these before the first day of training. If you
-have trouble getting any of them working, you can get help on the first day.
+Your new handler should be able to accept get requests in the form:
+`GET /tasks/123` where `123` is the ID of a particular task. This handler
+should behave similarly to the one we wrote for `GET /tasks`, except instead
+of returning a list of tasks, you should just return the task with the ID
+that they gave you.
 
-* [Yarn](https://yarnpkg.com/en/docs/install) lets us use code published by
-  other people.
-* [Docker](https://www.docker.com/community-edition) allows us to run our code
-  on any system we need to.
-* [Visual Studio Code](https://code.visualstudio.com/download), or if you
-  already have a favorite code editor, you can use that instead.
+Don't forget to validate the request to make sure they send a valid object ID
+and such. Also, if the task they asked for does not exist, be sure to send a
+`404` status with an appropriate message.
+
+## Examples
+
+Note that the error messages don't have the be exactly the same as mine, they
+should just get the point across of what went wrong.
+
+### 1. The task exists
+
+**Request**
+
+_Method_: GET
+
+_Path_: /tasks/123
+
+**Response**
+
+_Status_: 200
+
+_Body_:
+
+```
+{
+  "_id": "123",
+  "text": "My task",
+  "isComplete": false
+}
+```
+
+### 2. Invalid request
+
+**Request**
+
+_Method_: GET
+
+_Path_: /tasks/this_is_not_a_valid_id
+
+**Response**
+
+_Status_: 400
+
+_Body_:
+
+```
+{
+  "message": "Invalid request: Path Params.taskId does not match the format 'objectId'"
+}
+```
+
+### 3. Task does not exist
+
+**Request**
+
+_Method_: GET
+
+_Path_: /tasks/456
+
+**Response**
+
+_Status_: 404
+
+_Body_:
+
+```
+{
+  "message": "No task with id '456'"
+}
+```
 
 ## Table of Contents
 
-* [**Introduction**][intro]
+* [Introduction][intro]
 * [Day 1][day1]
 * [Day 2][day2]
 * [Day 3][day3]

api/.dockerignore

@@ -0,0 +1 @@
+/node_modules

api/.gitignore

@@ -0,0 +1 @@
+/node_modules

api/Dockerfile

@@ -0,0 +1,11 @@
+FROM node:8.9
+
+COPY . /var/api
+WORKDIR /var/api
+RUN yarn install
+
+ENV NODE_ENV=production
+
+EXPOSE 80
+
+CMD ["node", "index.js"]

api/index.js

@@ -0,0 +1,44 @@
+const express = require("express")
+const swaggerJSDoc = require("swagger-jsdoc")
+const swaggerUI = require("swagger-ui-express")
+const readYAML = require("read-yaml")
+
+require("express-async-errors")
+
+const tasksRouter = require("./tasks")
+const { HTTPError } = require("./util")
+
+const PORT = 80
+
+const swaggerSpec = swaggerJSDoc({
+  swaggerDefinition: readYAML.sync("./open-api.yml"),
+  apis: ["./tasks.js"]
+})
+
+express()
+  .use(express.json())
+
+  .get("/", (request, response) => response.redirect("/docs"))
+  .use("/docs", swaggerUI.serve, swaggerUI.setup(swaggerSpec))
+  .get("/docs.json", (request, response) =>
+    response.status(200).send(swaggerSpec)
+  )
+
+  .use("/tasks", tasksRouter)
+
+  .all("*", () => {
+    throw new HTTPError(404, "Not found")
+  })
+
+  .use((error, request, response, next) => {
+    if (error instanceof HTTPError) {
+      response.status(error.status).send({ message: error.message })
+    } else {
+      console.error(error)
+      response.status(500).send({ message: "Server error" })
+    }
+  })
+
+  .listen(PORT, () => {
+    console.log("API serving.")
+  })

api/open-api.yml

@@ -0,0 +1,76 @@
+openapi: 3.0.0
+
+info:
+  title: Cloud Services Training API
+  version: 1.0.0
+
+components:
+  propSchemas:
+    TaskId:
+      type: string
+      description: The unique ID of the task.
+      format: objectId
+    TaskText:
+      type: string
+      description: The text content of the task.
+    TaskIsComplete:
+      type: boolean
+      description: Whether the task has been checked off.
+
+  schemas:
+    TaskCreate:
+      type: object
+      properties:
+        text:
+          $ref: "#/components/propSchemas/TaskText"
+      required:
+        - text
+      additionalProperties: false
+
+    TaskEdit:
+      type: object
+      properties:
+        text:
+          $ref: "#/components/propSchemas/TaskText"
+        isComplete:
+          $ref: "#/components/propSchemas/TaskIsComplete"
+      additionalProperties: false
+
+    Task:
+      type: object
+      properties:
+        _id:
+          $ref: "#/components/propSchemas/TaskId"
+        text:
+          $ref: "#/components/propSchemas/TaskText"
+        isComplete:
+          $ref: "#/components/propSchemas/TaskIsComplete"
+      required:
+        - _id
+        - text
+        - isComplete
+      additionalProperties: false
+
+    Error:
+      type: object
+      properties:
+        message:
+          type: string
+      required:
+        - message
+      additionalProperties: false
+
+  responses:
+    BadRequest:
+      description: The request is incorrectly formatted.
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"
+
+    NotFound:
+      description: The requested resource could not be found.
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"

api/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "server",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "start": "nodemon --inspect=0.0.0.0:9222 index.js"
+  },
+  "dependencies": {
+    "express": "^4.16.2",
+    "express-async-errors": "^2.1.0",
+    "jsonschema": "^1.2.2",
+    "mongodb": "^2.2.33",
+    "read-yaml": "^1.1.0",
+    "swagger-jsdoc": "^1.9.7",
+    "swagger-ui-express": "^2.0.14",
+    "urlsafe-base64": "^1.0.0"
+  },
+  "devDependencies": {
+    "nodemon": "^1.12.1"
+  }
+}