diff --git a/lab-sharmarke/.eslintignore b/lab-sharmarke/.eslintignore new file mode 100644 index 0000000..05b1cf3 --- /dev/null +++ b/lab-sharmarke/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* diff --git a/lab-sharmarke/.eslintrc b/lab-sharmarke/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/lab-sharmarke/.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/lab-sharmarke/.gitignore b/lab-sharmarke/.gitignore new file mode 100644 index 0000000..345130c --- /dev/null +++ b/lab-sharmarke/.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/lab-sharmarke/lib/cors-middleware.js b/lab-sharmarke/lib/cors-middleware.js new file mode 100644 index 0000000..6661797 --- /dev/null +++ b/lab-sharmarke/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/lab-sharmarke/lib/error-middleware.js b/lab-sharmarke/lib/error-middleware.js new file mode 100644 index 0000000..eaa3126 --- /dev/null +++ b/lab-sharmarke/lib/error-middleware.js @@ -0,0 +1,20 @@ +'use strict'; + +const createError = require('http-errors'); +const debug = require('debug')('car: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/lab-sharmarke/lib/storage.js b/lab-sharmarke/lib/storage.js new file mode 100644 index 0000000..2e3c74a --- /dev/null +++ b/lab-sharmarke/lib/storage.js @@ -0,0 +1,54 @@ +'use strict'; + +const Promise = require('bluebird'); +const fs = Promise.promisifyAll(require('fs'), {suffix: 'Prom'}); +const createError = require('http-errors'); +const debug = require('debug')('car: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.writeFilePath(`${__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(404, err.message)); + + return fs.unlinkProm(`${__dirname}/../data/${schemaName}/${id}.json`) + .catch( err => Promise.reject(createError(404, err.message))); +} + +exports.availIDs = function(schemaName) { + 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/lab-sharmarke/model/car.js b/lab-sharmarke/model/car.js new file mode 100644 index 0000000..cde0344 --- /dev/null +++ b/lab-sharmarke/model/car.js @@ -0,0 +1,59 @@ +'use strict'; + +const uuidv4 = require('uuid/v4'); +const createError = require('http-errors'); +const debug = require('debug')('car:car'); +const storage = require('../lib/storage.js'); + +const Car = module.exports = function(make, model, year) { + debug('note constructor'); + + if (!make) throw new Error('expected make'); + if (!model) throw new Error('expected model'); + if (!year) throw new Error ('expected year'); + + this.id = uuidv4(); + this.make = make; + this.model = model; + this.year = year; +}; + +Car.createCar = function(_car) { + debug('createCar'); + + try { + let car = new Car(_car.make, _car.model, _car.year); + return storage.createItem('car', car); + } catch (err) { + return Promise.reject(err); + } +} + +Car.fetchCar = function(id) { + debug('fetchCar'); + return storage.fetchCar('car', id); +} + +Car.updateCar = function(id, _car) { + debug('updateCar'); + + return storage.fetchItem('car', id) + .catch( err => Promise.reject(createError(404, err.message))) + .then( note => { + for (var prop in car) { + if (prop === 'id') continue; + if (_car[prop]) car[prop] = _car[prop]; + } + return storage.createItem('car', car); + }); +}; + +Car.deleteCar = function(id) { + debug('deleteCar'); + return storage.deleteItem('car', id); +}; + +Car.fetchIDs = function() { + debug('fetchIDs'); + return storage.availIDs('car'); +}; diff --git a/lab-sharmarke/package.json b/lab-sharmarke/package.json new file mode 100644 index 0000000..d66b749 --- /dev/null +++ b/lab-sharmarke/package.json @@ -0,0 +1,30 @@ +{ + "name": "lab-sharmarke", + "version": "1.0.0", + "description": "", + "main": "server.js", + "directories": { + "test": "test" + }, + "scripts": { + "test": "DEBUG='note*' ./node_modules/mocha/bin/mocha", + "start": "DEBUG='note*' node server.js" + }, + "keywords": [], + "author": "", + "license": "ISC", + "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/lab-sharmarke/route/car-router.js b/lab-sharmarke/route/car-router.js new file mode 100644 index 0000000..1400e15 --- /dev/null +++ b/lab-sharmarke/route/car-router.js @@ -0,0 +1,41 @@ +'use strict'; + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('car:car-router'); +const Car = require('../model/car.js'); +const carRouter = new Router(); + +carRouter.post('/api/note', jsonParser, function(req, res, next) { + debug('POST: /api/car'); + + Car.createCar(req.body) + .then( car => res.json(car)) + .catch( err => next(err)); +}); + +carRouter.get('/api/car/:id', function(req, res, next) { + debug('GET: /api/car/:id'); + + Car.fetchCar(req.params.id) + .then( car => res.json(car)) + .catch( err => next(err)); +}); + +carRouter.get('/api/car', function(req, res, next) { + debug('GET: /api/car'); + + Car.fetchIDs() + .then( ids => res.json(ids)) + .catch( err => next(err)); +}); + +carRouter.put('/api/car', jsonParser, function(req, res, next) { + debug('POST: /api/car'); + + Car.updateCar(req.quer.id, req.body) + .then( car => res.json(car)) + .catch( err => next(err)); +}); + +module.exports = carRouter; diff --git a/lab-sharmarke/server.js b/lab-sharmarke/server.js new file mode 100644 index 0000000..8e642c7 --- /dev/null +++ b/lab-sharmarke/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')('car:sever'); + +const carRouter = require('./route/car-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(carRouter); +app.use(errors); + +app.listen(PORT, () => { + console.log(`server up: ${PORT}`); +}); diff --git a/lab-sharmarke/test/car-route-test.js b/lab-sharmarke/test/car-route-test.js new file mode 100644 index 0000000..ab0e2ab --- /dev/null +++ b/lab-sharmarke/test/car-route-test.js @@ -0,0 +1,112 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); +const Car = require('../model/car.js'); +const url = 'http://localhost:8000'; + + +require('../server.js'); + +const exampleCar = { + name: 'example name', + make: 'example make', + model: 'example model' +}; + +describe('Car Routes', function() { + + describe('GET: /api/car', function() { + describe('with valid id', function() { + before(done => { + Car.createCar(exampleCar) + .then(car => { + this.tempCar = car; + done(); + }) + .catch( err => done(err)); + }); + + after( done => { + Car.deleteCar(this.tempCar.id) + .then( () => done()) + .catch( err => done(err)); + }); + + it('should return a car', done => { + request.get(`${url}/api/car/${this.tempCar.id}`) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempCar.id); + expect(res.body.name).to.equal(this.tempCar.name); + expect(res.body.make).to.equal(this.tempCar.make); + expect(res.body.model).to.equal(this.tempCar.model); + done(); + }); + }); + }); + }); + + describe('POST: /api/car', function() { + describe('with valid body', function() { + after( done => { + if(this.tempCar) { + Car.deleteCar(this.tempCar.id) + .then( () => done()) + .catch( err => done(err)); + } + }); + + it('should return a car', done => { + request.post(`${url}/api/car`) + .send(exampleCar) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal(exampleCar.name); + expect(res.body.make).to.equal(exampleCar.make); + expect(res.body.model).to.equal(exampleCar.model); + this.tempCar = res.body; + done(); + }); + }); + }); + }); + + describe('PUT: /api/car', function() { + describe('with a valid id and body', function() { + before( done => { + Car.createCar(exampleCar) + .then( car => { + this.tempCar = car; + done(); + }) + .catch( err => done(err)); + }); + + after( done => { + if (this.tempCar) { + Car.deleteCar(this.tempCar.id) + .then( () => done()) + .catch(done); + } + }); + + it('should return a note', done => { + let updateCar = { name: 'example name', make: 'example make', model: 'example model' }; + request.put(`${url}/api/car/${this.tempCar.id}`) + .send(updateCar) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempCar.id); + for (var prop in updateCar) { + expect(res.body[prop]).to.equal(updateCar[prop]); + } + done(); + }); + }); + }); + }); +});