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

RESTアプリケーションはステートレスなので、認証が必要な場合は毎回リクエスト毎に認証が必要になります。

認証方法は HTTP Basic認証が推奨？されていて、Rails 2.0では Basic認証機能が強化(追加？)されてるようですね。

クライアント側でのリソースの参照に ActiveResourceを使う場合は、サイトのURLにユーザ名、パスワードを追加しておけばOKです。

class Entry < ActiveResource::Base self.site = "http://user1:pass1@localhost:3000/" end

こうしておけば、リクエスト時に Authorizationヘッダを追加してくれるんですね。

ところで、この site属性はクラススコープなので、リソース単位に一意になるんですが、複数のアカウントで切り替えたい場合(普通はないのかな？)にちょっと困ります。

ActiveResourceでは siteのURLを元に、connection属性(これもクラススコープ)を作っているようなので、これをいじればいいのかもしれません。

別の方法として、headers属性(ハッシュ、クラススコープ)というのがあって、ここにヘッダを追加しておくと、リクエスト送信時にヘッダに追加してくれるようです。

ということは、ここに Authorizationヘッダを追加してやれば、動的に認証情報を設定できるのかも。。

というわけで、以前作った MultiModelScope(see. [Rails] 複数のモデルに with_scope。)を真似て、MultiResourceScopeというのを作ってみました。

複数のリソースにまたがって、動的に認証を切り替えたいという場合に使えます。

class MultiResourceScope def initialize @resources = [] end def resources ; @resources ; end def with_authorization(user, password = "", &block) begin # Basic 認証のみ credential = ["#{user}:#{password}"].pack('m').delete("\r\n") resources.each do |r| r.headers['Authorization'] = "Basic #{credential}" end yield ensure resources.each do |r| r.headers.delete('Authorization') end end end end

こんなカンジに使うことを想定。

scope = MultiResourceScope.new scope.resources << Entry scope.resources << Archive e = Entry.find(1) => ActiveResource::ClientError: Failed with 401 Unauthorized # ★認証エラー : a = Archive.find(1) => ActiveResource::ClientError: Failed with 401 Unauthorized # ★認証エラー : # ブロック内で認証 scope.with_authorization("user1", "pass1") do e = Entry.find(1) puts "#{e}: #{e.owner}" a = Archive.find(1) puts "#{a}: #{a.owner}" end # 別のアカウントで認証 scope.with_authorization("user2", "pass2") do e = Entry.find(1) puts "#{e}: #{e.owner}" a = Archive.find(1) puts "#{a}: #{a.owner}" end => "Entry: user1" "Entry: user1" "Entry: user2" "Entry: user2"

認証方法を変えられるようにしたり便利かも。A^^;

投稿者: kawabata 日時: 20:00 | パーマリンク | コメント (0) | トラックバック (0)

韓国語版を開発しました。

５月ぐらいには、配布できるようになると思います。

画面ショットは、こんな感じです。

投稿者: nagase 日時: 14:32 | パーマリンク | コメント (0) | トラックバック (0)

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

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を始めて使った。" ...

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

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

投稿者: kawabata 日時: 23:00 | パーマリンク | コメント (0) | トラックバック (0)

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

tidusさんの TracGanttCalendarというプラグインの Trac-0.10対応。

[Trac]TracGanttCalendarプラグイン
http://tidus.ultimania.org/diary/?date=20071020#p01

カレンダーとチケットの連携と、ガントチャートの描画ができるようになるプラグインです。
オリジナルは 0.11以降にのみ対応なのですが、インタアクト製の trac-ja(Trac-0.10.4)な環境で使いたかったので、移植してみました。

ロジック部分は 0.10と 0.11でそれほど変更なさそうなので、軽い気持ちで着手したら、テンプレートエンジンが ClearSilverってやつから、Genshiってのに変更になってて、実は差分がでかいということを知り、えらい目に会いました。A^^;

TracGanttCalendar 0.1(2008/4/12現在、trunkから取ってきた最新)をベースにしています。
(バージョンのつけ方がよく分からないので、0.0.1としています。)

以下、インストール方法です。

ファイルをダウンロード。
TracGanttCalendar 0.0.1

ファイルを展開。
> tar zxvf ganttcalendar-XXX.tar.gz

eggファイルを作る。
> cd ganttcalendar-XXX/
> python setup.py bdist_egg

eggファイルを pluginフォルダにコピー。
> cp dist/TracGanttCalendarPlugin-XXX-pyXX.egg /path/to/tracprj/plugins/

Apache再起動。
# /etc/init.d/apache restart

インストールが完了したら、トップのナビゲーションバーに、「カレンダー」と「ガント」が追加されます。

いまさら、0.10対応なんて必要な人いないかもしれないけど、どうぞ。A^^;

