# casimircore

> The core modules for the Casimir webapp framework

Latest version **0.11.17** (published 2018-03-29) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install casimircore
pnpm add casimircore
yarn add casimircore
bun add casimircore
```

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.11.17 |
| Published | 2018-03-29 |
| First published | 2015-09-07 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 44 |
| Unpacked size | 47.5 KB |
| Known vulnerabilities | 0 (+27 in 9 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | thehobbit85 |
| Maintainers | bejavu, oleiba |
| Keywords | server, framework, webapp, database, mongoose, users, websites |

## Links

- npm: https://www.npmjs.com/package/casimircore
- Repository: https://github.com/Colored-Coins/casimircore
- Homepage: https://github.com/Colored-Coins/casimircore#readme
- Issues: https://github.com/Colored-Coins/casimircore/issues
- npm.io page: https://npm.io/package/casimircore

## Dependencies (44)

- [qs](https://npm.io/package/qs.md) ^5.0.0
- [cors](https://npm.io/package/cors.md) ^2.7.1
- [faye](https://npm.io/package/faye.md) ^1.1.2
- [jade](https://npm.io/package/jade.md) ^1.11.0
- [path](https://npm.io/package/path.md) ^0.12.7
- [uuid](https://npm.io/package/uuid.md) ^2.0.1
- [clone](https://npm.io/package/clone.md) ^1.0.2
- [merge](https://npm.io/package/merge.md) ^1.2.0
- [redis](https://npm.io/package/redis.md) ~2.6.2
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [moment](https://npm.io/package/moment.md) ^2.10.6
- [morgan](https://npm.io/package/morgan.md) ^1.7.0
- [express](https://npm.io/package/express.md) ^4.13.3
- [le_node](https://npm.io/package/le_node.md) ^1.1.0
- [request](https://npm.io/package/request.md) ^2.61.0
- [winston](https://npm.io/package/winston.md) ^1.0.1
- [jsonfile](https://npm.io/package/jsonfile.md) ^2.3.1
- [mongoose](https://npm.io/package/mongoose.md) ~4.4.3
- [passport](https://npm.io/package/passport.md) ^0.3.0
- [http-auth](https://npm.io/package/http-auth.md) ^2.2.8
- [iniparser](https://npm.io/package/iniparser.md) ^1.0.5
- [socket.io](https://npm.io/package/socket.io.md) git+https://github.com/tal-beja/socket.io.git#pre2
- [jwt-simple](https://npm.io/package/jwt-simple.md) ^0.3.1
- [prettyjson](https://npm.io/package/prettyjson.md) ^1.1.3
- [body-parser](https://npm.io/package/body-parser.md) ^1.13.3
- [compression](https://npm.io/package/compression.md) ^1.5.2
- [consolidate](https://npm.io/package/consolidate.md) ^0.13.1
- [mongodb-uri](https://npm.io/package/mongodb-uri.md) 0.9.7
- [on-finished](https://npm.io/package/on-finished.md) ^2.3.0
- [aws-xray-sdk](https://npm.io/package/aws-xray-sdk.md) 1.0.5-beta
- [winston-mail](https://npm.io/package/winston-mail.md) ^0.4.0
- [cookie-parser](https://npm.io/package/cookie-parser.md) ^1.3.5
- [mongoose-time](https://npm.io/package/mongoose-time.md) ^0.1.0
- [passport-http](https://npm.io/package/passport-http.md) ^0.3.0
- [piwik-tracker](https://npm.io/package/piwik-tracker.md) ^0.1.2
- [serve-favicon](https://npm.io/package/serve-favicon.md) ^2.3.0
- [express-winston](https://npm.io/package/express-winston.md) ^0.4.1
- [socket.io-redis](https://npm.io/package/socket.io-redis.md) git+https://github.com/tal-beja/socket.io-redis.git
- [socket.io-client](https://npm.io/package/socket.io-client.md) ~1.4.8
- [express-validator](https://npm.io/package/express-validator.md) ^2.17.1
- [findhit-proxywrap](https://npm.io/package/findhit-proxywrap.md) ^0.3.10
- [express-http-proxy](https://npm.io/package/express-http-proxy.md) ^0.10.1
- [passport-http-bearer](https://npm.io/package/passport-http-bearer.md) ^1.0.1
- [mongoose-merge-plugin](https://npm.io/package/mongoose-merge-plugin.md) 0.0.5

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [@temporal-architect/claude-plugin](https://npm.io/package/@temporal-architect/claude-plugin.md) — 335 weekly downloads

## Recent versions

- 0.11.17 (latest) — 2018-03-29
- 0.11.16 — 2017-08-23
- 0.11.15 — 2017-08-23
- 0.11.14 — 2017-08-23
- 0.11.13 — 2017-08-21
- 0.11.11 — 2017-05-15
- 0.11.10 — 2017-03-23
- 0.11.9 — 2017-03-13
- 0.11.8 — 2017-03-13
- 0.11.7 — 2017-03-12
- 0.11.6 — 2017-03-12
- 0.11.5 — 2017-03-06
- 0.11.4 — 2017-02-22
- 0.11.3 — 2016-12-26
- 0.11.2 — 2016-12-26
- … 57 more at https://npm.io/package/casimircore/versions

## README

# Casimir Core
[![Build Status][travis-image]][travis-url] [![Coverage percentage][coveralls-image]][coveralls-url] [![NPM version][npm-image]][npm-url] [![Dependency Status][daviddm-image]][daviddm-url] [![Slack Channel][slack-image]][slack-url]

[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

> The core modules for the Casimir webapp framework


### Install

```sh
$ npm i --save casimircore
```


### Features

```js
var casimir_core = require('casimircore')()

