Edited at

Slack + GASで社内仮想通貨取引所を実装 Part1

More than 1 year has passed since last update.


概要

社内コミュニケーションの活性化やモチベーションアップに利用される社内通貨を、Slack上でやり取りできるようにする。


背景

昨今、いくつかの企業で社内通貨を導入して、社員同士の交流を深めたり、貢献度を見える化したりする取り組みがあります。確かにぼくも普段、仕事のお世話になったメンバーに対してブラックサンダーをお布施するなどしていますが、特に切羽詰っているときは先送りになってしまったり、それほどではないものの、軽い感謝の気持ちを何かSlackのEmoji以外で表現できないかと思っていました。

ただ、その社内通貨のためにServerからFrontまで実装するのは大変ですし、普段のコミュニケーションツールと別個にシステムが存在するのも利便性を損なうということから、SlackSlash CommandGoogle Apps Scriptを組み合わせて簡単な仮想通貨取引ツールを作成しました。


成果物

口座を作って、

image.png

ユーザーを指定して送金して、

図2.png

残高確認 :v:

image.png


実装解説


全体構成

全体の構成図はこんな感じです。

image.png

SlackのSlash Commandを利用するので、そのAPIの受け口用にGASを利用するという構成になっています。認証周りに関しては 「Slash CommandsとGASでSlackのオリジナルコマンドをつくる」 がとてもわかりやすく参考になります。

基本的なPost処理に関してはそちらの記事に書いてあるので、ここではどのようにGASからGoogle Sheetsを操作したのかについて述べたいと思います。


Google Sheetsの触り方

口座を管理するシートは以下のようなユーザー名と残高のみを保持した簡単な構成です。

image.png

Google SheetsをGASから触るときにはSpreadsheetAppを利用するのが良いです。公式ドキュメントを読むと他のやり方もいろいろとあり混乱しますが、とにかくこれが一番書きやすかったです。そして、以下の要領でSheetにアクセスできるようになります。


Utilities.gs

function getLedger() {

/*
Return Google Sheets storing balance of users.
*/

return SpreadsheetApp.openById(PropertiesService.getScriptProperties().getProperty("SHEETID")).getSheets()[0]
}

SheetIDは「File > Project properties > Script Properties」に登録しておくと、コードが汎化するのでうま味です。

そして、Sheetへの入出力は基本sheet.getRangeで領域を選択してから、そこに対してgetterとsetterを適用するという流れになります。Indexは1-originなので、普段MATLABでも使っていない限り注意してください。

なので、この場合は


  1. 対象ユーザーのSheet上でのIndexを走査して探す

  2. そのIndexの残高カラムに対してgetter及びsetterを適用する

という形で行っています。


Sheetの走査


Utilities.gs

function getUserIndex(users) {

/*
Return associative array of {"user": "index in Google Sheets"}.
If not found, the value becomes NaN.
*/

const sheet = getLedger()
const memberList = sheet.getRange(2, 1, sheet.getLastRow() - 1, 1).getValues()

// Find user from "users" and push them to "userIndex" associative array
const userIndex = {}
for (var u in users) {
userIndex[users[u]] = NaN // Set default value
for (var m in memberList) {
if (users[u] === memberList[m][0]) { // User found in the member list
userIndex[users[u]] = parseInt(m) + 2 // +2 because the sheet has the header row and Google Sheet is 1-origin.
}
}
}
return userIndex
}


sheet.getLastRow値のある最後の行数を得ることができて便利です。範囲を指定して上からfor loopで走査して該当した行数を連想配列に突っ込んで返すという形です。


該当セルにgetter及びsetterの適用


SendCoin.gs

const userIndex = getUserIndex(recipients.concat([sender]))

const notFoundUsers = [] // If a recipient does not have acccount yet, notify later.
const ledger = getLedger()
for (var i in recipients) { // Add coins to each recipient
const r = recipients[i]
if (isNaN(userIndex[r])) { // Not member yet.
notFoundUsers.push(r)
} else {
const v = ledger.getRange(userIndex[r], 2).getValue()
ledger.getRange(userIndex[r], 2).setValue(v + amount)
}
}

// Subtract total amount of sent coins
const current = ledger.getRange(userIndex[sender], 2).getValue()
const numPayedUsers = recipients.length - notFoundUsers.length
const payment = amount * numPayedUsers
ledger.getRange(userIndex[sender], 2).setValue(current - payment) // Update balance


getValuesetValueを使って、現在の値を取得した後、差分を走査して再び値を設定しています。


実装公開してます

この記事で全てを説明するのは大変なので、GAS実装はGitHubで公開しています。それぞれのファイルの中身をコピペして、Script properties


  • DEFAULTAMOUNT: 口座開設時の初期残高

  • SHEETID: 口座情報が入ったGoogle SheetsのID

  • SLACKTOKEN: SlackのAppにある Verification Token

を設定すれば動くはずです。


機能追加予定


  • オークション機能: そもそもやりたかったこと

  • 税金機能: 明確なAssignがない公共事業的な仕事への報酬

  • ブロックチェーン :chains: : 流行りだし


あとがたり

普段はデータサイエンスを仕事としてやっているので、Python :snake: がメインなのと、Javascriptは書くこともあってもD3.jsのためだけに触るので、JSの仕様に慣れるのが大変でした…また、JSにはあるはずのArrow Functionsが使えないなど、最近の言語仕様に甘えきったコードを書くぼくには面倒くさく感じるシーンが多かったです。この辺についてはまたどこかでまとめようと思います。それでは :wave: