From 8f91e7abb93f1f46d535b9bc2c219be08f30af21 Mon Sep 17 00:00:00 2001 From: Bret Ldenburg Date: Tue, 1 Aug 2017 17:07:16 -0700 Subject: [PATCH] finished the lab for today --- .eslintrc | 21 ++++++ .gitignore | 136 +++++++++++++++++++++++++++++++++++ lib/cors-middleware.js | 7 ++ lib/error-middleware.js | 21 ++++++ lib/storage.js | 54 ++++++++++++++ model/superhero.js | 57 +++++++++++++++ package.json | 38 ++++++++++ route/superhero-router.js | 41 +++++++++++ server.js | 22 ++++++ test/superhero-route-test.js | 117 ++++++++++++++++++++++++++++++ 10 files changed, 514 insertions(+) create mode 100644 .eslintrc create mode 100644 .gitignore create mode 100644 lib/cors-middleware.js create mode 100644 lib/error-middleware.js create mode 100644 lib/storage.js create mode 100644 model/superhero.js create mode 100644 package.json create mode 100644 route/superhero-router.js create mode 100644 server.js create mode 100644 test/superhero-route-test.js diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/.eslintrc @@ -0,0 +1,21 @@ +{ + "rules": { + "no-console": "off", + "indent": [ "error", 2 ], + "quotes": [ "error", "single" ], + "semi": ["error", "always"], + "linebreak-style": [ "error", "unix" ] + }, + "env": { + "es6": true, + "node": true, + "mocha": true, + "jasmine": true + }, + "ecmaFeatures": { + "modules": true, + "experimentalObjectRestSpread": true, + "impliedStrict": true + }, + "extends": "eslint:recommended" +} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..345130c --- /dev/null +++ b/.gitignore @@ -0,0 +1,136 @@ +# Created by https://www.gitignore.io/api/osx,vim,node,macos,windows + +### macOS ### +*.DS_Store +.AppleDouble +.LSOverride + +# Icon must end with two \r +Icon + +# Thumbnails +._* + +# Files that might appear in the root of a volume +.DocumentRevisions-V100 +.fseventsd +.Spotlight-V100 +.TemporaryItems +.Trashes +.VolumeIcon.icns +.com.apple.timemachine.donotpresent + +# Directories potentially created on remote AFP share +.AppleDB +.AppleDesktop +Network Trash Folder +Temporary Items +.apdisk + +### Node ### +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Typescript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + + +### OSX ### + +# Icon must end with two \r + +# Thumbnails + +# Files that might appear in the root of a volume + +# Directories potentially created on remote AFP share + +### Vim ### +# swap +[._]*.s[a-v][a-z] +[._]*.sw[a-p] +[._]s[a-v][a-z] +[._]sw[a-p] +# session +Session.vim +# temporary +.netrwhist +*~ +# auto-generated tag files +tags + +### Windows ### +# Windows thumbnail cache files +Thumbs.db +ehthumbs.db +ehthumbs_vista.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + +# End of https://www.gitignore.io/api/osx,vim,node,macos,windows diff --git a/lib/cors-middleware.js b/lib/cors-middleware.js new file mode 100644 index 0000000..5dcf9d1 --- /dev/null +++ b/lib/cors-middleware.js @@ -0,0 +1,7 @@ +'use strict'; + +module.exports = function(req, res, next) { + res.append('Access-Control-Allow-Origin', '*'); + res.append('Access-Control-Allow-Headers', '*'); + next(); +} diff --git a/lib/error-middleware.js b/lib/error-middleware.js new file mode 100644 index 0000000..39b48db --- /dev/null +++ b/lib/error-middleware.js @@ -0,0 +1,21 @@ +'use strict'; + +const createError = require('http-errors'); +const debug = require('debug')('superhero:error-middleware'); + +module.exports = function(err, req, res, next) { + console.error(err.message); + + if (err.status) { + debug('user error'); + + res.status(err.status).send(err.name); + next(); + return; + } + + debug('server error'); + err = createError(500, err.message); + res.status(err.status).send(err.name); + next(); +}; diff --git a/lib/storage.js b/lib/storage.js new file mode 100644 index 0000000..0c1bcdf --- /dev/null +++ b/lib/storage.js @@ -0,0 +1,54 @@ +'use strict'; + +const Promise = require('bluebird'); +const fs = Promise.promisifyAll(require('fs'), {suffix: 'Prom'}); +const createError = require('http-errors'); +const debug = require('debug')('superhero:storage'); + +module.exports = exports = {}; + +exports.createItem = function(schemaName, item) { + debug('createItem'); + + if (!schemaName) return Promise.reject(createError(400, 'expected schema name')); + if (!item) return Promise.reject(createError(400, 'expected item')); + + let json = JSON.stringify(item); + return fs.writeFileProm(`${__dirname}/../data/${schemaName}/${item.id}.json`, json) + .then( () => item) + .catch( err => Promise.reject(createError(500, err.message))); +}; + +exports.fetchItem = function(schemaName, id) { + debug('fetchItem'); + + if (!schemaName) return Promise.reject(createError(400, 'expected schema name')); + if (!id) return Promise.reject(createError(400, 'expected id')); + + return fs.readFileProm(`${__dirname}/../data/${schemaName}/${id}.json`) + .then(data => { + try { + let item = JSON.parse(data.toString()); + return item; + } catch (err) { + return Promise.reject(createError(500, err.message)); + } + }) + .catch(err => Promise.reject(createError(404, err.message))); +}; + +exports.deleteItem = function(schemaName, id) { + debug('deleteItem'); + + if (!schemaName) return Promise.reject(createError(400, 'expected schema name')); + if (!id) return Promise.reject(createError(400, 'expected id')); + + return fs.unlinkProm(`${__dirname}/../data/${schemaName}/${id}.json`) + .catch( err => Promise.reject(createError(404, err.message))); +}; + +exports.availIDs = function(schemaName) { + return fs.readdirProm(`${__dirname}/../data/${schemaName}`) + .then( files => files.map(name => name.split('.json')[0])) + .catch( err => Promise.reject(createError(404, err.message))); +}; diff --git a/model/superhero.js b/model/superhero.js new file mode 100644 index 0000000..9a03250 --- /dev/null +++ b/model/superhero.js @@ -0,0 +1,57 @@ +'use strict'; + +const uuidv4 = require('uuid/v4'); +const createError = require('http-errors'); +const debug = require('debug')('superhero:superhero'); +const storage = require('../lib/storage.js'); + +const Superhero = module.exports = function(name, comicUni) { + debug('superhero constructor'); + + if (!name) throw new Error('expected name'); + if (!comicUni) throw new Error('expected comicUni'); + + this.id = uuidv4(); + this.name = name; + this.comicUni = comicUni; +}; + +Superhero.createSuperhero = function(_superhero) { + debug('createSuperhero'); + + try { + let superhero = new Superhero(_superhero.name, _superhero.comicUni); + return storage.createItem('superhero', superhero); + } catch (err) { + return Promise.reject(err); + } +}; + +Superhero.fetchSuperhero = function(id) { + debug('fetchSuperhero'); + return storage.fetchItem('superhero', id); +}; + +Superhero.updateSuperhero = function(id, _superhero) { + debug('updateSuperhero'); + + return storage.fetchItem('superhero', id) + .catch( err => Promise.reject(createError(404, err.message))) + .then( superhero => { + for (var prop in superhero) { + if (prop === 'id') continue; + if (_superhero[prop]) superhero[prop] = _superhero[prop]; + } + return storage.createItem('superhero', superhero); + }); +}; + +Superhero.deleteSuperhero = function(id) { + debug('deleteSuperhero'); + return storage.deleteItem('superhero', id); +}; + +Superhero.fetchIDs = function() { + debug('fetchIDs'); + return storage.availIDs('superhero'); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..95d37df --- /dev/null +++ b/package.json @@ -0,0 +1,38 @@ +{ + "name": "12-express-middleware", + "version": "1.0.0", + "description": "![cf](https://i.imgur.com/7v5ASc8.png) 12: Express Middleware ======", + "main": "server.js", + "directories": { + "test": "test" + }, + "scripts": { + "test": "DEBUG='note*' ./node_modules/mocha/bin/mocha", + "start": "DEBUG='note*' node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/bretladenburg/12-express-middleware.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/bretladenburg/12-express-middleware/issues" + }, + "homepage": "https://github.com/bretladenburg/12-express-middleware#readme", + "dependencies": { + "bluebird": "^3.5.0", + "body-parser": "^1.17.2", + "debug": "^2.6.8", + "express": "^4.15.3", + "http-errors": "^1.6.1", + "morgan": "^1.8.2", + "uuid": "^3.1.0" + }, + "devDependencies": { + "chai": "^4.1.0", + "mocha": "^3.5.0", + "superagent": "^3.5.2" + } +} diff --git a/route/superhero-router.js b/route/superhero-router.js new file mode 100644 index 0000000..5bcf69e --- /dev/null +++ b/route/superhero-router.js @@ -0,0 +1,41 @@ +'use strict'; + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('superhero:superhero-router'); +const Superhero = require('../model/superhero.js'); +const superheroRouter = new Router(); + +superheroRouter.post('/api/superhero', jsonParser, function(req, res, next) { + debug('POST: /api/superhero'); + + Superhero.createSuperhero(req.body) + .then( superhero => res.json(superhero)) + .catch( err => next(err)); +}); + +superheroRouter.get('/api/superhero/:id', function(req, res, next) { + debug('GET: /api/superhero/:id'); + + Superhero.fetchSuperhero(req.params.id) + .then( superhero => res.json(superhero)) + .catch( err => next(err)); +}); + +superheroRouter.get('/api/superhero', function(req, res, next) { + debug('GET: /api/superhero'); + + Superhero.fetchIDs() + .then( ids => res.json(ids)) + .catch( err => next(err)); +}); + +superheroRouter.put('/api/superhero', jsonParser, function(req, res, next) { + debug('PUT: /api/superhero'); + + Superhero.updateSuperhero(req.query.id, req.body) + .then( superhero => res.json(superhero)) + .catch( err => next(err)); +}); + +module.exports = superheroRouter; diff --git a/server.js b/server.js new file mode 100644 index 0000000..80b6ed9 --- /dev/null +++ b/server.js @@ -0,0 +1,22 @@ +'use strict'; + +const morgan = require('morgan'); +const express = require('express'); +const createError = require('http-errors'); +const debug = require('debug')('superhero:server'); + +const superheroRouter = require('./route/superhero-router.js'); +const cors = require('./lib/cors-middleware.js'); +const errors = require('./lib/error-middleware.js'); + +const PORT = process.env.PORT || 3000; +const app = express(); + +app.use(morgan('dev')); +app.use(cors); +app.use(superheroRouter); +app.use(errors); + +app.listen(PORT, () => { + console.log(`server up: ${PORT}`); +}); diff --git a/test/superhero-route-test.js b/test/superhero-route-test.js new file mode 100644 index 0000000..d22f390 --- /dev/null +++ b/test/superhero-route-test.js @@ -0,0 +1,117 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); +const Superhero = require('../model/superhero.js'); +const url = 'http://localhost:8000'; + +require('../server.js'); + +const exampleSuperhero = { + name: 'example name', + comicUni: 'example comicUni' +}; + +describe('Superhero Routes', function() { + describe('GET: /api/superhero', function() { + describe('with a valid id', function() { + before( done => { + Superhero.createSuperhero(exampleSuperhero) + .then(superhero => { + this.tempSuperhero = superhero; + done(); + }) + .catch( err => done(err)); + }); + + after( done => { + Superhero.deleteSuperhero(this.tempSuperhero.id) + .then( () => done()) + .catch( err => done(err)); + }); + + it('should return a note', done => { + request.get(`${url}/api/superhero/${this.tempSuperhero.id}`) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempSuperhero.id); + expect(res.body.name).to.equal(this.tempSuperhero.name); + expect(res.body.comicUni).to.equal(this.tempSuperhero.comicUni); + done(); + }); + }); + + describe('with an invalid id', function() { + it('should respond with a 404 status code', done => { + request.get(`${url}/api/superhero/12345`) + .end((err, res) => { + expect(res.status).to.equal(404); + done(); + }); + }); + }); + }); + }); + + describe('POST: /api/superhero', function() { + describe('with a valid body', function() { + after( done => { + if (this.tempSuperhero) { + Superhero.deleteSuperhero(this.tempSuperhero.id) + .then( () => done()) + .catch( err => done(err)); + } + }); + + it('should return a superhero', done => { + request.post(`${url}/api/superhero`) + .send(exampleSuperhero) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal(exampleSuperhero.name); + expect(res.body.comicUni).to.equal(exampleSuperhero.comicUni); + this.tempSuperhero = res.body; + done(); + }); + }); + }); + }); + + describe('PUT: /api/superhero', function() { + describe('with a valid id and body', function() { + before( done => { + Superhero.createSuperhero(exampleSuperhero) + .then( superhero => { + this.tempSuperhero = superhero; + done(); + }) + .catch( err => done(err)); + }); + + after( done => { + if (this.tempSuperhero) { + Superhero.deleteSuperhero(this.tempSuperhero.id) + .then( () => done()) + .catch(done); + } + }); + + it('should return a superhero', done => { + let updateSuperhero = {name: 'new name', comicUni: 'new comicUni'}; + request.put(`${url}/api/superhero?id=${this.tempSuperhero.id}`) + .send(updateSuperhero) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempSuperhero.id); + for (var prop in updateSuperhero) { + expect(res.body[prop]).to.equal(updateSuperhero[prop]); + } + done(); + }); + }); + }); + }); +});