追記 (2008/4/24):
カレンダーのマイルストーン表示にエラーがあったので、修正版をアップしました。
(上のリンクからダウンロード可)

追記 (2008/4/25):
TracGanttCalendarのリポジトリにブランチ作成してもらいました♪
http://svn.sourceforge.jp/svnroot/shibuya-trac/plugins/ganttcalendarplugin/branches/0.10/

下記のコマンドでチェックアウトできます。

svn co http://svn.sourceforge.jp/svnroot/shibuya-trac/plugins/ganttcalendarplugin/branches/0.10/ ganttcalendarplugin

投稿者: kawabata 日時: 17:15 | パーマリンク | コメント (12) | トラックバック (0)

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

routing周りのコード見ていて気になったんですが。。
(Railsのバージョンは 2.0.1)

actionpack-X.X.X/lib/action_controller/routing.rb Routing::RouteBuilder#divide_route_options(segments, options) ---- if options[:namespace] options[:controller] = "#{options[:path_prefix]}/#{options[:controller]}" options.delete(:path_prefix) options.delete(:name_prefix) options.delete(:namespace) end

という部分は、

if options[:namespace] options[:controller] = "#{options[:namespace]}/#{options[:controller]}" ★ options.delete(:path_prefix) options.delete(:name_prefix) options.delete(:namespace) end

となるのが正しいんじゃないかと。。A-_-;;

• namespace -> コントローラのプレフィクス
• path_prefix -> URLのプレフィクス
• name_prefix -> URL名のプレフィクス

routingのテストには path_prefixありのケースがない(resourcesにはたくさん)ようなので、どうあるべきかが分かりません。。うーん。A^^;

投稿者: kawabata 日時: 18:06 | パーマリンク | コメント (0) | トラックバック (0)

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

複数のモデルに対してあるカラムでフィルタリングしたい(ローカライズとか)と思って、ActiveRecordの with_scopeを調べてみました。

Rails 2.0からは with_scopeは protectedメソッドになっていて、外部からはそのままでは呼べなくなったんですね。
コントローラのフィルタを使う scoped_accessというプラグイン(舞波さん製)を使うのが主流なのかな？

scoped_access
http://wota.jp/svn/rails/plugins/branches/stable/scoped_access
http://wota.jp/ac/?date=20060105

どうも、複数モデルにまたがってスコープかけるという話はなさそうで、コントローラのフィルタにしてしまうのもピンとこない。

やりたいことはこんなカンジ。

• 複数モデルにまたがって with_scopeしたい。
• モデル外(コントローラとか)からスコープを指定したい。
• モデル内で sessionは見たくない。
• スコープ範囲のブロックを細かく指定したい。(旧バージョンの AR#with_scopeを直接呼ぶイメージ)

class MultiModelScope def initialize @models = [] end def models ; @models ; end def with_scope(method_scoping = {}, &block) begin models.each do |m| m.logger.debug("MultiModelScope#with_scope [%s] scope becoms %s" % [m, method_scoping.inspect]) m.instance_eval do scoped_methods << method_scoping end end yield ensure models.each do |m| m.instance_eval do scoped_methods.pop end m.logger.debug("MultiModelScope#with_scope [%s] scope restored to %s" % [m, m.send(:scoped_methods).inspect]) end end end end

たとえば、こんなカンジで使うことを想定。
複数モデルに ローカライズを行う例です。

# ローカライズのクラスを作成 class Localize < MultiModelScope def lang_scope(n, &block) n = n.to_s scope = { :find => { :conditions => ["lang=?", n] } } with_scope(scope) do yield end end end # モデルたち (ともに langフィールドを持っている) class Movie < ActiveRecord::Base end class Category < ActiveRecord::Base end # ローカライズをかけたいモデルを追加 localize = Localize.new localize.models << Movie localize.models << Category localize.lang_scope(:ja) do # 日本語の映画を検索 Movie.find(:all).each {|m| puts "#{m.lang}: #{m.name}" } Category.find(:all).each {|c| puts "#{c.lang}: #{c.name}" } end localize.lang_scope(:en) do # 英語の映画を検索 Movie.find(:all).each {|m| puts "#{m.lang}: #{m.name}" } Category.find(:all).each {|c| puts "#{c.lang}: #{c.name}" } end => ja: 天空の城ラピュタ ja: 魔女の宅急便 ja: ハリー・ポッターと秘密の部屋 ja: アニメ ja: ファンタジー en: LAPUTA: Castle in the Sky en: Kiki's Delivery Service en: Harry Potter and the Chamber of Secrets en: Animation en: Fantasy

すでにある方法でうまくできるのかもしれないんだけど。。A^^;

投稿者: kawabata 日時: 14:05 | パーマリンク | コメント (0) | トラックバック (0)