🚧 Repository update 🚧

The repository updated to be https://github.com/beproud/beproudbot-sls - please raise new issues, discussions and pull requests there 🙏

Haro

Haro is slackbot based beproud bot system.

事前準備

Macのローカルで開発する場合、Docker、ansibleを構築する必要なし
起動方法まで参照することで、ローカル環境が構築できる

APIトークンの取得

https://my.slack.com/services/new/bot にアクセス
botの名前を適当に指定して「Add bot integration」ボタンをクリックする
「Save Integration」ボタンをクリックして保存する
- API Token(xoxb-XXXXXXX-XXXXXXX)をこのあと使用するので、コピーしておく

Requirements

Python 3.8

$ python3 -m venv env
$ git clone git@github.com:beproud/beproudbot.git
$ cd beproudbot
$ source /path/env/bin/activate
(env)$ cp env.sample .env
(env)$ vi .env # API Token 等を記入する
(env)$ export SLACK_API_TOKEN=xoxb-XXXX　# API Tokenがターミナルの環境変数で.envに反映されない場合
(env)$ pip install -r src/requirements.txt

Redmine APIキーの取得

.env にREDMINE_API_KEY を指定する必要がある。

ローカル環境では、 BPのRedmine > 個人設定 > APIアクセスキー > 表示 で確認できるAPIキーを .env に追記する。

起動方法

$ source /path/env/bin/activate
# configには環境変数を指定します
(env)$ export $(cat .env |grep -v '#')
(env)$ cd src && python run.py

Docker

# MySQL を使用する場合先に立ち上げておく
# docker-compose up -d db
# bot の起動
$ docker-compose build bot
$ docker-compose run -d bot
# コンテナにはいる
$ docker-compose run --rm bot bash
# 終了
# docker-compose down

DB操作

alembic を使用します

マイグレーション

(env)$ export $(cat .env |grep -v '#')
(env)$ cd src && alembic --config alembic/conf.ini upgrade head

マイグレーションファイル作成

env.pyの設定を読み込み、versions以下にマイグレーションファイルが書き出されます

(env)$ export $(cat .env |grep -v '#')
(env)$ cd src && alembic --config alembic/conf.ini revision --autogenerate -m "my message"

Procfile 使用

マイグレーション等の操作は honcho を使用して操作することができます。

honchoは .env を自動的に読み込み、スクリプトを開始することができます。

(env)$ pip install honcho
# honcho start bot
# honcho start migrate
# honcho start makemigrations

環境構築

ansible の configure タグを使用します。

$ (cd beproudbot/deployment && ~/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml)
# 環境変数は `ENVIRONMENT_FILE_PATH` を指定することができます
$ (cd beproudbot/deployment && ~/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml "ENVIRONMENT_FILE_PATH=path/to/.env")
# MySQL をインストールしない場合 `use_local_mysql_server=false` とすることで設定をスキップできます
$ (cd beproudbot/deployment && ~/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml --tags=configure -e "use_local_mysql_server=$use_local_mysql_server")

デプロイ

ansible の deploy タグを使用します

# 自分のユーザーで haro サーバーに ssh 
$ ssh haro
# root ユーザーになる (以下は beproud ユーザー経由で root になる例)
$ su - beproud
パスワード: (いつものあれ)
$ sudo -iH

# デプロイ実行
$ cd beproudbot/deployment
$ ~/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml --tags=deploy
# デプロイ実行 (上記の venv がない場合)
$ /home/altnight/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml --tags deploy

# `git_version` でブランチ/タグ/リビジョンを指定することができます
$ (cd beproudbot/deployment && ~/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml --tags=deploy -e "git_version=branch_name")
# VM開発時は `git_sync_local` でローカルファイルを配備することができます
# また `git_force_checkout` で --force checkout できます
$ (cd beproudbot/deployment && ~/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml --tags=deploy -e "git_sync_local=true" -e "git_force_checkout=true")

環境変数からまとめてまとめて引数に渡す場合の例は以下です

$ (cd beproudbot/deployment && ~/venv_ansible/bin/ansible-playbook -i hosts --connection local site.yml \
  -e "ENVIRONMENT_FILE_PATH=$ENVIRONMENT_FILE_PATH" \
  -e "use_local_mysql_server=$use_local_mysql_server" \
  -e "git_force_checkout=$git_force_checkout" \
  -e "git_sync_local=$git_sync_local" \
  -e "git_version=$git_version")

Command

misc コマンド

$shuffle spam ham eggs: 指定された単語をシャッフルした結果を返す
$choice spam ham eggs: 指定された単語から一つをランダムに選んで返す

random コマンド

$random: チャンネルにいるメンバーからランダムに一人を選ぶ
$random active: チャンネルにいるactiveなメンバーからランダムに一人を選ぶ
$random help: randomコマンドの使い方を返す

redbull コマンド

$redbull count: RedBullの残り本数を表示する
$redbull num: numの数だけRedBullの本数を減らす(負数の場合、増やす)
$redbull history: 自分のRedBullの消費履歴を表示する
$redbull clear: RedBullのDBデータを削除するtoken付きのコマンドを表示する
$redbull csv: RedBullの月単位の消費履歴をCSV形式で表示する
$redbull help: redbullコマンドの使い方を返す

