Merge pull request #8 from Turistforeningen/docs/add-examples

Add example Express app using MongoQS

Author: Starefossen

docker-compose.yml

@@ -1,5 +1,10 @@
+mongo:
+    image: mongo:latest
+
 dev:
   image: node:0.10-slim
+  links:
+    - mongo
   working_dir: /usr/src/app
   volumes:
     - ".:/usr/src/app"

examples/app.js

@@ -0,0 +1,32 @@
+'use strict';
+
+var express = require('express');
+var app = module.exports = express();
+
+var MongoQS = require('../index');
+
+// Create a new Mongo QueryString parser
+var qs = new MongoQS({
+  custom: {
+    bbox: 'geojson',
+    near: 'geojson'
+  }
+});
+
+app.get('/api/places', function(req, res) {
+  res.set('Content-Type', 'application/json');
+
+  // Parse the request query parameters
+  var query = qs.parse(req.query);
+  var collection = require('./db').db.collection('places');
+  var cursor = collection.find(query).limit(3);
+
+  cursor.stream().pipe(require('JSONStream').stringify()).pipe(res);
+});
+
+if (!module.parent) {
+  require('./db').once('ready', function() {
+    app.listen(3000);
+    console.log('Express started on port 3000');
+  });
+}

examples/data.json

@@ -0,0 +1,43 @@
+[{
+  "name": "Solrenningen",
+  "geojson": {
+    "type": "Point",
+    "coordinates": [6.13037, 61.00607]
+  },
+  "tags": ["Ved", "Mat", "Båt"]
+},{
+  "name": "Norddalshytten",
+  "geojson": {
+    "type": "Point",
+    "coordinates": [5.99579, 61.01340]
+  },
+  "tags": ["Ved", "Mat", "Tåke"]
+},{
+  "name": "Åsedalen",
+  "geojson": {
+    "type": "Point",
+    "coordinates": [6.22032, 60.96244]
+  },
+  "tags": ["Ved", "Mat", "Stekeovn"]
+},{
+  "name": "Vatnane",
+  "geojson": {
+    "type": "Point",
+    "coordinates": [6.32607, 61.02105]
+  },
+  "tags": ["Ved"]
+},{
+  "name": "Selhamar",
+  "geojson": {
+    "type": "Point",
+    "coordinates": [6.26495, 60.91275]
+  },
+  "tags": ["Ved", "Mat", "Stekeovn", "Båt"]
+},{
+  "name": "Vardadalsbu",
+  "geojson": {
+    "type": "Point",
+    "coordinates": [5.89279, 60.94477]
+  },
+  "tags": ["Ved", ""]
+}]

examples/db.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var EventEmitter = require('events').EventEmitter;
+var MongoClient = require('mongodb').MongoClient;
+var inherits = require('util').inherits;
+
+var Mongo = function(uri) {
+  EventEmitter.call(this);
+
+  this.db = null;
+
+  var $this = this;
+
+  new MongoClient.connect(uri, function(err, db) {
+    if (err) { throw err; }
+
+    $this.db = db;
+    $this.emit('ready');
+  });
+
+  return this;
+};
+
+inherits(Mongo, EventEmitter);
+
+module.exports = new Mongo('mongodb://mongo:27017/test');

examples/test.js

@@ -0,0 +1,90 @@
+'use strict';
+
+var assert = require('assert');
+var request = require('supertest');
+
+var data = require('./data');
+var app = request(require('./app'));
+var db = require('./db');
+
+describe('Example App', function() {
+  before(function(done) {
+    if (db.db) { return done(); }
+    db.once('ready', done);
+  });
+
+  before(function(done) {
+    db.db.dropDatabase(done);
+  });
+
+  before(function(done) {
+    db.db.collection('places').createIndex({geojson: '2dsphere'}, done);
+  });
+
+  before(function(done) {
+    db.db.collection('places').insertMany(data, done);
+  });
+
+  var url = '/api/places';
+
+  it('returns all them places', function(done) {
+    app.get(url)
+      .expect(200)
+      .expect(function(res) {
+        assert.equal(res.body.length, 3);
+      })
+      .end(done);
+  });
+
+  it('returns places matching name', function(done) {
+    app.get(url + '?name=Vatnane')
+      .expect(200)
+      .expect(function(res) {
+        assert.equal(res.body.length, 1);
+        assert.equal(res.body[0].name, 'Vatnane');
+      })
+      .end(done);
+  });
+
+  it('returns places near point', function(done) {
+    app.get(url + '?near=6.13037,61.00607')
+      .expect(200)
+      .expect(function(res) {
+        assert.equal(res.body.length, 3);
+        assert.equal(res.body[0].name, 'Solrenningen');
+        assert.equal(res.body[1].name, 'Åsedalen');
+        assert.equal(res.body[2].name, 'Norddalshytten');
+      })
+      .end(done);
+  });
+
+  it('returns places inside bbox', function(done) {
+    var bbox = [
+      '5.5419158935546875',
+      '60.92859723298985',
+      '6.0363006591796875',
+      '61.018719220334525'
+    ].join(',');
+
+    app.get(url + '?bbox=' + bbox)
+      .expect(200)
+      .expect(function(res) {
+        assert.equal(res.body.length, 2);
+        assert.equal(res.body[0].name, 'Norddalshytten');
+        assert.equal(res.body[1].name, 'Vardadalsbu');
+      })
+      .end(done);
+  });
+
+  it('returns palces with any of the following tags', function(done) {
+    app.get(url + '?tags[]=Båt&tags[]=Stekeovn')
+      .expect(200)
+      .expect(function(res) {
+        assert.equal(res.body.length, 3);
+        assert.equal(res.body[0].name, 'Solrenningen');
+        assert.equal(res.body[1].name, 'Åsedalen');
+        assert.equal(res.body[2].name, 'Selhamar');
+      })
+      .end(done);
+  });
+});

package.json

@@ -13,9 +13,9 @@
     "test": "test"
   },
   "scripts": {
-    "lint": "jshint index.js test.js",
-    "watch": "mocha -w -b -c --check-leaks -R progress test.js",
-    "test": "mocha -b -c --check-leaks -R spec test.js",
+    "lint": "jshint *.js examples",
+    "watch": "mocha -w -b -c --check-leaks -R progress test.js examples/test.js",
+    "test": "mocha -b -c --check-leaks -R spec test.js examples/test.js",
     "semantic-release": "semantic-release"
   },
   "keywords": [
@@ -41,9 +41,13 @@
   },
   "homepage": "https://github.com/Turistforeningen/node-mongo-querystring",
   "devDependencies": {
+    "JSONStream": "^1.0.7",
+    "express": "^4.13.3",
     "jshint": "^2.8.0",
     "mocha": "^2.3.4",
+    "mongodb": "^2.0.52",
     "qs": "^5.2.0",
-    "semantic-release": "^4.3.5"
+    "semantic-release": "^4.3.5",
+    "supertest": "^1.1.0"
   }
 }

wercker.yml

@@ -1,5 +1,8 @@
 box: node:0.10
 
+services:
+    - mongo:latest
+
 build:
     steps:
         - script: