Skip to content
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
5 changes: 5 additions & 0 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
**/node_modules/*
**/vendor/*
**/*.min.js
**/coverage/*
**/build/*
21 changes: 21 additions & 0 deletions .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"
}
136 changes: 136 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
107 changes: 75 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,75 @@
![cf](https://i.imgur.com/7v5ASc8.png) Lab 09: Vanilla REST API w/ Persistence
======

## 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 learn how to save resource data to the file system for a layer of data persistence
* students will learn how to refactor commonly used coding constructs into custom helper modules

## Requirements

#### Configuration
* `package.json`
* `.eslintrc`
* `.gitignore`
* `README.md`
* your `README.md` should include detailed instructions on how to use your API
* this should include documentation on how to access your API endpoints

#### Feature Tasks
* continue working on your vanilla REST API
* refactor your routes to be contained in a separate module (ex: `route/resource-route.js`)
* refactor your `res` messages & status codes to be contained in a separate module (ex: `response.js`)
* refactor the `storage.js` module to use file system persistence
* use the `fs` module to create and read the associated data files
* the name of the file should contain the related resource id
# Vanilla API Persistence - 09 Lab

## 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

```
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.

### 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.
32 changes: 32 additions & 0 deletions lib/parse-json.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
'use strict';

module.exports = function(req) {
return new Promise((resolve, reject) => {
if (req.method === 'POST' || req.method === 'PUT') {
var body = '';

req.on('data', data => {
body += data.toString();
});

req.on('end', () => {
try {
req.body = JSON.parse(body);
resolve(req);
} catch (err) {
console.error(err);
reject(err);
}
});

req.on('error', err => {
console.error(err);
reject(err);
});

return;
}

resolve();
});
};
10 changes: 10 additions & 0 deletions lib/parse-url.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
'use strict';

const parseUrl = require('url').parse;
const parseQuery = require('querystring').parse;

module.exports = function(req) {
req.url = parseUrl(req.url);
req.url.query = parseQuery(req.url.query);
return Promise.resolve(req);
};
20 changes: 20 additions & 0 deletions lib/response.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
'use strict';

module.exports = exports = {};

exports.sendJSON = function (res, status, data){
res.writeHead(status, {
'content-type': 'application/json'
});

res.write(JSON.stringify(data));
res.end();
};

exports.sendText = function(res, status, msg) {
res.writeHead(status, {
'content-type': 'text/plain'
});
res.write(msg);
res.end();
};
59 changes: 59 additions & 0 deletions lib/router.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
'use strict';

const parseUrl = require('./parse-url.js');
const parseJSON = require('./parse-json.js');

const Router = module.exports = function() {
this.routes = {
GET: {},
POST: {},
PUT: {},
DELETE: {}
};
};

Router.prototype.get = function(endpoint, callback) {
this.routes.GET[endpoint] = callback;
};

Router.prototype.post = function(endpoint, callback) {
this.routes.POST[endpoint] = callback;
};

Router.prototype.put = function(endpoint, callback) {
this.routes.PUT[endpoint] = callback;
};

Router.prototype.delete = function(endpoint, callback) {
this.routes.DELETE[endpoint] = callback;
};

Router.prototype.route = function() {
return (req, res) => {
Promise.all([
parseUrl(req),
parseJSON(req)
])
.then( () => {
console.log(req.method, req.url.pathname);
if (typeof this.routes[req.method][req.url.pathname] === 'function') {
this.routes[req.method][req.url.pathname](req, res);
return;
}
console.error('route not found');
res.writeHead(404, {
'Content-Type': 'text/plain'
});
res.write('route not found');
res.end();
})
.catch( err => {
console.error(err);
res.writeHead(400, {
'Content-Type': 'text/plain'
});
res.write('bad request');
res.end();
});
};
};
Loading