summaryrefslogtreecommitdiffstats
path: root/padlite.py
blob: 767f848de7599ecf1cc585bbf73aa3c2be3dfcf8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
import httplib
import urllib
import json

class APIException(Exception):
    def __init__(self, response):
        self.code = response['code']
        self.message = response['message']

    def __str__(self):
        return "Code %s: %s" % (self.code, self.message)

class PadLite:

    def __init__(self, apikey, host, port=None, ssl=False):
        self.apikey = apikey
        self.host = host
        self.port = port
        self.ssl = ssl

        if self.port is None:
            if self.ssl:
                self.port = 443
            else:
                self.port = 80

    def _getConnection(self):
        if self.ssl:
            return httplib.HTTPSConnection(self.host, self.port)
        return httplib.HTTPConnection(self.host, self.port)

    def _apiCall(self, url, **kwargs):
        conn = self._getConnection()

        args = dict((k,v) for k,v in kwargs.iteritems() if v is not None)
        args['apikey'] = self.apikey
        conn.request('GET', '%s?%s' % (url, urllib.urlencode(args)))

        resp = conn.getresponse()
        if resp.status != 200:
            return None
        response = json.load(resp)

        if response['code'] != 0:
            raise APIException(response)

        return response['data']

    #
    # API Version 1
    #
    def createGroup(self):
        return self._apiCall('/api/1/createGroup')['groupID']

    def createGroupIfNotExistsFor(self, groupMapper):
        return self._apiCall('/api/1/createGroupIfNotExistsFor', groupMapper=groupMapper)['groupID']

    def deleteGroup(self, groupID):
        return self._apiCall('/api/1/deleteGroup', groupID=groupID)

    def listPads(self, groupID):
        return self._apiCall('/api/1/listPads', groupID=groupID)

    def createPad(self, padID, text):
        return self._apiCall('/api/1/createPad', padID=padID, text=text)

    def createGroupPad(self, groupID, padName, text):
        return self._apiCall('/api/1/createGroupPad', groupID=groupID, padName=padName, text=text)

    def createAuthor(self, name):
        return self._apiCall('/api/1/createAuthor', name=name)

    def createAuthorIfNotExistsFor(self, authorMapper, name):
        return self._apiCall('/api/1/createAuthorIfNotExistsFor', authorMapper=authorMapper, name=name)

    def listPadsOfAuthor(self, authorID):
        return self._apiCall('/api/1/listPadsOfAuthor', authorID=authorID)

    def createSession(self, groupID, authorID, validUntil):
        return self._apiCall('/api/1/createSession', groupID=groupID, authorID=authorID, validUntil=validUntil)

    def deleteSession(self, sessionID):
        return self._apiCall('/api/1/deleteSession', sessionID=sessionID)

    def getSessionInfo(self, sessionID):
        return self._apiCall('/api/1/getSessionInfo', sessionID=sessionID)

    def listSessionsOfGroup(self, groupID):
        return self._apiCall('/api/1/listSessionsOfGroup', groupID=groupID)

    def listSessionsOfAuthor(self, authorID):
        return self._apiCall('/api/1/listSessionsOfAuthor', authorID=authorID)

    def getText(self, padID, rev):
        return self._apiCall('/api/1/getText', padID=padID, rev=rev)

    def setText(self, padID, text):
        return self._apiCall('/api/1/setText', padID=padID, text=text)

    def getHTML(self, padID, rev):
        return self._apiCall('/api/1/getHTML', padID=padID, rev=rev)

    def setHTML(self, padID, html):
        return self._apiCall('/api/1/setHTML', padID=padID, html=html)

    def getRevisionsCount(self, padID):
        return self._apiCall('/api/1/getRevisionsCount', padID=padID)

    def getLastEdited(self, padID):
        return self._apiCall('/api/1/getLastEdited', padID=padID)

    def deletePad(self, padID):
        return self._apiCall('/api/1/deletePad', padID=padID)

    def getReadOnlyID(self, padID):
        return self._apiCall('/api/1/getReadOnlyID', padID=padID)

    def setPublicStatus(self, padID, publicStatus):
        return self._apiCall('/api/1/setPublicStatus', padID=padID, publicStatus=publicStatus)

    def getPublicStatus(self, padID):
        return self._apiCall('/api/1/getPublicStatus', padID=padID)

    def setPassword(self, padID, password):
        return self._apiCall('/api/1/setPassword', padID=padID, password=password)

    def isPasswordProtected(self, padID):
        return self._apiCall('/api/1/isPasswordProtected', padID=padID)

    def listAuthorsOfPad(self, padID):
        return self._apiCall('/api/1/listAuthorsOfPad', padID=padID)

    def padUsersCount(self, padID):
        return self._apiCall('/api/1/padUsersCount', padID=padID)


    #
    # API Version 1.1
    #
    def getAuthorName(self, authorID):
        return self._apiCall('/api/1.1/getAuthorName', authorID=authorID)

    def padUsers(self, padID):
        return self._apiCall('/api/1.1/padUsers', padID=padID)

    def sendClientsMessage(self, padID, msg):
        return self._apiCall('/api/1.1/sendClientsMessage', padID=padID, msg=msg)

    def listAllGroups(self):
        return self._apiCall('/api/1.1/listAllGroups')['groupIDs']


    #
    # API Version 1.2
    #
    def checkToken(self):
        return self._apiCall('/api/1.2/checkToken')


    #
    # API Version 1.2.1
    #
    def listAllPads(self):
        return self._apiCall('/api/1.2.1/listAllPads')['padIDs']


    #
    # API Version 1.2.7
    #
    def getChatHistory(self, padID, start=None, end=None):
        return self._apiCall('/api/1.2.7/getChatHistory', padID=padID, start=start, end=end)

    def getChatHead(self, padID):
        return self._apiCall('/api/1.2.7/getChatHead', padID=padID)


    #
    # API Version 1.2.8
    #
    def getRevisionsCount(self, padID):
        return self._apiCall('/api/1.2.8/getRevisionsCount', padID=padID)

    def getRevisionChangeset(self, padID, rev):
        return self._apiCall('/api/1.2.8/getRevisionChangeset', padID=padID, rev=rev)