Delete app

app/app.js

@@ -1,44 +0,0 @@
-// npm packages
-const dotenv = require("dotenv");
-const express = require("express");
-
-// app imports
-const { connectToDatabase, globalResponseHeaders } = require("./config");
-const { errorHandler } = require("./handlers");
-const { thingsRouter } = require("./routers");
-
-// global constants
-dotenv.config();
-const app = express();
-const {
-  bodyParserHandler,
-  globalErrorHandler,
-  fourOhFourHandler,
-  fourOhFiveHandler,
-} = errorHandler;
-
-// database
-connectToDatabase();
-
-// body parser setup
-app.use(express.urlencoded({ extended: true }));
-app.use(express.json({ type: "*/*" }));
-app.use(bodyParserHandler); // error handling specific to body parser only
-
-// response headers setup; CORS
-app.use(globalResponseHeaders);
-
-app.use("/things", thingsRouter);
-
-// catch-all for 404 "Not Found" errors
-app.get("*", fourOhFourHandler);
-// catch-all for 405 "Method Not Allowed" errors
-app.all("*", fourOhFiveHandler);
-
-app.use(globalErrorHandler);
-
-/**
- * This file does NOT run the app. It merely builds and configures it then exports it.config
- *  This is for integration tests with supertest (see __tests__).
- */
-module.exports = app;

app/config.js

@@ -1,56 +0,0 @@
-const mongoose = require("mongoose");
-
-const APP_NAME = "Boilerplate API";
-const ENV = process.env.NODE_ENV;
-const PORT = process.env.PORT || 8080;
-
-/**
- * Connect to mongoose asynchronously or bail out if it fails
- */
-async function connectToDatabase() {
-  const MONGODB_URI =
-    process.env.MONGODB_URI || "mongodb://mongodb/boilerplate";
-
-  mongoose.Promise = Promise;
-  if (ENV === "development" || ENV === "test") {
-    mongoose.set("debug", true);
-  }
-
-  try {
-    await mongoose.connect(MONGODB_URI, {
-      autoIndex: false,
-      useNewUrlParser: true,
-      useUnifiedTopology: true,
-    });
-    console.log(`${APP_NAME} successfully connected to database.`);
-  } catch (error) {
-    console.log(error);
-    process.exit(1);
-  }
-}
-
-/**
- * Configuration middleware to enable cors and set some other allowed headers.
- *  You can also just use the 'cors' package.
- */
-function globalResponseHeaders(request, response, next) {
-  response.header("Access-Control-Allow-Origin", "*");
-  response.header(
-    "Access-Control-Allow-Headers",
-    "Origin, Accept, X-Requested-With, Content-Type, Access-Control-Request-Method, Access-Control-Request-Headers, Authorization"
-  );
-  response.header(
-    "Access-Control-Allow-Methods",
-    "POST,GET,PATCH,DELETE,OPTIONS"
-  );
-  response.header("Content-Type", "application/json");
-  return next();
-}
-
-module.exports = {
-  APP_NAME,
-  ENV,
-  PORT,
-  connectToDatabase,
-  globalResponseHeaders,
-};

app/handlers/error.js

@@ -1,45 +0,0 @@
-const { APP_NAME } = require("../config");
-const { APIError } = require("../helpers");
-
-function bodyParserHandler(error, request, response, next) {
-  if (error instanceof SyntaxError || error instanceof TypeError) {
-    // console.error(error);
-    return next(new APIError(400, "Bad Request", "Malformed JSON."));
-  }
-}
-
-function fourOhFourHandler(request, response, next) {
-  return next(
-    new APIError(
-      404,
-      "Resource Not Found",
-      `${request.path} is not valid path to a ${APP_NAME} resource.`
-    )
-  );
-}
-
-function fourOhFiveHandler(request, response, next) {
-  return next(
-    new APIError(
-      405,
-      "Method Not Allowed",
-      `${request.method} method is not supported at ${request.path}.`
-    )
-  );
-}
-
-function globalErrorHandler(error, request, response, next) {
-  let err = error;
-  if (!(error instanceof APIError)) {
-    err = new APIError(500, error.type, error.message);
-  }
-
-  return response.status(err.status).json(err);
-}
-
-module.exports = {
-  bodyParserHandler,
-  fourOhFourHandler,
-  fourOhFiveHandler,
-  globalErrorHandler
-};

app/handlers/index.js

@@ -1,3 +0,0 @@
-exports.errorHandler = require("./error");
-exports.thingHandler = require("./thing");
-exports.thingsHandler = require("./things");

app/handlers/thing.js

