こんにちわ。ばたっちです。

Rails 2.0の REST対応はは、RESTアプリのサーバ側の機能と、クライアント側の機能が入ってるんですね。

• サーバ側 : ActionController::Resourcesとか
• クライアント側 : ActiveResource

例えば、コントローラで、

def show @entry = Entry.find params[:id] respond_to do |format| format.xml { render :xml => @entry } end end

とすれば、Entryオブジェクト(ActiveRecord)を自動で XMLに変換して返します。
(ActiveRecordの to_xmlの結果をそのまま返すみたい。だからテンプレート不要。)

一方 ActiveResourceは、クライアント側で RESTで提供されているリソースを、まるで ActiveRecordのオブジェクトのように扱えるようにしてくれるクラス。

例えば、上記の showアクションのレスポンスとして、

<entry> <title>今日の出来事</title> <text>ActiveResourceを始めて使った。</text> </entry>

のようなXMLを返す RESTアプリがあって、それを ActiveResourceで扱うと、

>> entry = Entry.find(1) => #<Entry:0xXXXXXXXX @attributes={"title"=>"今日の出来事","text"=>"ActiveResourceを始めて使った。"}, ... > entry.title => "今日の出来事"

こんなカンジでアクセスできます。find()の裏では「GET /entries/1.xml」のように HTTP GETしてるんですね。
うーん、すごい。

さて、Railsが自動で作ってくれる CRUDなインターフェースがそのまま使えれば、とても便利なのですが、実際に RESTアプリを作ると考えると、少し工夫が必要になりそうです。

例えば、

• クライアントの認証が必要な場合は？
• ActiveRecordの idをプライマリキーにしない場合は？

まず、認証については、アカウント名＋パスワードで認証するのであれば、URLにアカウント名、パスワードを含めてBASIC認証にするみたい。

class Entry < ActiveResource::Base self.site = "http://user1:pass1@api.example.com/" end

なるほど。
ちなみに RESTの定義としてセッションなどにログイン情報を持たず、毎回のリクエストでリソースの参照を完結すべきだそうで、認証が必要な場合は認証情報も毎回送る形になるようです。

それから、APIキーを発行するだけのような場合、URLの後ろに「api_key=key1」のようにクエリパラメータをつけるのは RESTっぽくない気がするので、

http://api.example.com/api/key1/entries/1.xml

のように、URLのプレフィクスに入れる方法を考えてみました。
この場合では、ActiveResourceの siteにプレフィクスまでを含めた URLを設定すればできるようです。

class Entry < ActiveResource::Base self.site = "http://api.example.com/api/key1/" end

次に、idをそのままプライマリキーに使えない場合。

例えば、外部の固定リソース(郵便番号情報とか)の上に RESTアプリをかぶせたりする場合、idをキーにすると外部リソースとの連携がしづらい。
例の Entryを日付をキーにしてとるような URLを考えてみる。

/api/key1/entries/20080415_001.xml

サーバ側では、config/routes.rbには以下のように設定します。
(ただし、Routing::RouteBuilderには、先日のエントリの修正をいれています。see. [Rails] routingの namespace。)

map.namespace :api, :path_prefix => '/api/:key' do |api| api.with_options :controller => 'entries' do |m| m.entries_show_date 'entries/:date.:format', :action => 'show' end end

EntriesController#showには、{ :key => "key1", :action => "show", :date => "20080415_001" } のようなパラメータが渡されるので、うまく検索できるように実装します。(^^;

クライアント側では、この URLだと ActiveResourceの find(1)のような方法では取得できないのですが、ActiveRecordの findと同様、いろいろできちゃうのが find()メソッド。(^^)v

ActiveResource::Base#findメソッドには、:fromというパラメータで URLを直接指定することができるようです。 したがって、

>> Entry.find(:one, :from => "/api/key1/entries/20080415_001.xml") => #<Entry:0xXXXXXXX @attributes={"title"=>...

のようにアクセスすることができます。
ちなみに、:fromパラメータには Request-URIを先頭から指定しないといけないようで、self.site に設定したプレフィクスには続けてくれないようです。

def self.find_by_date(date) find(:one, :from => "#{self.site.request_uri}entries/#{date}.xml") end

のようなメソッドを作るとよさそうですね。

他にも、element_pathという URLを作成するメソッド？があるので、そちらも使えそう。
Request-URIのプレフィクスが有効になるようです。
(こちらは逆に .xmlが勝手についてしまうので、外す方法が分かりません。A^^;)

>> Entry.element_path("20080415_001") => "/api/key1/entries/20080415_001.xml"

以下はサーバとクライアントのログ。

サーバ側 % ruby script/server => Booting WEBrick... => Rails application started on http://0.0.0.0:3000 => Ctrl-C to shutdown server; call with --help for options [2008-04-15 14:50:38] INFO WEBrick 1.3.1 [2008-04-15 14:50:38] INFO ruby 1.8.5 (2006-08-25) [i486-linux] [2008-04-15 14:50:38] INFO WEBrick::HTTPServer#start: pid=681 port=3000 127.0.0.1 - - [15/Apr/2008:15:04:21 JST] "GET /api/key1/entries/20080401_001.xml HTTP/1.1" 404 646 - -> /api/key1/entries/20080401_001.xml 127.0.0.1 - - [15/Apr/2008:15:05:30 JST] "GET /api/key1/entries/20080415_001.xml HTTP/1.1" 200 1870 - -> /api/key1/entries/20080415_001.xml

クライアント側 % ruby script/console >> Entry.find(:one, :from => "#{Entry.site.request_uri}20080415_001.xml") ActiveResource::ResourceNotFound: Failed with 404 Not Found : >> Entry.find(:one, :from => "#{Entry.site.request_uri}20080415_001.xml") => #<Entry:0xXXXXXXXX @attributes={"title"=>"今日の出来事", "text"=>"ActiveResourceを始めて使った。" ...

プロセス間通信の実験みたい(プロセス間通信だけど)で面白い♪

でも、まだまだ試行錯誤ですねぇ～ (^^)/~