Slackbotで特定のメッセージに反応してGoogle Spread Sheetに時間を記録したい

Question

python 3.7

【目的】
SlackのDMで勤怠管理を行いたい。
最初はみやもとさんでの勤怠管理を行おうとしていたのですが、この機能はWebhookを利用しているためチャットでの使用に限定され、複数の人が利用するチャットでは非常にうるさくなってしまいます。そこでみやもとさんの機能をbotに落とし込んで、DMで個人ごとにひっそりと勤怠管理をしようと試みています。

【実装内容】
PythonのslackbotライブラリでSlackボットを作る

上記の記事を参考に簡単なSlackbotを実装しました。
そこに追加機能として、botのいるDMで挨拶を送信したとき
・その日付時刻をGoogleSpreadSheetに記録
・おはよう等の返事を行う
の２点を追加しようとしています。

【困っていること】
日付時刻の取得やGoogleSpreadSheetへの記録は単体でならdatetime.now()とgspreadでできたのですが、Slackbotに挨拶をしたときに日付時刻をシートへ記録させることができませんでした。
以下のコードの内容で試してみたのですが、おそらくSlackへの投稿とGoogleSpreadSheetへの書き込みが紐付いてないような気がしています。
※write_toは自作のデコレータです

【ディレクトリ構造】

slackbot         # プログラムをまとめるディレクトリ。名前はなんでも良い
├─ run.py        # このプログラムを実行することで、ボットを起動する
├─ slackbot_settings.py   # botに関する設定を書くファイル
├─ gsheet.py              # GoogleSpreadSheetに日付時刻を記述するスクリプト
├─ bot.py                 # respond_toやlisten_toを定義するファイル（？）
└─ plugins                # botの機能はこのディレクトリに追加する
   ├─ __init__.py         # モジュールを示すためのファイル。空で良い
   └─ my_mention.py       # 機能を記述しているファイル。任意の名前で良い

【コード】
my_mention.py

# my_mention.py

# coding: utf-8
from slackbot.bot import respond_to     # @botname: で反応するデコーダ
from slackbot.bot import listen_to      # チャネル内発言で反応するデコーダ
from slackbot.bot import default_reply  # 該当する応答がない場合に反応するデコーダ
from slackbot.bot import write_to       # Google Spread Sheetに時刻を書き込むデコーダ
from slackbot.gsheet import Datetimeimport re

# @respond_to('string')     bot宛のメッセージ
#                           stringは正規表現が可能 「r'string'」
# @listen_to('string')      チャンネル内のbot宛以外の投稿
#                           @botname: では反応しないことに注意
#                           他の人へのメンションでは反応する
#                           正規表現可能
# @default_reply()          DEFAULT_REPLY と同じ働き
#                           正規表現を指定すると、他のデコーダにヒットせず、
#                           正規表現にマッチするときに反応
#                           ・・・なのだが、正規表現を指定するとエラーになる？

# message.reply('string')   @発言者名: string でメッセージを送信
# message.send('string')    string を送信
# message.react('icon_emoji')  発言者のメッセージにリアクション(スタンプ)する
#                               文字列中に':'はいらない

@respond_to('おは|はよ|おっは|hello|hi|出勤|来た|きた')
def mention_func(message):
    message.reply('おはよ〜！') # メンション

@respond_to('お先|失礼しま|お疲れ|おつ|帰る|退勤|バイバイ')
def mention_func(message):
    message.reply('バイバイ〜') # メンション

@listen_to('疲れた|帰りた|眠い|ねむ')
def mention_func(message):
    message.reply('わかる〜') # メンション

@write_to('おは|はよ|おっは|hello|hi|出勤|来た|きた') 
def mention_func(message):
    message.reply('GSS確認して')

bot.py

# bot.py

# -*- coding: utf-8 -*-
from __future__ import absolute_import
import imp
import importlib
import logging
import re
import time
from glob import glob
from six.moves import _thread
from slackbot import settings
from slackbot.manager import PluginsManager
from slackbot.slackclient import SlackClient
from slackbot.dispatcher import MessageDispatcher
from slackbot.gsheet import Datetime

