← Back to branch summary

~didrocks/unity/altf10

« back to all changes in this revision

Viewing changes to grackle/client.py

  • Committer: Curtis Hovey
  • Date: 2012-01-31 05:24:10 UTC
  • mfrom: (35.1.19 client-get-messages-0)
  • Revision ID: curtis.hovey@canonical.com-20120131052410-4n5iva4ujik6nhp8
Added support for display_type.
Introduced make_message and make_mime_message to make test data consistent for
InMemoryStore.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
1
 
__metaclass__ = type
2
 
 
3
1
import httplib
4
2
import simplejson
5
3
from urlparse import urlunparse
8
6
    urlencode,
9
7
)
10
8
 
11
 
from grackle.error import (
12
 
    ArchiveIdExists,
13
 
    MessageIdNotFound,
14
 
    UnparsableDateRange,
15
 
    UnsupportedDisplayType,
16
 
    UnsupportedOrder,
 
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',
17
22
    )
18
23
 
19
24
 
30
35
        self.port = port
31
36
        self.netloc = '%s:%d' % (host, port)
32
37
 
33
 
    def archive_url(self, path, query):
 
38
    def archive_url(self, archive_id, query):
34
39
        """Return the URL for an archive
35
40
 
36
 
        :param path: The path to generate the URL for.
37
 
            Maybe be '', 'archive_id', or 'archive_id/message_id'
 
41
        :param archive_id: The id of the archive to generate the URL for.
38
42
        :param query: The query to use in the URL, as a dict.
39
43
        """
40
 
        path = '/archive/%s' % quote(path)
 
44
        path = '/archive/%s' % quote(archive_id)
41
45
        query_string = urlencode(query)
42
46
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
43
47
 
44
48
    def _get_connection(self):
45
49
        return httplib.HTTPConnection(self.host, self.port)
46
50
 
47
 
    def _method_archive(self, method, path, query, body=None):
 
51
    def _method_archive(self, method, archive_id, query, body=None):
48
52
        """Perform an HTTP method on an archive's URL."""
49
 
        url = self.archive_url(path, query)
 
53
        url = self.archive_url(archive_id, query)
50
54
        connection = self._get_connection()
51
55
        connection.request(method, url, body)
52
56
        return connection.getresponse()
53
57
 
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
 
 
72
58
    def put_message(self, archive_id, key, file_obj):
73
59
        """Put a message into an archive.
74
60
 
77
63
            the message.
78
64
        :param file_obj: The raw text of the message, as a file.
79
65
        """
80
 
        path = '%s/%s' % (archive_id, key)
81
66
        response = self._method_archive(
82
 
            'PUT', path, {}, file_obj.read())
 
67
            'POST', archive_id, {'key': key}, file_obj.read())
83
68
        response.read()
84
69
        if response.status == httplib.BAD_REQUEST:
85
 
            if response.reason == ArchiveIdExists.__doc__:
86
 
                raise ArchiveIdExists
87
70
            raise Exception('wtf')
88
71
        elif response.status == httplib.CREATED:
89
72
            return
90
73
        else:
91
74
            raise Exception('!!')
92
75
 
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,
 
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,
96
79
                     display_type='all'):
97
80
        """Retrieve specified messages.
98
81
 
99
82
        :param archive_id: The archive to retrieve messages from.
100
83
        :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.
105
84
        :param limit: The maximum number of messages to return.  The server
106
85
            may, at its discretion, return fewer.
107
86
        :param memo: (optional) Opaque identifier describing the position in
129
108
        parameters = {}
130
109
        if message_ids is not None:
131
110
            parameters['message_ids'] = message_ids
132
 
        if date_range is not None:
133
 
            parameters['date_range'] = date_range
134
111
        if limit is not None:
135
112
            parameters['limit'] = limit
136
113
        if memo is not None:
150
127
                raise UnsupportedOrder
151
128
            elif response.reason == UnsupportedDisplayType.__doc__:
152
129
                raise UnsupportedDisplayType
153
 
            elif response.reason == UnparsableDateRange.__doc__:
154
 
                raise UnparsableDateRange
155
130
            else:
156
131
                raise ValueError('Bad request')
157
132
        data = response.read()
158
133
        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)