Merge lp:~leonardr/lazr.restful/474522-type-error into lp:lazr.restful

[Leonard Richardson]

Ignore the name of this branch; it refers to a backlog bug that turned out to be invalid.

This branch fixes a different backlog bug, bug 497602. It makes lazr.restful accept relative URLs when dereferencing URLs. This happens when you pass a URL into a named operation or try to change an entry's link. The URLs are relative to the versioned service root (so "/foo" might actually be "http://server/1.0/foo").

I also updated some imports and fixed a trivial test failure in the previous revision.

[Edwin Grubbs (edwin-grubbs)]

Hi Leonard,

This branch looks great. Thanks for fixing this issue.

-Edwin

review: Approve (code)

=== modified file 'src/lazr/restful/NEWS.txt'
--- src/lazr/restful/NEWS.txt	2010-09-27 18:31:14 +0000
+++ src/lazr/restful/NEWS.txt	2010-09-29 16:47:51 +0000
@@ -2,6 +2,13 @@
 NEWS for lazr.restful
 =====================
 
+0.13.3 (2010-09-29)
+===================
+
+Named operations that take URLs as arguments will now accept URLs
+relative to the versioned service root. Previously they would only
+accept absolute URLs. This fixes bug 497602.
+
 0.13.2 (2010-09-27)
 ===================
 

=== modified file 'src/lazr/restful/example/base/tests/entry.txt'
--- src/lazr/restful/example/base/tests/entry.txt	2010-08-26 18:22:19 +0000
+++ src/lazr/restful/example/base/tests/entry.txt	2010-09-29 16:47:51 +0000
@@ -222,11 +222,33 @@
 object. Here the 'dish' argument is the URL to a dish, and the named
 operation finds a recipe for making that dish.
 
+    >>> def find_recipe_in_joy(dish_url):
+    ...     """Look up a dish in 'The Joy of Cooking'."""
+    ...     return webservice.get("%s?ws.op=find_recipe_for&dish=%s" %
+    ...         (joy_url, quote(dish_url))).jsonBody()
+
     >>> dish_url = webservice.get("/recipes/2").jsonBody()['dish_link']
-    >>> recipe = webservice.get("%s?ws.op=find_recipe_for&dish=%s" %
-    ...                         (joy_url, quote(dish_url))).jsonBody()
-    >>> recipe['instructions']
-    u'Draw, singe, stuff, and truss...'
+    >>> find_recipe_in_joy(dish_url)['instructions']
+    u'Draw, singe, stuff, and truss...'
+
+The URL passed in to a named operation may be an absolute URL, or it
+may be relative to the versioned service root. This is for developer
+convenience only, as lazr.restful never serves relative URLs.
+
+    >>> print dish_url
+    http://cookbooks.dev/devel/dishes/Roast%20chicken
+    >>> relative_url = quote("/dishes/Roast chicken")
+    >>> find_recipe_in_joy(relative_url)['instructions']
+    u'Draw, singe, stuff, and truss...'
+
+A URL relative to the unversioned service root will not work.
+
+    >>> relative_url = quote("/devel/dishes/Roast chicken")
+    >>> find_recipe_in_joy(relative_url)
+    Traceback (most recent call last):
+    ...
+    ValueError: dish: No such object "/devel/dishes/Roast%20chicken".
+
 
 Some entries support custom operations through POST. You can invoke a
 custom operation to modify a cookbook's name, making it seem more
@@ -274,14 +296,19 @@
 should use the PATCH HTTP method. Or it may completely describe the
 entry's state, in which case the client should use PUT.
 
-    >>> def modify_cookbook(cookbook, representation, method, headers=None):
-    ...     "A helper function to PUT or PATCH a cookbook."
+    >>> def modify_entry(url, representation, method, headers=None):
+    ...     "A helper function to PUT or PATCH an entry."
     ...     new_headers = {'Content-type': 'application/json'}
     ...     if headers is not None:
     ...         new_headers.update(headers)
-    ...     return webservice('/cookbooks/' + quote(cookbook), method,
-    ...                       simplejson.dumps(representation),
-    ...                       headers)
+    ...     return webservice(
+    ...         url, method, simplejson.dumps(representation), headers)
+
+    >>> def modify_cookbook(cookbook, representation, method, headers=None):
+    ...     "A helper function to PUT or PATCH a cookbook."
+    ...     return modify_entry(
+    ...         '/cookbooks/' + quote(cookbook), representation,
+    ...         method, headers)
 
 Here we use the web service to change the cuisine of the "Everyday
 Greens" cookbook. The data returned is the new JSON representation of
