Merge lp:~bac/launchpadlib/short_service_names into lp:~launchpad-pqm/launchpadlib/devel

[Brad Crittenden]

[Brad Crittenden (bac)]

Allows the use of short names in Launchpad.login_with. Supported names are 'edge', 'staging', 'dogfood', and 'dev'.

[Leonard Richardson (leonardr)]

review: Approve (code)

=== modified file 'HACKING.txt'
--- HACKING.txt	2009-03-20 20:46:06 +0000
+++ HACKING.txt	2009-09-28 19:05:20 +0000
@@ -39,3 +39,19 @@
 or send a message to:
 
     [e-mail]
+
+
+========
+Building
+========
+
+As mentioned above, this project uses zc.buildout, which requires a
+few steps to build some necessary files.
+
+The following two steps will create some necessary files, including a
+bin directory.
+% python bootstrap.py
+% bin/buildout
+
+Once built you can run all of the tests with:
+% bin/test

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2009-03-23 21:50:35 +0000
+++ src/launchpadlib/launchpad.py	2009-09-28 19:05:20 +0000
@@ -22,11 +22,9 @@
     ]
 
 import os
-import shutil
 import simplejson
 import stat
 import sys
-import tempfile
 import urlparse
 import webbrowser
 
@@ -37,8 +35,12 @@
 from launchpadlib.resource import Resource
 from launchpadlib.credentials import AccessToken, Credentials
 
+
+EDGE_SERVICE_ROOT = 'https://api.edge.launchpad.net/beta/'
 STAGING_SERVICE_ROOT = 'https://api.staging.launchpad.net/beta/'
-EDGE_SERVICE_ROOT = 'https://api.edge.launchpad.net/beta/'
+DOGFOOD_SERVICE_ROOT = 'https://api.dogfood.launchpad.net/beta/'
+DEV_SERVICE_ROOT = 'https://api.launchpad.dev/beta/'
+
 
 class Launchpad(Resource):
     """Root Launchpad API class.
@@ -47,6 +49,12 @@
     :type credentials: `Credentials`
     """
 
+    service_roots = dict(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,
                  cache=None, timeout=None, proxy_info=None):
         """Root access to the Launchpad API.
@@ -183,7 +191,8 @@
             `Consumer` constructor
         :type consumer_name: string
         :param service_root: The URL to the root of the web service.
-        :type service_root: string
+        :type service_root: string.  Can either be the full URL to a service
+            or one of the short service names.
         :param launchpadlib_dir: The directory where the cache and
             credentials are stored.
         :type launchpadlib_dir: string
@@ -195,6 +204,9 @@
             home_dir = os.environ['HOME']
             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]
         # 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-03-23 22:48:16 +0000
+++ src/launchpadlib/tests/test_launchpad.py	2009-09-28 19:05:20 +0000
@@ -41,6 +41,7 @@
     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
@@ -48,7 +49,7 @@
 
     @classmethod
     def get_token_and_login(cls, consumer_name, **kw):
-        """Create fake credentials and recored that we were called."""
+        """Create fake credentials and record that we were called."""
         credentials = Credentials(
             consumer_name, consumer_secret='consumer_secret:42',
             access_token=AccessToken('access_key:84', 'access_secret:168'))
@@ -204,5 +205,21 @@
         self.assertTrue(os.path.exists(
             os.path.join(launchpadlib_dir, 'api.example.com', 'credentials')))
 
+    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 additional_tests():
     return unittest.TestLoader().loadTestsFromName(__name__)