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

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