1. http://www.rails.in.th
Developing API with Rails

2. Sponsors
http://www.artellectual.com http://www.oozou.com

3. Who Am I
Sakchai (Zack) Siripanyawuth
twitter: @artellectual
developer at Artellectual

4. Options
• LightRail - https://github.com/lightness/lightrail
• RocketPants (i am not joking) - https://github.com/
filtersquad/rocket_pants
• Sinatra Mounted into a Rails App - http://
www.sinatrarb.com/
• Good Ol’ - ActionController::Base

5. Why Rails Metal
• Because its thinner
• Benefits of rails is a few lines of code away
• Less context switching (ie same
conventions)
• Easy to do Hybrid Apps
• Modular
• No need to write Boilerplate Code

6. Something to keep in mind

7. VS

8. MODULES = [
AbstractController::Layouts,
AbstractController::Translation,
AbstractController::AssetPaths,
Helpers,
HideActions,
UrlFor,
Redirecting,
Rendering,
Renderers::All,
ConditionalGet,
RackDelegation,
Caching,
MimeResponds,
ImplicitRender,
Cookies,
Flash,
RequestForgeryProtection,
ForceSSL,
Streaming,
VS
DataStreaming,
RecordIdentifier,
HttpAuthentication::Basic::ControllerMethods,
HttpAuthentication::Digest::ControllerMethods,
HttpAuthentication::Token::ControllerMethods,
AbstractController::Callbacks,
Rescue,
Instrumentation,
ParamsWrapper
]

9. MODULES = [ include ActionController::Helpers
AbstractController::Layouts, include ActionController::Redirecting
AbstractController::Translation, include ActionController::Rendering
AbstractController::AssetPaths, include ActionController::Renderers::All
Helpers, include ActionController::ConditionalGet
HideActions, include ActionController::MimeResponds
UrlFor, include ActionController::RequestForgeryProtection
Redirecting, include ActionController::ForceSSL
Rendering, include AbstractController::Callbacks
Renderers::All, include ActionController::Instrumentation
ConditionalGet, include ActionController::ParamsWrapper
RackDelegation, include Devise::Controllers::Helpers
Caching,
MimeResponds,
ImplicitRender,
Cookies,
Flash,
RequestForgeryProtection,
ForceSSL,
Streaming,
VS
DataStreaming,
RecordIdentifier,
HttpAuthentication::Basic::ControllerMethods,
HttpAuthentication::Digest::ControllerMethods,
HttpAuthentication::Token::ControllerMethods,
AbstractController::Callbacks,
Rescue,
Instrumentation,
ParamsWrapper
]

10. MODULES = [ include ActionController::Helpers
AbstractController::Layouts, include ActionController::Redirecting
AbstractController::Translation, include ActionController::Rendering
AbstractController::AssetPaths, include ActionController::Renderers::All
Helpers, include ActionController::ConditionalGet
HideActions, include ActionController::MimeResponds
UrlFor, include ActionController::RequestForgeryProtection
Redirecting, include ActionController::ForceSSL
Rendering, include AbstractController::Callbacks
Renderers::All, include ActionController::Instrumentation
ConditionalGet, include ActionController::ParamsWrapper
RackDelegation, include Devise::Controllers::Helpers
Caching,
MimeResponds,
ImplicitRender,
Cookies,
Flash,
RequestForgeryProtection,
ForceSSL,
Streaming,
VS
DataStreaming,
RecordIdentifier,
HttpAuthentication::Basic::ControllerMethods,
HttpAuthentication::Digest::ControllerMethods,
HttpAuthentication::Token::ControllerMethods,
AbstractController::Callbacks,
Rescue,
Instrumentation,
ParamsWrapper
]
28 Modules

11. MODULES = [ include ActionController::Helpers
AbstractController::Layouts, include ActionController::Redirecting
AbstractController::Translation, include ActionController::Rendering
AbstractController::AssetPaths, include ActionController::Renderers::All
Helpers, include ActionController::ConditionalGet
HideActions, include ActionController::MimeResponds
UrlFor, include ActionController::RequestForgeryProtection
Redirecting, include ActionController::ForceSSL
Rendering, include AbstractController::Callbacks
Renderers::All, include ActionController::Instrumentation
ConditionalGet, include ActionController::ParamsWrapper
RackDelegation, include Devise::Controllers::Helpers
Caching,
MimeResponds,
ImplicitRender,
Cookies,
Flash,
RequestForgeryProtection,
ForceSSL,
Streaming,
VS
DataStreaming,
RecordIdentifier,
HttpAuthentication::Basic::ControllerMethods,
HttpAuthentication::Digest::ControllerMethods,
HttpAuthentication::Token::ControllerMethods,
AbstractController::Callbacks,
Rescue,
Instrumentation,
ParamsWrapper
]
28 Modules 12 Modules

12. How much faster?
ActionController::Base
ActionController::Metal
1200
1200
900
600
300
400
0
Rails
not so fine print:
*take these numbers with a grain of salt / benchmark yourself

13. Let’s Code!

14. /app/controllers/application_controller.rb

15. /app/controllers/application_controller.rb
class ApplicationController < ActionController::Base
# All kinds of magic
end

16. /app/controllers/api_controller.rb

17. /app/controllers/api_controller.rb
class ApiController < ActionController::Metal # inherit from Metal instead of Base
include ActionController::Helpers
include ActionController::Redirecting
include ActionController::Rendering
include ActionController::Renderers::All
include ActionController::ConditionalGet
# need this for responding to different types .json .xml etc...
include ActionController::MimeResponds
include ActionController::RequestForgeryProtection
# need this if your using SSL
include ActionController::ForceSSL
include AbstractController::Callbacks
# need this to build 'params'
include ActionController::Instrumentation
# need this for wrap_parameters
include ActionController::ParamsWrapper
include Devise::Controllers::Helpers
# need make your ApiController aware of your routes
include Rails.application.routes.url_helpers
# tell the controller where to look for templates
append_view_path "#{Rails.root}/app/views"
# you need this to wrap the parameters correctly eg
# { "person": { "name": "Zack", "email": "sakchai@artellectual.com", "twitter": "@artellectual" }}
wrap_parameters format: [:json]
# might not need this (depends on your client) rails bypasses automatically if client is not browser
protect_from_forgery
end

18. config/routes.rb

19. config/routes.rb
namespace "api" do
resources :contacts
resources :comments
resources :photos
end

20. config/routes.rb
namespace "api" do
resources :contacts
resources :comments
resources :photos
end
example:

21. config/routes.rb
namespace "api" do
resources :contacts
resources :comments
resources :photos
end
example:
www.greatapp.com/api/contacts

22. /app/controllers/api/contacts_controller.rb

23. /app/controllers/api/contacts_controller.rb
class Api::ContactsController < ApiController
# more magic goes here
end

24. Lets look at Views
• RABL - https://github.com/nesquena/rabl
• jbuilder - https://github.com/rails/jbuilder
• jsonify - https://github.com/bsiggelkow/
jsonify

25. Testing with json_spec
https://github.com/collectiveidea/json_spec
describe "/contacts/:id.json" do
before(:each) do
get :show, id: @client.id, format: :json
end
it "should render the correct template for SHOW" do
response.should render_template("api/contacts/show")
end
it "should render the correct attributes for contact" do
response.body.should have_json_path("id")
response.body.should have_json_path("first_name")
response.body.should have_json_path("last_name")
response.body.should have_json_path("type")
response.body.should have_json_path("updated_at")
end
end

26. Thank You !