pelias
/
api
mirror of https://github.com/pelias/api.git
1
0
Fork 0
Code Issues Releases Activity
Browse Source

Merge branch 'search_and_reverse_lat_lon'

pull/242/head
Julian Simioni 9 years ago
parent
155337eb3f 96c58e8658
commit
aea10ea95f
11 changed files with 154 additions and 148 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 3
      public/apiDoc.md
  2. 46
      sanitiser/_geo_common.js
  3. 34
      sanitiser/_geo_reverse.js
  4. 38
      sanitiser/_geo_search.js
  5. 6
      sanitiser/reverse.js
  6. 2
      sanitiser/search.js
  7. 2
      test/unit/query/reverse.js
  8. 3
      test/unit/query/search.js
  9. 48
      test/unit/sanitiser/reverse.js
  10. 42
      test/unit/sanitiser/search.js

3
public/apiDoc.md
Unescape View File

@ -7,7 +7,6 @@ The full text search endpoint that matches the name of a place to points on the
#### Optional Parameters
* `lat`, `lon`: the latitude/longitude coordinates to bias search results towards (may increase relevancy)
* `zoom`: zoom level from which you wish to view the world
* `size` (default: `10`): the number of results to return
* `layers` (default: `poi,admin,address`): the comma-separated names of datasets you wish to query. Valid values are:
* aliases for multiple datasets like `poi`, `admin` or `address`
@ -48,7 +47,6 @@ results from around the provided lat/lon coordinates and also from precision lev
* `lat`/`lon` are currently **required** because of this [open issue](https://github.com/elasticsearch/elasticsearch/issues/6444)
#### Optional Parameters
* `zoom`: zoom level from which you wish to view the world
* `size` (default: `10`): number of results requested
* `layers` (default: `poi,admin,address`): datasets you wish to query
* `details` (default: `true`)
@ -84,7 +82,6 @@ The reverse geocoding endpoint; matches a point on the planet to the name of tha
* `lat`, `lon`: The coordinates of the point.
#### Optional Parameters
* `zoom`: zoom level from which you wish to view the world
* `layers` (default: `poi,admin,address`)
* `details` (default: `true`)

46
sanitiser/_geo.js → sanitiser/_geo_common.js
Unescape View File

@ -1,37 +1,7 @@
/**
* helper sanitiser methods for geo parameters
*/
var util = require( 'util' );
var isObject = require('is-object');
// validate inputs, convert types and apply defaults
module.exports = function sanitize( req, latlon_is_required ){
var clean = req.clean || {};
var params = req.query;
latlon_is_required = latlon_is_required || false;
// ensure the input params are a valid object
if( !isObject( params ) ){
params = {};
}
try {
sanitize_coord( 'lat', clean, params.lat, latlon_is_required );
sanitize_coord( 'lon', clean, params.lon, latlon_is_required );
sanitize_zoom_level(clean, params.zoom);
sanitize_bbox(clean, params.bbox);
}
catch (err) {
return {
'error': true,
'message': err.message
};
}
req.clean = clean;
return { 'error': false };
};
/**
* Parse and validate bbox parameter
@ -83,9 +53,7 @@ function sanitize_coord( coord, clean, param, latlon_is_required ) {
}
}
function sanitize_zoom_level( clean, param ) {
var zoom = parseInt( param, 10 );
if( !isNaN( zoom ) ){
clean.zoom = Math.min( Math.max( zoom, 1 ), 18 ); // max
}
}
module.exports = {
sanitize_bbox: sanitize_bbox,
sanitize_coord: sanitize_coord
};

34
sanitiser/_geo_reverse.js
Unescape View File

@ -0,0 +1,34 @@
var isObject = require('is-object');
var geo_common = require ('./_geo_common');
// validate inputs, convert types and apply defaults
module.exports = function sanitize( req ){
var clean = req.clean || {};
var params = req.query;
var latlon_is_required = true;
// ensure the input params are a valid object
if( !isObject( params ) ){
params = {};
}
if( !isObject( params.point ) ){
params.point = {};
}
try {
geo_common.sanitize_coord( 'lat', clean, params.point.lat, latlon_is_required );
geo_common.sanitize_coord( 'lon', clean, params.point.lon, latlon_is_required );
geo_common.sanitize_bbox(clean, params.bbox);
}
catch (err) {
return {
'error': true,
'message': err.message
};
}
req.clean = clean;
return { 'error': false };
};

38
sanitiser/_geo_search.js
Unescape View File

@ -0,0 +1,38 @@
var isObject = require('is-object');
var geo_common = require ('./_geo_common');
// validate inputs, convert types and apply defaults
module.exports = function sanitize( req ){
var clean = req.clean || {};
var params = req.query;
var latlon_is_required = false;
// ensure the input params are a valid object
if( !isObject( params ) ){
params = {};
}
if( !isObject( params.focus ) ){
params.focus = {};
}
if( !isObject( params.focus.point ) ){
params.focus.point = {};
}
try {
geo_common.sanitize_coord( 'lat', clean, params.focus.point.lat, latlon_is_required );
geo_common.sanitize_coord( 'lon', clean, params.focus.point.lon, latlon_is_required );
geo_common.sanitize_bbox(clean, params.bbox);
}
catch (err) {
return {
'error': true,
'message': err.message
};
}
req.clean = clean;
return { 'error': false };
};

6
sanitiser/reverse.js
Unescape View File

@ -1,10 +1,6 @@
var _sanitize = require('../sanitiser/_sanitize'),
sanitiser = {
latlonzoom: function( req ) {
var geo = require('../sanitiser/_geo');
return geo(req, true);
},
latlonzoom: require('../sanitiser/_geo_reverse'),
layers: require('../sanitiser/_layers'),
details: require('../sanitiser/_details'),
size: require('../sanitiser/_size'),

2
sanitiser/search.js
Unescape View File

@ -6,7 +6,7 @@ var _sanitize = require('../sanitiser/_sanitize'),
layers: require('../sanitiser/_layers'),
source: require('../sanitiser/_source'),
details: require('../sanitiser/_details'),
latlonzoom: require('../sanitiser/_geo')
latlonzoom: require('../sanitiser/_geo_search')
};
var sanitize = function(req, cb) { _sanitize(req, sanitizers, cb); };

2
test/unit/query/reverse.js
Unescape View File

@ -1,4 +1,3 @@
var generate = require('../../../query/reverse');
module.exports.tests = {};
@ -38,7 +37,6 @@ module.exports.tests.query = function(test, common) {
};
module.exports.all = function (tape, common) {
function test(name, testFunction) {
return tape('reverse query ' + name, testFunction);
}

3
test/unit/query/search.js
Unescape View File

@ -1,4 +1,3 @@
var generate = require('../../../query/search');
var parser = require('../../../helper/query_parser');
@ -137,11 +136,9 @@ module.exports.tests.query = function(test, common) {
t.deepEqual(compiled, expected, 'valid search query');
t.end();
});
};
module.exports.all = function (tape, common) {
function test(name, testFunction) {
return tape('search query ' + name, testFunction);
}

48
test/unit/sanitiser/reverse.js
Unescape View File

@ -37,7 +37,7 @@ module.exports.tests.sanitize_lat = function(test, common) {
};
test('invalid lat', function(t) {
lats.invalid.forEach( function( lat ){
sanitize({ lat: lat, lon: 0 }, function( err, clean ){
sanitize({ point: { lat: lat, lon: 0 } }, function( err, clean ){
t.equal(err, 'invalid param \'lat\': must be >-90 and <90', lat + ' is an invalid latitude');
t.equal(clean, undefined, 'clean not set');
});
@ -46,7 +46,7 @@ module.exports.tests.sanitize_lat = function(test, common) {
});
test('valid lat', function(t) {
lats.valid.forEach( function( lat ){
sanitize({ lat: lat, lon: 0 }, function( err, clean ){
sanitize({ point: { lat: lat, lon: 0 } }, function( err, clean ){
var expected = JSON.parse(JSON.stringify( defaultClean ));
expected.lat = parseFloat( lat );
t.equal(err, undefined, 'no error');
@ -57,7 +57,7 @@ module.exports.tests.sanitize_lat = function(test, common) {
});
test('missing lat', function(t) {
lats.missing.forEach( function( lat ){
sanitize({ lat: lat, lon: 0 }, function( err, clean ){
sanitize({ point: { lat: lat, lon: 0 } }, function( err, clean ){
t.equal(err, 'missing param \'lat\'', 'latitude is a required field');
t.equal(clean, undefined, 'clean not set');
});
@ -73,7 +73,7 @@ module.exports.tests.sanitize_lon = function(test, common) {
};
test('valid lon', function(t) {
lons.valid.forEach( function( lon ){
sanitize({ lat: 0, lon: lon }, function( err, clean ){
sanitize({ point: { lat: 0, lon: lon } }, function( err, clean ){
var expected = JSON.parse(JSON.stringify( defaultClean ));
expected.lon = parseFloat( lon );
t.equal(err, undefined, 'no error');
@ -84,7 +84,7 @@ module.exports.tests.sanitize_lon = function(test, common) {
});
test('missing lon', function(t) {
lons.missing.forEach( function( lon ){
sanitize({ lat: 0, lon: lon }, function( err, clean ){
sanitize({ point: { lat: 0, lon: lon } }, function( err, clean ){
t.equal(err, 'missing param \'lon\'', 'longitude is a required field');
t.equal(clean, undefined, 'clean not set');
});
@ -96,19 +96,19 @@ module.exports.tests.sanitize_lon = function(test, common) {
module.exports.tests.sanitize_size = function(test, common) {
test('invalid size value', function(t) {
sanitize({ size: 'a', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ size: 'a', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.equal(clean.size, 10, 'default size set');
t.end();
});
});
test('below min size value', function(t) {
sanitize({ size: -100, lat: 0, lon: 0 }, function( err, clean ){
sanitize({ size: -100, point: { lat: 0, lon: 0 } }, function( err, clean ){
t.equal(clean.size, 1, 'min size set');
t.end();
});
});
test('above max size value', function(t) {
sanitize({ size: 9999, lat: 0, lon: 0 }, function( err, clean ){
sanitize({ size: 9999, point: { lat: 0, lon: 0 } }, function( err, clean ){
t.equal(clean.size, 40, 'max size set');
t.end();
});
@ -119,7 +119,7 @@ module.exports.tests.sanitize_details = function(test, common) {
var invalid_values = [null, -1, 123, NaN, 'abc'];
invalid_values.forEach(function(details) {
test('invalid details param ' + details, function(t) {
sanitize({ lat: 0, lon: 0, details: details }, function( err, clean ){
sanitize({ point: { lat: 0, lon: 0 }, details: details }, function( err, clean ){
t.equal(clean.details, false, 'details set to false');
t.end();
});
@ -129,7 +129,7 @@ module.exports.tests.sanitize_details = function(test, common) {
var valid_values = [true, 'true', 1, '1', 'yes', 'y'];
valid_values.forEach(function(details) {
test('valid details param ' + details, function(t) {
sanitize({ lat: 0, lon: 0, details: details }, function( err, clean ){
sanitize({ point: { lat: 0, lon: 0 }, details: details }, function( err, clean ){
t.equal(clean.details, true, 'details set to true');
t.end();
});
@ -137,7 +137,7 @@ module.exports.tests.sanitize_details = function(test, common) {
});
test('test default behavior', function(t) {
sanitize({ lat: 0, lon: 0 }, function( err, clean ){
sanitize({ point: { lat: 0, lon: 0 } }, function( err, clean ){
t.equal(clean.details, true, 'details set to true');
t.end();
});
@ -146,7 +146,7 @@ module.exports.tests.sanitize_details = function(test, common) {
var valid_false_values = ['false', false, 0, '0', 'no', 'n'];
valid_false_values.forEach(function(details) {
test('test setting false explicitly ' + details, function(t) {
sanitize({ lat: 0, lon: 0, details: details }, function( err, clean ){
sanitize({ point: { lat: 0, lon: 0 }, details: details }, function( err, clean ){
t.equal(clean.details, false, 'details set to false');
t.end();
});
@ -156,13 +156,13 @@ module.exports.tests.sanitize_details = function(test, common) {
module.exports.tests.sanitize_layers = function(test, common) {
test('unspecified', function(t) {
sanitize({ layers: undefined, lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: undefined, point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, defaultClean.types.from_layers, 'default layers set');
t.end();
});
});
test('invalid layer', function(t) {
sanitize({ layers: 'test_layer', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'test_layer', point: { lat: 0, lon: 0 } }, function( err, clean ){
var msg = 'invalid param \'layers\': must be one or more of ';
t.true(err.match(msg), 'invalid layer requested');
t.true(err.length > msg.length, 'invalid error message');
@ -171,21 +171,21 @@ module.exports.tests.sanitize_layers = function(test, common) {
});
test('poi (alias) layer', function(t) {
var poi_layers = ['geoname','osmnode','osmway'];
sanitize({ layers: 'poi', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'poi', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, poi_layers, 'poi layers set');
t.end();
});
});
test('admin (alias) layer', function(t) {
var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin'];
sanitize({ layers: 'admin', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'admin', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, admin_layers, 'admin layers set');
t.end();
});
});
test('address (alias) layer', function(t) {
var address_layers = ['osmaddress','openaddresses'];
sanitize({ layers: 'address', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'address', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, address_layers, 'address layers set');
t.end();
});
@ -193,7 +193,7 @@ module.exports.tests.sanitize_layers = function(test, common) {
test('poi alias layer plus regular layers', function(t) {
var poi_layers = ['geoname','osmnode','osmway'];
var reg_layers = ['admin0', 'admin1'];
sanitize({ layers: 'poi,admin0,admin1', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'poi,admin0,admin1', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, reg_layers.concat(poi_layers), 'poi + regular layers');
t.end();
});
@ -201,7 +201,7 @@ module.exports.tests.sanitize_layers = function(test, common) {
test('admin alias layer plus regular layers', function(t) {
var admin_layers = ['admin0','admin1','admin2','neighborhood','locality','local_admin'];
var reg_layers = ['geoname', 'osmway'];
sanitize({ layers: 'admin,geoname,osmway', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'admin,geoname,osmway', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, reg_layers.concat(admin_layers), 'admin + regular layers set');
t.end();
});
@ -209,21 +209,21 @@ module.exports.tests.sanitize_layers = function(test, common) {
test('address alias layer plus regular layers', function(t) {
var address_layers = ['osmaddress','openaddresses'];
var reg_layers = ['geoname', 'osmway'];
sanitize({ layers: 'address,geoname,osmway', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'address,geoname,osmway', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_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', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'poi,geoname,osmnode', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, poi_layers, 'poi layers found (no duplicates)');
t.end();
});
});
test('multiple alias layers (no duplicates)', function(t) {
var alias_layers = ['geoname','osmnode','osmway','admin0','admin1','admin2','neighborhood','locality','local_admin'];
sanitize({ layers: 'poi,admin', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ layers: 'poi,admin', point: { lat: 0, lon: 0 } }, function( err, clean ){
t.deepEqual(clean.types.from_layers, alias_layers, 'all layers found (no duplicates)');
t.end();
});
@ -231,7 +231,7 @@ module.exports.tests.sanitize_layers = function(test, common) {
};
module.exports.tests.sanitize_categories = function(test, common) {
var queryParams = { lat: 0, lon: 0 };
var queryParams = { point: { lat: 0, lon: 0 } };
test('unspecified', function(t) {
queryParams.categories = undefined;
sanitize(queryParams, function( err, clean ){
@ -284,7 +284,7 @@ module.exports.tests.middleware_failure = function(test, common) {
module.exports.tests.middleware_success = function(test, common) {
test('middleware success', function(t) {
var req = { query: { lat: 0, lon: 0 }};
var req = { query: { point: { lat: 0, lon: 0 } }};
var next = function( message ){
t.equal(message, undefined, 'no error message set');
t.deepEqual(req.clean, defaultClean);

42
test/unit/sanitiser/search.js
Unescape View File

@ -93,7 +93,7 @@ module.exports.tests.sanitize_lat = function(test, common) {
};
test('invalid lat', function(t) {
lats.invalid.forEach( function( lat ){
sanitize({ text: 'test', lat: lat, lon: 0 }, function( err, clean ){
sanitize({ text: 'test', focus: { point: { lat: lat, lon: 0 } } }, function( err, clean ){
t.equal(err, 'invalid param \'lat\': must be >-90 and <90', lat + ' is an invalid latitude');
t.equal(clean, undefined, 'clean not set');
});
@ -102,11 +102,10 @@ module.exports.tests.sanitize_lat = function(test, common) {
});
test('valid lat', function(t) {
lats.valid.forEach( function( lat ){
sanitize({ text: 'test', lat: lat, lon: 0 }, function( err, clean ){
var expected = JSON.parse(JSON.stringify( defaultClean ));
expected.lat = parseFloat( lat );
sanitize({ text: 'test', focus: { point: { lat: lat, lon: 0 } } }, function( err, clean ){
var expected_lat = parseFloat( lat );
t.equal(err, undefined, 'no error');
t.deepEqual(clean.lat, expected.lat, 'clean lat set correctly (' + lat + ')');
t.deepEqual(clean.lat, expected_lat, 'clean lat set correctly (' + lat + ')');
});
});
t.end();
@ -119,7 +118,7 @@ module.exports.tests.sanitize_lon = function(test, common) {
};
test('valid lon', function(t) {
lons.valid.forEach( function( lon ){
sanitize({ text: 'test', lat: 0, lon: lon }, function( err, clean ){
sanitize({ text: 'test', focus: { point: { lat: 0, lon: lon } } }, function( err, clean ){
var expected = JSON.parse(JSON.stringify( defaultClean ));
expected.lon = parseFloat( lon );
t.equal(err, undefined, 'no error');
@ -140,7 +139,7 @@ module.exports.tests.sanitize_optional_geo = function(test, common) {
t.end();
});
test('no lat', function(t) {
sanitize({ text: 'test', lon: 0 }, function( err, clean ){
sanitize({ text: 'test', focus: { point: { lon: 0 } } }, function( err, clean ){
var expected_lon = 0;
t.equal(err, undefined, 'no error');
t.deepEqual(clean.lon, expected_lon, 'clean set correctly (without any lat)');
@ -148,7 +147,7 @@ module.exports.tests.sanitize_optional_geo = function(test, common) {
t.end();
});
test('no lon', function(t) {
sanitize({ text: 'test', lat: 0 }, function( err, clean ){
sanitize({ text: 'test', focus: { point: { lat: 0 } } }, function( err, clean ){
var expected_lat = 0;
t.equal(err, undefined, 'no error');
t.deepEqual(clean.lat, expected_lat, 'clean set correctly (without any lon)');
@ -214,27 +213,6 @@ module.exports.tests.sanitize_bbox = function(test, common) {
});
};
module.exports.tests.sanitize_zoom = function(test, common) {
test('invalid zoom value', function(t) {
sanitize({ zoom: 'a', text: 'test', lat: 0, lon: 0 }, function( err, clean ){
t.equal(clean.zoom, undefined, 'zoom not set');
t.end();
});
});
test('below min zoom value', function(t) {
sanitize({ zoom: -100, text: 'test', lat: 0, lon: 0 }, function( err, clean ){
t.equal(clean.zoom, 1, 'min zoom set');
t.end();
});
});
test('above max zoom value', function(t) {
sanitize({ zoom: 9999, text: 'test', lat: 0, lon: 0 }, function( err, clean ){
t.equal(clean.zoom, 18, 'max zoom set');
t.end();
});
});
};
module.exports.tests.sanitize_size = function(test, common) {
test('invalid size value', function(t) {
sanitize({ size: 'a', text: 'test', lat: 0, lon: 0 }, function( err, clean ){
@ -270,7 +248,7 @@ module.exports.tests.sanitize_details = function(test, common) {
var valid_values = ['true', true, 1, '1', 'yes', 'y'];
valid_values.forEach(function(details) {
test('valid details param ' + details, function(t) {
sanitize({ text: 'test', lat: 0, lon: 0, details: details }, function( err, clean ){
sanitize({ text: 'test', details: details }, function( err, clean ){
t.equal(clean.details, true, 'details set to true');
t.end();
});
@ -280,7 +258,7 @@ module.exports.tests.sanitize_details = function(test, common) {
var valid_false_values = ['false', false, 0, '0', 'no', 'n'];
valid_false_values.forEach(function(details) {
test('test setting false explicitly ' + details, function(t) {
sanitize({ text: 'test', lat: 0, lon: 0, details: details }, function( err, clean ){
sanitize({ text: 'test', details: details }, function( err, clean ){
t.equal(clean.details, false, 'details set to false');
t.end();
});
@ -288,7 +266,7 @@ module.exports.tests.sanitize_details = function(test, common) {
});
test('test default behavior', function(t) {
sanitize({ text: 'test', lat: 0, lon: 0 }, function( err, clean ){
sanitize({ text: 'test' }, function( err, clean ){
t.equal(clean.details, true, 'details set to true');
t.end();
});

Write Preview
Loading…
Cancel
Save