Changeset 487 for Dev/trunk/src/client/qed-client/pages

Timestamp:

03/05/14 22:44:48 (11 years ago)

Author:

hendrikvanantwerpen

Message:

Completed migration to API, without CouchDB proxy.

Move to API is now completed. The full API is password protected, a very
limited API is exposed for respondents, which works with secrets that
are passed in URLs.

Serverside the HTTPResult class was introduced, which is similar to
Promises, but specifically for HTTP. It carries a status code and
response and makes it easier to extract parts of async handling in
separate functions.

Fixed a bug in our schema (it seems optional attributes don't exist but
a required list does). Verification of our schema by grunt-tv4 didn't
work yet. Our schema is organized the wrong way (this is fixable),
but the json-schema schema has problems with simple types and $refs.

Location:

Dev/trunk/src/client/qed-client/pages

Files:

• previewSurvey.js (modified) (3 diffs)
• question.js (modified) (5 diffs)
• questions.js (modified) (3 diffs)
• response.js (modified) (6 diffs)
• session.js (modified) (3 diffs)
• sessions.js (modified) (7 diffs)
• survey.js (modified) (6 diffs)
• surveyRun.js (modified) (7 diffs)
• surveys.js (modified) (8 diffs)

Dev/trunk/src/client/qed-client/pages/previewSurvey.js

