Yana - submission

lab-yana/.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-yana/.gitignore

@@ -0,0 +1,120 @@
+# 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
+
+# files in data/blog
+data
+
+# 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-yana/README.md

@@ -0,0 +1,44 @@
+### My Fisher Price First Express API for Blogs!!!!
+
+This is a single resource API using express middleware to make creating a server and routing requests much more efficient and painless. It allows you to upload a blog entry, look at stored blog entries, see a list of available blog entries, and delete a blog entry.
+
+### Directions for Use
+
+* make sure you have [node.js and npm installed](https://docs.npmjs.com/getting-started/installing-node), then in a terminal window, clone the code:
+  ```
+  $ git clone https://github.com/radenska/11-single_resource_express_api.git
+  ```
+
+* run npm i:
+  ```
+  $ npm i
+  ```
+* start the server!
+  ```
+  $ node server.js
+  ```
+* in a new terminal window, do the stuff! Here are your options:
+  - look at a blog entry:
+    ```
+    $ http :3003/api/blog/blogID
+    ```
+  - upload a blog entry:
+    ```
+    $ http POST :3003/api/blog name="blog entry name" content="blog entry contents"
+    ```
+  - look at a list of IDs of available blog entries (so you know how to look up a specific one!):
+    ```
+    $ http :3003/api/blog
+    ```
+  - delete a blog entry:
+    ```
+    $ http DELETE :3003/api/blog/blogID
+    ```
+  - update a blog entry (if you don't include the id, a new entry will be created instead):
+    ```
+    $ http POST :3003/api/blog id="blogID" name="new name" content="new content"
+    ```
+
+That's it!
+
+##### Created by Yana Radenska

lab-yana/gulpfile.js

@@ -0,0 +1,20 @@
+'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']);

lab-yana/lib/storage.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const Promise = require('bluebird'); //library that allows us to promisify modules
+const createError = require('http-errors');
+const debug = require('debug')('blog:storage');
+const fs = Promise.promisifyAll(require('fs'), { suffix: 'Prom' } ); //any function with that suffix has been promisified
+
+module.exports = exports = {};
+
+exports.createItem = function(schemaName, item) { // called for POST
+  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) //return item (blog in this case) object; blog-route.js gets response
+  .catch(err => Promise.reject(createError(404, err.message))); //reject promise if file isn't successfully written;
+};
+
+exports.fetchItem = function(schemaName, id) { //called for GET
+  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 { return JSON.parse(data.toString()); }
+    catch (err) { return Promise.reject(createError(400, 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`)
+  .then( res => {
+    return res;
+  })
+  .catch(err => { return Promise.reject(createError(404, err.message)); }) ;
+};
+
+
+exports.fetchList = function(schemaName) {
+  if (!schemaName) return Promise.reject(createError(400, 'expected schema name'));
+  return fs.readdirProm(`${__dirname}/../data/${schemaName}`)
+    .then(list => { return list; } )
+    .catch(err => { return Promise.reject(createError(404, err.message)); });
+};
+
+exports.changeItem = function(schemaName, id, item) {
+  debug('changeItem');
+  if (!item) return Promise.reject(createError(400, 'expected item'));
+  if (!schemaName) return Promise.reject(createError(400, 'expected schema name'));
+  if (!id) return Promise.reject(createError(400, 'expected id'));
+  var blog = JSON.parse(fs.readFile(`${__dirname}/../data/${schemaName}/${id}`).toString());
+  blog.content = item.content;
+  blog.name = item.name;
+  blog = JSON.stringify(blog);
+  return fs.writeFileProm(`${__dirname}/../data/${schemaName}/${id}.json`, blog)
+    .then( () => blog)
+    .catch(err => { return Promise.reject(createError(404, err.message)); } );
+};

lab-yana/model/blog.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const randomID = require('node-uuid');
+const createError = require('http-errors');
+const debug = require('debug')('blog:blog');
+const storage = require('../lib/storage.js');
+
+const Blog = module.exports = function(name, content) {
+  debug('note construct');
+  if (!name) throw createError(400, 'name expected');
+  if (!content) throw createError(400, 'content expected');
+
+  this.id = randomID.v1();
+  this.name = name;
+  this.content = content;
+};
+
+Blog.createBlog = function(_blog) {
+  debug('createBlog');
+  try {
+    let blog = new Blog(_blog.name, _blog.content);
+    return storage.createItem('blog', blog);
+  } catch(err) {
+    return Promise.reject(createError(400, err.message));
+  }
+};
+
+Blog.fetchBlog = function(id) {
+  debug('fetchBlog');
+  return storage.fetchItem('blog', id);
+};
+
+Blog.deleteBlog = function(id) {
+  debug('deleteItem');
+  return storage.deleteItem('blog', id);
+};
+
+Blog.updateBlog = function(_blog) {
+  debug('updateBlog');
+  try {
+    let blog = new Blog(_blog.name, _blog.content);
+    blog.id = _blog.id;
+    return storage.createItem('blog', blog);
+  } catch(err) {
+    return Promise.reject(createError(400, err.message));
+  }
+};
+
+Blog.fetchBlogList = function() {
+  debug('fetchList');
+  return storage.fetchList('blog');
+};

lab-yana/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "lab-yana",
+  "version": "1.0.0",
+  "description": "",
+  "main": "gulpfile.js",
+  "scripts": {
+    "start": "DEBUG='blog*' 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",
+    "gulp": "^3.9.1",
+    "gulp-eslint": "^3.0.1",
+    "gulp-mocha": "^4.0.1",
+    "superagent": "^3.5.0"
+  }
+}