本エントリは iCARE Advent Calendar 2020 の19日目の記事です。
はじめに
今回作成する機能は
・Slack Appへメンションをつけてメッセージを送信
・Slack Appが自分へメンションを付けて同じ内容のメッセージを返してくる
です。
今回はSlack AppとAWS Lambda(for ruby)の連携方法がメインのためLambdaへ実装する処理自体は簡単なものにしています。
Lambda内のプログラムを修正することで色々な機能が作れると思うので参考になれば幸いです。
作成していく手順
- Slack Appの作成
- AWS Lambda(for ruby)関数の作成
- API Gatewayの作成
- Slack AppでAPIの認証とEventの設定
では作っていきます。
Slack Appの作成
以下のURLからSlackへログインします。
アプリを作成したいワークスペースのアカウントでログインしてください。
https://slack.com/signin
続いて以下のURLへアクセスします。
https://api.slack.com/apps
下のような画面が表示されるので[Create New App]をクリックします。
作成したいSlackアプリの名前を[App Name]へ入力し対象のワークスペースを選択して[Create App]をクリックします。
作成したアプリへ権限を追加していきます。
[Basic Information] - [Add features and functionality]の[Permissions]をクリックします。
[Scopes]の項目にある[Add an OAuth Scope]をクリックします。
今回は「Slack appへメンションをつけたメッセージを読み取り、そのまま返す」だけなので
[app_mentions:read]、[chat:write]の2つの権限を付与します。
Permissionについては[OAuth & Permissions]の項目からも遷移でき、後から変更も可能です。
Slackのワークスペースにinstallしていきます。
[OAuth & Permissions] - [Install to Workspace]をクリックします。
Slackのワークスペースへinstallするための確認画面が表示されるので[許可する]をクリックします。
これでワークスペースでSlack Appを使用することができます。
次に[OAuth & Permissions]の画面へ遷移するので表示されている[Bot User OAuth Access Token]をコピーして残しておきます。
LambdaからSlack App経由でメッセージを送信するために使用します。
AWS Lambda(for ruby)関数の作成
続いてAWS Lambda関数を作成していきます。
AWS Console画面よりLambdaのところへ遷移します。
[関数の作成]をクリックします。
今回は[一から作成]のまま作成していきます。
[関数名]、[ランタイム]、[アクセス権限]を設定します。
[ランタイム]はRuby2.5を指定してください。(2.5でしか動作確認していないので2.7で動作するかは分かりません)
[アクセス権限]は[基本的なLambdaアクセス権限で新しいロールを作成]にしました。
既存のロールを使う場合は[既存のロールを使用する]から選択してください。
[詳細設定]部分は特に設定していないのでこのまま[関数の作成]をクリックします。
下のような lambda_function.rb が作成されます。
この lambda_function.rb にある lambda_handler関数が実際にLambdaを呼び出された時に実行される関数です。
今回はこの処理の中にslackからイベントが通知されるのでそのparameterを解析して該当のchannelへ返すという処理を実装します。
処理は↓で公開しています。
https://github.com/Nobuo-Hirai/parrot-for-Lambda
Lambdaへのdeployは以下の手順でおこないます。
git clone git@github.com:Nobuo-Hirai/parrot-for-Lambda.git
## bundle install
## gemもLambdaのアプリケーション内に含める必要があるので vendor/bundle 配下へinsallしてください。
bundle config set --local path 'vendor/bundle'
bundle install
## zip file作成
zip -r parrot-for-Lambda.zip vendor Lambda_function.rb
zipファイルを作成したらLambdaの[zipファイルをアップロード]よりアップロードします。
(zipファイルのサイズが10MBを超えたらS3経由になります)
次にLambda functionで使用する環境変数を設定します。
設定方法は下の環境変数の[編集]より設定します。
使用する環境変数は以下の3つを設定します。
| キー | 値 |
|---|---|
| api_app_id | Slackのapi_app_id (SlackのAppページに表示されているApp ID) |
| channel_id | 呼び出し元のSlack channel id。対象のchannel以外は実行を許可しないようにする。(channel idの確認方法は該当のchannelをアプリで選択して、右クリックでリンクをコピーします。それをブラウザへ貼り付け、/archives/以降がidです) |
| slack_token | Slackのaccess token(Bot User OAuth Access Token) |
channel_idの確認方法が分かりにくいのでスクショを添付しておきます。
archives/以降の最後の部分です。
設定後は以下のようになっていると思います。
API Gatewayの作成
続いてSlackとLambdaを繋ぐAPI Gatewayを作成します。
AWS API Gatewayへ遷移して[APIを作成]をクリックします。
[新しいAPI]を選択し、[API名]へ任意の名称を入力し[APIの作成]をクリックします。
[アクション] - [メソッドの作成]をクリックします。
続いて[/ (スラッシュ)]部分をクリックして[POST]メソッドを選択します。
メソッドの設定として以下を設定し[保存]をクリックします。
統合タイプ：Lambda関数
Lambdaプロキシ統合の使用：チェックあり
Lambdaのリージョン：該当のLambda functionのリージョンを指定
Lambda関数：作成したLambda関数の名前を入力
デフォルトタイムアウトの使用：チェックあり
Lambda関数への権限追加を確認する画面が表示されるので[OK]をクリックします。
以下の画面が表示されるので[アクション]より[APIのデプロイ]を選択します。
ステージ名を入力して[デプロイ]をクリックします。(これがエンドポイントの一番最後の文字列になります)
以上でAPI GatewayとLambda関数の紐付けが完了し、APIのエンドポイントが作成されました。
[画面のURLの呼び出し]部分に表示されているURLがエンドポイントになるのでコピーして保存しておいて下さい。
Slack AppでAPIの認証とEventの設定
続いてSlack Appで作成したAPIエンドポイントの認証をおこないSlack AppへのメンションがあればAPIをcallするという設定が必要なためその対応を進めていきます。
Slack Appの画面へ戻り[Event Subscriptions]を選択します。
最初は[OFF]になっているEnable Eventsを[ON]へ変更します。
その次にRequest URLへ先ほどのAPIのエンドポイントのURLを入力しVerifiedとなればOKです。
ここではSlackからAPIエンドポイントへ疎通確認をおこなっています。
具体的には{ challenge: xxxxx }というパラメータが送信されるのでそのchallengeパラメータをそのまま返す必要があります。
これはlambaの処理で
# slackのEvent APIの認証用
if event["body"].present? && JSON.parse(event["body"])["challenge"].present?
return { statusCode: 200, body: JSON.parse(event["body"])["challenge"] }
end
という箇所で実装しています。
次にSlack AppへのメンションがあればAPIをcallするという機能を追加するため[Subscribe to bot events]の[Add Bot User Event]より[app_mention]を追加し[Save Changes]をクリックします。
以上で全ての実装は終わったので実際にSlack Appを呼び出してみたいと思います！！
@parrot [メッセージ]
を送信すると同じメッセージを返してきました！成功しましたね！
30分、、はちょっと言いすぎたかもしれないですが簡単にSlack AppとLambdaは連携できるので是非試してみて下さい！
今回は処理自体は簡単な内容でしたがlambda function内の実装を変えることで色々できて楽しそうです！
最後に
iCAREではTech Blogも毎月投稿されているので是非みてください〜！
またMeet Upも開催しているのでご興味ある方はお気軽にご参加ください！