Rails%203%20In%20Action

382 CHAPTER 13 Designing an API
your API. You’ll need to open these controllers and replace the multiple occurrences
of Api::V1 with Api::V2.
Strangely, version 2 of your API is, right now, identical to version 1 of your API.
That’s intentional: a new version of the API should be an improvement, not an entirely
new thing. With this separation, you can modify version 2 of the API as you please,
leaving version 1 alone.
Before deprecating the name field in your project responses, you’ll write a test to
make sure that this is gone. This test will now test version 2 of the API, and so you’ll
copy over the spec/api/v1 directory to spec/api/v2, also replacing occurrences of v1
in these files with v2. The test for the new title field will now go in spec/api/v2/
projects_spec.rb and will test that the projects viewable by this user action returns
projects with title, and not name, using the code from the following listing to replace
the JSON example in the index context.
Listing 13.29 spec/api/v2/projects_spec.rb
context "projects viewable by this user" do
let(:url) { "/api/v2/projects" }
let(:options) { { :except => :name, :methods => :title } }
it "JSON" do
get "#{url}.json", :token => token
body = Project.readable_by(user).to_json(options)
last_response.body.should eql(body)
last_response.status.should eql(200)
projects = JSON.parse(last_response.body)
projects.any? do |p|
p["project"]["title"] == "Ticketee"
end.should be_true
projects.all? do |p|
p["project"]["name"].blank?
end.should be_true
end
end
At the beginning of this test, you need to pass the same options to to_json B as you
pass to respond_with, because the respond_with method generates the same output
as to_json.
In the final lines of this test, you’re checking that it’s now title and not name that
returns the correct project title, and that the name key on all projects is blank. You’ll
also need to change the XML test of this method to the code shown in the following
listing.
Listing 13.30 spec/api/v2/projects_spec.rb
it "XML" do
get "#{url}.xml", :token => token
body = Project.readable_by(user).to_xml(options)
B
Pass
options to
to_json