logger = logging.getLogger(__name__)

~中略~

def write_to(matchstr, flags=0):
    def wrapper(func):
        Datetime.taketime(matchstr)
        PluginsManager.commands['write_to'][
        re.compile(matchstr, flags)] = func
        logger.info('registered write_to plugin "%s" to "%s"', func.__name__,
        matchstr)
        return func

    return wrapper

gsheet.py

# gsheet.py

# coding: utf-8
import gspread
from oauth2client.service_account import ServiceAccountCredentials
from datetime import date, datetime, timedelta
import re

scope = ['https://spreadsheets.google.com/feeds',
         'https://www.googleapis.com/auth/drive']

#ダウンロードしたjsonファイル名を記入
json_file = 'miyamoto.json'

#スプレッドシートのシート名を記入
sheet_name = 'miyamoto'

#入力するワークシートの指定
credentials = ServiceAccountCredentials.from_json_keyfile_name(json_file, scope)
gc = gspread.authorize(credentials)
wks = gc.open(sheet_name).sheet1

class Datetime(object):
    def taketime(str):
        if re.compile("おは|はよ|おっは|hello|hi|出勤|来た|きた").search(str):
            now_time = datetime.now()             # 現在の yy年 mm月 dd日 HH時 MM分 SS秒
            date = now_time.strftime('%Y/%m/%d')  # 年月日の情報抽出
            time = now_time.strftime('%H:%M')     # 時,分の情報抽出
            print(now_time)                       # ex."2017-07-05T17:01:06.112224"
            wks.update_cell( 1, 1, date)          # Google Spread Sheetに日付を書き込む
            wks.update_cell( 1, 2, time)          # Google Spread Sheetに時刻を書き込む
            print(wks.acell('A1'))
            print(wks.acell('B1'))
        else:
            pass

run.py

# run.py
# -*- coding: utf-8
from slackbot.bot import Bot

def main():
    bot = Bot()
    bot.run()

if __name__ == "__main__":
    print('start miyamotosan')
    main()

Slackへの投稿とGoogleSpreadSheetへの書き込みを紐づけたいのですが、どうも何を使えばいいのかわからず手詰まり感があります……
どうかよろしくお願いいたします。

Comments

[papinianus]

現在できていることの確認ですが、"おはよう"などと書くと、スプレッドシートに書かれるのに"GSS確認して"という応答がなされないということで良いですか？
ちなみに、"お先"に対して、"バイバイ～"の返答はありますか？

[ano_gasena]

【できること】
"おはよう"に対して、"おはよ〜！"を返す
"お先"に対して"バイバイ〜"を返す
スプレッドシート自体への書き込み
【できないこと】
メッセージに反応したスプレッドシートへの書き込み

わかりにくい記述ですみません

Answer 1

回答には至らないのですが、追記欄に書くには長いので。

write_toというデコレータを動作させるには、slackbotのライブラリのdispatcher.pyの_on_new_messageを修正する必要があるはずです。

ただ、ライブラリの作りからいって、参考になさった記事のように、@respond_toに結びつく関数で、必要な処理をしてから、message.replyをすれば目的の動作になると思います。

具体的には↓のここのところで、Datetime.taketime(message)とこれに必要なgsheetの処理を書く感じかと思います。

@respond_to('おは|はよ|おっは|hello|hi|出勤|来た|きた')
def mention_func(message):
    #ここ
    message.reply('おはよ〜！') # メンション

-- 余談
自分へのDMだと、誰からも見られることなく、かつどこからでも書き込めます。publicチャンネルでやっているのは、検証可能性という意味があるのだと思います。
単に通知がうざい点はミュートで対処可能なはず。

Comments

[ano_gasena]

具体策ありがとうございます。おかげさまでなんとかできました！
(bot.pyでデコレータを作らなくてもよかったのですね、作れてたわけではないみたいですが)

>publicチャンネルでやっているのは、検証可能性という意味があるのだと思います。
みやもとさんで使用している発信Webhookはインテグレーション設定で対象チャンネルにDMを設定できなかったので、「それなら自作botでDM対応してみようか…？」という流れですね。