作者ichico (细雪。)
看板Soft_Job
标题[心得] 使用Claudia.js制作Facebook机器人
时间Sat Dec 17 10:21:17 2016
Claudia.js是一个可以把Node.js/Javascript 的Microservice
简单地部署到AWS Lambda的工具。
只要一行command就会帮你处理好AWS的IAM/Lambda的设定,
甚至是BOT的configuration,非常方便。
因为这个工具目前中文的介绍似乎还不多,
所以小的想抛砖引玉先来个简单的中文介绍如何使用Claudia制作FB机器人,
请版上各位年薪千万的大大们鞭小力一点。
Blog无广告音乐好读版
http://kaoruiscoding.blogspot.tw/2016/12/claudiajsfacebook.html
以前我们常常会需要一些Web Service帮我们处理一些简单的GET/POST,
这些Web Service可能很简单并不复杂,甚至不需要UI,
不过它总是需要一个host来立足,於是你可能就必须要找一台主机,
如果是Windows的话还要有IIS
(然後忍受IIS偶尔的冲康跟无止尽的windows update)
所以当AWS推出了Lambda,身为一个Infra暴弱的Dev,真的会要给AWS一个大大的赞!
这才是真正的SASS精神啊。毕竟我们不需要为了喝牛奶而去养一头牛你说是吧。
Lamdba让程式开发人员可以专心的在程式的逻辑上面,
将每个function独立出来计费可以让阮囊羞涩的独立开发者与startup
不需要负担主机的维运费用,
并且有精美的dashboard可以统计各个function的状态,真的是非~常~的美好。
BUT,这世界上总是有个BUT,Lambda要写python/node.js方便是方便,
不过在部署的时候还是得设定IAM的Role,function才能正常运行。
如果是AWS的菜鸟(尤其是Infra跟我一样爆烂的)看到IAM的设定应该会很茫然。
於是现在就有很多Lambda的部署工具,比方说Python用的Kappa,
以及现在我想介绍的Claudia.js。
Claudia.js其实就是用AWS的Node.js framework将Lamdba的部署自动化,
IAM以及Lambda的设定都在Claudia.js当中完成。
之後如果要更新code,也只要一个指令就能完成,
而且不需要登入AWS Console,是不是很方便啊。
以下就来介绍怎麽透过Claudia.js自动部署microservice
并在Facebook上面做一个机器人。
首先你必须要申请一个AWS帐号
(不然你是要部署到哪里去),
在此就不赘述如何申请了。
设定环境
因为Claudia.js是用来Deploy Node.js的microservice,
所以你的电脑也要装Node.js
(这不是废话吗)
Node.js预设就有npm(Node.js的package管理工具)因此以下会提到npm指令,
但不需要另外安装。
安装Node.js
Windows版
Command:
sudo curl
http://nvm-latest.herokuapp.com | bash
手动安装:到官网安装最新版的Node.js
安装完後在Command line工具中执行
node -v
就可以检查Node.js是否正确安装。
Mac版
虽然Mac的Homebrew好用到令人流泪,但因为node.js版本更新非常快速,
因此推荐使用nvm安装。透过nvm安装Node可以很简单的轻松切换Node.js版本。
如果你有安装XCode,可以透过XCode来安装nvm
$ xcode-select --install
如果没有安装,可以透过curl来安装
sudo curl -o-
https://raw.githubusercontent.com/creationix/nvm/v0.32.1/install.sh | bash
在Terminal中输入nvm ls-remote找出最新的版本,
我写这篇文章时最新的版本是7.2.1
执行$ nvm install 7.2.1
$ nvm alias default 7.2.1
安装node.js
新增一个IAM使用者
1.到AWS主控台,从上方的下拉选单选择IAM服务,
进入IAM服务後选择左边的"Users" ,并按下蓝色的"Add User"
2.输入使用者名称,并勾选“Programmatic access”,
然後按下“Next:Permissions"
3.选择”Attach existing policies directly“
并在底下的policy勾选IAM Full permission / Lambda Full permission,
然後按下"Next: Review"
4.确定这个使用者有IAM Full Access 和Lambda Full Access之後,
按下”Create User“
5.按下"Download .csv"按钮可以下载这个使用者的Credential,
强烈建议要下载下来,
因为当按下close之後你就再也没有机会看到Secret access key 了,
只能重新建立一个使用者。
(都已经说了This is the last time these credentials
will be available to download.了~)
建立登入资料
这个步骤是让你在Deploy的时候不需要再输入帐号密码。
用Sublime或Notepad等纯文字编辑器打开 Mac/Linux 的 ~/.aws/credentials
或 Windows 的 C:\Users\USERNAME\.aws\credentials,加入以下指令:
[default]
aws_access_key_id = YOUR_ACCESS_KEY_ID
aws_secret_access_key = YOUR_ACCESS_SECRET_KEY
YOUR_ACCESS_KEY_ID指的是刚刚建立好的帐号中,最後一步显示的access_key_id,
YOUR_ACCESS_SECRET_KEY则是被隐藏的access Secret key.
如果刚刚没有把资料保存下来...再回去重新建立一个使用者吧
安装Claudia.js
因为已经安装好npm了,安装Claudia就是一件非常轻松简单的事情。
在Mac的Terminal或是Windows的console打入以下指令:
npm install claudia -D
Claudia就装好了。
开始写机器人罗!
初始化npm专案
1.建立一个资料夹并命名为aLittleGreeter
2.打开Mac Terminal/Windows command line tool
并移动到这个资料夹(cd aLittleGreeter)
3.初始化npm专案:输入npm init
安装套件
在写机器人之前,我们还需要安装两个npm套件
1.claudia-bot-builder:
有了这个套件,Claudia才能帮你设定和其他通讯软体
(例如Facebook, skype, slack)
2.huh:这是乱数取一个理由的npm套件,
可以在系统挂掉的时候第一时间回信给PM解释(误)
在Terminal或是Cmd输入
npm install claudia-bot-builder huh -S
即可安装这两个套件。
BOT的Code
(乡民表示:终於到写Code了)
打开你的sublime或是其他的记事本工具,输入以下的code:
const botBuilder = require('claudia-bot-builder');
const excuse = require('huh');
module.exports = botBuilder(
function(message) {
return 'Thanks for sending '+ message.text +
'Your message is very important to us, but '+excuse.get();
});
然後储存成index.js。
这是一个很简单的机器人,会把你说的话再重复一次,
然後找个理由回(ㄈㄨ)答(ㄧㄢˇ)你。
透过Claudia把Code部署上AWS
Claudia会帮你把Lambda和Role该设定的全部都设定好,
就交给Claudia部署就可以了。
只需要一个指令
claudia create --name aLittleGreeter --region us-west-2 --api-module index
name 属性: Claudia会使用name来建立IAM Role和Lamdba
region属性: 你要部署到哪个AWS的region,
在这边使用us-west-w2指的是美国的奥勒冈州。
可以参考AWS Region列表
https://goo.gl/FXWlJW
选择要部署到哪个region。
api-module属性:Lamdba程式的进入点。我们的档名是index.js,
所以将api-module设定为index,
Claudia就会将index.js的内容部署到Lamdba。
如果没有问题,就会看到Claudia一直在帮你跑AWS上面的流程了。
部署完成以後,应该会看到以下的讯息
{
"lambda": {
"role": "aLittleGreeter-executor",
"name": "aLittleGreeter",
"region": "us-west-2"
},
"api": {
"id": "
[api-gateway-id]",
"module": "index",
"url":
"
https://[api-gateway-id].execute-api.us-west-2.amazonaws.com/latest"
"deploy": {
"facebook": "
[url]facebook",
"slackSlashCommand": "
[url]slack/slash-command",
"telegram": "
[url]telegram",
"skype": "
[url]skype",
"twilio": "
[url]twilio",
"kik": "
[url]kik",
"groupme": "[url]groupme",
"viber":
"[url]viber",
"alexa": "
[url]alexa"
}
}
}
然後回到AWS的IAM 管理介面,选择Role,
可以看到Claudia已经帮你建好一个Role了。
再切到AWS的Lambda管理介面,发现Claudia也建好Lambda的函数了。
这样AWS的部署就已经完成了。有没有很方便呀。
设定Facebook粉丝专页机器人
OK,我们已经部署完AWS的部份了,接下来是Facebook的设定。
1.先建立一个粉丝专页
2.到Facebook Developer应用程式开发页面,
如果之前没有注册成为Facebook Developer,
应该会先看到"立即注册"的按钮,按下立即注册成为Facebook Developer。
3.按下“新增应用程式”,类别选择“专业应用程式”,
取好名字以後选择“建立应用程式编号"
4.建立好之後会到这个应用程式的主控台,
在产品设定中按下Messanger区块旁的"开始使用"
5.在"权杖产生"中,先选择先前建立好的粉丝专页,
在旁边的粉丝专页存取权杖中会显示一组权杖,先记录下来。
6.这时我们要在Claudia设定与Facebook连动,
回到电脑的Terminal或是Cmd Console,打入以下指令:
claudia update --configure-fb-bot
Claudia会将Code重新部署,部署完後会出现以下的回应:
Facebook Messenger setup
Following info is required for the setup,
for more info check the documentation.
Your webhook URL is:
https://[api-gateway-id].execute-api.us-west-2.amazonaws.com/latest/facebook
Your verify token is: [verify Token]
Facebook page access token:
Claudia询问的Facebook page access token,
就是刚刚Facebook应用程式中粉丝专页的权杖,将刚刚复制好的权杖贴入Terminal
接着Claudia会询问Facebook App Secret,
到应用程式中选择“主控台”,在主控台中找到"应用程式秘钥",
按下显示後,将内容贴到Terminal
到这边AWS端的连动已经设定完成,接下来回到Facebook应用程式
到"Webhooks"区段中选择“Setup Webhook”
填写Webhook资讯:
回呼网址:填上Claudia回应中的deploy->facebook区段中的内容,
通常是
https://[api-gateway-id].execute-api.us-west-2.amazonaws.com/latest/facebook
验证权杖:在刚刚打入claudia update --configure-fb-bot的时候,
Claudia的回应中有一段 Your verify token is: [verify Token],
填入这个verify token
订阅栏位:至少要勾选messages
储存之後,就可以看到Webhooks区段有绿色勾勾,代表已经设定完毕
然後就可以尝试传送讯息给你的粉丝专页了
茶包射手
*部署的时候出现npm error
检查一下Code有没有写错,或是需要的npm套件没有安装。
*部署的时候出现AccessDeniedException
检查IAM的使用者是否已经有IAM和Lambda的Full permission
*出现package.json does not exist in the source folder
通常是因为没有执行npm init,可以再执行一次让npm产生package.json
部署失败,
出现Make sure you have the latest version of node.js and npm installed.
这是因为Node.js太旧了,
如果Mac有安装Homebrew只要透过Homebrew更新就可以了
brew upgrade node
如果没有Homebrew,可以透过npm清除Node.js的Cache并下载最新版:
sudo npm cache clean -f
sudo npm install -g n
sudo n stable
Windows的使用者也可以透过npm来更新node.js
npm cache clean
npm update -g
*我想更新我的Code,重新执行Claudia出现这样的讯息:
Role with name aLittleGreeter-executor already exists.
这是因为重复执行Claudia create。
Claudia create会自动建立AWS的IAM Role和Lamdba,
而名字是identity不能重复的。
所以如果要更新Code或是设定其他的组态(像是Facebook连动),
请用Claudia update.
如果想要更新的不是只有Code本身,像是想要换AWS的region,
那麽只能将建立好的IAM Role, Lamdba等等都先手动删除再执行Claudia create。
Facebook机器人不会回应我的朋友
这是正常的,这个机器人目前只会回应你而已,
当全部开发完成之後会需要提交给Facebook审查,
可以参考Facebook的审查说明。
https://developers.facebook.com/docs/messenger-platform/app-review
人工审查需要七天左右,审查通过其他人才可以用。
--
※ 发信站: 批踢踢实业坊(ptt.cc), 来自: 1.164.205.197
※ 文章网址: https://webptt.com/cn.aspx?n=bbs/Soft_Job/M.1481941288.A.9D7.html
1F:推 jerry771210: 太威了 12/17 10:50
2F:推 lipojack: 推 12/17 11:38
3F:推 jjwei: push! 12/17 12:46
4F:推 MagicTouch: 感谢分享~ 12/17 12:48
5F:推 Ekmund: 喔喔这个赞 12/17 12:53
6F:推 blackcan: 感谢分享 12/17 12:57
7F:推 wddx: 感谢大大分享! 12/17 13:09
8F:推 saivantist: 赞赞 12/17 13:45
9F:推 SmallDruid: 好玩欸 12/17 14:02
10F:推 jimmy689: 家豪推 12/17 14:34
11F:推 ZC: 感谢 12/17 15:08
12F:推 ian90911: 推 12/17 17:40
13F:推 drajan: 赞 12/17 22:40
14F:推 xxhomey: 推 12/17 22:45
15F:推 srxrrr: 推推!!!! 12/17 23:46
16F:推 NvidiaCUDA: 推 12/17 23:47
17F:推 jay123peter: 推 12/18 02:07
18F:推 bruce723: 推 12/18 09:21
19F:推 yongb: PUSH 12/18 14:54
20F:→ viper9709: 推~感谢分享 12/18 16:58
21F:推 vidcina: 把朋友加到粉丝页面的tester就可以收到了 12/19 10:11
22F:推 kyocartoon: 推 12/19 19:05
23F:推 yuanyu90221: 推 12/19 22:23
24F:推 markbex: 感谢原po!! 12/21 19:01
25F:推 youccu: 谢分享 12/22 10:01