RESTfulie - ハイパーメディアを意識したサービスとクライアントを生成するGem

原文(投稿日：2009/11/11)へのリンク

Guilherme Silveira氏が今回のruby gemのリリースに伴ってInfoQに寄稿した。このgemはハイパーメディアを意識したサービスと、それを利用するクライアントの開発を実に簡単にするというものだ。氏は次のように語る。

restもしくはrestfulな考え方をアプリケーションで使うことの利点については多くが語られてきました。昨年はMark Baker氏がrestfulアプリケーションにおけるハイパーメディア・コンテンツについて記事を書いていますし、HATEOASを定義するという、より正式な試みとその利点について書かれたものも多少はあります。しかし、ウェブベースのサービスを作り出す上で、ウェブをうまく使っていることは確かにあるのですが、それでも私たちが日常使っている最も便利なものが、未だに欠けています。 それが、ハイパーリンクとハイパーメディア・コンテンツなのです。

氏は続けて、ある注文を定義している具体例について説明した。この注文は適切に定義された一連の状態遷移を進んでいく。例えば、未払いから支払い後といったようにである。これはまた、さまざまな状態遷移をそれに対応するアクションにマッピングできるようにもなっている。

class Order < ActiveRecord::Base 
  state :unpaid, :allow => [:latest, :pay, :cancel]
  state :cancelled, :allow => :latest

  transition :latest, {:action => :show}
  transition :cancel, {:action => :destroy}, :cancelled
  transition :pay, {}, :preparing 
end

これは例えばatomベースのリソース表現を生成するが、そこにはハイパーメディアが埋め込まれている。

<order> 
   <product>basic rails course</product> 
   <product>RESTful training</product> 
   <atom:link xmlns:atom="http://www.w3.org/2005/Atom" 
          href="http://www.caelum.com.br/orders/1" rel="latest" /> 
   <atom:link xmlns:atom="http://www.w3.org/2005/Atom" 
          href="http://www.caelum.com.br/orders/1/pay" rel="pay" /> 
   <atom:link xmlns:atom="http://www.w3.org/2005/Atom" 
          href="http://www.caelum.com.br/orders/1" rel="cancel" /> 
</order> 

そして、クライアントは、そのリソース表現を利用することで、動的に生成されたメソッドを呼び出すことができるのだ。

order = Order.from_web 'http://caelum.com.br/orders/1' 
order.pay(payment) 

Jim Webber氏のRESTBucks記事と、刊行予定のREST本はこのgemを作るにあたってインスピレーションを与えているのだが、そのWebber氏は次のように語った。

多才なGuilherme Silveira氏とAdriano Almeida氏、Lucas Cavalcanti氏はRESTfulなサービスのフロントを形成するものを作り上げました。（中略）より重要なのは、彼らがこのプロトコルを調べるのに使用できる汎用的なクライアントを書き上げたということです。彼らはデモサービスをGAE上にホスティングしており、コードは誰もが楽しめるようにGitHub上にリリースしています。これは素晴らしい仕事であり、時期を得たものでもあります。

共著者であるSavas Parastatidis氏は次のようにコメントしている。

私たちの本を書き上げるのが待ち遠しくてたまりません。そうすれば、誰もがハイパーメディアに関する私たちの議論と私たちが作ったものをチェックできるようになるからです。Restfulieが私たちと実に良く似たアプローチを取っているのを見て本当にうれしく思いました。

RESTfulなサービスとそれを利用するクライアントを作る上でのgemの使い方について、詳細な具体例はGitHubプロジェクトリポジトリで入手できる。