Merge lp:~leonardr/launchpadlib/web-root into lp:launchpadlib

[Leonard Richardson]

[Leonard Richardson (leonardr)]

This is the first part of a multi-part branch. It creates a "web_roots" dict similar to the existing "service_roots" dict, which maps nicknames for servers (dogfood, edge, etc.) to the root URI for the corresponding Launchpad website.

The larger purpose of this branch is to lay the groundwork for SimpleLaunchpadBrowser, a class that can communicate with the Launchpad website in lieu of the user's web browser. SimpleLaunchpadBrowser will be able to ask for request tokens and exchange a request token for an access token. This, in turn, will let people write trusted token-exchange clients that go in launchpadlib, rather than untrustable one-off clients. Then I can finally mark bug 387297 as fixed.

This branch will let users point SimpleLaunchpadBrowser at a Launchpad instance by specifying its nickname, just as they can point Launchpad at an instance of the web service by specifying its name.

To avoid import conflicts in future branches, and to keep all the hard-coded URIs in one place, I moved service_roots out of the Launchpad class and into a new file, uris.py. I also refactored the lookup code in the Launchpad class into a utility function, lookup_service_root. I don't know how often lookup_service_root will be called, but the corresponding function for the website, lookup_web_root, will be called a lot.

[lp:~leonardr/launchpadlib/web-root]

66. By Leonard Richardson on 2009-10-23

Fixed up tests and added error checking in response to feedback.

[Abel Deuring (adeuring)]

Hi Leonard,

nice code! thanks for the additonal changes we dicussed on IRC

review: Approve (code)

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2009-10-22 14:04:19 +0000
+++ src/launchpadlib/launchpad.py	2009-10-23 16:59:11 +0000
@@ -33,14 +33,9 @@
     CollectionWithKeyBasedLookup, HostedFile, ServiceRoot)
 from launchpadlib.credentials import AccessToken, Credentials
 from oauth.oauth import OAuthRequest, OAuthSignatureMethod_PLAINTEXT
-
+from launchpadlib import uris
 
 OAUTH_REALM = 'https://api.launchpad.net'
-LPNET_SERVICE_ROOT = 'https://api.launchpad.net/beta/'
-EDGE_SERVICE_ROOT = 'https://api.edge.launchpad.net/beta/'
-STAGING_SERVICE_ROOT = 'https://api.staging.launchpad.net/beta/'
-DEV_SERVICE_ROOT = 'https://api.launchpad.dev/beta/'
-DOGFOOD_SERVICE_ROOT = 'https://api.dogfood.launchpad.net/beta/'
 
 
 class PersonSet(CollectionWithKeyBasedLookup):
@@ -86,16 +81,7 @@
             'projects': PillarSet,
             }
 
