From dc7a9c6a886c13dcfbe400d618f9496e7aa63a8b Mon Sep 17 00:00:00 2001 From: andyfiveeleven Date: Tue, 1 Aug 2017 18:14:59 -0700 Subject: [PATCH] tests all working --- .gitignore | 1 + .../1a1ee70e-e7ba-45d7-b74b-b4b0233be0cb.json | 1 + .../2ec48c31-1e52-4701-9857-87cd2bdc25f0.json | 1 + .../e56672f3-362a-4a2b-b4b2-c683f1727eb5.json | 1 + lib/cors-middleware.js | 7 ++ lib/error-middleware.js | 21 ++++ lib/storage.js | 57 +++++++++ model/hike.js | 57 +++++++++ package.json | 39 ++++++ route/hike-router.js | 41 ++++++ server.js | 22 ++++ test/hike-route-test.js | 117 ++++++++++++++++++ 12 files changed, 365 insertions(+) create mode 100644 .gitignore create mode 100644 data/hike/1a1ee70e-e7ba-45d7-b74b-b4b0233be0cb.json create mode 100644 data/hike/2ec48c31-1e52-4701-9857-87cd2bdc25f0.json create mode 100644 data/hike/e56672f3-362a-4a2b-b4b2-c683f1727eb5.json create mode 100644 lib/cors-middleware.js create mode 100644 lib/error-middleware.js create mode 100644 lib/storage.js create mode 100644 model/hike.js create mode 100644 package.json create mode 100644 route/hike-router.js create mode 100644 server.js create mode 100644 test/hike-route-test.js diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3c3629e --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +node_modules diff --git a/data/hike/1a1ee70e-e7ba-45d7-b74b-b4b0233be0cb.json b/data/hike/1a1ee70e-e7ba-45d7-b74b-b4b0233be0cb.json new file mode 100644 index 0000000..7838fdf --- /dev/null +++ b/data/hike/1a1ee70e-e7ba-45d7-b74b-b4b0233be0cb.json @@ -0,0 +1 @@ +{"id":"1a1ee70e-e7ba-45d7-b74b-b4b0233be0cb","name":"party hike","location":"party town"} \ No newline at end of file diff --git a/data/hike/2ec48c31-1e52-4701-9857-87cd2bdc25f0.json b/data/hike/2ec48c31-1e52-4701-9857-87cd2bdc25f0.json new file mode 100644 index 0000000..ea5055f --- /dev/null +++ b/data/hike/2ec48c31-1e52-4701-9857-87cd2bdc25f0.json @@ -0,0 +1 @@ +{"id":"2ec48c31-1e52-4701-9857-87cd2bdc25f0","name":"party hike","location":"party town"} \ No newline at end of file diff --git a/data/hike/e56672f3-362a-4a2b-b4b2-c683f1727eb5.json b/data/hike/e56672f3-362a-4a2b-b4b2-c683f1727eb5.json new file mode 100644 index 0000000..ad2eccf --- /dev/null +++ b/data/hike/e56672f3-362a-4a2b-b4b2-c683f1727eb5.json @@ -0,0 +1 @@ +{"id":"e56672f3-362a-4a2b-b4b2-c683f1727eb5","name":"party hike","location":"party town"} \ No newline at end of file diff --git a/lib/cors-middleware.js b/lib/cors-middleware.js new file mode 100644 index 0000000..0e42383 --- /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..6950706 --- /dev/null +++ b/lib/error-middleware.js @@ -0,0 +1,21 @@ +'use strict'; + +const createError = require('http-errors'); +const debug = require('debug')('hike:error-middlware'); + +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 errror'); + 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..77ebd9d --- /dev/null +++ b/lib/storage.js @@ -0,0 +1,57 @@ +'use strict'; + +const Promise = require('bluebird'); +const fs = Promise.promisifyAll(require('fs'), {suffix: 'Prom'}); +const createError = require('http-errors'); +const debug = require('debug')('hike: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) { + debug('available ids'); + 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/model/hike.js b/model/hike.js new file mode 100644 index 0000000..d09994a --- /dev/null +++ b/model/hike.js @@ -0,0 +1,57 @@ +'use strict'; + +const uuidv4 = require('uuid/v4'); +const createError = require('http-errors'); +const debug = require('debug')('hike:hike'); +const storage = require('../lib/storage.js'); + +const Hike = module.exports = function(name, location) { + debug('hike constructr'); + + if(!name) throw new Error('expected name'); + if(!location) throw new Error('expected content'); + + this.id = uuidv4(); + this.name = name; + this.location = location; +}; + +Hike.createHike = function(_hike) { + debug('createHike'); + + try { + let hike = new Hike(_hike.name, _hike.location); + return storage.createItem('hike', hike); + } catch (err) { + return Promise.reject(err); + } +}; + +Hike.fetchHike = function(id) { + debug('fetch Hike '); + return storage.fetchItem('hike', id); +}; + +Hike.updateHike = function(id, _hike) { + debug('update hike'); + + return storage.fetchItem('hike', id) + .catch( err=> Promise.reject(createError(404, err.message))) + .then (hike => { + for (var prop in hike) { + if(prop === 'id')continue; + if (_hike[prop]) hike[prop] = _hike[prop]; + } + return storage.createItem('hike', hike); + }); +}; + +Hike.deleteHike = function(id){ + debug('deleteHike'); + return storage.deleteItem('hike', id); +}; + +Hike.fetchIDs = function() { + debug('fetchIDs'); + return storage.availIDs('hike'); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..7c56f4f --- /dev/null +++ b/package.json @@ -0,0 +1,39 @@ +{ + "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='hike*' ./node_modules/mocha/bin/mocha", + "start": "DEBUG='hike*' node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/andyfiveeleven/12-express-middleware.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/andyfiveeleven/12-express-middleware/issues" + }, + "homepage": "https://github.com/andyfiveeleven/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", + "mkdirp": "^0.5.1", + "morgan": "^1.8.2", + "uuid": "^3.1.0" + } +} diff --git a/route/hike-router.js b/route/hike-router.js new file mode 100644 index 0000000..497c5fb --- /dev/null +++ b/route/hike-router.js @@ -0,0 +1,41 @@ +'use strict' + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('hike:hike-route'); +const Hike = require('../model/hike.js'); +const hikeRouter = new Router(); + +hikeRouter.post('/api/hike', jsonParser, function(req,res,next){ + debug('POST: /api/hike'); + + Hike.createHike(req.body) + .then( hike => res.json(hike)) + .catch(err => next(err)); +}); + +hikeRouter.get('/api/hike/:id', function(req,res,next ){ + debug('GET: /api/hike:id'); + + Hike.fetchHike(req.params.id) + .then(hike=> res.json(hike)) + .catch( err=> next(err)); +}); + +hikeRouter.get('/api/hike', function(req, res, next){ + debug('GET /api/hike'); + + Hike.fetchIDs() + .then( ids => res.json(ids)) + .catch( err => next(err)); +}); + +hikeRouter.put('/api/hike', jsonParser, function(req, res, next) { + debug('PUT: /api/hike'); + + Hike.updateHike(req.query.id,req.body) + .then( hike => res.json(hike)) + .catch( err => next(err)); +}); + +module.exports = hikeRouter; diff --git a/server.js b/server.js new file mode 100644 index 0000000..3904f9c --- /dev/null +++ b/server.js @@ -0,0 +1,22 @@ +'use strict' + +const morgan = require('morgan'); +const express = require('express'); +const createError = require('http-errors'); +const debug = require('debug')('hike:server'); + +const hikeRouter = require('./route/hike-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(hikeRouter); +app.use(errors); + +app.listen(PORT, () => { + console.log(`server up on ${PORT}`); +}); diff --git a/test/hike-route-test.js b/test/hike-route-test.js new file mode 100644 index 0000000..2acf8e5 --- /dev/null +++ b/test/hike-route-test.js @@ -0,0 +1,117 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); +const Hike = require('../model/hike.js'); +const url = 'http://localhost:8000'; + +require('../server.js'); + +const exampleHike = { + name: 'party hike', + location: 'party town' +}; + +describe('hike routes', function() { + describe('GET: /api/hike', function(){ + describe('with a valid id', function(){ + before( done => { + Hike.createHike(exampleHike) + .then( hike => { + this.tempHike = hike; + done(); + }) + .catch(err => done(err)); + }); + + after(done => { + Hike.deleteHike(this.tempHike.id) + .then( () => done()) + .catch( err => done(err)); + }); + + it('should return a hike', done => { + request.get(`${url}/api/hike/${this.tempHike.id}`) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempHike.id); + expect(res.body.name).to.equal(this.tempHike.name); + expect(res.body.location).to.equal(this.tempHike.location); + done(); + }); + }); + + describe('with an invalid id', function() { + it('shoulr respond witha 404', done => { + request.get(`${url}/api/hike/1234565678`) + .end((err, res)=> { + expect(res.status).to.equal(404); + done(); + }); + }); + }); + }); + }); + + describe('POST: /api/hike', function(){ + describe('with a valid body', function(){ + after(done => { + if(this.tempHike) { + Hike.deleteHike(this.tempHike.id) + .then( () => done()) + .catch( err=> done(err)); + } + }); + + it('should return a hike', done =>{ + request.post(`${url}/api/hike`) + .send(exampleHike) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal(exampleHike.name); + expect(res.body.location).to.equal(exampleHike.location); + this.tempHike = res.body; + done(); + }); + }); + }); + }); + + describe('PUT /api/hike', function(){ + describe('with a valid id and body', function(){ + before( done => { + Hike.createHike(exampleHike) + .then( hike => { + this.tempHike = hike; + done(); + }) + .catch (err => done(err)); + }); + + after(done => { + if (this.tempHike) { + Hike.deleteHike(this.tempHike.id) + .then( ()=> done()) + .catch(done); + } + }); + + it('should return a hike', done =>{ + let updateHike = {name: 'party hike', location: 'party town'}; + request.put(`${url}/api/hike?id=${this.tempHike.id}`) + .send(updateHike) + .end((err, res)=> { + if (err)return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempHike.id); + for (var prop in updateHike){ + expect(res.body[prop]).to.equal(updateHike[prop]) + } + done(); + }); + }); + }); + }); +});