diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000..82ff623 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,5 @@ +**/node_modules/* +**/vendor/* +**/*.min.js +**/coverage/* +**/build/* \ No newline at end of file diff --git a/.eslintrc b/.eslintrc new file mode 100644 index 0000000..b663d77 --- /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" +} \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..393ef53 --- /dev/null +++ b/.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 \ No newline at end of file diff --git a/data/pokemon/1a82315b-7811-4a94-9936-ec7d5af12c69.json b/data/pokemon/1a82315b-7811-4a94-9936-ec7d5af12c69.json new file mode 100644 index 0000000..fd24735 --- /dev/null +++ b/data/pokemon/1a82315b-7811-4a94-9936-ec7d5af12c69.json @@ -0,0 +1 @@ +{"id":"1a82315b-7811-4a94-9936-ec7d5af12c69","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/4cafee4c-1af2-4dca-98a0-3ec446d2372e.json b/data/pokemon/4cafee4c-1af2-4dca-98a0-3ec446d2372e.json new file mode 100644 index 0000000..f54a25b --- /dev/null +++ b/data/pokemon/4cafee4c-1af2-4dca-98a0-3ec446d2372e.json @@ -0,0 +1 @@ +{"id":"4cafee4c-1af2-4dca-98a0-3ec446d2372e","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/4fc89108-7495-4cc7-aefd-d1f82ed965cb.json b/data/pokemon/4fc89108-7495-4cc7-aefd-d1f82ed965cb.json new file mode 100644 index 0000000..7758d45 --- /dev/null +++ b/data/pokemon/4fc89108-7495-4cc7-aefd-d1f82ed965cb.json @@ -0,0 +1 @@ +{"id":"4fc89108-7495-4cc7-aefd-d1f82ed965cb","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/a63009c1-f959-4e42-8d5f-7ff62b8611da.json b/data/pokemon/a63009c1-f959-4e42-8d5f-7ff62b8611da.json new file mode 100644 index 0000000..0e23f76 --- /dev/null +++ b/data/pokemon/a63009c1-f959-4e42-8d5f-7ff62b8611da.json @@ -0,0 +1 @@ +{"id":"a63009c1-f959-4e42-8d5f-7ff62b8611da","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/a8913b8b-9623-4b20-bdd0-16cbe4be208c.json b/data/pokemon/a8913b8b-9623-4b20-bdd0-16cbe4be208c.json new file mode 100644 index 0000000..1c0a4ce --- /dev/null +++ b/data/pokemon/a8913b8b-9623-4b20-bdd0-16cbe4be208c.json @@ -0,0 +1 @@ +{"id":"a8913b8b-9623-4b20-bdd0-16cbe4be208c","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/e3088f0e-b8b6-476a-ae3b-719f05ba0a07.json b/data/pokemon/e3088f0e-b8b6-476a-ae3b-719f05ba0a07.json new file mode 100644 index 0000000..b73220c --- /dev/null +++ b/data/pokemon/e3088f0e-b8b6-476a-ae3b-719f05ba0a07.json @@ -0,0 +1 @@ +{"id":"e3088f0e-b8b6-476a-ae3b-719f05ba0a07","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/e36598ef-33c9-4969-82ee-b0db40ff3828.json b/data/pokemon/e36598ef-33c9-4969-82ee-b0db40ff3828.json new file mode 100644 index 0000000..337005f --- /dev/null +++ b/data/pokemon/e36598ef-33c9-4969-82ee-b0db40ff3828.json @@ -0,0 +1 @@ +{"id":"e36598ef-33c9-4969-82ee-b0db40ff3828","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/ee0b1b9b-bf69-4356-a1bd-f6d8f80f18c4.json b/data/pokemon/ee0b1b9b-bf69-4356-a1bd-f6d8f80f18c4.json new file mode 100644 index 0000000..a3db171 --- /dev/null +++ b/data/pokemon/ee0b1b9b-bf69-4356-a1bd-f6d8f80f18c4.json @@ -0,0 +1 @@ +{"id":"ee0b1b9b-bf69-4356-a1bd-f6d8f80f18c4","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/f7f2eb4a-941a-416b-b092-061f5fbaaa90.json b/data/pokemon/f7f2eb4a-941a-416b-b092-061f5fbaaa90.json new file mode 100644 index 0000000..f975294 --- /dev/null +++ b/data/pokemon/f7f2eb4a-941a-416b-b092-061f5fbaaa90.json @@ -0,0 +1 @@ +{"id":"f7f2eb4a-941a-416b-b092-061f5fbaaa90","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/f95b8987-1454-4e01-a2d5-681b9d160854.json b/data/pokemon/f95b8987-1454-4e01-a2d5-681b9d160854.json new file mode 100644 index 0000000..44cddfe --- /dev/null +++ b/data/pokemon/f95b8987-1454-4e01-a2d5-681b9d160854.json @@ -0,0 +1 @@ +{"id":"f95b8987-1454-4e01-a2d5-681b9d160854","name":"test name","type":"test type","gen":"test gen"} \ No newline at end of file diff --git a/data/pokemon/undefined.json b/data/pokemon/undefined.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/data/pokemon/undefined.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/lib/storage.js b/lib/storage.js new file mode 100644 index 0000000..9ef7c5f --- /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')('pokemon: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(err)); +}; + +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) { + Promise.reject(err); + } + }) + .catch(err => Promise.reject(createError(404, 'file not found'))); +}; + +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 item')); + + return fs.unlinkProm(`${__dirname}/../data/${schemaName}/${id}.json`) + .then( () => { + try { + debug('pokemon has been deleted'); + return; + } catch (err) { + Promise.reject(err); + } + }) + .catch( err => Promise.reject(err)); +}; \ No newline at end of file diff --git a/model/pokemon.js b/model/pokemon.js new file mode 100644 index 0000000..986863c --- /dev/null +++ b/model/pokemon.js @@ -0,0 +1,38 @@ +'use strict'; + +const uuidv4 = require('uuid/v4'); +const createError = require('http-errors'); +const debug = require('debug')('pokemon:pokemon'); +const storage = require('../lib/storage.js'); + +const Pokemon = module.exports = function(name, type, gen) { + if(!name) return Promise.reject(createError(400, 'expected name')); + if(!type) return Promise.reject(createError(400, 'expected type')); + if(!gen) return Promise.reject(createError(400, 'expected gen')); + + this.id = uuidv4(); + this.name = name; + this.type = type; + this.gen = gen; +}; + +Pokemon.createPokemon = function(_pokemon) { + debug('createPokemon'); + + try { + let pokemon = new Pokemon(_pokemon.name, _pokemon.type, _pokemon.gen); + return storage.createItem('pokemon', pokemon); + } catch(err) { + return Promise.reject(err); + } +}; + +Pokemon.fetchPokemon = function(id) { + debug('fetchPokemon'); + return storage.fetchItem('pokemon', id); +}; + +Pokemon.deletePokemon = function(id) { + debug('deletePokemon'); + return storage.deleteItem('pokemon', id); +}; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..bdb1fda --- /dev/null +++ b/package.json @@ -0,0 +1,35 @@ +{ + "name": "11-express-api", + "version": "1.0.0", + "description": "![cf](https://i.imgur.com/7v5ASc8.png) 11: Single Resource Express API ======", + "main": "server.js", + "scripts": { + "test": "DEBUG='pokemon*' mocha", + "start": "DEBUG='pokemon*' node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/Loaye/11-express-api.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/Loaye/11-express-api/issues" + }, + "homepage": "https://github.com/Loaye/11-express-api#readme", + "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.4.2", + "superagent": "^3.5.2" + } +} diff --git a/server.js b/server.js new file mode 100644 index 0000000..4d4e9a2 --- /dev/null +++ b/server.js @@ -0,0 +1,54 @@ +'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')('pokemon:server'); +const Pokemon = require('./model/pokemon.js'); + +const PORT = process.env.PORT || 3000; +const app = express(); + +app.use(morgan('dev')); + +app.get('/api/pokemon', function(req, res, next) { + debug('GET: /api/pokemon'); + + Pokemon.fetchPokemon(req.query.id) + .then( pokemon => res.json(pokemon)) + .catch( err => next(err)); +}); + +app.post('/api/pokemon', jsonParser, function(req, res, next) { + debug('POST: /api/pokemon'); + + Pokemon.createPokemon(req.body) + .then( pokemon => res.json(pokemon) ) + .catch( err => next(err) ); +}); + +app.delete('/api/pokemon', function(req, res, next) { + debug('DELETE: /api/pokemon'); + + Pokemon.deletePokemon(req.query.id) + .then( () => createError(204, 'pokemon deleted') ) + .catch( err => next(err) ); +}); + +app.use(function(err, req, res, next) { + 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); +}); \ No newline at end of file diff --git a/test/pokemon-route-test.js b/test/pokemon-route-test.js new file mode 100644 index 0000000..152f6a1 --- /dev/null +++ b/test/pokemon-route-test.js @@ -0,0 +1,64 @@ +'use strict'; + +const request = require('superagent'); +const expect = require('chai').expect; + +require('../server.js'); + +describe('Pokemon Routes', function() { + var pokemon = null; + + describe('POST: /api/pokemon', function() { + it('should return a pokemon', function(done) { + request.post('localhost:8000/api/pokemon') + .send({name: 'test name', type: 'test type', gen: 'test gen'}) + .end((err, res) => { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('test name'); + expect(res.body.type).to.equal('test type'); + expect(res.body.gen).to.equal('test gen'); + pokemon = res.body; + done(); + }); + }); + + it('POST: should return 400', function(done) { + request.post('localhost:8000/api/pokemon') + .end((err, res) => { + expect(res.status).to.equal(400); + done(); + }); + }); + }); + + describe('GET: /api/pokemon', function() { + it('should return a pokemon', function(done) { + request.get(`localhost:8000/api/pokemon?id=${pokemon.id}`) + .end(function(err, res) { + if(err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('test name'); + expect(res.body.type).to.equal('test type'); + expect(res.body.gen).to.equal('test gen'); + done(); + }); + }); + + it('should return 404', function(done) { + request.get('localhost:8000/api/pokemon?id=12345') + .end((err, res) => { + expect(res.status).to.equal(404); + done(); + }); + }); + + it('GET: should return 400', function(done) { + request.get('localhost:8000/api/pokemon?=123455') + .end(function(err, res) { + expect(res.status).to.equal(400); + done(); + }); + }); + }); +}); \ No newline at end of file