← Back to branch summary

~didrocks/unity/altf10

« back to all changes in this revision

Viewing changes to grackle/client.py

  • Committer: Aaron Bentley
  • Date: 2012-01-16 20:31:23 UTC
  • Revision ID: aaron@canonical.com-20120116203123-bxg29ktwtq19al75
Cleanup

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
8
8
 
9
9
 
10
10
class UnsupportedOrder(Exception):
11
 
    pass
 
11
    """Raised when an Unsupported order is requested."""
12
12
 
13
13
 
14
14
class GrackleClient:
 
15
    """Class for accessing Grackle web service."""
15
16
 
16
17
    def __init__(self, host, port):
 
18
        """Constructor.
 
19
 
 
20
        :param host: The name of the server.
 
21
        :param port: The port providing Grackle service.
 
22
        """
17
23
        self.host = host
18
24
        self.port = port
19
25
        self.netloc = '%s:%d' % (host, port)
20
26
 
21
27
    def archive_url(self, archive_id, query):
 
28
        """Return the URL for an archive
 
29
 
 
30
        :param archive_id: The id of the archive to generate the URL for.
 
31
        :param query: The query to use in the URL, as a dict.
 
32
        """
22
33
        path = '/archive/%s' % quote(archive_id)
23
34
        query_string = urlencode(query)
24
35
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
26
37
    def _get_connection(self):
27
38
        return httplib.HTTPConnection(self.host, self.port)
28
39
 
29
 
    def _verb_archive(self, verb, archive_id, query, body=None):
 
40
    def _method_archive(self, method, archive_id, query, body=None):
 
41
        """Perform an HTTP method on an archive's URL."""
30
42
        url = self.archive_url(archive_id, query)
31
43
        connection = self._get_connection()
32
 
        connection.request(verb, url, body)
 
44
        connection.request(method, url, body)
33
45
        return connection.getresponse()
34
46
 
35
47
    def put_message(self, archive_id, key, file_obj):
36
 
        response = self._verb_archive(
 
48
        """Put a message into an archive.
 
49
 
 
50
        :param archive_id: The archive to put the message into.
 
51
        :param key: An arbitrary identifier that can later be used to retrieve
 
52
            the message.
 
53
        :param file_obj: The raw text of the message, as a file.
 
54
        """
 
55
        response = self._method_archive(
37
56
            'POST', archive_id, {'key': key}, file_obj.read())
38
57
        data = response.read()
39
58
        if response.status == httplib.BAD_REQUEST:
46
65
    def get_messages(self, archive_id, message_ids=None, limit=None,
47
66
                     memo=None, order=None, headers=None,
48
67
                     max_body_length=None, include_hidden=False):
 
68
        """Retrieve specified messages.
 
69
 
 
70
        :param archive_id: The archive to retrieve messages from.
 
71
        :param message_ids: (optional) Retrieve only messages with these ids.
 
72
        :param limit: The maximum number of messages to return.  The server
 
73
            may, at its discretion, return fewer.
 
74
        :param memo: (optional) Opaque identifier describing the position in
 
75
            the list of messages to return.  The combination of a memo and a
 
76
            limit describes a batch of results.  If not specified, the start
 
77
            is used.
 
78
        :param order: The order to return results in.  Supported orders are
 
79
            determined by the server.  See test_client.SUPPORTED_ORDERS for an
 
80
            example.
 
81
        :param headers: The headers to include in the message.  Only headers
 
82
            actually present in the message will be provided.  If unspecified,
 
83
            most headers will be included.
 
84
        :param max_body_length: The maximum length for a message's body.  When
 
85
            multiple messages are nested (as with a thread), this applies to
 
86
            each message's body, not the aggregate length of all messages'
 
87
            bodies.
 
88
        :param include_hidden: If true, include messages that have been
 
89
            flagged "hidden" in the results.
 
90
        """
49
91
        parameters = {}
50
92
        if message_ids is not None:
51
93
            parameters['message_ids'] = message_ids
61
103
            parameters['max_body_length'] = max_body_length
62
104
        parameters['include_hidden'] = include_hidden
63
105
        query = {'parameters': simplejson.dumps(parameters)}
64
 
        response = self._verb_archive('GET', archive_id, query)
 
106
        response = self._method_archive('GET', archive_id, query)
65
107
        if response.status == httplib.BAD_REQUEST:
66
108
            raise UnsupportedOrder
67
109
        data = response.read()