Changeset 475

Timestamp:

07/28/13 17:46:12 (12 years ago)

Author:

hendrikvanantwerpen

Message:

• Added CouchDB script to make interacting with couch easier.
• Use this script in the database configuration.
• Get CSV export to work.

Location:

Dev/trunk

Files:

• package.json (modified) (1 diff)
• src/.jshintrc (modified) (2 diffs)
• src/.jshintrc-generated (modified) (1 diff)
• src/package.json (modified) (1 diff)
• src/server/app.js (modified) (4 diffs)
• src/server/config/config-couchdb.js (modified) (3 diffs)
• src/server/heroku.js (modified) (1 diff)
• src/server/util (modified) (1 prop)
• src/server/util/couch.coffee (added)

Dev/trunk/package.json

@@ -6 +6 @@
     "grunt": "~0.4.0",
     "grunt-contrib-copy": "~0.4.1",
-    "grunt-contrib-jshint": "~0.2.0",
-    "grunt-contrib-less": "~0.5.0",
+    "grunt-contrib-jshint": "~0.6.0",
+    "grunt-contrib-less": "~0.6.4",
     "grunt-dojo": "~0.2.3",
     "grunt-exec": "~0.4.1",
     "grunt-htmlhint": "~0.4.0",
-    "grunt-contrib-clean": "~0.4.1",
+    "grunt-contrib-clean": "~0.5.0",
     "grunt-contrib-coffee": "~0.7.0",
     "underscore": "~1.4.4",
-    "grunt-coffeelint": "0.0.6",
+    "grunt-coffeelint": "~0.0.6",
     "grunt-banner": "~0.1.4",
     "grunt-amd-check": "~0.5.2"

Dev/trunk/src/.jshintrc

@@ -6 +6 @@
     "immed": true,
     "indent": 4,
-    "latedef": true,
+    "latedef": "nofunc",
     "newcap": true,
     "noarg": true,
@@ -16 +16 @@
 
     "loopfunc": true,
+    "laxcomma": true,
 
     "devel": true,

Dev/trunk/src/.jshintrc-generated

@@ -21 +21 @@
     "browser": true,
     "couch": true,
