Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

lab-yana #1

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions lab-yana/.eslintrc
Original file line number Diff line number Diff line change
@@ -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"
}
118 changes: 118 additions & 0 deletions lab-yana/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# Created by https://www.gitignore.io/api/node,vim,osx,macos,linux

*node_modules
*data/blog

### 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
41 changes: 41 additions & 0 deletions lab-yana/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
### My Fisher Price Second 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, and see a list of available blog entries. As a dev, you can also 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/12-express_middleware.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
```
- 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
##### [_Yana's GitHub Repository_](https://github.com/radenska)
20 changes: 20 additions & 0 deletions lab-yana/gulpfile.js
Original file line number Diff line number Diff line change
@@ -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']);
7 changes: 7 additions & 0 deletions lab-yana/lib/cors-middleware.js
Original file line number Diff line number Diff line change
@@ -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();
};
18 changes: 18 additions & 0 deletions lab-yana/lib/error-middleware.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
'use strict';

const debug = require('debug')('blog:error-middleware');
const createError = require('http-errors');

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();
};
49 changes: 49 additions & 0 deletions lab-yana/lib/storage.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
'use strict';

const debug = require('debug')('blog:storage');
const createError = require('http-errors');
const Promise = require('bluebird');
const fs = Promise.promisifyAll(require('fs'), {suffix: 'Prom'} );
const url = `${__dirname}/../data/`;

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'));

return fs.writeFileProm(`${url}${schemaName}/${item.id}.json`, JSON.stringify(item))
.then( () => item)
.catch(err => { return Promise.reject(createError(404, err.message)); });
};

exports.fetchItem = function(schemaName, id) {
debug('fetchItem');
if (!schemaName) return Promise.reject(createError(400, 'expected schemaName'));
if (!id) return Promise.reject(createError(400, 'expected id'));

return fs.readFileProm(`${url}${schemaName}/${id}.json`)
.then(file => {
try { return JSON.parse(file.toString()); }
catch (err) {return Promise.reject(createError(400, err.message)); }
})
.catch(err => { return 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(`${url}${schemaName}/${id}.json`)
.catch(err => { return Promise.reject(createError(404, err.message)); });
};

exports.getItemList = function(schemaName) {
debug('getItemList');
if (!schemaName) return Promise.reject(createError(400, 'expected schema name'));
return fs.readdirProm(`${url}${schemaName}`)
.then(list => { return list.map(filename => filename.split('.json')[0]); })
.catch(err => { return Promise.reject(createError(404, err.message)); });
};
54 changes: 54 additions & 0 deletions lab-yana/model/blog.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
'use strict';

const storage = require('../lib/storage.js');
const randomID = require('node-uuid');
const debug = require('debug')('blog:blog');
const createError = require('http-errors');

const Blog = module.exports = function (name, content) {
if (!name) throw createError(400, 'name expected');
if (!content) throw createError(400, 'content expecte');

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.removeBlog = function(id) {
debug('removeBlog');
return storage.deleteItem('blog', id);
};

Blog.getBlogList = function() {
debug('getBlogList');
return storage.getItemList('blog');
};

Blog.updateBlog = function(id, content) {
debug('updateBlog');
return storage.fetchItem('blog', id)
.catch(err => Promise.reject(createError(404, err.message)))
.then(blog => {
if(!content.name && !content.content) return Promise.reject(createError(400, 'bad request')); //to make sure we're being given a valid update that has either a name or content property
for (var key in blog) {
if (key === 'id') continue;
if (content[key]) blog[key] = content[key];
}
return storage.createItem('blog', blog);
});
};
30 changes: 30 additions & 0 deletions lab-yana/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"name": "lab-yana",
"version": "1.0.0",
"description": "",
"main": "gulpfule.js",
"scripts": {
"test": "DEBUG='blog*' mocha",
"start": "DEBUG='blog*' node server.js"
},
"keywords": [],
"author": "",
"license": "ISC",
"devDependencies": {
"chai": "^3.5.0",
"gulp": "^3.9.1",
"gulp-eslint": "^3.0.1",
"gulp-mocha": "^4.0.1",
"mocha": "^3.2.0",
"superagent": "^3.5.0"
},
"dependencies": {
"bluebird": "^3.4.7",
"body-parser": "^1.16.1",
"debug": "^2.6.1",
"express": "^4.14.1",
"mkdirp": "^0.5.1",
"morgan": "^1.8.1",
"node-uuid": "^1.4.7"
}
}
Loading