[Ruby] Backlogの作業時間の記録を半自動化する

前提

以下の環境で開発、動作確認

要素 バージョン
debian 8.6
ruby 2.2.2
gem 2.4.5
bundle 1.13.4
backlog_kit 0.15.0

リポジトリ
https://github.com/Sa2Knight/BacklogTimeKeeper

以下の続きのようなもの
[Ruby] BacklogをCUIで操作してみる

概要

BacklogAPIを用いて、コマンド実行のみで課題の作業時間を記録するCUIツールを作ったので紹介。

以下のように、コマンドで課題キーを指定して課題を開始。課題が完了したら再度コマンドを実行すると、作業時間を計算して、課題の作業時間を更新してくれる。それだけ。

目新しい技術要素もないが、ブログネタが無くなってきたので

10:08:39$ bruby Main.rb -s DEVS-1
プログラムを書く (DEV-1)を開始しました
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
13:14:08$ bruby Main.rb -e
プログラムを書く (DEV-1)を終了し、作業時間を3.09時間追加しました

BacklogAPIの準備

BacklogAPIは、特別な申請なしにすぐに利用を開始することができる。BacklogAPIを利用したいBacklogにログインし、個人設定→API設定に移動すると、以下の画面になるので、適当に名前を付けてAPIを発行する。APIキーは後ほど必要になるので控えておく。

ツールの導入

リポジトリからソースコードを取得

GithubからCloneする。

$ git clone git@github.com:Sa2Knight/BacklogTimeKeeper.git
Cloning into 'BacklogTimeKeeper'...
remote: Counting objects: 48, done.
remote: Compressing objects: 100% (33/33), done.
remote: Total 48 (delta 23), reused 37 (delta 12), pack-reused 0
Receiving objects: 100% (48/48), 7.10 KiB | 0 bytes/s, done.
Resolving deltas: 100% (23/23), done.
$ cd BacklogTimeKeeper/

必要なライブラリをインストール

サードパーティ製のbacklog_kitを利用するので、bundleでインストールする。

$ bundle install --path vendor/bundle
Fetching gem metadata from https://rubygems.org/..........
Fetching version metadata from https://rubygems.org/..
Fetching dependency metadata from https://rubygems.org/.
Resolving dependencies...
Installing concurrent-ruby 1.0.5
Installing i18n 0.8.4
Installing minitest 5.10.2
Installing thread_safe 0.3.6
Installing multipart-post 2.0.0
Using bundler 1.13.4
Installing tzinfo 1.2.3
Installing faraday 0.10.1
Installing activesupport 5.1.1
Installing faraday_middleware 0.10.1
Installing backlog_kit 0.15.0
Bundle complete! 1 Gemfile dependency, 11 gems now installed.
Bundled gems are installed into ./vendor/bundle.

環境変数を設定

本ツールでは、BacklogのスペースID及びAPIキーを環境変数から参照する仕様になっているので、以下のようにエクスポートしておく。エクスポートする値は各々の環境にあわせたものにする。

$ export BACKLOG_SPACE="hoge"
$ export BACKLOGAPI="ghaiogapigipeghpghapghpheapiwthpiat"

使い方

課題の作業を開始する

Main.rbを-sオプションを付与して、対象の課題キーを指定して実行する。bundle execは必須だが、面倒なのでaliasつけたりするとマシになる。

$ bundle exec ruby Main.rb -s DEV-1
プログラムを書く(DEV-1)を開始しました

課題を開始すると、同ディレクトリにworkというファイルが作成されるが、これは対象の課題キーとその開始時間を記録しているだけのJSONファイルなので特に気にしなくて良い

$ cat work
{"key":"DEV-1","datetime":"2017-06-06 20:44:05 +0900"}

課題の作業を終了する

開始から数時間たったことにして、課題を終了する。終了時はMain.rbを-eオプションを付与して実行するだけで良い。前述のworkファイルで対象の課題キーが管理されているので、ここでは課題キーを指定する必要がない。

$ bundle exec ruby Main.rb -e
プログラムを書く(DEV-1)を終了し、作業時間を1.71時間追加しました

課題を確認すると1.71時間設定されているのがわかる

また、既に作業時間が記録されている課題に対して同様に作業開始→作業終了のコマンドを実行すると、以下のように作業時間を追加する形で更新される

使いみち

まだたったコレだけしかできないが、個人的には既に以下のような実用性がある

  • 課題の作業時間を自分で時刻見て計算する必要がなくなる
  • 億劫だった作業時間記録作業がむしろ楽しみになった
  • 本ツールで課題を開始するとその課題にだけしっかりと集中できるようになった気がする(複数課題並行できないのはむしろメリット)

今後

多分以下のように発展されられる気がする

  • 本日の作業時間の集計機能(どの課題にどのぐらい時間を使ったか)
  • 作業中の課題をチャットワークで通知(名前欄に動的に記入したり?)
  • 課題のステータス変更との組み合わせ(課題終了時に、ステータスを「完了」にするとか)

とにかくBacklogAPIとチャットワークAPIのマッシュアップが夢広がる。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です