@@ -1,91 +0,0 @@
-// npm packages
-const { validate } = require("jsonschema");
-
-// app imports
-const { Thing } = require("../models");
-const { APIError } = require("../helpers");
-const { thingNewSchema, thingUpdateSchema } = require("../schemas");
-
-/**
- * Validate the POST request body and create a new Thing
- */
-async function createThing(request, response, next) {
-  const validation = validate(request.body, thingNewSchema);
-  if (!validation.valid) {
-    return next(
-      new APIError(
-        400,
-        "Bad Request",
-        validation.errors.map(e => e.stack).join(". ")
-      )
-    );
-  }
-
-  try {
-    const newThing = await Thing.createThing(new Thing(request.body));
-    return response.status(201).json(newThing);
-  } catch (err) {
-    return next(err);
-  }
-}
-
-/**
- * Get a single thing
- * @param {String} name - the name of the Thing to retrieve
- */
-async function readThing(request, response, next) {
-  const { name } = request.params;
-  try {
-    const thing = await Thing.readThing(name);
-    return response.json(thing);
-  } catch (err) {
-    return next(err);
-  }
-}
-
-/**
- * Update a single thing
- * @param {String} name - the name of the Thing to update
- */
-async function updateThing(request, response, next) {
-  const { name } = request.params;
-
-  const validation = validate(request.body, thingUpdateSchema);
-  if (!validation.valid) {
-    return next(
-      new APIError(
-        400,
-        "Bad Request",
-        validation.errors.map(e => e.stack).join(". ")
-      )
-    );
-  }
-
-  try {
-    const thing = await Thing.updateThing(name, request.body);
-    return response.json(thing);
-  } catch (err) {
-    return next(err);
-  }
-}
-
-/**
- * Remove a single thing
- * @param {String} name - the name of the Thing to remove
- */
-async function deleteThing(request, response, next) {
-  const { name } = request.params;
-  try {
-    const deleteMsg = await Thing.deleteThing(name);
-    return response.json(deleteMsg);
-  } catch (err) {
-    return next(err);
-  }
-}
-
-module.exports = {
-  createThing,
-  readThing,
-  updateThing,
-  deleteThing
-};

app/handlers/things.js

@@ -1,28 +0,0 @@
-// app imports
-const { Thing } = require("../models");
-const { APIError, parseSkipLimit } = require("../helpers");
-
-/**
- * List all the things. Query params ?skip=0&limit=1000 by default
- */
-async function readThings(request, response, next) {
-  /* pagination validation */
-  let skip = parseSkipLimit(request.query.skip) || 0;
-  let limit = parseSkipLimit(request.query.limit, 1000) || 1000;
-  if (skip instanceof APIError) {
-    return next(skip);
-  } else if (limit instanceof APIError) {
-    return next(limit);
-  }
-
-  try {
-    const things = await Thing.readThings({}, {}, skip, limit);
-    return response.json(things);
-  } catch (err) {
-    return next(err);
-  }
-}
-
-module.exports = {
-  readThings
-};

app/helpers/APIError.js

@@ -1,31 +0,0 @@
-/** Class representing an API Error Response with a related HTTP Status Code **/
-class APIError extends Error {
-  /**
-   * Create an Error Object
-   * @param {Number} status - The HTTP Status Code (e.g. 404)
-   * @param {String} title - The title corresponding to the Status Code (e.g. Bad Request)
-   * @param {String} message - Specific information about what caused the error
-   */
-  constructor(
-    status = 500,
-    title = "Internal Server Error",
-    message = "An unknown server error occurred."
-  ) {
-    super(message);
-    this.status = status;
-    this.title = title;
-    this.message = message;
-  }
-  toJSON() {
-    const { status, title, message } = this;
-    return {
-      error: {
-        status,
-        title,
-        message
-      }
-    };
-  }
-}
-
-module.exports = APIError;

app/helpers/index.js

@@ -1,2 +0,0 @@
-exports.APIError = require("./APIError");
-exports.parseSkipLimit = require("./parseSkipLimit");

app/helpers/parseSkipLimit.js

@@ -1,33 +0,0 @@
-const APIError = require("./APIError");
-/**
- * Validate the 'limit' and `skip` query params
- * @param {String} val - limit or skip param
- * @param {Number} max - the max value (default 1000)
- * @param {String} type - what we're validating (skip or limit, default limit)
- * @return {Number} numerical form of the val
- */
-function parseSkipLimit(val, max = 1000, type = "limit") {
-  if (!val) {
-    return null;
-  }
-  const min = type === "skip" ? 0 : 1;
-  const num = +val;
-
-  if (!Number.isInteger(num)) {
-    return new APIError(
-      400,
-      "Bad Request",
-      `Invalid ${type}: '${val}', ${type} needs to be an integer.`
-    );
-  } else if (num < min || (max && num > max)) {
-    return new APIError(
-      400,
-      "Bad Request",
-      `${num} is out of range for ${type} -- it should be between ${min} and ${max}.`
-    );
-  }
-
-  return num;
-}
-
-module.exports = parseSkipLimit;

app/models/Thing.js