water コマンド

$water count: 現在の残数を返す
$water num: 水を取り替えた時に使用。指定した数だけ残数を減らす(numが負数の場合、増やす)
$water history <num>: 指定した件数分の履歴を返す(default=10)
$water help: このコマンドの使い方を返す

kintai コマンド

$kintai start: 出社時刻を記録します
$kintai end: 退社時刻を記録します
$kintai show: 自分の勤怠一覧を直近40日分表示する
$kintai csv <year>/<month>: monthに指定した月の勤怠記録をCSV形式で返す(defaultは当年月)
$kintai help: 勤怠コマンドの使い方を返す

alias コマンド

$alias show [user_name]: Slackのユーザーに紐づいているエイリアス名一覧を表示する
$alias add [user_name] <alias_name>: Slackのユーザーに紐づくエイリアス名を登録する
$alias del [user_name] <alias_name>: Slackのユーザーに紐づくエイリアス名を削除する
$alias help: aliasコマンドの使い方を返す
※各コマンドにてuser_name引数を省略した際には投稿者に対しての操作になります

cleaning コマンド

$cleaning task: 掃除作業の一覧を表示する
$cleaning list: 掃除当番の一覧を表示する
$cleaning today: 今日の掃除当番を表示する
$cleaning add <user_name> <day_of_week>: 掃除当番を追加する
$cleaning del <user_name> <day_of_week>: 掃除当番から削除する
$cleaning move <user_name> <day_of_week>: 掃除当番の曜日を移動する
$cleaning swap <user_name> <user_name>: 掃除当番を入れ替える
$cleaning help: cleaningコマンドの使い方を返す
※<day_of_week> は月、火、水、木、金が指定可能です

create コマンド

$create add <command>: コマンドを追加する
$create del <command>: コマンドを削除する
$<command>: コマンドに登録した語録の中からランダムに一つ返す
$<command> <語録>: 語録を登録する
$<command> del <語録>: 語録を削除する
$<command> pop: 最後に自分が登録した語録を削除する
$<command> list: 登録された語録の一覧を返す
$<command> search <keyword>: 語録の一覧からキーワードを含むものを返す
$create help: createコマンドの使い方を返す

kudo コマンド

<name>++: 指定された名称に対して++します
$kudo help: kudoコマンドの使い方を返す

thx コマンド

[user_name]++ [word]: 指定したSlackのユーザーにGJする
$thx from <user_name>: 誰からGJされたかの一覧を表示する
$thx to <user_name>: 誰にGJしたかの一覧を返す
$thx help: thxコマンドの使い方を返す
※各コマンドにてuser_name引数を省略した際には投稿者に対しての操作になります

redmine コマンド

/msg @haro $redmine key <your_api_key>: 自分のRedmineのAPIキーを登録する
$redmine add <redmine_project_identifier>: コマンドを実行したSlackチャンネルとRedmineのプロジェクトを連携させます
$redmine remove <redmine_project_identifier>: コマンドを実行したSlackチャンネルとRedmineプロジェクトの連携を解除します
※<your_api_key> はRedmineの [個人設定] -> [APIアクセスキー] -> [表示] から取得します
※<redmine_project_identifier> はRedmineのプロジェクトを開き、 [設定] -> [情報] -> [識別子] から取得します

文章の中にチケット番号(tXXXX)が含まれている場合、チケットのタイトル名とチケットのリンクを表示します。

例:

james [9:00 PM]
t12345はいつできるのかな？

Haro [9:00 PM]
SlackからRedmineのチケットを見れるようにしよう
http://localhost:9000/redmine/issues/12345

$redmine help: redmineのコマンドの使い方を返す

uranai コマンド

$uranai <誕生日(4桁)>: 今日の占いを返す

lunch コマンド

$lunch: オフィス近辺のお店情報返す
$lunch <keyword>: 指定したキーワードのお店情報を返す
$lunch <keyword> <distance>: 指定したキーワードと検索距離のお店情報を返す
$lunch help: このコマンドの使い方を返す

amesh コマンド

$amesh : http://tokyo-ame.jwa.or.jp/ の雨雲画像を返す

status コマンド

$status: リソース一覧表示
$status <add> <name>: リソース追加
$status <del,delte,rm,remove> <name>: リソース削除
$status <name>: リソースのステータスをデフォルトに戻す
$status <name> <value>: リソースのステータス設定

version コマンド

$version : リリースノートから最新の更新を取得して表示する

Name		Name	Last commit message	Last commit date
Latest commit History 597 Commits
.circleci		.circleci
.devcontainer		.devcontainer
.github		.github
deployment		deployment
docs		docs
src		src
tests		tests
.gitignore		.gitignore
CONTRIBUTING.md		CONTRIBUTING.md
ChangeLog.rst		ChangeLog.rst
Dockerfile		Dockerfile
LICENSE		LICENSE
Procfile		Procfile
README.md		README.md
Vagrantfile		Vagrantfile
docker-compose.yml		docker-compose.yml
env.sample		env.sample
tox.ini		tox.ini

License

beproud/beproudbot

Folders and files

Latest commit

History

Repository files navigation