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/README.md b/README.md index 37f3822..ec33b97 100644 --- a/README.md +++ b/README.md @@ -1,27 +1,3 @@ -![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 13: Single Resource Mongo and Express API -=== - -## Submission Instructions - * fork this repository & create a new branch for your work - * write all of your code in a directory named `lab-` + `` **e.g.** `lab-susan` - * 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 - -## Learning Objectives -* students will be able to work with the MongoDB database management system -* students will understand the primary concepts of working with a NoSQL database management system -* students will be able to create custom data models *(schemas)* through the use of mongoose.js -* students will be able to use mongoose.js helper methods for interacting with their database persistence layer - -## Requirements -#### Configuration -* `package.json` -* `.eslintrc` -* `.gitignore` -* `README.md` - * your `README.md` should include detailed instructions on how to use your API #### Feature Tasks * create an HTTP Server using `express` diff --git a/model/bakery.js b/model/bakery.js new file mode 100644 index 0000000..59fa222 --- /dev/null +++ b/model/bakery.js @@ -0,0 +1,11 @@ +'use strict'; + +const mongoose = require('mongoose'); +const Schema = mongoose.Schema; + +const bakerySchema = Schema({ + name: { type: String, required: true }, + timestamp: { type: Date, required: true } +}); + +module.exports = mongoose.model('bakery', bakerySchema); \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..5bbffa1 --- /dev/null +++ b/package.json @@ -0,0 +1,38 @@ +{ + "name": "13-mongodb", + "version": "1.0.0", + "description": "![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) 13: Single Resource Mongo and Express API ===", + "main": "server.js", + "directories": { + "test": "test" + }, + "scripts": { + "test": "DEBUG='bakery*' mocha", + "start": "DEBUG='bakery*' node server.js" + }, + "repository": { + "type": "git", + "url": "git+https://github.com/ohjonah/13-mongodb.git" + }, + "keywords": [], + "author": "", + "license": "ISC", + "bugs": { + "url": "https://github.com/ohjonah/13-mongodb/issues" + }, + "homepage": "https://github.com/ohjonah/13-mongodb#readme", + "dependencies": { + "bluebird": "^3.5.0", + "body-parser": "^1.17.2", + "cors": "^2.8.4", + "debug": "^2.6.8", + "express": "^4.15.3", + "mongoose": "^4.11.5", + "morgan": "^1.8.2" + }, + "devDependencies": { + "chai": "^4.1.0", + "mocha": "^3.5.0", + "superagent": "^3.5.2" + } +} diff --git a/route/bakery-route.js b/route/bakery-route.js new file mode 100644 index 0000000..336feb1 --- /dev/null +++ b/route/bakery-route.js @@ -0,0 +1,40 @@ +'use strict'; + +const Router = require('express').Router; +const jsonParser = require('body-parser').json(); +const debug = require('debug')('bakery:bakery-router'); +const Bakery = require('../model/bakery.js'); +const bakeryRouter = module.exports = new Router(); + +bakeryRouter.post('/api/bakery', jsonParser, function(req, res, next) { + debug('POST: /api/bakery'); + + req.body.timestamp = new Date(); + new Bakery(req.body).save() + .then( bakery => res.json(bakery)) + .catch(next); +}); + +bakeryRouter.get('/api/bakery/:id', function(req, res, next) { + debug('GET: /api/bakery'); + + Bakery.findById(req.params.id) + .then( bakery => res.json(bakery)) + .catch(next); +}); + +bakeryRouter.put('/api/bakery/:id', function(req, res, next) { + debug('PUT: /api/bakery'); + + Bakery.findByIdAndUpdate(req.params.id) + .then( bakery => res.json(bakery)) + .catch(next); +}); + +bakeryRouter.delete('/api/bakery/:id', function(req, res, next) { + debug('DELETE: /api/bakery'); + + Bakery.findByIdAndRemove(req.params.id) + .then( bakery => res.status(204).send(bakery)) + .catch(next); +}); \ No newline at end of file diff --git a/server.js b/server.js new file mode 100644 index 0000000..a3afec4 --- /dev/null +++ b/server.js @@ -0,0 +1,30 @@ +'use strict'; + +const express = require('express'); +const morgan = require('morgan'); +const cors = require('cors'); +const Promise = require('bluebird'); +const mongoose = require('mongoose'); +const debug = require('debug')('bakery:server'); + +const bakeryRouter = require('./route/bakery-route.js'); + +const app = express(); +const PORT = process.env.PORT || 3000; +const MONGODB_URI = 'mongodb://localhost/bakery'; + +mongoose.Promise = global.Promise; +mongoose.connect(MONGODB_URI, { + useMongoClient: true +}); + +app.use(cors()); +app.use(morgan('dev')); +app.use(bakeryRouter); + +app.listen(PORT, () => { + debug(`Server on PORT: ${PORT}`); +}); + + + diff --git a/test/bakery-test.js b/test/bakery-test.js new file mode 100644 index 0000000..bb99080 --- /dev/null +++ b/test/bakery-test.js @@ -0,0 +1,153 @@ +'use strict'; + +const expect = require('chai').expect; +const request = require('superagent'); +const Bakery = require('../model/bakery.js'); +const PORT = process.env.PORT || 3000; + +require('../server.js'); + +const url = `http://localhost:${PORT}`; + +const exampleBakery = { + name: 'test bakery name' +}; + +describe('Bakery Routes', function() { + describe('POST: /api/bakery', function() { + describe('with a valid req body', function() { + + after( done => { + if (this.tempBakery) { + Bakery.remove({}) + .then( () => done()) + .catch(done); + return; + } + done(); + }); + + it('should return a list', done => { + request.post(`${url}/api/bakery`) + .send(exampleBakery) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('test bakery name'); + this.tempBakery = res.body; + done(); + }); + }); + }); + }); + + describe('GET: /api/bakery/:id', function() { + describe('with a valid body', function() { + + before( done => { + exampleBakery.timestamp = new Date(); + new Bakery(exampleBakery).save() + .then( bakery => { + this.tempBakery = bakery; + done(); + }) + .catch(done); + }); + + after( done => { + delete exampleBakery.timestamp; + if (this.tempBakery) { + Bakery.remove({}) + .then( () => done()) + .catch(done); + return; + } + done(); + }); + + it('should return a bakery', done => { + request.get(`${url}/api/bakery/${this.tempBakery._id}`) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + expect(res.body.name).to.equal('test bakery name'); + done(); + }); + }); + }); + + describe('with an invalid id', function() { + it('should return a 404', function() { + request.get(`${url}/api/bakery`) + .end((err, res) => { + expect(res.status).to.equal(404); + }); + }); + }); + }); + + describe('PUT: /api/bakery/:id', function() { + before( done => { + exampleBakery.timestamp = new Date(); + new Bakery(exampleBakery).save() + .then( bakery => { + this.tempBakery = bakery; + done(); + }) + .catch(done); + }); + + after( done => { + delete exampleBakery.timestamp; + if (this.tempBakery) { + Bakery.remove({}) + .then( () => done()) + .catch(done); + return; + } + done(); + }); + + it('should update a bakery', done => { + request.put(`${url}/api/bakery/${this.tempBakery._id}`) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(200); + done(); + }); + }); + + it('should return a 404', done => { + request.put(`${url}/api/bakery`) + .end((err, res) => { + console.log('res:', res); + expect(res.status).to.equal(404); + done(); + }); + }); + }); + + describe('DELETE: /api/bakery/:id', function() { + describe('with a valid id', function() { + + before( done => { + exampleBakery.timestamp = new Date(); + new Bakery(exampleBakery).save() + .then( bakery => { + this.tempBakery = bakery; + done(); + }) + .catch(done); + }); + + it('should delete a bakery', done => { + request.delete(`${url}/api/bakery/${this.tempBakery._id}`) + .end((err, res) => { + if (err) return done(err); + expect(res.status).to.equal(204); + done(); + }); + }); + }); + }); +}); \ No newline at end of file