Merge lp:~wallyworld/lazr.restfulclient/relative-url-fix-681767 into lp:lazr.restfulclient

[Ian Booth]

Fix ServiceRoot.load() so that it properly handles relative URLs in a way that doesn't break subsequent API calls

== Implementation ==

The ServiceRoot.load() API takes a url as a parameter. In the case where the URL is relative, a URI object was being constructed and assigned to the url. However, this conflicted with the case where a full url was passed in as a string, and also downstream processing which expects the url to be a string. So the simple fix is simply to stringify the constructed URI object when a relative URL is passed in.

== Tests ==

Add some extra checks to entries.txt

== Lint ==

Did some lint cleanup to make everything happy.

[Curtis Hovey (sinzui)]

Thank you for the fix and the de-linting.

review: Approve (code)

=== modified file '.bzrignore'
--- .bzrignore	2011-11-18 20:23:37 +0000
+++ .bzrignore	2012-04-16 03:23:21 +0000
@@ -11,3 +11,4 @@
 build
 *.egg
 dist
+MANIFEST

=== modified file 'src/lazr/restfulclient/NEWS.txt'
--- src/lazr/restfulclient/NEWS.txt	2012-03-28 20:37:13 +0000
+++ src/lazr/restfulclient/NEWS.txt	2012-04-16 03:23:21 +0000
@@ -2,6 +2,12 @@
 NEWS for lazr.restfulclient
 ===========================
 
+0.12.2 (2012-04-16)
+===================
+
+  - Fix ServiceRoot.load() so that it properly handles relative URLs
+  in a way that doesn't break subsequent API calls (bug 681767).
+
 0.12.1 (2012-03-28)
 ===================
 

=== modified file 'src/lazr/restfulclient/docs/entries.txt'
--- src/lazr/restfulclient/docs/entries.txt	2011-11-18 20:38:06 +0000
+++ src/lazr/restfulclient/docs/entries.txt	2012-04-16 03:23:21 +0000
@@ -176,14 +176,23 @@
 currently in use.
 
     >>> cookbooks = service.load("cookbooks")
+    >>> assert isinstance(cookbooks._wadl_resource.url, basestring)
+    >>> print cookbooks._wadl_resource.url
+    http://cookbooks.dev/1.0/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")
+    >>> assert isinstance(cookbook._wadl_resource.url, basestring)
+    >>> print cookbook._wadl_resource.url
+    http://cookbooks.dev/1.0/cookbooks/The%20Joy%20of%20Cooking
     >>> print cookbook.self_link
     http://cookbooks.dev/1.0/cookbooks/The%20Joy%20of%20Cooking
 
     >>> service_root = service.load("")
+    >>> assert isinstance(service_root._wadl_resource.url, basestring)
+    >>> print service_root._wadl_resource.url
+    http://cookbooks.dev/1.0/
     >>> print service_root.cookbooks['The Joy of Cooking'].name
     The Joy of Cooking
 

=== modified file 'src/lazr/restfulclient/resource.py'
--- src/lazr/restfulclient/resource.py	2011-11-18 20:38:06 +0000
+++ src/lazr/restfulclient/resource.py	2012-04-16 03:23:21 +0000
@@ -50,6 +50,7 @@
 
 missing = object()
 
+
 class HeaderDictionary:
     """A dictionary that bridges httplib2's and wadllib's expectations.
 
@@ -218,8 +219,8 @@
                 param_name + suffix)
             if param is not None:
                 try:
-                    value = param.get_value()
-                except KeyError, e:
+                    param.get_value()
+                except KeyError:
                     # The parameter could have been present, but isn't.
                     # Try the next parameter.
                     continue
@@ -242,7 +243,7 @@
         :return: A NamedOperation instance that can be called with
                  appropriate arguments to invoke the operation.
         """
-        params = { 'ws.op' : operation_name }
+        params = {'ws.op': operation_name}
         method = self._wadl_resource.get_method('get', query_params=params)
         if method is None:
             method = self._wadl_resource.get_method(
@@ -369,7 +370,8 @@
                 type_link = representation['resource_type_link']
                 if (type_link is not None
                     and type_link != self._wadl_resource.type_url):
-                    resource_type = self._root._wadl.get_resource_type(type_link)
+                    resource_type = self._root._wadl.get_resource_type(
+                        type_link)
                     self._wadl_resource.tag = resource_type.tag
             self.__dict__['_wadl_resource'] = self._wadl_resource.bind(
                 representation, self.JSON_MEDIA_TYPE,
@@ -388,7 +390,7 @@
         """Return the scalar value."""
         self._ensure_representation()
         return self._wadl_resource.representation
-    
+
 
 class HostedFile(Resource):
     """A resource representing a file managed by a lazr.restful service."""
@@ -501,7 +503,7 @@
             # it with the service root resource.
             if url[:1] == '/':
                 url = url[1:]
-            url = self._root_uri.append(url)
+            url = str(self._root_uri.append(url))
         document = self._browser.get(url)
         try:
             representation = simplejson.loads(unicode(document))
@@ -568,7 +570,7 @@
             (media_type,
              in_representation) = self.wadl_method.build_representation(
                 **args)
-            extra_headers = { 'Content-type' : media_type }
+            extra_headers = {'Content-type': media_type}
         # Pass uppercase method names to httplib2, as that is what it works
         # with. If you pass a lowercase method name to httplib then it doesn't
         # consider it to be a GET, PUT, etc., and so will do things like not
@@ -806,7 +808,7 @@
             return self._get_slice(key)
         else:
             # Look up a single item by its position in the list.
-            found_slice = self._get_slice(slice(key, key+1))
+            found_slice = self._get_slice(slice(key, key + 1))
             if len(found_slice) != 1:
                 raise IndexError("list index out of range")
             return found_slice[0]
@@ -858,7 +860,7 @@
             page_url = self._with_url_query_variable_set(
                 self._wadl_resource.url, 'ws.start', start)
 
-        desired_size = stop-start
+        desired_size = stop - start
         more_needed = desired_size - len(entry_dicts)
 
         # Iterate over pages until we have the correct number of entries.
@@ -1060,5 +1062,5 @@
             disposition = 'attachment; filename="%s"' % self.filename
             self.hosted_file._root._browser.put(
                 self.url, self.getvalue(),
-                self.content_type, {'Content-Disposition' : disposition})
+                self.content_type, {'Content-Disposition': disposition})
         StringIO.close(self)

=== modified file 'src/lazr/restfulclient/version.txt'
--- src/lazr/restfulclient/version.txt	2012-03-28 20:37:13 +0000
+++ src/lazr/restfulclient/version.txt	2012-04-16 03:23:21 +0000
@@ -1,1 +1,1 @@
-0.12.1
+0.12.2