← 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-10 15:36:31 UTC
  • Revision ID: aaron@canonical.com-20120110153631-vvqlfg122u08wsrt
Accept arbitrary permalink urls.

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 UnsupportedOrder(Exception):
11
 
    """Raised when an Unsupported order is requested."""
12
2
 
13
3
 
14
4
class GrackleClient:
15
 
    """Class for accessing Grackle web service."""
16
5
 
17
6
    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
 
        """
23
7
        self.host = host
24
8
        self.port = port
25
 
        self.netloc = '%s:%d' % (host, port)
26
 
 
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
 
        """
33
 
        path = '/archive/%s' % quote(archive_id)
34
 
        query_string = urlencode(query)
35
 
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
36
 
 
37
 
    def _get_connection(self):
38
 
        return httplib.HTTPConnection(self.host, self.port)
39
 
 
40
 
    def _method_archive(self, method, archive_id, query, body=None):
41
 
        """Perform an HTTP method on an archive's URL."""
42
 
        url = self.archive_url(archive_id, query)
43
 
        connection = self._get_connection()
44
 
        connection.request(method, url, body)
45
 
        return connection.getresponse()
46
 
 
47
 
    def put_message(self, archive_id, key, file_obj):
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(
56
 
            'POST', archive_id, {'key': key}, file_obj.read())
57
 
        response.read()
 
9
 
 
10
    def put_message(self, archive_name, permalink, file_obj):
 
11
        connection = httplib.HTTPConnection(self.host, self.port)
 
12
        connection.request('PUT', permalink, file_obj.read())
 
13
        response = connection.getresponse()
 
14
        data = response.read()
58
15
        if response.status == httplib.BAD_REQUEST:
59
16
            raise Exception('wtf')
60
17
        elif response.status == httplib.CREATED:
61
18
            return
62
19
        else:
63
20
            raise Exception('!!')
64
 
 
65
 
    def get_messages(self, archive_id, message_ids=None, limit=None,
66
 
                     memo=None, order=None, headers=None,
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
 
        """
91
 
        parameters = {}
92
 
        if message_ids is not None:
93
 
            parameters['message_ids'] = message_ids
94
 
        if limit is not None:
95
 
            parameters['limit'] = limit
96
 
        if memo is not None:
97
 
            parameters['memo'] = memo
98
 
        if order is not None:
99
 
            parameters['order'] = order
100
 
        if headers is not None:
101
 
            parameters['headers'] = headers
102
 
        if max_body_length is not None:
103
 
            parameters['max_body_length'] = max_body_length
104
 
        parameters['include_hidden'] = include_hidden
105
 
        query = {'parameters': simplejson.dumps(parameters)}
106
 
        response = self._method_archive('GET', archive_id, query)
107
 
        if response.status == httplib.BAD_REQUEST:
108
 
            raise UnsupportedOrder
109
 
        data = response.read()
110
 
        return simplejson.loads(data)