redis2go v1.0.2

Redis2Go

This is a implementation of a subset of Redis commands. In particular:

1. SET key value
2. SET key value EX seconds (need not implement other SET options)
3. GET key
4. DEL key
5. DBSIZE
6. INCR key
7. ZADD key score member
8. ZCARD key
9. ZRANK key member
10. ZRANGE key start stop

Lightweight Architecture Decision Records

We use ADRs, so major decisions are justified and put on context for future consideration.

• Architecture
• Promises
• Hapi

Installation in your Project

You'll need Node v6.10.3 and npm. This packaged it's published on NPM, so you can add it to your JS projects.

npm install redis2go --save

Usage Example

const Redis2Go = require('./redis2go')
const client = new Redis2Go()

client.set(100).then(result => console.log(result)) // 'OK'


client.get('my_key').then(result => console.log(result)) // '100'
 

JS API of Available Commands

For behavior of each command, check the Command Reference.

GET

 get(key) -> Promise

SET

 set(key, value, expiration_time) -> Promise

DEL

 del(...args) -> Promise

INCR

 incr(key) -> Promise

DBSIZE

 dbsize() -> Promise

ZADD

 zadd(key, [... order, value]) -> Promise

ZCARD

 zcard(key) -> Promise

ZRANK

 zrank(key, value) -> Promise

ZRANGE

 zrange(key, start, end) -> Promise

Server

To start a server instance:

npm run start

You can specify which port to run by setting the environment variable PORT, by default it will run in the port 3000.

Command Mode

You can run raw commands with query parameters:

curl localhost:8080/?cmd=SET%20mykey%20cool-value
OK
curl localhost:8080/?cmd=GET%20mykey
cool-value
curl localhost:8080/?cmd=DEL%20mykey
OK
curl localhost:8080/?cmd=GET%20mykey
(nil)

HTTP API

For a more idiomatic way of communicating with Redis2go, we have a Full Rest API.

Make sure to add Content-Type: text/plain as it is the data type that the API will consume.

ADD

method: 'PUT',
path: '/{key}',

GET

method: 'GET',
path: '/{key}',

DELETE

method: 'DELETE',
path: '/{key}',

DBSIZE

method: 'GET',
path: '/dbSize',

INCR

method: 'PUT',
path: '/{key}/incr',

ZADD

method: 'PUT',
path: '/{key}/zadd',

ZCARD

method: 'GET',
path: '/{key}/zcard',

ZRANK

method: 'GET',
path: '/{key}/zrank/{value}'

ZRANGE

method: 'GET',
path: '/{key}/zrange/{start}/{end}',

Example

curl -X POST -H "Content-Type: text/plain" --data "cool-value" -X PUT localhost:3000/mykey

Tests

To run unit tests, clone this repo and run the following:

npm install
npm run test

To run integration tests:

npm install
npm run start

#different terminal, run the tests
npm run integration-tests