Merge lp:~thekorn/launchpadlib/fix.270393.verbose.credentials into lp:launchpadlib

[Robert Collins]

From bug 270393: (probably needs updating for launchpadlib changes)
I have different credential files for different applications and access level on my system, they look like

[1]
consumer_secret =
access_token = abcdef
consumer_key = launchpadfs
access_secret = xxxxxxxxxxxxxxxxxxxxxxxx

and I'm often asking myself which launchpad service I can access on which level with credentials created by loading this file.

So it would be nice to have extra values like

service_root = https://api.staging.launchpad.net/beta/
access_level = read_public

and make the accessible like:

>>> credentials = Credentials()
>>> credentials.load(open("some-file.txt"))
>>> credentials.service_root
'https://api.staging.launchpad.net/beta/'
>>> credentials.access_level
'read_public'

Markus

[j.c.sackett (jcsackett)]

I'm seeing conflicts in this code.

review: Needs Fixing

[j.c.sackett (jcsackett)]

Is there any intent to fix the conflicts and update this branch? I note it's been sitting since my last comment, and now I see the last commit apparently was in 2009?

Unmerged revisions

32. By Markus Korn on 2009-01-18

* added Credentials.service_root. This way it is easier to discover the
  usage of a certain file of credentials. This is a first step of fixing
  (LP: #270393)

=== modified file 'src/launchpadlib/credentials.py'
--- src/launchpadlib/credentials.py	2011-01-10 14:34:03 +0000
+++ src/launchpadlib/credentials.py	2011-09-30 10:28:17 +0000
@@ -34,6 +34,7 @@
 import stat
 import time
 from urllib import urlencode
+<<<<<<< TREE
 from urlparse import urljoin
 import webbrowser
 
@@ -49,6 +50,16 @@
 
 from launchpadlib import uris
 
+=======
+
+from ConfigParser import SafeConfigParser, NoOptionError
+from launchpadlib.errors import CredentialsFileError, HTTPError
+from launchpadlib._oauth.oauth import OAuthConsumer, OAuthToken
+
+
+CREDENTIALS_FILE_VERSION = '1'
+STAGING_WEB_ROOT = 'https://staging.launchpad.net/'
+>>>>>>> MERGE-SOURCE
 request_token_page = '+request-token'
 access_token_page = '+access-token'
 authorize_token_page = '+authorize-token'
@@ -67,6 +78,7 @@
     """
     _request_token = None
 
+<<<<<<< TREE
     URI_TOKEN_FORMAT = "uri"
     DICT_TOKEN_FORMAT = "dict"
 
@@ -91,6 +103,87 @@
 
     def get_request_token(self, context=None, web_root=uris.STAGING_WEB_ROOT,
                           token_format=URI_TOKEN_FORMAT):
+=======
+    def __init__(self, consumer_name=None, consumer_secret='',
+                 access_token=None, service_root=None):
+        """The user's Launchpad API credentials.
+
+        :param consumer_name: The name of the consumer (application)
+        :param consumer_secret: The secret of the consumer
+        :param access_token: The authenticated user access token
+        :param service_root: The root uri of the service or None
+        :type access_token: `AccessToken`
+        """
+        self.consumer = None
+        self.service_root = service_root
+        if consumer_name is not None:
+            self.consumer = Consumer(consumer_name, consumer_secret)
+        self.access_token = access_token
+
+    def load(self, readable_file):
+        """Load credentials from a file-like object.
+
+        This overrides the consumer and access token given in the constructor
+        and replaces them with the values read from the file.
+
+        :param readable_file: A file-like object to read the credentials from
+        :type readable_file: Any object supporting the file-like `read()`
+            method
+        """
+        # Attempt to load the access token from the file.
+        parser = SafeConfigParser()
+        parser.readfp(readable_file)
+        # Check the version number and extract the access token and
+        # secret.  Then convert these to the appropriate instances.
+        if not parser.has_section(CREDENTIALS_FILE_VERSION):
+            raise CredentialsFileError('No configuration for version %s' %
+                                       CREDENTIALS_FILE_VERSION)
+        consumer_key = parser.get(
+            CREDENTIALS_FILE_VERSION, 'consumer_key')
+        consumer_secret = parser.get(
+            CREDENTIALS_FILE_VERSION, 'consumer_secret')
+        self.consumer = Consumer(consumer_key, consumer_secret)
+        access_token = parser.get(
+            CREDENTIALS_FILE_VERSION, 'access_token')
+        access_secret = parser.get(
+            CREDENTIALS_FILE_VERSION, 'access_secret')
+        self.access_token = AccessToken(access_token, access_secret)
+        try:
+            self.service_root = parser.get(
+                CREDENTIALS_FILE_VERSION, 'service_root') or None
+        except NoOptionError:
+            self.service_root = None
+
+    def save(self, writable_file):
+        """Write the credentials to the file-like object.
+
+        :param writable_file: A file-like object to write the credentials to
+        :type writable_file: Any object supporting the file-like `write()`
+            method
+        :raise CredentialsFileError: when there is either no consumer or no
+            access token
+        """
+        if self.consumer is None:
+            raise CredentialsFileError('No consumer')
+        if self.access_token is None:
+            raise CredentialsFileError('No access token')
+
+        parser = SafeConfigParser()
+        parser.add_section(CREDENTIALS_FILE_VERSION)
+        parser.set(CREDENTIALS_FILE_VERSION,
+                   'consumer_key', self.consumer.key)
+        parser.set(CREDENTIALS_FILE_VERSION,
+                   'consumer_secret', self.consumer.secret)
+        parser.set(CREDENTIALS_FILE_VERSION,
+                   'access_token', self.access_token.key)
+        parser.set(CREDENTIALS_FILE_VERSION,
+                   'access_secret', self.access_token.secret)
+        parser.set(CREDENTIALS_FILE_VERSION,
+                   'service_root', str(self.service_root or ''))
+        parser.write(writable_file)
+
+    def get_request_token(self, context=None, web_root=STAGING_WEB_ROOT):
+>>>>>>> MERGE-SOURCE
         """Request an OAuth token to Launchpad.
 
         Also store the token in self._request_token.

=== modified file 'src/launchpadlib/launchpad.py'
--- src/launchpadlib/launchpad.py	2011-09-29 15:48:31 +0000
+++ src/launchpadlib/launchpad.py	2011-09-30 10:28:17 +0000
@@ -291,6 +291,7 @@
         :return: The web service root
         :rtype: `Launchpad`
         """
+<<<<<<< TREE
         cls._warn_of_deprecated_login_method("get_token_and_login")
         return cls._authorize_token_and_login(
             consumer_name, service_root, cache, timeout, proxy_info,
@@ -609,3 +610,21 @@
             os.makedirs(cache_path, 0700)
         return (service_root, launchpadlib_dir, cache_path, service_root_dir)
 
+=======
+        credentials = Credentials(consumer_name)
+        web_root_uri = URI(service_root)
+        web_root_uri.path = ""
+        web_root_uri.host = web_root_uri.host.replace("api.", "", 1)
+        web_root = str(web_root_uri.ensureSlash())
+        authorization_url = credentials.get_request_token(web_root=web_root)
+        webbrowser.open(authorization_url)
+        print ("The authorization page (%s) should be opening in your "
+               "browser. After you have authorized this program to "
+               "access Launchpad on your behalf you should come back "
+               "here and press <Enter> to finish the authentication "
+               "process." % authorization_url)
+        sys.stdin.readline()
+        credentials.exchange_request_token_for_access_token(web_root)
+        credentials.service_root = service_root
+        return cls(credentials, service_root, cache, timeout, proxy_info)
+>>>>>>> MERGE-SOURCE