Merge lp:~wallyworld/launchpadlib/services-serviceroot into lp:launchpadlib

[Ian Booth]

Add top level services collection to enable easy access to named Launchpad services.

== Implementation ==

This branch adds a new top level 'services' collection, allowing easy access to named Launchpad services. A Launchpad service implements IService and is traversed to via +service/<name>

Using launchpadlib:

lp = Launchpad(...)
service = lp.services['myservice']
service.some_method()

Some drive-by lint was also done.

== Tests ==

Extend the testing-wadl.xml file and add a new test test_services_collection_get_service.
The test simply ensures the new ServiceSet class is properly setup allowing the services top level collection to be used to locate a service.

== Lint ==

Checking for conflicts and issues in changed files.

Linting changed files:
  .bzrignore
  src/launchpadlib/NEWS.txt
  src/launchpadlib/__init__.py
  src/launchpadlib/launchpad.py
  src/launchpadlib/docs/toplevel.txt
  src/launchpadlib/testing/testing-wadl.xml
  src/launchpadlib/testing/tests/test_launchpad.py

./src/launchpadlib/docs/toplevel.txt
     121: want exceeds 78 characters.

[Robert Collins (lifeless)]

This seems to special case all the services; if the bug about interface support in launchpadlib were fixed, it wouldn't need special casing. As it stands, this is adding code rather than maintaining LoC count, and doing so when a generic approach will be ~ the same size and much more powerful doesn't make sense.

review: Needs Fixing

[Ian Booth (wallyworld)]

I have now landed the fix for the relative url issue so that launchpadlib.load() works with relative URLs eg '+services/sharing'. If I understand the discussion on the list correctly, I think I am now in a position to be able to land this branch as is. Any library fixes for the pattern this branch re-uses can come later.

[Colin Watson (cjwatson)]

launchpadlib has moved to git (https://code.launchpad.net/launchpadlib/+git). Sorry for not reviewing this in a timely fashion; if this is still relevant, then please update your branch and re-propose it against the git repository.

Unmerged revisions

130. By Ian Booth on 2012-04-10

Lint

129. By Ian Booth on 2012-04-10

Add a test

128. By Ian Booth on 2012-04-10

Add new services top level collection

=== modified file '.bzrignore'
--- .bzrignore	2010-05-22 12:48:48 +0000
+++ .bzrignore	2012-04-10 09:05:22 +0000
@@ -11,3 +11,4 @@
 dist
 eggs
 _trial_temp
+MANIFEST

=== modified file 'src/launchpadlib/NEWS.txt'
--- src/launchpadlib/NEWS.txt	2011-12-05 15:05:31 +0000
+++ src/launchpadlib/NEWS.txt	2012-04-10 09:05:22 +0000
@@ -2,6 +2,11 @@
 NEWS for launchpadlib
 =====================
 
+1.9.13 (2012-04-10)
+===================
+- Add new top level "services" collection to allow easy access to
+  named services defined in Launchpad.  [bug=974139]
+
 1.9.12 (2011-12-05)
 ===================
 - Move keyring base64 encoding to KeyringCredential and be more

=== modified file 'src/launchpadlib/__init__.py'
--- src/launchpadlib/__init__.py	2011-12-05 15:05:31 +0000
+++ src/launchpadlib/__init__.py	2012-04-10 09:05:22 +0000
@@ -14,4 +14,4 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with launchpadlib. If not, see <http://www.gnu.org/licenses/>.
 
-__version__ = '1.9.12'
+__version__ = '1.9.13'

=== modified file 'src/launchpadlib/docs/toplevel.txt'
--- src/launchpadlib/docs/toplevel.txt	2011-07-27 05:33:26 +0000
+++ src/launchpadlib/docs/toplevel.txt	2012-04-10 09:05:22 +0000
@@ -54,6 +54,14 @@
     ...
     ubuntu
 
+The service collection does lookups by service name.
+
+    >>> sharing_service = launchpad.services('sharing')
+    >>> print sharing_service.name
+    send: 'GET /.../sharing ...'
+    ...
+    sharing
+
 The person collection does lookups by a person's Launchpad
 name.
 

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2011-11-10 15:29:38 +0000
+++ src/launchpadlib/launchpad.py	2012-04-10 09:05:22 +0000
@@ -106,6 +106,19 @@
     collection_of = 'distribution'
 
 
+class ServiceSet(CollectionWithKeyBasedLookup):
+    """A custom subclass capable of service lookup by service name."""
+
+    def _get_url_from_id(self, key):
+        """Transform a service name into the URL to a service."""
+        return str(
+            self._root._root_uri.ensureSlash()) + '+services/' + str(key)
+
+    # All services are different so we need to ensure each service
+    # representation is retrieved when needed.
+    collection_of = None
+
+
 class LaunchpadOAuthAwareHttp(RestfulHttp):
     """Detects expired/invalid OAuth tokens and tries to get a new token."""
 
@@ -157,6 +170,7 @@
             'people': PersonSet,
             'project_groups': ProjectGroupSet,
             'projects': ProjectSet,
+            'services': ServiceSet,
             }
     RESOURCE_TYPE_CLASSES.update(ServiceRoot.RESOURCE_TYPE_CLASSES)
 
@@ -569,7 +583,6 @@
                 argument_name, argument_value, object_value,
                 object_name, argument_name, object_name))
 
