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..989f200 --- /dev/null +++ b/.gitignore @@ -0,0 +1,120 @@ +# Created by https://www.gitignore.io/api/node,vim,osx,macos,linux + +*node_modules + +#ignore data files +data/ + +### 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/README.md b/README.md index efca449..592c2a2 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,27 @@ -![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) Lab 12: Single Resource Express API -=== -## To Submit this Assignment - * Fork this repository - * Write all of your code in a directory named `lab-` + `` **e.g.** `lab-brian` - * 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 +![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) Lab 12: Single Resource Express API +=== +## The build out of this API: +- Created a HTTP server using express +- Created an object constructor which then creates a simple resource with three properties +- 1. id +- 2. author +- 3. entry +- Created a single resource `express` API that can handle **GET**, **POST**, and **PUT** requests +- Used the `http-errors` module to create new errors and associate them with a proper status code +- Created an `error-middleware` module to handle errors and *use* it in your server file +- Created a `cors-middleware` module that will allow for public use of your API +- Created a storage module that stores resources by their schema type +- Created 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`) +- Created a series of `note-route-tests` to test your **GET**, **POST**, and **PUT** routes -## Include - * `package.json` - * `.eslintrc` - * `gulpfile.js` - * `.gitignore` - * `README.md` +## Server Endpoints + ### '/api/journal' + - POST Request + - PUT Request + - GET Request + - DELETE Request -## Description - * 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* +## Tests +-Wrote tests to ensure the /api/journal endpoint responds as described for each condition below: diff --git a/gulpfile.js b/gulpfile.js new file mode 100644 index 0000000..032c482 --- /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: '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', 'test']); +}); + +gulp.task('default', ['dev']); 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..63a0a60 --- /dev/null +++ b/lib/error-middleware.js @@ -0,0 +1,21 @@ +'use strict'; + +const createError = require('http-errors'); +const debug = require('debug')('journal: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..30feecc --- /dev/null +++ b/lib/storage.js @@ -0,0 +1,55 @@ +'use strict'; + +const Promise = require('bluebird'); +const fs = Promise.promisifyAll(require('fs'), {suffix: 'Prom'}); +const createError = require('http-errors'); +const debug = require('debug')('journal: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) { + 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/journal.js b/model/journal.js new file mode 100644 index 0000000..9968294 --- /dev/null +++ b/model/journal.js @@ -0,0 +1,57 @@ +'use strict'; + +const uuid = require('node-uuid'); +const createError = require('http-errors'); +const debug = require('debug')('journal:journal'); +const storage = require('../lib/storage.js'); + +const Journal = module.exports = function(author, entry) { + debug('journal constructor'); + + if(!author) throw createError(400, 'expected author'); + if (!entry) throw createError(400, 'expected entry'); + + this.id = uuid.v1(); + this.author = author; + this.entry = entry; +}; + +Journal.createJournal = function(_journal){ + debug('createJournal'); + + try { + let journal = new Journal(_journal.author, _journal.entry); + return storage.createItem('journal', journal); + } catch (err) { + return Promise.reject(err); + } +}; + +Journal.fetchJournal = function(id) { + debug('fetchJournal'); + return storage.fetchItem('journal', id); +}; + +Journal.updateJournal = function(id, _journal) { + debug('updateJournal'); + + return storage.fetchItem('journal', id) + .catch( err => Promise.reject(createError(404, err.message))) + .then( journal => { + for(var prop in journal) { + if(prop === 'id') continue; + if(_journal[prop]) journal[prop] = _journal[prop]; + } + return storage.createItem('journal', journal); + }); +}; + +Journal.deleteJournal = function(id) { + debug('deleteJournal'); + return storage.deleteItem('journal', id); +}; + +Journal.fetchIDs = function() { + debug('fetchIDs'); + return storage.availIDs('journal'); +}; diff --git a/package.json b/package.json new file mode 100644 index 0000000..b1d6c64 --- /dev/null +++ b/package.json @@ -0,0 +1,39 @@ +{ + "name": "12-express_middleware", + "version": "1.0.0", + "description": "![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) Lab 12: Single Resource Express API ===", + "main": "gulpfile.js", + "directories": { + "test": "test" + }, + "scripts": { + "test": "DEBUG='journal*' ./node_modules/mocha/bin/mocha", + "start": "DEBUG='journal*' node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/caylazabel/12-express_middleware.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/caylazabel/12-express_middleware/issues" + }, + "homepage": "https://github.com/caylazabel/12-express_middleware#readme", + "dependencies": { + "bluebird": "^3.4.7", + "body-parser": "^1.16.1", + "debug": "^2.6.1", + "express": "^4.14.1", + "http-errors": "^1.6.1", + "mkdirp": "^0.5.1", + "morgan": "^1.8.1", + "node-uuid": "^1.4.7" + }, + "devDependencies": { + "chai": "^3.5.0", + "mocha": "^3.2.0", + "superagent": "^3.5.0" + } +} diff --git a/route/journal-route.js b/route/journal-route.js new file mode 100644 index 0000000..496c51f --- /dev/null +++ b/route/journal-route.js @@ -0,0 +1,42 @@ +'use strict'; + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('journal:journal-router'); +const Journal = require('../model/journal.js'); +const journalRouter = new Router(); + +journalRouter.post('/api/journal', jsonParser, function(req, res, next){ + debug('POST: /api/journal'); + + Journal.createJournal(req.body) + .then( journal => res.json(journal)) + .catch( err => next(err)); +}); + +journalRouter.get('/api/journal/:id', function(req, res, next) { + debug('GET: /api/journal/:id'); + + Journal.fetchJournal(req.params.id) + .then( journal => res.json(journal)) + .catch( err => next(err)); +}); + +journalRouter.put('/api/journal', jsonParser, function(req, res, next){ + debug('PUT: /api/journal'); + + Journal.updateJournal(req.query.id, req.body) + .then(journal => res.json(journal)) + .catch(next); +}); + +journalRouter.delete('/api/journal/:id', function( req, res, next){ + debug('DELETE: /api/journal/:id'); + + Journal.deleteJournal(req.params.id) + .then(res.status(204).send('no content')) + .catch( err => next(err)); +}); + + +module.exports = journalRouter; diff --git a/server.js b/server.js new file mode 100644 index 0000000..d78c5f2 --- /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')('journal:server'); + +const journalRouter = require('./route/journal-route.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(journalRouter); +app.use(errors); + +app.listen(PORT, () => { + debug(`server up: ${PORT}`); +}); diff --git a/test/journal-route-test.js b/test/journal-route-test.js new file mode 100644 index 0000000..5c343fa --- /dev/null +++ b/test/journal-route-test.js @@ -0,0 +1,113 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); +const Journal = require('../model/journal.js'); +const url = 'http://localhost:3000'; + +require('../server.js'); + +const exampleJournal = { + author: 'example author', + entry: 'example entry' +}; + +describe('Journal Routes', function(){ + describe('GET: /api/journal', function(){ + before( done => { + Journal.createJournal(exampleJournal) + .then( journal => { + this.tempJournal = journal; + done(); + }) + .catch( err => done(err)); + }); + after ( done => { + Journal.deleteJournal(this.tempJournal.id) + .then( () => done()) + .catch( err => done(err)); + }); + + it('should return a journal', done => { + request.get(`${url}/api/journal/${this.tempJournal.id}`) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempJournal.id); + expect(res.body.author).to.equal(this.tempJournal.author); + expect(res.body.entry).to.equal(this.tempJournal.entry); + done(); + }); + }); + + describe('with an invalid id', function() { + it('should respond witha a 404 status code', done => { + request.get(`${url}/journal/123456789`) + .end((err, res) => { + expect(res.status).to.equal(404); + done(); + }); + }); + }); + }); + + describe('POST: /api/journal', function() { + describe('with a valid body', function(){ + after( done => { + if (this.tempJournal) { + Journal.deleteJournal(this.tempJournal.id) + .then( () => done()) + .catch( err => done(err)); + } + }); + + it('should return a journal', done => { + request.post(`${url}/api/journal`) + .send(exampleJournal) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.author).to.equal(exampleJournal.author); + expect(res.body.entry).to.equal(exampleJournal.entry); + this.tempJournal = res.body; + done(); + }); + }); + }); + }); + + describe('PUT: /api/journal/', function(){ + describe('with a valid id and body', function(){ + before( done => { + Journal.createJournal(exampleJournal) + .then( journal => { + this.tempJournal = journal; + done(); + }) + .catch( err => done(err)); + }); + after( done => { + if(this.tempJournal) { + Journal.deleteJournal(this.tempJournal.id) + .then( () => done()) + .catch(done); + } + }); + + it('should return a journal', done => { + let updateJournal = { author: 'new author', entry: 'new entry' }; + request.put(`${url}/api/journal?id=${this.tempJournal.id}`) + .send(updateJournal) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.id).to.equal(this.tempJournal.id); + for (var prop in updateJournal) { + expect(res.body[prop]).to.equal(updateJournal[prop]); + } + done(); + }); + }); + }); + }); +});