diff --git a/lab-shawn/.eslintrc b/lab-shawn/.eslintrc new file mode 100644 index 0000000..8dc6807 --- /dev/null +++ b/lab-shawn/.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-shawn/.gitignore b/lab-shawn/.gitignore new file mode 100644 index 0000000..96bb76c --- /dev/null +++ b/lab-shawn/.gitignore @@ -0,0 +1,127 @@ +Created by https://www.gitignore.io/api/macos,node,vim,windows,linux + +out.bmp +### 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 ### +node_modules +# Logs +logs +*.log +npm-debug.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 + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules +jspm_packages + +# 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 + + + +### Vim ### +# swap +[._]*.s[a-w][a-z] +[._]s[a-w][a-z] +# session +Session.vim +# temporary +.netrwhist +*~ +# auto-generated tag files +tags + + +### Windows ### +# Windows image file caches +Thumbs.db +ehthumbs.db + +# Folder config file +Desktop.ini + +# Recycle Bin used on file shares +$RECYCLE.BIN/ + +# Windows Installer files +*.cab +*.msi +*.msm +*.msp + +# Windows shortcuts +*.lnk + + +### Linux ### + +# temporary files which can be created if a process still has a handle open of a deleted file +.fuse_hidden* + +# KDE directory preferences +.directory + +# Linux trash folder which might appear on any partition or disk +.Trash-* + +# .nfs files are created when an open file is removed but is still being accessed +.nfs* diff --git a/lab-shawn/README.md b/lab-shawn/README.md new file mode 100644 index 0000000..d764589 --- /dev/null +++ b/lab-shawn/README.md @@ -0,0 +1,36 @@ +# **Vanilla HTTP RESTful API** + +## **Overview** + + This application is a HTTP RESTful API written in vanilla JavaScript. It utilizes the GET, POST, & DELETE methods to fetch, add, and remove files in a file system. + +## **How To Use API** + * Clone this repository + * Open a terminal and run `npm i` to install all the application dependencies + + #### Dependencies + * bluebird 3.4.6 + * node-uuid 1.4.7 + + #### Dev dependencies + * chai 3.5.0 + * gulp 3.9.1 + * gulp-eslint 3.0.1 + * gulp-mocha 3.0.1 + * mocha 3.2.0 + * superagent 3.3.0 + + +### **Run your server** + `node server.js` + +In a new terminal window/tab run your HTTP method commands + +### **POST Request** + `http POST localhost:[port number] name='[name]' gender='[gender]'` + +### **GET Request** + `http GET localhost:[port number]?id='[id]'` + +### **DELETE Request** + `http DELETE localhost:[port number]?id='[id]'` diff --git a/lab-shawn/data/person/00b17950-c35b-11e6-91c0-2f447f841b80.json b/lab-shawn/data/person/00b17950-c35b-11e6-91c0-2f447f841b80.json new file mode 100644 index 0000000..ac3e322 --- /dev/null +++ b/lab-shawn/data/person/00b17950-c35b-11e6-91c0-2f447f841b80.json @@ -0,0 +1 @@ +{"id":"00b17950-c35b-11e6-91c0-2f447f841b80","name":"test name","gender":"male"} \ No newline at end of file diff --git a/lab-shawn/data/person/282e3b50-c34f-11e6-a8f1-49626432423e.json b/lab-shawn/data/person/282e3b50-c34f-11e6-a8f1-49626432423e.json new file mode 100644 index 0000000..7f0e110 --- /dev/null +++ b/lab-shawn/data/person/282e3b50-c34f-11e6-a8f1-49626432423e.json @@ -0,0 +1 @@ +{"id":"282e3b50-c34f-11e6-a8f1-49626432423e","name":"test name","gender":"male"} \ No newline at end of file diff --git a/lab-shawn/gulpfile.js b/lab-shawn/gulpfile.js new file mode 100644 index 0000000..45a1a50 --- /dev/null +++ b/lab-shawn/gulpfile.js @@ -0,0 +1,23 @@ +'use strict'; + +const gulp = require('gulp'); +const eslint = require('gulp-eslint'); +const mocha = require('gulp-mocha'); + +gulp.task('test', function(){ + gulp.src('./test/*-*-test.js', {read: false}) + .pipe(mocha({reporter: 'spec'})); +}); + +gulp.task('lint', function(){ + return gulp.src(['**/*.js', '!node_modules']) + .pipe(eslint()) + .pipe(eslint.format()) + .pipe(eslint.failAfterError()); +}); + +gulp.task('dev', function(){ + gulp.watch(['**/*.js', '!node_modules'],['lint']); +}); + +gulp.task('default',['dev']); diff --git a/lab-shawn/lib/parse-json.js b/lab-shawn/lib/parse-json.js new file mode 100644 index 0000000..26d4fcc --- /dev/null +++ b/lab-shawn/lib/parse-json.js @@ -0,0 +1,25 @@ +'use strict'; + +module.exports = function(req){ + return new Promise((resolve,reject) => { + if(req.method === 'POST' || req.method === 'PUT'){ + var body = ''; + + req.on('data',data => { + body += data.toString(); + }); + + req.on('end', () =>{ + try{ + req.body = JSON.parse(body); + resolve(req); + }catch(err){ + console.error(err); + reject(err); + } + }); + return; + } + resolve(); + }); +}; diff --git a/lab-shawn/lib/parse-url.js b/lab-shawn/lib/parse-url.js new file mode 100644 index 0000000..f9c85e5 --- /dev/null +++ b/lab-shawn/lib/parse-url.js @@ -0,0 +1,10 @@ +'use strict'; + +const parseUrl = require('url').parse; +const parseQuery = require('querystring').parse; + +module.exports = function(req){ + req.url = parseUrl(req.url); + req.url.query = parseQuery(req.url.query); + return Promise.resolve(req); +}; diff --git a/lab-shawn/lib/response.js b/lab-shawn/lib/response.js new file mode 100644 index 0000000..6a69540 --- /dev/null +++ b/lab-shawn/lib/response.js @@ -0,0 +1,19 @@ +'use strict'; + +module.exports = exports = {}; + +exports.sendJSON = function(res,status,data){ + res.writeHead(status,{ + 'Content-Type':'application/json' + }); + res.write(JSON.stringify(data)); + res.end(); +}; + +exports.sendText = function(res,status,msg){ + res.writeHead(status,{ + 'Content-Type':'text/plain' + }); + res.write(msg); + res.end(); +}; diff --git a/lab-shawn/lib/router.js b/lab-shawn/lib/router.js new file mode 100644 index 0000000..fe03588 --- /dev/null +++ b/lab-shawn/lib/router.js @@ -0,0 +1,51 @@ +'use strict'; + +const parseUrl = require('./parse-url.js'); +const parseJSON = require('./parse-json.js'); + +const Router = module.exports = function(){ + this.routes = { + GET: {}, + POST: {}, + PUT: {}, + DELETE: {} + }; +}; + +Router.prototype.get = function(endpoint,callback){ + this.routes.GET[endpoint] = callback; +}; + +Router.prototype.post = function(endpoint,callback){ + this.routes.POST[endpoint] = callback; +}; + +Router.prototype.put = function(endpoint,callback){ + this.routes.PUT[endpoint] = callback; +}; + +Router.prototype.delete = function(endpoint,callback){ + this.routes.DELETE[endpoint] = callback; +}; + +Router.prototype.route = function(){ + return (req,res) => { + Promise.all([ + parseUrl(req), + parseJSON(req) + ]) + .then( () => { + if(typeof this.routes[req.method][req.url.pathname] === 'function'){ + this.routes[req.method][req.url.pathname](req,res); + return; + } + + console.error('route not found'); + res.sendText(res,404,'route not found'); + }) + .catch(err => { + console.error(err); + res.sendText(res,400,'bad request'); + }); + }; +}; diff --git a/lab-shawn/lib/storage.js b/lab-shawn/lib/storage.js new file mode 100644 index 0000000..df4dfed --- /dev/null +++ b/lab-shawn/lib/storage.js @@ -0,0 +1,37 @@ +'use strict'; + +const Promise = require('bluebird'); +const fs = Promise.promisifyAll(require('fs'),{suffix: 'Prom'}); + +module.exports = exports = {}; + +exports.createPerson = function(schemaName, person){ + if(!schemaName) return Promise.reject(new Error('expected schema name')); + if(!person) return Promise.reject(new Error('expected a person')); + + let json = JSON.stringify(person); + return fs.writeFileProm(`${__dirname}/../data/${schemaName}/${person.id}.json`,json) + .then( () => person ) + .catch( err => Promise.reject(err)); +}; + +exports.fetchPerson = function(schemaName,id){ + if(!schemaName) return Promise.reject(new Error('expected schema name')); + if(!id) return Promise.reject(new Error('expected an id')); + + return fs.readFileProm(`${__dirname}/../data/${schemaName}/${id}.json`) + .then( data => { + let person = JSON.parse(data.toString()); + return person; + }) + .catch(err => Promise.reject(err)); +}; + +exports.deletePerson = function(schemaName,id){ + if(!schemaName) return Promise.reject(new Error('expected schema name')); + if(!id) return Promise.reject(new Error('expected id')); + + return fs.unlinkProm(`${__dirname}/../data/${schemaName}/${id}.json`) + .catch(err => Promise.reject(err)); + +}; diff --git a/lab-shawn/model/person.js b/lab-shawn/model/person.js new file mode 100644 index 0000000..95220b0 --- /dev/null +++ b/lab-shawn/model/person.js @@ -0,0 +1,12 @@ +'use strict'; + +const uuid = require('node-uuid'); + +module.exports = function(name, gender){ + if(!name) throw new Error('expected name'); + if(!gender) throw new Error('expected gender'); + + this.id = uuid.v1(); + this.name = name; + this.gender = gender; +}; diff --git a/lab-shawn/package.json b/lab-shawn/package.json new file mode 100644 index 0000000..11fb171 --- /dev/null +++ b/lab-shawn/package.json @@ -0,0 +1,28 @@ +{ + "name": "lab-shawn", + "version": "1.0.0", + "description": "", + "main": "server.js", + "directories": { + "test": "test" + }, + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1", + "start": "node server.js" + }, + "keywords": [], + "author": "", + "license": "ISC", + "dependencies": { + "bluebird": "^3.4.6", + "node-uuid": "^1.4.7" + }, + "devDependencies": { + "chai": "^3.5.0", + "gulp": "^3.9.1", + "gulp-eslint": "^3.0.1", + "gulp-mocha": "^3.0.1", + "mocha": "^3.2.0", + "superagent": "^3.3.0" + } +} diff --git a/lab-shawn/route/person-route.js b/lab-shawn/route/person-route.js new file mode 100644 index 0000000..15d9371 --- /dev/null +++ b/lab-shawn/route/person-route.js @@ -0,0 +1,46 @@ +'use strict'; + +const storage = require('../lib/storage.js'); +const Person = require('../model/person.js'); +const response = require('../lib/response.js'); + +module.exports = function(router){ + router.get('/api/person', function(req,res){ + if(req.url.query.id){ + storage.fetchPerson('person',req.url.query.id) + .then( person => { + response.sendJSON(res,200,person); + }) + .catch(err => { + console.error(err); + response.sendText(res,404,'person not found'); + }); + return; + } + response.sendText(res,400,'bad request'); + }); + + router.post('/api/person',function(req,res){ + try{ + var person = new Person(req.body.name,req.body.gender); + storage.createPerson('person',person); + response.sendJSON(res,200,person); + }catch(err){ + console.error(err); + response.sendText(res,400,'bad request'); + } + }); + + router.delete('/api/person', function(req,res){ + if(req.url.query.id){ + storage.deletePerson('person',req.url.query.id) + .then( ()=> { + response.sendJSON(res,204,'person removed'); + }) + .catch(err => { + console.error(err); + response.sendText(res,404,'person not found'); + }); + } + }); +}; diff --git a/lab-shawn/server.js b/lab-shawn/server.js new file mode 100644 index 0000000..8c23783 --- /dev/null +++ b/lab-shawn/server.js @@ -0,0 +1,14 @@ +'use strict'; + +const http = require('http'); +const Router = require('./lib/router.js'); +const PORT = process.env.PORT || 3000; +const router = new Router(); + +require('./route/person-route.js')(router); + +const server = http.createServer(router.route()); + +server.listen(PORT, () => { + console.log('Served On:', PORT); +}); diff --git a/lab-shawn/test/person-route-test.js b/lab-shawn/test/person-route-test.js new file mode 100644 index 0000000..34c6777 --- /dev/null +++ b/lab-shawn/test/person-route-test.js @@ -0,0 +1,59 @@ +'use strict'; + +const request = require('superagent'); +const expect = require('chai').expect; +const PORT = process.env.PORT || 3000; + + +require('../server.js'); + +describe('Person Routes', function(){ + var person = null; + + describe('POST: /api/person', function(){ + it('should return a person', function(done){ + request.post(`localhost:${PORT}/api/person`) + .send({name:'test name', gender:'male'}) + .end((err,res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + person = res.body; + done(); + }); + }); + it('should return bad request', function(done){ + request.post(`localhost:${PORT}/api/person`) + .send({name:'test name'}) + .end((err) => { + expect(err.status).to.equal(400); + done(); + }); + }); + }); + + describe('GET: /api/person', function(){ + it('should return with person', function(done){ + request.get(`localhost:${PORT}/api/person?id=${person.id}`) + .end((err,res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + person = res.body; + done(); + }); + }); + it('should return not found', function(done){ + request.get(`localhost:${PORT}/api/person?id=123`) + .end((err) => { + expect(err.status).to.equal(404); + done(); + }); + }); + it('should return bad request', function(done){ + request.get(`localhost:${PORT}/api/person`) + .end((err) => { + expect(err.status).to.equal(400); + done(); + }); + }); + }); +});