← 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-03-16 19:37:09 UTC
  • Revision ID: curtis.hovey@canonical.com-20120316193709-oa33ido3h6hpo0bu
Factor-out message methods.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
6
6
    urlencode,
7
7
)
8
8
 
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',
 
9
from grackle.error import (
 
10
    MessageIdNotFound,
 
11
    UnparsableDateRange,
 
12
    UnsupportedDisplayType,
 
13
    UnsupportedOrder,
22
14
    )
23
15
 
24
16
 
55
47
        connection.request(method, url, body)
56
48
        return connection.getresponse()
57
49
 
 
50
    def put_archive(self, archive_id, mbox=None):
 
51
        """Create an archive.
 
52
 
 
53
        :param archive_id: The archive id.
 
54
        :param mbox: An optional mbox with messages to add to the new archive.
 
55
        """
 
56
        response = self._method_archive(
 
57
            'POST', '', {'archive_id': archive_id}, None)
 
58
        response.read()
 
59
        if response.status == httplib.BAD_REQUEST:
 
60
            raise Exception('wtf')
 
61
        elif response.status == httplib.CREATED:
 
62
            return
 
63
        else:
 
64
            raise Exception('!!')
 
65
 
58
66
    def put_message(self, archive_id, key, file_obj):
59
67
        """Put a message into an archive.
60
68
 
63
71
            the message.
64
72
        :param file_obj: The raw text of the message, as a file.
65
73
        """
 
74
        path = '%s/%s' % (archive_id, key)
66
75
        response = self._method_archive(
67
 
            'POST', archive_id, {'key': key}, file_obj.read())
 
76
            'POST', path, {}, file_obj.read())
68
77
        response.read()
69
78
        if response.status == httplib.BAD_REQUEST:
70
79
            raise Exception('wtf')
73
82
        else:
74
83
            raise Exception('!!')
75
84
 
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,
 
85
    def get_messages(self, archive_id, message_ids=None, date_range=None,
 
86
                     limit=None, memo=None, order=None, headers=None,
 
87
                     include_hidden=False, max_body_length=None,
79
88
                     display_type='all'):
80
89
        """Retrieve specified messages.
81
90
 
82
91
        :param archive_id: The archive to retrieve messages from.
83
92
        :param message_ids: (optional) Retrieve only messages with these ids.
 
93
        :param date_range: Retrieve the messages from or between a range of
 
94
            dates. Example: 2012-01-01..2012-01-31 retrieve all the messages
 
95
            between the 01 and 31 of January, including message from 01
 
96
            and 31.
84
97
        :param limit: The maximum number of messages to return.  The server
85
98
            may, at its discretion, return fewer.
86
99
        :param memo: (optional) Opaque identifier describing the position in
108
121
        parameters = {}
109
122
        if message_ids is not None:
110
123
            parameters['message_ids'] = message_ids
 
124
        if date_range is not None:
 
125
            parameters['date_range'] = date_range
111
126
        if limit is not None:
112
127
            parameters['limit'] = limit
113
128
        if memo is not None:
127
142
                raise UnsupportedOrder
128
143
            elif response.reason == UnsupportedDisplayType.__doc__:
129
144
                raise UnsupportedDisplayType
 
145
            elif response.reason == UnparsableDateRange.__doc__:
 
146
                raise UnparsableDateRange
130
147
            else:
131
148
                raise ValueError('Bad request')
132
149
        data = response.read()
133
150
        return simplejson.loads(data)
 
151
 
 
152
    def hide_message(self, archive_id, message_id, hidden):
 
153
        parameters = {
 
154
            'hidden': hidden,
 
155
            }
 
156
        query = {'parameters': simplejson.dumps(parameters)}
 
157
        path = '%s/%s' % (archive_id, message_id)
 
158
        response = self._method_archive('POST', path, query)
 
159
        if response.status == httplib.BAD_REQUEST:
 
160
            if response.reason == MessageIdNotFound.__doc__:
 
161
                raise MessageIdNotFound
 
162
        data = response.read()
 
163
        return simplejson.loads(data)