Merge pull request #61 from pelias/address_alias

Address alias

package.json

@@ -37,6 +37,7 @@
     "geojson": "^0.2.0",
     "geojson-extent": "^0.3.1",
     "geopipes-elasticsearch-backend": "0.0.8",
+    "is-object": "^1.0.1",
     "pelias-esclient": "0.0.25",
     "toobusy": "^0.2.4"
   },

query/indeces.js

@@ -8,5 +8,6 @@ module.exports = [
   'admin0',
   'admin1',
   'admin2',
-  'neighborhood'
+  'neighborhood',
+  'openaddresses'
 ];

sanitiser/_layers.js

@@ -1,4 +1,6 @@
-var indeces = require('../query/indeces');
+
+var isObject = require('is-object'),
+    indeces = require('../query/indeces');
 
 // validate inputs, convert types and apply defaults
 function sanitize( req ){
@@ -7,50 +9,56 @@ function sanitize( req ){
   var params= req.query;
 
   // ensure the input params are a valid object
-  if( Object.prototype.toString.call( params ) !== '[object Object]' ){
+  if( !isObject( params ) ){
     params = {};
   }
 
-  // which layers to query
+  // default case (no layers specified in GET params)
-  if('string' === typeof params.layers && params.layers.length){
+  if('string' !== typeof params.layers || !params.layers.length){
-    
+    // @note: 'address' alias disabled by default until feature testing completed
-    var alias_layers  = ['poi', 'admin'];
+    params.layers = 'poi,admin'; // default layers
-    var alias_indeces = indeces.concat(alias_layers);
-
-    var layers = params.layers.split(',').map( function( layer ){
-      return layer.toLowerCase(); // lowercase inputs
-    });
-    for( var x=0; x<layers.length; x++ ){
-      if( -1 === alias_indeces.indexOf( layers[x] ) ){
-        return {
-          'error': true,
-          'message': 'invalid param \'layer\': must be one or more of ' + alias_indeces.join(',') 
-        };
-      }
-    }
-    var expand_aliases = function(alias, layers, layer_indeces) {
-      var alias_index  = layers.indexOf(alias);
-      if (alias_index !== -1 ) {
-        layers.splice(alias_index, 1);
-        layers = layers.concat(layer_indeces);
-      }
-      return layers;
-    };
-
-    layers = expand_aliases('poi',   layers, ['geoname','osmnode','osmway']);
-    layers = expand_aliases('admin', layers, ['admin0','admin1','admin2','neighborhood']);
-    
-    // de-dup
-    layers = layers.filter(function(item, pos) {
-      return layers.indexOf(item) === pos;
-    });
-
-    clean.layers = layers;
   }
-  else {
+
-    clean.layers = indeces; // default (all layers)
+  // decide which layers can be queried
+  var alias_layers  = ['poi', 'admin', 'address'];
+  var alias_indeces = indeces.concat(alias_layers);
+
+  // parse GET params
+  var layers = params.layers.split(',').map( function( layer ){
+    return layer.toLowerCase(); // lowercase inputs
+  });
+
+  // validate layer names
+  for( var x=0; x<layers.length; x++ ){
+    if( -1 === alias_indeces.indexOf( layers[x] ) ){
+      return {
+        'error': true,
+        'message': 'invalid param \'layer\': must be one or more of ' + alias_indeces.join(',')
+      };
+    }
   }
 
+  // expand aliases
+  var expand_aliases = function(alias, layers, layer_indeces) {
+    var alias_index  = layers.indexOf(alias);
+    if (alias_index !== -1 ) {
+      layers.splice(alias_index, 1);
+      layers = layers.concat(layer_indeces);
+    }
+    return layers;
+  };
+
+  layers = expand_aliases('poi',   layers, ['geoname','osmnode','osmway']);
+  layers = expand_aliases('admin', layers, ['admin0','admin1','admin2','neighborhood']);
+  layers = expand_aliases('address', layers, ['openaddresses']);
+
+  // de-dupe
+  layers = layers.filter(function(item, pos) {
+    return layers.indexOf(item) === pos;
+  });
+
+  // pass validated params to next middleware
+  clean.layers = layers;
   req.clean = clean;
   
   return { 'error': false };

test/unit/query/indeces.js

@@ -6,7 +6,7 @@ module.exports.tests = {};
 module.exports.tests.interface = function(test, common) {
   test('valid interface', function(t) {
     t.true(Array.isArray(indeces), 'valid array');
-    t.equal(indeces.length, 7, 'valid array');
+    t.equal(indeces.length, 8, 'valid array');
     t.end();
   });
 };

test/unit/sanitiser/suggest.js

@@ -160,8 +160,9 @@ module.exports.tests.sanitize_layers = function(test, common) {
   });
   test('invalid layer', function(t) {
     sanitize({ layers: 'test_layer', input: 'test', lat: 0, lon: 0 }, function( err, clean ){
-      var msg = 'invalid param \'layer\': must be one or more of geoname,osmnode,osmway,admin0,admin1,admin2,neighborhood,poi,admin';
+      var msg = 'invalid param \'layer\': must be one or more of ';
-      t.equal(err, msg, 'invalid layer requested');
+      t.true(err.match(msg), 'invalid layer requested');
+      t.true(err.length > msg.length, 'invalid error message');
       t.end();
     });
   });
@@ -179,6 +180,13 @@ module.exports.tests.sanitize_layers = function(test, common) {
       t.end();
     });
   });
+  test('address (alias) layer', function(t) {
+    var address_layers = ['openaddresses'];
+    sanitize({ layers: 'address', input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.deepEqual(clean.layers, address_layers, 'address layers set');
+      t.end();
+    });
+  });
   test('poi alias layer plus regular layers', function(t) {
     var poi_layers = ['geoname','osmnode','osmway'];
     var reg_layers = ['admin0', 'admin1'];
@@ -195,6 +203,14 @@ module.exports.tests.sanitize_layers = function(test, common) {
       t.end();
     });
   });
+  test('address alias layer plus regular layers', function(t) {
+    var address_layers = ['openaddresses'];
+    var reg_layers   = ['geoname', 'osmway'];
+    sanitize({ layers: 'address,geoname,osmway', input: 'test', lat: 0, lon: 0 }, function( err, clean ){
+      t.deepEqual(clean.layers, reg_layers.concat(address_layers), 'address + regular layers set');
+      t.end();
+    });
+  });
   test('alias layer plus regular layers (no duplicates)', function(t) {
     var poi_layers = ['geoname','osmnode','osmway'];
     sanitize({ layers: 'poi,geoname,osmnode', input: 'test', lat: 0, lon: 0 }, function( err, clean ){