1. Garageを
触ってみた
株式会社エクストーン 下っ端 豊田陽一

2. Garage
RESTful APIを実装するためのフレームワーク
Rails上で動作
OAuth2認証対応 (doorkeeprを利用)
リソースレベルでのアクセス管理
Cookpadが開発、2014年にOSS化
https://github.com/cookpad/garage

3. アプリの設計指針
Controller
どのリソースを返すかを記述
Model
権限・プロパティ・他のモデルとの関連を記述

4. 例) /v1/users API
以下のAPIを定義する
● GET /v1/users･･･ユーザー一覧を返す
● GET /v1/users/:id･･･指定したIDのユーザーを返す
● PUT /v1/users/:id･･･ユーザーリソースを更新する

5. UsersController
class UsersController < ApplicationController
include Garage::RestfulActions
def require_resources
@resources = User.all
end
def require_resource
@resource = User.find(params[:id])
end
def update_resource
@resource.update_attributes!(user_params)
end
end
以下のメソッドを実装することで、リソー
ス一覧取得・リソース取得・リソース更新
等の実装を行う
● require_resources
● require_resource
● create_resource
● update_resource
● destroy_resource

6. User
class User < ActiveRecord::Base
include Garage::Representer
include Garage::Authorizable
property :id
property :name
property :email
def self.build_permissions(perms, other, target)
perms.permits! :read
end
def build_permissions(perms, other)
perms.permits! :read
perms.permits! :write
end
end
プロパティの定義
パーミッションの定義
(自分以外は参照できない・編集できない等 )

7. TokenScope
リソースのアクセス制限の定義を行う
Garage::TokenScope.configure {
register :public, desc: 'accessing publicly availabledata' do
access :read, User
access :write, User
end
}
config/initializer/garage.rb内に記述
スコープごとに各リソースへのアクセス制限を
来記述可能

8. Gemfileに以下の一行を追加し、bundle installを
実行
インストールとか
gem ‘garage’, github: ‘cookpad/garage’

9. 設定ファイルの追加
config/initializer/garage.rb
Garage.configure {}
Garage::TokenScope.configure {
register :public, desc: 'accessing publicly availabledata' do
access :read, User
access :write, User
end
}
Doorkeeper.configure do
orm :active_record
default_scopes :public
optional_scopes("Garage::TokenScope.optional_scopes")
resource_owner_from_credentials do |routes|
User.find_by(email: params[:username])
end
end

10. 起動準備
Doorkeeper用のテーブルを作成し、 DBの初期化を行う
ついでに、テスト用のユーザーも作成したあとサーバー起動
$ bundle exec rails g doorkeeper:migration
$ bundle exec rake db:create
$ bundle exec rake db:migrate
$ bundle exec rails c
> User.create(name: ‘test’, email: ‘hoge@example.com’)
> quit
$ bundle exec rails s

11. アクセスしてみる
http://localhost:3000/oauth/applications
ここからアプリケーションIDとキーを取得

12. アクセストークンを取得
以下のようにして、アクセストークンを取得可能
$ export APPLICATION_ID=<取得したアプリケーションID>
$ export APPLICATION_SECRET=<取得したアプリケーションシークレット>
$ curl -u "$APPLICTION_ID:$APPLICATION_SECRET"
-XPOST http://localhost:3000/oauth/token
-d 'grant_type=password&username=hoge@example.com'
{"access_token":"XXXX","token_type":"bearer","expires_in":7200,"scope":"public"}

13. APIアクセス
取得したアクセストークンをヘッダに渡してリクエスト
(XXXXに先ほど取得したアクセストークンを記述する )
$ curl -s -XGET -H "Authorization: Bearer XXXX" http://localhost:3000/v1/users | jq '.'
[
{
"id": 1,
"name": "test",
"email": "hoge@example.com"
}
]

14. おわりに
garageでできること
● RESTfulなURLを持つAPIの設計
○ リソースの一覧取得や削除など、操作がすべて定義されているので、その
実装を行うだけ
● アクセスコントロール
○ スコープごとのアクセスコントロール
○ 条件によるアクセス制限(自分のプロフィールである、等)