DJ System API

DJ System の API です。

Quick Start

必ずrackupコマンドを使用してください。

$ git clone https://github.com/lit-kansai/dj_system-api
$ cd dj_system-api
$ bundle install
$ rake db:create
$ rake db:migrate
$ $EDITOR .env
$ rackup config.ru

環境変数

SPOTIFY_API_CLIENT_ID=
SPOTIFY_API_CLIENT_SECRET=
GOOGLE_API_CLIENT_ID=
GOOGLE_API_CLIENT_SECRET=
JWT_SECRET=
CORS_DOMAINS=
APPLE_MUSIC_API_PRIVATE_KEY=
APPLE_MUSIC_API_KEY_ID=
APPLE_MUSIC_API_TEAM_ID=

技術

目的	技術	備考
言語	Ruby
フレームワーク	Sinatra	規模が大きいのでmodular styleを採用しています。
ORM	Active Record
サーバ	AWS EC2

特殊な実装について

base.rb

Sinatra の modular style は通常Sinatra::BaseもしくはSinatra::Applicationを継承したクラスを作成しますが、このプロジェクトでは Sinatra::Baseを継承して新たにBaseクラスを作り、こちらを使用しています。

これにより、全てのルートで共通な関数を定義したり、設定をすることが出来ます。

また、Baseクラスの中でもかなり特殊な（ある意味 Evil とも捉えられる）実装であるbind_routerメソッドについては次のセクションで解説しています。

bind_router メソッドについて

このメソッドを理解するためには 2 つの前提を理解する必要があります。まず 1 つ目にSinatra::Baseクラスが Rack に準拠しており、callメソッドを呼び出すことで Rack アプリケーションとして動作するようになっている事を知っておく必要があります。

そして、Rack アプリケーションとは、環境を引数として受け取り、status / header / body を返すメソッド「call」が定義されているクラスということになります。

つまるところ、Sinatra::Baseクラスはこの Rack アプリケーションの仕様に基づき、getメソッドやpostメソッドの定義を元にルーティングを処理し、その結果を Rack の形式に変換して返すという仕組みになっているということです。

2 つ目に、Ruby ではクラスの直下でメソッドを呼び出せるという仕様を知る必要があります。

この仕様についてはこちらの記事が参考になりますが、クラス直下に書いたメソッドはクラスが読み込まれたタイミングで呼び出されるという仕様になっています。

そして、実はget '/' doのようなgetやpostはこちらの仕組みが使われており、クラス直下でgetメソッドを呼び出しているということになります。

また、getメソッドも Call メソッドと互換があるので、getメソッドの引数に Rack アプリケーションを渡すことが出来ます。

これらを整理して、別のファイルを元にgetやpostメソッドを呼び出せばいいのでは？と考えたのがこのbind_routerです。

bind_routerを呼び出すと、任意のパス配下の処理を別のクラスに委譲することが出来ます。また、@変数は維持されるので、bind_routerを呼び出す前に定義した変数をそのまま使うことが出来ます。

Sinatra が一部@env["PATH_INFO"]を元に処理している部分があるため、ここだけ予め変更するように Proc を記述しています。

Sinatra は条件によっては上から優先して処理をしていく場合があるので、bind_routerは必ずクラス末尾に記述する必要があります。