Rails%203%20In%20Action

Versioning an API
last_response.body.should eql(body)
projects = Nokogiri::XML(last_response.body)
projects.css("project title").text.should eql("Ticketee")
projects.css("project name").text.should eql("")
end
When you run this test using bin/rspec spec/api/v2/projects_spec.rb, it’s broken:
Failure/Error: last_response.body.should eql(body)
expected "[{[ticket hash without name key]}]"
got "[{[ticket hash with name key]}]"
This is because the name field is still being returned by your API. To exclude this field
from your API, you can use the :except option to respond_with calls. In app/
controllers/api/v2/projects_controller.rb the index method can now be altered to this:
def index
projects = Project.readable_by(current_user)
respond_with(projects, :except => :name, :methods => :title)
end
The :except option here will exclude the name field from the responses provided by
this API, and the methods option will call the title method (you’ll define it in a
moment), providing that in your API response. You still need to have the name field in
your database because it’s used in quite a few places in your application. You could
change it all now, but this example is purely to show off the :except option and API
versioning. A change like that would be recommended over this example, however it’s
best left as another exercise for you.
To make your API respond with the title method, you need to define it in app/
models/project.rb inside the Project class like this:
def title
name
end
Now when you run bin/rspec spec/api/v2/projects_spec.rb, the tests that you
edited will pass:
8 examples, 0 failures
You’ve seen how you can generate a new version of your API and alter the output of it,
and the text says that your original API (v1) shouldn’t be effected, but was it? A great
way to check is a quick run of bin/rspec spec/api/v1:
15 examples, 0 failures
Great, that’s all working! A quick run of rake spec will confirm your suspicions that
nothing is broken:
71 examples, 0 failures, 18 pending
Awesome stuff. Let’s make a new commit:
git add .
git commit -m "Implement v2 of the API,
383