开发Hubot聊天机器人

大家所熟知的智能聊天机器人，比如：微软小冰、Apple Siri、Google Now、IBM Watson等。微信自动回复、微信服务号里的客服Bot也都算是简单的实例。聊天机器人（Dialog System）主要实现方式有：基于人工模板（比如AIML）、基于搜索技术（比如ElasticSearch）、基于深度学习。从零实现这样的系统是很复杂的。

开源的ChatOps机器人：
1.Hubot：CoffeeScipt编写
2.Lita：Ruby编写
3.Errbot：Python编写

So, What is ChatOps? And How do I Get Started?
12+ Frameworks to Build ChatOps Bots

Hubot是由Github开发的开源聊天机器人，基于Node.js采用CoffeeScript编写。
Hubot https://hubot.github.com/
Hubot Scripts https://github.com/hubot-scripts
Hubot Control https://github.com/spajus/hubot-control

可以借助Hubot开发Chatbot来自动化的完成想要一切自动化任务，比如：
-运维自动化（编译部署代码、重启机器，监控服务器运行情况，自动修复Bug等）
-外部服务交互（管理Redmine、集成Jenkins、监视Zabbix等）
-定时获取天气预报
-随机订餐
-聊天机器人等等。

官方文档里有详细的使用说明，https://hubot.github.com/docs/，这里只做一个摘要。
Hubot Scripts里有大量的现成脚本可以用，也是自己编写脚本的最好sample。

（一）安装
运行Hubot需要以下软件支持：

• Node.js
• Redis 默认存贮数据
• CoffeeScript
• Yeoman
• generator-hubot 生成Hubot骨架工程

（二）创建自己的bot

默认提供了campfire和shell的adapter，其他的需要通过npm下载hubot-<AdapterName>。
也可以通过参数直接生成：

项目结构：

• bin/ 运行脚本
• node_modules 应用的包文件
• scripts 存放自定义脚本
• external-scripts.json 应用的外部脚本
• hubot-scripts.json *** 该文件已经无用，可以删除
• package.json 项目全局配置信息

（三）运行bot

-a 指定Adapter（默认是shell）
-d 关闭HTTP服务（默认是开启的）
-c deprecated 使用yeoman

采用默认的shell adapter

指定adapter

***所有的输入都会被记录在.hubot_history文件里。

（四）编写脚本
编写的自定义脚本要放在scripts中，可以是.coffee或.js文件。

scripts/hello.coffee

Js代码  

1. # Description:
2. #   This is a test.
3. #
4. # Commands:
5. #   okbot helo – Reply with world!
7. module.exports = (robot) ->
8.   robot.respond /hello/i, (msg) ->
9.     msg.send “world!”

因为Hubot要解析脚本文件，提供help帮助，所以脚本文件开头的注释是规范的，
第一行必须是注释“# Description:”(其他的可以没有)，否则会有警告：

Hubot同时也支持js，比如：
scripts/hello2.js

Js代码  

1. // Description:
2. //   This is a test2.
3. // Commands:
4. //   okbot helo – Reply with world!
6. module.exports = function(robot) {
7.     robot.respond(/hi/i, function(msg){
8.         msg.send(“world2!”);
9.     });
10. }

Respond vs Hear

• respond只监听直接发送给机器人的消息,需要指定机器人名称
• hear可以监听任何消息

Send vs Reply

• send会将消息发送给所有人
• reply会将消息回复给指定的人

Random
msg对象有一个random方法，可以从之后的数组对象中随机提取一个元素

hubot Scripts Explained
http://theprogrammingbutler.com/blog/archives/2011/10/28/hubot-scripts-explained/

（五）安装脚本
Hubot 有一大堆现成的脚本，可以集成各种服务。

将package-name添加到external-scripts.json

（六）hubot-script实例

定时脚本
scripts/cron.coffee

Js代码  

1. cronJob = require(‘cron’).CronJob
3. module.exports = (robot) ->
4.   send = (room, msg) ->
5.     response = new robot.Response(robot, {user : {id : -1, name : room}, text : “none”, done : false}, [])
6.     response.send msg
8.   new cronJob(‘0 * * * * *’, () ->
9.     currentTime = new Date
10.     send ‘#your-channel-name’, “current time is #{currentTime.getHours()}:#{currentTime.getMinutes()}.”
11.   ).start()

http请求
scripts/googleGEO.coffee

Js代码  

