From 18421058ddca45aa7b64a4c62bd883120a3621e7 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 12:11:24 -0700 Subject: [PATCH 01/12] structure complete --- .eslintignore | 5 ++ .eslintrc | 21 ++++++++ .gitignore | 136 +++++++++++++++++++++++++++++++++++++++++++++++++ lib/storage.js | 53 +++++++++++++++++++ model/beer.js | 14 +++++ package.json | 30 +++++++++++ server.js | 0 7 files changed, 259 insertions(+) create mode 100644 .eslintignore create mode 100644 .eslintrc create mode 100644 .gitignore create mode 100644 lib/storage.js create mode 100644 model/beer.js create mode 100644 package.json create mode 100644 server.js 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/lib/storage.js b/lib/storage.js new file mode 100644 index 0000000..613ccd3 --- /dev/null +++ b/lib/storage.js @@ -0,0 +1,53 @@ +'use strict'; + +const Promise = require('bluebird'); +const fs = Promise.promisifyAll(require('fs'), { suffix: 'Prom' }); +const createError = require('http-errors'); +const debug = require('debug')('note: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(new Error(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(err)); +}; + +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(err); + } + }) + .catch( err => Promise.reject(err)); +}; + +exports.deleteItem = function(schemaName, id) { + debug('fetchItem'); + if (!schemaName) return Promise.reject(createError(400, 'expected schema name')); + if (!id) return Promise.reject(reateError(400, 'expected id')); + + return fs.unlinkProm(`${__dirname}/../data/${schemaName}/${id}.json`) + .then( () => { + try { + console.log('your file was deleted'); + + } catch (err) { + return Promise.reject(err); + } + }) + .catch( err => Promise.reject(err)); +}; diff --git a/model/beer.js b/model/beer.js new file mode 100644 index 0000000..270c39f --- /dev/null +++ b/model/beer.js @@ -0,0 +1,14 @@ +'use strict'; + +const uuidv4 = require('uuid/v4'); + +module.exports = function(name, style, IBU) { + if (!name) throw new Error('expected name'); + if (!style) throw new Error('expected content'); + if (!IBU) throw new Error('expected content'); + + this.id = uuidv4(); + this.name = name; + this.style = style; + this.IBU = IBU; +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..e89f5e3 --- /dev/null +++ b/package.json @@ -0,0 +1,30 @@ +{ + "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": "echo \"Error: no test specified\" && exit 1", + "start": "node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Jamesbillard12/11-express-api.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/Jamesbillard12/11-express-api/issues" + }, + "homepage": "https://github.com/Jamesbillard12/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" + } +} diff --git a/server.js b/server.js new file mode 100644 index 0000000..e69de29 From f50ca4ed44e1180949ba89a311769792c5450604 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 12:56:34 -0700 Subject: [PATCH 02/12] i have a basic server file, basic beer constructor, and storage.js has debug added --- lib/storage.js | 4 ++-- model/beer.js | 27 ++++++++++++++++++++++++++- package.json | 2 +- server.js | 17 +++++++++++++++++ 4 files changed, 46 insertions(+), 4 deletions(-) diff --git a/lib/storage.js b/lib/storage.js index 613ccd3..b8c20d5 100644 --- a/lib/storage.js +++ b/lib/storage.js @@ -10,7 +10,7 @@ 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(new Error(createError(400, 'expected item')); + if (!item) return Promise.reject(createError(400, 'expected item')); let json = JSON.stringify(item); return fs.writeFileProm(`${__dirname}/../data/${schemaName}/${item.id}.json`, json) @@ -38,7 +38,7 @@ exports.fetchItem = function(schemaName, id) { exports.deleteItem = function(schemaName, id) { debug('fetchItem'); if (!schemaName) return Promise.reject(createError(400, 'expected schema name')); - if (!id) return Promise.reject(reateError(400, 'expected id')); + if (!id) return Promise.reject(createError(400, 'expected id')); return fs.unlinkProm(`${__dirname}/../data/${schemaName}/${id}.json`) .then( () => { diff --git a/model/beer.js b/model/beer.js index 270c39f..d7ce170 100644 --- a/model/beer.js +++ b/model/beer.js @@ -1,8 +1,13 @@ 'use strict'; const uuidv4 = require('uuid/v4'); +const createError = require('http-errors'); +const debug = require('debug')('beer:beer'); +const storage = require('../lib/storage.js') + +const Beer = module.exports = function(name, style, IBU) { + debug('beer constructor'); -module.exports = function(name, style, IBU) { if (!name) throw new Error('expected name'); if (!style) throw new Error('expected content'); if (!IBU) throw new Error('expected content'); @@ -12,3 +17,23 @@ module.exports = function(name, style, IBU) { this.style = style; this.IBU = IBU; }; + +Beer.createBeer = function(_beer) { + debug('createBeer'); + + try { + let beer = new Beer(_beer.name, _beer.style, _beer.IBU); + return storage.createItem('beer', beer); + } catch(err) { + return Promise.reject(err); + } +}; + +Beer.fetchBeer = function(id) { + debug('fetchBeer'); + return(storage.fetchItem('beer', id)); +}; + +Beer.deleteBeer = function(id) { + +} diff --git a/package.json b/package.json index e89f5e3..6f161f6 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "main": "server.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "start": "node server.js" + "start": "DEBUG='beer*' node server.js" }, "repository": { "type": "git", diff --git a/server.js b/server.js index e69de29..6bbd88c 100644 --- a/server.js +++ b/server.js @@ -0,0 +1,17 @@ +'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')('beer:server'); +const Beer = require('./model/beer.js'); + +const PORT = process.env.PORT || 3000; +const app = express(); + + + +app.listen(PORT, () => { + debug('server up:', PORT); +}); From 0818b44003ad24c2334b4375f588d6ab2e4ab05d Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 13:05:28 -0700 Subject: [PATCH 03/12] added GET test route and it works, yay --- model/beer.js | 5 +++-- server.js | 7 +++++++ 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/model/beer.js b/model/beer.js index d7ce170..efefba0 100644 --- a/model/beer.js +++ b/model/beer.js @@ -35,5 +35,6 @@ Beer.fetchBeer = function(id) { }; Beer.deleteBeer = function(id) { - -} + debug('deleteBeer'); + return(storage.deleteItem('beer', id)); +}; diff --git a/server.js b/server.js index 6bbd88c..8087fcd 100644 --- a/server.js +++ b/server.js @@ -10,6 +10,13 @@ const Beer = require('./model/beer.js'); const PORT = process.env.PORT || 3000; const app = express(); +app.use(morgan('dev')); + +app.get('/test', function(req, res){ + debug('GET: /test'); + res.json({msg: 'you have tested a GET req'}); +}) + app.listen(PORT, () => { From 5c2f694ed31c1f185760024f9216ad675e2e688b Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 13:39:21 -0700 Subject: [PATCH 04/12] Post is working --- data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json | 1 + model/beer.js | 2 +- server.js | 10 +++++++++- 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json diff --git a/data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json b/data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json new file mode 100644 index 0000000..ed0aea0 --- /dev/null +++ b/data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json @@ -0,0 +1 @@ +{"id":"e356ecb8-ae2f-4fec-9d8d-82e04f369bc0","name":"testName","style":"teststyle","IBU":"testIBU"} \ No newline at end of file diff --git a/model/beer.js b/model/beer.js index efefba0..f94738c 100644 --- a/model/beer.js +++ b/model/beer.js @@ -3,7 +3,7 @@ const uuidv4 = require('uuid/v4'); const createError = require('http-errors'); const debug = require('debug')('beer:beer'); -const storage = require('../lib/storage.js') +const storage = require('../lib/storage.js'); const Beer = module.exports = function(name, style, IBU) { debug('beer constructor'); diff --git a/server.js b/server.js index 8087fcd..c384d30 100644 --- a/server.js +++ b/server.js @@ -15,7 +15,15 @@ app.use(morgan('dev')); app.get('/test', function(req, res){ debug('GET: /test'); res.json({msg: 'you have tested a GET req'}); -}) +}); + +app.post('/api/beer', jsonParser, function (req, res, next) { + debug('POST: /apo/beer'); + + Beer.createBeer(req.body) + .then( beer => res.json(beer)) + .catch( err => next(err)); +}); From aecc95753e4a01d43a55be12f7e61a6903bb6099 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 13:46:01 -0700 Subject: [PATCH 05/12] GET works --- server.js | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/server.js b/server.js index c384d30..c718ee0 100644 --- a/server.js +++ b/server.js @@ -12,7 +12,7 @@ const app = express(); app.use(morgan('dev')); -app.get('/test', function(req, res){ +app.get('/test', function(req, res) { debug('GET: /test'); res.json({msg: 'you have tested a GET req'}); }); @@ -25,6 +25,13 @@ app.post('/api/beer', jsonParser, function (req, res, next) { .catch( err => next(err)); }); +app.get('/api/beer', function(req, res, next) { + debug('GET: /api/beer'); + Beer.fetchBeer(req.query.id) + .then( beer => res.json(beer)) + .catch( err => next(err)); +}); + app.listen(PORT, () => { From 41209acb63bc63232606aed70de30ae897fbf49c Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 13:55:30 -0700 Subject: [PATCH 06/12] I can delete --- data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json | 1 - server.js | 7 +++++++ 2 files changed, 7 insertions(+), 1 deletion(-) delete mode 100644 data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json diff --git a/data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json b/data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json deleted file mode 100644 index ed0aea0..0000000 --- a/data/beer/e356ecb8-ae2f-4fec-9d8d-82e04f369bc0.json +++ /dev/null @@ -1 +0,0 @@ -{"id":"e356ecb8-ae2f-4fec-9d8d-82e04f369bc0","name":"testName","style":"teststyle","IBU":"testIBU"} \ No newline at end of file diff --git a/server.js b/server.js index c718ee0..0ad1a2b 100644 --- a/server.js +++ b/server.js @@ -32,6 +32,13 @@ app.get('/api/beer', function(req, res, next) { .catch( err => next(err)); }); +app.delete('/api/beer', function(req, res, next) { + debug('DELETE: /api/beet'); + Beer.deleteBeer(req.query.id) + .then( () => res.send('Deleted beer')) + .catch( err => next(err)); +}); + app.listen(PORT, () => { From b4a25e0ca854c282e22ee1732f976461528c66f6 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 15:41:24 -0700 Subject: [PATCH 07/12] off to testing? --- .../032d17df-3b41-43db-b14f-577fb38aed9b.json | 1 + .../ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json | 1 + server.js | 36 ++++++++++++++----- 3 files changed, 30 insertions(+), 8 deletions(-) create mode 100644 data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json create mode 100644 data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json diff --git a/data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json b/data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json new file mode 100644 index 0000000..e098584 --- /dev/null +++ b/data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json @@ -0,0 +1 @@ +{"id":"032d17df-3b41-43db-b14f-577fb38aed9b","name":"testName","style":"teststyle","IBU":"testIBU"} \ No newline at end of file diff --git a/data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json b/data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json new file mode 100644 index 0000000..f3de7d5 --- /dev/null +++ b/data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json @@ -0,0 +1 @@ +{"id":"ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc","name":"testName","style":"teststyle","IBU":"testIBU"} \ No newline at end of file diff --git a/server.js b/server.js index 0ad1a2b..477d330 100644 --- a/server.js +++ b/server.js @@ -12,16 +12,11 @@ const app = express(); app.use(morgan('dev')); -app.get('/test', function(req, res) { - debug('GET: /test'); - res.json({msg: 'you have tested a GET req'}); -}); - app.post('/api/beer', jsonParser, function (req, res, next) { - debug('POST: /apo/beer'); + debug('POST: /api/beer'); Beer.createBeer(req.body) - .then( beer => res.json(beer)) + .then( beer => res.status(200).json(beer)) .catch( err => next(err)); }); @@ -35,10 +30,35 @@ app.get('/api/beer', function(req, res, next) { app.delete('/api/beer', function(req, res, next) { debug('DELETE: /api/beet'); Beer.deleteBeer(req.query.id) - .then( () => res.send('Deleted beer')) + .then( () => res.status(204).send('Beer Deleted')) .catch( err => next(err)); }); +app.use(function(err, req, res, next){ + debug('error middleware'); + console.error(err.message); + + if(err.status){ + res.status(err.status).send(err.name); + return; + } + + if(res.status(404)){ + res.status(404).send('Not Found'); + return; + } + + if(err.status(400)){ + res.status(400).send('Bad Request'); + return; + } + + + + err = createError(500, err.message); + res.status(err.status).send(err.name); +}); + app.listen(PORT, () => { From 218f886a4f8ee112652b4ce95f7bac8f73d0e911 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 16:20:56 -0700 Subject: [PATCH 08/12] 404 and 400 not passing test --- .../032d17df-3b41-43db-b14f-577fb38aed9b.json | 1 - .../ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json | 1 - package.json | 7 +- server.js | 20 ++--- test/beer-route-test.js | 74 +++++++++++++++++++ 5 files changed, 90 insertions(+), 13 deletions(-) delete mode 100644 data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json delete mode 100644 data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json create mode 100644 test/beer-route-test.js diff --git a/data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json b/data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json deleted file mode 100644 index e098584..0000000 --- a/data/beer/032d17df-3b41-43db-b14f-577fb38aed9b.json +++ /dev/null @@ -1 +0,0 @@ -{"id":"032d17df-3b41-43db-b14f-577fb38aed9b","name":"testName","style":"teststyle","IBU":"testIBU"} \ No newline at end of file diff --git a/data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json b/data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json deleted file mode 100644 index f3de7d5..0000000 --- a/data/beer/ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc.json +++ /dev/null @@ -1 +0,0 @@ -{"id":"ba2d1c7b-13f5-4b6e-9f88-c221b774e1fc","name":"testName","style":"teststyle","IBU":"testIBU"} \ No newline at end of file diff --git a/package.json b/package.json index 6f161f6..356e038 100644 --- a/package.json +++ b/package.json @@ -4,7 +4,7 @@ "description": "![cf](https://i.imgur.com/7v5ASc8.png) 11: Single Resource Express API ======", "main": "server.js", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1", + "test": "mocha", "start": "DEBUG='beer*' node server.js" }, "repository": { @@ -26,5 +26,10 @@ "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 index 477d330..631c378 100644 --- a/server.js +++ b/server.js @@ -38,22 +38,22 @@ app.use(function(err, req, res, next){ debug('error middleware'); console.error(err.message); - if(err.status){ - res.status(err.status).send(err.name); - return; - } + // if(err.status){ + // res.status(err.status).send(err.name); + // return; + // } - if(res.status(404)){ - res.status(404).send('Not Found'); - return; - } - if(err.status(400)){ - res.status(400).send('Bad Request'); + if(res.status(400)){ + res.status(400).send(err.message); return; } + if(res.status(404)){ + res.status(404).send(err.message); + return; + } err = createError(500, err.message); res.status(err.status).send(err.name); diff --git a/test/beer-route-test.js b/test/beer-route-test.js new file mode 100644 index 0000000..f88b0b5 --- /dev/null +++ b/test/beer-route-test.js @@ -0,0 +1,74 @@ +'use strict'; + +const request = require('superagent'); +const expect = require('chai').expect; + +require('../server.js'); + +describe('Beer Routes', function() { + var beer = null; + + describe('POST: /api/beer', function() { + it('should return a beer', function(done) { + request.post('localhost:8000/api/beer') + .send({ name: 'test name', style: 'test style', IBU: 'test IBU' }) + .end((err, res) => { + if (err) return done(err); + console.log(res.body); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('test name'); + expect(res.body.style).to.equal('test style'); + expect(res.body.IBU).to.equal('test IBU'); + beer = res.body; + done(); + }); + }); + it('should return 400', function(done) { + request.post('localhost:8000/api/beer') + .send({}) + .end((err, res) => { + expect(res.status).to.equal(400); + done(); + }); + }); + }); + + describe('GET: /api/beer', function() { + it('should return a beer', function(done) { + request.get(`localhost:8000/api/beer?id=${beer.id}`) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('test name'); + expect(res.body.style).to.equal('test style'); + expect(res.body.IBU).to.equal('test IBU'); + done(); + }); + }); + it('should return 404 not found', function(done) { + request.get('localhost:8000/api/beer?id=6194fa11-758f-477f-a597-61a5a8ca65cb') + .end((err, res) => { + expect(res.status).to.equal(404); + done(); + }); + }); + it('should return 400 bad request', function(done) { + request.get('localhost:8000/api/beer?id=') + .end((err, res) => { + expect(res.status).to.equal(400); + done(); + }); + }); + }); + + describe('DELETE: /api/beer', function() { + it('should return 204', function(done) { + request.delete(`localhost:8000/api/beer?id=${beer.id}`) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(204); + done(); + }); + }); + }); +}); From 208aa85e00e6f5b76c65471dab6efcf8a3ce5805 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 16:53:53 -0700 Subject: [PATCH 09/12] all errrors are working --- data/beer/undefined.json | 1 + lib/storage.js | 2 +- model/beer.js | 6 +++--- server.js | 12 ++++++------ 4 files changed, 11 insertions(+), 10 deletions(-) create mode 100644 data/beer/undefined.json diff --git a/data/beer/undefined.json b/data/beer/undefined.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/data/beer/undefined.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/lib/storage.js b/lib/storage.js index b8c20d5..122caae 100644 --- a/lib/storage.js +++ b/lib/storage.js @@ -32,7 +32,7 @@ exports.fetchItem = function(schemaName, id) { return Promise.reject(err); } }) - .catch( err => Promise.reject(err)); + .catch( () => Promise.reject(createError(404, 'not found'))); }; exports.deleteItem = function(schemaName, id) { diff --git a/model/beer.js b/model/beer.js index f94738c..cefc90b 100644 --- a/model/beer.js +++ b/model/beer.js @@ -8,9 +8,9 @@ const storage = require('../lib/storage.js'); const Beer = module.exports = function(name, style, IBU) { debug('beer constructor'); - if (!name) throw new Error('expected name'); - if (!style) throw new Error('expected content'); - if (!IBU) throw new Error('expected content'); + if (!name) return Promise.reject(createError(400, 'expected name')); + if (!style) return Promise.reject(createError(400, 'expected style')); + if (!IBU) return Promise.reject(createError(400, 'expected IBU')); this.id = uuidv4(); this.name = name; diff --git a/server.js b/server.js index 631c378..2a5f899 100644 --- a/server.js +++ b/server.js @@ -36,24 +36,24 @@ app.delete('/api/beer', function(req, res, next) { app.use(function(err, req, res, next){ debug('error middleware'); - console.error(err.message); + console.error('hello', err.message); // if(err.status){ // res.status(err.status).send(err.name); // return; // } + if(err.status === 404){ + res.status(404).send(err.message); + return; + } - if(res.status(400)){ + if(err.status === 400){ res.status(400).send(err.message); return; } - if(res.status(404)){ - res.status(404).send(err.message); - return; - } err = createError(500, err.message); res.status(err.status).send(err.name); From 0eb511541e91db1ecfc46a93e9284d6a3fdb7bf6 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 17:24:04 -0700 Subject: [PATCH 10/12] finished testing --- data/beer/undefined.json | 1 - model/beer.js | 10 +++++----- 2 files changed, 5 insertions(+), 6 deletions(-) delete mode 100644 data/beer/undefined.json diff --git a/data/beer/undefined.json b/data/beer/undefined.json deleted file mode 100644 index 9e26dfe..0000000 --- a/data/beer/undefined.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file diff --git a/model/beer.js b/model/beer.js index cefc90b..52931a2 100644 --- a/model/beer.js +++ b/model/beer.js @@ -8,9 +8,9 @@ const storage = require('../lib/storage.js'); const Beer = module.exports = function(name, style, IBU) { debug('beer constructor'); - if (!name) return Promise.reject(createError(400, 'expected name')); - if (!style) return Promise.reject(createError(400, 'expected style')); - if (!IBU) return Promise.reject(createError(400, 'expected IBU')); + if (!name) throw new Error('expected content'); + if (!style) throw new Error('expected content'); + if (!IBU) throw new Error('expected content'); this.id = uuidv4(); this.name = name; @@ -24,8 +24,8 @@ Beer.createBeer = function(_beer) { try { let beer = new Beer(_beer.name, _beer.style, _beer.IBU); return storage.createItem('beer', beer); - } catch(err) { - return Promise.reject(err); + } catch (err) { + return Promise.reject(createError(400, 'bad request')); } }; From 8127d899504dded02dd1329aa11aa9bf15ff81e6 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 17:33:05 -0700 Subject: [PATCH 11/12] eslint ignore on app.use next --- server.js | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/server.js b/server.js index 2a5f899..0c02acc 100644 --- a/server.js +++ b/server.js @@ -34,14 +34,9 @@ app.delete('/api/beer', function(req, res, next) { .catch( err => next(err)); }); -app.use(function(err, req, res, next){ +app.use(function(err, req, res, next){ //eslint-disable-line debug('error middleware'); - console.error('hello', err.message); - - // if(err.status){ - // res.status(err.status).send(err.name); - // return; - // } + console.error(err.message); if(err.status === 404){ res.status(404).send(err.message); @@ -53,14 +48,10 @@ app.use(function(err, req, res, next){ return; } - - err = createError(500, err.message); res.status(err.status).send(err.name); }); - - app.listen(PORT, () => { debug('server up:', PORT); }); From cab437e9106ea71e3ef021cde9c26c46ad47b140 Mon Sep 17 00:00:00 2001 From: Jamesbillard12 Date: Mon, 31 Jul 2017 17:36:38 -0700 Subject: [PATCH 12/12] added readme --- README.md | 128 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 75 insertions(+), 53 deletions(-) diff --git a/README.md b/README.md index feb511f..051bd82 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,75 @@ -![cf](https://i.imgur.com/7v5ASc8.png) 11: Single Resource Express API -====== - -## Submission Instructions - * fork this repository & create a new branch for your work - * write all of your code in a directory named `lab-` + `` **e.g.** `lab-susan` - * push to your repository - * submit a pull request to this repository - * submit a link to your PR in canvas - * write a question and observation on canvas - -## Learning Objectives -* students will be able to create a single resource API using the express framework -* students will be able to leverage 3rd party helper modules for debugging, logging, and handling errors - -## Requirements - -#### Configuration -* `package.json` -* `.eslintrc` -* `.gitignore` -* `README.md` - * your `README.md` should include detailed instructions on how to use your API - -#### Feature Tasks -* create an HTTP server using `express` -* create a object constructor that creates a _simple resource_ with at least 3 properties - * it can **not** have the same properties as the in-class sample code (other than the `id`) - * a unique `id` property should be included *(node-uuid)* - * include two additional properties of your choice -* use the JSON parser included with the `body-parser` module as a middleware component to parse the request body on `POST` and `PUT` routes -* use the npm `debug` module to log the methods in your application -* create an `npm` script to automate the `debug` process and start the server -* persist your API data using the storage module and file system persistence - -#### Server Endpoints -* **`/api/simple-resource-name`** -* `POST` request - * pass data as stringifed JSON in the body of a **POST** request to create a new resource -* `GET` request - * pass `?id=` as a query string parameter to retrieve a specific resource (as JSON) -* `DELETE` request - * pass `?id=` in the query string to **DELETE** a specific resource - * this should return a 204 status code with no content in the body - -#### Tests -* write a test to ensure that your api returns a status code of 404 for routes that have not been registered -* write tests to ensure the `/api/simple-resource-name` endpoint responds as described for each condition below: - * `GET`: test 404, it should respond with 'not found' for valid requests made with an id that was not found - * `GET`: test 400, it should respond with 'bad request' if no id was provided in the request - * `GET`: test 200, it should contain a response body for a request made with a valid id - * `POST`: test 400, it should respond with 'bad request' if no request body was provided or the body was invalid - * `POST`: test 200, it should respond with the body content for a post request with a valid body +# Vanilla API Persistence - 09 Lab + +## Description: +This app builds out an API where data is stored in the file system. This API stores beer data with the schema of name, style, and IBU. + +## API: +The URL endpoint to access the api is `/api/beer`. Using REST architecture the data is read, written and deleted using `GET`, `POST` and `DELETE` requests. + +### POST: + +``` +request.post('localhost:8000/api/beer') +.send({ name: 'Have a Nice Day IPA', style: 'IPA', IBU: '43' }) +``` + +This is a representation of the POST method. You can see that we first make a request to post to +``` +localhost:8000 +``` +with a route of +``` +/api/beer +``` +Once the connection has bee made we send our beer in +``` +.send({ name: 'Have a Nice Day IPA', style: 'IPA', IBU: '43' }) +``` +format. This will respond with 200 if the request was made or 400 if not. + +### GET + +``` +request.get(`localhost:8000/api/beer?id=${beer.id}`) +``` +This is a representation of the GET method. You can see that we first make a request to post to + +``` +localhost:8000 +``` +with a route of + +``` +/api/beer +``` + +finally with finish the request with reference to a specific id which was generated with uuid + +``` +?id=${beer.id} +``` + +This will respond with 200 if the request was made, 404 if not found or 400 if the request was made in wrong format. + +### DELETE + +``` +request.delete(`localhost:8000/api/beer?id=${beer.id}`) +``` + +This is a representation of the POST method. You can see that we first make a request to post to + +``` +localhost:8000 +``` +with a route of + +``` +/api/beer +``` +finally with finish the request with reference to a specific id which was generated with uuid +``` +?id=${beer.id} +``` + +This will respond with 200 if the request was made, 404 if not found or 400 if the request was made in wrong format.