@@ -1,108 +0,0 @@
-// npm packages
-const mongoose = require("mongoose");
-
-// app imports
-const { APIError } = require("../helpers");
-
-// globals
-const Schema = mongoose.Schema;
-
-const thingSchema = new Schema({
-  name: String,
-  number: Number,
-  stuff: [String],
-  url: String
-});
-
-thingSchema.statics = {
-  /**
-   * Create a Single New Thing
-   * @param {object} newThing - an instance of Thing
-   * @returns {Promise<Thing, APIError>}
-   */
-  async createThing(newThing) {
-    const duplicate = await this.findOne({ name: newThing.name });
-    if (duplicate) {
-      throw new APIError(
-        409,
-        "Thing Already Exists",
-        `There is already a thing with name '${newThing.name}'.`
-      );
-    }
-    const thing = await newThing.save();
-    return thing.toObject();
-  },
-  /**
-   * Delete a single Thing
-   * @param {String} name - the Thing's name
-   * @returns {Promise<Thing, APIError>}
-   */
-  async deleteThing(name) {
-    const deleted = await this.findOneAndRemove({ name });
-    if (!deleted) {
-      throw new APIError(404, "Thing Not Found", `No thing '${name}' found.`);
-    }
-    return deleted.toObject();
-  },
-  /**
-   * Get a single Thing by name
-   * @param {String} name - the Thing's name
-   * @returns {Promise<Thing, APIError>}
-   */
-  async readThing(name) {
-    const thing = await this.findOne({ name });
-
-    if (!thing) {
-      throw new APIError(404, "Thing Not Found", `No thing '${name}' found.`);
-    }
-    return thing.toObject();
-  },
-  /**
-   * Get a list of Things
-   * @param {Object} query - pre-formatted query to retrieve things.
-   * @param {Object} fields - a list of fields to select or not in object form
-   * @param {String} skip - number of docs to skip (for pagination)
-   * @param {String} limit - number of docs to limit by (for pagination)
-   * @returns {Promise<Things, APIError>}
-   */
-  async readThings(query, fields, skip, limit) {
-    const things = await this.find(query, fields)
-      .skip(skip)
-      .limit(limit)
-      .sort({ name: 1 })
-      .exec();
-    if (!things.length) {
-      return [];
-    }
-    return things.map(thing => thing.toObject());
-  },
-  /**
-   * Patch/Update a single Thing
-   * @param {String} name - the Thing's name
-   * @param {Object} thingUpdate - the json containing the Thing attributes
-   * @returns {Promise<Thing, APIError>}
-   */
-  async updateThing(name, thingUpdate) {
-    const thing = await this.findOneAndUpdate({ name }, thingUpdate, {
-      new: true
-    });
-    if (!thing) {
-      throw new APIError(404, "Thing Not Found", `No thing '${name}' found.`);
-    }
-    return thing.toObject();
-  }
-};
-
-/* Transform with .toObject to remove __v and _id from response */
-if (!thingSchema.options.toObject) thingSchema.options.toObject = {};
-thingSchema.options.toObject.transform = (doc, ret) => {
-  const transformed = ret;
-  delete transformed._id;
-  delete transformed.__v;
-  return transformed;
-};
-
-/** Ensure MongoDB Indices **/
-thingSchema.index({ name: 1, number: 1 }, { unique: true }); // example compound idx
-
-module.exports = mongoose.model("Thing", thingSchema);

app/models/index.js

@@ -1 +0,0 @@
-exports.Thing = require("./Thing");

app/routers/index.js

@@ -1 +0,0 @@
-exports.thingsRouter = require("./things");

app/routers/things.js

@@ -1,25 +0,0 @@
-// npm packages
-const express = require("express");
-
-// app imports
-const { thingHandler, thingsHandler } = require("../handlers");
-
-// globals
-const router = new express.Router();
-const { readThings } = thingsHandler;
-const { createThing, readThing, updateThing, deleteThing } = thingHandler;
-
-/* All the Things Route */
-router
-  .route("")
-  .get(readThings)
-  .post(createThing);
-
-/* Single Thing by Name Route */
-router
-  .route("/:name")
-  .get(readThing)
-  .patch(updateThing)
-  .delete(deleteThing);
-
-module.exports = router;

app/schemas/index.js

@@ -1,2 +0,0 @@
-exports.thingNewSchema = require('./thingNew');
-exports.thingUpdateSchema = require('./thingUpdate');

app/schemas/thingNew.json

@@ -1,27 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string"
-    },
-    "number": {
-      "type": "integer",
-      "minimum": 0
-    },
-    "stuff": {
-      "type": "array",
-      "uniqueItems": true,
-      "minItems": 1,
-      "items": {
-        "type": "string"
-      }
-    },
-    "url": {
-      "type": "string",
-      "format": "uri"
-    }
-  },
-  "required": ["name"]
-}

app/schemas/thingUpdate.json

@@ -1,27 +0,0 @@
-{
-  "$schema": "http://json-schema.org/draft-04/schema#",
-  "type": "object",
-  "additionalProperties": false,
-  "properties": {
-    "name": {
-      "type": "string"
-    },
-    "number": {
-      "type": "integer",
-      "minimum": 0
-    },
-    "stuff": {
-      "type": "array",
-      "uniqueItems": true,
-      "minItems": 1,
-      "items": {
-        "type": "string"
-      }
-    },
-    "url": {
-      "type": "string",
-      "format": "uri"
-    }
-  },
-  "required": ["name"]
-}

app/server.js

@@ -1,6 +0,0 @@
-const { APP_NAME, PORT } = require("./config");
-const app = require("./app");
-
-app.listen(PORT, () => {
-  console.log(`${APP_NAME} is listening on port ${PORT}...`);
-});