← Back to branch summary

~didrocks/unity/altf10

« back to all changes in this revision

Viewing changes to grackle/client.py

  • Committer: Curtis Hovey
  • Date: 2012-01-31 00:00:49 UTC
  • mto: This revision was merged to the branch mainline in revision 37.
  • Revision ID: curtis.hovey@canonical.com-20120131000049-5hv0eb60q5qwt55z
Added support for display_type == 'all'.
This has a hack because many of the tests are not working with a real message.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
6
6
    urlencode,
7
7
)
8
8
 
9
 
from grackle.error import (
10
 
    ArchiveIdExists,
11
 
    MessageIdNotFound,
12
 
    UnparsableDateRange,
13
 
    UnsupportedDisplayType,
14
 
    UnsupportedOrder,
 
9
 
 
10
class UnsupportedDisplayType(Exception):
 
11
    """Raised when an Unsupported display_type is requested."""
 
12
 
 
13
 
 
14
class UnsupportedOrder(Exception):
 
15
    """Raised when an Unsupported order is requested."""
 
16
 
 
17
 
 
18
SUPPORTED_DISPLAY_TYPES = (
 
19
    'all',
 
20
    'text-only',
 
21
    'headers-only',
15
22
    )
16
23
 
17
24
 
28
35
        self.port = port
29
36
        self.netloc = '%s:%d' % (host, port)
30
37
 
31
 
    def archive_url(self, path, query):
 
38
    def archive_url(self, archive_id, query):
32
39
        """Return the URL for an archive
33
40
 
34
 
        :param path: The path to generate the URL for.
35
 
            Maybe be '', 'archive_id', or 'archive_id/message_id'
 
41
        :param archive_id: The id of the archive to generate the URL for.
36
42
        :param query: The query to use in the URL, as a dict.
37
43
        """
38
 
        path = '/archive/%s' % quote(path)
 
44
        path = '/archive/%s' % quote(archive_id)
39
45
        query_string = urlencode(query)
40
46
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
41
47
 
42
48
    def _get_connection(self):
43
49
        return httplib.HTTPConnection(self.host, self.port)
44
50
 
45
 
    def _method_archive(self, method, path, query, body=None):
 
51
    def _method_archive(self, method, archive_id, query, body=None):
46
52
        """Perform an HTTP method on an archive's URL."""
47
 
        url = self.archive_url(path, query)
 
53
        url = self.archive_url(archive_id, query)
48
54
        connection = self._get_connection()
49
55
        connection.request(method, url, body)
50
56
        return connection.getresponse()
51
57
 
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
 
 
70
58
    def put_message(self, archive_id, key, file_obj):
71
59
        """Put a message into an archive.
72
60
 
75
63
            the message.
76
64
        :param file_obj: The raw text of the message, as a file.
77
65
        """
78
 
        path = '%s/%s' % (archive_id, key)
79
66
        response = self._method_archive(
80
 
            'PUT', path, {}, file_obj.read())
 
67
            'POST', archive_id, {'key': key}, file_obj.read())
81
68
        response.read()
82
69
        if response.status == httplib.BAD_REQUEST:
83
 
            if response.reason == ArchiveIdExists.__doc__:
84
 
                raise ArchiveIdExists
85
70
            raise Exception('wtf')
86
71
        elif response.status == httplib.CREATED:
87
72
            return
88
73
        else:
89
74
            raise Exception('!!')
90
75
 
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,
 
76
    def get_messages(self, archive_id, message_ids=None, limit=None,
 
77
                     memo=None, order=None, headers=None,
 
78
                     max_body_length=None, include_hidden=False,
94
79
                     display_type='all'):
95
80
        """Retrieve specified messages.
96
81
 
97
82
        :param archive_id: The archive to retrieve messages from.
98
83
        :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.
103
84
        :param limit: The maximum number of messages to return.  The server
104
85
            may, at its discretion, return fewer.
105
86
        :param memo: (optional) Opaque identifier describing the position in
127
108
        parameters = {}
128
109
        if message_ids is not None:
129
110
            parameters['message_ids'] = message_ids
130
 
        if date_range is not None:
131
 
            parameters['date_range'] = date_range
132
111
        if limit is not None:
133
112
            parameters['limit'] = limit
134
113
        if memo is not None:
148
127
                raise UnsupportedOrder
149
128
            elif response.reason == UnsupportedDisplayType.__doc__:
150
129
                raise UnsupportedDisplayType
151
 
            elif response.reason == UnparsableDateRange.__doc__:
152
 
                raise UnparsableDateRange
153
130
            else:
154
131
                raise ValueError('Bad request')
155
132
        data = response.read()
156
133
        return simplejson.loads(data)
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)