@@ -309,6 +336,35 @@
     >>> print greens['revision_number']
     1
 
+A modification may cause one of en entry's links to point to another
+object. Here, we change the 'dish_link' field of a roast chicken
+recipe, turning it into a recipe for baked beans.
+
+    >>> old_dish = webservice.get("/recipes/1").jsonBody()['dish_link']
+    >>> print old_dish
+    http://.../dishes/Roast%20chicken
+
+    >>> new_dish = webservice.get("/recipes/4").jsonBody()['dish_link']
+    >>> print new_dish
+    http://.../dishes/Baked%20beans
+
+    >>> new_entry = modify_entry(
+    ...     "/recipes/2", {'dish_link' : new_dish}, 'PATCH').jsonBody()
+    >>> print new_entry['dish_link']
+    http://.../dishes/Baked%20beans
+
+When changing one of an entry's links, you can use an absolute URL (as
+seen above) or a URL relative to the versioned service root. Let's use
+a relative URL to change the baked beans recipe back to a roast
+chicken recipe.
+
+    >>> relative_old_dish = quote('/dishes/Roast chicken')
+    >>> new_entry = modify_entry(
+    ...     "/recipes/2", {'dish_link' : relative_old_dish},
+    ...     'PATCH').jsonBody()
+    >>> print new_entry['dish_link']
+    http://.../dishes/Roast%20chicken
+
 A modification might cause an entry's address to change. Here we use
 the web service to change the cookbook's name to 'Everyday Greens 2'.
 

=== modified file 'src/lazr/restful/example/base/tests/redirect.txt'
--- src/lazr/restful/example/base/tests/redirect.txt	2010-09-27 16:40:28 +0000
+++ src/lazr/restful/example/base/tests/redirect.txt	2010-09-29 16:47:51 +0000
@@ -42,3 +42,4 @@
     HTTP/1.1 301 Moved Permanently
     ...
     Location: http://.../Mastering%20the%20Art%20of%20French%20Cooking{invalid}?ws.accept=application/json
+    ...

=== modified file 'src/lazr/restful/marshallers.py'
--- src/lazr/restful/marshallers.py	2009-11-10 13:58:22 +0000
+++ src/lazr/restful/marshallers.py	2010-09-29 16:47:51 +0000
@@ -28,17 +28,30 @@
 
 import simplejson
 
-from zope.datetime import DateTimeError, DateTimeParser
-from zope.component import getMultiAdapter, getUtility
+from zope.datetime import (
+    DateTimeError,
+    DateTimeParser,
+    )
+from zope.component import (
+    getMultiAdapter,
+    getUtility,
+    )
 from zope.interface import implements
 from zope.publisher.interfaces import NotFound
 from zope.security.proxy import removeSecurityProxy
 from zope.traversing.browser import absoluteURL
 
-from lazr.uri import URI, InvalidURIError
+from lazr.uri import (
+    URI,
+    InvalidURIError,
+    )
 
 from lazr.restful.interfaces import (
-    IFieldMarshaller, IUnmarshallingDoesntNeedValue, IWebServiceConfiguration)
+    IFieldMarshaller,
+    IUnmarshallingDoesntNeedValue,
+    IServiceRootResource,
+    IWebServiceConfiguration,
+    )
 from lazr.restful.utils import safe_hasattr
 
 
@@ -74,7 +87,14 @@
         if not isinstance(url, basestring):
             raise ValueError("got '%s', expected string: %r" % (
                 type(url).__name__, url))
-        uri = URI(url)
+        if url.startswith('/'):
+            # It's a relative URI. Resolve it relative to the root of this
+            # version of the web service.
+            service_root = getUtility(IServiceRootResource)
+            root_uri = absoluteURL(service_root, self.request)
+            uri = URI(root_uri).append(url[1:])
+        else:
+            uri = URI(url)
         protocol = uri.scheme
         host = uri.host
         port = uri.port or default_port

=== modified file 'src/lazr/restful/version.txt'
--- src/lazr/restful/version.txt	2010-09-27 18:31:14 +0000
+++ src/lazr/restful/version.txt	2010-09-29 16:47:51 +0000
@@ -1,1 +1,1 @@
-0.13.2
+0.13.3