~didrocks/unity/altf10 : revision 57

6

urlencode,

7

)

8

9

10

class UnsupportedOrder(Exception):

11

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

9

from grackle.error import (

10

MessageIdNotFound,

11

UnparsableDateRange,

12

UnsupportedDisplayType,

13

UnsupportedOrder,

14

)

12

15

13

16

14

17

class GrackleClient:

24

27

self.port = port

25

28

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

26

29

27

def archive_url(self, archive_id, query):

30

def archive_url(self, path, query):

28

31

"""Return the URL for an archive

29

32

30

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

33

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

34

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

31

35

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

32

36

"""

33

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

37

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

34

38

query_string = urlencode(query)

35

39

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

36

40

37

41

def _get_connection(self):

38

42

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

39

43

40

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

44

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

41

45

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

42

url = self.archive_url(archive_id, query)

46

url = self.archive_url(path, query)

43

47

connection = self._get_connection()

44

48

connection.request(method, url, body)

45

49

return connection.getresponse()

46

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

'PUT', 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

47

67

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

48

68

"""Put a message into an archive.

49

69

52

72

the message.

53

73

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

54

74

"""

75

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

55

76

response = self._method_archive(

56

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

57

data = response.read()

77

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

78

response.read()

58

79

if response.status == httplib.BAD_REQUEST:

59

80

raise Exception('wtf')

60

81

elif response.status == httplib.CREATED:

62

83

else:

63

84

raise Exception('!!')

64

85

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

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

68

90

"""Retrieve specified messages.

69

91

70

92

:param archive_id: The archive to retrieve messages from.

71

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.

72

98

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

73

99

may, at its discretion, return fewer.

74

100

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

87

113

bodies.

88

114

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

89

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.

90

121

"""

91

122

parameters = {}

92

123

if message_ids is not None:

93

124

parameters['message_ids'] = message_ids

125

if date_range is not None:

126

parameters['date_range'] = date_range

94

127

if limit is not None:

95

128

parameters['limit'] = limit

96

129

if memo is not None:

101

134

parameters['headers'] = headers

102

135

if max_body_length is not None:

103

136

parameters['max_body_length'] = max_body_length

137

parameters['display_type'] = display_type

104

138

parameters['include_hidden'] = include_hidden

105

139

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

106

140

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

107

141

if response.status == httplib.BAD_REQUEST:

108

raise UnsupportedOrder

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

109

150

data = response.read()

110

151

return simplejson.loads(data)

111

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)