@@ -120,6 +120,7 @@ Let's move on, creating a note using <a href="http://tools.ietf.org/html/rfc2616 $ curl -i -XPOST -d'{"title":"projects"}' http://localhost:9292/notes HTTP/1.1 201 Created Cache-Control: no-cache + Location: http://localhost:9292/notes/0dda06f0-b134-012b-a2d8-0017f2c62348 Content-Type: application/json Content-Length: 159 @@ -139,6 +140,7 @@ so that we can specify its location: $ curl -i -XPUT -d'{"title":"reminders"}' http://localhost:9292/notes/abc HTTP/1.1 201 Created Cache-Control: no-cache + Location: http://localhost:9292/notes/abc Content-Type: application/json Content-Length: 126 doc/curl.html @@ -168,5 +168,10 @@ module CloudKit def flash session[CLOUDKIT_FLASH] ||= CloudKit::FlashSession.new end + + # Return the host and scheme + def domain_root + "#{scheme}://#{@env['HTTP_HOST']}" + end end end lib/cloudkit/request.rb @@ -68,18 +68,22 @@ module CloudKit if tunnel_methods.include?(request['_method'].try(:upcase)) return send(request['_method'].downcase, request) end - @store.post( + response = @store.post( request.uri, {:json => request.json}.filter_merge!( - :remote_user => request.current_user)).to_rack + :remote_user => request.current_user)) + update_location_header(request, response) + response.to_rack end def put(request) - @store.put( + response = @store.put( request.uri, {:json => request.json}.filter_merge!( :remote_user => request.current_user, - :etag => request.if_match)).to_rack + :etag => request.if_match)) + update_location_header(request, response) + response.to_rack end def delete(request) @@ -114,21 +118,26 @@ module CloudKit end def versions_link_header(request) - base_url = "#{request.scheme}://#{request.env['HTTP_HOST']}#{request.path_info}" + base_url = "#{request.domain_root}#{request.path_info}" "<#{base_url}/versions>; rel=\"http://joncrosby.me/cloudkit/1.0/rel/versions\"" end def resolved_link_header(request) - base_url = "#{request.scheme}://#{request.env['HTTP_HOST']}#{request.path_info}" + base_url = "#{request.domain_root}#{request.path_info}" "<#{base_url}/_resolved>; rel=\"http://joncrosby.me/cloudkit/1.0/rel/resolved\"" end def index_link_header(request) index_path = request.path_info.sub(/\/_resolved(\/)*$/, '') - base_url = "#{request.scheme}://#{request.env['HTTP_HOST']}#{index_path}" + base_url = "#{request.domain_root}#{index_path}" "<#{base_url}>; rel=\"index\"" end + def update_location_header(request, response) + return unless response['Location'] + response['Location'] = "#{request.domain_root}#{response['Location']}" + end + def auth_missing?(request) request.current_user == nil end lib/cloudkit/service.rb @@ -118,7 +118,7 @@ module CloudKit resource.delete archived_resource = resource.previous_version - return json_meta_response(200, archived_resource.uri.string, archived_resource.etag, resource.last_modified) + return json_meta_response(archived_resource.uri.string, archived_resource.etag, resource.last_modified) end # Build a response containing the allowed methods for a given URI. @@ -277,7 +277,7 @@ module CloudKit def create_resource(uri, options) JSON.parse(options[:json]) rescue (return status_422) resource = CloudKit::Resource.create(uri, options[:json], options[:remote_user]) - json_meta_response(201, resource.uri.string, resource.etag, resource.last_modified) + json_create_response(resource.uri.string, resource.etag, resource.last_modified) end # Update the resource at the specified URI. Requires the :etag option. @@ -289,7 +289,7 @@ module CloudKit return etag_required unless options[:etag] return status_412 unless options[:etag] == resource.etag resource.update(options[:json]) - return json_meta_response(200, uri.string, resource.etag, resource.last_modified) + return json_meta_response(uri.string, resource.etag, resource.last_modified) end # Bundle a collection of results as a list of URIs for the response. lib/cloudkit/store.rb @@ -46,21 +46,32 @@ module CloudKit::ResponseHelpers def response(status, content='', etag=nil, last_modified=nil, options={}) cache_control = options[:cache] == false ? 'no-cache' : 'proxy-revalidate' - headers = { + etag = "\"#{etag}\"" if etag + headers = {}.filter_merge!( 'Content-Type' => 'application/json', - 'Cache-Control' => cache_control} - headers.merge!('ETag' => "\"#{etag}\"") if etag - headers.merge!('Last-Modified' => last_modified) if last_modified + 'Cache-Control' => cache_control, + 'Last-Modified' => last_modified, + 'Location' => options[:location], + 'ETag' => etag) CloudKit::Response.new(status, headers, content) end - def json_meta_response(status, uri, etag, last_modified) - json = JSON.generate( + def json_meta_response(uri, etag, last_modified) + json = json_metadata(uri, etag, last_modified) + response(200, json, nil, nil, :cache => false) + end + + def json_create_response(uri, etag, last_modified) + json = json_metadata(uri, etag, last_modified) + response(201, json, nil, nil, {:cache => false, :location => uri}) + end + + def json_metadata(uri, etag, last_modified) + JSON.generate( :ok => true, :uri => uri, :etag => etag, :last_modified => last_modified) - response(status, json, nil, nil, :cache => false) end def json_error(message) lib/cloudkit/store/response_helpers.rb @@ -182,4 +182,10 @@ describe "A Request" do request.last_path_element.should == 'def' end + it "should know its domain root" do + request = CloudKit::Request.new(Rack::MockRequest.env_for( + '/', 'HTTP_HOST' => 'example.com')) + request.domain_root.should == "http://example.com" + end + end spec/request_spec.rb @@ -570,7 +570,7 @@ describe "A CloudKit::Service" do before(:each) do json = JSON.generate(:this => 'that') @response = @request.post( - '/items', {:input => json}.merge(VALID_TEST_AUTH)) + '/items', {:input => json, 'HTTP_HOST' => 'example.org'}.merge(VALID_TEST_AUTH)) @body = JSON.parse(@response.body) end @@ -600,6 +600,10 @@ describe "A CloudKit::Service" do @response['Last-Modified'].should be_nil end + it "should return a Location header" do + @response['Location'].should match(/http:\/\/example.org#{@body['uri']}/) + end + it "should return a 422 if parsing fails" do response = @request.post('/items', {:input => 'fail'}.merge(VALID_TEST_AUTH)) response.status.should == 422 @@ -607,7 +611,7 @@ describe "A CloudKit::Service" do end - describe "on PUT /:collection/:id" do + describe "on PUT /:collection/:id" do before(:each) do json = JSON.generate(:this => 'that') @@ -626,11 +630,15 @@ describe "A CloudKit::Service" do it "should create a document if it does not already exist" do json = JSON.generate(:this => 'thing') response = @request.put( - '/items/xyz', {:input => json}.merge(VALID_TEST_AUTH)) + '/items/xyz', { + :input => json, + 'HTTP_HOST' => 'example.org'}.merge(VALID_TEST_AUTH)) response.status.should == 201 result = @request.get('/items/xyz', VALID_TEST_AUTH) result.status.should == 200 - JSON.parse(result.body)['this'].should == 'thing' + parsed_json = JSON.parse(result.body)['this'] + parsed_json.should == 'thing' + response['Location'].should match(/http:\/\/example.org#{parsed_json['uri']}/) end it "should not create new resources using deleted resource URIs" do spec/service_spec.rb 1fbd6d2e40cd71f895f5ac3fd746e1fa27d66940 Jon Crosby jon@joncrosby.me http://github.com/jcrosby/cloudkit/commit/ced6a2631f83696c7003024171a4a86deff881a2 ced6a2631f83696c7003024171a4a86deff881a2

2009-05-02T12:51:16-07:00

Add Location header for 201s 9e4452ce3fb98094222a97c8d1eed53b4da13439 Jon Crosby jon@joncrosby.me