← Back to branch summary

~didrocks/unity/altf10

« back to all changes in this revision

Viewing changes to grackle/client.py

  • Committer: Curtis Hovey
  • Date: 2012-03-17 21:21:37 UTC
  • Revision ID: curtis.hovey@canonical.com-20120317212137-r7zonl5ksenpa5ci
Save the scheme.

Show diffs side-by-side

added added

removed removed

Lines of Context:
grackle/client.py
6
6
    urlencode,
7
7
)
8
8
 
9
 
 
10
 
class UnparsableDateRange(Exception):
11
 
    """The date_range was not in the format of 2012-01-01..2012-01-31."""
12
 
 
13
 
 
14
 
class UnsupportedDisplayType(Exception):
15
 
    """Raised when an Unsupported display_type is requested."""
16
 
 
17
 
 
18
 
class UnsupportedOrder(Exception):
19
 
    """Raised when an Unsupported order is requested."""
20
 
 
21
 
 
22
 
SUPPORTED_DISPLAY_TYPES = (
23
 
    'all',
24
 
    'text-only',
25
 
    'headers-only',
 
9
from grackle.error import (
 
10
    ArchiveIdExists,
 
11
    MessageIdNotFound,
 
12
    UnparsableDateRange,
 
13
    UnsupportedDisplayType,
 
14
    UnsupportedOrder,
26
15
    )
27
16
 
28
17
 
39
28
        self.port = port
40
29
        self.netloc = '%s:%d' % (host, port)
41
30
 
42
 
    def archive_url(self, archive_id, query):
 
31
    def archive_url(self, path, query):
43
32
        """Return the URL for an archive
44
33
 
45
 
        :param archive_id: The id of the archive to generate the URL for.
 
34
        :param path: The path to generate the URL for.
 
35
            Maybe be '', 'archive_id', or 'archive_id/message_id'
46
36
        :param query: The query to use in the URL, as a dict.
47
37
        """
48
 
        path = '/archive/%s' % quote(archive_id)
 
38
        path = '/archive/%s' % quote(path)
49
39
        query_string = urlencode(query)
50
40
        return urlunparse(('http', self.netloc, path, '', query_string, ''))
51
41
 
52
42
    def _get_connection(self):
53
43
        return httplib.HTTPConnection(self.host, self.port)
54
44
 
55
 
    def _method_archive(self, method, archive_id, query, body=None):
 
45
    def _method_archive(self, method, path, query, body=None):
56
46
        """Perform an HTTP method on an archive's URL."""
57
 
        url = self.archive_url(archive_id, query)
 
47
        url = self.archive_url(path, query)
58
48
        connection = self._get_connection()
59
49
        connection.request(method, url, body)
60
50
        return connection.getresponse()
61
51
 
 
52
    def put_archive(self, archive_id, mbox=None):
 
53
        """Create an archive.
 
54
 
 
55
        :param archive_id: The archive id.
 
56
        :param mbox: An optional mbox with messages to add to the new archive.
 
57
        """
 
58
        response = self._method_archive(
 
59
            'PUT', archive_id, {}, None)
 
60
        response.read()
 
61
        if response.status == httplib.BAD_REQUEST:
 
62
            if response.reason == ArchiveIdExists.__doc__:
 
63
                raise ArchiveIdExists
 
64
            raise Exception('wtf')
 
65
        elif response.status == httplib.CREATED:
 
66
            return
 
67
        else:
 
68
            raise Exception('!!')
 
69
 
62
70
    def put_message(self, archive_id, key, file_obj):
63
71
        """Put a message into an archive.
64
72
 
67
75
            the message.
68
76
        :param file_obj: The raw text of the message, as a file.
69
77
        """
 
78
        path = '%s/%s' % (archive_id, key)
70
79
        response = self._method_archive(
71
 
            'POST', archive_id, {'key': key}, file_obj.read())
 
80
            'PUT', path, {}, file_obj.read())
72
81
        response.read()
73
82
        if response.status == httplib.BAD_REQUEST:
 
83
            if response.reason == ArchiveIdExists.__doc__:
 
84
                raise ArchiveIdExists
74
85
            raise Exception('wtf')
75
86
        elif response.status == httplib.CREATED:
76
87
            return
143
154
                raise ValueError('Bad request')
144
155
        data = response.read()
145
156
        return simplejson.loads(data)
 
157
 
 
158
    def hide_message(self, archive_id, message_id, hidden):
 
159
        parameters = {
 
160
            'hidden': hidden,
 
161
            }
 
162
        query = {'parameters': simplejson.dumps(parameters)}
 
163
        path = '%s/%s' % (archive_id, message_id)
 
164
        response = self._method_archive('POST', path, query)
 
165
        if response.status == httplib.BAD_REQUEST:
 
166
            if response.reason == MessageIdNotFound.__doc__:
 
167
                raise MessageIdNotFound
 
168
        data = response.read()
 
169
        return simplejson.loads(data)