Merge lp:~leonardr/launchpadlib/multiversion into lp:launchpadlib

[Leonard Richardson]

[Leonard Richardson (leonardr)]

This branch changes launchpadlib to take advantage of lazr.restful's 'version' constructor argument. Instead of a service root of http://api.launchpad.net/beta/, you now use a service root of http://api.launchpad.net/ and a version of "beta". This makes it much easier to specify which version of a web service you want to use.

This branch also changes the default version of the web service to 'devel'. Here is the plan (not yet ratified by distro developers):

1. We get a launchpadlib release based on this branch into Lucid before the feature freeze. At this point anyone who writes launchpadlib scripts with beta versions of Lucid will be using the unstable 'devel' version of the web service.

2. Before Lucid is released, we make some changes to the Launchpad web service and freeze a '1.0' release.

3. We make a small launchpadlib release that does nothing but change the default web service version to '1.0'. Anyone who writes launchpadlib scripts with the released
version of Lucid will be using the frozen '1.0' version of the web service.

This is flacoste's plan; I would prefer to change the default web service version to '1.0' in this branch, and not mess with Lucid any more after this.

Either way, by releasing a '1.0' version of the web service and tying it to Lucid, we will be able to retire the 'beta' version when we retire Karmic. If we don't get this done, we won't be able to retire the 'beta' version until we retire Lucid.

[Leonard Richardson (leonardr)]

s/lazr.restful/lazr.restfulclient/ in the above.

[Eleanor Berger (intellectronica)]

review: Approve (code)

[Francis J. Lacoste (flacoste)]

On February 15, 2010, Leonard Richardson wrote:
> Leonard Richardson has proposed merging
> lp:~leonardr/launchpadlib/multiversion into lp:launchpadlib.
>
> Requested reviews:
> LAZR Developers (lazr-developers)
>
>
> This branch changes launchpadlib to take advantage of lazr.restful's
> 'version' constructor argument. Instead of a service root of
> http://api.launchpad.net/beta/, you now use a service root of
> http://api.launchpad.net/ and a version of "beta". This makes it much
> easier to specify which version of a web service you want to use.
>
> This branch also changes the default version of the web service to 'devel'.
> Here is the plan (not yet ratified by distro developers):
>
> 1. We get a launchpadlib release based on this branch into Lucid before the
> feature freeze. At this point anyone who writes launchpadlib scripts with
> beta versions of Lucid will be using the unstable 'devel' version of the
> web service.
>
> 2. Before Lucid is released, we make some changes to the Launchpad web
> service and freeze a '1.0' release.
>
> 3. We make a small launchpadlib release that does nothing but change the
> default web service version to '1.0'. Anyone who writes launchpadlib
> scripts with the released version of Lucid will be using the frozen '1.0'
> version of the web service.
>
> This is flacoste's plan; I would prefer to change the default web service
> version to '1.0' in this branch, and not mess with Lucid any more after
> this.
>
> Either way, by releasing a '1.0' version of the web service and tying it to
> Lucid, we will be able to retire the 'beta' version when we retire Karmic.
> If we don't get this done, we won't be able to retire the 'beta' version
> until we retire Lucid.
>

The default for production should still be beta, at least until this code is
deployed to production. Otherwise, anybody will get breakage when they try
launchpadlib on lpnet.

--
Francis J. Lacoste
<email address hidden>

[Leonard Richardson (leonardr)]

"The default for production should still be beta, at least until this code is
deployed to production. Otherwise, anybody will get breakage when they try
launchpadlib on lpnet."

Then maybe the launchpadlib default should continue to be "beta", and once we're ready, we can change it to "1.0". Rather than changing it to "devel" and then to "1.0".

[Francis J. Lacoste (flacoste)]

On February 16, 2010, Leonard Richardson wrote:
> "The default for production should still be beta, at least until this code
> is deployed to production. Otherwise, anybody will get breakage when they
> try launchpadlib on lpnet."
>
> Then maybe the launchpadlib default should continue to be "beta", and once
> we're ready, we can change it to "1.0". Rather than changing it to "devel"
> and then to "1.0".

It's really something to discuss with the Ubuntu release team. Each scenario
has different trade-off in expectations management.

--
Francis J. Lacoste
<email address hidden>

[Leonard Richardson (leonardr)]

On further reflection I believe this point is moot. Right now, the "devel" version isn't deployed any more than the "1.0" version is. https://edge.launchpad.net/api/devel leads to a 404. If we want Lucid developers to be able to use launchpadlib, we have to give them "beta" by default until "1.0" and "devel" are deployed. At that point we might as well give them "1.0".

