← Back to branch summary

~unity-2d-team/unity-2d/Shell-MultiMonitor

« back to all changes in this revision

Viewing changes to grackle/client.py

  • Committer: William Grant
  • Date: 2012-04-20 02:20:58 UTC
  • mfrom: (6.1.70 trunk)
  • Revision ID: william.grant@canonical.com-20120420022058-3nkracsmlg7akydu
Merge trunk.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
 
1
__metaclass__ = type
 
2
 
1
3
import httplib
2
4
import simplejson
3
5
from urlparse import urlunparse
6
8
    urlencode,
7
9
)
8
10
 
9
 
 
10
 
class UnsupportedDisplayType(Exception):
11
 
    """Raised when an Unsupported display_type is requested."""
12
 
 
13
 
 
14
 
class UnsupportedOrder(Exception):
15
 
    """Raised when an Unsupported order is requested."""
16
 
 
17
 
 
18
 
SUPPORTED_DISPLAY_TYPES = (
19
 
    'all',
20
 
    'text-only',
21
 
    'headers-only',
 
11
from grackle.error import (
 
12
    ArchiveIdExists,
 
13
    MessageIdNotFound,
 
14
    UnparsableDateRange,
 
15
    UnsupportedDisplayType,
 
16
    UnsupportedOrder,
22
17
    )
23
18
 
24
19
 
35
30
        self.port = port
36
31
        self.netloc = '%s:%d' % (host, port)
37
32
 
38
 
    def archive_url(self, archive_id, query):
 
33
    def archive_url(self, path, query):
39
34
        """Return the URL for an archive
40
35
 
41
 
        :param archive_id: The id of the archive to generate the URL for.
 
36
        :param path: The path to generate the URL for.
 
37
            Maybe be '', 'archive_id', or 'archive_id/message_id'
42
38
        :param query: The query to use in the URL, as a dict.
43
39
        """
44
 
        path = '/archive/%s' % quote(archive_id)
 
40
        path = '/archive/%s' % quote(path)
45
41
        query_string = urlencode(query)
46
42
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
47
43
 
48
44
    def _get_connection(self):
49
45
        return httplib.HTTPConnection(self.host, self.port)
50
46
 
51
 
    def _method_archive(self, method, archive_id, query, body=None):
 
47
    def _method_archive(self, method, path, query, body=None):
52
48
        """Perform an HTTP method on an archive's URL."""
53
 
        url = self.archive_url(archive_id, query)
 
49
        url = self.archive_url(path, query)
54
50
        connection = self._get_connection()
55
51
        connection.request(method, url, body)
56
52
        return connection.getresponse()
57
53
 
 
54
    def put_archive(self, archive_id, mbox=None):
 
55
        """Create an archive.
 
56
 
 
57
        :param archive_id: The archive id.
 
58
        :param mbox: An optional mbox with messages to add to the new archive.
 
59
        """
 
60
        response = self._method_archive(
 
61
            'PUT', archive_id, {}, None)
 
62
        response.read()
 
63
        if response.status == httplib.BAD_REQUEST:
 
64
            if response.reason == ArchiveIdExists.__doc__:
 
65
                raise ArchiveIdExists
 
66
            raise Exception('wtf')
 
67
        elif response.status == httplib.CREATED:
 
68
            return
 
69
        else:
 
70
            raise Exception('!!')
 
71
 
58
72
    def put_message(self, archive_id, key, file_obj):
59
73
        """Put a message into an archive.
60
74
 
63
77
            the message.
64
78
        :param file_obj: The raw text of the message, as a file.
65
79
        """
 
80
        path = '%s/%s' % (archive_id, key)
66
81
        response = self._method_archive(
67
 
            'POST', archive_id, {'key': key}, file_obj.read())
 
82
            'PUT', path, {}, file_obj.read())
68
83
        response.read()
69
84
        if response.status == httplib.BAD_REQUEST:
 
85
            if response.reason == ArchiveIdExists.__doc__:
 
86
                raise ArchiveIdExists
70
87
            raise Exception('wtf')
71
88
        elif response.status == httplib.CREATED:
72
89
            return
73
90
        else:
74
91
            raise Exception('!!')
75
92
 
76
 
    def get_messages(self, archive_id, message_ids=None, limit=None,
77
 
                     memo=None, order=None, headers=None,
78
 
                     max_body_length=None, include_hidden=False,
 
93
    def get_messages(self, archive_id, message_ids=None, date_range=None,
 
94
                     limit=None, memo=None, order=None, headers=None,
 
95
                     include_hidden=False, max_body_length=None,
79
96
                     display_type='all'):
80
97
        """Retrieve specified messages.
81
98
 
82
99
        :param archive_id: The archive to retrieve messages from.
83
100
        :param message_ids: (optional) Retrieve only messages with these ids.
 
101
        :param date_range: Retrieve the messages from or between a range of
 
102
            dates. Example: 2012-01-01..2012-01-31 retrieve all the messages
 
103
            between the 01 and 31 of January, including message from 01
 
104
            and 31.
84
105
        :param limit: The maximum number of messages to return.  The server
85
106
            may, at its discretion, return fewer.
86
107
        :param memo: (optional) Opaque identifier describing the position in
108
129
        parameters = {}
109
130
        if message_ids is not None:
110
131
            parameters['message_ids'] = message_ids
 
132
        if date_range is not None:
 
133
            parameters['date_range'] = date_range
111
134
        if limit is not None:
112
135
            parameters['limit'] = limit
113
136
        if memo is not None:
127
150
                raise UnsupportedOrder
128
151
            elif response.reason == UnsupportedDisplayType.__doc__:
129
152
                raise UnsupportedDisplayType
 
153
            elif response.reason == UnparsableDateRange.__doc__:
 
154
                raise UnparsableDateRange
130
155
            else:
131
156
                raise ValueError('Bad request')
132
157
        data = response.read()
133
158
        return simplejson.loads(data)
 
159
 
 
160
    def hide_message(self, archive_id, message_id, hidden):
 
161
        parameters = {
 
162
            'hidden': hidden,
 
163
            }
 
164
        query = {'parameters': simplejson.dumps(parameters)}
 
165
        path = '%s/%s' % (archive_id, message_id)
 
166
        response = self._method_archive('POST', path, query)
 
167
        if response.status == httplib.BAD_REQUEST:
 
168
            if response.reason == MessageIdNotFound.__doc__:
 
169
                raise MessageIdNotFound
 
170
        data = response.read()
 
171
        return simplejson.loads(data)