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/3f1e82e0-c854-43b9-9879-1b35b2047673.json b/data/note/3f1e82e0-c854-43b9-9879-1b35b2047673.json new file mode 100644 index 0000000..39b4967 --- /dev/null +++ b/data/note/3f1e82e0-c854-43b9-9879-1b35b2047673.json @@ -0,0 +1 @@ +{"id":"3f1e82e0-c854-43b9-9879-1b35b2047673","name":"Logan","content":"21"} \ No newline at end of file diff --git a/lib/storage.js b/lib/storage.js new file mode 100644 index 0000000..2af1043 --- /dev/null +++ b/lib/storage.js @@ -0,0 +1,55 @@ +'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 = function(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(err)); +}; + +exports.fetchItem = function(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(err); + } + }) + .catch((err) => Promise.reject(err)); +}; + +exports.updateItem = (schemaName, item) => { + debug('update item'); + if(!schemaName) return Promise.reject(createError(400, 'expected schemaName')); + if(!item) return Promise.reject(createError(400, 'expected input')); + + return fs.writeFilePr(`${__dirname}/../data/${schemaName}/${item.id}.json`, JSON.stringify(item)) + .then(() => Promise.resolve(item)) + .catch((err) => Promise.reject(err)); +}; + +exports.removeItem = (schemaName, id) => { + debug('remove 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`) + .then(() => Promise.resolve()) + .catch((err) => Promise.reject(err)); +}; diff --git a/model/note.js b/model/note.js new file mode 100644 index 0000000..2a2f9d6 --- /dev/null +++ b/model/note.js @@ -0,0 +1,44 @@ +'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, 'bad request'); + if(!content) return createError(400, 'bad request'); + + this.id = uuidv4(); + this.name = name; + this.content = content; +}; + +Note.createNote = (_note) => { + debug('create note'); + try{ + let note = new Note(_note.name, _note.content); + return storage.createItem('note', note); + }catch(err){ + return Promise.reject(err); + } +}; + +Note.fetchNote = (id) => { + debug('fetch note'); + return storage.fetchItem('note', id); +}; + +Note.replaceNote = (_note) => { + debug('replace note'); + let note = new Note(_note.name, _note.content); + note.id = _note.target; + return storage.updateItem('note', note); +}; + +Note.deleteNote = (id) => { + debug('delete note'); + return storage.removeItem('note', id); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..7a7144b --- /dev/null +++ b/package.json @@ -0,0 +1,35 @@ +{ + "name": "11-express-api", + "version": "1.0.0", + "description": "![cf](https://i.imgur.com/7v5ASc8.png) 11: Single Resource Express API ======", + "main": "server.js", + "scripts": { + "test": "mocha", + "start": "DEBUG='note*' node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/loganabsher/11-express-api.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/loganabsher/11-express-api/issues" + }, + "homepage": "https://github.com/loganabsher/11-express-api#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/server.js b/server.js new file mode 100644 index 0000000..24d0528 --- /dev/null +++ b/server.js @@ -0,0 +1,69 @@ +'use strict'; + +const express = require('express'); +const morgan = require('morgan'); +const createError = require('http-errors'); +const jsonParser = require('body-parser').json(); +const debug = require('debug')('note:server'); +const Note = require('./model/note.js'); + +const PORT = process.env.PORT || 3000; + +const app = express(); + +app.use(morgan('dev')); + +app.get('/test', (req, res, next) => { + debug('GET: /test'); + res.json({msg: 'testing GET route success'}); + next(); +}); + +app.post('/api/note', jsonParser, (req, res, next) => { + debug('POST: /api/note'); + if(!req.name || !req.content){ + next(); + } + Note.createNote(req.body) + .then((note) => res.json(note)) + .catch((err) => next(err)); +}); + +app.get('/api/note', (req, res, next) => { + debug('GET: /api/note'); + Note.fetchNote(req.query.id) + .then((note) => res.json(note)) + .catch((err) => next(err)); +}); + +app.put('/api/note', jsonParser, (req, res, next) => { + debug('PUT: /api/note'); + console.log(req.query); + Note.replaceNote(req.query) + .then((note) => res.json(note)) + .catch((err) => next(err)); +}); + +app.delete('/api/note', (req, res, next) => { + debug('DELETE: /api/note'); + Note.deleteNote(req.query.id) + .then((note) => res.json(note)) + .catch((err) => next(err)); +}); + +// app.use('/*', (req, res) => { +// debug('bad route middleware'); +// console.log('yes'); +// return res.status(404); +// }); + +app.use((err, req, res, next) => { + debug('error middleware'); + console.error(err.message); + if(err.status) return res.status(err.status).send(err.name); + err = createError(404, err.message); + res.status(err.status).send(err.name); + next(); +}); + +app.listen(PORT, () => debug('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..c35e4d3 --- /dev/null +++ b/test/http-req-test.js @@ -0,0 +1,52 @@ +'use strict'; + +const request = require('superagent'); +const expect = require('chai').expect; + +// require('../server.js'); + +describe('http Test Module', () => { + let testId = ''; + it('Should have GET return a status of 404', (done) => { + request.get('localhost:8000/api/failure') + .end((err)=> { + expect(err.status).to.equal(404); + done(); + }); + }); + it('Should have GET return 400 with valid route', (done) => { + request.get('localhost:8000/api/note') + .end((err) => { + expect(err.status).to.equal(400); + done(); + }); + }); + it('Should have POST return 404 with valid route', (done) => { + request.post('localhost:8000/api/note') + .end((err) => { + expect(err.status).to.equal(404); + done(); + }); + }); + it('Should POST a route', (done) => { + request.post('localhost:8000/api/note') + .send({name: 'Logan', content: '21'}) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('Logan'); + expect(res.body.content).to.equal('21'); + testId = res.body.id; + done(); + }); + }); + it('Should GET a route', (done) => { + request.get('localhost:8000/api/note') + .send({id: testId}) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + done(); + }); + }); +});