-    service_roots = dict(
-        production=LPNET_SERVICE_ROOT,
-        edge=EDGE_SERVICE_ROOT,
-        staging=STAGING_SERVICE_ROOT,
-        dogfood=DOGFOOD_SERVICE_ROOT,
-        dev=DEV_SERVICE_ROOT,
-        )
-
-
-    def __init__(self, credentials, service_root=STAGING_SERVICE_ROOT,
+    def __init__(self, credentials, service_root=uris.STAGING_SERVICE_ROOT,
                  cache=None, timeout=None, proxy_info=None):
         """Root access to the Launchpad API.
 
@@ -109,7 +95,7 @@
 
     @classmethod
     def login(cls, consumer_name, token_string, access_secret,
-              service_root=STAGING_SERVICE_ROOT,
+              service_root=uris.STAGING_SERVICE_ROOT,
               cache=None, timeout=None, proxy_info=None):
         """Convenience for setting up access credentials.
 
@@ -138,7 +124,7 @@
 
     @classmethod
     def get_token_and_login(cls, consumer_name,
-                            service_root=STAGING_SERVICE_ROOT,
+                            service_root=uris.STAGING_SERVICE_ROOT,
                             cache=None, timeout=None, proxy_info=None):
         """Get credentials from Launchpad and log into the service root.
 
@@ -181,7 +167,7 @@
 
     @classmethod
     def login_with(cls, consumer_name,
-                   service_root=STAGING_SERVICE_ROOT,
+                   service_root=uris.STAGING_SERVICE_ROOT,
                    launchpadlib_dir=None, timeout=None, proxy_info=None):
         """Log in to Launchpad with possibly cached credentials.
 
@@ -219,8 +205,7 @@
             launchpadlib_dir = os.path.join(home_dir, '.launchpadlib')
         launchpadlib_dir = os.path.expanduser(launchpadlib_dir)
         # Determine the real service root.
-        if service_root in cls.service_roots:
-            service_root = cls.service_roots[service_root]
+        service_root = uris.lookup_service_root(service_root)
         # Each service root has its own cache and credential dirs.
         scheme, host_name, path, query, fragment = urlparse.urlsplit(
             service_root)

=== modified file 'src/launchpadlib/tests/test_launchpad.py'
--- src/launchpadlib/tests/test_launchpad.py	2009-09-29 14:54:55 +0000
+++ src/launchpadlib/tests/test_launchpad.py	2009-10-23 16:59:11 +0000
@@ -26,7 +26,7 @@
 
 from launchpadlib.credentials import AccessToken, Credentials
 from launchpadlib.launchpad import Launchpad
-
+from launchpadlib import uris
 
 class NoNetworkLaunchpad(Launchpad):
     """A Launchpad instance for tests with no network access.
@@ -39,7 +39,6 @@
     passed_in_kwargs = None
     credentials = None
     get_token_and_login_called = False
-    service_roots = dict(example='http://api.example.com/beta')
 
     def __init__(self, credentials, **kw):
         self.credentials = credentials
@@ -58,6 +57,40 @@
         return launchpad
 
 
+class TestNameLookups(unittest.TestCase):
+    """Test the utility functions in the 'uris' module."""
+
+    def setUp(self):
+        self.aliases = sorted(
+            ['production', 'edge', 'staging', 'dogfood', 'dev'])
+
+    def test_short_names(self):
+        # Ensure the short service names are all supported.
+        self.assertEqual(sorted(uris.service_roots.keys()), self.aliases)
+        self.assertEqual(sorted(uris.web_roots.keys()), self.aliases)
+
+    def test_lookups(self):
+        """Ensure that short service names turn into long service names."""
+
+        # If the service name is a known alias, lookup methods convert
+        # it to a URL.
+        for alias in self.aliases:
+            self.assertEqual(
+                uris.lookup_service_root(alias), uris.service_roots[alias])
+            self.assertEqual(
+                uris.lookup_web_root(alias), uris.web_roots[alias])
+
+        # If the service name is a valid URL, lookup methods let it
+        # through.
+        other_root = "http://some-other-server.com"
+        self.assertEqual(uris.lookup_service_root(other_root), other_root)
+        self.assertEqual(uris.lookup_web_root(other_root), other_root)
+
+        # Otherwise, lookup methods raise an exception.
+        not_a_url = "not-a-url"
+        self.assertRaises(ValueError, uris.lookup_service_root, not_a_url)
+        self.assertRaises(ValueError, uris.lookup_web_root, not_a_url)
+
 class TestLaunchpadLoginWith(unittest.TestCase):
     """Tests for Launchpad.login_with()."""
 
@@ -205,25 +238,24 @@
 
     def test_short_service_name(self):
         # A short service name is converted to the full service root URL.
-        launchpad = NoNetworkLaunchpad.login_with('app name', 'example')
-        self.assertEqual(
-            launchpad.passed_in_kwargs['service_root'],
-            'http://api.example.com/beta')
-
-    def test_short_service_name_bad(self):
-        # A short service name that does not match one of the pre-defined
-        # service root names is passed through.
-        launchpad = NoNetworkLaunchpad.login_with('app name', 'foo')
-        self.assertEqual(
-            launchpad.passed_in_kwargs['service_root'],
-            'foo')
-
-    def test_short_service_names(self):
-        # Ensure the short service names are all supported.
-        expected = ['production', 'edge', 'staging', 'dogfood', 'dev']
-        self.assertEqual(
-            sorted(Launchpad.service_roots.keys()),
-            sorted(expected))
+        launchpad = NoNetworkLaunchpad.login_with('app name', 'staging')
+        self.assertEqual(
+            launchpad.passed_in_kwargs['service_root'],
+            'https://api.staging.launchpad.net/beta/')
+
+        # A full URL as the service name is left alone.
+        launchpad = NoNetworkLaunchpad.login_with(
+            'app name', uris.service_roots['staging'])
+        self.assertEqual(
+            launchpad.passed_in_kwargs['service_root'],
+            uris.service_roots['staging'])
+
+        # A short service name that does not match one of the
+        # pre-defined service root names, and is not a valid URL,
+        # raises an exception.
+        launchpad = ('app name', 'https://')
+        self.assertRaises(
+            ValueError, NoNetworkLaunchpad.login_with, 'app name', 'foo')
 
 
 def test_suite():

=== added file 'src/launchpadlib/uris.py'
--- src/launchpadlib/uris.py	1970-01-01 00:00:00 +0000
+++ src/launchpadlib/uris.py	2009-10-23 16:59:11 +0000
@@ -0,0 +1,95 @@
+# Copyright 2009 Canonical Ltd.
+
+# This file is part of launchpadlib.
+#
+# launchpadlib is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as published by the
+# Free Software Foundation, version 3 of the License.
+#
+# launchpadlib is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+# FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
+# for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with launchpadlib. If not, see <http://www.gnu.org/licenses/>.
+
+"""Launchpad-specific URIs and convenience lookup functions.
+
+The code in this module lets users say "edge" when they mean
+"https://api.edge.launchpad.net/beta".
+"""
+
+__metaclass__ = type
+__all__ = [
+    'lookup_service_root',
+    'lookup_web_root',
+    ]
+
+from urlparse import urlparse
+
+LPNET_SERVICE_ROOT = 'https://api.launchpad.net/beta/'
+EDGE_SERVICE_ROOT = 'https://api.edge.launchpad.net/beta/'
+STAGING_SERVICE_ROOT = 'https://api.staging.launchpad.net/beta/'
+DEV_SERVICE_ROOT = 'https://api.launchpad.dev/beta/'
+DOGFOOD_SERVICE_ROOT = 'https://api.dogfood.launchpad.net/beta/'
+
+LPNET_WEB_ROOT = 'https://launchpad.net/'
+EDGE_WEB_ROOT = 'https://edge.launchpad.net/'
+STAGING_WEB_ROOT = 'https://staging.launchpad.net/'
+DEV_WEB_ROOT = 'https://launchpad.dev/'
+DOGFOOD_WEB_ROOT = 'https://dogfood.launchpad.net/'
+
+
+service_roots = dict(
+    production=LPNET_SERVICE_ROOT,
+    edge=EDGE_SERVICE_ROOT,
+    staging=STAGING_SERVICE_ROOT,
+    dogfood=DOGFOOD_SERVICE_ROOT,
+    dev=DEV_SERVICE_ROOT,
+    )
+
+
+web_roots = dict(
+    production=LPNET_WEB_ROOT,
+    edge=EDGE_WEB_ROOT,
+    staging=STAGING_WEB_ROOT,
+    dogfood=DOGFOOD_WEB_ROOT,
+    dev=DEV_WEB_ROOT,
+    )
+
+
+def _dereference_alias(root, aliases):
+    """Dereference what might a URL or an alias for a URL."""
+    if root in aliases:
+        return aliases[root]
+
+    # It's not an alias. Is it a valid URL?
+    parsed = urlparse(root)
+    if parsed.scheme != "" and parsed.netloc != "":
+        return root
+
+    # It's not an alias or a valid URL.
+    raise ValueError("%s is not a valid URL or an alias for any Launchpad "
+                     "server" % root)
+
+
+def lookup_service_root(service_root):
+    """Dereference an alias to a service root.
+
+    A recognized server alias such as "edge" gets turned into the
+    appropriate URI. A URI gets returned as is. Any other string raises a
+    ValueError.
+    """
+    return _dereference_alias(service_root, service_roots)
+
+
+def lookup_web_root(web_root):
+    """Dereference an alias to a website root.
+
+    A recognized server alias such as "edge" gets turned into the
+    appropriate URI. A URI gets returned as is. Any other string raises a
+    ValueError.
+    """
+    return _dereference_alias(web_root, web_roots)
+