hubot is a chat bot built on the Hubot framework. It was initially generated by generator-hubot, and configured to be deployed on Heroku to get you up and running as quick as possible.
This README is intended to help get you started. Definitely update and improve to talk about your own instance, how to use and deploy, what functionality he has, etc!
You can test your hubot by running the following, however some plugins will not behave as expected unless the environment variables they rely upon have been set.
You can start hubot locally by running:
% bin/hubot
You'll see some start up output and a prompt:
[Sat Feb 28 2015 12:38:27 GMT+0000 (GMT)] INFO Using default redis on localhost:6379
hubot>
Then you can interact with hubot by typing hubot help
.
hubot> hubot help
hubot animate me <query> - The same thing as `image me`, except adds [snip]
hubot help - Displays all of the help commands that hubot knows about.
...
A few scripts (including some installed by default) require environment variables to be set as a simple form of configuration.
Each script should have a commented header which contains a "Configuration" section that explains which values it requires to be placed in which variable. When you have lots of scripts installed this process can be quite labour intensive. The following shell command can be used as a stop gap until an easier way to do this has been implemented.
grep -o 'hubot-[a-z0-9_-]\+' external-scripts.json | \
xargs -n1 -I {} sh -c 'sed -n "/^# Configuration/,/^#$/ s/^/{} /p" \
$(find node_modules/{}/ -name "*.coffee")' | \
awk -F '#' '{ printf "%-25s %s\n", $1, $2 }'
How to set environment variables will be specific to your operating system. Rather than recreate the various methods and best practices in achieving this, it's suggested that you search for a dedicated guide focused on your OS.
An example script is included at scripts/example.coffee
, so check it out to
get started, along with the Scripting Guide.
For many common tasks, there's a good chance someone has already one to do just the thing.
There will inevitably be functionality that everyone will want. Instead of writing it yourself, you can use existing plugins.
Hubot is able to load plugins from third-party npm
packages. This is the
recommended way to add functionality to your hubot. You can get a list of
available hubot plugins on npmjs.com or by using npm search
:
% npm search hubot-scripts panda
NAME DESCRIPTION AUTHOR DATE VERSION KEYWORDS
hubot-pandapanda a hubot script for panda responses =missu 2014-11-30 0.9.2 hubot hubot-scripts panda
...
To use a package, check the package's documentation, but in general it is:
- Use
npm install --save
to add the package topackage.json
and install it - Add the package name to
external-scripts.json
as a double quoted string
You can review external-scripts.json
to see what is included by default.
It is also possible to define external-scripts.json
as an object to
explicitly specify which scripts from a package should be included. The example
below, for example, will only activate two of the six available scripts inside
the hubot-fun
plugin, but all four of those in hubot-auto-deploy
.
{
"hubot-fun": [
"crazy",
"thanks"
],
"hubot-auto-deploy": "*"
}
Be aware that not all plugins support this usage and will typically fallback to including all scripts.
Before hubot plugin packages were adopted, most plugins were held in the hubot-scripts package. Some of these plugins have yet to be migrated to their own packages. They can still be used but the setup is a bit different.
To enable scripts from the hubot-scripts package, add the script name with
extension as a double quoted string to the hubot-scripts.json
file in this
repo.
If you are going to use the hubot-redis-brain
package (strongly suggested),
you will need to add the Redis to Go addon on Heroku which requires a verified
account or you can create an account at Redis to Go and manually
set the REDISTOGO_URL
variable.
% heroku config:add REDISTOGO_URL="..."
If you don't need any persistence feel free to remove the hubot-redis-brain
from external-scripts.json
and you don't need to worry about redis at all.
Adapters are the interface to the service you want your hubot to run on, such as Campfire or IRC. There are a number of third party adapters that the community have contributed. Check Hubot Adapters for the available ones.
If you would like to run a non-Campfire or shell adapter you will need to add
the adapter package as a dependency to the package.json
file in the
dependencies
section.
Once you've added the dependency with npm install --save
to install it you
can then run hubot with the adapter.
% bin/hubot -a <adapter>
Where <adapter>
is the name of your adapter without the hubot-
prefix.
% heroku create --stack cedar
% git push heroku master
If your Heroku account has been verified you can run the following to enable and add the Redis to Go addon to your app.
% heroku addons:add redistogo:nano
If you run into any problems, checkout Heroku's docs.
You'll need to edit the Procfile
to set the name of your hubot.
More detailed documentation can be found on the deploying hubot onto Heroku wiki page.
If you would like to deploy to either a UNIX operating system or Windows. Please check out the deploying hubot onto UNIX and deploying hubot onto Windows wiki pages.
If you are using the Campfire adapter you will need to set some environment variables. If not, refer to your adapter documentation for how to configure it, links to the adapters can be found on Hubot Adapters.
Create a separate Campfire user for your bot and get their token from the web UI.
% heroku config:add HUBOT_CAMPFIRE_TOKEN="..."
Get the numeric IDs of the rooms you want the bot to join, comma delimited. If
you want the bot to connect to https://mysubdomain.campfirenow.com/room/42
and https://mysubdomain.campfirenow.com/room/1024
then you'd add it like
this:
% heroku config:add HUBOT_CAMPFIRE_ROOMS="42,1024"
Add the subdomain hubot should connect to. If you web URL looks like
http://mysubdomain.campfirenow.com
then you'd add it like this:
% heroku config:add HUBOT_CAMPFIRE_ACCOUNT="mysubdomain"
You may want to get comfortable with heroku logs
and heroku restart
if
you're having issues.
From a Sumologic dashboard widget, be able to display it as an image
Step one : Target the good widget For now we can't do it easily while the dashboard API from Sumologic is broken. For now we should link manually id to widget 😢
Step two : Transform widget data to graph
Thanks to jsdom and highcharts we can transform what sumologic return to a graph. This process will be manual in a first time for testing purpose, then a bit industrialize to display all widget possible. Sumologic seems to use highcharts for rendering their widget, so this part shouldn't be hard...
Step three : Transform svg graph to image
For now we will use svg2png, it use phamtomjs in background for extract png from svg. Not the nicer solution but the easiest for now. Other lib are only wrapper of lower image libs. Maybe this latest solution is faster than the previous and we should consider it on long term maybe. But this one is harder to implement and depend on which OS the hubot will run.
Step Four : Host/Send the img to slack
At first sight, Hubot should send image generated. Not the hardest part, seems slack api have what we need to do it ! We just need to implement that part and we should be done !
Could send it to a third part and just send link in a channel to.
// Will launch the test bouzin !
coffee ./scripts/hubot-sumologic-image-widget/main.coffee
// Will launch the gist test bouzin !
node ./scripts/hubot-sumologic-image-widget/gist.js
- Tests the all chain !
- Use real data from sumologic widget
- Implement some highchart adapters depending of widget
- Add Hubot hear for this dev
- Test on a true slack
- Graph can be built on highchart or svg template
- Split how work graph builder for allowing multiple implementation
- Base on graph type
- Use promises !
- Break callback hell into promise composition
- Clean generated image file
- Auto find tmp file
- Use it
- Style graph
- Learn hubot to learn
- Learn from a json file (brain used)
- Allow to erase memory via a command
- Clean && Tidy && Refactor if needed
- Clean todo's
- SendToSlack (ensure work for common cases)
- Package it !
- Boulangerie repo
- Issues followings subjects
- Millestone them ?
- Readme
- Npm publish
- Boulangerie repo
POC on fact hubot can get a json file through slack Can be a link to file but it's less safer Finally we can brainwash hubot if we want ! Maybe if sumologic fix their API we could use it properly and avoid a lot of this stuff
Some of this feature have already been done. But this part of this package could improved a bit more
- [] Erase brain should be possible only by some users
- [] Should list all widget available...
- [] Should add/update/remove unitary by a command
Instead of using dashboard data, use true results from a custom query. The naive way should to transform query results into dashboard data format. Like this graphs implementation should work as expected without no update on it.
We should use the same hubot command, but hubot have to warn user the result could not come as quickly as a widget result
- Associate a query with a name and a graph type
- Implement logic to transform sumo data into something usable for graph
- Add hubot behavior
- (Depending of : Learn hubot to learn) Update or consider it
- Missing infos
- Time range of current graph
- Missing graph
- Donuts
- Text percentage
- Filled line chart
- Upgrade logic behind how we format rawData from sumo (to dumb for now)
- Style should be configurable
- Apply Color rules on some of them when sumo will give us that details
- Implement a true logger to see what hubot do
Instead of using promise of folder, use it or flag, this could avoid problem with promise. Other solution should be to create it at module install
- Spec it :)
- Find a way to delete what hubot send to slack
- Make this part of hubot more customisable via brain of something (theme ?)