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/README.md b/README.md index 8d00d0f..2cd8e90 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,93 @@ -![cf](https://i.imgur.com/7v5ASc8.png) 12: Express Middleware -====== - -## 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 work with application, router, and 3rd party middleware through the use of express.js -* students will be able to implement custom middleware through the use of express.js -* students will be able to create custom routers for a specific resource - -## Requirements - -#### Configuration -* `package.json` -* `.eslintrc` -* `.gitignore` -* `README.md` - * your `README.md` should include detailed instructions on how to use your API - -#### Feature Tasks -* create a single resource `express` API that can handle **GET**, **POST**, and **PUT** requests -* use the `http-errors` module to create new errors and associate them with a proper status code -* create an `error-middleware` module to handle errors and *use* it in your server file -* create a `cors-middleware` module that will allow for public use of your API -* create the `deleteItem` and `availIDs` methods and add them to your `storage` module - * these methods should be used to delete a resource (`deleteItem`) and return an array of id's from persisted resource filenames (`availIDs`) -* create the `updateNote`, `fetchNote`, and `fetchIDs` static methods as part of your `Note` model -* create a series of `note-route-tests` to test your **GET**, **POST**, and **PUT** routes - * **hint:** *you'll want to use the `before` and `after` hooks provided by `mocha` in order to create a test note and delete the note after the test has completed* +# 12: Express Middleware + +## 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 +#### With ID +``` +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. + +#### Without ID + +``` +request.get(`localhost:8000/api/beer`) +``` +This is a representation of the GET method without an ID. This will respond with all the available IDs. You can see that we first make a request to post to + +``` +localhost:8000 +``` +with a route of + +``` +/api/beer +``` + +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. diff --git a/lib/cors-middleware.js b/lib/cors-middleware.js new file mode 100644 index 0000000..6661797 --- /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..b7810d8 --- /dev/null +++ b/lib/error-middleware.js @@ -0,0 +1,22 @@ +'use strict'; + +const createError = require('http-errors'); +const debug = require('debug')('beer: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..da28cc7 --- /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')('beer: 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()); + console.log(item); + return item; + } catch (err){ + return Promise.reject(createError(500, err.message)); + } + }) + .catch(err => Promise.reject(createError(404, err.message))); +}; + +exports.deleteItem = function(schemaName, id){ + 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){ + 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/beer.js b/model/beer.js new file mode 100644 index 0000000..f32b58c --- /dev/null +++ b/model/beer.js @@ -0,0 +1,58 @@ +'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'); + if(!name) throw new Error('expected name'); + if(!style) throw new Error('expected style'); + if(!ibu) throw new Error('expected ibu'); + + this.id = uuidv4(); + this.name = name; + 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.updateBeer = function(id, _beer) { + debug('updateNote'); + + return storage.fetchItem('beer', id) + .catch( err => Promise.reject(createError(404, err.message))) + .then( beer => { + for (var prop in beer) { + if (prop === 'id') continue; + if (_beer[prop]) beer[prop] = _beer[prop]; + } + return storage.createItem('beer', beer); + }); +}; + +Beer.deleteBeer = function(id){ + debug('deleteBeer'); + return storage.deleteItem('beer', id); +}; + +Beer.fetchIDs = function() { + debug('fetchIDs'); + return storage.availIDs('beer'); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..7a2d37d --- /dev/null +++ b/package.json @@ -0,0 +1,35 @@ +{ + "name": "12-express-middleware", + "version": "1.0.0", + "description": "![cf](https://i.imgur.com/7v5ASc8.png) 12: Express Middleware ======", + "main": "server.js", + "scripts": { + "test": "DEBUG='beer*' mocha", + "start": "DEBUG='beer*' node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Jamesbillard12/12-express-middleware.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/Jamesbillard12/12-express-middleware/issues" + }, + "homepage": "https://github.com/Jamesbillard12/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/beer-router.js b/route/beer-router.js new file mode 100644 index 0000000..ba37f89 --- /dev/null +++ b/route/beer-router.js @@ -0,0 +1,50 @@ +'use strict'; + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('beer:beer-router'); +const Beer = require('../model/beer.js'); +const beerRouter = new Router(); + +beerRouter.post('/api/beer', jsonParser, function(req, res, next){ + debug('POST: /api/beer'); + + Beer.createBeer(req.body) + .then( beer => res.json(beer)) + .catch( err => next(err)); +}); + +beerRouter.get('/api/beer/:id', function(req, res, next){ + debug('GET: /api/beer/:id'); + + Beer.fetchBeer(req.params.id) + .then( beer => res.json(beer)) + .catch( err => next(err)); +}); + + +beerRouter.get('/api/beer', function(req, res, next){ + debug('GET: /api/beer'); + + Beer.fetchIDs() + .then( beerIDs => res.json(beerIDs)) + .catch( err => next(err)); +}); + + +beerRouter.put('/api/beer', jsonParser, function(req, res, next) { + debug('PUT: /api/beer'); + + Beer.updateBeer(req.query.id, req.body) + .then( beer => res.json(beer)) + .catch( err => next(err)); +}); + +beerRouter.delete('/api/beer', function(req, res, next){ + debug('DELETE: api/beer'); + + Beer.deleteBeer(req.params.id) + .catch(err => next(err)); +}); + +module.exports = beerRouter; diff --git a/server.js b/server.js new file mode 100644 index 0000000..84c8936 --- /dev/null +++ b/server.js @@ -0,0 +1,19 @@ +'use strict'; + +const morgan = require('morgan'); +const express = require('express'); +const beerRouter = require('./route/beer-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(beerRouter); +app.use(errors); + +app.listen(PORT, () => { + console.log(`server up ${PORT}`); +}); diff --git a/test/beer-route-test.js b/test/beer-route-test.js new file mode 100644 index 0000000..d00c866 --- /dev/null +++ b/test/beer-route-test.js @@ -0,0 +1,117 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); +const Beer = require('../model/beer.js'); +const url = 'http://localhost:8000'; + +require('../server.js'); + +const exampleBeer = { + name: 'example name', + style: 'example style', + ibu: 'example ibu' +}; + +describe('New Routes', function() { + describe('with a valid id', function() { + before( done => { + Beer.createBeer(exampleBeer) + .then(beer => { + this.tempBeer = beer; + console.log(this.tempBeer); + done(); + }) + .catch (err => done(err)); + }); + after( done => { + Beer.deleteBeer(this.tempBeer.id) + .then( () => done()) + .catch( err => done(err)); + }); + + it('should return a beer', done => { + request.get(`${url}/api/beer/${this.tempBeer.id}`) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempBeer.id); + expect(res.body.name).to.equal(this.tempBeer.name); + expect(res.body.style).to.equal(this.tempBeer.style); + expect(res.body.ibu).to.equal(this.tempBeer.ibu); + done(); + }); + }); + + describe('with an invalid id', function() { + it('should respond with 404 status code', done => { + request.get(`${url}/api/beer/123456789`) + .end((err, res) => { + expect(res.status).to.equal(404); + done(); + }); + }); + }); + }); +}); + +describe('POST: /api/beer', function() { + describe('with a valid body', function() { + after( done => { + if (this.tempBeer) { + Beer.deleteBeer(this.tempBeer.id) + .then( ()=> done()) + .catch( err => done(err)); + } + }); + + it('should return a beer', done => { + request.post(`${url}/api/beer`) + .send(exampleBeer) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal(exampleBeer.name); + expect(res.body.content).to.equal(exampleBeer.content); + this.tempBeer = res.body; + done(); + }); + }); + }); +}); + +describe('PUT: /api/beer', function() { + describe('with a valid id and body', function() { + before( done => { + Beer.createBeer(exampleBeer) + .then( beer => { + this.tempBeer = beer; + done(); + }) + .catch( err => done(err)); + }); + + after( done => { + if (this.tempBeer) { + Beer.deleteBeer(this.tempBeer.id) + .then( ()=> done()) + .catch(done); + } + }); + + it('should return a beer', done => { + let updateBeer = { name: 'new name', style: 'new style', ibu: 'new ibu' }; + request.put(`${url}/api/beer?id=${this.tempBeer.id}`) + .send(updateBeer) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempBeer.id); + for (var prop in updateBeer) { + expect(res.body[prop]).to.equal(updateBeer[prop]); + } + done(); + }); + }); + }); +});