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

6 by Aaron Bentley
Use constants.
1
import httplib
6.1.5 by Aaron Bentley
Start working on GET.
2
import simplejson
3
from urlparse import urlunparse
4
from urllib import (
5
    quote,
6
    urlencode,
7
)
8
6.1.38 by Curtis Hovey
Move errors to their own module.
9
from grackle.error import (
6.1.46 by Curtis Hovey
Added support for hide_message.
10
    MessageIdNotFound,
6.1.38 by Curtis Hovey
Move errors to their own module.
11
    UnparsableDateRange,
12
    UnsupportedDisplayType,
13
    UnsupportedOrder,
6.2.4 by Curtis Hovey
Added SUPPORTED_DISPLAY_TYPES.
14
    )
15
16
6.1.1 by Aaron Bentley
Fix URLs etc.
17
class GrackleClient:
6.1.28 by Aaron Bentley
Cleanup
18
    """Class for accessing Grackle web service."""
6.1.1 by Aaron Bentley
Fix URLs etc.
19
20
    def __init__(self, host, port):
6.1.28 by Aaron Bentley
Cleanup
21
        """Constructor.
22
23
        :param host: The name of the server.
24
        :param port: The port providing Grackle service.
25
        """
6.1.1 by Aaron Bentley
Fix URLs etc.
26
        self.host = host
27
        self.port = port
6.1.5 by Aaron Bentley
Start working on GET.
28
        self.netloc = '%s:%d' % (host, port)
29
6.1.48 by Curtis Hovey
Rename args to be honest about what is expected.
30
    def archive_url(self, path, query):
6.1.28 by Aaron Bentley
Cleanup
31
        """Return the URL for an archive
32
6.1.49 by Curtis Hovey
updated docstring.
33
        :param path: The path to generate the URL for.
34
            Maybe be '', 'archive_id', or 'archive_id/message_id'
6.1.28 by Aaron Bentley
Cleanup
35
        :param query: The query to use in the URL, as a dict.
36
        """
6.1.48 by Curtis Hovey
Rename args to be honest about what is expected.
37
        path = '/archive/%s' % quote(path)
6.1.9 by Aaron Bentley
Test filtering by message-id.
38
        query_string = urlencode(query)
39
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
6.1.5 by Aaron Bentley
Start working on GET.
40
41
    def _get_connection(self):
42
        return httplib.HTTPConnection(self.host, self.port)
43
6.1.48 by Curtis Hovey
Rename args to be honest about what is expected.
44
    def _method_archive(self, method, path, query, body=None):
6.1.28 by Aaron Bentley
Cleanup
45
        """Perform an HTTP method on an archive's URL."""
6.1.48 by Curtis Hovey
Rename args to be honest about what is expected.
46
        url = self.archive_url(path, query)
6.1.5 by Aaron Bentley
Start working on GET.
47
        connection = self._get_connection()
6.1.28 by Aaron Bentley
Cleanup
48
        connection.request(method, url, body)
6.1.5 by Aaron Bentley
Start working on GET.
49
        return connection.getresponse()
50
6.1.40 by Curtis Hovey
Implemented a partial put into the MemoryStore.
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(
6.1.51 by Curtis Hovey
Added a rudimentary put_archive.
58
            'PUT', archive_id, {}, None)
6.1.40 by Curtis Hovey
Implemented a partial put into the MemoryStore.
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
6.1.12 by Aaron Bentley
archive_name -> archive_id
67
    def put_message(self, archive_id, key, file_obj):
6.1.28 by Aaron Bentley
Cleanup
68
        """Put a message into an archive.
69
70
        :param archive_id: The archive to put the message into.
71
        :param key: An arbitrary identifier that can later be used to retrieve
72
            the message.
73
        :param file_obj: The raw text of the message, as a file.
74
        """
6.1.40 by Curtis Hovey
Implemented a partial put into the MemoryStore.
75
        path = '%s/%s' % (archive_id, key)
6.1.28 by Aaron Bentley
Cleanup
76
        response = self._method_archive(
6.1.50 by Curtis Hovey
Use PUT for creating messages.
77
            'PUT', path, {}, file_obj.read())
6.2.1 by Curtis Hovey
Hush lint.
78
        response.read()
6.1.1 by Aaron Bentley
Fix URLs etc.
79
        if response.status == httplib.BAD_REQUEST:
80
            raise Exception('wtf')
81
        elif response.status == httplib.CREATED:
82
            return
83
        else:
84
            raise Exception('!!')
