~didrocks/unity/altf10

6 by Aaron Bentley
Use constants.
1
import httplib
11 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
44 by Curtis Hovey
Move errors to their own module.
9
from grackle.error import (
10
    UnparsableDateRange,
11
    UnsupportedDisplayType,
12
    UnsupportedOrder,
35.1.4 by Curtis Hovey
Added SUPPORTED_DISPLAY_TYPES.
13
    )
14
15
7 by Aaron Bentley
Fix URLs etc.
16
class GrackleClient:
34 by Aaron Bentley
Cleanup
17
    """Class for accessing Grackle web service."""
7 by Aaron Bentley
Fix URLs etc.
18
19
    def __init__(self, host, port):
34 by Aaron Bentley
Cleanup
20
        """Constructor.
21
22
        :param host: The name of the server.
23
        :param port: The port providing Grackle service.
24
        """
7 by Aaron Bentley
Fix URLs etc.
25
        self.host = host
26
        self.port = port
11 by Aaron Bentley
Start working on GET.
27
        self.netloc = '%s:%d' % (host, port)
28
18 by Aaron Bentley
archive_name -> archive_id
29
    def archive_url(self, archive_id, query):
34 by Aaron Bentley
Cleanup
30
        """Return the URL for an archive
31
32
        :param archive_id: The id of the archive to generate the URL for.
33
        :param query: The query to use in the URL, as a dict.
34
        """
26 by Aaron Bentley
Implement an archive namespace.
35
        path = '/archive/%s' % quote(archive_id)
15 by Aaron Bentley
Test filtering by message-id.
36
        query_string = urlencode(query)
37
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
11 by Aaron Bentley
Start working on GET.
38
39
    def _get_connection(self):
40
        return httplib.HTTPConnection(self.host, self.port)
41
34 by Aaron Bentley
Cleanup
42
    def _method_archive(self, method, archive_id, query, body=None):
43
        """Perform an HTTP method on an archive's URL."""
18 by Aaron Bentley
archive_name -> archive_id
44
        url = self.archive_url(archive_id, query)
11 by Aaron Bentley
Start working on GET.
45
        connection = self._get_connection()
34 by Aaron Bentley
Cleanup
46
        connection.request(method, url, body)
11 by Aaron Bentley
Start working on GET.
47
        return connection.getresponse()
48
18 by Aaron Bentley
archive_name -> archive_id
49
    def put_message(self, archive_id, key, file_obj):
34 by Aaron Bentley
Cleanup
50
        """Put a message into an archive.
51
52
        :param archive_id: The archive to put the message into.
53
        :param key: An arbitrary identifier that can later be used to retrieve
54
            the message.
55
        :param file_obj: The raw text of the message, as a file.
56
        """
57
        response = self._method_archive(
18 by Aaron Bentley
archive_name -> archive_id
58
            'POST', archive_id, {'key': key}, file_obj.read())
35.1.1 by Curtis Hovey
Hush lint.
59
        response.read()
7 by Aaron Bentley
Fix URLs etc.
60
        if response.status == httplib.BAD_REQUEST:
61
            raise Exception('wtf')
62
        elif response.status == httplib.CREATED:
63
            return
64
        else:
65
            raise Exception('!!')
11 by Aaron Bentley
Start working on GET.
66
38 by Curtis Hovey
Added basic handling of date_range.
67
    def get_messages(self, archive_id, message_ids=None, date_range=None,
68
                     limit=None, memo=None, order=None, headers=None,
69
                     include_hidden=False, max_body_length=None,
35.1.5 by Curtis Hovey
Moved the display_type arg.
70
                     display_type='all'):
