Merge branch 'rename-doc-to-place'

DOCS.md

@@ -89,14 +89,15 @@ The reverse geocoding endpoint; matches a point on the planet to the name of tha
 * `details` (default: `true`)
 
 
-## /doc
+## /place
 
-The endpoint for retrieving one or more elasticsearch documents with specific ids.
+The endpoint for retrieving one or more places with specific ids. These correspond
+directly with Elasticsearch documents.
 
 #### Required Parameters
 * one of `id` or `ids`
   * `id`:
-    * unique id of the document to be retrieved
+    * unique id of the places to be retrieved
     * should be in the form of type:id, for example: `geoname:4163334`
   * `ids`:
-    * if multiple docs are to be fetched in bulk, an array of ids
+    * if multiple places are to be fetched in bulk, an array of ids

app.js

@@ -15,7 +15,7 @@ app.use( require('./middleware/jsonp') );
 /** ----------------------- sanitisers ----------------------- **/
 
 var sanitisers = {};
-sanitisers.doc      = require('./sanitiser/doc');
+sanitisers.place      = require('./sanitiser/place');
 sanitisers.suggest  = require('./sanitiser/suggest');
 sanitisers.search   = require('./sanitiser/search');
 sanitisers.coarse   = require('./sanitiser/coarse');
@@ -25,7 +25,7 @@ sanitisers.reverse  = require('./sanitiser/reverse');
 
 var controllers     = {};
 controllers.index   = require('./controller/index');
-controllers.doc     = require('./controller/doc');
+controllers.place     = require('./controller/place');
 controllers.search  = require('./controller/search');
 
 /** ----------------------- routes ----------------------- **/
@@ -33,8 +33,8 @@ controllers.search  = require('./controller/search');
 // api root
 app.get( '/', controllers.index() );
 
-// doc API
-app.get( '/doc', sanitisers.doc.middleware, controllers.doc() );
+// place API
+app.get( '/place', sanitisers.place.middleware, controllers.place() );
 
 // suggest APIs
 app.get( '/suggest', sanitisers.search.middleware, controllers.search() );

controller/place.js

@@ -1,14 +1,11 @@
-
 var service = { mget: require('../service/mget') };
 var geojsonify = require('../helper/geojsonify').search;
 
 function setup( backend ){
-
   // allow overriding of dependencies
   backend = backend || require('../src/backend');
 
   function controller( req, res, next ){
-    
     var query = req.clean.ids.map( function(id) {
       return {
         _index: 'pelias',
@@ -18,7 +15,6 @@ function setup( backend ){
     });
 
     service.mget( backend, query, function( err, docs ){
-
       // error handler
       if( err ){ return next( err ); }
 
@@ -30,9 +26,7 @@ function setup( backend ){
 
       // respond
       return res.status(200).json( geojson );
-
     });
-
   }
 
   return controller;

sanitiser/place.js

@@ -1,4 +1,3 @@
-
 var _sanitize = require('../sanitiser/_sanitize'),
     sanitizers = {
       id: require('../sanitiser/_id'),

test/ciao/place/msuccess.coffee

@@ -1,6 +1,6 @@
 
-#> valid doc query
-path: '/doc?id=geoname:4221195&id=geoname:4193595'
+#> valid place query
+path: '/place?id=geoname:4221195&id=geoname:4193595'
 
 #? 200 ok
 response.statusCode.should.equal 200

test/ciao/place/success.coffee

@@ -1,6 +1,6 @@
 
-#> valid doc query
-path: '/doc?id=geoname:4221195'
+#> valid place query
+path: '/place?id=geoname:4221195'
 
 #? 200 ok
 response.statusCode.should.equal 200

test/unit/controller/place.js

@@ -1,5 +1,4 @@
-
-var setup = require('../../../controller/doc'),
+var setup = require('../../../controller/place'),
     mockBackend = require('../mock/backend');
 
 module.exports.tests = {};
@@ -15,7 +14,7 @@ module.exports.tests.interface = function(test, common) {
 // functionally test controller (backend success)
 module.exports.tests.functional_success = function(test, common) {
 
-  // expected geojson features for 'client/doc/ok/1' fixture
+  // expected geojson features for 'client/place/ok/1' fixture
   var expected = [{
     type: 'Feature',
     geometry: {

test/unit/run.js

@@ -4,14 +4,14 @@ var common = {};
 
 var tests = [
   require('./controller/index'),
-  require('./controller/doc'),
+  require('./controller/place'),
   require('./controller/search'),
   require('./service/mget'),
   require('./service/search'),
   require('./sanitiser/suggest'),
   require('./sanitiser/search'),
   require('./sanitiser/reverse'),
-  require('./sanitiser/doc'),
+  require('./sanitiser/place'),
   require('./sanitiser/coarse'),
   require('./query/indeces'),
   require('./query/sort'),

test/unit/sanitiser/place.js

@@ -1,7 +1,7 @@
 
-var doc  = require('../../../sanitiser/doc'),
-    _sanitize = doc.sanitize,
-    middleware = doc.middleware,
+var place  = require('../../../sanitiser/place'),
+    _sanitize = place.sanitize,
+    middleware = place.middleware,
     indeces = require('../../../query/indeces'),
     delimiter = ':',
     defaultLengthError = function(input) { return 'invalid param \''+ input + '\': text length, must be >0'; },
@@ -190,7 +190,7 @@ module.exports.tests.middleware_success = function(test, common) {
 module.exports.all = function (tape, common) {
 
   function test(name, testFunction) {
-    return tape('SANTIZE /doc ' + name, testFunction);
+    return tape('SANTIZE /place ' + name, testFunction);
   }
 
   for( var testCase in module.exports.tests ){