feat(api): mongoDB database wrapper

Author: Hans Kristian Flaatten

.eslintrc

@@ -0,0 +1,18 @@
+# vi:syntax=json
+{
+  "extends": "airbnb-base",
+  "env": {
+    "mocha": true,
+    "node": true
+  },
+  "parserOptions": {
+    "ecmaVersion": 6,
+    "sourceType": "script",
+    "ecmaFeatures": {
+      "modules": false
+    }
+  },
+  "rules": {
+    "strict": [2, "global"]
+  }
+}

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Den Norske Turistforening (DNT), Hans Kristian Flaatten
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,39 @@
+# @turbasen/db-mongo
+
+[![Build status](https://app.wercker.com/status/8af22dd80c3f309b1e116e251dd66cd0/s "wercker status")](https://app.wercker.com/project/bykey/8af22dd80c3f309b1e116e251dd66cd0)
+[![Codacy grade](https://img.shields.io/codacy/grade/eeb155a45852449da23b2e10b09c6ff9.svg "Codacy grade")](https://www.codacy.com/app/Turbasen/db-mongo)
+[![Codacy coverage](https://img.shields.io/codacy/coverage/eeb155a45852449da23b2e10b09c6ff9.svg "Codacy coverage")](https://www.codacy.com/app/Turbasen/db-mongo)
+[![NPM downloads](https://img.shields.io/npm/dm/@turbasen/db-mongo.svg "NPM downloads")](https://www.npmjs.com/package/@turbasen/db-mongo)
+[![NPM version](https://img.shields.io/npm/v/@turbasen/db-mongo.svg "NPM version")](https://www.npmjs.com/package/@turbasen/db-mongo)
+[![Node version](https://img.shields.io/node/v/@turbasen/db-mongo.svg "Node version")](https://www.npmjs.com/package/@turbasen/db-mongo)
+[![Dependency status](https://img.shields.io/david/Turbasen/db-mongo.svg "Dependency status")](https://david-dm.org/Turbasen/db-mongo)
+
+Internal mongoDB wrapper for Nasjonal Turbase API.
+
+## Getting started
+
+Download [Docker for Mac or Windows](https://www.docker.com/products/docker).
+
+Run in this directory:
+
+```
+$ docker-compose up
+```
+
+Docker is now watching for changes and will run the test suite automatically.
+
+## Usage
+
+Connects automatically using `MONGO_URI`, or `MONGO_PORT_27017_TCP_ADDR` +
+`MONGO_PORT_27017_TCP_PORT` environment variables, or default to `mongo` +
+`27017`.
+
+```js
+const mongo = require('mongo');
+
+mongo.on('ready', () => {
+  console.log('mongoDB is ready!');
+});
+```
+
+## [MIT lisenced](https://github.com/Turbasen/Auth/blob/master/LICENSE)

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '2'
+
+services:
+  mongo:
+    image: mongo:3.0
+
+  node:
+    image: node:argon
+    working_dir: /usr/src/app
+    volumes:
+      - .:/usr/src/app
+    links:
+      - mongo
+    depends_on:
+      - mongo
+    environment:
+      - NODE_ENV=development
+      - NPM_CONFIG_LOGLEVEL=silent
+      - NPM_CONFIG_PROGRESS=false
+      - NPM_CONFIG_SPIN=false
+    command: npm run test:watch

index.js

@@ -0,0 +1,41 @@
+'use strict';
+
+const EventEmitter = require('events').EventEmitter;
+const MongoClient = require('mongodb').MongoClient;
+const inherits = require('util').inherits;
+
+const MongoWrapper = function MongoWrapper(uri) {
+  EventEmitter.call(this);
+
+  MongoClient.connect(uri, (err, database) => {
+    if (err) { throw err; }
+
+    this.db = database;
+
+    this.api = {
+      users: database.collection('api.users'),
+    };
+
+    ['turer', 'steder', 'områder', 'bilder', 'grupper'].forEach((type) => {
+      this[type] = database.collection(type);
+    });
+
+    this.emit('ready');
+  });
+
+  return this;
+};
+
+inherits(MongoWrapper, EventEmitter);
+
+if (process.env.MONGO_URI) {
+  module.exports = new MongoWrapper(process.env.MONGO_URI);
+} else {
+  const addr = process.env.MONGO_PORT_27017_TCP_ADDR || 'mongo';
+  const port = process.env.MONGO_PORT_27017_TCP_PORT || '27017';
+  const db = 'test';
+
+  module.exports = new MongoWrapper(`mongodb://${addr}:${port}/${db}`);
+}
+
+module.exports.MongoWrapper = MongoWrapper;

package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@turbasen/db-mongo",
+  "version": null,
+  "description": "Internal mongoDB wrapper for Nasjonal Turbase API",
+  "main": "index.js",
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "codacy-coverage": "codacy-coverage",
+    "cover": "istanbul cover --report lcovonly ./node_modules/.bin/_mocha -- -R spec test.js",
+    "grunt:watch": "grunt watch",
+    "lint": "eslint index.js test.js",
+    "nsp": "nsp check",
+    "semantic-release": "semantic-release",
+    "test": "mocha -R tap -b --check-leaks test.js",
+    "test:watch": "mocha -R progress -b --check-leaks -w test.js",
+    "greenkeeper-postpublish": "greenkeeper-postpublish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Turbasen/db-mongo.git"
+  },
+  "keywords": [
+    "nasjonal turbase",
+    "turbasen",
+    "db",
+    "mongo",
+    "mongodb"
+  ],
+  "author": "Hans Kristian Flaatten <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Turbasen/db-mongo/issues"
+  },
+  "homepage": "https://github.com/Turbasen/db-mongo#readme",
+  "dependencies": {
+    "mongodb": "^2.1.18"
+  },
+  "devDependencies": {
+    "codacy-coverage": "^1.1.3",
+    "eslint": "^2.13.1",
+    "eslint-config-airbnb-base": "^3.0.1",
+    "eslint-plugin-import": "^1.10.0",
+    "greenkeeper-postpublish": "^1.0.0",
+    "istanbul": "^0.4.4",
+    "mocha": "^2.5.3",
+    "nsp": "^2.5.0",
+    "semantic-release": "^4.3.5"
+  },
+  "engines": {
+    "node": ">=4.0.0"
+  }
+}

test.js

@@ -0,0 +1,55 @@
+'use strict';
+
+const mongo = require('.');
+const assert = require('assert');
+const mongodb = require('mongodb');
+
+before(done => mongo.on('ready', done));
+
+describe('mongo', () => {
+  it('returns Mongo wrapper class', () => {
+    assert(mongo instanceof mongo.MongoWrapper);
+    assert(mongo.db instanceof mongodb.Db);
+
+    assert(mongo.api.users instanceof mongodb.Collection);
+
+    ['turer', 'steder', 'områder', 'bilder', 'grupper'].forEach((type) => {
+      assert(mongo[type] instanceof mongodb.Collection);
+    });
+  });
+
+  it('is connected to the database', (done) => {
+    mongo.db.stats((err, stats) => {
+      assert.ifError(err);
+      assert.equal(stats.ok, 1);
+      done();
+    });
+  });
+
+  it('connects via MONGO_URI environment variable', done => {
+    process.env.MONGO_URI = 'mongodb://mongo:27017/test';
+
+    delete require.cache[require.resolve('.')];
+    require('.').on('ready', function readyCb() { // eslint-disable-line global-require
+      // assert(this instanceof mongo.MongoWrapper);
+      assert(this.db instanceof mongodb.Db);
+      done();
+    });
+
+    delete process.env.MONGO_URI;
+  });
+
+  it('connects via MONGO_PORT_27017_TCP_* environment variables', done => {
+    process.env.MONGO_PORT_27017_TCP_ADDR = 'mongo';
+    process.env.MONGO_PORT_27017_TCP_PORT = '27017';
+
+    delete require.cache[require.resolve('.')];
+    require('.').on('ready', function readyCb() { // eslint-disable-line global-require
+      assert(this.db instanceof mongodb.Db);
+      done();
+    });
+
+    delete process.env.MONGO_PORT_27017_TCP_ADDR;
+    delete process.env.MONGO_PORT_27017_TCP_PORT;
+  });
+});

wercker.yml

@@ -0,0 +1,69 @@
+box: node:argon
+
+build:
+  services:
+    - mongo:3.0
+    - redis:3
+
+  steps:
+    - script:
+        name: wait for MongoDB to start
+        code: |
+          apt-get update --no-install-recommends -y
+          apt-get install --no-install-recommends -y netcat
+          while ! nc -q 1 $MONGO_PORT_27017_TCP_ADDR $MONGO_PORT_27017_TCP_PORT </dev/null; do sleep 3; done
+
+    - script:
+        name: echo nodejs information
+        code: |
+          echo "node version $(node -v) running"
+          echo "npm version $(npm -v) running"
+
+    - npm-install
+
+    - script:
+        name: lint
+        code: npm run lint
+
+    - npm-test
+
+    - script:
+        name: test coverage
+        code: |
+          npm run cover
+          cat ./coverage/lcov.info | npm run codacy-coverage
+
+    - script:
+        name: node security project
+        code: |
+          npm run nsp
+
+  after-steps:
+    - turistforeningen/slack-notifier:
+        url: $SLACK_WEBHOOK_URL
+
+npm:
+  steps:
+    # Rebuild node_modules to fix broken symlinks
+    # https://github.com/wercker/docs/issues/310
+    - script:
+        name: npm rebuild
+        code: npm rebuild
+
+    - script:
+        name: semantic release pre
+        code: npm run semantic-release -- pre
+
+    - turistforeningen/npm-publish
+
+    - script:
+        name: semantic release post
+        code: npm run semantic-release -- post
+
+    - script:
+        name: greenkeeper postpublish
+        code: npm run greenkeeper-postpublish
+
+  after-steps:
+    - turistforeningen/slack-notifier:
+        url: $SLACK_WEBHOOK_URL