console.log(casimir_core)

{
  server: {
    http_server,
    port,
    ssl,
    pub_sub,
    sockets,
    io_server
  },
  Error: 'Error Middleware',
  Router: 'Custom Router with authentication and validation',
  logger: {
    info,
    debug,
    error,
    warn
  },
  properties: properties,
  db: {
    init,
    get_model
  },
  authentication: {
    verify_token,
    verify_specific_user_token,
    check_access
  }
}
```

### Authentication

```js
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
    next()
  })
}

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

```js
var mongoose = require('mongoose')
var db = casimir_core.db
var settings = {
  user: 'user',
  pass: 'password',
  host: 'host.mongodb.com',
  port: 27000,
  name: 'testDB',

  // with URI - if provided, all previous connection settings are ignored
  uri: 'mongodb://user:password@host.mongodb.com:27000/testDB',

  // mongoose models directory
  dir: './db'
}
db.init(settings, mongoose, function (err, mongoose) {
  if (err) return console.error(err)
  console.log('connected to db')
})
```

### Error

```js
var env = process.env.NODE_ENV
var error = casimir_core.error(env)
```

### Logger

```js
var env = process.env.NODE_ENV
var logentries_api_key = 'fdsfdf23fewfew'

var log_settings = {
  env: env,
  logentries_api_key: logentries_api_key,
  log_dir: './log'
}

var logger = casimir_core.logger(log_settings)

// Can Actually run over normal console with logger
console.log = logger.info
console.error = logger.error
console.warn = logger.warn
...
```

### Properties

```js
var config_dir = './config'
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",
    "params": ["param1","param2"],
    "optional": ["optionalParam"],
    "users": ["optionalPrivateUsers"]
  }
}
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

```js
var validator = require('./validator.js')
// Add custom framwork modules for server
properties.modules = {
  validator: validator,
  router: router,
  error: error,
  logger: logger,
  requestid: requestid
}
// Set server and server port
var server = casimir_core.server(properties)
```

### Testing

```sh
$ cd /"module-path"/casimircore
$ npm test
```


## License

[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)

[npm-image]: https://badge.fury.io/js/casimircore.svg
[npm-url]: https://npmjs.org/package/casimircore
[travis-image]: https://travis-ci.org/Colored-Coins/casimircore.svg?branch=master
[travis-url]: https://travis-ci.org/Colored-Coins/casimircore
[daviddm-image]: https://david-dm.org/Colored-Coins/casimircore.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/Colored-Coins/casimircore
[coveralls-image]: https://coveralls.io/repos/Colored-Coins/casimircore/badge.svg
[coveralls-url]: https://coveralls.io/r//Colored-Coins/casimircore
[slack-image]: http://slack.coloredcoins.org/badge.svg
[slack-url]: http://slack.coloredcoins.org
[mocha]: https://www.npmjs.com/package/mocha
[gulp]: http://gulpjs.com/

---
_Source: https://npm.io/package/casimircore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
