define the structure, example code for getting the Police.getCategories

use domain:port/api/ POST request

Author: Georgi Tenev

application/__init__.py

@@ -16,8 +16,8 @@
 import all blueprint modules
 """
 from views.home import home
-from api.external_api import external_api
-
+# from api.external_api import external_api
+from request_handler.handler import handler
 
 if os.getenv('FLASK_CONF') == 'DEV':
 	#development settings n
@@ -46,4 +46,5 @@ def inject_profiler():
 
 # Pull in URL dispatch routes
 app.register_blueprint(home)
-app.register_blueprint(external_api)
+# app.register_blueprint(external_api)
+app.register_blueprint(handler)

application/controller/__init__.py

@@ -0,0 +1 @@
+    

application/controller/controller.py

@@ -0,0 +1,25 @@
+import urllib2
+import json
+from google.appengine.api import users
+from google.appengine.runtime.apiproxy_errors import CapabilityDisabledError
+from flask import request, render_template, flash, url_for, redirect, Blueprint, json, jsonify
+from flask_cache import Cache
+from pprint import pprint
+
+from application.decorators import login_required, admin_required
+from application.forms import ExampleForm
+
+from application import app
+
+from servers import police
+
+def main():
+	#test response will be the response from
+	#the module taking care of a communication 
+	#with some external API
+	#we parse that response with the PARSER
+	#and return it to the request handler
+	test_response = police.getCategories()
+	temp = test_response.read()
+
+	return temp

application/controller/servers/__init__.py

@@ -0,0 +1,32 @@
+"""
+handles interaction with the food standartds agency api
+"""
+
+import urllib2
+import json
+
+from google.appengine.api import users
+from google.appengine.runtime.apiproxy_errors import CapabilityDisabledError
+
+from flask import request, render_template, flash, url_for, redirect, Blueprint
+
+from flask_cache import Cache
+
+
+
+from application.decorators import login_required, admin_required
+from application.forms import ExampleForm
+from application.models import ExampleModel
+
+from application import app
+
+# Flask-Cache (configured to use App Engine Memcache API)
+cache = Cache(app)
+
+def getData(name, location, format):
+	url = "http://ratings.food.gov.uk/search/" + name + "/" + location + "/" + format
+	data = urllib2.urlopen(url)
+	#remove the headers, and only get the relevant info
+	result = json.load(data)['FHRSEstablishment']['EstablishmentCollection']['EstablishmentDetail']
+
+	return result

application/controller/servers/foodstandartsagency.py

@@ -0,0 +1,50 @@
+"""
+handles interaction with the worldbank api
+
+"""
+import urllib2
+import json
+
+from google.appengine.api import users
+from google.appengine.runtime.apiproxy_errors import CapabilityDisabledError
+
+from flask import request, render_template, flash, url_for, redirect, Blueprint
+
+from flask_cache import Cache
+
+
+
+from application.decorators import login_required, admin_required
+from application.forms import ExampleForm
+from application.models import ExampleModel
+
+from application import app
+
+# Flask-Cache (configured to use App Engine Memcache API)
+cache = Cache(app)
+
+'''
+ API Key for geocoding can be found here:
+	https://console.developers.google.com/project/cobalt-mantis-732/apiui/credential
+
+Example link (need to edit api key): 
+	https://maps.googleapis.com/maps/api/geocode/json?address=122+Flinders+St,+Darlinghurst,+NSW,+Australia&sensor=false&key={key}
+
+'''
+
+API_KEY = "AIzaSyAXZycyWt-ZGGooaAycfCyfZuV1W5uKBGg"
+
+components = "components=country:UK"
+def getData(address):
+	url = "https://maps.googleapis.com/maps/api/geocode/json?address="+address+"&"+components+"&"+"sensor=false"+"&"+"key="+API_KEY
+	request = urllib2.urlopen(url)	
+	result = json.load(request)
+	
+	return result
+
+
+
+
+
+
+

application/controller/servers/geocoding.py

@@ -0,0 +1,77 @@
+
+import urllib2
+import json
+
+from google.appengine.api import users
+from google.appengine.runtime.apiproxy_errors import CapabilityDisabledError
+
+from flask import request, render_template, flash, url_for, redirect, Blueprint, json, jsonify
+
+from flask_cache import Cache
+
+
+
+from application.decorators import login_required, admin_required
+from application.forms import ExampleForm
+from application.models import ExampleModel
+
+from application import app
+
+url = 'http://data.police.uk/api/'
+
+def getData():
+    global url
+    #json object
+    data = urllib2.urlopen(url)
+    
+    #for testing purposes
+    #print json.load(data)
+    
+    url = 'http://data.police.uk/api/'
+    return data
+
+def getCategories():
+    global url
+    url += 'crime-categories?date=2011-08'
+    return getData()
+
+#Neighbourhoods must be lower case and the white spaces replaced with '-'
+def getNeighbourhoodsData(county):
+    global url
+    url += county + '/neighbourhoods'
+    return getData()
+
+def getBoundaryData(county, nhood):
+    global url
+    url += county + '/' + getNeighbourhoodID(county, nhood) + '/boundary'
+    return getData()
+
+def getNeighbourhoodID(county, nhood):
+    global url
+    url+= county + '/neighbourhoods'
+    data = json.load(urllib2.urlopen(url))
+    
+    for j in xrange(0, len(data)):
+        if data[j]["name"] == nhood:
+            return data[j]["id"]
+#date must be in the format yyyy-mm
+def getCrimesData(category, lat, lng, date):
+    global url
+    url+='crimes-street/' + category + '?lat=' + str(lat) + '&lng=' + str(lng) + '&date=' + date
+    return getData()
+
+def getCrimesInAreaData(category, latArr, lngArr, date):
+    global url
+    url+='crimes-street/' + category + '?poly='
+    for j in xrange(0, len(latArr)):
+        url+=str(latArr[j]) + ',' + str(lngArr[j]) + ':'
+    url = url[:-1]
+    url+='&date=' + date
+    return getData()
+
+
+#getCategories()
+#getNeighbourhoods('hampshire')
+#getBoundary('hampshire', 'Fair Oak')
+#getCrimes('all-crimes', 52.629729, -1.131592, '2014-09')
+#getCrimesInArea('all-crimes', [52.268, 52.794, 52.130], [0.543, 0.238, 0.478], '2014-09')

application/controller/servers/police.py

@@ -0,0 +1,31 @@
+"""
+handles interaction with the worldbank api
+
+"""
+import urllib2
+import json
+
+from google.appengine.api import users
+from google.appengine.runtime.apiproxy_errors import CapabilityDisabledError
+
+from flask import request, render_template, flash, url_for, redirect, Blueprint
+
+from flask_cache import Cache
+
+
+
+from application.decorators import login_required, admin_required
+from application.forms import ExampleForm
+from application.models import ExampleModel
+
+from application import app
+
+# Flask-Cache (configured to use App Engine Memcache API)
+cache = Cache(app)
+
+def getData(dataType, date, format):
+	url = "http://api.worldbank.org/countries/gbr/indicators/" + dataType + "?" + date + "&" + format
+	request = urllib2.urlopen(url)	
+	result = json.load(request)[1][0]
+	
+	return result

application/controller/servers/worldbank.py

@@ -0,0 +1,39 @@
+"""
+external_api.py
+
+"""
+import urllib2
+import json
+from google.appengine.api import users
+from google.appengine.runtime.apiproxy_errors import CapabilityDisabledError
+from flask import request, render_template, flash, url_for, redirect, Blueprint, json, jsonify
+from flask_cache import Cache
+
+from application.decorators import login_required, admin_required
+from application.forms import ExampleForm
+
+from application import app
+
+from application.controller import controller
+
+
+# Flask-Cache (configured to use App Engine Memcache API)
+cache = Cache(app)
+ 
+handler = Blueprint('handler', __name__)
+
+'''
+ideally, the request_handler accepts POST requests, extract the data in the POST requst,
+calls the controller method which returns the JSON object which the client expect,
+and then finally, send the result(the json) back to the client
+'''
+@handler.route('/app/', methods=['POST'])
+def handleReq():
+	#extract the data sent from the client
+	#the POST request's body should contain a key-value pair and the name of the key is 'data'
+	input_data = request.form['data']
+	result = controller.main()
+ 	return result
+
+
+