~didrocks/unity/altf10 : revision 62

6

urlencode,

7

)

8

9

10

class UnsupportedOrder(Exception):

11

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

9

from grackle.error import (

10

ArchiveIdExists,

11

MessageIdNotFound,

12

UnparsableDateRange,

13

UnsupportedDisplayType,

14

UnsupportedOrder,

15

)

12

16

13

17

14

18

class GrackleClient:

24

28

self.port = port

25

29

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

26

30

27

def archive_url(self, archive_id, query):

31

def archive_url(self, path, query):

28

32

"""Return the URL for an archive

29

33

30

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

34

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

35

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

31

36

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

32

37

"""

33

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

38

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

34

39

query_string = urlencode(query)

35

40

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

36

41

37

42

def _get_connection(self):

38

43

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

39

44

40

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

45

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

41

46

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

42

url = self.archive_url(archive_id, query)

47

url = self.archive_url(path, query)

43

48

connection = self._get_connection()

44

49

connection.request(method, url, body)

45

50

return connection.getresponse()

46

51

52

def put_archive(self, archive_id, mbox=None):

53

"""Create an archive.

54

55

:param archive_id: The archive id.

56

:param mbox: An optional mbox with messages to add to the new archive.

57

"""

58

response = self._method_archive(

59

'PUT', archive_id, {}, None)

60

response.read()

61

if response.status == httplib.BAD_REQUEST:

62

if response.reason == ArchiveIdExists.__doc__:

63

raise ArchiveIdExists

64

raise Exception('wtf')

65

elif response.status == httplib.CREATED:

66

return

67

else:

68

raise Exception('!!')

69

47

70

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

48

71

"""Put a message into an archive.

49

72

52

75

the message.

53

76

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

54

77

"""

78

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

55

79

response = self._method_archive(

56

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

57

data = response.read()

80

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

81

response.read()

58

82

if response.status == httplib.BAD_REQUEST:

83

if response.reason == ArchiveIdExists.__doc__:

84

raise ArchiveIdExists

59

85

raise Exception('wtf')

60

86

elif response.status == httplib.CREATED:

61

87

return

62

88

else:

63

89

raise Exception('!!')

64

90

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

91

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

92

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

93

include_hidden=False, max_body_length=None,

94

display_type='all'):

68

95

"""Retrieve specified messages.

69

96

70

97

:param archive_id: The archive to retrieve messages from.

71

98

:param message_ids: (optional) Retrieve only messages with these ids.

99

:param date_range: Retrieve the messages from or between a range of

100

dates. Example: 2012-01-01..2012-01-31 retrieve all the messages

101

between the 01 and 31 of January, including message from 01

102

and 31.

72

103

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

73

104

may, at its discretion, return fewer.

74

105

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

87

118

bodies.

88

119

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

89

120

flagged "hidden" in the results.

121

:param display_type: Adjust the message content to meet the needs of

122

the intended display. Valid values are:

123

all: (the default) include all message content.

124

text-only: include only plain/text parts; exclude all other parts.

125

headers-only: include only the message headers.

90

126

"""

91

127

parameters = {}

92

128

if message_ids is not None:

93

129

parameters['message_ids'] = message_ids

130

if date_range is not None:

131

parameters['date_range'] = date_range

94

132

if limit is not None:

95

133

parameters['limit'] = limit

96

134

if memo is not None:

101

139

parameters['headers'] = headers

102

140

if max_body_length is not None:

103

141

parameters['max_body_length'] = max_body_length

142

parameters['display_type'] = display_type

104

143

parameters['include_hidden'] = include_hidden

105

144

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

106

145

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

107

146

if response.status == httplib.BAD_REQUEST:

108

raise UnsupportedOrder

147

if response.reason == UnsupportedOrder.__doc__:

148

raise UnsupportedOrder

149

elif response.reason == UnsupportedDisplayType.__doc__:

150

raise UnsupportedDisplayType

151

elif response.reason == UnparsableDateRange.__doc__:

152

raise UnparsableDateRange

153

else:

154

raise ValueError('Bad request')

109

155

data = response.read()

110

156

return simplejson.loads(data)

111

157

158

def hide_message(self, archive_id, message_id, hidden):

159

parameters = {

160

'hidden': hidden,

161

}

162

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

163

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

164

response = self._method_archive('POST', path, query)

165

if response.status == httplib.BAD_REQUEST:

166

if response.reason == MessageIdNotFound.__doc__:

167

raise MessageIdNotFound

168

data = response.read()

169

return simplejson.loads(data)