Refactor python library to unify and rename as cdb_services

server/lib/python/cartodb_services/cartodb_services/here/__init__.py

@@ -0,0 +1 @@
+from geocoder import HereMapsGeocoder

server/lib/python/cartodb_services/cartodb_services/here/exceptions.py

@@ -0,0 +1,21 @@
+#!/usr/local/bin/python
+# -*- coding: utf-8 -*-
+import json
+
+
+class BadGeocodingParams(Exception):
+    def __init__(self, value):
+        self.value = value
+
+    def __str__(self):
+        return repr('Bad geocoding params: ' + json.dumps(self.value))
+
+
+class NoGeocodingParams(Exception):
+    def __str__(self):
+        return repr('No params for geocoding specified')
+
+
+class MalformedResult(Exception):
+    def __str__(self):
+            return repr('Result structure is malformed')

server/lib/python/cartodb_services/cartodb_services/here/geocoder.py

@@ -0,0 +1,98 @@
+#!/usr/local/bin/python
+# -*- coding: utf-8 -*-
+
+import json
+import requests
+
+from exceptions import *
+
+
+class HereMapsGeocoder:
+    'A Here Maps Geocoder wrapper for python'
+
+    PRODUCTION_GEOCODE_JSON_URL = 'https://geocoder.api.here.com/6.2/geocode.json'
+    STAGING_GEOCODE_JSON_URL = 'https://geocoder.cit.api.here.com/6.2/geocode.json'
+    DEFAULT_MAXRESULTS = 1
+    DEFAULT_GEN = 9
+
+    ADDRESS_PARAMS = [
+        'city',
+        'country',
+        'county',
+        'district',
+        'housenumber',
+        'postalcode',
+        'searchtext',
+        'state',
+        'street'
+        ]
+
+    ADMITTED_PARAMS = [
+        'additionaldata',
+        'app_id',
+        'app_code',
+        'bbox',
+        'countryfocus',
+        'gen',
+        'jsonattributes',
+        'jsoncallback',
+        'language',
+        'locationattributes',
+        'locationid',
+        'mapview',
+        'maxresults',
+        'pageinformation',
+        'politicalview',
+        'prox',
+        'strictlanguagemode'
+        ] + ADDRESS_PARAMS
+
+    def __init__(self, app_id, app_code, maxresults=DEFAULT_MAXRESULTS,
+                 gen=DEFAULT_GEN, host=PRODUCTION_GEOCODE_JSON_URL):
+        self.app_id = app_id
+        self.app_code = app_code
+        self.maxresults = maxresults
+        self.gen = gen
+        self.host = host
+
+    def geocode(self, **kwargs):
+        params = {}
+        for key, value in kwargs.iteritems():
+            if value:
+                params[key] = value
+        if not params:
+            raise NoGeocodingParams()
+        return self._execute_geocode(params)
+
+    def _execute_geocode(self, params):
+        if not set(params.keys()).issubset(set(self.ADDRESS_PARAMS)):
+            raise BadGeocodingParams(params)
+        try:
+            response = self._perform_request(params)
+            results = response['Response']['View'][0]['Result'][0]
+            return self._extract_lng_lat_from_result(results)
+        except IndexError:
+            return []
+        except KeyError:
+            raise MalformedResult()
+
+    def _perform_request(self, params):
+        request_params = {
+            'app_id': self.app_id,
+            'app_code': self.app_code,
+            'maxresults': self.maxresults,
+            'gen': self.gen
+        }
+        request_params.update(params)
+        response = requests.get(self.host, params=request_params)
+        if response.status_code == requests.codes.ok:
+            return json.loads(response.text)
+        else:
+            response.raise_for_status()
+
+    def _extract_lng_lat_from_result(self, result):
+        location = result['Location']
+        longitude = location['DisplayPosition']['Longitude']
+        latitude = location['DisplayPosition']['Latitude']
+
+        return [longitude, latitude]