← 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: William Grant
  • Date: 2012-01-22 11:15:15 UTC
  • Revision ID: william.grant@canonical.com-20120122111515-87kkj7g8upjbhcmg
Include message-id in the result.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
1
1
import httplib
2
 
import simplejson
3
 
from urlparse import urlunparse
4
 
from urllib import (
5
 
    quote,
6
 
    urlencode,
7
 
)
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',
22
 
    )
23
 
 
24
 
 
25
 
class GrackleClient:
26
 
    """Class for accessing Grackle web service."""
27
 
 
28
 
    def __init__(self, host, port):
29
 
        """Constructor.
30
 
 
31
 
        :param host: The name of the server.
32
 
        :param port: The port providing Grackle service.
33
 
        """
34
 
        self.host = host
35
 
        self.port = port
36
 
        self.netloc = '%s:%d' % (host, port)
37
 
 
38
 
    def archive_url(self, archive_id, query):
39
 
        """Return the URL for an archive
40
 
 
41
 
        :param archive_id: The id of the archive to generate the URL for.
42
 
        :param query: The query to use in the URL, as a dict.
43
 
        """
44
 
        path = '/archive/%s' % quote(archive_id)
45
 
        query_string = urlencode(query)
46
 
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
47
 
 
48
 
    def _get_connection(self):
49
 
        return httplib.HTTPConnection(self.host, self.port)
50
 
 
51
 
    def _method_archive(self, method, archive_id, query, body=None):
52
 
        """Perform an HTTP method on an archive's URL."""
53
 
        url = self.archive_url(archive_id, query)
54
 
        connection = self._get_connection()
55
 
        connection.request(method, url, body)
56
 
        return connection.getresponse()
57
 
 
58
 
    def put_message(self, archive_id, key, file_obj):
59
 
        """Put a message into an archive.
60
 
 
61
 
        :param archive_id: The archive to put the message into.
62
 
        :param key: An arbitrary identifier that can later be used to retrieve
63
 
            the message.
64
 
        :param file_obj: The raw text of the message, as a file.
65
 
        """
66
 
        response = self._method_archive(
67
 
            'POST', archive_id, {'key': key}, file_obj.read())
68
 
        response.read()
69
 
        if response.status == httplib.BAD_REQUEST:
70
 
            raise Exception('wtf')
71
 
        elif response.status == httplib.CREATED:
72
 
            return
73
 
        else:
74
 
            raise Exception('!!')
75
 
 
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,
79
 
                     display_type='all'):
80
 
        """Retrieve specified messages.
81
 
 
82
 
        :param archive_id: The archive to retrieve messages from.
83
 
        :param message_ids: (optional) Retrieve only messages with these ids.
84
 
        :param limit: The maximum number of messages to return.  The server
85
 
            may, at its discretion, return fewer.
86
 
        :param memo: (optional) Opaque identifier describing the position in
87
 
            the list of messages to return.  The combination of a memo and a
88
 
            limit describes a batch of results.  If not specified, the start
89
 
            is used.
90
 
        :param order: The order to return results in.  Supported orders are
91
 
            determined by the server.  See test_client.SUPPORTED_ORDERS for an
92
 
            example.
93
 
        :param headers: The headers to include in the message.  Only headers
94
 
            actually present in the message will be provided.  If unspecified,
95
 
            most headers will be included.
96
 
        :param max_body_length: The maximum length for a message's body.  When
97
 
            multiple messages are nested (as with a thread), this applies to
98
 
            each message's body, not the aggregate length of all messages'
99
 
            bodies.
100
 
        :param include_hidden: If true, include messages that have been
101
 
            flagged "hidden" in the results.
102
 
        :param display_type: Adjust the message content to meet the needs of
103
 
            the intended display. Valid values are:
104
 
            all: (the default) include all message content.
105
 
            text-only: include only plain/text parts; exclude all other parts.
106
 
            headers-only: include only the message headers.
107
 
        """
108
 
        parameters = {}
109
 
        if message_ids is not None:
110
 
            parameters['message_ids'] = message_ids
111
 
        if limit is not None:
112
 
            parameters['limit'] = limit
113
 
        if memo is not None:
114
 
            parameters['memo'] = memo
115
 
        if order is not None:
116
 
            parameters['order'] = order
117
 
        if headers is not None:
118
 
            parameters['headers'] = headers
119
 
        if max_body_length is not None:
120
 
            parameters['max_body_length'] = max_body_length
121
 
        parameters['display_type'] = display_type
122
 
        parameters['include_hidden'] = include_hidden
123
 
        query = {'parameters': simplejson.dumps(parameters)}
124
 
        response = self._method_archive('GET', archive_id, query)
125
 
        if response.status == httplib.BAD_REQUEST:
126
 
            if response.reason == UnsupportedOrder.__doc__:
127
 
                raise UnsupportedOrder
128
 
            elif response.reason == UnsupportedDisplayType.__doc__:
129
 
                raise UnsupportedDisplayType
130
 
            else:
131
 
                raise ValueError('Bad request')
132
 
        data = response.read()
133
 
        return simplejson.loads(data)
 
2
 
 
3
def put_message(archive_name, file_obj):
 
4
    connection = httplib.HTTPConnection('localhost', 8435)
 
5
    connection.request('POST', '/archive/%s' % archive_name, file_obj.read())
 
6
    response = connection.getresponse()
 
7
    data = response.read()
 
8
    if response.status == httplib.BAD_REQUEST:
 
9
        raise Exception('wtf')
 
10
    elif response.status == httplib.CREATED:
 
11
        return
 
12
    else:
 
13
        raise Exception('!!')