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..0992345 --- /dev/null +++ b/.gitignore @@ -0,0 +1,117 @@ +# Created by https://www.gitignore.io/api/node,vim,osx,macos,linux + +*node_modules + +### Node ### +# 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-v][a-z] +[._]*.sw[a-p] +[._]s[a-v][a-z] +[._]sw[a-p] +# session +Session.vim +# temporary +.netrwhist +*~ +# auto-generated tag files +tags + + +### OSX ### +*.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 + + +### macOS ### +# Icon must end with two \r +# Thumbnails +# Files that might appear in the root of a volume +# Directories potentially created on remote AFP share + + +### 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* + +# End of https://www.gitignore.io/api/node,vim,osx,macos,linux diff --git a/.gulpfile.js b/.gulpfile.js new file mode 100644 index 0000000..e394a1a --- /dev/null +++ b/.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:'nyan'})); +}); + +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', 'test']); +}); + +gulp.task('default', ['dev']); diff --git a/lib/storage.js b/lib/storage.js new file mode 100644 index 0000000..137379f --- /dev/null +++ b/lib/storage.js @@ -0,0 +1,48 @@ +'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(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'); + console.log('in fetch item : ', schemaName, id) + 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) { + return new Promise((resolve, reject) => { + if(!schemaName) return Promise.reject(createError(400, 'expected schema name')); + if(!id) return Promise.reject(createError(400, 'expected id')); + fs.unlink(`${__dirname}/../data/${schemaName}/${id}.json`, function(e){ + if(e) console.log(e); + if(e) return reject(e); + resolve(); + }); + }); +}; diff --git a/model/rwby.js b/model/rwby.js new file mode 100644 index 0000000..3531e0d --- /dev/null +++ b/model/rwby.js @@ -0,0 +1,37 @@ +'use strict'; + +const uuid = require('node-uuid'); +const createError = require('http-errors'); +const debug = require('debug')('rwby:rwby'); +const storage = require('../lib/storage.js'); + +const Rwby = module.exports = function(name, weapon){ //eslint-disable-line + debug('rwby constructor'); + + if(!name) throw createError(400, 'expected name'); + if(!weapon) throw createError(400, 'expected weapon'); + this.id = uuid.v1(); + this.name = name; + this.weapon = weapon; +}; + +Rwby.createRwby = function(_rwby) { + debug('createRwby'); + + try{ + let rwby = new Rwby(_rwby.name, _rwby.weapon); + return storage.createItem('rwby', rwby); + } catch (err) { + return Promise.reject(err); + } +}; + +Rwby.fetchRwby = function(id){ + debug('fetchRwby'); + return storage.fetchItem('rwby', id); +}; + +Rwby.deleteRwby = function(schemaName, id){ + debug('deleteRwby'); + return storage.deleteItem(schemaName, id); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..134ca53 --- /dev/null +++ b/package.json @@ -0,0 +1,37 @@ +{ + "name": "11-single_resource_express_api", + "version": "1.0.0", + "description": "![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) Lab 11: Single Resource Express API ===", + "main": "index.js", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/brials/11-single_resource_express_api.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/brials/11-single_resource_express_api/issues" + }, + "homepage": "https://github.com/brials/11-single_resource_express_api#readme", + "dependencies": { + "bluebird": "^3.4.7", + "body-parser": "^1.16.1", + "debug": "^2.6.1", + "express": "^4.14.1", + "http-errors": "^1.6.1", + "morgan": "^1.8.1", + "node-uuid": "^1.4.7" + }, + "devDependencies": { + "chai": "^3.5.0", + "gulp": "^3.9.1", + "gulp-eslint": "^3.0.1", + "gulp-mocha": "^4.0.1", + "mocha": "^3.2.0", + "superagent": "^3.5.0" + } +} diff --git a/server.js b/server.js new file mode 100644 index 0000000..13cab80 --- /dev/null +++ b/server.js @@ -0,0 +1,57 @@ +'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')('rwby:server'); + +const Rwby = require('./model/rwby.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: 'test route worked'}); +}); + +app.post('/api/rwby', jsonParser, (req, res, next) => { + debug('POST: /api/rwby'); + Rwby.createRwby(req.body) + .then( rwby => res.json(rwby)) + .catch( err => next(err)); +}); + +app.get('/api/rwby/:id', function(req, res, next){ + debug('Get: /api/rwby/:id'); + console.log(' in get in server', req.params.id); + Rwby.fetchRwby(req.params.id) + .then(rwby => res.json(rwby)) + .catch(err => next(err)); +}); + +app.delete('/api/delete/:schemaName/:id', function(req, res, next){ + debug('Delete: /api/delete/:schemaName/:id'); + Rwby.deleteRwby(req.params.schemaName, req.params.id) + .then( () =>console.log(`Rwby of id ${req.params.id}, has been deleted`)) + .catch( err => next(err)); +}); + +app.use(function(err, req, res, next){ //eslint-disable-line + debug('error middleware'); + console.error(err.message); + + if(err.status) { + res.status(err.status).send(err.name); + return; + } + err = createError(500, err.message); + res.status(err.status).send(err.name); +}); + +app.listen(PORT, () => { + debug(`server up: ${PORT}`); +}); diff --git a/test/rwby-test.js b/test/rwby-test.js new file mode 100644 index 0000000..e44790f --- /dev/null +++ b/test/rwby-test.js @@ -0,0 +1,74 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); + +require('../server.js'); + +describe('RWBY Routes', function(){ + var rwby = null; + describe('Post: /api/rwby', function(){ + it('should post a new item', function(done){ + request.post('localhost:3000/api/rwby') + .send({name: 'Ruby Rose', weapon: 'Scythe'}) + .end((err, res) => { + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('Ruby Rose'); + expect(res.body.weapon).to.equal('Scythe'); + rwby = res.body; + done(); + }); + }); + }); + describe('Post: /api/rwby', function(){ + it('should post a new item', function(done){ + request.post('localhost:3000/api/rwby') + .send() + .end((err, res) => { + expect(res.status).to.equal(400); + done(); + }); + }); + }); + describe('Get: /api/rwby/id', function(){ + it('should retrieve an item', function(done){ + request.get(`localhost:3000/api/rwby/${rwby.id}`) + .end((err, res) =>{ + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(rwby.id); + expect(res.body.name).to.equal('Ruby Rose'); + expect(res.body.weapon).to.equal('Scythe'); + done(); + }); + }); + }); + describe('Get: /api/rwby/12345', function(){ + it('should respond with not found', function(done){ + request.get('localhost:3000/api/rwby/12345') + .end((err, res) =>{ + expect(res.status).to.equal(404); + expect(res.body.id).to.equal(undefined); + done(); + }); + }); + }); + describe('Get: /api/rwby', function(){ + it('should respond with a bad request', function(done){ + request.get('localhost:3000/api/rwby') + .end((err, res) =>{ + expect(res.status).to.equal(400); + expect(res.body.id).to.equal(undefined); + done(); + }); + }); + }); + describe('Delete: /api/rwby', function(){ + it('should delete an item', function(done){ + request.delete(`localhost:3000/api/delete/rwby/${rwby.id}`) + .end((err, res) =>{ + expect(res.status).to.equal(204); + done(); + }); + }); + }); +});