1. module.exports = (robot) ->
2.   robot.hear /location (.*)/, (msg) ->
3.     request = robot.http(“https://maps.googleapis.com/maps/api/geocode/json”)
4.                    .query(address: msg.match[1])
5.                    .get()
6.     request (err, res, body) ->
7.       json = JSON.parse body
8.       location = json[‘results’][0][‘geometry’][‘location’]
10.       msg.send “#{location[‘lat’]}, #{location[‘lng’]}”

抓取数据(request, cheerio)
scripts/title.coffee

Js代码  

1. request = require ‘request’
2. cheerio = require ‘cheerio’
4. module.exports = (robot) ->
5.   robot.respond /title (.*)/i, (msg) ->
6.     url = msg.match[1]
7.     options =
8.       url: url
9.       timeout: 2000
10.       headers: {‘user-agent’: ‘node title fetcher’}
12.     request options, (error, response, body) ->
13.       $ = cheerio.load body
14.       title = $(‘title’).text().replace(/\n/g, ”)
15.       msg.send(title)

http应答(httpd)
scripts/version.coffee

Js代码  

1. module.exports = (robot) ->
2.   robot.router.get “/version”, (req, res) ->
3.     res.end robot.version

访问http://localhost:8080/version。
默认端口是8080，可以修改环境变量:export PORT=8080

Hubot大量依赖环境变量来配置脚本，所以一般都做一个启动脚本：

脚本中的使用：

捕获所有未处理信息
scripts/catchAll.coffee

Js代码  

1. module.exports = (robot) ->
2.   robot.catchAll (res) ->
3.     res.send “Nothing Found：#{res.message.text}”

hubotスクリプトの書き方とサンプル集
http://blog.fumiz.me/2012/08/05/hubot-irc-bot-script/
编写 Hubot Scripts
http://scarletsky.github.io/2016/05/02/write-your-own-hubot-scripts/

（七）自定义Adapter
hubot默认提供两种adapter：shell、campfile
shell用于开发调试，campfile以外的Chat Service也都有开源的实现。

Adapter基本构成

新建文件 \node_modules\hubot\src\adapters\SampleAdapter.coffee

Js代码  

1. class SampleAdapter extends Adapter
3.   send: (envelope, strings…) ->
4.     @robot.logger.info “Send”
6.   run: ->
7.     @robot.logger.info “Run”
9. exports.use = (robot) ->
10.   new SampleAdapter robot

修改文件 \node_modules\hubot\src\robot.coffee

启动bot

* 所有的Adapter必须继承自Adapter
* Adapter中最重要的两个方法是send和run，其他方法比如emote、reply、topic、play等在特定场景下才需要。
* run方法是bot启动时执行
* send方法是回复信息时执行
* 父类 adapter.coffee 里有详细的方法说明 https://github.com/github/hubot/blob/master/src/adapter.coffee
* Adapter名必须是：src\adapters里的文件名 & robot.coffee的HUBOT_DEFAULT_ADAPTERS里定义的名 或者和 hubot-#{adapter} 一致

Chat服务的Adapter

Js代码  

1. {Adapter, TextMessage} = require ‘hubot’
2. {EventEmitter} = require ‘events’
4. class MyChatAdapter extends Adapter
5.   send: (envelope, strings…) ->
6.     @bot.send str for str in strings
8.   run: ->
9.     options =
10.       token:   process.env.HUBOT_CHAT_TOKEN
11.       rooms:   process.env.HUBOT_CHAT_ROOMS
12.       account: process.env.HUBOT_CHAT_ACCOUNT
14.     bot = new MyChatStreaming options, @robot
16.     bot.on ‘message’, (userId, userData, message) ->
17.       user = @robot.brain.userForId userId, userData
18.       @receive new TextMessage user, message
20.     bot.listen()
22. exports.use = (robot) ->
23.   new MyChatAdapter robot
25. class MyChatStreaming extends EventEmitter
26.   constructor: (options, @robot) ->
27.     @token         = options.token
28.     @rooms         = options.rooms.split(“,”)
29.     @account       = options.account
31.   send: (message) ->
32.     # Send data to your chat service
34.   listen: ->
35.     # Get messge data from chat service
36.     # @emit ‘message’, user, message

具体可以参考： https://github.com/github/hubot/blob/master/src/adapters/campfire.coffee

扩展robot的方法：
\node_modules\hubot\src\adapters\incircle.coffee

Java代码  

1. class TestXXX extends Adapter
2.   constructor: (robot) ->
3.     super robot
4.     robot.hearXXX = (options, callback) ->
5.       robot.listeners.push new TextListener(robot, “@XXXmessage”, options, callback)

\scripts\testbot.coffee

Java代码  

1. module.exports = (robot) ->
2.   robot.hearXXX (msg) ->
3.     msg.send “#{JSON.stringify msg}”

（八）微信adapter
https://github.com/KasperDeng/Hubot-WeChat

主要机制是hack网页版微信协议，先用手机登录微信帐号，然后模拟网页版微信登录，这样就可以接受微信消息了。

• npm install hubot-weixin –save
• 手机端登录微信
• 打开网页微信：web.weixin.qq.com
• 手机扫描登录
• 控制台查看如下信息 /node_modules/hubot-weixin/config.yaml

cookie: Uin: Sid: Skey: DeviceID:

• bin\hubot.cmd -n bot -l / -a weixin

参考：
正在吃掉世界的Bot：它从哪里来，会到哪里去？
Hubot：来自GitHub的聊天机器人
GitHub社謹製！ bot開発・実行フレームワーク「Hubot」
TDD Hubot scripts with gulp+mocha
在Skype中使用Hubot
http://qiita.com/bouzuya/items/c7d0ad80c357aab6b696

Tags: chatopsdevops