lab-james

.eslintignore

@@ -0,0 +1,5 @@
+**/node_modules/*
+**/vendor/*
+**/*.min.js
+**/coverage/*
+**/build/*

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

.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

README.md

@@ -1,35 +1,93 @@
-![cf](https://i.imgur.com/7v5ASc8.png) 12: Express Middleware
-======
-
-## Submission Instructions
-  * fork this repository & create a new branch for your work
-  * write all of your code in a directory named `lab-` + `<your name>` **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 application, router, and 3rd party middleware through the use of express.js
-* students will be able to implement custom middleware through the use of express.js
-* students will be able to create custom routers for a specific resource
-
-## Requirements
-
-#### Configuration
-* `package.json`
-* `.eslintrc`
-* `.gitignore`
-* `README.md`
-  * your `README.md` should include detailed instructions on how to use your API
-
-#### Feature Tasks
-* 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*
+# 12: Express Middleware
+
+## Description:
+This app builds out an API where data is stored in the file system. This API stores beer data with the schema of name, style, and IBU.
+
+## API:
+The URL endpoint to access the api is `/api/beer`.  Using REST architecture the data is read, written and deleted using `GET`, `POST` and `DELETE` requests.
+
+### POST:
+
+```
+request.post('localhost:8000/api/beer')
+.send({ name: 'Have a Nice Day IPA', style: 'IPA', IBU: '43' })
+```
+
+This is a representation of the POST method. You can see that we first make a request to post to
+```
+localhost:8000
+```
+with a route of
+```
+/api/beer
+```
+Once the connection has bee made we send our beer in
+```
+.send({ name: 'Have a Nice Day IPA', style: 'IPA', IBU: '43' })
+```
+format. This will respond with 200 if the request was made or 400 if not.
+
+### GET
+#### With ID
+```
+request.get(`localhost:8000/api/beer?id=${beer.id}`)
+```
+This is a representation of the GET method. You can see that we first make a request to post to
+
+```
+localhost:8000
+```
+with a route of
+
+```
+/api/beer
+```
+
+finally with finish the request with reference to a specific id which was generated with uuid
+
+```
+?id=${beer.id}
+```
+
+This will respond with 200 if the request was made, 404 if not found or 400 if the request was made in wrong format.
+
+#### Without ID
+
+```
+request.get(`localhost:8000/api/beer`)
+```
+This is a representation of the GET method without an ID. This will respond with all the available IDs. You can see that we first make a request to post to
+
+```
+localhost:8000
+```
+with a route of
+
+```
+/api/beer
+```
+
+This will respond with 200 if the request was made, 404 if not found or 400 if the request was made in wrong format.
+
+### DELETE
+
+```
+request.delete(`localhost:8000/api/beer?id=${beer.id}`)
+```
+
+This is a representation of the POST method. You can see that we first make a request to post to
+
+```
+localhost:8000
+```
+with a route of
+
+```
+/api/beer
+```
+finally with finish the request with reference to a specific id which was generated with uuid
+```
+?id=${beer.id}
+```
+
+This will respond with 200 if the request was made, 404 if not found or 400 if the request was made in wrong format.

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

lib/error-middleware.js

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

lib/storage.js

@@ -0,0 +1,53 @@
+'use strict';
+
+const Promise = require('bluebird');
+const fs = Promise.promisifyAll(require('fs'), {suffix: 'Prom'});
+const createError = require('http-errors');
+const debug = require('debug')('beer: 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());
+      console.log(item);
+      return item;
+    } catch (err){
+      return Promise.reject(createError(500, err.message));
+    }
+  })
+  .catch(err => Promise.reject(createError(404, err.message)));
+};
+
+exports.deleteItem = function(schemaName, id){
+  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){
+  fs.readDirProm(`${__dirname}/../data/${schemaName}`)
+  .then( files => files.map(name => name.split('.json')[0]))
+  .catch( err => Promise.reject(createError(404, err.message)));
+};