diff --git a/lab-hawa/.eslintrc b/lab-hawa/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/lab-hawa/.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/lab-hawa/.gitignore b/lab-hawa/.gitignore new file mode 100644 index 0000000..43bce2d --- /dev/null +++ b/lab-hawa/.gitignore @@ -0,0 +1,117 @@ +# Created by https://www.gitignore.io/api/ma,node,macos,windows,linux + +#!! ERROR: ma is undefined. Use list command to see defined gitignore types !!# + +node_modules/ + +### Node ### +# Logs +logs +*.log +npm-debug.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 + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules +jspm_packages + +# 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 + + + +### 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 + + +### Windows ### +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + + +### Linux ### +*~ + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* diff --git a/lab-hawa/README.md b/lab-hawa/README.md new file mode 100644 index 0000000..c13252b --- /dev/null +++ b/lab-hawa/README.md @@ -0,0 +1,2 @@ +__Express Middleware__ +====== diff --git a/lab-hawa/data/spiritAnimal/1371e7a0-d111-11e6-bb8c-4d90b94618c3.json b/lab-hawa/data/spiritAnimal/1371e7a0-d111-11e6-bb8c-4d90b94618c3.json new file mode 100644 index 0000000..17dcac9 --- /dev/null +++ b/lab-hawa/data/spiritAnimal/1371e7a0-d111-11e6-bb8c-4d90b94618c3.json @@ -0,0 +1 @@ +{"id":"1371e7a0-d111-11e6-bb8c-4d90b94618c3","name":"example name","spiritAnimal":"example spiritAnimal","spiritAnimalName":"example spiritAnimalName"} \ No newline at end of file diff --git a/lab-hawa/data/spiritAnimal/5577dcb0-c7dc-11e6-93bd-a13b10be40d2.json b/lab-hawa/data/spiritAnimal/5577dcb0-c7dc-11e6-93bd-a13b10be40d2.json new file mode 100644 index 0000000..8e917e4 --- /dev/null +++ b/lab-hawa/data/spiritAnimal/5577dcb0-c7dc-11e6-93bd-a13b10be40d2.json @@ -0,0 +1 @@ +{"id":"5577dcb0-c7dc-11e6-93bd-a13b10be40d2","name":"example name","spiritAnimal":"example spiritAnimal","spiritAnimalName":"example spiritAnimalName"} \ No newline at end of file diff --git a/lab-hawa/data/spiritAnimal/55815290-c7dc-11e6-93bd-a13b10be40d2.json b/lab-hawa/data/spiritAnimal/55815290-c7dc-11e6-93bd-a13b10be40d2.json new file mode 100644 index 0000000..f042c1f --- /dev/null +++ b/lab-hawa/data/spiritAnimal/55815290-c7dc-11e6-93bd-a13b10be40d2.json @@ -0,0 +1 @@ +{"id":"55815290-c7dc-11e6-93bd-a13b10be40d2","name":"example name","spiritAnimal":"example spiritAnimal","spiritAnimalName":"example spiritAnimalName"} \ No newline at end of file diff --git a/lab-hawa/data/spiritAnimal/917279f0-c7dc-11e6-9c23-f9e3f0401c40.json b/lab-hawa/data/spiritAnimal/917279f0-c7dc-11e6-9c23-f9e3f0401c40.json new file mode 100644 index 0000000..eb8af7e --- /dev/null +++ b/lab-hawa/data/spiritAnimal/917279f0-c7dc-11e6-9c23-f9e3f0401c40.json @@ -0,0 +1 @@ +{"id":"917279f0-c7dc-11e6-9c23-f9e3f0401c40","name":"example name","spiritAnimal":"example spiritAnimal","spiritAnimalName":"example spiritAnimalName"} \ No newline at end of file diff --git a/lab-hawa/data/spiritAnimal/a2719c30-c88c-11e6-af99-5d1dde52a62c.json b/lab-hawa/data/spiritAnimal/a2719c30-c88c-11e6-af99-5d1dde52a62c.json new file mode 100644 index 0000000..19cf4ff --- /dev/null +++ b/lab-hawa/data/spiritAnimal/a2719c30-c88c-11e6-af99-5d1dde52a62c.json @@ -0,0 +1 @@ +{"id":"a2719c30-c88c-11e6-af99-5d1dde52a62c","name":"example name","spiritAnimal":"example spiritAnimal","spiritAnimalName":"example spiritAnimalName"} \ No newline at end of file diff --git a/lab-hawa/data/spiritAnimal/ada78bb0-c7dc-11e6-af9c-d7a9c1c62256.json b/lab-hawa/data/spiritAnimal/ada78bb0-c7dc-11e6-af9c-d7a9c1c62256.json new file mode 100644 index 0000000..06d84ac --- /dev/null +++ b/lab-hawa/data/spiritAnimal/ada78bb0-c7dc-11e6-af9c-d7a9c1c62256.json @@ -0,0 +1 @@ +{"id":"ada78bb0-c7dc-11e6-af9c-d7a9c1c62256","name":"example name","spiritAnimal":"example spiritAnimal","spiritAnimalName":"example spiritAnimalName"} \ No newline at end of file diff --git a/lab-hawa/data/spiritAnimal/e2d4fac0-c7dc-11e6-8d84-b9f4c59011fc.json b/lab-hawa/data/spiritAnimal/e2d4fac0-c7dc-11e6-8d84-b9f4c59011fc.json new file mode 100644 index 0000000..386249a --- /dev/null +++ b/lab-hawa/data/spiritAnimal/e2d4fac0-c7dc-11e6-8d84-b9f4c59011fc.json @@ -0,0 +1 @@ +{"id":"e2d4fac0-c7dc-11e6-8d84-b9f4c59011fc","name":"example name","spiritAnimal":"example spiritAnimal","spiritAnimalName":"example spiritAnimalName"} \ No newline at end of file diff --git a/lab-hawa/gulpfile.js b/lab-hawa/gulpfile.js new file mode 100644 index 0000000..00fd57d --- /dev/null +++ b/lab-hawa/gulpfile.js @@ -0,0 +1,25 @@ +'use strict'; + +const gulp = require('gulp'); +const eslint = require('gulp-eslint'); +const mocha = require('gulp-mocha'); + +//TODO:watch each individual file?? + +gulp.task('test', function(){ + gulp.src('./test/*-test.js', {read: false}) + .pipe(mocha({reporter: 'spec'})); +}); + +gulp.task('lint', function(){ + return gulp.src(['**/*.js','!node_modules/**']) + .pipe(eslint()) + .pipe(eslint.format()) + .pipe(eslint.failAfterError()); +}); + +gulp.task('dev', function(){ + gulp.watch(['**/*.js','!node_modules/**'], ['test', 'lint']); +}); + +gulp.task('default', ['dev']); diff --git a/lab-hawa/lib/cors-middleware.js b/lab-hawa/lib/cors-middleware.js new file mode 100644 index 0000000..6661797 --- /dev/null +++ b/lab-hawa/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/lab-hawa/lib/error-middleware.js b/lab-hawa/lib/error-middleware.js new file mode 100644 index 0000000..5c8863d --- /dev/null +++ b/lab-hawa/lib/error-middleware.js @@ -0,0 +1,21 @@ +'use strict'; + +const createError = require('http-errors'); +const debug = require('debug')('spiritAnimal: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/lab-hawa/lib/storage.js b/lab-hawa/lib/storage.js new file mode 100644 index 0000000..21b4eb2 --- /dev/null +++ b/lab-hawa/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')('spiritAnimal: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/lab-hawa/model/spiritAnimal.js b/lab-hawa/model/spiritAnimal.js new file mode 100644 index 0000000..2b1a9e2 --- /dev/null +++ b/lab-hawa/model/spiritAnimal.js @@ -0,0 +1,62 @@ +'use strict'; + +const uuid = require('node-uuid'); +const createError = require('http-errors'); +const debug = require('debug')('spiritAnimal:spiritAnimal'); +const storage = require('../lib/storage.js'); + +const SpiritAnimal = module.exports = function(name, spiritAnimal, spiritAnimalName) { + debug('spirit animal constructor'); + + if (!name) throw createError(400, 'expected name'); + if (!spiritAnimal) throw createError(400, 'expected spirit animal'); + if (!spiritAnimalName) throw createError(400, 'expected favorite animal'); + + this.id = uuid.v1(); + this.name = name; + this.spiritAnimal = spiritAnimal; + this.spiritAnimalName = spiritAnimalName; +}; + +SpiritAnimal.createSpiritAnimal = function (_spiritAnimal) { + debug('createItem -- spiritAnimal.js'); + + try { + let spiritAnimal = new SpiritAnimal(_spiritAnimal.name, _spiritAnimal.spiritAnimal, _spiritAnimal.spiritAnimalName); + return storage.createItem('spiritAnimal', spiritAnimal); + } catch (err) { + return Promise.reject(createError(400, err.message)); + } +}; + +SpiritAnimal.fetchSpiritAnimal = function(id) { + debug('fetchSpiritAnimal'); + + return storage.fetchItem('spiritAnimal', id); +}; + +SpiritAnimal.updateSpiritAnimal = function(id, _spiritAnimal) { + debug('updateSpirtAnimal'); + + return storage.fetchItem('spiritAnimal', id) + .catch( err => Promise.reject(createError(404, err.message))) + .then( spiritAnimal => { + for (var prop in spiritAnimal) { + if (prop === 'id') continue; + if(_spiritAnimal[prop]) spiritAnimal[prop] = _spiritAnimal[prop]; + } + return storage.createItem('spiritAnimal', spiritAnimal); + }); +}; + +SpiritAnimal.deleteSpiritAnimal = function(id) { + debug('deleteSpiritAnimal'); + + return storage.deleteItem('spiritAnimal', id); +}; + +SpiritAnimal.fetchIDs = function() { + debug('fetchIDs'); + + return storage.availIDs('spiritAnimal'); +}; diff --git a/lab-hawa/package.json b/lab-hawa/package.json new file mode 100644 index 0000000..255ba3e --- /dev/null +++ b/lab-hawa/package.json @@ -0,0 +1,32 @@ +{ + "name": "lab-hawa", + "version": "1.0.0", + "description": "", + "main": "server.js", + "directories": { + "test": "test" + }, + "scripts": { + "start": "DEBUG='spiritAnimal*' node server.js", + "test": "DEBUG='spiritAnimal*' mocha" + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "bluebird": "^3.4.6", + "body-parser": "^1.15.2", + "chai": "^3.5.0", + "debug": "^2.5.1", + "express": "^4.14.0", + "http-errors": "^1.5.1", + "mocha": "^3.2.0", + "morgan": "^1.7.0", + "node-uuid": "^1.4.7" + }, + "devDependencies": { + "chai": "^3.5.0", + "mocha": "^3.2.0", + "superagent": "^3.3.1" + } +} diff --git a/lab-hawa/route/spiritAnimal-router.js b/lab-hawa/route/spiritAnimal-router.js new file mode 100644 index 0000000..882e59e --- /dev/null +++ b/lab-hawa/route/spiritAnimal-router.js @@ -0,0 +1,41 @@ +'use strict'; + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('spiritAnimal:spiritAnimal-router'); +const SpiritAnimal = require('../model/spiritAnimal.js'); +const spiritAnimalRouter = new Router(); + +spiritAnimalRouter.post('/api/spiritAnimal', jsonParser, function(req, res, next) { + debug('POST: /api/spiritAnimal'); + + SpiritAnimal.createSpiritAnimal(req.body) + .then( spiritAnimal => res.json(spiritAnimal)) + .catch( err => next(err)); +}); + +spiritAnimalRouter.get('/api/spiritAnimal/:id', function(req, res, next) { + debug('GET: /api/spiritAnimal/:id'); + + SpiritAnimal.fetchSpiritAnimal(req.params.id) + .then( spiritAnimal => res.json(spiritAnimal)) + .catch( err => next(err)); +}); + +spiritAnimalRouter.get('/api/spiritAnimal', function(req, res, next) { + debug('GET: /api/spiritAnimal'); + + SpiritAnimal.fetchIDs() + .then( ids => res.json(ids)) + .catch(next); +}); + +spiritAnimalRouter.put('/api/spiritAnimal', jsonParser, function(req, res, next) { + debug('PUT: /api/spiritAnimal'); + + SpiritAnimal.updateSpiritAnimal(req.query.id, req.body) + .then( spiritAnimal => res.json(spiritAnimal)) + .catch(next); +}); + +module.exports = spiritAnimalRouter; diff --git a/lab-hawa/server.js b/lab-hawa/server.js new file mode 100644 index 0000000..69d5d1e --- /dev/null +++ b/lab-hawa/server.js @@ -0,0 +1,21 @@ +'use strict'; + +const morgan = require('morgan'); +const express = require('express'); +const createError = require('http-errors'); +const cors = require('./lib/cors-middleware.js'); +const errors = require('./lib/error-middleware.js'); +const debug = require('debug')('spiritAnimal:server'); +const spiritAnimalRouter = require('./route/spiritAnimal-router.js'); + +const PORT = process.env.PORT || 3000; +const app = express(); + +app.use(morgan('dev')); +app.use(cors); +app.use(spiritAnimalRouter); +app.use(errors); + +app.listen(PORT, () => { + console.log(`server up: ${PORT}`); +}); diff --git a/lab-hawa/test/spiritAnimal-route-test.js b/lab-hawa/test/spiritAnimal-route-test.js new file mode 100644 index 0000000..a0accc7 --- /dev/null +++ b/lab-hawa/test/spiritAnimal-route-test.js @@ -0,0 +1,143 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); +const SpiritAnimal = require('../model/spiritAnimal.js'); +const url = 'http://localhost:3000'; + +require('../server.js'); + +const exampleSpiritAnimal = { + name: 'example name', + spiritAnimal: 'example spiritAnimal', + spiritAnimalName: 'example spiritAnimalName' +}; + +describe('Spirit Animal Route', function() { + + describe('POST: /api/spiritAnimal', function() { + describe('with a valid body', function() { + after( done => { + if(this.tempSpiritAnimal) { + SpiritAnimal.deleteSpiritAnimal(this.tempSpiritAnimal.id) + .then( () => done()) + .catch(done); + } + }); + + it('should return a spiritAnimal', done => { + request.post(`${url}/api/spiritAnimal`) + .send(exampleSpiritAnimal) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal(exampleSpiritAnimal.name); + expect(res.body.spiritAnimal).to.equal(exampleSpiritAnimal.spiritAnimal); + expect(res.body.spiritAnimalName).to.equal(exampleSpiritAnimal.spiritAnimalName); + this.tempSpiritAnimal = res.body; + done(); + }); + }); + + it('Should return a status of 400 and bad request with no body', done => { + request.post(`${url}/api/spiritAnimal`) + .end((err, res) => { + expect(err).to.be.an('error'); + expect(res.status).to.equal(400); + expect(res.body.id).to.equal(undefined); + done(); + }); + }); + + it('Should return a status of 400 and bad request with wrong body inputs', done => { + request + .post(`${url}/api/spiritAnimal`) + .send({hello: 'World', world: 'Hello'}) + .end((err, res) => { + expect(err).to.be.an('error'); + expect(res.status).to.equal(400); + expect(res.body.id).to.equal(undefined); + done(); + }); + }); + }); + }); + + describe('GET: /api/spiritAnimal', function() { + describe('with a valid body', function() { + before( done => { + SpiritAnimal.createSpiritAnimal(exampleSpiritAnimal) + .then(spiritAnimal => { + this.tempSpiritAnimal = spiritAnimal; + done(); + }) + .catch( err => done(err)); + }); + + after( done => { + SpiritAnimal.deleteSpiritAnimal(this.tempSpiritAnimal.id) + .then( () => done()) + .catch(done); + }); + + it('should return a spirit animal', done => { + request.get(`${url}/api/spiritAnimal/${this.tempSpiritAnimal.id}`) + .end( (err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempSpiritAnimal.id); + expect(res.body.name).to.equal(this.tempSpiritAnimal.name); + expect(res.body.spiritAnimal).to.equal(this.tempSpiritAnimal.spiritAnimal); + expect(res.body.spiritAnimalName).to.equal(this.tempSpiritAnimal.spiritAnimalName); + done(); + }); + }); + }); + + describe('with an invalid id', function() { + it('should respond with a 404 status', done => { + request.get(`${url}/api/spiritAnimal/12`) + .end((err, res) => { + expect(res.status).to.equal(404); + done(); + }); + }); + }); + }); + + describe('PUT: /api/spiritAnimal', function() { + describe('with a valid body and id', function() { + before( done => { + SpiritAnimal.createSpiritAnimal(exampleSpiritAnimal) + .then( spiritAnimal => { + this.tempSpiritAnimal = spiritAnimal; + done(); + }) + .catch(done); + }); + + after( done => { + if (this.tempSpiritAnimal) { + SpiritAnimal.deleteSpiritAnimal(this.tempSpiritAnimal.id) + .then( () => done()) + .catch(done); + } + }); + + it('should return a spirit animal', done => { + let updateSpiritAnimal = { name: 'new name', spiritAnimal: 'new spiritAnimal', spiritAnimalName: 'new spiritAnimalName' }; + request.put(`${url}/api/spiritAnimal?id=${this.tempSpiritAnimal.id}`) + .send(updateSpiritAnimal) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempSpiritAnimal.id); + for (var prop in updateSpiritAnimal) { + expect(res.body[prop]).to.equal(updateSpiritAnimal[prop]); + } + done(); + }); + }); + }); + }); +});