Merge lp:~wallyworld/lazr.restfulclient/named-post-url-change-1056546 into lp:lazr.restfulclient

[Ian Booth]

If a Location header is in a named operation post response, use it as the replacement url for the resource.

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. When the lazr restful client has finished making the api call, it invokes lp_refresh() to get the new state of the resource, and this fails with a 404 if the url has changed, since the old url is all the client knows about.

I added a bit of code to detect the 301 response and reload the resource if necessary.

I added a dependency on the corresponding new lazr.resful lib and updated a doctest to reflect the new behaviour.

[Curtis Hovey (sinzui)]

Thank you. Users do not install this lib. I doubt it will even be backported to LTS releases, so I expect users will still see this problem for years after we release the fix.

review: Approve (code)

=== modified file 'src/lazr/restfulclient/NEWS.txt'
--- src/lazr/restfulclient/NEWS.txt	2012-06-19 13:47:10 +0000
+++ src/lazr/restfulclient/NEWS.txt	2012-09-26 11:13:26 +0000
@@ -2,6 +2,12 @@
 NEWS for lazr.restfulclient
 ===========================
 
+0.13.1 (2012-09-26)
+===================
+
+  - Named POST operations may result in a resource moving to a new location.
+  Detect the redirect and reload the resource from its new URL.
+
 0.13.0 (2012-06-19)
 ===================
 

=== modified file 'src/lazr/restfulclient/docs/operations.txt'
--- src/lazr/restfulclient/docs/operations.txt	2011-11-18 20:38:06 +0000
+++ src/lazr/restfulclient/docs/operations.txt	2012-09-26 11:13:26 +0000
@@ -74,6 +74,19 @@
     >>> print cookbook.find_recipe_for(dish=dish)
     None
 
+A named operation may change the resource's location so we get a 301 response
+with the new URL.
+
+    >>> from urllib import quote
+    >>> from lazr.restful.testing.webservice import WebServiceCaller
+    >>> webservice = WebServiceCaller(domain='cookbooks.dev')
+    >>> url = quote("/cookbooks/New cookbook")
+    >>> print webservice.named_post(url, 'make_more_interesting')
+    HTTP/1.1 301 Moved Permanently
+    ...
+    Location: http://cookbooks.dev/devel/cookbooks/The%20New%20New%20cookbook
+    ...
+
 JSON-encoding
 -------------
 

=== modified file 'src/lazr/restfulclient/resource.py'
--- src/lazr/restfulclient/resource.py	2012-06-19 11:58:42 +0000
+++ src/lazr/restfulclient/resource.py	2012-09-26 11:13:26 +0000
@@ -589,8 +589,13 @@
         else:
             if http_method == 'post':
                 # The method call probably modified this resource in
-                # an unknown way. Refresh its representation.
-                self.resource.lp_refresh()
+                # an unknown way. If it moved to a new location, reload it or
+                # else just refresh its representation.
+                if response.status == 301:
+                    url = response['location']
+                    response, content = self.root._browser._request(url)
+                else:
+                    self.resource.lp_refresh()
             return self._handle_200_response(url, response, content)
 
     def _handle_201_response(self, url, response, content):

=== modified file 'src/lazr/restfulclient/version.txt'
--- src/lazr/restfulclient/version.txt	2012-06-19 13:47:10 +0000
+++ src/lazr/restfulclient/version.txt	2012-09-26 11:13:26 +0000
@@ -1,1 +1,1 @@
-0.13.0
+0.13.1

=== modified file 'versions.cfg'
--- versions.cfg	2012-06-19 13:28:22 +0000
+++ versions.cfg	2012-09-26 11:13:26 +0000
@@ -25,7 +25,7 @@
 lazr.delegates = 1.2.0
 lazr.enum = 1.1.2
 lazr.lifecycle = 1.0
-lazr.restful = 0.19.2
+lazr.restful = 0.19.7
 lazr.uri = 1.0.2
 lxml = 2.2.7
 martian = 0.11