6.1.5 by Aaron Bentley
Start working on GET.
85
6.1.32 by Curtis Hovey
Added basic handling of date_range.
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,
6.2.5 by Curtis Hovey
Moved the display_type arg.
89
                     display_type='all'):
6.1.28 by Aaron Bentley
Cleanup
90
        """Retrieve specified messages.
91
92
        :param archive_id: The archive to retrieve messages from.
93
        :param message_ids: (optional) Retrieve only messages with these ids.
6.1.32 by Curtis Hovey
Added basic handling of date_range.
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.
6.1.28 by Aaron Bentley
Cleanup
98
        :param limit: The maximum number of messages to return.  The server
99
            may, at its discretion, return fewer.
100
        :param memo: (optional) Opaque identifier describing the position in
101
            the list of messages to return.  The combination of a memo and a
102
            limit describes a batch of results.  If not specified, the start
103
            is used.
104
        :param order: The order to return results in.  Supported orders are
105
            determined by the server.  See test_client.SUPPORTED_ORDERS for an
106
            example.
107
        :param headers: The headers to include in the message.  Only headers
108
            actually present in the message will be provided.  If unspecified,
109
            most headers will be included.
110
        :param max_body_length: The maximum length for a message's body.  When
111
            multiple messages are nested (as with a thread), this applies to
112
            each message's body, not the aggregate length of all messages'
113
            bodies.
114
        :param include_hidden: If true, include messages that have been
115
            flagged "hidden" in the results.
6.2.5 by Curtis Hovey
Moved the display_type arg.
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.
6.1.28 by Aaron Bentley
Cleanup
121
        """
6.1.5 by Aaron Bentley
Start working on GET.
122
        parameters = {}
123
        if message_ids is not None:
6.1.7 by Aaron Bentley
Retrieve messages.
124
            parameters['message_ids'] = message_ids
6.1.32 by Curtis Hovey
Added basic handling of date_range.
125
        if date_range is not None:
126
            parameters['date_range'] = date_range
6.1.13 by Aaron Bentley
Implement memo/limit support.
127
        if limit is not None:
128
            parameters['limit'] = limit
129
        if memo is not None:
130
            parameters['memo'] = memo
6.1.14 by Aaron Bentley
Support order by date
131
        if order is not None:
132
            parameters['order'] = order
6.1.21 by Aaron Bentley
get_messages supports header parameter.
133
        if headers is not None:
134
            parameters['headers'] = headers
6.2.5 by Curtis Hovey
Moved the display_type arg.
135
        if max_body_length is not None:
136
            parameters['max_body_length'] = max_body_length
137
        parameters['display_type'] = display_type
6.1.23 by Aaron Bentley
implement include_hidden.
138
        parameters['include_hidden'] = include_hidden
6.1.5 by Aaron Bentley
Start working on GET.
139
        query = {'parameters': simplejson.dumps(parameters)}
6.1.28 by Aaron Bentley
Cleanup
140
        response = self._method_archive('GET', archive_id, query)
6.1.15 by Aaron Bentley
Test unsupported orders.
141
        if response.status == httplib.BAD_REQUEST:
6.2.8 by Curtis Hovey
Use the exception __doc__ to ensure client and server can match exceptions.
142
            if response.reason == UnsupportedOrder.__doc__:
6.2.7 by Curtis Hovey
Moved the handling of unsupported display_type to server.
143
                raise UnsupportedOrder
6.2.8 by Curtis Hovey
Use the exception __doc__ to ensure client and server can match exceptions.
144
            elif response.reason == UnsupportedDisplayType.__doc__:
6.2.7 by Curtis Hovey
Moved the handling of unsupported display_type to server.
145
                raise UnsupportedDisplayType
6.1.33 by Curtis Hovey
Raise UnparsableDateRange when the date cannot be parsed.
146
            elif response.reason == UnparsableDateRange.__doc__:
147
                raise UnparsableDateRange
6.2.7 by Curtis Hovey
Moved the handling of unsupported display_type to server.
148
            else:
149
                raise ValueError('Bad request')
6.1.7 by Aaron Bentley
Retrieve messages.
150
        data = response.read()
151
        return simplejson.loads(data)
6.1.46 by Curtis Hovey
Added support for hide_message.
152
153
    def hide_message(self, archive_id, message_id, hidden):
154
        parameters = {
155
            'hidden': hidden,
156
            }
157
        query = {'parameters': simplejson.dumps(parameters)}
6.1.47 by Curtis Hovey
Factor-out message methods.
158
        path = '%s/%s' % (archive_id, message_id)
159
        response = self._method_archive('POST', path, query)
6.1.46 by Curtis Hovey
Added support for hide_message.
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)