« back to all changes in this revision
Viewing changes to grackle/client.py
- browse files at revision 45
- compare with another revision
- download diff
- download tarball
- view history from revision 45
- 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.
- files added:
- grackle/error.py
- files modified:
- Makefile
added
removed
grackle/client.py
1
__metaclass__ = type
2
1
3
import httplib
2
3
def put_message(archive_name, file_obj):
4
connection = httplib.HTTPConnection('localhost', 8435)
5
connection.request('POST', '/archive/%s' % archive_name, file_obj.read())
6
response = connection.getresponse()
7
data = response.read()
8
if response.status == httplib.BAD_REQUEST:
9
raise Exception('wtf')
10
elif response.status == httplib.CREATED:
11
return
12
else:
13
raise Exception('!!')
4
import simplejson
5
from urlparse import urlunparse
6
from urllib import (
7
quote,
8
urlencode,
9
)
10
11
from grackle.error import (
12
ArchiveIdExists,
13
MessageIdNotFound,
14
UnparsableDateRange,
15
UnsupportedDisplayType,
16
UnsupportedOrder,
17
)
18
19
20
class GrackleClient:
21
"""Class for accessing Grackle web service."""
22
23
def __init__(self, host, port):
24
"""Constructor.
25
26
:param host: The name of the server.
27
:param port: The port providing Grackle service.
28
"""
29
self.host = host
30
self.port = port
31
self.netloc = '%s:%d' % (host, port)
32
33
def archive_url(self, path, query):
34
"""Return the URL for an archive
35
36
:param path: The path to generate the URL for.
37
Maybe be '', 'archive_id', or 'archive_id/message_id'
38
:param query: The query to use in the URL, as a dict.
39
"""
40
path = '/archive/%s' % quote(path)
41
query_string = urlencode(query)
42
return urlunparse(('http', self.netloc, path, '', query_string, ''))
43
44
def _get_connection(self):
45
return httplib.HTTPConnection(self.host, self.port)
46
47
def _method_archive(self, method, path, query, body=None):
48
"""Perform an HTTP method on an archive's URL."""
49
url = self.archive_url(path, query)
50
connection = self._get_connection()
51
connection.request(method, url, body)
52
return connection.getresponse()
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
72
def put_message(self, archive_id, key, file_obj):
73
"""Put a message into an archive.
74
75
:param archive_id: The archive to put the message into.
76
:param key: An arbitrary identifier that can later be used to retrieve
77
the message.
78
:param file_obj: The raw text of the message, as a file.
79
"""
80
path = '%s/%s' % (archive_id, key)
81
response = self._method_archive(
82
'PUT', path, {}, file_obj.read())
83
response.read()
84
if response.status == httplib.BAD_REQUEST:
85
if response.reason == ArchiveIdExists.__doc__:
86
raise ArchiveIdExists
87
raise Exception('wtf')
88
elif response.status == httplib.CREATED:
89
return
90
else:
91
raise Exception('!!')
92
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,
96
display_type='all'):
97
"""Retrieve specified messages.
98
99
:param archive_id: The archive to retrieve messages from.
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.
105
:param limit: The maximum number of messages to return. The server
106
may, at its discretion, return fewer.
107
:param memo: (optional) Opaque identifier describing the position in
108
the list of messages to return. The combination of a memo and a
109
limit describes a batch of results. If not specified, the start
110
is used.
111
:param order: The order to return results in. Supported orders are
112
determined by the server. See test_client.SUPPORTED_ORDERS for an
113
example.
114
:param headers: The headers to include in the message. Only headers
115
actually present in the message will be provided. If unspecified,
116
most headers will be included.
117
:param max_body_length: The maximum length for a message's body. When
118
multiple messages are nested (as with a thread), this applies to
119
each message's body, not the aggregate length of all messages'
120
bodies.
121
:param include_hidden: If true, include messages that have been
122
flagged "hidden" in the results.
123
:param display_type: Adjust the message content to meet the needs of
124
the intended display. Valid values are:
125
all: (the default) include all message content.
126
text-only: include only plain/text parts; exclude all other parts.
127
headers-only: include only the message headers.
128
"""
129
parameters = {}
130
if message_ids is not None:
131
parameters['message_ids'] = message_ids
132
if date_range is not None:
133
parameters['date_range'] = date_range
134
if limit is not None:
135
parameters['limit'] = limit
136
if memo is not None:
137
parameters['memo'] = memo
138
if order is not None:
139
parameters['order'] = order
140
if headers is not None:
141
parameters['headers'] = headers
142
if max_body_length is not None:
143
parameters['max_body_length'] = max_body_length
144
parameters['display_type'] = display_type
145
parameters['include_hidden'] = include_hidden
146
query = {'parameters': simplejson.dumps(parameters)}
147
response = self._method_archive('GET', archive_id, query)
148
if response.status == httplib.BAD_REQUEST:
149
if response.reason == UnsupportedOrder.__doc__:
150
raise UnsupportedOrder
151
elif response.reason == UnsupportedDisplayType.__doc__:
152
raise UnsupportedDisplayType
153
elif response.reason == UnparsableDateRange.__doc__:
154
raise UnparsableDateRange
155
else:
156
raise ValueError('Bad request')
157
data = response.read()
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)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1