lab-shiv

lab-shiv/.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"
+}

lab-shiv/.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

lab-shiv/README.md

@@ -0,0 +1,28 @@
+![CF](https://camo.githubuserpurpose.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-` + `<your name>` **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
+
+## Include
+  * `package.json`
+  * `.eslintrc`
+  * `gulpfile.js`
+  * `.gitignore`
+  * `README.md`
+
+## 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 `updateLeader`, `fetchLeader`, and `fetchIDs` static methods as part of your `leader` model
+  * Create a series of `leader-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 leader and delete the leader after the test has completed*

lab-shiv/gulpfile.js

@@ -0,0 +1,19 @@
+'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('default', ['test', 'lint']);

lab-shiv/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();
+};

lab-shiv/lib/error-middleware.js

@@ -0,0 +1,21 @@
+'use strict';
+
+const createError = require('http-errors');
+const debug = require('debug')('leader: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();
+};

lab-shiv/lib/storage.js

@@ -0,0 +1,54 @@
+'use strict';
+
+const Promise = require('bluebird');
+const fs = Promise.promisifyAll(require('fs'), {suffix: 'Prom'});
+const createError = require('http-errors');
+const debug = require('debug')('leader: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)));
+};

lab-shiv/model/leader.js

@@ -0,0 +1,57 @@
+'use strict';
+
+const uuid = require('node-uuid');
+const createError = require('http-errors');
+const debug = require('debug')('leader:leader');
+const storage = require('../lib/storage.js');
+
+const Leader = module.exports = function(name, purpose) {
+  debug('leader constructor');
+
+  if (!name) throw createError(400, 'expected name');
+  if (!purpose) throw createError(400, 'expected purpose');
+
+  this.id = uuid.v1();
+  this.name = name;
+  this.purpose = purpose;
+};
+
+Leader.createLeader = function(_leader) {
+  debug('createLeader');
+
+  try {
+    let leader = new Leader(_leader.name, _leader.purpose);
+    return storage.createItem('leader', leader);
+  } catch (err) {
+    return Promise.reject(err);
+  }
+};
+
+Leader.fetchLeader = function(id) {
+  debug('fetchLeader');
+  return storage.fetchItem('leader', id);
+};
+
+Leader.updateLeader = function(id, _leader) {
+  debug('updateLeader');
+
+  return storage.fetchItem('leader', id)
+  .catch( err => Promise.reject(createError(404, err.message)))
+  .then( leader => {
+    for (var prop in leader) {
+      if (prop === 'id') continue;
+      if (_leader[prop]) leader[prop] = _leader[prop];
+    }
+    return storage.createItem('leader', leader);
+  });
+};
+
+Leader.deleteLeader = function(id) {
+  debug('deleteLeader');
+  return storage.deleteItem('leader', id);
+};
+
+Leader.fetchIDs = function() {
+  debug('fetchIDs');
+  return storage.availIDs('leader');
+};

lab-shiv/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "12-express_middleware",
+  "version": "1.0.0",
+  "description": "![CF](https://camo.githubuserpurpose.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) Lab 12: Single Resource Express API\r ===",
+  "main": "index.js",
+  "scripts": {
+    "test": "test"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shivprogrammer/12-express_middleware.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/shivprogrammer/12-express_middleware/issues"
+  },
+  "homepage": "https://github.com/shivprogrammer/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"
+  },
+  "scripts": {
+    "start": "DEBUG='leader*' node server.js",
+    "test": "DEBUG='leader*' ./node_modules/mocha/bin/mocha"
+  }
+}