Advanced RESTful Rails Guide
Uploaded by
Dmytro ShteflyukAdvanced RESTful Rails Guide
Uploaded by
Dmytro ShteflyukAdvanced RESTful Rails
Ben Scofield
Constraints
Shall I compare thee to a summer's day?
Thou art more lovely and more temperate.
Rough winds do shake the darling buds of May,
And summer's lease hath all too short a date.
Sometime too hot the eye of heaven shines,
And often is his gold complexion dimm'd;
And every fair from fair some time declines,
By chance, or nature's changing course, untrimm'd;
But thy eternal summer shall not fade
...
app
controllers
helpers
models
views
config
environments
initializers
db
doc
lib
tasks
log
public
images
javascripts
stylesheets
script
performance
process
test
fixtures
functional
integration
unit
...
exists app/models/
exists app/controllers/
exists app/helpers/
create app/views/users
exists test/functional/
exists test/unit/
dependency model
exists app/models/
exists test/unit/
exists test/fixtures/
create app/models/[Link]
create test/unit/user_test.rb
create test/fixtures/[Link]
create db/migrate
create db/migrate/20080531002035_create_users.rb
create app/controllers/users_controller.rb
create test/functional/users_controller_test.rb
create app/helpers/users_helper.rb
route [Link] :users
REST
Audience Participation!
who is building restful applications?
212,000 Results
How do I handle ...
Difficult
even for the pros
class UsersController < ApplicationController
# ...
def activate
self.current_user = params[:activation_code].blank? ? false : # ...
if logged_in? && !current_user.active?
current_user.activate!
flash[:notice] = "Signup complete!"
end
redirect_back_or_default('/')
end
def suspend
@[Link]!
redirect_to users_path
end
def unsuspend
@[Link]!
redirect_to users_path
end
def destroy
@[Link]!
redirect_to users_path
end
def purge
@[Link]
redirect_to users_path
Restful Authentication
end
end
What is REST?
Resources
hey-helen - flickr
Addressability
memestate - flickr
Representations
stevedave - flickr
Stateless*
[Link]
Audience Participation!
why care?
Process
tiptoe - flickr
Domain
ejpphoto - flickr
Modeled
kerim - flickr
?
Identify
resources
Select
methods to expose
Respect
the middleman
Simple
My Pull List
Releases
ActionController::Routing::[Link] do |map|
[Link] 'releases/:year/:month/:day',
:controller => 'items', :action => 'index'
end
class ItemsController < ApplicationController
# release listing page; filters on year/month/day from params
def index; end
end
Issues
ActionController::Routing::[Link] do |map|
[Link] :issues
end
class IssuesController < ApplicationController
# issue detail page
def show; end
end
Series
ActionController::Routing::[Link] do |map|
[Link] :titles
end
class TitlesController < ApplicationController
# title detail page
def show; end
end
ActionController::Routing::[Link] do |map|
[Link] :titles, :has_many => [:issues]
end
class IssuesController < ApplicationController
# issue listing page; could be series page
def index; end
end
Users
ActionController::Routing::[Link] do |map|
[Link] :users
end
class UsersController < ApplicationController
before_filter :require_login, :only => [:edit, :update]
# edit account
def edit; end
# update account
def update; end
end
Lists
ActionController::Routing::[Link] do |map|
[Link] :users
end
class UsersController < ApplicationController
# public view - pull list
def show; end
end
ActionController::Routing::[Link] do |map|
[Link] :users, :has_many => [:titles]
end
class TitlesController < ApplicationController
# public view - pull list, given a user_id
def index; end
end
Advanced
Login* mc - flickr
ActionController::Routing::[Link] do |map|
[Link] :session
end
class SessionsController < ApplicationController
# login form
def new; end
# login action
def create; end
# logout action
def destroy; end
end
Homepage seandreilinger - flickr
ActionController::Routing::[Link] do |map|
[Link] :homepage
[Link] :homepage
end
class HomepagesController < ApplicationController
# homepage
def show; end
end
ActionController::Routing::[Link] do |map|
[Link] :contents
[Link] :controller => ‘contents’, :action => ‘show’,
:page => ‘homepage’
end
class ContentsController < ApplicationController
# static content
def show
# code to find a template named according to params[:page]
end
end
ActionController::Routing::[Link] do |map|
[Link] :ads
[Link] :ads
end
class AdsController < ApplicationController
# ad index - the million dollar homepage
def index; end
end
Dashboard hel2005 - flickr
ActionController::Routing::[Link] do |map|
[Link] :dashboard
end
class DashboardsController < ApplicationController
before_filter :require_login
# dashboard
def show; end
end
ActionController::Routing::[Link] do |map|
[Link] :instruments
end
class InstrumentsController < ApplicationController
before_filter :require_login
# dashboard
def index
@instruments = current_user.instruments
end
end
Preview ashoe - flickr
ActionController::Routing::[Link] do |map|
[Link] :posts, :has_one => [:preview]
end
class PreviewsController < ApplicationController
def create
@post = [Link](params[:post_id])
@[Link] = params[:post]
render :template => 'posts/show'
end
end
ActionController::Routing::[Link] do |map|
[Link] :posts
[Link] :preview
end
class PreviewsController < ApplicationController
def create
@post = [Link](params[:post])
render :template => 'posts/show'
end
end
Search seandreilinger - flickr
ActionController::Routing::[Link] do |map|
[Link] :posts
end
class PostsController < ApplicationController
def index
if params[:query].blank?
@posts = [Link](:all)
else
@posts = Post.find_for_query(params[:query])
end
end
end
ActionController::Routing::[Link] do |map|
[Link] :search
end
class SearchesController < ApplicationController
def show
@results = [Link](params[:query])
end
end
Wizards dunechaser - flickr
/galleries/new
/restaurants/:id/photos/new
/restaurants/:id/photos/edit
ActionController::Routing::[Link] do |map| [Link] :galleries
[Link] :galleries
[Link] :restaurants, :has_many => [:photos]
map.with_options :controller => 'photos' do |p|
p.edit_restaurant_photos 'restaurants/:restaurant_id/photos/edit',
:action => 'edit'
p.update_restaurant_photos 'restaurants/:restaurant_id/photos/update',
:action => 'update',
:conditions => {:method => :put}
end
end
Collections wooandy - flickr
Web Services josefstuefer - flickr
Staff Directory
Inventory
Search Application Text
RESTful API
HR
etc.
RESTful API Staff Directory
RESTful API Inventory
Search Application Text
RESTful API HR
RESTful API etc.
this slide left intentionally blank
Administration
ActionController::Routing::[Link] do |map|
[Link] :admin do |admin|
[Link] :invitations
[Link] :emails
[Link] :users
[Link] :features
end
end
Audience Participation!
what gives you fits?
Rails, Specifically
<%= link_to 'Delete', record, :method => 'delete',
:confirm => 'Are you sure?' %>
<a href="/records/1" onclick="if (confirm('Are you sure?')) { var f =
[Link]('form'); [Link] = 'none';
[Link](f); [Link] = 'POST'; [Link] = [Link];var m =
[Link]('input'); [Link]('type', 'hidden');
[Link]('name', '_method'); [Link]('value', 'delete');
[Link](m);[Link](); };return false;">Delete</a>
Accessibility
ActionController::Routing::[Link] do |map|
[Link] 'users', :controller => ‘users’, :action => ‘index’
[Link] 'users', :controller => ‘users’, :action => ‘create’
end
Hand-Written Routes
ActionController::Routing::[Link] do |map|
[Link] :users
# Install the default route as the lowest priority.
[Link] ':controller/:action/:id'
end
Default Routing
Collections wooandy - flickr
ActionController::Routing::[Link] do |map|
[Link] :records
end
class RecordsController < ApplicationController
def index; end
def show; end
# ...
end
Mixed
ActionController::Routing::[Link] do |map|
[Link] :record_list
[Link] :records
end
class RecordListsController < ApplicationController
def show; end
# ...
end
class RecordsController < ApplicationController
def show; end
# ...
end
Separated
Audience Participation!
where’s rails bitten you?
Thanks!
ben scofield
[Link]@[Link]
[Link]
[Link]