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