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