diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* 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/data/note/4d0cbf3e-28b3-4457-8552-70c3c8e7aece.json b/data/note/4d0cbf3e-28b3-4457-8552-70c3c8e7aece.json new file mode 100644 index 0000000..c50cd68 --- /dev/null +++ b/data/note/4d0cbf3e-28b3-4457-8552-70c3c8e7aece.json @@ -0,0 +1 @@ +{"id":"4d0cbf3e-28b3-4457-8552-70c3c8e7aece","name":"example name","content":"example content"} \ No newline at end of file diff --git a/lib/cors-middleware.js b/lib/cors-middleware.js new file mode 100644 index 0000000..998e1ab --- /dev/null +++ b/lib/cors-middleware.js @@ -0,0 +1,7 @@ +'use strict'; + +module.exports = (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..26655f8 --- /dev/null +++ b/lib/error-middleware.js @@ -0,0 +1,18 @@ +'use strict'; + +const createError = require('http-errors'); +const debug = require('debug')('note:error-middleware'); + +module.exports = (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..779d632 --- /dev/null +++ b/lib/storage.js @@ -0,0 +1,57 @@ +'use strict'; + +const Promise = require('bluebird'); +const fs = Promise.promisifyAll(require('fs'), {suffix: 'Pr'}); +const createError = require('http-errors'); +const debug = require('debug')('note:storage'); + +module.exports = exports = {}; + +exports.createItem = (schemaName, item) => { + debug('create item'); + + if(!schemaName) return Promise.reject(createError(400, 'expected schemaName')); + if(!item) return Promise.reject(createError(400, 'expected item')); + + return fs.writeFilePr(`${__dirname}/../data/${schemaName}/${item.id}.json`, JSON.stringify(item)) + .then(() => item) + .catch((err) => Promise.reject(createError(500, err.message))); +}; + +exports.fetchItem = (schemaName, id) => { + debug('fetch item'); + + if(!schemaName) return Promise.reject(createError(400, 'expected schemaName')); + if(!id) return Promise.reject(createError(400, 'expected id')); + + return fs.readFilePr(`${__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 = (schemaName, id) => { + debug('delete item'); + + if(!schemaName) return Promise.reject(createError(400, 'expected schemaName')); + if(!id) return Promise.reject(createError(400, 'expected id')); + + return fs.unlinkPr(`${__dirname}/../data/${schemaName}/${id}.json`) + .catch((err) => Promise.reject(createError(404, err.message))); +}; + +exports.availIDs = (schemaName) => { + debug('avail IDs'); + + if(!schemaName) return Promise.reject(createError(400, 'expected schemaName')); + + return fs.readdirPr(`${__dirname}/../data/${schemaName}`) + .then((files) => files.map((name) => name.split('.json')[0])) + .catch((err) => Promise.reject(createError(404, err.message))); +}; diff --git a/model/note.js b/model/note.js new file mode 100644 index 0000000..958e44a --- /dev/null +++ b/model/note.js @@ -0,0 +1,59 @@ +'use strict'; + +const uuidv4 = require('uuid/v4'); +const createError = require('http-errors'); +const debug = require('debug')('note:note'); +const storage = require('../lib/storage.js'); + +const Note = module.exports = function(name, content){ + debug('note constructor'); + + if(!name) return createError(400, 'expected name'); + if(!content) return createError(400, 'expected content'); + + this.id = uuidv4(); + this.name = name; + this.content = content; +}; + +Note.createNote = (_note) => { + debug('createNote'); + + try{ + let note = new Note(_note.name, _note.content); + return storage.createItem('note', note); + }catch(err){ + return Promise.reject(err); + } +}; + +Note.fetchNote = (id) => { + debug('fetchNote'); + + return storage.fetchItem('note', id); +}; + +Note.updateNote = (id, _note) => { + debug('updateNote'); + + return storage.fetchItem('note', id) + .catch((err) => Promise.reject(createError(404, err.message))) + .then((note) => { + for(var prop in note){ + if(prop === 'id') continue; + if(_note[prop]) note[prop] = _note[prop]; + } + return storage.createItem('note', note); + }); +}; + +Note.deleteNote = (id) => { + debug('deleteNote'); + return storage.deleteItem('note', id); +}; + +Note.fetchIDs = () => { + debug('fetchIDs'); + + return storage.availIDs('note'); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..c8d2658 --- /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/loganabsher/12-express-middleware.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/loganabsher/12-express-middleware/issues" + }, + "homepage": "https://github.com/loganabsher/12-express-middleware#readme", + "devDependencies": { + "chai": "^4.1.0", + "mocha": "^3.5.0", + "superagent": "^3.5.2" + }, + "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" + } +} diff --git a/router/note-router.js b/router/note-router.js new file mode 100644 index 0000000..9a5743f --- /dev/null +++ b/router/note-router.js @@ -0,0 +1,48 @@ +'use strict'; + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('note:note-router'); + +const Note = require('../model/note.js'); + +const noteRouter = module.exports = new Router(); + +noteRouter.post('/api/note', jsonParser, (req, res, next) => { + debug('POST: /api/note'); + + Note.createNote(req.body) + .then((note) => res.json(note)) + .catch((err) => next(err)); +}); + +noteRouter.get('/api/note/:id', (req, res, next) => { + debug('GET: /api/note/:id'); + + Note.fetchNote(req.params.id) + .then((note) => res.json(note)) + .catch((err) => next(err)); +}); + +noteRouter.get('/api/note', (req, res, next) => { + debug('GET: /api/note'); + + Note.fetchIDs() + .then((ids) => res.json(ids)) + .catch((err) => next(err)); +}); + +noteRouter.put('/api/note', jsonParser, (req, res, next) => { + debug('PUT: /api/note'); + + Note.updateNote(req.query.id, req.body) + .then((note) => res.json(note)) + .catch((err) => next(err)); +}); + +noteRouter.delete('/api/note/:id', (req, res, next) => { + debug('DELETE: /api/note'); + + Note.deleteNote(req.params.id) + .catch((err) => next(err)); +}); diff --git a/server.js b/server.js new file mode 100644 index 0000000..14d3c04 --- /dev/null +++ b/server.js @@ -0,0 +1,20 @@ +'use strict'; + +const morgan = require('morgan'); +const express = require('express'); +const createError = require('http-errors'); +const debug = require('debug')('note:server'); + +const noteRouter = require('./router/note-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(noteRouter); +app.use(errors); + +app.listen(PORT, () => console.log(`server running on PORT:${PORT}`)); diff --git a/test/http-req-test.js b/test/http-req-test.js new file mode 100644 index 0000000..c8d1873 --- /dev/null +++ b/test/http-req-test.js @@ -0,0 +1,127 @@ +'use strict'; + +const expect = require('chai').expect; +const superagent = require('superagent'); +const Note = require('../model/note.js'); +const url = 'http://localhost:8000'; + +require('../server.js'); + +let exampleNote = { + name: 'example name', + content: 'example content' +}; + +describe('Note Routes', function(){ + describe('GET: /api/note', function(){ + describe('with a valid id', function(){ + before((done) => { + Note.createNote(exampleNote) + .then((note) => { + this.tempNote = note; + done(); + }) + .catch((err) => done(err)); + }); + after((done) => { + Note.deleteNote(this.tempNote.id) + .then(()=> done()) + .catch((err) => done(err)); + }); + it('should return a note', (done) => { + superagent.get(`${url}/api/note/${this.tempNote.id}`) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempNote.id); + expect(res.body.name).to.equal(this.tempNote.name); + expect(res.body.content).to.equal(this.tempNote.content); + done(); + }); + }); + describe('with an invalid id', function(){ + it('should respond with a 404 status code', (done) => { + superagent.get(`${url}/api/note/123456789`) + .end((err, res) => { + expect(res.status).to.equal(404); + done(); + }); + }); + }); + }); + }); + describe('POST: /api/note', function(){ + describe('with a valid body', function() { + after((done) => { + if(this.tempNote){ + Note.deleteNote(this.tempNote.id) + .then(()=> done()) + .catch((err) => done(err)); + } + }); + it('should return a note', (done) => { + superagent.post(`${url}/api/note`) + .send(exampleNote) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal(exampleNote.name); + expect(res.body.content).to.equal(exampleNote.content); + this.tempNote = res.body; + done(); + }); + }); + }); + }); + describe('PUT: /api/note', function(){ + describe('with a valid id and body', function(){ + before((done) => { + Note.createNote(exampleNote) + .then((note) => { + this.tempNote = note; + done(); + }) + .catch((err) => done(err)); + }); + after((done) => { + if(this.tempNote){ + Note.deleteNote(this.tempNote.id) + .then(()=> done()) + .catch(done); + } + }); + it('should return a note', (done) => { + let updateNote = {name: 'new name', content: 'new content'}; + superagent.put(`${url}/api/note?id=${this.tempNote.id}`) + .send(updateNote) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempNote.id); + for(var prop in updateNote){ + expect(res.body[prop]).to.equal(updateNote[prop]); + } + done(); + }); + }); + }); + }); + describe('DELETE: /api/note', function(){ + before((done) => { + Note.createNote(exampleNote) + .then((note) => { + this.tempNote = note; + done(); + }) + .catch((err) => done(err)); + }); + it('Should remove a note', (done) => { + superagent.delete(`${url}/api/note/${this.tempNote.id}`) + .end((err) => { + if(err) return done(err); + expect(this.tempNote).to.equal(null); + done(); + }); + }); + }); +});