Merge lp:~mandel/ubuntuone-client/provide_credentials_management into lp:ubuntuone-client

[Manuel de la Peña]

Rearranged the code so that the API is kept as it was before the port to Windows.

Rearranged the code so that the API is kept as it was before the port to Windows.

[Natalia Bidart (nataliabidart)]

Imports should be sorted alphabetically, for example:

http://pastebin.ubuntu.com/613765/

For the particular case of tests/platform/linux/test_credentials.py, I think there is no need for adding diff lines since the imports itself are not changing (as far as I can see).

If you're changing import from this style:

from ubuntu_sso.credentials import HELP_TEXT_KEY, PING_URL_KEY, TC_URL_KEY

to:

from ubuntu_sso.credentials import (
    HELP_TEXT_KEY,
    PING_URL_KEY,
    TC_URL_KEY)

please make the last import to have a comma and the closing parenthesis on a single line. That is:

from ubuntu_sso.credentials import (
    HELP_TEXT_KEY,
    PING_URL_KEY,
    TC_URL_KEY,
)

Can you please move the line:

CredentialsError = CredentialsErrorRoot

so when looking at the diff it replaces the definition of the old CredentialsError exception? (this way we make the diff clearer).

Can you please move the definition of the NO_OP and logging setup to ubuntuone/credentials.py? that way you can import those from linux/windows without duplicating the code.

Please remove all your #!/usr/bin/env python from the python modules. The shebang is only needed on executable code (so, pretty much never when we develop libraries :-)).

Every occurrence of "ubuntu one" should be capitalized ("Ubuntu One").

review: Needs Fixing

[Roberto Alsina (ralsina)]

Looks good to me.

review: Approve

[Natalia Bidart (nataliabidart)]

./ubuntuone/platform/linux/credentials.py:
    20: 'os' imported but unused
    25: 'basic_formatter' imported but unused
    25: 'LOGFOLDER' imported but unused
    25: 'CustomRotatingFileHandler' imported but unused
    25: 'logging' imported but unused

./ubuntuone/platform/windows/credentials.py:
    20: 'os' imported but unused
    25: 'basic_formatter' imported but unused
    25: 'LOGFOLDER' imported but unused
    25: 'CustomRotatingFileHandler' imported but unused
    25: 'logging' imported but unused
    32: 'logger' imported but unused

review: Needs Fixing

[Natalia Bidart (nataliabidart)]

Approving so mandel can land this once the lint issues are solved.

review: Approve

[Ubuntu One Auto Pilot (otto-pilot)]

There are additional revisions which have not been approved in review. Please seek review and approval of these new revisions.

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~mandel/ubuntuone-client/provide_credentials_management into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
  testing autoconf2.50... not found.
  testing autoconf... found 2.67
checking for automake >= 1.10...
  testing automake-1.11... found 1.11.1
checking for libtool >= 1.5...
  testing libtoolize... found 2.2.6b
checking for intltool >= 0.30...
  testing intltoolize... found 0.41.1
checking for pkg-config >= 0.14.0...
  testing pkg-config... found 0.25
checking for gtk-doc >= 1.0...
  testing gtkdocize... found 1.17
Checking for required M4 macros...
Checking for forbidden M4 macros...
Processing ./configure.ac
Running libtoolize...
libtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
Running gtkdocize...
Running aclocal-1.11...
Running autoconf...
Running autoheader...
Running automake-1.11...
Running ./configure --enable-gtk-doc --enable-debug ...
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum length of command line arguments... 1572864
checking whether the shell understands some XSI constructs... yes
checking whether the shell understands "+="... yes
checking for /usr/bin/ld option to reload object files... -r
checking for objdump... objdump
checking how to recognize ...

[Ubuntu One Auto Pilot (otto-pilot)]

The attempt to merge lp:~mandel/ubuntuone-client/provide_credentials_management into lp:ubuntuone-client failed. Below is the output from the failed tests.

/usr/bin/gnome-autogen.sh
checking for autoconf >= 2.53...
  testing autoconf2.50... not found.
  testing autoconf... found 2.67
checking for automake >= 1.10...
  testing automake-1.11... found 1.11.1
checking for libtool >= 1.5...
  testing libtoolize... found 2.2.6b
checking for intltool >= 0.30...
  testing intltoolize... found 0.41.1
checking for pkg-config >= 0.14.0...
  testing pkg-config... found 0.25
checking for gtk-doc >= 1.0...
  testing gtkdocize... found 1.17
