Add middleware for renaming placename properties to match WOF

app.js

@@ -68,6 +68,7 @@ app.get( '/reverse', routers.reverse );
 /** -------------------- post-processing-middleware ------------------**/
 
 // TODO: name mapping for admin values (admin0 => country, etc)
+app.use(require('./middleware/renamePlacenames')());
 app.use(require('./middleware/geocodeJSON')());
 app.use(require('./middleware/sendJSON'));
 

helper/geojsonify.js

@@ -14,7 +14,13 @@ var DETAILS_PROPS = [
   'locality',
   'neighborhood',
   'category',
-  'address'
+  'address',
+  'country_a',
+  'country',
+  'region',
+  'region_a',
+  'county',
+  'neighbourhood'
 ];
 
 

middleware/renamePlacenames.js

@@ -0,0 +1,57 @@
+/**
+ - P is a preferred English name
+ - Q is a preferred name (in other languages)
+ - V is a well-known (but unofficial) variant for the place
+ (e.g. "New York City" for New York)
+ - S is either a synonym or a colloquial name for the place
+ (e.g. "Big Apple" for New York), or a version of the name which
+ is stripped of accent characters.
+ - A is an abbreviation or code for the place (e.g. "NYC" for New
+ York)
+ */
+// config mapping of old names to new ones
+var NAME_MAP = {
+  'alpha3': 'country_a',
+  'admin0': 'country',
+  'admin1': 'region',
+  'admin1_abbr': 'region_a',
+  'admin2': 'county',
+  // TODO: what does "local_admin" map to in WOF???
+  'neighborhood': 'neighbourhood'
+};
+
+function setup() {
+
+  return mapPlacenames;
+}
+
+function mapPlacenames(req, res, next) {
+
+  // do nothing if no result data set
+  if (!req.results.data) {
+    return next();
+  }
+
+  // loop through data items and remap placenames
+  req.results.data = req.results.data.map(renameProperties);
+
+  next();
+}
+
+function renameProperties(place) {
+  var newPlace = {};
+  Object.keys(place).forEach(function (property) {
+    renameProperty(place, newPlace, property);
+  });
+  return newPlace;
+}
+
+function renameProperty(oldObj, newObj, property) {
+  if (!oldObj.hasOwnProperty(property)) {
+    return;
+  }
+
+  newObj[ (NAME_MAP[property] || property) ] = oldObj[property];
+}
+
+module.exports = setup;