=== modified file 'setup.py'
--- setup.py	2009-11-03 13:50:27 +0000
+++ setup.py	2010-02-15 16:44:17 +0000
@@ -60,7 +60,7 @@
     license='LGPL v3',
     install_requires=[
         'httplib2',
-        'lazr.restfulclient>=0.9.10',
+        'lazr.restfulclient>=0.9.11',
         'lazr.uri',
         'oauth',
         'setuptools',

=== modified file 'src/launchpadlib/__init__.py'
--- src/launchpadlib/__init__.py	2009-12-17 13:13:42 +0000
+++ src/launchpadlib/__init__.py	2010-02-15 16:44:17 +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.5.4'
+__version__ = '1.5.5'

=== modified file 'src/launchpadlib/docs/introduction.txt'
--- src/launchpadlib/docs/introduction.txt	2009-12-17 17:26:30 +0000
+++ src/launchpadlib/docs/introduction.txt	2010-02-15 16:44:17 +0000
@@ -299,7 +299,7 @@
 service. Earlier we used 'test_dev' as shorthand for the website URL,
 and like in that earlier case, launchpadlib will internally
 dereference 'test_dev' into the service root URL, defined in the
-'uris' module as "http://api.launchpad.dev:8085/beta".
+'uris' module as "http://api.launchpad.dev:8085/".
 
     >>> consumer_name = 'launchpadlib'
     >>> launchpad = Launchpad.get_token_and_login(

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2009-12-17 20:27:18 +0000
+++ src/launchpadlib/launchpad.py	2010-02-15 16:44:17 +0000
@@ -76,6 +76,8 @@
     :type credentials: `Credentials`
     """
 
+    DEFAULT_VERSION = 'devel'
+
     RESOURCE_TYPE_CLASSES = {
             'bugs': BugSet,
             'distributions': PillarSet,
@@ -86,7 +88,8 @@
             }
 
     def __init__(self, credentials, service_root=uris.STAGING_SERVICE_ROOT,
-                 cache=None, timeout=None, proxy_info=None):
+                 cache=None, timeout=None, proxy_info=None,
+                 version=DEFAULT_VERSION):
         """Root access to the Launchpad API.
 
         :param credentials: The credentials used to access Launchpad.
@@ -96,12 +99,13 @@
         """
         service_root = uris.lookup_service_root(service_root)
         super(Launchpad, self).__init__(
-            credentials, service_root, cache, timeout, proxy_info)
+            credentials, service_root, cache, timeout, proxy_info, version)
 
     @classmethod
     def login(cls, consumer_name, token_string, access_secret,
               service_root=uris.STAGING_SERVICE_ROOT,
-              cache=None, timeout=None, proxy_info=None):
+              cache=None, timeout=None, proxy_info=None,
+              version=DEFAULT_VERSION):
         """Convenience for setting up access credentials.
 
         When all three pieces of credential information (the consumer
@@ -125,14 +129,16 @@
         access_token = AccessToken(token_string, access_secret)
         credentials = Credentials(
             consumer_name=consumer_name, access_token=access_token)
-        return cls(credentials, service_root, cache, timeout, proxy_info)
+        return cls(credentials, service_root, cache, timeout, proxy_info,
+                   version)
 
     @classmethod
     def get_token_and_login(cls, consumer_name,
                             service_root=uris.STAGING_SERVICE_ROOT,
                             cache=None, timeout=None, proxy_info=None,
                             authorizer_class=AuthorizeRequestTokenWithBrowser,
-                            allow_access_levels=[], max_failed_attempts=3):
+                            allow_access_levels=[], max_failed_attempts=3,
+                            version=DEFAULT_VERSION):
         """Get credentials from Launchpad and log into the service root.
 
         This is a convenience method which will open up the user's preferred
@@ -170,19 +176,21 @@
             max_failed_attempts)
         authorizer()
         credentials.exchange_request_token_for_access_token(web_root)
-        return cls(credentials, service_root, cache, timeout, proxy_info)
+        return cls(credentials, service_root, cache, timeout, proxy_info,
+                   version)
 
     @classmethod
     def login_anonymously(
         cls, consumer_name, service_root=uris.STAGING_SERVICE_ROOT,
-        launchpadlib_dir=None, timeout=None, proxy_info=None):
+        launchpadlib_dir=None, timeout=None, proxy_info=None,
+        version=DEFAULT_VERSION):
         """Get access to Launchpad without providing any credentials."""
         (service_root, launchpadlib_dir, cache_path,
          service_root_dir) = cls._get_paths(service_root, launchpadlib_dir)
         token = AnonymousAccessToken()
         credentials = Credentials(consumer_name, access_token=token)
         return cls(credentials, service_root=service_root, cache=cache_path,
-                   timeout=timeout, proxy_info=proxy_info)
+                   timeout=timeout, proxy_info=proxy_info, version=version)
 
     @classmethod
     def login_with(cls, consumer_name,
@@ -190,7 +198,7 @@
                    launchpadlib_dir=None, timeout=None, proxy_info=None,
                    authorizer_class=AuthorizeRequestTokenWithBrowser,
                    allow_access_levels=[], max_failed_attempts=3,
-                   credentials_file=None):
+                   credentials_file=None, version=DEFAULT_VERSION):
         """Log in to Launchpad with possibly cached credentials.
 
         This is a convenience method for either setting up new login
@@ -247,7 +255,7 @@
                 timeout=timeout, proxy_info=proxy_info,
                 authorizer_class=authorizer_class,
                 allow_access_levels=allow_access_levels,
-                max_failed_attempts=max_failed_attempts)
+                max_failed_attempts=max_failed_attempts, version=version)
             launchpad.credentials.save_to_path(consumer_credentials_path)
             os.chmod(consumer_credentials_path, stat.S_IREAD | stat.S_IWRITE)
         return launchpad

