Merge lp:~wallyworld/lazr.restful/namedpost-url-change-1056666 into lp:lazr.restful

[Ian Booth]

Redirect to a new location if the resource url changes after a named operation.

A named post operation may result in the resource on which the post is operating to have a different url at the end of the operation. Put and Patch operations do the right thing and issue a 301 with the new location, but named post operations don't. This branch corrects that.

I updated an existing doc test which performs a named post to account for the new behaviour.

[Curtis Hovey (sinzui)]

Thank you.

review: Approve (code)

=== modified file 'src/lazr/restful/NEWS.txt'
--- src/lazr/restful/NEWS.txt	2012-03-15 03:07:15 +0000
+++ src/lazr/restful/NEWS.txt	2012-09-26 09:35:24 +0000
@@ -2,6 +2,12 @@
 NEWS for lazr.restful
 =====================
 
+0.19.7 (2012-09-26)
+===================
+
+Fixed bug 1056666: make named operations which result in a resource URL change
+issue a 301 response containing the new location.
+
 0.19.6 (2012-03-15)
 ===================
 

=== modified file 'src/lazr/restful/_resource.py'
--- src/lazr/restful/_resource.py	2011-10-11 13:33:15 +0000
+++ src/lazr/restful/_resource.py	2012-09-26 09:35:24 +0000
@@ -1393,6 +1393,7 @@
 
     def handleCustomPOST(self, operation_name):
         """See `CustomOperationResourceMixin`."""
+        original_url = absoluteURL(self.entry.context, self.request)
         value = super(EntryResource, self).handleCustomPOST(operation_name)
         # We don't know what the custom operation might have done.
         # Remove this object from the representation cache, just to be
@@ -1400,6 +1401,14 @@
         cache = self._representation_cache
         if cache is not None:
             cache.delete(self.context)
+        new_url = absoluteURL(self.entry.context, self.request)
+        if original_url != new_url:
+            # The object moved. Serve a redirect to its new location.
+            # This might not necessarily be the location of the entry!
+            self.request.response.setStatus(301)
+            self.request.response.setHeader(
+                'Location', absoluteURL(self.context, self.request))
+            return ''
         return value
 
     def _getETagCores(self, unmarshalled_field_values=None):

=== modified file 'src/lazr/restful/example/base/tests/entry.txt'
--- src/lazr/restful/example/base/tests/entry.txt	2011-02-01 00:57:27 +0000
+++ src/lazr/restful/example/base/tests/entry.txt	2012-09-26 09:35:24 +0000
@@ -252,13 +252,16 @@
 
 Some entries support custom operations through POST. You can invoke a
 custom operation to modify a cookbook's name, making it seem more
-interesting.
+interesting. As a result of the operation, the cookbook's location will
+change so we get a 301 response with the new URL.
 
     >>> print webservice.get(joy_url).jsonBody()['cuisine']
     General
 
     >>> print webservice.named_post(joy_url, 'make_more_interesting', {})
-    HTTP/1.1 200 Ok
+    HTTP/1.1 301 Moved Permanently
+    ...
+    Location: http://cookbooks.dev/devel/cookbooks/The%20New%20The%20Joy%20of%20Cooking
     ...
 
     >>> new_joy_url = quote("/cookbooks/The New The Joy of Cooking")

=== modified file 'src/lazr/restful/version.txt'
--- src/lazr/restful/version.txt	2012-03-15 03:07:15 +0000
+++ src/lazr/restful/version.txt	2012-09-26 09:35:24 +0000
@@ -1,1 +1,1 @@
-0.19.6
+0.19.7