nomlab / swimmy Goto Github PK

View Code? Open in Web Editor NEW

0.0 13.0 34.0 1.57 MB

License: MIT License

Ruby 98.51% Shell 1.42% Dockerfile 0.07%

swimmy's Introduction

swimmy

swimmyとは，B4新人課題で作成した各々のSlackBotを1つにまとめたものである．本プロジェクト名は，絵本作家レオ・レオニ作の絵本「swimmy」に由来し，各々のプログラムをまとめた1つの成果物を表している．

Setup

このリポジトリを clone する．

$ git clone https://github.com/nomlab/swimmy.git

gem のインストール
- 以下のコマンドを実行し，gemをインストールする．
```
$ gem install bundler
$ bundle install --path vendor/bundle
```
設定ファイルの作成
- 以下のコマンドを実行し，.env.sample を .envに変更する．
```
$ cp .env.sample .env
```
Slack appの作成とOAuth Tokenの取得
- https://api.slack.com/authentication/basicsへアクセスし，リンク先の手順に従いclassic Slack appを作成する．#251
- Appのインストール後生成されるOAuth Tokenを.envに記述する．
APIキーの設定
- Google Maps API の API キー取得
  - Google Maps API へアクセスし，「キーの取得」をクリックする．
  - 「Select or create project」をクリックする．
  - 「Create a new project」をクリックし，プロジェクト名を付ける．
  - 「NEXT」をクリックすると，Google Maps APIキーが作成される．
- Google Places API の API キー取得
  - Google Place APIへアクセスし，「キーの取得」をクリックする．
  - 「Create a new project」を選択し，プロジェクト名を決定する．
  - 「Next」をクリックすると API キーが生成される．
- Yahoo! JAPAN デベロッパーネットワーク Web API の Client ID の取得
  - Yahoo! JAPAN デベロッパーネットワークにアクセスする．
  - ページ上部の「機能」をクリックし，「アプリケーションの開発」をクリックする．
  - 本プログラムの使用者の Yahoo!JAPAN アカウントにログインする．
  - 「新しいアプリケーションの開発」をクリックする．
  - アプリケーション情報を入力し，「ガイドラインに同意する」にチェックを入れ，「確認」をクリックする．
  - Client ID を取得する．なお，Client ID を API キーとして用いる．
- 取得したAPIキーを.envに記述する．
sheetqの設定
- https://github.com/nomlab/sheetqにしたがって設定を行う．
- GoogleスプレッドシートIDを.envに設定する．
Google OAuthの設定
この設定はtodayコマンド，及びphoto_uploadコマンドの使用に必須である．
1. Google Cloud Console上で作成したOAuthクライアント認証情報をダウンロード(「OAuthクライアントをダウンロード」，「JSONをダウンロード」の順にクリック)し，config/credentials.jsonとして保存する．または，config/credentials.json.sampleをconfig/credentials.jsonとしてコピーし，自身のクライアント認証情報に沿って編集する．
2. 以下のコマンドを実行し，Google OAuth アクセストークンを作成する．
```
$ ./exe/google_oauth_initializer
```

systemdの設定

以下のコマンドを実行する．

# root ユーザ
$ cp systemd_conf/swimmy.service /etc/systemd/system/swimmy.service
$ cp systemd_conf/swimmy_env /etc/default/swimmy_env

# 非 root ユーザ
$ cp systemd_conf/user/swimmy.service ~/.config/systemd/user/swimmy.service
$ cp systemd_conf/swimmy_env ~/.config/systemd/user/swimmy_env

コピーしたswimmy.serviceについて，以下の項目を環境に合わせて設定する．

5 WorkingDirectory=/home/nomlab/swimmy
6 ExecStart=/bin/sh -c 'exec /home/nomlab/swimmy/exe/swimmy >> /var/log/swimmy.log 2>&1'
7 User=nomlab
8 Group=nomlab

コピーしたswimmy_envについて，PATHを環境に合わせて設定する．

Run

以下のコマンドを実行することでswimmyを起動できる．

# root ユーザ
$ sudo systemctl start swimmy

# 非 root ユーザ
$ systemctl --user start swimmy

また，以下のコマンドを実行することでswimmyを停止できる．

# root ユーザ
$ sudo systemctl stop swimmy

# 非 root ユーザ
$ systemctl --user stop swimmy

swimmy's People

Contributors

Watchers

swimmy's Issues

todayコマンドとphoto_uploadコマンドで同じOAuthのデータを使用するようにする

today コマンドと photo_upload コマンドは同じ認証情報 (credentials) から，異なる認可プロセスを経て，異なる token を作成している．
このため，認可の際に Google Photo と Google Calendar の2つのスコープを与えて，一つの token で動作するようにする．

Dockerfile を作成する．

Created from AI0703 of minute 1000.

swimmy について Dockerfile を作成する．-->(高家，坂本，野村 !:0703)

swimmyの自動起動についてnomlab/swimmyリポジトリのREADMEにまとめ，必要なファイルを追加する

Created from AI0638 of minute 857.

swimmyの自動起動についてnomlab/swimmyリポジトリのREADMEにまとめ，必要なファイルを追加する．-->(藤原 !:0638)

.env.sampleに，APIトークンがどのコマンドで使用されるか分かるようにコメントを記載する

Created from AI0700 of minute 978.

.env.sampleに，APIトークンがどのコマンドで使用されるか分かるようにコメントを記載する．-->(中園 !:0700)

Upate Sinatra version in Gemfile.lock

https://nvd.nist.gov/vuln/detail/CVE-2018-11627
Known vulnerability found
CVE-2018-11627
High severity

Sinatra before 2.0.2 has XSS via the 400 Bad Request page that occurs upon a params parser exception.

Gemfile.lock update suggested:
sinatra ~> 2.0.2

コマンドを実行する do コマンドの作成

Created from AI0751 of minute 1081.

コマンドを実行する do コマンドの作成 -->(濵本 !:0751)

pollについて数字スタンプの順番がおかしい

swimmy の poll 機能を使うと，数字スタンプが昇順に並ばない場合がある．

参考画像

at コマンドのテストを追加する

Created from AI0782 of minute 1221.

at コマンドの動作を確認するため，テストを追加する．

swimmyのリポジトリのマージを契機に，テストからデプロイまでを自動化する

Created from AI0690 of minute 956.

swimmyのリポジトリのマージを契機に，テストからデプロイまでを自動化する．-->(高家 !:0690)

Updateコマンドについて，新しく Gem をインストールする必要がある場合， bundle install が失敗する

Created from AI0756 of minute 1081.

Updateコマンドについて，新しく Gem をインストールする必要がある場合， bundle install が失敗する． -->(高家 !:0756)

Bundler 環境から Bundler を実行すると，後者の Bundler は，前者のBundlerが環境変数に加えた変更の影響を受け，失敗する．
参考: https://www.cargomedia.ch/2016/03/18/reset-bundler-environment.html

today コマンドを実行するために，seiryu 上で設定を行う

Created from AI0755 of minute 1081.

today コマンドを実行するために，seiryu 上で設定を行う． -->(中園 !:0755)
- Google Calendar API 用の token.yml を作成する．
- スプレッドシートにカレンダ名とカレンダIDを記述したシートを作成する．
- help メッセージのタイピングミスを修正する．