~didrocks/unity/altf10 : revision 76

1

__metaclass__ = type

2

1

3

import httplib

2

4

import simplejson

3

5

from urlparse import urlunparse

6

8

urlencode,

7

9

)

8

10

9

10

class UnsupportedOrder(Exception):

11

"""Raised when an Unsupported order is requested."""

11

from grackle.error import (

12

ArchiveIdExists,

13

MessageIdNotFound,

14

UnparsableDateRange,

15

UnsupportedDisplayType,

16

UnsupportedOrder,

17

)

12

18

13

19

14

20

class GrackleClient:

24

30

self.port = port

25

31

self.netloc = '%s:%d' % (host, port)

26

32

27

def archive_url(self, archive_id, query):

33

def archive_url(self, path, query):

28

34

"""Return the URL for an archive

29

35

30

:param archive_id: The id of the archive to generate the URL for.

36

:param path: The path to generate the URL for.

37

Maybe be '', 'archive_id', or 'archive_id/message_id'

31

38

:param query: The query to use in the URL, as a dict.

32

39

"""

33

path = '/archive/%s' % quote(archive_id)

40

path = '/archive/%s' % quote(path)

34

41

query_string = urlencode(query)

35

42

return urlunparse(('http', self.netloc, path, '', query_string, ''))

36

43

37

44

def _get_connection(self):

38

45

return httplib.HTTPConnection(self.host, self.port)

39

46

40

def _method_archive(self, method, archive_id, query, body=None):

47

def _method_archive(self, method, path, query, body=None):

41

48

"""Perform an HTTP method on an archive's URL."""

42

url = self.archive_url(archive_id, query)

49

url = self.archive_url(path, query)

43

50

connection = self._get_connection()

44

51

connection.request(method, url, body)

45

52

return connection.getresponse()

46

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

47

72

def put_message(self, archive_id, key, file_obj):

48

73

"""Put a message into an archive.

49

74

52

77

the message.

53

78

:param file_obj: The raw text of the message, as a file.

54

79

"""

80

path = '%s/%s' % (archive_id, key)

55

81

response = self._method_archive(

56

'POST', archive_id, {'key': key}, file_obj.read())

57

data = response.read()

82

'PUT', path, {}, file_obj.read())

83

response.read()

58

84

if response.status == httplib.BAD_REQUEST:

85

if response.reason == ArchiveIdExists.__doc__:

86

raise ArchiveIdExists

59

87

raise Exception('wtf')

60

88

elif response.status == httplib.CREATED:

61

89

return

62

90

else:

63

91

raise Exception('!!')

64

92

65

def get_messages(self, archive_id, message_ids=None, limit=None,

66

memo=None, order=None, headers=None,

67

max_body_length=None, include_hidden=False):

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'):

68

97

"""Retrieve specified messages.

69

98

70

99

:param archive_id: The archive to retrieve messages from.

71

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.

72

105

:param limit: The maximum number of messages to return. The server

73

106

may, at its discretion, return fewer.

74

107

:param memo: (optional) Opaque identifier describing the position in

87

120

bodies.

88

121

:param include_hidden: If true, include messages that have been

89

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.

90

128

"""

91

129

parameters = {}

92

130

if message_ids is not None:

93

131

parameters['message_ids'] = message_ids

132

if date_range is not None:

133

parameters['date_range'] = date_range

94

134

if limit is not None:

95

135

parameters['limit'] = limit

96

136

if memo is not None:

101

141

parameters['headers'] = headers

102

142

if max_body_length is not None:

103

143

parameters['max_body_length'] = max_body_length

144

parameters['display_type'] = display_type

104

145

parameters['include_hidden'] = include_hidden

105

146

query = {'parameters': simplejson.dumps(parameters)}

106

147

response = self._method_archive('GET', archive_id, query)

107

148

if response.status == httplib.BAD_REQUEST:

108

raise UnsupportedOrder

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')

109

157

data = response.read()

110

158

return simplejson.loads(data)

111

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)