34 by Aaron Bentley
Cleanup
71
        """Retrieve specified messages.
72
73
        :param archive_id: The archive to retrieve messages from.
74
        :param message_ids: (optional) Retrieve only messages with these ids.
38 by Curtis Hovey
Added basic handling of date_range.
75
        :param date_range: Retrieve the messages from or between a range of
76
            dates. Example: 2012-01-01..2012-01-31 retrieve all the messages
77
            between the 01 and 31 of January, including message from 01
78
            and 31.
34 by Aaron Bentley
Cleanup
79
        :param limit: The maximum number of messages to return.  The server
80
            may, at its discretion, return fewer.
81
        :param memo: (optional) Opaque identifier describing the position in
82
            the list of messages to return.  The combination of a memo and a
83
            limit describes a batch of results.  If not specified, the start
84
            is used.
85
        :param order: The order to return results in.  Supported orders are
86
            determined by the server.  See test_client.SUPPORTED_ORDERS for an
87
            example.
88
        :param headers: The headers to include in the message.  Only headers
89
            actually present in the message will be provided.  If unspecified,
90
            most headers will be included.
91
        :param max_body_length: The maximum length for a message's body.  When
92
            multiple messages are nested (as with a thread), this applies to
93
            each message's body, not the aggregate length of all messages'
94
            bodies.
95
        :param include_hidden: If true, include messages that have been
96
            flagged "hidden" in the results.
35.1.5 by Curtis Hovey
Moved the display_type arg.
97
        :param display_type: Adjust the message content to meet the needs of
98
            the intended display. Valid values are:
99
            all: (the default) include all message content.
100
            text-only: include only plain/text parts; exclude all other parts.
101
            headers-only: include only the message headers.
34 by Aaron Bentley
Cleanup
102
        """
11 by Aaron Bentley
Start working on GET.
103
        parameters = {}
104
        if message_ids is not None:
13 by Aaron Bentley
Retrieve messages.
105
            parameters['message_ids'] = message_ids
38 by Curtis Hovey
Added basic handling of date_range.
106
        if date_range is not None:
107
            parameters['date_range'] = date_range
19 by Aaron Bentley
Implement memo/limit support.
108
        if limit is not None:
109
            parameters['limit'] = limit
110
        if memo is not None:
111
            parameters['memo'] = memo
20 by Aaron Bentley
Support order by date
112
        if order is not None:
113
            parameters['order'] = order
27 by Aaron Bentley
get_messages supports header parameter.
114
        if headers is not None:
115
            parameters['headers'] = headers
35.1.5 by Curtis Hovey
Moved the display_type arg.
116
        if max_body_length is not None:
117
            parameters['max_body_length'] = max_body_length
118
        parameters['display_type'] = display_type
29 by Aaron Bentley
implement include_hidden.
119
        parameters['include_hidden'] = include_hidden
11 by Aaron Bentley
Start working on GET.
120
        query = {'parameters': simplejson.dumps(parameters)}
34 by Aaron Bentley
Cleanup
121
        response = self._method_archive('GET', archive_id, query)
21 by Aaron Bentley
Test unsupported orders.
122
        if response.status == httplib.BAD_REQUEST:
35.1.8 by Curtis Hovey
Use the exception __doc__ to ensure client and server can match exceptions.
123
            if response.reason == UnsupportedOrder.__doc__:
35.1.7 by Curtis Hovey
Moved the handling of unsupported display_type to server.
124
                raise UnsupportedOrder
35.1.8 by Curtis Hovey
Use the exception __doc__ to ensure client and server can match exceptions.
125
            elif response.reason == UnsupportedDisplayType.__doc__:
35.1.7 by Curtis Hovey
Moved the handling of unsupported display_type to server.
126
                raise UnsupportedDisplayType
39 by Curtis Hovey
Raise UnparsableDateRange when the date cannot be parsed.
127
            elif response.reason == UnparsableDateRange.__doc__:
128
                raise UnparsableDateRange
35.1.7 by Curtis Hovey
Moved the handling of unsupported display_type to server.
129
            else:
130
                raise ValueError('Bad request')
13 by Aaron Bentley
Retrieve messages.
131
        data = response.read()
132
        return simplejson.loads(data)