feat(api): Redis 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,36 @@
+# @turbasen/db-redis
+
+[![Build status](https://app.wercker.com/status/5030e064047a362f5b19495b974190b7/s "wercker status")](https://app.wercker.com/project/bykey/5030e064047a362f5b19495b974190b7)
+[![Codacy grade](https://img.shields.io/codacy/grade/f1b04663349647a9bb7765a296c7caca.svg "Codacy grade")](https://www.codacy.com/app/Turbasen/db-redis)
+[![Codacy coverage](https://img.shields.io/codacy/coverage/f1b04663349647a9bb7765a296c7caca.svg "Codacy coverage")](https://www.codacy.com/app/Turbasen/db-redis)
+[![NPM downloads](https://img.shields.io/npm/dm/@turbasen/db-redis.svg "NPM downloads")](https://www.npmjs.com/package/@turbasen/db-redis)
+[![NPM version](https://img.shields.io/npm/v/@turbasen/db-redis.svg "NPM version")](https://www.npmjs.com/package/@turbasen/db-redis)
+[![Node version](https://img.shields.io/node/v/@turbasen/db-redis.svg "Node version")](https://www.npmjs.com/package/@turbasen/db-redis)
+[![Dependency status](https://img.shields.io/david/Turbasen/db-redis.svg "Dependency status")](https://david-dm.org/Turbasen/db-redis)
+
+Internal Redis 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 to Redis using the following configurations:
+
+* `REDIS_PORT_6379_TCP_ADDR` and `REDIS_PORT_6379_TCP_PORT`
+* Default to `redis` and `6379`
+
+```js
+const redis = require('redis');
+```
+
+## [MIT lisenced](https://github.com/Turbasen/db-redis/blob/master/LICENSE)

docker-compose.yml

@@ -0,0 +1,21 @@
+version: '2'
+
+services:
+  redis:
+    image: redis:3
+
+  node:
+    image: node:argon
+    working_dir: /usr/src/app
+    volumes:
+      - .:/usr/src/app
+    links:
+      - redis
+    depends_on:
+      - redis
+    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,8 @@
+'use strict';
+
+const Redis = require('ioredis');
+
+const addr = process.env.REDIS_PORT_6379_TCP_ADDR || 'redis';
+const port = process.env.REDIS_PORT_6379_TCP_PORT || '6379';
+
+module.exports = new Redis(port, addr);

package.json

@@ -0,0 +1,53 @@
+{
+  "name": "@turbasen/db-redis",
+  "version": null,
+  "description": "Internal Redis 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-redis.git"
+  },
+  "keywords": [
+    "nasjonal turbase",
+    "turbasen",
+    "db",
+    "redis"
+  ],
+  "author": "Hans Kristian Flaatten <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Turbasen/db-redis/issues"
+  },
+  "homepage": "https://github.com/Turbasen/db-redis#readme",
+  "dependencies": {
+    "ioredis": "^2.2.0"
+  },
+  "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,31 @@
+'use strict';
+
+const redis = require('.');
+const assert = require('assert');
+const Ioredis = require('ioredis');
+
+describe('redis', () => {
+  it('returns Redis instance', () => {
+    assert(redis instanceof Ioredis);
+  });
+
+  it('is connected to the database', done => {
+    redis.info((err, info) => {
+      assert.ifError(err);
+      assert.equal(typeof info, 'string');
+      done();
+    });
+  });
+
+  it('connects via REDIS_PORT_6379_TCP_* environment variables', () => {
+    process.env.REDIS_PORT_6379_TCP_ADDR = 'redis';
+    process.env.REDIS_PORT_6379_TCP_PORT = '6379';
+
+    delete require.cache[require.resolve('.')];
+    const redisOverEnv = require('.'); // eslint-disable-line global-require
+    assert(redisOverEnv instanceof Ioredis);
+
+    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