=== modified file 'src/launchpadlib/testing/helpers.py'
--- src/launchpadlib/testing/helpers.py	2009-12-17 16:52:54 +0000
+++ src/launchpadlib/testing/helpers.py	2010-02-15 16:44:17 +0000
@@ -39,9 +39,11 @@
     """A base class for talking to the testing root service."""
 
     def __init__(self, credentials, service_root=None,
-                 cache=None, timeout=None, proxy_info=None):
+                 cache=None, timeout=None, proxy_info=None,
+                 version=Launchpad.DEFAULT_VERSION):
         super(TestableLaunchpad, self).__init__(
-            credentials, 'test_dev', cache, timeout, proxy_info)
+            credentials, 'test_dev', cache, timeout, proxy_info,
+            version=version)
 
 
 class KnownTokens:
@@ -51,11 +53,13 @@
         self.token_string = token_string
         self.access_secret = access_secret
 
-    def login(self, cache=None, timeout=None, proxy_info=None):
+    def login(self, cache=None, timeout=None, proxy_info=None,
+              version=Launchpad.DEFAULT_VERSION):
         """Login using these credentials."""
         return TestableLaunchpad.login(
             'launchpad-library', self.token_string, self.access_secret,
-            cache=cache, timeout=timeout, proxy_info=proxy_info)
+            cache=cache, timeout=timeout, proxy_info=proxy_info,
+            version=version)
 
 
 salgado_with_full_permissions = KnownTokens('salgado-change-anything', 'test')

=== modified file 'src/launchpadlib/tests/test_launchpad.py'
--- src/launchpadlib/tests/test_launchpad.py	2009-12-17 18:45:49 +0000
+++ src/launchpadlib/tests/test_launchpad.py	2010-02-15 16:44:17 +0000
@@ -164,7 +164,8 @@
             service_root=service_root,
             timeout=timeout,
             proxy_info=proxy_info,
-            cache=os.path.join(self.temp_dir, 'api.example.com', 'cache'))
+            cache=os.path.join(self.temp_dir, 'api.example.com', 'cache'),
+            version='devel')
         self.assertEqual(launchpad.passed_in_kwargs, expected_arguments)
 
     def test_anonymous_login(self):
@@ -287,7 +288,7 @@
         launchpad = NoNetworkLaunchpad.login_with('app name', 'staging')
         self.assertEqual(
             launchpad.passed_in_kwargs['service_root'],
-            'https://api.staging.launchpad.net/beta/')
+            'https://api.staging.launchpad.net/')
 
         # A full URL as the service name is left alone.
         launchpad = NoNetworkLaunchpad.login_with(

=== modified file 'src/launchpadlib/uris.py'
--- src/launchpadlib/uris.py	2009-12-17 16:52:54 +0000
+++ src/launchpadlib/uris.py	2010-02-15 16:44:17 +0000
@@ -17,7 +17,7 @@
 """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".
+"https://api.edge.launchpad.net/".
 """
 
 __metaclass__ = type
@@ -28,12 +28,12 @@
 
 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/'
-TEST_DEV_SERVICE_ROOT = 'http://api.launchpad.dev:8085/beta/'
+LPNET_SERVICE_ROOT = 'https://api.launchpad.net/'
+EDGE_SERVICE_ROOT = 'https://api.edge.launchpad.net/'
+STAGING_SERVICE_ROOT = 'https://api.staging.launchpad.net/'
+DEV_SERVICE_ROOT = 'https://api.launchpad.dev/'
+DOGFOOD_SERVICE_ROOT = 'https://api.dogfood.launchpad.net/'
+TEST_DEV_SERVICE_ROOT = 'http://api.launchpad.dev:8085/'
 
 LPNET_WEB_ROOT = 'https://launchpad.net/'
 EDGE_WEB_ROOT = 'https://edge.launchpad.net/'