← Back to branch summary

~unity-2d-team/unity-2d/Shell-MultiMonitor

« back to all changes in this revision

Viewing changes to grackle/client.py

  • Committer: Curtis Hovey
  • Date: 2012-01-30 18:30:54 UTC
  • mto: (6.1.30 trunk)
  • mto: This revision was merged to the branch mainline in revision 45.
  • Revision ID: curtis.hovey@canonical.com-20120130183054-lyjgaxcekr8efuou
Hush lint.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
7
7
)
8
8
 
9
9
 
10
 
class UnparsableDateRange(Exception):
11
 
    """The date_range was not in the format of 2012-01-01..2012-01-31."""
12
 
 
13
 
 
14
 
class UnsupportedDisplayType(Exception):
15
 
    """Raised when an Unsupported display_type is requested."""
16
 
 
17
 
 
18
10
class UnsupportedOrder(Exception):
19
11
    """Raised when an Unsupported order is requested."""
20
12
 
21
13
 
22
 
class MessageIdNotFound(Exception):
23
 
    """No message matching the message_id was found in the archive."""
24
 
 
25
 
 
26
 
SUPPORTED_DISPLAY_TYPES = (
27
 
    'all',
28
 
    'text-only',
29
 
    'headers-only',
30
 
    )
31
 
 
32
 
 
33
14
class GrackleClient:
34
15
    """Class for accessing Grackle web service."""
35
16
 
81
62
        else:
82
63
            raise Exception('!!')
83
64
 
84
 
    def get_messages(self, archive_id, message_ids=None, date_range=None,
85
 
                     limit=None, memo=None, order=None, headers=None,
86
 
                     include_hidden=False, max_body_length=None,
87
 
                     display_type='all'):
 
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):
88
68
        """Retrieve specified messages.
89
69
 
90
70
        :param archive_id: The archive to retrieve messages from.
91
71
        :param message_ids: (optional) Retrieve only messages with these ids.
92
 
        :param date_range: Retrieve the messages from or between a range of
93
 
            dates. Example: 2012-01-01..2012-01-31 retrieve all the messages
94
 
            between the 01 and 31 of January, including message from 01
95
 
            and 31.
96
72
        :param limit: The maximum number of messages to return.  The server
97
73
            may, at its discretion, return fewer.
98
74
        :param memo: (optional) Opaque identifier describing the position in
111
87
            bodies.
112
88
        :param include_hidden: If true, include messages that have been
113
89
            flagged "hidden" in the results.
114
 
        :param display_type: Adjust the message content to meet the needs of
115
 
            the intended display. Valid values are:
116
 
            all: (the default) include all message content.
117
 
            text-only: include only plain/text parts; exclude all other parts.
118
 
            headers-only: include only the message headers.
119
90
        """
120
91
        parameters = {}
121
92
        if message_ids is not None:
122
93
            parameters['message_ids'] = message_ids
123
 
        if date_range is not None:
124
 
            parameters['date_range'] = date_range
125
94
        if limit is not None:
126
95
            parameters['limit'] = limit
127
96
        if memo is not None:
132
101
            parameters['headers'] = headers
133
102
        if max_body_length is not None:
134
103
            parameters['max_body_length'] = max_body_length
135
 
        parameters['display_type'] = display_type
136
104
        parameters['include_hidden'] = include_hidden
137
105
        query = {'parameters': simplejson.dumps(parameters)}
138
106
        response = self._method_archive('GET', archive_id, query)
139
107
        if response.status == httplib.BAD_REQUEST:
140
 
            if response.reason == UnsupportedOrder.__doc__:
141
 
                raise UnsupportedOrder
142
 
            elif response.reason == UnsupportedDisplayType.__doc__:
143
 
                raise UnsupportedDisplayType
144
 
            elif response.reason == UnparsableDateRange.__doc__:
145
 
                raise UnparsableDateRange
146
 
            else:
147
 
                raise ValueError('Bad request')
148
 
        data = response.read()
149
 
        return simplejson.loads(data)
150
 
 
151
 
    def hide_message(self, archive_id, message_id, hidden):
152
 
        parameters = {
153
 
            'message_id': message_id,
154
 
            'hidden': hidden,
155
 
            }
156
 
        query = {'parameters': simplejson.dumps(parameters)}
157
 
        response = self._method_archive('POST', archive_id, query)
158
 
        if response.status == httplib.BAD_REQUEST:
159
 
            if response.reason == MessageIdNotFound.__doc__:
160
 
                raise MessageIdNotFound
 
108
            raise UnsupportedOrder
161
109
        data = response.read()
162
110
        return simplejson.loads(data)