Merge lp:~leonardr/lazr.restfulclient/load-relative-uri into lp:lazr.restfulclient

[Leonard Richardson]

This branch makes load() support relative URIs, a tiny feature whose absence has caused a lot of problems. The URIs in question are relative to the versioned service root (eg. http://api.launchpad.net/1.0/), since you can't load objects from other web services or other versions of the Launchpad web service.

[Abel Deuring (adeuring)]

review: Approve (code)

=== modified file 'src/lazr/restfulclient/NEWS.txt'
--- src/lazr/restfulclient/NEWS.txt	2010-06-21 14:02:23 +0000
+++ src/lazr/restfulclient/NEWS.txt	2010-06-25 15:12:28 +0000
@@ -2,6 +2,12 @@
 NEWS for lazr.restfulclient
 ===========================
 
+0.9.20 (2010-06-25)
+===================
+
+ - It's now possible to pass a relative URL (relative to the versioned
+   service root) into load().
+
 0.9.19 (2010-06-21)
 ===================
 

=== modified file 'src/lazr/restfulclient/docs/entries.txt'
--- src/lazr/restfulclient/docs/entries.txt	2010-06-16 17:40:18 +0000
+++ src/lazr/restfulclient/docs/entries.txt	2010-06-25 15:12:28 +0000
@@ -171,7 +171,35 @@
     >>> print new_recipe.dish.name
     Roast chicken
 
-You can't bookmark a random URI.
+You can bookmark a URI relative to the version of the web service
+currently in use.
+
+    >>> cookbooks = service.load("cookbooks")
+    >>> print cookbooks['The Joy of Cooking'].self_link
+    http://cookbooks.dev/1.0/cookbooks/The%20Joy%20of%20Cooking
+
+    >>> cookbook = service.load("/cookbooks/The%20Joy%20of%20Cooking")
+    >>> print cookbook.self_link
+    http://cookbooks.dev/1.0/cookbooks/The%20Joy%20of%20Cooking
+
+    >>> service_root = service.load("")
+    >>> print service_root.cookbooks['The Joy of Cooking'].name
+    The Joy of Cooking
+
+But you can't provide the web service version and bookmark a URI
+relative to the service root.
+
+    >>> cookbooks = service.load("/1.0/cookbooks")
+    Traceback (most recent call last):
+    ...
+    HTTPError: HTTP Error 404: Not Found
+    ...
+
+(That code attempts to load http://cookbooks.dev/1.0/1.0/cookbooks,
+which doesn't exist.)
+
+You can't bookmark an absolute or relative URI that has nothing to do
+with the web service.
 
     >>> bookmark = 'http://cookbooks.dev/'
     >>> service.load(bookmark)
@@ -180,6 +208,12 @@
     HTTPError: HTTP Error 404: Not Found
     ...
 
+    >>> service.load("/no-such-url")
+    Traceback (most recent call last):
+    ...
+    HTTPError: HTTP Error 404: Not Found
+    ...
+
 You can't bookmark the return value of a named operation. This is not
 really desirable, but that's how things work right now.
 
@@ -190,7 +224,6 @@
     ...
     ValueError: Couldn't determine the resource type of...
 
-
 Moving an entry
 ---------------
 

=== modified file 'src/lazr/restfulclient/resource.py'
--- src/lazr/restfulclient/resource.py	2010-06-21 14:02:23 +0000
+++ src/lazr/restfulclient/resource.py	2010-06-25 15:12:28 +0000
@@ -450,6 +450,13 @@
 
     def load(self, url):
         """Load a resource given its URL."""
+        parsed = urlparse(url)
+        if parsed.scheme == '':
+            # This is a relative URL. Make it absolute by joining
+            # it with the service root resource.
+            if len(url) > 0 and url[0] == '/':
+                url = url[1:]
+            url = self._root_uri.append(url)
         document = self._browser.get(url)
         try:
             representation = simplejson.loads(unicode(document))

=== modified file 'src/lazr/restfulclient/version.txt'
--- src/lazr/restfulclient/version.txt	2010-06-21 14:02:23 +0000
+++ src/lazr/restfulclient/version.txt	2010-06-25 15:12:28 +0000
@@ -1,1 +1,1 @@
-0.9.19
+0.9.20