Hubot-cm NPM | npm.io

Description

This is the COMPANY Messenger adapter for hubot.

Installation

1. Install the hubot generator

You will need node.js and npm. Once those are installed, we can install the hubot generator.

    $ npm install -g yo generator-hubot

This will give us the hubot yeoman generator.

2. Install the hubot

Now you can make a new directory, and generate a new instance of hubot in it, using this COMPANY Messenger adapter.

    $ mkdir myhubot
    $ cd myhubot
    $ yo hubot --adapter cm

You will be asked a few questions about the bot you are creating. When you finish answering, yeoman will download and install the necessary dependencies.

3. Configure environment variables

COMPANY Messenger adapeter uses the following environment variables.

HUBOT_CM_HOSTNAME The host name you want to connect to.
HUBOT_CM_API_KEY Bot user's API key.
HUBOT_CM_SECRET_KEY Bot user's secret key.
HUBOT_CM_API_RATE Request frequency per hour.

You will need to configure these environment variables in your hubot's bin/hubot.

    export HUBOT_CM_HOSTNAME="xxx.lakeel.com"
    export HUBOT_CM_API_KEY="api_key"
    export HUBOT_CM_SECRET_KEY="secret_key"
    export HUBOT_CM_API_RATE="1800"