9
from grackle.error import (
13
UnsupportedDisplayType,
11
18
class GrackleClient:
19
"""Class for accessing Grackle web service."""
13
21
def __init__(self, host, port):
24
:param host: The name of the server.
25
:param port: The port providing Grackle service.
16
29
self.netloc = '%s:%d' % (host, port)
18
def archive_url(self, archive_id, query):
19
path = '/%s' % quote(archive_id)
31
def archive_url(self, path, query):
32
"""Return the URL for an archive
34
:param path: The path to generate the URL for.
35
Maybe be '', 'archive_id', or 'archive_id/message_id'
36
:param query: The query to use in the URL, as a dict.
38
path = '/archive/%s' % quote(path)
20
39
query_string = urlencode(query)
21
40
return urlunparse(('http', self.netloc, path, '', query_string, ''))
23
42
def _get_connection(self):
24
43
return httplib.HTTPConnection(self.host, self.port)
26
def _verb_archive(self, verb, archive_id, query, body=None):
27
url = self.archive_url(archive_id, query)
45
def _method_archive(self, method, path, query, body=None):
46
"""Perform an HTTP method on an archive's URL."""
47
url = self.archive_url(path, query)
28
48
connection = self._get_connection()
29
connection.request(verb, url, body)
49
connection.request(method, url, body)
30
50
return connection.getresponse()
52
def put_archive(self, archive_id, mbox=None):
55
:param archive_id: The archive id.
56
:param mbox: An optional mbox with messages to add to the new archive.
58
response = self._method_archive(
59
'PUT', archive_id, {}, None)
61
if response.status == httplib.BAD_REQUEST:
62
if response.reason == ArchiveIdExists.__doc__:
64
raise Exception('wtf')
65
elif response.status == httplib.CREATED:
32
70
def put_message(self, archive_id, key, file_obj):
33
response = self._verb_archive(
34
'POST', archive_id, {'key': key}, file_obj.read())
35
data = response.read()
71
"""Put a message into an archive.
73
:param archive_id: The archive to put the message into.
74
:param key: An arbitrary identifier that can later be used to retrieve
76
:param file_obj: The raw text of the message, as a file.
78
path = '%s/%s' % (archive_id, key)
79
response = self._method_archive(
80
'PUT', path, {}, file_obj.read())
36
82
if response.status == httplib.BAD_REQUEST:
83
if response.reason == ArchiveIdExists.__doc__:
37
85
raise Exception('wtf')
38
86
elif response.status == httplib.CREATED:
41
89
raise Exception('!!')
43
def get_messages(self, archive_id, message_ids=None, limit=None,
44
memo=None, order=None):
91
def get_messages(self, archive_id, message_ids=None, date_range=None,
92
limit=None, memo=None, order=None, headers=None,
93
include_hidden=False, max_body_length=None,
95
"""Retrieve specified messages.
97
:param archive_id: The archive to retrieve messages from.
98
:param message_ids: (optional) Retrieve only messages with these ids.
99
:param date_range: Retrieve the messages from or between a range of
100
dates. Example: 2012-01-01..2012-01-31 retrieve all the messages
101
between the 01 and 31 of January, including message from 01
103
:param limit: The maximum number of messages to return. The server
104
may, at its discretion, return fewer.
105
:param memo: (optional) Opaque identifier describing the position in
106
the list of messages to return. The combination of a memo and a
107
limit describes a batch of results. If not specified, the start
109
:param order: The order to return results in. Supported orders are
110
determined by the server. See test_client.SUPPORTED_ORDERS for an
112
:param headers: The headers to include in the message. Only headers
113
actually present in the message will be provided. If unspecified,
114
most headers will be included.
115
:param max_body_length: The maximum length for a message's body. When
116
multiple messages are nested (as with a thread), this applies to
117
each message's body, not the aggregate length of all messages'
119
:param include_hidden: If true, include messages that have been
120
flagged "hidden" in the results.
121
:param display_type: Adjust the message content to meet the needs of
122
the intended display. Valid values are:
123
all: (the default) include all message content.
124
text-only: include only plain/text parts; exclude all other parts.
125
headers-only: include only the message headers.
46
128
if message_ids is not None:
47
129
parameters['message_ids'] = message_ids
130
if date_range is not None:
131
parameters['date_range'] = date_range
48
132
if limit is not None:
49
133
parameters['limit'] = limit
50
134
if memo is not None:
51
135
parameters['memo'] = memo
52
136
if order is not None:
53
137
parameters['order'] = order
54
query = {'parameters': simplejson.dumps(parameters)}
55
response = self._verb_archive('GET', archive_id, query)
138
if headers is not None:
139
parameters['headers'] = headers
140
if max_body_length is not None:
141
parameters['max_body_length'] = max_body_length
142
parameters['display_type'] = display_type
143
parameters['include_hidden'] = include_hidden
144
query = {'parameters': simplejson.dumps(parameters)}
145
response = self._method_archive('GET', archive_id, query)
146
if response.status == httplib.BAD_REQUEST:
147
if response.reason == UnsupportedOrder.__doc__:
148
raise UnsupportedOrder
149
elif response.reason == UnsupportedDisplayType.__doc__:
150
raise UnsupportedDisplayType
151
elif response.reason == UnparsableDateRange.__doc__:
152
raise UnparsableDateRange
154
raise ValueError('Bad request')
155
data = response.read()
156
return simplejson.loads(data)
158
def hide_message(self, archive_id, message_id, hidden):
162
query = {'parameters': simplejson.dumps(parameters)}
163
path = '%s/%s' % (archive_id, message_id)
164
response = self._method_archive('POST', path, query)
165
if response.status == httplib.BAD_REQUEST:
166
if response.reason == MessageIdNotFound.__doc__:
167
raise MessageIdNotFound
56
168
data = response.read()
57
169
return simplejson.loads(data)