Mapzen geocoder integrated

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

@@ -1 +1,2 @@
 from routing import MapzenRouting, MapzenRoutingResponse
+from geocoder import MapzenGeocoder

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

@@ -0,0 +1,53 @@
+import requests
+import json
+import re
+
+from exceptions import WrongParams, MalformedResult
+from qps import qps_retry
+from cartodb_services.tools import Coordinate, PolyLine
+
+
+class MapzenGeocoder:
+    'A Mapzen Geocoder wrapper for python'
+
+    BASE_URL = 'https://search.mapzen.com/v1/search'
+
+    def __init__(self, app_key, base_url=BASE_URL):
+        self._app_key = app_key
+        self._url = base_url
+
+    @qps_retry
+    def geocode(self, searchtext, country=None):
+        request_params = self._build_requests_parameters(searchtext, country)
+        response = requests.get(self._url, params=request_params)
+        if response.status_code == requests.codes.ok:
+            return self.__parse_response(response.text)
+        elif response.status_code == requests.codes.bad_request:
+            return []
+        else:
+            response.raise_for_status()
+
+    def _build_requests_parameters(self, searchtext, country=None):
+        request_params = {}
+        request_params['text'] = searchtext
+        request_params['layers'] = 'address'
+        request_params['api_key'] = self._app_key
+        if country:
+            request_params['boundary.country'] = country
+        return request_params
+
+    def __parse_response(self, response):
+        try:
+            parsed_json_response = json.loads(response)
+            feature = parsed_json_response['features'][0]
+            return self._extract_lng_lat_from_result(feature)
+        except IndexError:
+            return []
+        except KeyError:
+            raise MalformedResult()
+
+    def _extract_lng_lat_from_result(self, result):
+        location = result['geometry']['coordinates']
+        longitude = location[0]
+        latitude = location[1]
+        return [longitude, latitude]

server/lib/python/cartodb_services/cartodb_services/metrics/config.py

@@ -168,15 +168,17 @@ class GeocoderConfig(ServiceConfig):
     GEOCODER_CONFIG_KEYS = ['google_maps_client_id', 'google_maps_api_key',
                             'geocoding_quota', 'soft_geocoding_limit',
                             'geocoder_type', 'period_end_date',
-                            'heremaps_app_id', 'heremaps_app_code', 'username',
-                            'orgname']
-    NOKIA_GEOCODER_MANDATORY_KEYS = ['geocoding_quota', 'soft_geocoding_limit']
+                            'heremaps_app_id', 'heremaps_app_code',
+                            'mapzen_geocoder_app_key', 'username', 'orgname']
+    NOKIA_GEOCODER_REDIS_MANDATORY_KEYS = ['geocoding_quota', 'soft_geocoding_limit']
     NOKIA_GEOCODER = 'heremaps'
     NOKIA_GEOCODER_APP_ID_KEY = 'heremaps_app_id'
     NOKIA_GEOCODER_APP_CODE_KEY = 'heremaps_app_code'
     GOOGLE_GEOCODER = 'google'
     GOOGLE_GEOCODER_API_KEY = 'google_maps_api_key'
     GOOGLE_GEOCODER_CLIENT_ID = 'google_maps_client_id'
+    MAPZEN_GEOCODER = 'mapzen'
+    MAPZEN_GEOCODER_API_KEY = 'mapzen_geocoder_app_key'
     GEOCODER_TYPE = 'geocoder_type'
     QUOTA_KEY = 'geocoding_quota'
     SOFT_LIMIT_KEY = 'soft_geocoding_limit'
@@ -217,11 +219,15 @@ class GeocoderConfig(ServiceConfig):
 
     def __check_config(self, filtered_config):
         if filtered_config[self.GEOCODER_TYPE].lower() == self.NOKIA_GEOCODER:
-            if not set(self.NOKIA_GEOCODER_MANDATORY_KEYS).issubset(set(filtered_config.keys())):
+            if not set(self.NOKIA_GEOCODER_REDIS_MANDATORY_KEYS).issubset(set(filtered_config.keys())) or \
+            not self.heremaps_app_id or not self.heremaps_app_code:
                 raise ConfigException("""Some mandatory parameter/s for Nokia geocoder are missing. Check it please""")
         elif filtered_config[self.GEOCODER_TYPE].lower() == self.GOOGLE_GEOCODER:
             if self.GOOGLE_GEOCODER_API_KEY not in filtered_config.keys():
                 raise ConfigException("""Google geocoder need the mandatory parameter 'google_maps_private_key'""")
+        elif filtered_config[self.GEOCODER_TYPE].lower() == self.MAPZEN_GEOCODER:
+            if not self.mapzen_app_key:
+                raise ConfigException("""Mapzen config is not setted up""")
 
         return True
 
@@ -242,11 +248,16 @@ class GeocoderConfig(ServiceConfig):
             self._google_maps_api_key = filtered_config[self.GOOGLE_GEOCODER_API_KEY]
             self._google_maps_client_id = filtered_config[self.GOOGLE_GEOCODER_CLIENT_ID]
             self._cost_per_hit = 0
+        elif filtered_config[self.GEOCODER_TYPE].lower() == self.MAPZEN_GEOCODER:
+            self._mapzen_app_key = db_config.mapzen_geocoder_app_key
+            self._cost_per_hit = 0
 
     @property
     def service_type(self):
         if self._geocoder_type == self.GOOGLE_GEOCODER:
             return 'geocoder_google'
+        elif self._geocoder_type == self.MAPZEN_GEOCODER:
+            return 'geocoder_mapzen'
         else:
             return 'geocoder_here'
 
@@ -258,6 +269,10 @@ class GeocoderConfig(ServiceConfig):
     def google_geocoder(self):
         return self._geocoder_type == self.GOOGLE_GEOCODER
 
+    @property
+    def mapzen_geocoder(self):
+        return self._geocoder_type == self.MAPZEN_GEOCODER
+
     @property
     def google_client_id(self):
         return self._google_maps_client_id
@@ -289,6 +304,10 @@ class GeocoderConfig(ServiceConfig):
     def heremaps_app_code(self):
         return self._heremaps_app_code
 
+    @property
+    def mapzen_app_key(self):
+        return self._mapzen_app_key
+
     @property
     def is_high_resolution(self):
         return True
@@ -331,6 +350,7 @@ class ServicesDBConfig:
         else:
             mapzen_conf = json.loads(mapzen_conf_json)
             self._mapzen_routing_app_key = mapzen_conf['routing_app_key']
+            self._mapzen_geocoder_app_key = mapzen_conf['geocoder_app_key']
 
     def _get_logger_config(self):
         logger_conf_json = self._get_conf('logger_conf')
@@ -364,6 +384,10 @@ class ServicesDBConfig:
     def mapzen_routing_app_key(self):
         return self._mapzen_routing_app_key
 
+    @property
+    def mapzen_geocoder_app_key(self):
+        return self._mapzen_geocoder_app_key
+
     @property
     def geocoder_log_path(self):
         return self._geocoder_log_path