Checking for required M4 macros...
Checking for forbidden M4 macros...
Processing ./configure.ac
Running libtoolize...
libtoolize: putting auxiliary files in `.'.
libtoolize: copying file `./ltmain.sh'
libtoolize: putting macros in AC_CONFIG_MACRO_DIR, `m4'.
libtoolize: copying file `m4/libtool.m4'
libtoolize: copying file `m4/ltoptions.m4'
libtoolize: copying file `m4/ltsugar.m4'
libtoolize: copying file `m4/ltversion.m4'
libtoolize: copying file `m4/lt~obsolete.m4'
Running intltoolize...
Running gtkdocize...
Running aclocal-1.11...
Running autoconf...
Running autoheader...
Running automake-1.11...
Running ./configure --enable-gtk-doc --enable-debug ...
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... /bin/mkdir -p
checking for gawk... gawk
checking whether make sets $(MAKE)... yes
checking for style of include used by make... GNU
checking for gcc... gcc
checking whether the C compiler works... yes
checking for C compiler default output file name... a.out
checking for suffix of executables...
checking whether we are cross compiling... no
checking for suffix of object files... o
checking whether we are using the GNU C compiler... yes
checking whether gcc accepts -g... yes
checking for gcc option to accept ISO C89... none needed
checking dependency style of gcc... gcc3
checking for library containing strerror... none required
checking for gcc... (cached) gcc
checking whether we are using the GNU C compiler... (cached) yes
checking whether gcc accepts -g... (cached) yes
checking for gcc option to accept ISO C89... (cached) none needed
checking dependency style of gcc... (cached) gcc3
checking build system type... i686-pc-linux-gnu
checking host system type... i686-pc-linux-gnu
checking for a sed that does not truncate output... /bin/sed
checking for grep that handles long lines and -e... /bin/grep
checking for egrep... /bin/grep -E
checking for fgrep... /bin/grep -F
checking for ld used by gcc... /usr/bin/ld
checking if the linker (/usr/bin/ld) is GNU ld... yes
checking for BSD- or MS-compatible name lister (nm)... /usr/bin/nm -B
checking the name lister (/usr/bin/nm -B) interface... BSD nm
checking whether ln -s works... yes
checking the maximum length of command line arguments... 1572864
checking whether the shell understands some XSI constructs... yes
checking whether the shell understands "+="... yes
checking for /usr/bin/ld option to reload object files... -r
checking for objdump... objdump
checking how to recognize ...

=== modified file 'bin/test-send-signal.py' (properties changed: +x to -x)
=== modified file 'po/POTFILES.in'
--- po/POTFILES.in	2011-05-24 18:19:52 +0000
+++ po/POTFILES.in	2011-06-02 10:17:29 +0000
@@ -1,6 +1,6 @@
 ubuntuone/clientdefs.py.in
 ubuntuone/status/aggregator.py
-ubuntuone/platform/linux/credentials.py
+ubuntuone/credentials.py
 data/emblem-ubuntuone-downloading.icon.in
 data/emblem-ubuntuone-unsynchronized.icon.in
 data/emblem-ubuntuone-uploading.icon.in

=== modified file 'tests/platform/linux/test_credentials.py'
--- tests/platform/linux/test_credentials.py	2011-05-24 18:19:52 +0000
+++ tests/platform/linux/test_credentials.py	2011-06-02 10:17:29 +0000
@@ -24,12 +24,24 @@
 from ubuntuone.devtools.testcase import DBusTestCase as TestCase
 from ubuntuone.devtools.handlers import MementoHandler
 