-
     @classmethod
     def _get_paths(cls, service_root, launchpadlib_dir=None):
         """Locate launchpadlib-related user paths and ensure they exist.

=== modified file 'src/launchpadlib/testing/testing-wadl.xml'
--- src/launchpadlib/testing/testing-wadl.xml	2011-09-13 15:37:51 +0000
+++ src/launchpadlib/testing/testing-wadl.xml	2012-04-10 09:05:22 +0000
@@ -36,6 +36,12 @@
       <wadl:link resource_type="https://api.example.com/testing/#bugs"/>
     </wadl:param>
 
+    <wadl:param style="plain"
+                path="$['services_collection_link']"
+                name="services_collection_link">
+      <wadl:link resource_type="https://api.example.com/testing/#services"/>
+    </wadl:param>
+
     <wadl:param style="plain" path="$['me_link']"
                 name="me_link">
       <wadl:link resource_type="https://api.example.com/testing/#person"/>
@@ -343,4 +349,73 @@
     </wadl:param>
   </wadl:representation>
 
+  <wadl:resource_type id="services">
+    <wadl:doc xmlns="http://www.w3.org/1999/xhtml">
+      Interface representing the set of services.
+    </wadl:doc>
+    <wadl:method name="GET" id="services-get">
+      <wadl:response>
+        <wadl:representation
+           href="https://api.example.com/testing/#service-page"/>
+        <wadl:representation
+           mediaType="application/vnd.sun.wadl+xml"
+           id="services-wadl"/>
+      </wadl:response>
+    </wadl:method>
+
+    <wadl:method id="services-getByName" name="GET">
+      <wadl:request>
+        <wadl:param style="query" name="ws.op"
+                    required="true"
+                    fixed="getByName">
+        </wadl:param>
+        <wadl:param style="query" required="true"
+                    name="name">
+        </wadl:param>
+      </wadl:request>
+      <wadl:response>
+        <wadl:representation
+           href="https://api.example.com/testing/#service-full"/>
+      </wadl:response>
+    </wadl:method>
+
+  </wadl:resource_type>
+
+    <wadl:resource_type id="service">
+      <wadl:doc xmlns="http://www.w3.org/1999/xhtml">
+A Launchpad service.
+</wadl:doc>
+      <wadl:method name="GET" id="service-get">
+        <wadl:response>
+          <wadl:representation
+    href="https://api.example.com/testing/#service-full"/>
+          <wadl:representation
+    mediaType="application/xhtml+xml" id="service-xhtml"/>
+          <wadl:representation
+    mediaType="application/vnd.sun.wadl+xml"
+    id="service-wadl"/>
+        </wadl:response>
+      </wadl:method>
+
+    </wadl:resource_type>
+
+  <wadl:representation mediaType="application/json"
+                       id="service-full">
+    <wadl:param style="plain" name="self_link" path="$['self_link']">
+      <wadl:link resource_type="https://api.example.com/testing/#service"/>
+    </wadl:param>
+    <wadl:param style="plain" name="web_link"
+                path="$['web_link']">
+      <wadl:link/>
+    </wadl:param>
+    <wadl:param style="plain" name="resource_type_link" path="$['resource_type_link']">
+      <wadl:link/>
+    </wadl:param>
+    <wadl:param style="plain" name="http_etag" path="$['http_etag']">
+    </wadl:param>
+    <wadl:param style="plain" required="true"
+                path="$['name']" name="name">
+    </wadl:param>
+  </wadl:representation>
+
 </wadl:application>

=== modified file 'src/launchpadlib/testing/tests/test_launchpad.py'
--- src/launchpadlib/testing/tests/test_launchpad.py	2011-09-13 13:48:51 +0000
+++ src/launchpadlib/testing/tests/test_launchpad.py	2012-04-10 09:05:22 +0000
@@ -69,7 +69,8 @@
         bug = dict(id="1", title="Bug #1")
         self.launchpad.bugs = dict(entries=[bug])
         [bug] = list(self.launchpad.bugs)
-        self.assertEqual("<FakeResource bug 1 at %s>" % hex(id(bug)), repr(bug))
+        self.assertEqual(
+            "<FakeResource bug 1 at %s>" % hex(id(bug)), repr(bug))
 
 
 class FakeLaunchpadTest(ResourcedTestCase):
@@ -116,7 +117,8 @@
         An L{IntegrityError} is raised if an attribute is set on a
         L{FakeLaunchpad} instance that isn't present in the WADL definition.
         """
-        self.assertRaises(IntegrityError, setattr, self.launchpad, "foo", "bar")
+        self.assertRaises(
+            IntegrityError, setattr, self.launchpad, "foo", "bar")
 
     def test_get_undefined_resource(self):
         """
@@ -317,6 +319,16 @@
         branch = self.launchpad.branches.getByUniqueName("foo")
         self.assertEqual("lp:~user/project/branch2", branch.bzr_identity)
 
+    def test_services_collection_get_service(self):
+        """
+        Test that the services collection can be used to locate a named
+        service.
+        """
+        service = dict(name="myservice")
+        self.launchpad.services = dict(getByName=lambda name: service)
+        service = self.launchpad.services.getByName("myservice")
+        self.assertEqual("myservice", service.name)
+
     def test_replace_property_with_invalid_value(self):
         """Values set on fake resource objects are validated."""
         self.launchpad.me = dict(name="foo")