@@ -1 +1 @@
 define([
     "../app/Page",
-    "../store",
+    "../model/classes/surveys",
     "dojo/_base/array",
     "dojo/_base/declare",
@@ -8 +8 @@
     "require",
     "dojo/text!./templates/previewSurvey.html"
-], function(Page, store, array, declare, lang, when, require, template) {
+], function(Page, surveys, array, declare, lang, when, require, template) {
     return declare([Page],{
         contextRequire: require,
@@ -16 +16 @@
             this.inherited(arguments);
             if ( this.surveyId ) {
-                when(store.get(this.surveyId))
+                when(surveys.load(this.surveyId))
                 .then(lang.hitch(this,function(survey){
-                    this.titleNode.innerHTML = survey.title;
+                    this.titleNode.innerHTML = survey.title || "";
                     this.surveyWidget.set('survey',survey);
                 }));

Dev/trunk/src/client/qed-client/pages/question.js

@@ -3 +3 @@
     "../app/Page",
     "../app/Router",
-    "../model/classes/Question",
+    "../model/classes/questions",
     "../model/widgets/QuestionEditorPreview",
     "../model/widgets/QuestionEditorToolkit",
-    "../store",
     "../widgets/_ComplexValueMixin",
     "dojo/_base/declare",
@@ -13 +12 @@
     "dojo/when",
     "dojo/text!./templates/question.html"
-], function(Content, Page, Router, Question, QuestionEditorPreview, QuestionEditorToolkit, store, _ComplexValueMixin, declare, event, lang, when, template) {
+], function(Content, Page, Router, questions, QuestionEditorPreview, QuestionEditorToolkit, _ComplexValueMixin, declare, event, lang, when, template) {
     return declare([Page,_ComplexValueMixin], {
         templateString: template,
@@ -43 +42 @@
             }
             if (this.questionId === "new") {
-                this.set('value', Question.create());
+                this.set('value', questions.create());
             } else {
-                when(store.get(this.questionId))
+                when(questions.load(this.questionId))
                 .then(lang.hitch(this, function(value) {
                     this.set('value', value);
@@ -54 +53 @@
             this.value = value;
             this.inherited(arguments);
-            this.titleNode.innerHTML = Question.DisplayTitle.get(value);
+            this.titleNode.innerHTML = value.title || "";
         },
         _getValueAttr: function() {
@@ -63 +62 @@
         _onSave: function(evt) {
             if ( this.validate() ) {
-                var value = this.get('value');
-                store.put(value)
+                questions.save(this.get('value'))
                 .then(function() {
                     Router.go('/questions');

Dev/trunk/src/client/qed-client/pages/questions.js

@@ -1 +1 @@
 define([
-    'dojo/_base/declare',
-    'dojo/_base/Deferred',
-    'dojo/_base/event',
-    'dojo/_base/lang',
-    '../store',
-    '../app/Content',
-    '../app/Router',
-    '../app/Page',
-    '../model/widgets/TabbedQuestionBrowser',
-    'dojo/text!./templates/questions.html'
-],function(declare,Deferred,event,lang,store,Content,Router,Page,TabbedQuestionBrowser,template) {
+    "../app/Content",
+    "../app/Page",
+    "../app/Router",
+    "../model/classes/questions",
+    "../model/widgets/TabbedQuestionBrowser",
+    "dojo/_base/Deferred",
+    "dojo/_base/declare",
+    "dojo/_base/event",
+    "dojo/_base/lang",
+    "dojo/text!./templates/questions.html"
+], function(Content, Page, Router, questions, TabbedQuestionBrowser, Deferred, declare, event, lang, template) {
     return declare([Page],{
         templateString: template,
@@ -44 +44 @@
         },
         onDeleteQuestion: function(question) {
-            store.remove(store.getIdentity(question),store.getRevision(question))
+            questions.remove(question)
             .then(function(){
                 Content.notify("Question deleted.");
@@ -55 +55 @@
         },
         onPublishQuestion: function(question) {
-            question.publicationDate = store.timestamp();
-            store.put(question)
+            question.publicationDate = new Date();
+            questions.save(question)
             .then(function(){
                 Content.notify("Question published.");

Dev/trunk/src/client/qed-client/pages/response.js

@@ -3 +3 @@
     "../app/Page",
     "../lib/async",
-    "../model/classes/Response",
-    "../model/classes/Survey",
-    "../model/classes/SurveyRun",
-    "../store",
+    "../model/classes/responses",
     "dojo/_base/declare",
     "dojo/_base/event",
@@ -16 +13 @@
     "require",
     "dojo/text!./templates/response.html"
-], function(Content, Page, async, Response, Survey, SurveyRun, store, declare, event, json, lang, all, request, when, require, template) {
+], function(Content, Page, async, responses, declare, event, json, lang, all, request, when, require, template) {
     return declare([Page],{
         contextRequire: require,
@@ -28 +25 @@
             this.inherited(arguments);
             this._disableSubmit();
-            var surveyRunId = this.surveyRunId;
-            var responseId = this.options && this.options.id;
-            if ( surveyRunId && responseId ) {
-                this._loadSurveyAndResponse(surveyRunId,responseId)
-                .then(lang.hitch(this, function() {
-                    if ( this.response.publicationDate ) {
-                        this._showInfo("<div>You already submitted your survey and cannot change it anymore. You can still view your answers here.</div>");
-                        this._disableSubmit();
-                    } else {
-                        this._enableSubmit();
-                    }
-                }), lang.hitch(this,function() {
-                    this._showInfo("<div>The url seems to be incorrect, no survey found.</div>");
-                }));
+            if ( !this.response ) {
+                this._showInfo("<div>The url seems to be incorrect, no response found.</div>");
             } else {
-                throw new Error("No valid uid or survey passed!");
+                this.titleNode.innerHTML = this.response._surveyRun.survey.title || "";
+                this.surveyWidget.set('survey', this.response._surveyRun.survey);
+                this.surveyWidget.set('value', this.response.answers || {});
+                if ( this.response.publicationDate ) {
+                    this._showInfo("<div>You already submitted your survey and cannot change it anymore. You can still view your answers here.</div>");
+                    this._disableSubmit();
+                } else {
+                    this._enableSubmit();
+                }
             }
-        },
-        _loadSurveyAndResponse: function(surveyRunId,responseId){
-            return all([request.get('/api/surveyRuns/'+surveyRunId,{handleAs:'json'}),
-                        request.get('/api/responses/'+responseId,{handleAs:'json'})])
-            .then(lang.hitch(this,function(surveyAndResponse){
-                var surveyRun = surveyAndResponse[0];
-                this.response = surveyAndResponse[1];
-                if ( this.response.surveyRunId !== surveyRunId ) {
-                    throw "Survey does not match the response...";
-                }
-                this.titleNode.innerHTML = Survey.DisplayTitle.get(surveyRun.survey);
-                this.surveyWidget.set('survey', surveyRun.survey);
-                this.surveyWidget.set('value', this.response.answers || {});
-            }));
         },
         _enableSubmit: function() {
@@ -78 +57 @@
             var answers = this.surveyWidget.get('value');
             this.response.answers = answers;
-            return request.put('/api/responses/'+store.getIdentity(this.response),{
-                handleAs:'json',
-                data:json.toJson(this.response),
-                headers:{"Content-Type": "application/json"}
-            }).then(lang.hitch(this,function(res){
-                this.response._rev = res.rev;
+            return responses.putWithSecret(this.response,this.response.secret)
+            .then(lang.hitch(this,function(response){
+                this.response = response;
                 Content.notify("Your response is saved.");
             }), function(err){
@@ -90 +66 @@
         },
         _onSubmit: function(e) {
-            this.response.publicationDate = store.timestamp();
+            this.response.publicationDate = new Date();
             this._getAnswersAndSaveResponse()
             .then(lang.hitch(this,function(){
@@ -110 +86 @@
             this._disableSubmit();
             this.surveyWidget.destroy();
-            request('/api/responses/'+store.getIdentity(this.response)+'?rev='+store.getRevision(this.response),{
-                method: 'DELETE',
-                handleAs:'json',
-                data:json.toJson(this.response),
-                headers:{"Content-Type": "application/json"}
-            }).then(lang.hitch(this,function(res){
+            responses.removeWithSecret(this.response,this.response.secret)
+            .then(lang.hitch(this,function(res){
                 this._showInfo("<div>Your response has been deleted, no answers have been saved.</div>");
                 Content.notify("Your response is deleted.");

Dev/trunk/src/client/qed-client/pages/session.js

@@ -1 +1 @@
 define([
-    'dojo/_base/array',
+    /*'dojo/_base/array',
     'dojo/_base/declare',
     'dojo/_base/event',
@@ -12 +12 @@
     '../model/classes/SessionTemplate',
     '../model/widgets/AccountListView',
-    'dojo/text!./templates/session.html'
+    'dojo/text!./templates/session.html'*/
 ],function(array,declare,event,lang,when,search,store,Page,Router,ThresholdFilteringSelect,SessionTemplate,AccountListView,template){
-    return declare([Page],{
+    /*return declare([Page],{
         templateString: template,
         session: null,
@@ -92 +92 @@
 
 
-    });
+    });*/
 });
 

Dev/trunk/src/client/qed-client/pages/sessions.js

@@ -1 +1 @@
 define([
-    'dojo/_base/declare',
+    /*'dojo/_base/declare',
     'dojo/_base/lang',
     'dojo/date/stamp',
@@ -7 +7 @@
     '../app/Page',
     '../widgets/ObjectBox',
-    'dojo/text!./templates/sessions.html'
+    'dojo/text!./templates/sessions.html'*/
 ],function(declare,lang,dateStamp,store,Router,Page,ObjectBox,template){
-    return declare([Page],{
+    /*return declare([Page],{
         templateString: template,
         templateActions: null,
@@ -18 +18 @@
             this.templateActions = {
                 "Edit": function(obj){
-                    Router.go('/session/'+store.getIdentity(obj));
+                    Router.go('/session/'+obj.get('id'));
                 },
                 "Delete": lang.hitch(this,function(obj){
-                    store.remove(store.getIdentity(obj),store.getRevision(obj))
+                    obj.remove()
                     .then(lang.hitch(this,function(){
                         this._refresh();
@@ -30 +30 @@
             this.sessionActions = {
                 "Facilitate": function(obj){
-                    Router.go('run',{uid:store.getIdentity(obj)});
+                    Router.go('run',{uid: obj.get('id')});
                 },
                 "Delete": lang.hitch(this,function(obj){
-                    store.remove(store.getIdentity(obj),store.getRevision(obj))
+                    obj.remove()
                     .then(lang.hitch(this,function(){
                         this._refresh();
@@ -48 +48 @@
         },
         _refreshByType: function(type,container,actions) {
+            // FIXME
             store.query("_design/default/_view/by_type",{key:type})
             .forEach(lang.hitch(this,function(obj){
@@ -61 +62 @@
         },
         _publishSession: function(sessionTemplate) {
+            // FIXME
             var session = lang.clone(sessionTemplate);
             delete session[store.idProperty];
@@ -73 +75 @@
             }));
         }
-    });
+    });*/
 });

Dev/trunk/src/client/qed-client/pages/survey.js

@@ -2 +2 @@
     "../app/Page",
     "../app/Router",
-    "../model/classes/Survey",
+    "../model/classes/surveys",
     "../model/widgets/QuestionListView",
     "../model/widgets/TabbedQuestionBrowser",
-    "../store",
     "dojo/_base/array",
     "dojo/_base/declare",
@@ -13 +12 @@
     "require",
     "dojo/text!./templates/survey.html"
-], function(Page, Router, Survey, QuestionListView, TabbedQuestionBrowser, store, array, declare, event, lang, when, require, template) {
+], function(Page, Router, surveys, QuestionListView, TabbedQuestionBrowser, array, declare, event, lang, when, require, template) {
     return declare([Page],{
         contextRequire: require,
@@ -63 +62 @@
         _loadSurvey: function() {
             if ( this.surveyId === "new" ) {
-                this.survey = Survey.create();
+                this.survey = surveys.create();
                 this.refresh();
             } else {
-                when(store.get(this.surveyId))
+                when(surveys.load(this.surveyId))
                 .then(lang.hitch(this,function(survey){
                     this.survey = survey;
                     this.questionList.set('value',
-                                          Survey.Questions.get(this.survey));
+                                          this.survey.questions);
                     this.refresh();
                 }));
@@ -79 +78 @@
         },
         refresh: function() {
-            this.titleNode.innerHTML = Survey.DisplayTitle.get(this.survey) || "(set title in properties)";
+            this.titleNode.innerHTML = this.survey.title || "(set title in properties)";
             this.propertiesDialog.set('value',this.survey);
         },
@@ -100 +99 @@
         _onSave: function(evt) {
             this.survey.questions = this.questionList.get('value');
-            store.put(this.survey)
+            surveys.save(this.survey)
             .then(function() { 
                 Router.go('/surveys');
@@ -111 +110 @@
         },
         _onShowPreview: function() {
-            Router.go('/previewSurvey/'+store.getIdentity(this.survey),{
+            Router.go('/previewSurvey/'+this.survey._id,{
                 preview: true
             });

Dev/trunk/src/client/qed-client/pages/surveyRun.js

@@ -4 +4 @@
     "../app/Router",
     "../lib/func",
-    "../model/classes/SurveyRun",
-    "../store",
+    "../model/classes/responses",
+    "../model/classes/surveyRuns",
     "../widgets/LineWithActionsWidget",
+    "dojo/_base/array",
     "dojo/_base/declare",
     "dojo/_base/event",
@@ -13 +14 @@
     "require",
     "dojo/text!./templates/surveyRun.html"
-], function(Content, Page, Router, func, SurveyRun, store, LineWithActionsWidget, declare, event, lang, when, require, template) {
+], function(Content, Page, Router, func, responses, surveyRuns, LineWithActionsWidget, array, declare, event, lang, when, require, template) {
     return declare([Page],{
         contextRequire: require,
@@ -24 +25 @@
             if ( this.surveyRunId ) {
                 this._loadSurveyRun();
-                this._loadResponses();
             } else {
                 throw "No valid uid or survey passed!";
@@ -30 +30 @@
         },
         _loadSurveyRun: function() {
-            when(store.get(this.surveyRunId))
+            when(surveyRuns.load(this.surveyRunId))
             .then(lang.hitch(this,function(surveyRun){
                 this.surveyRun = surveyRun;
                 this.refreshSurveyRun();
+                this._loadResponses();
             }));
         },
         refreshSurveyRun: function() {
-            this.titleNode.innerHTML = SurveyRun.DisplayTitle.get(this.surveyRun);
-            this.surveySummaryWidget.set('value',SurveyRun.Survey.get(this.surveyRun));
+            this.titleNode.innerHTML = this.surveyRun.title || "";
+            this.surveySummaryWidget.set('value',this.surveyRun.survey);
             this.surveyRunWidget.set('value',this.surveyRun);
             this._onPropChange();
         },
         _loadResponses: function() {
-            when(store.query("_design/responses/_view/by_surveyrun",{key:this.surveyRunId}))
-            .forEach(lang.hitch(this,function(response){
-                var actions = {
-                    view: {
-                        callback: function(){},
-                        properties: {
-                            title: "View response"
-                        }
-                    }
-                };
-                if ( !response.publicationDate ) {
-                    actions.remove = {
-                        callback: function(){},
-                        properties: {
-                            title: "Remove response"
+            responses.query({surveyRunId:surveyRuns.getId(this.surveyRun)})
+            .then(lang.hitch(this,function(allResponses){
+                array.forEach(allResponses, function(response){
+                    var actions = {
+                        view: {
+                            callback: function(){},
+                            properties: {
+                                title: "View response"
+                            }
                         }
                     };
-                }
-                var w = new LineWithActionsWidget({
-                    actions: actions
-                });
-                var responseId = store.getIdentity(response);
-                w.set('title',this._link(this._getResponseURL(this.surveyRunId,responseId),responseId));
-                w.placeAt(this.responsesNode);
+                    if ( !response.publicationDate ) {
+                        actions.remove = {
+                            callback: function(){},
+                            properties: {
+                                title: "Remove response"
+                            }
+                        };
+                    }
+                    var w = new LineWithActionsWidget({
+                        actions: actions
+                    });
+                    var rid = responses.getId(response);
+                    w.set('title',this._link(this._buildResponseURL(response),rid),rid);
+                    w.placeAt(this.responsesNode);
+                }, this);
             }));
         },
@@ -73 +76 @@
             if ( surveyRun.mode === "open" ) {
                 this.runURLNode.innerHTML =
-                    this._link(this._getGeneralURL(store.getIdentity(this.surveyRun)));
+                    this._link(this._buildGeneralURL(this.surveyRun));
             } else {
                 this.runURLNode.innerHTML =
@@ -79 +82 @@
             }
         },
-        _getGeneralURL: function(surveyRunId) {
-            return 'response.html#!/'+surveyRunId;
+        _buildGeneralURL: function(surveyRun) {
+            return 'response.html#!/surveyRuns/'+surveyRuns.getId(surveyRun)+'!secret='+surveyRun.secret;
         },
-        _getResponseURL: function(surveyRunId,responseId) {
-            return 'response.html#!/'+surveyRunId+'!id='+responseId;
+        _buildResponseURL: function(response) {
+            return 'response.html#!/responses/'+responses.getId(response)+'!secret='+response.secret;
         },
         _link: function(url,label) {
@@ -92 +95 @@
                 lang.mixin(this.surveyRun,this.surveyRunWidget.get('value'));
 
-                var SD = SurveyRun.StartDate;
-                var ED = SurveyRun.EndDate;
-                SD.set(this.surveyRun, SD.get(this.surveyRun));
-                ED.set(this.surveyRun, ED.get(this.surveyRun));
-
-                store.put(this.surveyRun)
+                surveyRuns.save(this.surveyRun)
                 .then(function() { 
                     Router.go('/surveys');

Dev/trunk/src/client/qed-client/pages/surveys.js

@@ -1 +1 @@
 define([
-    'dojo/_base/array',
-    'dojo/_base/declare',
-    'dojo/_base/lang',
-    'dojo/when',
-    '../store',
-    '../app/Content',
-    '../app/Page',
-    '../app/Router',
-    '../model/classes/Survey',
-    '../model/classes/SurveyRun',
-    '../widgets/LineWithActionsWidget',
-    'dojo/text!./templates/surveys.html'
-],function(array,declare,lang,when,store,Content,Page,Router,Survey,SurveyRun,LineWithActionsWidget,template){
+    "../app/Content",
+    "../app/Page",
+    "../app/Router",
+    "../model/classes/surveys",
+    "../model/classes/surveyRuns",
+    "../widgets/LineWithActionsWidget",
+    "dojo/_base/array",
+    "dojo/_base/declare",
+    "dojo/_base/lang",
+    "dojo/when",
+    "dojo/text!./templates/surveys.html"
+], function(Content, Page, Router, surveys, surveyRuns, LineWithActionsWidget, array, declare, lang, when, template) {
     return declare([Page],{
         templateString: template,
@@ -25 +24 @@
         _onPublishSurvey:function(survey){
             var self = this;
-            survey.publicationDate = store.timestamp();
-            store.put(survey).then(function(){
+            survey.publicationDate = new Date();
+            surveys.save(survey)
+            .then(function(){
                 self.refreshDrafts();
                 self.refreshPublished();
@@ -35 +35 @@
         _onDeleteSurvey:function(survey){
             var self = this;
-            store.remove(store.getIdentity(survey),store.getRevision(survey))
+            surveys.remove(survey)
             .then(function(){
                 self.refreshDrafts();
@@ -43 +43 @@
         },
         _onEditSurvey:function(survey){
-            Router.go('/survey/'+store.getIdentity(survey));
+            Router.go('/survey/'+survey._id);
         },
         _onPreviewSurvey:function(survey){
-            Router.go('/previewSurvey/'+store.getIdentity(survey));
+            Router.go('/previewSurvey/'+survey._id);
         },
         _onRunSurvey:function(survey){
-            var surveyRun = SurveyRun.create();
-            SurveyRun.Survey.set(surveyRun,survey);
-            store.put(surveyRun)
+            var surveyRun = surveyRuns.create();
+            surveyRun.survey = survey;
+            surveyRuns.save(surveyRun)
             .then(lang.hitch(this,function(surveyRun){
                 this._onRunDetails(surveyRun);
@@ -59 +59 @@
         },
         _onRunDetails: function(surveyRun) {
-            Router.go('/surveyRun/'+store.getIdentity(surveyRun));
+            Router.go('/surveyRun/'+surveyRun._id);
         },
         refresh: function() {
@@ -68 +68 @@
         refreshDrafts: function() {
             this.draftsContainer.set('content','');
-            when(store.query("_design/surveys/_view/drafts"),
-                    lang.hitch(this,function(surveys) {
+            when(surveys.query({drafts:true}), lang.hitch(this,function(surveys) {
                 this.draftsTab.set('title','Drafts ('+surveys.length+')');
                 array.forEach(surveys,function(survey){
                     var w = new LineWithActionsWidget({
-                        title: Survey.DisplayTitle.get(survey) || '(unnamed)',
+                        title: survey.title || '(unnamed)',
                         actions: [{
                             callback: lang.hitch(this,'_onPublishSurvey',survey),
@@ -110 +109 @@
         refreshPublished: function() {
             this.publishedContainer.set('content','');
-            when(store.query("_design/surveys/_view/published"),
-                    lang.hitch(this, function(surveys) {
+            when(surveys.query({published:true}), lang.hitch(this, function(surveys) {
                 this.publishedTab.set('title','Published ('+surveys.length+')');
                 array.forEach(surveys,function(survey){
                     var w = new LineWithActionsWidget({
-                        title: Survey.DisplayTitle.get(survey),
+                        title: survey.title || "",
                         actions:[{
                             callback: lang.hitch(this,'_onPreviewSurvey',survey),
@@ -138 +136 @@
         refreshRuns: function() {
             this.runsContainer.set('content','');
-            when(store.query("_design/default/_view/by_type",{key:'SurveyRun'}),
-                    lang.hitch(this,function(surveyRuns){
+            when(surveyRuns.query(), lang.hitch(this,function(surveyRuns){
                 this.runsTab.set('title','Runs ('+surveyRuns.length+')');
                 array.forEach(surveyRuns,function(surveyRun){
                     var w = new LineWithActionsWidget({
-                        title: SurveyRun.DisplayTitle.get(surveyRun),
+                        title: surveyRun.title || "",
                         actions:[{
                             callback: lang.hitch(this,'_onRunDetails',surveyRun),