-from ubuntuone.platform.linux.credentials import (dbus, logger, logging,
-    CredentialsManagement, CredentialsManagementTool, CredentialsError,
+from ubuntuone.credentials import logging, logger
+from ubuntuone.platform.linux.credentials import (
+    APP_NAME,
+    CredentialsError,
+    CredentialsManagement,
+    CredentialsManagementTool,
+    dbus,
+    DBUS_BUS_NAME,
+    DBUS_CREDENTIALS_IFACE,
+    DBUS_CREDENTIALS_PATH,
+    DESCRIPTION, 
+    HELP_TEXT_KEY,
+    PING_URL,
+    PING_URL_KEY,
+    TC_URL_KEY,
+    TC_URL,
+    TIMEOUT_INTERVAL,
     ubuntu_sso,
-    DBUS_BUS_NAME, DBUS_CREDENTIALS_PATH, DBUS_CREDENTIALS_IFACE,
-    APP_NAME, HELP_TEXT_KEY, DESCRIPTION, TC_URL_KEY, TC_URL,
-    PING_URL_KEY, PING_URL, TIMEOUT_INTERVAL,
 )
 
 FAKED_CREDENTIALS = {

=== added file 'tests/test_credentials.py'
--- tests/test_credentials.py	1970-01-01 00:00:00 +0000
+++ tests/test_credentials.py	2011-06-02 10:17:29 +0000
@@ -0,0 +1,98 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Manuel de la Pena<[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Platform independent tests for the credentials management."""
+
+from mocker import MockerTestCase, MATCH
+
+from ubuntuone.platform.credentials import CredentialsManagementTool
+
+
+class TestCredentialsManagementTool(MockerTestCase):
+    """Test the crendentials management tool mocking the proxy."""
+
+    def setUp(self):
+        """Set the diff tests."""
+        super(TestCredentialsManagementTool, self).setUp()
+        self.get_cred_proxy = self.mocker.mock()
+        self.proxy = self.mocker.mock()
+        self.management_tool = CredentialsManagementTool()
+        self.management_tool.get_creds_proxy = self.get_cred_proxy
+
+    def test_find_credentials(self):
+        """Test that we do ask for the credentials correctly."""
+        signals = ['creds_found', 'creds_not_found', 'creds_erro']
+        self.get_cred_proxy()
+        self.mocker.result(self.proxy)
+        self.proxy.register_to_credentials_found(MATCH(callable))
+        self.mocker.result(signals[0])
+        self.proxy.register_to_credentials_not_found(MATCH(callable))
+        self.mocker.result(signals[1])
+        self.proxy.register_to_credentials_error(MATCH(callable))
+        self.mocker.result(signals[2])
+        self.proxy.find_credentials(reply_handler=MATCH(callable),
+                                    error_handler=MATCH(callable))
+        self.mocker.replay()
+        return self.management_tool.find_credentials()
+
+    def test_clear_credentials(self):
+        """Test that we clear the credentials correctly."""
+        signals = ['creds_cleared', 'creds_error']
+        self.get_cred_proxy()
+        self.mocker.result(self.proxy)
+        self.proxy.register_to_credentials_cleared(MATCH(callable))
+        self.mocker.result(signals[0])
+        self.proxy.register_to_credentials_error(MATCH(callable))
+        self.mocker.result(signals[1])
+        self.proxy.clear_credentials(reply_handler=MATCH(callable),
+                                     error_handler=MATCH(callable))
+        self.mocker.replay()
+        return self.management_tool.clear_credentials()
+
+    def test_store_credentials(self):
+        """Test that we store the credentials correctly."""
+        token = 'token'
+        signals = ['creds_stored','creds_error']
+        self.get_cred_proxy()
+        self.mocker.result(self.proxy)
+        self.proxy.register_to_credentials_stored(MATCH(callable))
+        self.mocker.result(signals[0])
+        self.proxy.register_to_credentials_error(MATCH(callable))
+        self.mocker.result(signals[1])
+        self.proxy.store_credentials(token, reply_handler=MATCH(callable),
+                                     error_handler=MATCH(callable))
+        self.mocker.replay()
+        return self.management_tool.store_credentials(token)
+
+    def test_register(self):
+        """Test that we correctly register."""
+        window_id = 10
+        window_id_dict = dict(window_id=str(window_id))
+        signals = ['creds_found', 'creds_denied', 'creds_error']
+        self.get_cred_proxy()
+        self.mocker.result(self.proxy)
+        self.proxy.register_to_credentials_found(MATCH(callable))
+        self.mocker.result(signals[0])
+        self.proxy.register_to_authorization_denied(MATCH(callable))
+        self.mocker.result(signals[1])
+        self.proxy.register_to_credentials_error(MATCH(callable))
+        self.mocker.result(signals[2])
+        self.proxy.register(window_id_dict, reply_handler=MATCH(callable),
+                            error_handler=MATCH(callable))
+        self.mocker.replay()
+        return self.management_tool.register(window_id=window_id)
+

=== added file 'ubuntuone/credentials.py'
--- ubuntuone/credentials.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/credentials.py	2011-06-02 10:17:29 +0000
@@ -0,0 +1,264 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Natalia B. Bidart <[e-mail]>
+# Author: Manuel de la Pena<[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Common code for the credentials management."""
+
+import os
+import gettext
+
+from twisted.internet import defer
+
+from ubuntuone.logger import (basic_formatter, logging,
+    CustomRotatingFileHandler, LOGFOLDER)
+from ubuntuone.clientdefs import GETTEXT_PACKAGE
+
+LOG_LEVEL = logging.DEBUG
+path = os.path.join(LOGFOLDER, 'credentials.log')
+MAIN_HANDLER = CustomRotatingFileHandler(path)
+MAIN_HANDLER.setFormatter(basic_formatter)
+MAIN_HANDLER.setLevel(LOG_LEVEL)
+
+logger = logging.getLogger("ubuntuone.credentials")
+logger.setLevel(LOG_LEVEL)
+logger.addHandler(MAIN_HANDLER)
+
+NO_OP = lambda *args, **kwargs: None
+Q_ = lambda string: gettext.dgettext(GETTEXT_PACKAGE, string)
+APP_NAME = "Ubuntu One"
+TC_URL = "https://one.ubuntu.com/terms/"
+PING_URL = "https://one.ubuntu.com/oauth/sso-finished-so-get-tokens/"
+DESCRIPTION = Q_('Ubuntu One requires an Ubuntu Single Sign On (SSO) account. '
+                 'This process will allow you to create a new account, '
+                 'if you do not yet have one.')
+
+class CredentialsError(Exception):
+    """A general exception when hadling credentilas."""
+
+
+class CredentialsManagementToolRoot(object):
+    """Wrapper to CredentialsManagement.
+
+    The goal of this class is to abstract the caller from calling the DBus
+    service implemented in the class CredentialsManagement.
+
+    """
+
+    def __init__(self, get_proxy_fn):
+        self._cleanup_signals = []
+        self.get_creds_proxy = get_proxy_fn
+
+    def cleanup(self, _):
+        """Disconnect all the DBus signals."""
+        for sig in self._cleanup_signals:
+            logger.debug('cleanup: removing signal match %r', sig)
+            sig.remove()
+
+        return _
+
+    @defer.inlineCallbacks
+    def find_credentials(self):
+        """Find credentials for Ubuntu One.
+
+        Return a deferred that, when fired, will return the credentials for
+        Ubuntu One for the current logged in user.
+
+        The credentials is a dictionary with both string keys and values. The
+        dictionary may be either empty if there are no credentials for the
+        user, or will hold five items as follow:
+
+        - "name"
+        - "token"
+        - "token_secret"
+        - "consumer_key"
+        - "consumer_secret"
+
+        """
+        d = defer.Deferred()
+        d.addBoth(self.cleanup)
+
+        proxy = self.get_creds_proxy()
+
+        sig = proxy.register_to_credentials_found(d.callback)
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_credentials_not_found(lambda: d.callback({}))
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_credentials_error(
+            lambda error_dict: d.errback(CredentialsError(error_dict)))
+        self._cleanup_signals.append(sig)
+
+        done = defer.Deferred()
+        proxy.find_credentials(reply_handler=lambda: done.callback(None),
+            error_handler=lambda *a: done.errback(a))
+
+        yield done
+
+        result = yield d
+        defer.returnValue(result)
+
+    @defer.inlineCallbacks
+    def clear_credentials(self):
+        """Clear credentials for Ubuntu One.
+
+        Return a deferred that, when fired, will return no result but will
+        indicate that the Ubuntu One credentials for the current user were
+        removed from the local keyring.
+
+        """
+        d = defer.Deferred()
+        d.addBoth(self.cleanup)
+
+        proxy = self.get_creds_proxy()
+        sig = proxy.register_to_credentials_cleared(lambda: d.callback(None))
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_credentials_error(
+            lambda error_dict: d.errback(CredentialsError(error_dict)))
+        self._cleanup_signals.append(sig)
+
+        done = defer.Deferred()
+        proxy.clear_credentials(reply_handler=lambda: done.callback(None),
+            error_handler=lambda *a: done.errback(a))
+
+        yield done
+
+        yield d
+
+    @defer.inlineCallbacks
+    def store_credentials(self, token):
+        """Store credentials for Ubuntu One.
+
+        The parameter 'token' should be a dictionary that matches the
+        description of the result of 'find_credentials'.
+
+        Return a deferred that, when fired, will return no result but will
+        indicate that 'token' was stored in the local keyring as the new Ubuntu
+        One credentials for the current user.
+
+        """
+        d = defer.Deferred()
+        d.addBoth(self.cleanup)
+
+        proxy = self.get_creds_proxy()
+        sig = proxy.register_to_credentials_stored(lambda: d.callback(None))
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_credentials_error(
+            lambda error_dict: d.errback(CredentialsError(error_dict)))
+        self._cleanup_signals.append(sig)
+
+        done = defer.Deferred()
+        proxy.store_credentials(token,
+            reply_handler=lambda: done.callback(None),
+            error_handler=lambda *a: done.errback(a))
+
+        yield done
+
+        yield d
+
+    @defer.inlineCallbacks
+    def register(self, window_id=0):
+        """Register to Ubuntu One.
+
+        Return a deferred that, when fired, will return the credentials for
+        Ubuntu One for the current logged in user.
+
+        If there are no credentials for the current user, a GTK UI will be
+        opened to invite the user to register to Ubuntu One. This UI provides
+        options to either register (main screen) or login (secondary screen).
+
+        You can pass an optional 'window_id' parameter that will be used by the
+        GTK UI to be set transient for it.
+
+        The returned credentials will be either a non-empty dictionary like the
+        one described in 'find_credentials', or None. The latter indicates that
+        there were no credentials for the user in the local keyring and that
+        the user refused to register to Ubuntu One.
+
+        """
+        d = defer.Deferred()
+        d.addBoth(self.cleanup)
+
+        proxy = self.get_creds_proxy()
+
+        sig = proxy.register_to_credentials_found(d.callback)
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_authorization_denied(lambda: d.callback(None))
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_credentials_error(
+            lambda error_dict: d.errback(CredentialsError(error_dict)))
+        self._cleanup_signals.append(sig)
+
+        done = defer.Deferred()
+        proxy.register({'window_id': str(window_id)},
+            reply_handler=lambda: done.callback(None),
+            error_handler=lambda *a: done.errback(a))
+
+        yield done
+
+        result = yield d
+        defer.returnValue(result)
+
+    @defer.inlineCallbacks
+    def login(self, window_id=0):
+        """Login to Ubuntu One.
+
+        Return a deferred that, when fired, will return the credentials for
+        Ubuntu One for the current logged in user.
+
+        If there are no credentials for the current user, a GTK UI will be
+        opened to invite the user to login to Ubuntu One. This UI provides
+        options to either login (main screen) or retrieve password (secondary
+        screen).
+
+        You can pass an optional 'window_id' parameter that will be used by the
+        GTK UI to be set transient for it.
+
+        The returned credentials will be either a non-empty dictionary like the
+        one described in 'find_credentials', or None. The latter indicates that
+        there were no credentials for the user in the local keyring and that
+        the user refused to login to Ubuntu One.
+
+        """
+        d = defer.Deferred()
+        d.addBoth(self.cleanup)
+
+        proxy = self.get_creds_proxy()
+
+        sig = proxy.register_to_credentials_found(d.callback)
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_authorization_denied(lambda: d.callback(None))
+        self._cleanup_signals.append(sig)
+
+        sig = proxy.register_to_credentials_error(
+            lambda error_dict: d.errback(CredentialsError(error_dict)))
+        self._cleanup_signals.append(sig)
+
+        done = defer.Deferred()
+        proxy.login({'window_id': str(window_id)},
+            reply_handler=lambda: done.callback(None),
+            error_handler=lambda *a: done.errback(a))
+
+        yield done
+
+        result = yield d
+        defer.returnValue(result)

=== modified file 'ubuntuone/platform/linux/__init__.py'
--- ubuntuone/platform/linux/__init__.py	2011-05-24 18:19:52 +0000
+++ ubuntuone/platform/linux/__init__.py	2011-06-02 10:17:29 +0000
@@ -55,7 +55,7 @@
     get_udf_path,
     VMMetadataUpgraderMixIn
 )
-from ubuntuone.platform.linux.credentials import CredentialsManagement
+from ubuntuone.platform.linux.credentials import CredentialsManagementTool
 from ubuntuone.platform.linux.logger import setup_filesystem_logging, get_filesystem_logger
 from ubuntuone.platform.linux.filesystem_notifications import FilesystemMonitor
 from ubuntuone.platform.linux.notification import Notification

=== modified file 'ubuntuone/platform/linux/credentials.py'
--- ubuntuone/platform/linux/credentials.py	2011-05-24 18:19:52 +0000
+++ ubuntuone/platform/linux/credentials.py	2011-06-02 10:17:29 +0000
@@ -15,48 +15,37 @@
 #
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
-
 """Ubuntu One credentials management dbus service."""
 
-import os
 
 import dbus.service
-import gettext
 import ubuntu_sso
 
-from twisted.internet import defer
-from ubuntu_sso.credentials import HELP_TEXT_KEY, PING_URL_KEY, TC_URL_KEY
-
-from ubuntuone.logger import (basic_formatter, logging,
-    CustomRotatingFileHandler, LOGFOLDER)
-from ubuntuone.clientdefs import GETTEXT_PACKAGE
-
-
-Q_ = lambda string: gettext.dgettext(GETTEXT_PACKAGE, string)
-NO_OP = lambda *args, **kwargs: None
+from ubuntu_sso.credentials import (
+    HELP_TEXT_KEY,
+    PING_URL_KEY,
+    TC_URL_KEY,
+)
+from ubuntuone.credentials import (
+    CredentialsManagementToolRoot,
+    logger,
+    APP_NAME,
+    DESCRIPTION,
+    NO_OP,
+    PING_URL,
+    TC_URL,
+)
+from ubuntuone.credentials import CredentialsError as CredentialsErrorRoot
+
+
 TIMEOUT_INTERVAL = 10000  # 10 seconds
 
-LOG_LEVEL = logging.DEBUG
-path = os.path.join(LOGFOLDER, 'credentials.log')
-MAIN_HANDLER = CustomRotatingFileHandler(path)
-MAIN_HANDLER.setFormatter(basic_formatter)
-MAIN_HANDLER.setLevel(LOG_LEVEL)
-
-logger = logging.getLogger("ubuntuone.credentials")
-logger.setLevel(LOG_LEVEL)
-logger.addHandler(MAIN_HANDLER)
-
 # constants
 DBUS_BUS_NAME = "com.ubuntuone.Credentials"
 DBUS_CREDENTIALS_PATH = "/credentials"
 DBUS_CREDENTIALS_IFACE = "com.ubuntuone.CredentialsManagement"
 
-APP_NAME = "Ubuntu One"
-TC_URL = "https://one.ubuntu.com/terms/"
-PING_URL = "https://one.ubuntu.com/oauth/sso-finished-so-get-tokens/"
-DESCRIPTION = Q_('Ubuntu One requires an Ubuntu Single Sign On (SSO) account. '
-                 'This process will allow you to create a new account, '
-                 'if you do not yet have one.')
+CredentialsError = CredentialsErrorRoot
 
 
 class CredentialsManagement(dbus.service.Object):
@@ -238,237 +227,75 @@
             reply_handler=reply_handler, error_handler=error_handler)
 
 
-class CredentialsError(Exception):
-    """A general exception when hadling credentilas."""
-
-
-class CredentialsManagementTool(object):
-    """Wrapper to CredentialsManagement.
-
-    The goal of this class is to abstract the caller from calling the DBus
-    service implemented in the class CredentialsManagement.
-
+class CredentialsManagementProxy(object):
+    """Proxy that allows to work with the dbus api.
+
+    This proxy has been added to hide the exact details of
+    how the signals are connected. This allows the reuse of 
+    the CredentialsManagementTool in diff platforms.
     """
 
     def __init__(self):
-        self._cleanup_signals = []
-
-    def _get_creds_proxy(self):
-        """Get the CredentialsManagement dbus proxy."""
+        """Create a new instance."""
         bus = dbus.SessionBus()
         try:
             obj = bus.get_object(DBUS_BUS_NAME,
                                  DBUS_CREDENTIALS_PATH,
                                  follow_name_owner_changes=True)
-            proxy = dbus.Interface(obj, DBUS_CREDENTIALS_IFACE)
+            self.proxy = dbus.Interface(obj, DBUS_CREDENTIALS_IFACE)
         except:
             logger.exception('get_creds_proxy:')
             raise
 
-        return proxy
-
-    def cleanup(self, _):
-        """Disconnect all the DBus signals."""
-        for sig in self._cleanup_signals:
-            logger.debug('cleanup: removing signal match %r', sig)
-            sig.remove()
-
-        return _
-
-    @defer.inlineCallbacks
-    def find_credentials(self):
-        """Find credentials for Ubuntu One.
-
-        Return a deferred that, when fired, will return the credentials for
-        Ubuntu One for the current logged in user.
-
-        The credentials is a dictionary with both string keys and values. The
-        dictionary may be either empty if there are no credentials for the
-        user, or will hold five items as follow:
-
-        - "name"
-        - "token"
-        - "token_secret"
-        - "consumer_key"
-        - "consumer_secret"
-
-        """
-        d = defer.Deferred()
-        d.addBoth(self.cleanup)
-
-        proxy = self._get_creds_proxy()
-
-        sig = proxy.connect_to_signal('CredentialsFound', d.callback)
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('CredentialsNotFound',
-            lambda: d.callback({}))
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('CredentialsError',
-            lambda error_dict: d.errback(CredentialsError(error_dict)))
-        self._cleanup_signals.append(sig)
-
-        done = defer.Deferred()
-        proxy.find_credentials(reply_handler=lambda: done.callback(None),
-            error_handler=lambda *a: done.errback(a))
-
-        yield done
-
-        result = yield d
-        defer.returnValue(result)
-
-    @defer.inlineCallbacks
-    def clear_credentials(self):
-        """Clear credentials for Ubuntu One.
-
-        Return a deferred that, when fired, will return no result but will
-        indicate that the Ubuntu One credentials for the current user were
-        removed from the local keyring.
-
-        """
-        d = defer.Deferred()
-        d.addBoth(self.cleanup)
-
-        proxy = self._get_creds_proxy()
-        sig = proxy.connect_to_signal('CredentialsCleared',
-            lambda: d.callback(None))
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('CredentialsError',
-            lambda error_dict: d.errback(CredentialsError(error_dict)))
-        self._cleanup_signals.append(sig)
-
-        done = defer.Deferred()
-        proxy.clear_credentials(reply_handler=lambda: done.callback(None),
-            error_handler=lambda *a: done.errback(a))
-
-        yield done
-
-        yield d
-
-    @defer.inlineCallbacks
-    def store_credentials(self, token):
-        """Store credentials for Ubuntu One.
-
-        The parameter 'token' should be a dictionary that matches the
-        description of the result of 'find_credentials'.
-
-        Return a deferred that, when fired, will return no result but will
-        indicate that 'token' was stored in the local keyring as the new Ubuntu
-        One credentials for the current user.
-
-        """
-        d = defer.Deferred()
-        d.addBoth(self.cleanup)
-
-        proxy = self._get_creds_proxy()
-        sig = proxy.connect_to_signal('CredentialsStored',
-            lambda: d.callback(None))
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('CredentialsError',
-            lambda error_dict: d.errback(CredentialsError(error_dict)))
-        self._cleanup_signals.append(sig)
-
-        done = defer.Deferred()
-        proxy.store_credentials(token,
-            reply_handler=lambda: done.callback(None),
-            error_handler=lambda *a: done.errback(a))
-
-        yield done
-
-        yield d
-
-    @defer.inlineCallbacks
-    def register(self, window_id=0):
-        """Register to Ubuntu One.
-
-        Return a deferred that, when fired, will return the credentials for
-        Ubuntu One for the current logged in user.
-
-        If there are no credentials for the current user, a GTK UI will be
-        opened to invite the user to register to Ubuntu One. This UI provides
-        options to either register (main screen) or login (secondary screen).
-
-        You can pass an optional 'window_id' parameter that will be used by the
-        GTK UI to be set transient for it.
-
-        The returned credentials will be either a non-empty dictionary like the
-        one described in 'find_credentials', or None. The latter indicates that
-        there were no credentials for the user in the local keyring and that
-        the user refused to register to Ubuntu One.
-
-        """
-        d = defer.Deferred()
-        d.addBoth(self.cleanup)
-
-        proxy = self._get_creds_proxy()
-
-        sig = proxy.connect_to_signal('CredentialsFound', d.callback)
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('AuthorizationDenied',
-            lambda: d.callback(None))
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('CredentialsError',
-            lambda error_dict: d.errback(CredentialsError(error_dict)))
-        self._cleanup_signals.append(sig)
-
-        done = defer.Deferred()
-        proxy.register({'window_id': str(window_id)},
-            reply_handler=lambda: done.callback(None),
-            error_handler=lambda *a: done.errback(a))
-
-        yield done
-
-        result = yield d
-        defer.returnValue(result)
-
-    @defer.inlineCallbacks
-    def login(self, window_id=0):
-        """Login to Ubuntu One.
-
-        Return a deferred that, when fired, will return the credentials for
-        Ubuntu One for the current logged in user.
-
-        If there are no credentials for the current user, a GTK UI will be
-        opened to invite the user to login to Ubuntu One. This UI provides
-        options to either login (main screen) or retrieve password (secondary
-        screen).
-
-        You can pass an optional 'window_id' parameter that will be used by the
-        GTK UI to be set transient for it.
-
-        The returned credentials will be either a non-empty dictionary like the
-        one described in 'find_credentials', or None. The latter indicates that
-        there were no credentials for the user in the local keyring and that
-        the user refused to login to Ubuntu One.
-
-        """
-        d = defer.Deferred()
-        d.addBoth(self.cleanup)
-
-        proxy = self._get_creds_proxy()
-
-        sig = proxy.connect_to_signal('CredentialsFound', d.callback)
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('AuthorizationDenied',
-            lambda: d.callback(None))
-        self._cleanup_signals.append(sig)
-
-        sig = proxy.connect_to_signal('CredentialsError',
-            lambda error_dict: d.errback(CredentialsError(error_dict)))
-        self._cleanup_signals.append(sig)
-
-        done = defer.Deferred()
-        proxy.login({'window_id': str(window_id)},
-            reply_handler=lambda: done.callback(None),
-            error_handler=lambda *a: done.errback(a))
-
-        yield done
-
-        result = yield d
-        defer.returnValue(result)
+    def find_credentials(self, *args, **kwargs):
+        """Relay the find_credentials method."""
+        return self.proxy.find_credentials(*args, **kwargs)
+
+    def clear_credentials(self, *args, **kwargs):
+        """Relay the clear_credentials method."""
+        return self.proxy.clear_credentials(*args, **kwargs)
+
+    def store_credentials(self, *args, **kwargs):
+        """Relay the store_credentials method."""
+        return self.proxy.store_credentials(*args, **kwargs)
+
+    def register(self, *args, **kwargs):
+        """Relay the register method."""
+        return self.proxy.register(*args, **kwargs)
+
+    def login(self, *args, **kwargs):
+        """Relay the login method."""
+        return self.proxy.login(*args, **kwargs)
+
+    def register_to_credentials_stored(self, callback):
+        """Register to the CredentialsStored dbus signal."""
+        return self.proxy.connect_to_signal('CredentialsStored', callback)
+
+    def register_to_credentials_cleared(self, callback):
+        """Register to the CredentialsCleared dbus signal."""
+        return self.proxy.connect_to_signal('CredentialsCleared', callback)
+
+    def register_to_credentials_found(self, callback):
+        """Register to the CredentialsFound dbus signal."""
+        return self.proxy.connect_to_signal('CredentialsFound', callback)
+
+    def register_to_credentials_not_found(self, callback):
+        """Register to the CredentialsFound dbus signal."""
+        return self.proxy.connect_to_signal('CredentialsNotFound', callback)
+
+    def register_to_authorization_denied(self, callback):
+        """Register to the AuthorizationDenied dbus signal."""
+        return self.proxy.connect_to_signal('AuthorizationDenied', callback)
+
+    def register_to_credentials_error(self, callback):
+        """Register to the CredentialsError dbus signal."""
+        return self.proxy.connect_to_signal('CredentialsError', callback)
+
+
+class CredentialsManagementTool(CredentialsManagementToolRoot):
+    """Wrapper used to manage the creds of ubuntu one."""
+
+    def __init__(self):
+        """Create a new instance."""
+        super(CredentialsManagementTool, self).__init__(
+                                                CredentialsManagementProxy)

=== modified file 'ubuntuone/platform/windows/__init__.py'
--- ubuntuone/platform/windows/__init__.py	2011-05-03 15:22:19 +0000
+++ ubuntuone/platform/windows/__init__.py	2011-06-02 10:17:29 +0000
@@ -57,7 +57,7 @@
     validate_path_from_unix
 )
 
-from ubuntuone.platform.windows.credentials import get_creds_proxy
+from ubuntuone.platform.windows.credentials import CredentialsManagementTool
 from ubuntuone.platform.windows import event_logging
 from ubuntuone.platform.windows.logger import (
     setup_filesystem_logging,

=== added file 'ubuntuone/platform/windows/credentials.py'
--- ubuntuone/platform/windows/credentials.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/platform/windows/credentials.py	2011-06-02 10:17:29 +0000
@@ -0,0 +1,126 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Manuel de la Pena<[e-mail]>
+#
+# Copyright 2011 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+#
+# This program is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
+# PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""Ubuntu One credentials management IPC service."""
+
+
+from ubuntu_sso.main.windows import UbuntuSSOClient
+from twisted.internet import defer
+
+from ubuntu_sso.credentials import (
+    HELP_TEXT_KEY,
+    PING_URL_KEY,
+    TC_URL_KEY,
+)
+from ubuntuone.credentials import (
+    CredentialsManagementToolRoot,
+    APP_NAME,
+    DESCRIPTION,
+    NO_OP,
+    PING_URL,
+    TC_URL,
+)
+from ubuntuone.credentials import CredentialsError as CredentialsErrorRoot
+
+CredentialsError = CredentialsErrorRoot
+
+
+class CredentialsManagement(object):
+    """Object that manages Ubuntu One credentials."""
+
+    def __init__(self, proxy, *args, **kwargs):
+        super(CredentialsManagement, self).__init__(*args, **kwargs)
+        self.sso_proxy = proxy
+
+    def find_credentials(self, reply_handler=NO_OP, error_handler=NO_OP):
+        """Ask the Ubuntu One credentials."""
+        self.sso_proxy.find_credentials(APP_NAME, {},
+            reply_handler=reply_handler, error_handler=error_handler)
+
+
+    def clear_credentials(self, reply_handler=NO_OP, error_handler=NO_OP):
+        """Clear the Ubuntu One credentials."""
+        self.sso_proxy.clear_credentials(APP_NAME, {},
+            reply_handler=reply_handler, error_handler=error_handler)
+
+    def store_credentials(self, credentials,
+                          reply_handler=NO_OP, error_handler=NO_OP):
+        """Store the token for Ubuntu One application."""
+        self.sso_proxy.store_credentials(APP_NAME, credentials,
+            reply_handler=reply_handler, error_handler=error_handler)
+
+    def register(self, args, reply_handler=NO_OP, error_handler=NO_OP):
+        """Get credentials if found else prompt to register to Ubuntu One."""
+        params = {HELP_TEXT_KEY: DESCRIPTION, TC_URL_KEY: TC_URL,
+                  PING_URL_KEY: PING_URL}
+        params.update(args)
+        self.sso_proxy.register(APP_NAME, params,
+            reply_handler=reply_handler, error_handler=error_handler)
+
+    def login(self, args, reply_handler=NO_OP, error_handler=NO_OP):
+        """Get credentials if found else prompt to login to Ubuntu One."""
+        params = {HELP_TEXT_KEY: DESCRIPTION, TC_URL_KEY: TC_URL,
+                  PING_URL_KEY: PING_URL}
+        params.update(args)
+        self.sso_proxy.login(APP_NAME, params,
+            reply_handler=reply_handler, error_handler=error_handler)
+
+    def register_to_credentials_stored(self, callback):
+        """Register to the CredentialsStored dbus signal."""
+        self.sso_proxy.on_credentials_stored_cb = callback
+        return self.sso_proxy.on_credentials_stored_cb
+
+    def register_to_credentials_cleared(self, callback):
+        """Register to the CredentialsCleared dbus signal."""
+        self.sso_proxy.on_credentials_cleared_cb = callback
+        return self.sso_proxy.on_credentials_cleared_cb
+
+    def register_to_credentials_found(self, callback):
+        """Register to the CredentialsFound dbus signal."""
+        self.sso_proxy.on_credentials_found_cb = callback
+        return self.sso_proxy.on_credentials_found_cb
+
+    def register_to_credentials_not_found(self, callback):
+        """Register to the CredentialsFound dbus signal."""
+        self.sso_proxy.on_credentials_not_found_cb = callback
+        return self.sso_proxy.on_credentials_not_found_cb
+
+    def register_to_authorization_denied(self, callback):
+        """Register to the AuthorizationDenied dbus signal."""
+        self.sso_proxy.on_authorization_denied_cb = callback
+        return self.sso_proxy.on_authorization_denied_cb
+
+    def register_to_credentials_error(self, callback):
+        """Register to the CredentialsError dbus signal."""
+        self.sso_proxy.on_credentials_error_cb = callback
+        return self.sso_proxy.on_credentials_error_cb
+
+
[e-mail]
+def get_creds_proxy():
+    """Get the CredentialsManagement dbus proxy."""
+    client = UbuntuSSOClient()
+    client = yield client.connect()
+    defer.returnValue(CredentialsManagement(client.cred_management))
+
+
+class CredentialsManagementTool(CredentialsManagementToolRoot):
+    """Wrapper used to manage the creds of ubuntu one."""
+
+    def __init__(self):
+        """Create a new instance."""
+        super(CredentialsManagementTool, self).__init__(get_creds_proxy)