← 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-02-14 22:55:57 UTC
  • Revision ID: curtis.hovey@canonical.com-20120214225557-pi20aqjex7wtiwpl
Added test for extra data argument.

Show diffs side-by-side

added added

removed removed

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