mirror of https://github.com/pelias/api.git
Julian Simioni
6 years ago
committed by
GitHub
28 changed files with 333 additions and 321 deletions
@ -0,0 +1,16 @@ |
|||||||
|
const _ = require('lodash'); |
||||||
|
const Debug = require('../../helper/debug'); |
||||||
|
const debugLog = new Debug('controller:predicates:is_request_sources_includes_whosonfirst'); |
||||||
|
const stackTraceLine = require('../../helper/stackTraceLine'); |
||||||
|
|
||||||
|
// returns true IFF 'whosonfirst' is included in the requested sources
|
||||||
|
module.exports = (req, res) => { |
||||||
|
const is_request_sources_includes_whosonfirst = _.get(req, 'clean.sources', []).includes( |
||||||
|
'whosonfirst' |
||||||
|
); |
||||||
|
debugLog.push(req, () => ({ |
||||||
|
reply: is_request_sources_includes_whosonfirst, |
||||||
|
stack_trace: stackTraceLine() |
||||||
|
})); |
||||||
|
return is_request_sources_includes_whosonfirst; |
||||||
|
}; |
||||||
@ -0,0 +1,16 @@ |
|||||||
|
const _ = require('lodash'); |
||||||
|
const Debug = require('../../helper/debug'); |
||||||
|
const debugLog = new Debug('controller:predicates:is_request_sources_undefined'); |
||||||
|
const stackTraceLine = require('../../helper/stackTraceLine'); |
||||||
|
|
||||||
|
// returns true IFF there are no requested sources
|
||||||
|
module.exports = (req, res) => { |
||||||
|
const is_request_sources_undefined = _.isEmpty( |
||||||
|
_.get(req, 'clean.sources') |
||||||
|
); |
||||||
|
debugLog.push(req, () => ({ |
||||||
|
reply: is_request_sources_undefined, |
||||||
|
stack_trace: stackTraceLine() |
||||||
|
})); |
||||||
|
return is_request_sources_undefined; |
||||||
|
}; |
||||||
@ -1,7 +1,7 @@ |
|||||||
## Attribution |
## Attribution |
||||||
* Geocoding by [Pelias](https://pelias.io). |
* Geocoding by [Pelias](https://pelias.io). |
||||||
* Data from |
* Data from |
||||||
* [OpenStreetMap](http://www.openstreetmap.org/copyright) © OpenStreetMap contributors under [ODbL](http://opendatacommons.org/licenses/odbl/) |
* [OpenStreetMap](http://www.openstreetmap.org/copyright) © OpenStreetMap contributors under [ODbL](http://opendatacommons.org/licenses/odbl/). Also see the [OSM Geocoding Guidelines](https://wiki.osmfoundation.org/wiki/Licence/Community_Guidelines/Geocoding_-_Guideline) for acceptable use. |
||||||
* [OpenAddresses](http://openaddresses.io) under a [Creative Commons Zero](https://github.com/openaddresses/openaddresses/blob/master/sources/LICENSE) public domain designation |
* [OpenAddresses](http://openaddresses.io) under [various public-domain and share-alike licenses](http://results.openaddresses.io/) |
||||||
* [GeoNames](http://www.geonames.org/) under [CC-BY-3.0](https://creativecommons.org/licenses/by/2.0/) |
* [GeoNames](http://www.geonames.org/) under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/) |
||||||
* [WhosOnFirst](https://www.whosonfirst.org/) under [various licenses](https://github.com/whosonfirst/whosonfirst-data/blob/master/LICENSE.md) |
* [WhosOnFirst](https://www.whosonfirst.org/) under [various CC-BY or CC-0 equivalent licenses](https://whosonfirst.org/docs/licenses/) |
||||||
|
|||||||
@ -1,38 +0,0 @@ |
|||||||
var peliasQuery = require('pelias-query'); |
|
||||||
|
|
||||||
/** |
|
||||||
This view is the same as `peliasQuery.view.focus` with one exception: |
|
||||||
|
|
||||||
if the view is generated successfully, we add a 'filter' clause which |
|
||||||
restricts the targeted '_type' to be in the list specified below. |
|
||||||
|
|
||||||
documents which are not in the '_type' list below will simply score 0 for |
|
||||||
this section of the query. |
|
||||||
**/ |
|
||||||
|
|
||||||
module.exports = function( subview ){ |
|
||||||
return function( vs ){ |
|
||||||
|
|
||||||
// don't perform this query on single character inputs
|
|
||||||
// as its too unperformant to sort a large part of the index.
|
|
||||||
if( vs.var('input:name').get().length < 2 ){ |
|
||||||
return null; |
|
||||||
} |
|
||||||
|
|
||||||
if( !subview ){ return null; } // subview validation failed
|
|
||||||
var macroView = peliasQuery.view.focus( subview ); |
|
||||||
if( !macroView ){ return null; } // macroView validation failed
|
|
||||||
var view = macroView( vs ); |
|
||||||
|
|
||||||
if( view && view.hasOwnProperty('function_score') ){ |
|
||||||
view.function_score.filter = { |
|
||||||
'or': [ |
|
||||||
{ 'term': { 'layer': 'venue' } }, |
|
||||||
{ 'term': { 'layer': 'address' } } |
|
||||||
] |
|
||||||
}; |
|
||||||
} |
|
||||||
|
|
||||||
return view; |
|
||||||
}; |
|
||||||
}; |
|
||||||
@ -1,43 +0,0 @@ |
|||||||
var _ = require('lodash'); |
|
||||||
|
|
||||||
/** |
|
||||||
In the process of phasing out the 'quattroshapes' source in favour of 'whosonfirst' |
|
||||||
we will emit a warning to users so they can begin upgrading their clients. |
|
||||||
|
|
||||||
In the interim we will automatically rewrite all requests for quattroshapes to whosonfirst. |
|
||||||
|
|
||||||
@todo: this is only temporary |
|
||||||
@see: https://github.com/pelias/api/issues/442
|
|
||||||
**/ |
|
||||||
|
|
||||||
function _sanitize( raw, clean, opts ) { |
|
||||||
// error & warning messages
|
|
||||||
var messages = { errors: [], warnings: [] }; |
|
||||||
|
|
||||||
// only applicably when 'sources' param is privided
|
|
||||||
if( raw.hasOwnProperty('sources') ){ |
|
||||||
|
|
||||||
var sources = raw.sources.split(','); |
|
||||||
if (_.includes(sources, 'quattroshapes') || _.includes(sources, 'qs')) { |
|
||||||
|
|
||||||
// emit a warning message so users can transition.
|
|
||||||
messages.warnings.push('You are using Quattroshapes as a data source in this query. ' + |
|
||||||
'Quattroshapes has been disabled as a data source for Mapzen Search, and has been' + |
|
||||||
'replaced by Who\'s on First, an actively maintained data project based on Quattroshapes' + |
|
||||||
'Your existing queries WILL CONTINUE TO WORK for the foreseeable future, but results will ' + |
|
||||||
'be coming from Who\'s on First and `sources=quattroshapes` will be interpreted as ' + |
|
||||||
'`sources=whosonfirst`. If you have any questions, please email pelias.team@gmail.com.'); |
|
||||||
|
|
||||||
// user requested 'quattroshapes', we will give them 'whosonfirst' instead.
|
|
||||||
sources = _.without(sources, 'quattroshapes', 'qs'); |
|
||||||
sources.push('whosonfirst'); |
|
||||||
raw.sources = sources.join(','); |
|
||||||
} |
|
||||||
} |
|
||||||
|
|
||||||
return messages; |
|
||||||
} |
|
||||||
|
|
||||||
module.exports = () => ({ |
|
||||||
sanitize: _sanitize |
|
||||||
}); |
|
||||||
@ -1,34 +0,0 @@ |
|||||||
|
|
||||||
#> quattroshapes is being phased out and so should emit a warning message |
|
||||||
path: '/v1/reverse?point.lat=1&point.lon=2&sources=qs' |
|
||||||
|
|
||||||
#? 200 ok |
|
||||||
response.statusCode.should.be.equal 200 |
|
||||||
response.should.have.header 'charset', 'utf8' |
|
||||||
response.should.have.header 'content-type', 'application/json; charset=utf-8' |
|
||||||
|
|
||||||
#? valid geocoding block |
|
||||||
should.exist json.geocoding |
|
||||||
should.exist json.geocoding.version |
|
||||||
should.exist json.geocoding.attribution |
|
||||||
should.exist json.geocoding.query |
|
||||||
should.exist json.geocoding.engine |
|
||||||
should.exist json.geocoding.engine.name |
|
||||||
should.exist json.geocoding.engine.author |
|
||||||
should.exist json.geocoding.engine.version |
|
||||||
should.exist json.geocoding.timestamp |
|
||||||
|
|
||||||
#? valid geojson |
|
||||||
json.type.should.be.equal 'FeatureCollection' |
|
||||||
json.features.should.be.instanceof Array |
|
||||||
|
|
||||||
#? expected errors |
|
||||||
should.not.exist json.geocoding.errors |
|
||||||
|
|
||||||
#? expected warnings |
|
||||||
should.exist json.geocoding.warnings |
|
||||||
json.geocoding.warnings.should.eql ['You are using Quattroshapes as a data source in this query. Quattroshapes has been disabled as a data source for Mapzen Search, and has beenreplaced by Who\'s on First, an actively maintained data project based on QuattroshapesYour existing queries WILL CONTINUE TO WORK for the foreseeable future, but results will be coming from Who\'s on First and `sources=quattroshapes` will be interpreted as `sources=whosonfirst`. If you have any questions, please email pelias.team@gmail.com.' ] |
|
||||||
|
|
||||||
#? inputs |
|
||||||
json.geocoding.query['size'].should.eql 10 |
|
||||||
json.geocoding.query.sources.should.eql ['whosonfirst'] # should use 'whosonfirst' instead of 'quattroshapes' |
|
||||||
@ -1,35 +0,0 @@ |
|||||||
|
|
||||||
#> quattroshapes is being phased out and so should emit a warning message |
|
||||||
path: '/v1/search?sources=qs&text=a' |
|
||||||
|
|
||||||
#? 200 ok |
|
||||||
response.statusCode.should.be.equal 200 |
|
||||||
response.should.have.header 'charset', 'utf8' |
|
||||||
response.should.have.header 'content-type', 'application/json; charset=utf-8' |
|
||||||
|
|
||||||
#? valid geocoding block |
|
||||||
should.exist json.geocoding |
|
||||||
should.exist json.geocoding.version |
|
||||||
should.exist json.geocoding.attribution |
|
||||||
should.exist json.geocoding.query |
|
||||||
should.exist json.geocoding.engine |
|
||||||
should.exist json.geocoding.engine.name |
|
||||||
should.exist json.geocoding.engine.author |
|
||||||
should.exist json.geocoding.engine.version |
|
||||||
should.exist json.geocoding.timestamp |
|
||||||
|
|
||||||
#? valid geojson |
|
||||||
json.type.should.be.equal 'FeatureCollection' |
|
||||||
json.features.should.be.instanceof Array |
|
||||||
|
|
||||||
#? expected errors |
|
||||||
should.not.exist json.geocoding.errors |
|
||||||
|
|
||||||
#? expected warnings |
|
||||||
should.exist json.geocoding.warnings |
|
||||||
json.geocoding.warnings.should.eql ['You are using Quattroshapes as a data source in this query. Quattroshapes has been disabled as a data source for Mapzen Search, and has beenreplaced by Who\'s on First, an actively maintained data project based on QuattroshapesYour existing queries WILL CONTINUE TO WORK for the foreseeable future, but results will be coming from Who\'s on First and `sources=quattroshapes` will be interpreted as `sources=whosonfirst`. If you have any questions, please email pelias.team@gmail.com.' ] |
|
||||||
|
|
||||||
#? inputs |
|
||||||
json.geocoding.query['size'].should.eql 10 |
|
||||||
json.geocoding.query['text'].should.eql 'a' |
|
||||||
json.geocoding.query.sources.should.eql ['whosonfirst'] # should use 'whosonfirst' instead of 'quattroshapes' |
|
||||||
@ -0,0 +1,90 @@ |
|||||||
|
const _ = require('lodash'); |
||||||
|
const is_request_sources_includes_whosonfirst = require('../../../../controller/predicates/is_request_sources_includes_whosonfirst'); |
||||||
|
|
||||||
|
module.exports.tests = {}; |
||||||
|
|
||||||
|
module.exports.tests.interface = (test, common) => { |
||||||
|
test('valid interface', (t) => { |
||||||
|
t.ok(_.isFunction(is_request_sources_includes_whosonfirst), 'is_request_sources_includes_whosonfirst is a function'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.tests.true_conditions = (test, common) => { |
||||||
|
test('sources includes \'whosonfirst\' should return true', (t) => { |
||||||
|
const req = { |
||||||
|
clean: { |
||||||
|
sources: [ |
||||||
|
'whosonfirst', |
||||||
|
'not whosonfirst' |
||||||
|
] |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
t.ok(is_request_sources_includes_whosonfirst(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('empty req.clean.sources should return false', (t) => { |
||||||
|
const req = { |
||||||
|
clean: { |
||||||
|
sources: [] |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
t.notOk(is_request_sources_includes_whosonfirst(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.tests.false_conditions = (test, common) => { |
||||||
|
test('undefined req should return false', (t) => { |
||||||
|
t.notOk(is_request_sources_includes_whosonfirst(undefined)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('undefined req.clean should return false', (t) => { |
||||||
|
const req = {}; |
||||||
|
|
||||||
|
t.notOk(is_request_sources_includes_whosonfirst(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('undefined req.clean.sources should return false', (t) => { |
||||||
|
const req = { |
||||||
|
clean: {} |
||||||
|
}; |
||||||
|
|
||||||
|
t.notOk(is_request_sources_includes_whosonfirst(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('sources not \'whosonfirst\' should return false', (t) => { |
||||||
|
const req = { |
||||||
|
clean: { |
||||||
|
sources: [ |
||||||
|
'not whosonfirst' |
||||||
|
] |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
t.notOk(is_request_sources_includes_whosonfirst(req)); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.all = (tape, common) => { |
||||||
|
function test(name, testFunction) { |
||||||
|
return tape(`GET /is_request_sources_includes_whosonfirst ${name}`, testFunction); |
||||||
|
} |
||||||
|
|
||||||
|
for( const testCase in module.exports.tests ){ |
||||||
|
module.exports.tests[testCase](test, common); |
||||||
|
} |
||||||
|
}; |
||||||
@ -0,0 +1,78 @@ |
|||||||
|
const _ = require('lodash'); |
||||||
|
const is_request_sources_undefined = require('../../../../controller/predicates/is_request_sources_undefined'); |
||||||
|
|
||||||
|
module.exports.tests = {}; |
||||||
|
|
||||||
|
module.exports.tests.interface = (test, common) => { |
||||||
|
test('valid interface', (t) => { |
||||||
|
t.ok(_.isFunction(is_request_sources_undefined), 'is_request_sources_undefined is a function'); |
||||||
|
t.end(); |
||||||
|
}); |
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.tests.true_conditions = (test, common) => { |
||||||
|
test('undefined req should return true', (t) => { |
||||||
|
|
||||||
|
t.ok(is_request_sources_undefined(undefined)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('undefined req.clean should return true', (t) => { |
||||||
|
const req = {}; |
||||||
|
|
||||||
|
t.ok(is_request_sources_undefined(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('undefined req.clean.sources should return true', (t) => { |
||||||
|
const req = { |
||||||
|
clean: {} |
||||||
|
}; |
||||||
|
|
||||||
|
t.ok(is_request_sources_undefined(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
test('empty req.clean.sources should return true', (t) => { |
||||||
|
const req = { |
||||||
|
clean: { |
||||||
|
sources: [] |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
t.ok(is_request_sources_undefined(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.tests.false_conditions = (test, common) => { |
||||||
|
test('sources not empty should return false', (t) => { |
||||||
|
const req = { |
||||||
|
clean: { |
||||||
|
sources: [ |
||||||
|
'not empty' |
||||||
|
] |
||||||
|
} |
||||||
|
}; |
||||||
|
|
||||||
|
t.notOk(is_request_sources_undefined(req)); |
||||||
|
t.end(); |
||||||
|
|
||||||
|
}); |
||||||
|
|
||||||
|
}; |
||||||
|
|
||||||
|
module.exports.all = (tape, common) => { |
||||||
|
function test(name, testFunction) { |
||||||
|
return tape(`GET /is_request_sources_undefined ${name}`, testFunction); |
||||||
|
} |
||||||
|
|
||||||
|
for( const testCase in module.exports.tests ){ |
||||||
|
module.exports.tests[testCase](test, common); |
||||||
|
} |
||||||
|
}; |
||||||
@ -1,65 +0,0 @@ |
|||||||
var sanitizer = require('../../../sanitizer/_deprecate_quattroshapes')(); |
|
||||||
|
|
||||||
module.exports.tests = {}; |
|
||||||
|
|
||||||
module.exports.tests.warning_message_1 = function(test, common) { |
|
||||||
test('[qs] should emit a deprecation warning', function(t) { |
|
||||||
var raw = { sources: 'qs' }; |
|
||||||
var clean = {}; |
|
||||||
|
|
||||||
var messages = sanitizer.sanitize(raw, clean); |
|
||||||
t.deepEquals(messages, { |
|
||||||
errors: [], |
|
||||||
warnings: ['You are using Quattroshapes as a data source in this query. ' + |
|
||||||
'Quattroshapes has been disabled as a data source for Mapzen Search, and has been' + |
|
||||||
'replaced by Who\'s on First, an actively maintained data project based on Quattroshapes' + |
|
||||||
'Your existing queries WILL CONTINUE TO WORK for the foreseeable future, but results will ' + |
|
||||||
'be coming from Who\'s on First and `sources=quattroshapes` will be interpreted as ' + |
|
||||||
'`sources=whosonfirst`. If you have any questions, please email pelias.team@gmail.com.'] |
|
||||||
}, 'warning emitted'); |
|
||||||
|
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
module.exports.tests.warning_message_2 = function(test, common) { |
|
||||||
test('[quattroshapes] should emit a deprecation warning', function(t) { |
|
||||||
var raw = { sources: 'quattroshapes' }; |
|
||||||
var clean = {}; |
|
||||||
|
|
||||||
var messages = sanitizer.sanitize(raw, clean); |
|
||||||
t.deepEquals(messages, { |
|
||||||
errors: [], |
|
||||||
warnings: ['You are using Quattroshapes as a data source in this query. ' + |
|
||||||
'Quattroshapes has been disabled as a data source for Mapzen Search, and has been' + |
|
||||||
'replaced by Who\'s on First, an actively maintained data project based on Quattroshapes' + |
|
||||||
'Your existing queries WILL CONTINUE TO WORK for the foreseeable future, but results will ' + |
|
||||||
'be coming from Who\'s on First and `sources=quattroshapes` will be interpreted as ' + |
|
||||||
'`sources=whosonfirst`. If you have any questions, please email pelias.team@gmail.com.'] |
|
||||||
}, 'warning emitted'); |
|
||||||
|
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
module.exports.tests.rewrite = function(test, common) { |
|
||||||
test('should rewrite qs and quattroshapes to whosonfirst', function(t) { |
|
||||||
var raw = { sources: 'qs,quattroshapes,qs,quattroshapes,osm' }; |
|
||||||
var clean = {}; |
|
||||||
|
|
||||||
sanitizer.sanitize(raw, clean); |
|
||||||
t.equals(raw.sources,'osm,whosonfirst','use wof instead of qs'); |
|
||||||
|
|
||||||
t.end(); |
|
||||||
}); |
|
||||||
}; |
|
||||||
|
|
||||||
module.exports.all = function (tape, common) { |
|
||||||
function test(name, testFunction) { |
|
||||||
return tape('SANITIZE _deprecate_quattroshapes ' + name, testFunction); |
|
||||||
} |
|
||||||
|
|
||||||
for( var testCase in module.exports.tests ){ |
|
||||||
module.exports.tests[testCase](test, common); |
|
||||||
} |
|
||||||
}; |
|
||||||
Loading…
Reference in new issue