lab-regan

README.md

@@ -1,48 +1,15 @@
-![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67) Lab 11: Single Resource Express API
+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`
-    * your `README.md` should include detailed instructions on how to use your API
-
 ## Description
-  * Create an HTTP server using `express`
-  * Create a object constructor that creates a _simple resource_ with at least 3 properties
-    * it can **not** have the same properties as the in-class sample code (other than the `id`)
-    * a unique `id` property should be included *(node-uuid)*
-    * include two additional properties of your choice
-  * Use the JSON parser included with the `body-parser` module as a middleware component to parse the request body on `POST` and `PUT` routes
-  * Use the npm `debug` module to log the methods in your application
-  * Create an `npm` script to automate the `debug` process and start the server
-  * Persist your API data using the storage module and file system persistence
+  * Utilizes an `express` server, one resource, and various third party tools to route and handle requests and allow data to persist on the file system.
 
 ## Server Endpoints
-  * **`/api/simple-resource-name`**
+  * **`/api/neighbor`**
   * `POST` request
    * pass data as stringifed JSON in the body of a **POST** request to create a new resource
   * `GET` request
    * pass `?id=<uuid>` as a query string parameter to retrieve a specific resource (as JSON)
   * `DELETE` request
    * pass `?id=<uuid>` in the query string to **DELETE** a specific resource
    * this should return a 204 status code with no content in the body
-
-## Tests
-  * write a test to ensure that your api returns a status code of 404 for routes that have not been registered
-  * write tests to ensure the `/api/simple-resource-name` endpoint responds as described for each condition below:
-   * `GET`: test 404, it should respond with 'not found' for valid requests made with an id that was not found
-   * `GET`: test 400, it should respond with 'bad request' if no id was provided in the request
-   * `GET`: test 200, it should contain a response body for a request made with a valid id
-   * `POST`: test 400, it should respond with 'bad request' if no request body was provided or the body was invalid
-   * `POST`: test 200, it should respond with the body content for a post request with a valid body

lab-regan/.eslintrc

@@ -0,0 +1,19 @@
+{
+  "rules": {
+    "no-console": "off",
+    "indent": [ "error", 2 ],
+    "quotes": [ "error", "single" ],
+    "semi": ["error", "always"],
+    "linebreak-style": [ "error", "unix" ]
+  },
+  "env": {
+    "es6": true,
+    "node": true,
+  },
+  "ecmaFeatures": {
+    "modules": true,
+    "experimentalObjectRestSpread": true,
+    "impliedStrict": true
+  },
+  "extends": "eslint:recommended"
+}

lab-regan/.gitignore

@@ -0,0 +1,132 @@
+
+# Created by https://www.gitignore.io/api/osx,node,linux,windows
+
+### 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*
+
+###Local Files###
+data/
+
+### 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 ###
+*.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
+
+### 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,node,linux,windows

lab-regan/README.md

@@ -0,0 +1,15 @@
+Single Resource Express API
+===
+
+## Description
+  * Utilizes an `express` server, one resource, and various third party tools to route and handle requests and allow data to persist on the file system.
+
+## Server Endpoints
+  * **`/api/neighbor`**
+  * `POST` request
+   * pass data as stringifed JSON in the body of a **POST** request to create a new resource
+  * `GET` request
+   * pass `?id=<uuid>` as a query string parameter to retrieve a specific resource (as JSON)
+  * `DELETE` request
+   * pass `?id=<uuid>` in the query string to **DELETE** a specific resource
+   * this should return a 204 status code with no content in the body

lab-regan/gulpfile.js

@@ -0,0 +1,13 @@
+'use strict';
+
+const gulp = require('gulp');
+const eslint = require('gulp-eslint');
+
+gulp.task('lint', function(){
+  return gulp.src(['**/*.js', '!node_modules'])
+  .pipe(eslint())
+  .pipe(eslint.format())
+  .pipe(eslint.failAfterError());
+});
+
+gulp.task('default', ['lint']);

lab-regan/lib/storage.js

@@ -0,0 +1,45 @@
+'use strict';
+
+const Promise = require('bluebird');
+const createError = require('http-errors');
+const debug = require('debug')('neighbors:storage');
+const fs = Promise.promisifyAll(require('fs'), {suffix:'Prom'});
+
+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 object'));
+
+  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)));
+};//end createItem
+
+
+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`)
+  .then( () => thang )
+  .catch( err => Promise.reject(createError(500, err.message)));
+};//end deleteItem
+
+
+exports.fetchItem = function(schemaName, id){
+  if(!schemaName) return Promise.reject(createError(400, 'expected schema'));
+  if(!id) return Promise.reject(createError(400, 'expected id'));
+  return fs.readFileProm(`${__dirname}/../data/${schemaName}/${id}.json`)
+  .then( thing => {
+    try {
+      let item = JSON.parse(thing.toString());
+      return item;
+    } catch (err) {
+      return Promise.reject(createError(500, err.message));
+    }
+  })
+  .catch( err => Promise.reject(createError(404, err.message)));
+};//end fetchItem

lab-regan/model/neighbor.js

@@ -0,0 +1,40 @@
+'use strict';
+
+const uuid = require('node-uuid');
+const createError = require('http-errors');
+const debug = require('debug')('neighbor:neighbor');
+const storage = require('../lib/storage.js');
+
+const Neighbor = module.exports = function(name, age, friendly){
+  debug('neighbor constructor');
+
+  if(!name) throw createError(400, 'expected name');
+  if(!age) throw createError(400, 'expected age');
+  if(!friendly) throw createError(400, 'expected friendly');
+
+  this.id = uuid.v1();
+  this.name = name;
+  this.age = age;
+  this.friendly = friendly;
+};
+
+Neighbor.createNeighbor = function(_neighbor){
+  debug('createNeighbor');
+  try {
+    let neighbor = new Neighbor(_neighbor.name, _neighbor.age, _neighbor.friendly);
+    return storage.createItem('neighbor', neighbor);
+  } catch(err) {
+    return Promise.reject(err);
+  };
+};// end createNeighbor
+
+Neighbor.fetchNeighbor = function(id){
+  debug('fetchNeighbor');
+  return storage.fetchItem('neighbor', id);
+};//end fetchNeighbor
+
+
+Neighbor.deleteNeighbor = function(id){
+  debug('deleteNeighbor');
+  return storage.deleteItem('neighbor', id);
+};//end deleteNeighbor

lab-regan/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "lab-regan",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "start": "DEBUG='neighbor*' node server.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "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",
+    "superagent": "^3.5.0"
+  }
+}