+    "boss": true,
 
     "globals": {

Dev/trunk/src/package.json

@@ -9 +9 @@
     "passport-local": "~0.1.6",
     "q": "~0.9.6",
-    "request": "~2.21.0"
+    "request": "~2.21.0",
+    "ya-csv": "~0.9.2"
   },
   "engines": {

Dev/trunk/src/server/app.js

@@ -1 @@
-var express = require("express");
-var passport = require("passport"),
-    passportLocal = require("passport-local");
-var fs = require("fs");
-var path = require("path");
-var proxy = require("./util/simple-http-proxy");
-var _ = require("underscore");
+var express = require("express")
+  , passport = require("passport")
+  , passportLocal = require("passport-local")
+  , fs = require("fs")
+  , path = require("path")
+  , proxy = require("./util/simple-http-proxy")
+  , CSV = require("ya-csv")
+  , CouchDB = require('./util/couch').CouchDB
+  , _ = require("underscore")
+  ;
 
 function assertSetting(name, settings, validate) {
@@ -19 +22 @@
 
     assertSetting("couchDbURL", settings, _.isString);
+    var couch = new CouchDB(settings.couchDbURL);
     
     function clientPath(relativePath) {
@@ -105 +109 @@
         function(req, res) {
             var id = req.params.id;
-            // query CouchDB and build the CSV file
-            res.set({
-                'Content-Type': 'text/csv',
-                'Content-Disposition': 'attachment; filename=surveyRun-'+id+'-responses.csv'
+            var url = '_design/responses/_view/by_surveyrun?key='+JSON.stringify(id);
+            couch.get(url).then(function(result){
+                var responses = _.map(result.rows, function(item) { return item.value; });
+                var flatResponses = responsesToVariables(responses);
+                res.set({
+                    'Content-Type': 'text/csv',
+                    'Content-Disposition': 'attachment; filename=surveyRun-'+id+'-responses.csv'
+                });
+                res.status(200);
+                writeObjectsToCSVStream(flatResponses, res);
+                res.end();
+            }, function(error){
+                res.send(404, {error: "Cannot find responses for survey run "+id});
             });
-            res.send(200, "Response for surveyRun "+id);
         });
     
@@ -116 +128 @@
 
 };
+
+function responsesToVariables(responses) {
+    return _.map(responses, responseToVariables);
+}
+
+function responseToVariables(response) {
+    var result = flattenObject(response.answers);
+    result.respondent = response.id;
+    return result;
+}
+
+function flattenObject(value) {
+    var result = {};
+    (function agg(val,key,res){
+        if ( _.isObject(val) ) {
+            _.forEach(val, function(v,k){
+                agg(v,(key ? key+'.' : '')+k,res);
+            });
+        } else if ( _.isArray(val) ) {
+            _.forEach(val, function(v,i){
+                agg(v,(key ? key+'.' : '')+i,res);
+            });
+        } else {
+            res[key] = val;
+        }
+    })(value,null,result);
+    return result;
+}
+
+function writeObjectsToCSVStream(objects, stream) {
+    var keys = _.chain(objects)
+                .map(_.keys)
+                .flatten()
+                .uniq()
+                .value();
+    var idxs = {};
+    _.forEach(keys, function(key,idx){
+        idxs[key] = idx;
+    });
+    var writer = new CSV.CsvWriter(stream);
+    writer.writeRecord(keys);
+    _.forEach(objects, function(obj){
+        var row = [];
+        _.forEach(obj, function(val,key){
+            row[idxs[key]] = val;
+        });
+        writer.writeRecord(row);
+    });
+}

Dev/trunk/src/server/config/config-couchdb.js

@@ -1 @@
-var q = require('q'),
-    request = require('../util/q-request'),
-    _ = require('underscore'),
-    util = require('util');
+var Q = require('q')
+  , request = require('../util/q-request')
+  , _ = require('underscore')
+  , CouchDB = require('../util/couch').CouchDB
+  , util = require('util');
 
 var designDocs = require('./couchdb-design-docs');
 
 module.exports = function(couchDbURL) {
-
-    function stringifyFunctions(value) {
-        if ( value === null ) {
-            return null;
-        } else if ( _.isArray(value) ) {
-            return value;
-        } else if ( _.isFunction(value) ) {
-            return value.toString();
-        } else if ( _.isObject(value) ) {
-            value = _.clone(value);
-            _.each(value, function(propValue, propName){
-                value[propName] = stringifyFunctions(propValue);
-            });
-            return value;
-        } else {
-            return value;
-        }
-    }
-
-    function dbRequest(method,path,content) {
-        var url = couchDbURL+path;
-        var options = {
-            method: method,
-            headers: {
-                'content-type': 'application/json; charset=utf-8',
-                'accept': 'application/json'
-            },
-            body: JSON.stringify(content)
-        };
-        //console.log('req',url,options);
-        return request(url,options).then(function(res){
-            return JSON.parse(res);
-        }, function(err){
-            return JSON.parse(err);
-        });
-    }
+    var server = new CouchDB(couchDbURL);
 
     console.log("Configuring CouchDB for QED");
     console.log("Checking CouchDB version");
-    return dbRequest('GET','')
-    .then(function(res){
-        if (res.version !== "1.2.0" ) {
-            console.log("Found "+res.version+", only tested with CouchDB 1.2.0");
+    return server.get('')
+    .then(function(info){
+        if (info.version !== "1.2.0" ) {
+            console.log("Found "+info.version+", only tested with CouchDB 1.2.0");
         } else {
             console.log("CouchDB 1.2.0 found");
@@ -55 +21 @@
     }).then(function(res){
         console.log("Checking database 'qed'");
-        return dbRequest('GET','qed')
-        .then(function(res){
+        return server.get('qed')
+        .then(function(db){
             console.log("Database 'qed' found.");
         },function(err){
             console.log("Creating database 'qed'");
-            return dbRequest('PUT','qed');
+            return server.put('qed');
         });
     }).then(function(){
         console.log("Putting documents in database.");
-        designDocs = stringifyFunctions(designDocs);
-        return q.all(_.map(designDocs, function(doc,docUrl){
+        return _.reduce(designDocs, function(memo, doc, docUrl) {
             var configAction = doc.__configAction || "replace";
             delete doc.__configAction;
@@ -71 +36 @@
             case "ignore":
                 console.log(docUrl+" ignored.");
-                break;
+                return memo;
             case "update":
                 console.log(docUrl+" updating.");
-                return dbRequest('GET',docUrl)
-                .then(function(oldDoc){
-                    _.extend(oldDoc,doc);
-                    return dbRequest('PUT',docUrl,oldDoc);
-                },function(){
-                    return dbRequest('PUT',docUrl,doc);
+                return memo.then(function(){
+                    server.get(docUrl)
+                    .then(function(oldDoc){
+                        _.extend(oldDoc,doc);
+                        return server.put(docUrl,oldDoc);
+                    },function(){
+                        return server.put(docUrl,doc);
+                    });
                 });
             case "replace":
                 console.log(docUrl+" replacing.");
-                return dbRequest('GET',docUrl)
-                .then(function(oldDoc){
-                    _.extend(doc,_.pick(oldDoc,'_id','_rev'));
-                    return dbRequest('PUT',docUrl,doc);
-                },function(){
-                    return dbRequest('PUT',docUrl,doc);
+                return memo.then(function(){
+                    server.get(docUrl)
+                    .then(function(oldDoc){
+                        _.extend(doc,_.pick(oldDoc,'_id','_rev'));
+                        return server.put(docUrl,doc);
+                    },function(){
+                        return server.put(docUrl,doc);
+                    });
                 });
             default:
                 console.warn("Unknown action",configAction);
-                break;
+                return memo;
             }
-        }));
+        }, Q.resolve());
     }).then(function(results){
-        console.log("Done!");
+        console.log("Done!", results);
     },function(err){
         console.error("ERROR",err,err.stack);

Dev/trunk/src/server/heroku.js

@@ -15 +15 @@
         console.log('Listening on port',port);
     });
+}, function(error){
+    console.error(error);
 });