Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Oded Leiba authored Dec 22, 2016
1 parent 19a5260 commit fbcb0b2
Showing 1 changed file with 23 additions and 44 deletions.
67 changes: 23 additions & 44 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,41 +45,28 @@ console.log(casimir_core)
authentication: {
verify_token,
verify_specific_user_token,
check_access,
issue_token
},
block_explorer: {
get,
post
check_access
}
}
```

### Authentication

```js
var secret = 'helloKitty'

var callback = function (token, decoded, errmsg, req, res, next) {
var User = db.get_model('User')
User.findOne({ user_name: decoded.iss }, function (err, user) {
if (err) {
console.warn(err)
return next(errmsg)
}
if (!user) return next()
if (user.black_list.indexOf(token) !== -1) {
console.warn('Token has been used')
return next(errmsg)
}
var verify_callback = function (jwt_token, req, res, next) {
get_user_by_token(jwt_token, function (err, user) {
if (err) return next(err)
req.user = user
if (decoded.type === 'api_key') console.log(token, '-', req.path)
req.user.requestToken = {token: token, decoded: decoded}
return next()
next()
})
}

var authentication = casimir_core.authentication(secret, callback)
var access_callback = function (req, res, next) {
// reaches here if there is no req.user
res.status(401).send('Not Authorized')
}

var authentication = casimir_core.authentication(verify_callback, access_callback)
```

### DB
Expand All @@ -101,12 +88,6 @@ db.init(settings, mongoose, function (err, mongoose) {
})
```

### BLOCK-EXPLORER

```js
var block_explorer = casimir_core.block_explorer(explorerURI)
```

### Error

```js
Expand Down Expand Up @@ -145,11 +126,17 @@ var properties = casimir_core.properties(config_dir)
### RequestId

```js
var settings = {
secret: 'secret',
namespace: 'servername'
}
var requestid = casimir_core.request_id(requestSettings)
```

### Router

```js
var fs = require('fs')
var GET_public = {
"/path": {
"function_name": "File.Function",
Expand All @@ -158,14 +145,10 @@ var GET_public = {
"users": ["optionalPrivateUsers"]
}
}
var contollers_dir = './controllers/'
var routes = {
GET: { Public: GET_public, Private: GET_private },
POST: { Public: POST_public, Private: POST_private },
PUT: { Public: PUT_public, Private: PUT_private },
DELETE: { Public: DELETE_public, Private: DELETE_private }
}
var router = casimir_core.router(routes, contollers_dir, authentication)
fs.writeFileSync(routes_dir + 'GET-public.json', GET_public) // can be similarly done for POST, PUT, DELETE and private
var controllers_dir = './controllers/'
var routes_dir = './routes/'
var router = casimir_core.router(routes_dir, controllers_dir, authentication)
```

### Server
Expand All @@ -177,17 +160,13 @@ properties.modules = {
validator: validator,
router: router,
error: error,
logger: logger
logger: logger,
requestid: requestid
}
// Set server and server port
var server = casimir_core.server(properties)
```

### Setup

```js
```

### Testing

```sh
Expand Down

0 comments on commit fbcb0b2

Please sign in to comment.