-
Notifications
You must be signed in to change notification settings - Fork 28
/
prowlpy.py
296 lines (248 loc) · 11 KB
/
prowlpy.py
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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Copyright (c) 2009, Jaccob Burch
# Copyright (c) 2010, Olivier Hervieu
# Copyright (c) 2011, Ken Pepple
#
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
#
# * Neither the name of the University of California, Berkeley nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
"""
Prowlpy V0.50 originally written by Jacob Burch, modified by Olivier Hervieu.
Updated to Prowl API version 1.2 by Ken Pepple.
Python Prowlpy is a python module that implement the public api of Prowl to
send push notification to iPhones.
See http://prowlapp.com for information about Prowl.
The prowlpy module respect the API of prowl. So prowlpy provides a Prowl class
which implements four methods :
- post, to push a notification to an iPhone,
- verify_key, to verify an API key.
- retrieve_token, to get a registration token for use in retrieve/apikey and
the associated URL for the user to approve the request.
- retrieve_apikey, to get an API key from a registration token retrieved in
retrieve/token.
"""
__author__ = 'Jacob Burch'
__author_email__ = 'jacoburch@gmail.com'
__maintainer__ = 'Olivier Hervieu'
__maintainer_email__ = 'olivier.hervieu@gmail.com'
__version__ = 0.51
from httplib import HTTPSConnection as Https
from urllib import urlencode
from xml.dom import minidom
API_DOMAIN = 'api.prowlapp.com'
class Prowl(object):
def __init__(self, apikey, providerkey=None):
"""
Initialize a Prowl instance.
"""
self.apikey = apikey
# Set User-Agent
self.headers = {'User-Agent': "Prowlpy/%s" % str(__version__),
'Content-type': "application/x-www-form-urlencoded"}
# Aliasing
self.add = self.post
def _relay_error(self, error_code, reason=""):
"""
Errors from http://www.prowlapp.com/api.php:
- 400 Bad request, the parameters you provided did not validate,
see ERRORMESSAGE,
- 401 Not authorized, the API key given is not valid, and does not
correspond to a user,
- 406 Not acceptable, your IP address has exceeded the API limit,
- 409 Not approved, the user has yet to approve your retrieve request,
- 500 Internal server error, something failed to execute properly on
the Prowl side.
"""
if error_code == 400:
raise Exception(
"Bad Request. The parameters you provided did not validate")
elif error_code == 401:
raise Exception(
"%s Probably invalid API key %s" % (reason, self.apikey))
elif error_code == 406:
raise Exception(
"Not acceptable, your IP address has exceeded the API limit")
elif error_code == 409:
raise Exception(
"Not approved, the user has yet to approve your retrieve request")
elif error_code == 500:
raise Exception(
"Internal server error")
def post(self, application=None, event=None,
description=None, priority=0, providerkey=None,
url=None):
"""
Post a notification..
You must provide either event or description or both.
The parameters are :
- application ; The name of your application or the application
generating the event.
- providerkey (optional) : your provider API key.
Only necessary if you have been whitelisted.
- priority (optional) : default value of 0 if not provided.
An integer value ranging [-2, 2] representing:
-2. Very Low
-1. Moderate
0. Normal
1. High
2. Emergency (note : emergency priority messages may bypass
quiet hours according to the user's settings)
- event : the name of the event or subject of the notification.
- description : a description of the event, generally terse.
- url (optional) : The URL which should be attached to the
notification.
"""
# Create the http object
h = Https(API_DOMAIN)
# Perform the request and get the response headers and content
data = {'apikey': self.apikey,
'application': application,
'event': event,
'description': description,
'priority': priority}
if providerkey is not None:
data['providerkey'] = providerkey
if url is not None:
data['url'] = url[0:512] # API limits to 512 characters
h.request("POST",
"/publicapi/add",
headers=self.headers,
body=urlencode(data))
response = h.getresponse()
request_status = response.status
if request_status == 200:
return True
else:
self._relay_error(request_status, response.reason)
def verify_key(self, providerkey=None):
"""
Verify if the API key is valid.
The parameters are :
- providerkey (optional) : your provider API key.
Only necessary if you have been whitelisted.
"""
h = Https(API_DOMAIN)
data = {'apikey': self.apikey}
if providerkey is not None:
data['providerkey'] = providerkey
h.request("GET",
"/publicapi/verify?" + urlencode(data),
headers=self.headers)
request_status = h.getresponse().status
if request_status != 200:
self._relay_error(request_status)
def retrieve_token(self, providerkey=None):
"""
Get a registration token for use in retrieve/apikey
and the associated URL for the user to approve the request.
The parameters are :
- providerkey (required) : your provider API key.
This returns a dictionary such as:
{'code': u'0',
'remaining': u'999',
'resetdate': u'1299535575',
'token': u'60fd568423e3cd337b45172be91cabe46b94c200',
'url': u'https://www.prowlapp.com/retrieve.php?token=60fd5684'}
"""
h = Https(API_DOMAIN)
data = {'apikey': self.apikey}
if providerkey is not None:
data['providerkey'] = providerkey
h.request("GET",
"/publicapi/retrieve/token?" + urlencode(data),
headers=self.headers)
request = h.getresponse()
request_status = request.status
if request_status == 200:
dom = minidom.parseString(request.read())
code = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('success')[0].\
getAttribute('code')
remaining = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('success')[0].\
getAttribute('remaining')
resetdate = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('success')[0].\
getAttribute('resetdate')
token = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('retrieve')[0].\
getAttribute('token')
url = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('retrieve')[0].\
getAttribute('url')
return dict(token=token, url=url, code=code,
remaining=remaining, resetdate=resetdate)
else:
self._relay_error(request_status)
def retrieve_apikey(self, providerkey=None, token=None):
"""
Get an API key from a registration token retrieved in retrieve/token.
The user must have approved your request first, or you will get an
error response.
The parameters are :
- providerkey (required) : your provider API key.
- token (required): the token returned from retrieve_token.
This returns a dictionary such as:
{'apikey': u'16b776682332cf11102b67d6db215821f2c233a3',
'code': u'200',
'remaining': u'999',
'resetdate': u'1299535575'}
"""
h = Https(API_DOMAIN)
data = {'apikey': self.apikey}
if providerkey is not None:
data['providerkey'] = providerkey
else:
raise Exception("Provider Key is required for retrieving API key")
if token is not None:
data['token'] = token
else:
raise Exception("Token is required for retrieving API key.\
Call retrieve_token to request it.")
h.request("GET",
"/publicapi/retrieve/apikey?" + urlencode(data),
headers=self.headers)
request = h.getresponse()
request_status = request.status
if request_status == 200:
dom = minidom.parseString(request.read())
code = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('success')[0].\
getAttribute('code')
remaining = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('success')[0].\
getAttribute('remaining')
resetdate = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('success')[0].\
getAttribute('resetdate')
users_api_key = dom.getElementsByTagName('prowl')[0].\
getElementsByTagName('retrieve')[0].\
getAttribute('apikey')
return dict(apikey=users_api_key, code=code, remaining=remaining,
resetdate=resetdate)
else:
self._relay_error(request_status)