« back to all changes in this revision
Viewing changes to grackle/client.py
- browse files at revision 35.1.6
- compare with another revision
- download diff
- download tarball
- view history from revision 35.1.6
- Committer: Curtis Hovey
- Date: 2012-01-30 20:57:08 UTC
- mto: This revision was merged to the branch mainline in revision 37.
- Revision ID: curtis.hovey@canonical.com-20120130205708-1sxt295z6nvbsmfg
Added display_type == 'headers-only' support.
- files modified:
- grackle-put-message
added
removed
grackle/client.py
7
7
)
8
8
9
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',
22
)
23
10
24
11
25
class GrackleClient:
26
"""Class for accessing Grackle web service."""
12
27
13
28
def __init__(self, host, port):
29
"""Constructor.
30
31
:param host: The name of the server.
32
:param port: The port providing Grackle service.
33
"""
14
34
self.host = host
15
35
self.port = port
16
36
self.netloc = '%s:%d' % (host, port)
17
37
18
38
def archive_url(self, archive_id, query):
19
path = '/%s' % quote(archive_id)
39
"""Return the URL for an archive
40
41
:param archive_id: The id of the archive to generate the URL for.
42
:param query: The query to use in the URL, as a dict.
43
"""
44
path = '/archive/%s' % quote(archive_id)
20
45
query_string = urlencode(query)
21
46
return urlunparse(('http', self.netloc, path, '', query_string, ''))
22
47
23
48
def _get_connection(self):
24
49
return httplib.HTTPConnection(self.host, self.port)
25
50
26
def _verb_archive(self, verb, archive_id, query, body=None):
51
def _method_archive(self, method, archive_id, query, body=None):
52
"""Perform an HTTP method on an archive's URL."""
27
53
url = self.archive_url(archive_id, query)
28
54
connection = self._get_connection()
29
connection.request(verb, url, body)
55
connection.request(method, url, body)
30
56
return connection.getresponse()
31
57
32
58
def put_message(self, archive_id, key, file_obj):
33
response = self._verb_archive(
59
"""Put a message into an archive.
60
61
:param archive_id: The archive to put the message into.
62
:param key: An arbitrary identifier that can later be used to retrieve
63
the message.
64
:param file_obj: The raw text of the message, as a file.
65
"""
66
response = self._method_archive(
34
67
'POST', archive_id, {'key': key}, file_obj.read())
35
data = response.read()
68
response.read()
36
69
if response.status == httplib.BAD_REQUEST:
37
70
raise Exception('wtf')
38
71
elif response.status == httplib.CREATED:
41
74
raise Exception('!!')
42
75
43
76
def get_messages(self, archive_id, message_ids=None, limit=None,
44
memo=None):
77
memo=None, order=None, headers=None,
78
max_body_length=None, include_hidden=False,
79
display_type='all'):
80
"""Retrieve specified messages.
81
82
:param archive_id: The archive to retrieve messages from.
83
:param message_ids: (optional) Retrieve only messages with these ids.
84
:param limit: The maximum number of messages to return. The server
85
may, at its discretion, return fewer.
86
:param memo: (optional) Opaque identifier describing the position in
87
the list of messages to return. The combination of a memo and a
88
limit describes a batch of results. If not specified, the start
89
is used.
90
:param order: The order to return results in. Supported orders are
91
determined by the server. See test_client.SUPPORTED_ORDERS for an
92
example.
93
:param headers: The headers to include in the message. Only headers
94
actually present in the message will be provided. If unspecified,
95
most headers will be included.
96
:param max_body_length: The maximum length for a message's body. When
97
multiple messages are nested (as with a thread), this applies to
98
each message's body, not the aggregate length of all messages'
99
bodies.
100
:param include_hidden: If true, include messages that have been
101
flagged "hidden" in the results.
102
:param display_type: Adjust the message content to meet the needs of
103
the intended display. Valid values are:
104
all: (the default) include all message content.
105
text-only: include only plain/text parts; exclude all other parts.
106
headers-only: include only the message headers.
107
"""
45
108
parameters = {}
46
109
if message_ids is not None:
47
110
parameters['message_ids'] = message_ids
49
112
parameters['limit'] = limit
50
113
if memo is not None:
51
114
parameters['memo'] = memo
115
if order is not None:
116
parameters['order'] = order
117
if headers is not None:
118
parameters['headers'] = headers
119
if max_body_length is not None:
120
parameters['max_body_length'] = max_body_length
121
if display_type not in SUPPORTED_DISPLAY_TYPES:
122
raise UnsupportedDisplayType
123
parameters['display_type'] = display_type
124
parameters['include_hidden'] = include_hidden
52
125
query = {'parameters': simplejson.dumps(parameters)}
53
response = self._verb_archive('GET', archive_id, query)
126
response = self._method_archive('GET', archive_id, query)
127
if response.status == httplib.BAD_REQUEST:
128
raise UnsupportedOrder
54
129
data = response.read()
55
130
return simplejson.loads(data)
Loggerhead is a web-based interface for Breezy
Version: 2.0.1