Lambda for Ruby を使って勤怠ボタンを作ってみた
概要
弊社では勤怠の管理に jobcan というサービスを利用しています。slack連携で特定のコマンドを入力すると出勤・退勤ができるっていうグッドでナイスな感じなんですが、もはや出勤時に文字を打つのすらめんどいということで、せっかくなので先日発表された「AWS Support for Ruby」を利用して更に楽に出勤してみるをしてみます。 ### 仕組み すでに下記とほぼ同内容の仕組みが IFTTT 版で動いてるためその時にpythonで書いてたものをrubyでやってみるという感じです。 [embed]http://uskey.hatenablog.com/entry/2018/10/17/115728[/embed] #### やりたいこと オフィスのドアを開ける → ポケットからiPhoneを取り出す → IFTTT Button を押す → AWS API Gatewayで設定したURLにPOSTする → フックされた Lambda が動く→ slack にcommand を投稿する → jobcan連携が飛ぶ → 出勤！ をオフィスに入ってから自席につくまでにやる、です。 #### 手順 下記の手順でやったことを書いていきますが、IFTTTのアカウント作成はたぶん興味ある人いないと思うし、AWSのアカウントも迷うことなく登録できると思うし、太字のところから書いていこうと思います。 - IFTTTアカウントを作成する - AWSアカウントを作成する - Rubyコードを書く - lambdaの準備 - IFTTT ボタンの設定 - 実行
Rubyコードを書く
ハマりどころ
Rubyでslackに投稿するコードを書いていきます。上に上げたリンクにも書いてあるんですが2つほど注意点があります。 1つ目は、「レガシートークンを使う」です。今回の投稿はslackの連携commandを使うので本人の投稿として認識させる必要があります。そのためIncomming Webhookが使えません。 2つ目は、「ドキュメントに記載されてないAPIの chat.command にあたる命令をする必要がある」です。今回 以下のgemを使ってますが、公式のドキュメントに記載がないAPIなのでこのgemのリファレンスにも乗ってないコマンドだったりします。 [embed]http://uskey.hatenablog.com/entry/2018/10/17/115728[/embed] どちらも公式が推奨してない感じがプンプンしているので、いつか使えなくなる日が来るかも知れないんですがその頃にはjobcanさんがAPIを公開していただけるとありがたいです。出勤だけでいいので。
#### コード
さて、コードはこんな感じです。 https://gist.github.com/katsumata-ryo/f6c5c4736a58a3510e737681ae6cb68f#file-gemfileコードのとおりなのですが、注意点としては
- lambdaのコード実行のスタートが lambda_fucntion.rbの def lambda_handler から実行されます。そのためこれがないとlambdaにファイルを上げた時に警告がでます。
- 3行目: lambdaは環境変数が登録できるのでトークンは環境変数に登録してます
- 12行目: client.chat_command が先程のドキュメントに載ってないAPIのメソッド
- 13行目: 投稿チャネル
- 14行目: jobcanの出勤するスラック連携のコマンドtextだと文章として認識してしまうため、別にcommandで指定する必要があります。
- 16行目: as_user: true で本人としてslackに投稿ができるようになります。
という感じです。非公式コマンドのところは参考にしたサイトを見つけられなかったら確実に諦めてた案件でした。 ### lambdaの準備
アップロードファイルの準備
lambdaの準備をしていきます。今回外部ライブラリを使用しているので、AWS lambdaのエディタを使うことができません。そのためzipにしてファイルをアップロードする必要があります。また、今回は4.3MBぐらいだったので必要なかったんですが、10MBを超えるとlambdaでのアップロードができません。その場合はS3にアップロードをする方向で対応してみてください(参考: Announcing Ruby Support for AWS Lambda)。 bundle installしてローカルにgemを用意する
$ bundle install
$ bundle install --deployment # ./vender/bundle にgemが入る
ファイルツリーの様子
./
├── Gemfile
├── Gemfile.lock
├── lambda_function.rb
└── vendor # gem が入ってる
ファイル構造がこんな感じになっているはずなので、この4つを選択してzipファイルにしてあげてください。
#### AWSでlambdaの作成
AWSでlambdaを作っていきます。 lambdaのページを開いて関数の作成を押す。
一から作成で項目を入力しランタイムでRubyを選択する。2018/12/02時点だと ruby2.5 のランタイムのみ用意されているようですね。
以下のような画面が出てくると思うので(※画面はすでに動いてる関数のものなので実際の画面とは異なります)、一番上のファイル名のところが選択されている状態になっているとページの下部に関数コードの編集画面が出ていると思います。
コードエントリタイプで.zipファイルをアップロードを選択し、先程zipに固めたファイルをアップロードします。アップロード選択し終わったらページ上部の保存を押すようにしてください。毎回忘れてあれ？ってなる。今回ライブラリを含んでいるので下記画像のようなinfoが出ていて、インラインコードの編集はできなくなってる。
次に環境変数の登録です。書いたコードに合わせて環境変数を登録します。値にしてしているのは、先程のslackのレガシートークンです。
最後にAPI Gatewayの設定をします。ない人はトリガーの追加からAPI Gatewayの設定を行ってください。
ここで作ったAPI エンドポイントが IFTTT Buttonで登録する値になります。 ちなみにlambdaはメソッドの投稿テストができるので、実際に全体で動かして見る前に関数のテストを試せるので便利です。
IFTTT Buttonの設定
あとは特に説明するほどではないのでキャプチャだけ。設定はbuttonからwebhookです。
で、iPhoneの方でIFTTTのアプリをダウンロードしてボタンを設定してあげるとこのような感じに。
これで準備完了です！(実装中に一回間違えてボタンを押してしまって、出勤してしまったため勤怠修正申請しなきゃいけない…)
### 実行
ボタンを押すとslackの投稿がこんな感じでされてよっしゃ。
以上lambda for ruby を使った勤怠ボタンの作成でした。 lambda for rubyですが個人的に待望の機能追加でずっと待ってたので先日の発表は歓喜でした。サーバ上から何かを実行し用とすると環境の準備がネックになって作るのやめっちゃったりとかのハードルがぐっと下がりそう。簡単なwebアプリケーションも動かせたりと夢が広がりまくりな感じがあるので、lambda for ruby 活用していきたいところ。
#### 参考リンク