Lab-Cayla

.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,120 @@
+# Created by https://www.gitignore.io/api/node,vim,osx,macos,linux
+
+*node_modules
+
+#ignore data files
+data/
+
+### 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

README.md

@@ -1,28 +1,27 @@
-![CF](https://camo.githubusercontent.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
+![CF](https://camo.githubusercontent.com/70edab54bba80edb7493cad3135e9606781cbb6b/687474703a2f2f692e696d6775722e636f6d2f377635415363382e706e67)  Lab 12: Single Resource Express API
+===
+## The build out of this API:
+- Created a HTTP server using express
+- Created an object constructor which then creates a simple resource with three properties
+-       1. id
+-       2. author
+-       3. entry
+- Created a single resource `express` API that can handle **GET**, **POST**, and **PUT** requests
+- Used the `http-errors` module to create new errors and associate them with a proper status code
+- Created an `error-middleware` module to handle errors and *use* it in your server file
+- Created a `cors-middleware` module that will allow for public use of your API
+- Created a storage module that stores resources by their schema type
+- Created 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`)
+- Created a series of `note-route-tests` to test your **GET**, **POST**, and **PUT** routes
 
-## Include
-  * `package.json`
-  * `.eslintrc`
-  * `gulpfile.js`
-  * `.gitignore`
-  * `README.md`
+## Server Endpoints
+ ### '/api/journal'
+ - POST Request
+ - PUT Request
+ - GET Request
+ - DELETE Request
 
-## 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 `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*
+## Tests
+-Wrote tests to ensure the /api/journal endpoint responds as described for each condition below:

gulpfile.js

@@ -0,0 +1,23 @@
+'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('dev', function(){
+  gulp.watch(['**/*.js', '!node_modules/**'], ['lint', 'test']);
+});
+
+gulp.task('default', ['dev']);

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

model/journal.js

@@ -0,0 +1,57 @@
+'use strict';
+
+const uuid = require('node-uuid');
+const createError = require('http-errors');
+const debug = require('debug')('journal:journal');
+const storage = require('../lib/storage.js');
+
+const Journal = module.exports = function(author, entry) {
+  debug('journal constructor');
+
+  if(!author) throw createError(400, 'expected author');
+  if (!entry) throw createError(400, 'expected entry');
+
+  this.id = uuid.v1();
+  this.author = author;
+  this.entry = entry;
+};
+
+Journal.createJournal = function(_journal){
+  debug('createJournal');
+
+  try {
+    let journal = new Journal(_journal.author, _journal.entry);
+    return storage.createItem('journal', journal);
+  } catch (err) {
+    return Promise.reject(err);
+  }
+};
+
+Journal.fetchJournal = function(id) {
+  debug('fetchJournal');
+  return storage.fetchItem('journal', id);
+};
+
+Journal.updateJournal = function(id, _journal) {
+  debug('updateJournal');
+
+  return storage.fetchItem('journal', id)
+  .catch( err => Promise.reject(createError(404, err.message)))
+  .then( journal => {
+    for(var prop in journal) {
+      if(prop === 'id') continue;
+      if(_journal[prop]) journal[prop] = _journal[prop];
+    }
+    return storage.createItem('journal', journal);
+  });
+};
+
+Journal.deleteJournal = function(id) {
+  debug('deleteJournal');
+  return storage.deleteItem('journal', id);
+};
+
+Journal.fetchIDs = function() {
+  debug('fetchIDs');
+  return storage.availIDs('journal');
+};