← Back to branch summary

~mvo/ubuntu-sso-client/strawman-lp711413

« back to all changes in this revision

Viewing changes to ubuntu_sso/utils/webclient/common.py

  • Committer: Tarmac
  • Author(s): Natalia B. Bidart
  • Date: 2011-12-20 15:46:10 UTC
  • mfrom: (815.1.2 stable-3-0-update)
  • Revision ID: tarmac-20111220154610-bbocw3y2omwkjgze
[ Alejandro J. Cura <alecu@canonical.com> ]
  - An async webclient with qtnetwork and libsoup backends, to be used for
    proxy support.
  - Use the dedicated time url (LP: #891644).

[ Diego Sarmentero <diego.sarmentero@canonical.com> ]
  - Fixed pep8 issue.
  - Fix double back navigation in SSO reset code page (LP: #862403).

[ Manuel de la Pena <manuel.delapena@canonical.com> ]
  - Fixed the tests by ensuring that the server and the client are correctly
    closed.
  - Changed the import from ubuntuone-dev-tools so that we do not use the
    deprecated API.

[ Natalia B. Bidart <natalia.bidart@canonical.com> ]
  - Do not hardcode the app_name when showing the TC_NOT_ACCEPTED message
    (LP: #TC_NOT_ACCEPTED).
  - Pass module for test to u1trial properly.
  - Have a single executable to start the service (LP: #890416).
  - Lint fixes (LP: #890349).

Show diffs side-by-side

added added

removed removed

Lines of Context:
ubuntu_sso/utils/webclient/common.py
 
1
# -*- coding: utf-8 -*-
 
2
#
 
3
# Copyright 2011 Canonical Ltd.
 
4
#
 
5
# This program is free software: you can redistribute it and/or modify it
 
6
# under the terms of the GNU General Public License version 3, as published
 
7
# by the Free Software Foundation.
 
8
#
 
9
# This program is distributed in the hope that it will be useful, but
 
10
# WITHOUT ANY WARRANTY; without even the implied warranties of
 
11
# MERCHANTABILITY, SATISFACTORY QUALITY, or FITNESS FOR A PARTICULAR
 
12
# PURPOSE.  See the GNU General Public License for more details.
 
13
#
 
14
# You should have received a copy of the GNU General Public License along
 
15
# with this program.  If not, see <http://www.gnu.org/licenses/>.
 
16
"""The common bits of a webclient."""
 
17
 
 
18
import time
 
19
 
 
20
from oauth import oauth
 
21
from twisted.internet import defer
 
22
 
 
23
 
 
24
class WebClientError(Exception):
 
25
    """An http error happened while calling the webservice."""
 
26
 
 
27
 
 
28
class UnauthorizedError(WebClientError):
 
29
    """The request ended with bad_request, unauthorized or forbidden."""
 
30
 
 
31
 
 
32
class Response(object):
 
33
    """A reponse object."""
 
34
 
 
35
    def __init__(self, content, headers=None):
 
36
        """Initialize this instance."""
 
37
        self.content = content
 
38
        self.headers = headers
 
39
 
 
40
 
 
41
class BaseWebClient(object):
 
42
    """The webclient base class, to be extended by backends."""
 
43
 
 
44
    def __init__(self, username=None, password=None):
 
45
        """Initialize this instance."""
 
46
        self.username = username
 
47
        self.password = password
 
48
 
 
49
    def request(self, url, method="GET", extra_headers=None,
 
50
                oauth_credentials=None):
 
51
        """Return a deferred that will be fired with a Response object."""
 
52
        raise NotImplementedError
 
53
 
 
54
    def get_timestamp(self):
 
55
        """Get a timestamp synchronized with the server."""
 
56
        # pylint: disable=W0511
 
57
        # TODO: get the synchronized timestamp
 
58
        return defer.succeed(time.time())
 
59
 
 
60
    @staticmethod
 
61
    def build_oauth_headers(method, url, credentials, timestamp):
 
62
        """Build an oauth request given some credentials."""
 
63
        consumer = oauth.OAuthConsumer(credentials["consumer_key"],
 
64
                                       credentials["consumer_secret"])
 
65
        token = oauth.OAuthToken(credentials["token"],
 
66
                                 credentials["token_secret"])
 
67
        parameters = {}
 
68
        if timestamp:
 
69
            parameters["oauth_timestamp"] = timestamp
 
70
        request = oauth.OAuthRequest.from_consumer_and_token(
 
71
                                            http_url=url,
 
72
                                            http_method=method,
 
73
                                            parameters=parameters,
 
74
                                            oauth_consumer=consumer,
 
75
                                            token=token)
 
76
        sig_method = oauth.OAuthSignatureMethod_HMAC_SHA1()
 
77
        request.sign_request(sig_method, consumer, token)
 
78
        return request.to_header()
 
79
 
 
80
    def shutdown(self):
 
81
        """Shut down all pending requests (if possible)."""