丸山先生レクチャーシリーズ2007-2008

Ruby on Rails における REST ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. dispatcher.cgi routes.rb Controller View Model Database 呼び出す Controller を特定 O/R マッピング Model への操作と View の決定 HTML や XML のレンダリング ActionPack ActiveRecord

Ruby on Rails における REST ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09

Ruby on Rails における REST ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 Rails 2.0 では REST がメインとなる

RESTful サービスへのアクセス ,[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 Business Object ActiveResource RESTful WebService 普通の Object へのアクセス透過的なプロキシとして機能する Object と REST リソースのマッピング

RESTful サービスへのアクセス ,[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 Business Object Active Resource RESTful WebService Object と REST リソースのマッピング Business Object Active Record Object と Database Entity のマッピング Database

RESTful サービスへのアクセス ,[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 emp = Employee.new emp.name = ‘yoichiro’ emp. save emp = Employee. find (13308) p emp.name # => “yoichiro” emp = Employee. find (13308) emp. destroy Employee. delete (12345) emp = Employee. find (13308) emp.name = ‘yojiro’ emp. save 生成検索更新削除

RESTful サービスへのアクセス ,[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 class Status < ActiveResource::Base self. site = ‘http:// [ ユーザ ID]:[ パスワード ]@ twitter.com’ self. logger = Logger.new($stderr) end ActionResource::Base クラスを継承 site クラス変数にリソースの在り処を指定リソース名をクラス名にする logger クラス変数に設定すると URL が見える HTTP BASIC 認証

RESTful サービスへのアクセス ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 >> s = Status.find(‘show/485685072’) => #<Status:0xb58ad1 @prefix_options={}, @attributes={"text"=>"ActiveResource43014743012343015643027143030643037443430306430271430310 ！ ", "id"=>"485685072", "source"=>"web", "created_at"=>"Mon Dec 10 06:42:46 +0000 2007"}> >> GET http://twitter.com:80/statuses/show/485685072.xml --> 200 OK (733b 0.34s) >> puts s.text ActiveResource でこのステータス取得をテスト！ => nil

RESTful サービスへのアクセス 2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. Person.find(:all) # => GET /people.xml Person.find(:all, :params => { :title => "CEO" }) # => GET /people.xml?title=CEO Person.find(:first, :from => :managers) # => GET /people/managers.xml Person.find(:all, :from => "/companies/1/people.xml") # => GET /companies/1/people.xml Person.find(:one, :from => :leader) # => GET /people/leader.xml Person.find(:one, :from => "/companies/1/manager.xml") # => GET /companies/1/manager.xml StreetAddress.find(1, :params => { :person_id => 1 }) # => GET /people/1/street_addresses/1.xml

RESTful サービスへのアクセス ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. link_to_remote "Delete this post", :update => "posts", :url => post_url(@post), :method => :delete , :html => { :class => "destructive" } ヘルパーメソッドが method 指定をサポート <a class="destructive" href="#" onclick="new Ajax.Updater('posts', 'http://localhost:3000/employees/3', {asynchronous:true, evalScripts:true, method:'delete' , parameters:'authenticity_token=' + encodeURIComponent('520fb86f42576048061a5c408604c52411df8841')}); return false;">Delete this employee</a>

RESTful サービスの実装 ,[object Object],[object Object],[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 Scaffold Code EmployeesController Employee Model Views

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 $ jruby ./script/generate scaffold employee # GET /employees/1 # GET /employees/1.xml def show @employee = Employee.find(params[:id]) respond_to do |format| format.html # show.html.erb format.xml {render :xml => @employee} end end employees_controller.rb ActionController::Routing::Routes.draw do |map| map.resources :employees routes.rb

RESTful サービスの実装 ,[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 routes.rb map.resources Controller ActiveRecord Database 規則に従って、 HTTP Method および PATH から呼び出す Controller を選定各メソッド内で ActiveRecord によりリソースを取得・更新処理結果を HTTP Status に、リソースを XML 形式に変換して返却

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 ActionController::Routing::Routes.draw do |map| map.resources :employees end EmployeesController のメソッド Verb Path Method Parameter GET /employees index GET /employees/1 show :id => 1 POST /employees create PUT /employees/1 update :id => 1 DELETE /employees/1 destroy :id => 1

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 map.resources :divs do |divs| divs.resources :employees end EmployeesController のメソッドリソースのネスト定義より多段にすることも可能 Verb Path Method Parameter GET /divs/1/employees index :div_id => 1 GET /divs/1/employees/2 show :div_id => 1 :id => 2 POST /divs/1/employees create :div_id => 1 PUT /divs/1/employees/2 update :div_id => 1 :id => 2 DELETE /divs/1/employees/2 destroy :div_id => 1 :id => 2

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 def index @employees = Employee.find(:all) respond_to do |format| format.html # index.html.erb format.xml { render :xml => @employees } end end routes.rb によるマッピング「 .xml 」なので、モデルの内容が XML 形式でレンダリングされる

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 format.xml { render :xml => @employees } <?xml version="1.0" encoding="UTF-8"?> <employees type="array"> <employee> <id type="integer">3</id> <name>Yoichiro Tanaka</name> </employee> ・・・ </employees> View を作らなくてもレンダリングされる

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 def show begin @employee = Employee.find(params[:id]) respond_to do |format| format.html # show.html.erb format.xml { render :xml => @employee } end rescue ActiveRecord::RecordNotFound head :not_found end end routes.rb によるマッピング「 .xml 」なので、モデルの内容が XML 形式でレンダリングされるリソースがない場合は 404 を返す

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 def create @employee = Employee.new(params[:employee]) respond_to do |format| if @employee.save format.html { redirect_to(@employee) } format.xml { render :xml => @employee, :status => :created, :location => @employee } else ・・・ end routes.rb によるマッピング新規作成処理の結果、ステータスコードは 201 Location ヘッダはリソースの URI を返却する

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 def update begin @employee = Employee.find(params[:id]) respond_to do |format| if @employee.update_attribute(params[:employee]) format.html { redirect_to(@employee) } format.xml { head :ok } else ・・・ rescue ActiveRecord::RecordNotFond head :not_found end end routes.rb によるマッピング更新処理の結果、ステータスコードは 200 を返却するリソースがない場合は 404 を返す

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 def destroy begin @employee = Employee.find(params[:id]) @employee.destroy respond_to do |format| format.html { redirect_to(employees_url) } format.xml { head :ok } end rescue ActiveRecord::RecordNotFond head :not_found end end routes.rb によるマッピング削除処理の結果、ステータスコードは 200 を返却するリソースがない場合は 404 を返す

RESTful サービスの実装 ,[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved.

RESTful サービスの実装 ,[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 routes.rb map.resources Controller ActiveRecord Database 規則に従って、 HTTP Method および PATH から呼び出す Controller を選定各メソッド内で ActiveRecord によりリソースを取得・更新 atom.builder filter View で Atom Feed を構築して返却リクエストの XML を params ハッシュに変換

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. atom_feed do |feed| feed.title("My great blog!") feed.updated((@posts.first.created_at)) for post in @posts feed.entry(post) do |entry| entry.title(post.title) entry.content(post.body, :type => 'html') entry.author do |author| author.name("DHH") end end end end View ヘルパーを使う

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. def parse_request_xml if /^applicationatomxml/.match( request.env[“CONTENT_TYPE”] ) xml = REXML::Document.new(request.raw_post) params[:post] = { :title => xml.elements[“ entry/title ”].text :content => xml.elements[“ entry/content ”].text } end return true end 変換ロジックは自作するこのメソッドを before フィルタとしておくと良い XML をパースして、各要素から params ハッシュに格納 request.format = Mime::ATOM でも可

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. def create @post = Post.new( params[:post] ) @post.save respond_to do |format| format.atom do headers[“Content-Type”] = “ application/atom+xml;type=entry” render :action => “show”, :status => :created, :location => post_url(@post) + “.atom” end end end parse_request_xml により params[:post] が利用可能 POST /posts.atom により format.atom が対応新規投稿処理の結果、ステータスコードは 201 Location ヘッダはリソースの URI を返却する

RESTful サービスの実装 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. xml .instruct! xml.entry(“xml:lang” => “ja”, “ xmlns” => “http://www.w3.org/2005/Atom”) do |entry| entry.title(@post.title) entry.content(@post.body, :type => 'html') entry.author do |author| author.name("DHH") end end Builder::XmlMarkup を使って構築

認証処理 ,[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. class ApplicationController < ActionController::Base before_filter :authenticate protected def authenticate if request.format == Mime::ATOM if user = authenticate_with_http_basic { |u, p| @account.authenticate(u, p) } @current_user = user else request_http_basic_authentication end else request からユーザ ID およびパスワードを取得して認証を実施認証失敗時に再度ブラウザに認証情報送信を要求 AtomPub の場合

認証処理 ,[object Object],[object Object],[object Object],[object Object],[object Object],2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. 05/29/09 X-WSSE: UsernameToken Username=“yoichiro", PasswordDigest="ZCNaK2jrXr4+zsCaYK/YLUxImZU=", Nonce="Uh95NQlviNpJQR1MmML+zq6pFxE=", Created="2007-12-11T22:51:15Z"

認証処理 2007/12/18 (c) 2007 Yoichiro Tanaka. All rights Reserved. require ‘base64’ def auth_wsse @@wsse_pattern ||= /^UsernameToken Username="([^"]+)",PasswordDigest= "([^"]+)",Nonce="([^"]+)",Created="([^"]+)"$/ if request.env['HTTP_X_WSSE'] && @@wsse_pattern =~ request.env['HTTP_X_WSSE'] username = $1 passwd = Base64.decode64($2) nonce = Base64.decode64($3) created = $4 return username == ‘yoichiro‘ && Digest::SHA1.digest( nonce + created + ‘pass’) == passwd else ・・・ end 正規表現により認証情報を取得パスワードと付加情報から SHA1 ダイジェストを生成し比較これも before フィルタとしておけば便利

丸山先生レクチャーシリーズ2007-2008

Recommended

Recommended

More Related Content

Viewers also liked

Viewers also liked (18)

Similar to 丸山先生レクチャーシリーズ2007-2008

Similar to 丸山先生レクチャーシリーズ2007-2008 (20)

More from Yoichiro Tanaka

More from Yoichiro Tanaka (10)

丸山先生レクチャーシリーズ2007-2008