forked from andrewxhill/gfw-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api.py
333 lines (293 loc) · 12 KB
/
api.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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
# Global Forest Watch API
# Copyright (C) 2013 World Resource Institute
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
"""This module contains request handlers for the Global Forest Watch API."""
import base64
import hashlib
import json
import random
import re
import os
import copy
import webapp2
import monitor
import logging
import traceback
from gfw import common
from gfw import countries
from gfw import stories
from gfw import pubsub
from gfw import wdpa
from appengine_config import runtime_config
from hashlib import md5
from google.appengine.api import mail
from google.appengine.api import taskqueue
from google.appengine.ext import ndb
class Entry(ndb.Model):
value = ndb.TextProperty()
# Countries API route
COUNTRY_ROUTE = r'/countries'
# WPDA site API route
WDPA = r'/wdpa/sites'
# Stories API routes
LIST_STORIES = r'/stories'
CREATE_STORY = r'/stories/new'
CREATE_STORY_EMAILS = r'/stories/email'
GET_STORY = r'/stories/<id:\d+>'
class SubHandler(webapp2.RequestHandler):
def get(self):
subs = []
for s in pubsub.Subscription.with_topic('updates/forma'):
subs.append('%s,%s' % (s.email, json.dumps(s.params)))
self.response.headers.add_header('charset', 'utf-8')
self.response.headers['Content-Type'] = 'text/csv'
self.response.out.write('\n'.join(subs))
class BaseApi(webapp2.RequestHandler):
"""Base request handler for API."""
def _send_response(self, data, error=None):
"""Sends supplied result dictionnary as JSON response."""
self.response.headers.add_header("Access-Control-Allow-Origin", "*")
self.response.headers.add_header(
'Access-Control-Allow-Headers',
'Origin, X-Requested-With, Content-Type, Accept')
self.response.headers.add_header('charset', 'utf-8')
self.response.headers["Content-Type"] = "application/json"
if error:
self.response.set_status(400)
if not data:
self.response.out.write('')
else:
self.response.out.write(data)
if error:
taskqueue.add(url='/log/error', params=error, queue_name="log")
def _get_id(self, params):
whitespace = re.compile(r'\s+')
params = re.sub(whitespace, '', json.dumps(params, sort_keys=True))
return '/'.join([self.request.path.lower(), md5(params).hexdigest()])
def _get_params(self, body=False):
if body:
params = json.loads(self.request.body)
else:
args = self.request.arguments()
vals = map(self.request.get, args)
params = dict(zip(args, vals))
return params
def options(self):
"""Options to support CORS requests."""
self.response.headers['Access-Control-Allow-Origin'] = '*'
self.response.headers['Access-Control-Allow-Headers'] = \
'Origin, X-Requested-With, Content-Type, Accept'
self.response.headers['Access-Control-Allow-Methods'] = 'POST, GET'
class StoriesApi(BaseApi):
def _send_new_story_emails(self):
story = self._get_params()
# Email WRI:
subject = 'A new story has been registered with Global Forest Watch'
sender = \
'Global Forest Watch Stories <noreply@gfw-apis.appspotmail.com>'
to = runtime_config.get('wri_emails_stories')
story_url = 'http://globalforestwatch.org/stories/%s' % story['id']
api_url = '%s/stories/%s' % (common.APP_BASE_URL, story['id'])
token = story['token']
body = 'Story URL: %s\nStory API: %s\nStory token: %s' % \
(story_url, api_url, token)
mail.send_mail(sender=sender, to=to, subject=subject, body=body)
# Email user:
subject = 'Your story has been registered with Global Forest Watch!'
to = '%s <%s>' % (story['name'], story['email'])
body = 'Here is your story: %s' % story_url
mail.send_mail(sender=sender, to=to, subject=subject, body=body)
def _gen_token(self):
return base64.b64encode(
hashlib.sha256(str(random.getrandbits(256))).digest(),
random.choice(
['rA', 'aZ', 'gQ', 'hH', 'hG', 'aR', 'DD'])).rstrip('==')
def list(self):
try:
params = self._get_params()
result = stories.list(params)
if not result:
result = []
self._send_response(json.dumps(result))
except Exception, e:
name = e.__class__.__name__
msg = 'Error: Story API (%s)' % name
monitor.log(self.request.url, msg, error=e,
headers=self.request.headers)
def create(self):
# host = os.environ['HTTP_HOST']
# logging.info(os.environ)
# if 'globalforestwatch' not in host and 'localhost' not in host:
# self.error(404)
# return
params = self._get_params(body=True)
required = ['title', 'email', 'geom']
if not all(x in params and params.get(x) for x in required):
self.response.set_status(400)
self._send_response(json.dumps(dict(required=required)))
return
token = self._gen_token()
try:
params['token'] = token
result = stories.create(params)
if result:
story = json.loads(result.content)['rows'][0]
story['media'] = json.loads(story['media'])
data = copy.copy(story)
data['token'] = token
self.response.set_status(201)
taskqueue.add(url='/stories/email', params=data,
queue_name="story-new-emails")
self._send_response(json.dumps(story))
else:
story = None
self.response.set_status(400)
return
except Exception, e:
error = e
name = error.__class__.__name__
trace = traceback.format_exc()
payload = self.request.headers
payload.update(params)
msg = 'Story submit failure: %s: %s' % (name, error)
monitor.log(self.request.url, msg, error=trace,
headers=payload)
self.error(400)
def get(self, id):
try:
params = dict(id=id)
result = stories.get(params)
if not result:
self.response.set_status(404)
self._send_response(json.dumps(result))
except Exception, e:
name = e.__class__.__name__
msg = 'Error: Story API (%s)' % name
monitor.log(self.request.url, msg, error=e,
headers=self.request.headers)
class WdpaApi(BaseApi):
def site(self):
try:
params = self._get_params()
rid = self._get_id(params)
entry = Entry.get_by_id(rid)
if not entry or params.get('bust') or runtime_config.get('IS_DEV'):
site = wdpa.get_site(params)
if site:
entry = Entry(id=rid, value=json.dumps(site))
entry.put()
self._send_response(entry.value if entry else None)
except Exception, e:
name = e.__class__.__name__
msg = 'Error: WPDA API (%s)' % name
monitor.log(self.request.url, msg, error=e,
headers=self.request.headers)
class CountryApi(BaseApi):
"""Handler for countries."""
def get(self):
try:
params = self._get_params()
rid = self._get_id(params)
if 'interval' not in params:
params['interval'] = '12 MONTHS'
entry = Entry.get_by_id(rid)
if not entry or params.get('bust') or runtime_config.get('IS_DEV'):
result = countries.get(params)
if result:
entry = Entry(id=rid, value=json.dumps(result))
entry.put()
self._send_response(entry.value if entry else None)
except Exception, error:
name = error.__class__.__name__
trace = traceback.format_exc()
msg = 'Publish failure: %s: %s' % \
(name, error)
monitor.log(self.request.url, msg, error=trace,
headers=self.request.headers)
class PubSubApi(BaseApi):
def subscribe(self):
try:
params = self._get_params(body=True)
pubsub.subscribe(params)
self.response.set_status(201)
self._send_response(json.dumps(dict(subscribe=True)))
except Exception, e:
name = e.__class__.__name__
msg = 'Error: PubSub API (%s)' % name
monitor.log(self.request.url, msg, error=e,
headers=self.request.headers)
def unsubscribe(self):
try:
params = self._get_params(body=True)
pubsub.unsubscribe(params)
self._send_response(json.dumps(dict(unsubscribe=True)))
except Exception, e:
name = e.__class__.__name__
msg = 'Error: PubSub API (%s)' % name
monitor.log(self.request.url, msg, error=e,
headers=self.request.headers)
def publish(self):
params = self._get_params(body=True)
try:
pubsub.publish(params)
self._send_response(json.dumps(dict(publish=True)))
except Exception, error:
name = error.__class__.__name__
trace = traceback.format_exc()
msg = 'Publish failure: %s: %s' % \
(name, error)
monitor.log(self.request.url, msg, error=trace,
headers=self.request.headers)
self._send_error()
routes = [
webapp2.Route(COUNTRY_ROUTE, handler=CountryApi,
handler_method='get'),
webapp2.Route(CREATE_STORY, handler=StoriesApi,
handler_method='create', methods=['POST']),
webapp2.Route(LIST_STORIES, handler=StoriesApi,
handler_method='list'),
webapp2.Route(GET_STORY, handler=StoriesApi,
handler_method='get'),
webapp2.Route(r'/subout', handler=SubHandler,
handler_method='get'),
webapp2.Route(WDPA, handler=WdpaApi,
handler_method='site'),
webapp2.Route(CREATE_STORY_EMAILS, handler=StoriesApi,
handler_method='_send_new_story_emails',
methods=['POST']),
webapp2.Route(r'/pubsub/publish', handler=pubsub.Publisher,
handler_method='post',
methods=['POST']),
webapp2.Route(r'/pubsub/confirm', handler=pubsub.Confirmer,
handler_method='get',
methods=['GET']),
webapp2.Route(r'/pubsub/notify', handler=pubsub.Notify,
handler_method='post',
methods=['POST']),
webapp2.Route(r'/pubsub/dump', handler=pubsub.SubscriptionDump,
handler_method='get',
methods=['GET']),
webapp2.Route(r'/subscribe', handler=PubSubApi,
handler_method='subscribe',
methods=['POST']),
webapp2.Route(r'/unsubscribe', handler=PubSubApi,
handler_method='unsubscribe',
methods=['POST']),
webapp2.Route(r'/publish', handler=PubSubApi,
handler_method='publish',
methods=['POST'])
]
handlers = webapp2.WSGIApplication(routes, debug=common.IS_DEV)