決勝イベント時レギュレーション: https://gist.github.com/tagomoris/2be8751d8c13f5e78e61
The MIT License (MIT)
Copyright (c) 2015 tagomoris, kamipo, najeira, hkurokawa, making, xerial, hokaccha
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Cookieでセッション管理、ログインを要求する。
なおサインアップ時に指定する grade で使える外部APIのセットが決まり /modify で各APIの引数を与えることとする。
各gradeが使えるAPIは以下の通り
- premium: 全て
- standard: xxx以外全て
- small: xxx, xxx, ....
- micro: ken, ken2, ...
外部APIは以下のようなものである必要があります。
- GETもしくはPOSTリクエストを受ける
- JSONのオブジェクトを返す
- URIのpath部分は固定文字列、もしくは任意個数文字列の埋め込みで成る (ex:
/part1/%s/part2/%s) - フォームもしくはURIクエリパラメータでキーと値のペアをひとつだけ取れる (ex:
?q=VALUE) - tokenをとれる
- とらなくてもよい
- トークンはフォームもしくはURIクエリパラメータのひとつ(
param)、もしくはHTTPヘッダ(header)として渡す - トークンはユーザごとに固定のものとする
- レスポンスJSONはできるだけリクエストがどのようなものだったかが分かるような情報を含んで返すこと
- これはアプリケーション側でもレンダリングし、ベンチマークツールが結果のチェックに使用する
これらのリクエスト組み立て方法はWebアプリケーション側の endpoints テーブルに入るレコードによって制御します。このテーブルは全ユーザに同じデータが渡されます。
アプリケーション参考実装は外部APIの情報を以下の場所に持っています。つまり、外部APIをひとつ足すためには api/ 以下に足すアプリケーションコードのほか、各言語の参考実装に以下の変更をする必要があります。(が、そう多くはありません。)
endpointsへのレコードの追加 (sql/init.sqlへの行の追加)static/airisu.jsへのレンダリング用関数の追加 (render_xxx()関数の追加、およびrender()の switch-case への行の追加)- 各言語実装における API 登録画面へのHTML1行の追加 (rubyの場合は
views/modify.erbへの<div class="api-form">のタグ部分)- これは実際にはJSでレンダリングされるため各実装言語のロジックは必要ない
以上です。が、面倒であれば適当に後回しにしてください。(ただし何を後回しにしたかどこかにメモっておいてもらえると助かります)
-
GET /signupサインアップ用フォーム表示 -
POST /signupサインアップ、成功したら/loginにリダイレクト -
POST /cancel解約、そのユーザのデータをすべて削除する、完了したら/signupにリダイレクト -
GET /loginログインフォームを含むHTMLを返す -
POST /loginログインに成功したら/、失敗したら/loginにリダイレクト- ログインしていなければ 403
-
GET /HTMLを返す、この段階では外部APIへのリクエストは発生しない (未ログインの場合/signupにリダイレクト) -
GET /user.jsユーザごとにAPIリクエスト用のjsを返す- ユーザ情報のgradeを見て異なる auto refresh の間隔が入ったjavascriptを返す
- 高速化のためにはgradeごとにjsを予め生成しておいてそこにredirectすればよいようにする
- ログインしていなければ 403
-
GET /modifyAPIアクセス情報変更画面を表示 -
POST /modifyAPIアクセス情報の変更を行う- ログインしていなければ 403
- なお各APIアクセス情報は(必要なら)以下のキーを持つ
keysリスト、pathの%sにsprintfで展開されるparamsオブジェクト、GETならクエリパラメータ、POSTならフォームデータとして送信されるtoken文字列、存在すればtoken_typeおよびtoken_keyにしたがって送信される- 成功したら
/modifyにリダイレクト
-
GET /dataユーザがsubscribeしているAPIすべてにアクセスし、結果をまとめてjsonで返す- ログインしてなければ 403
-
GET /initializeデータの初期化用ハンドラ