Merge pull request #139 from marc101101/feature/102_trim_response_data

marc101101 · web-flow · commit 7273daee79ee · 2018-09-18T17:37:37.000+02:00
Feature/102 trim response data
diff --git a/server/service/CategoriesService.js b/server/service/CategoriesService.js
@@ -3,6 +3,7 @@
 var Categories = require('../utils/database').Category;
 var knex = require('../utils/database').knex;
 var Errors = require('../utils/errors');
+var Trimmer = require('../utils/trim');
 /**
  * get all courses of a category
  * get all courses of a category
@@ -20,7 +21,7 @@ exports.categoriesCategory_idCoursesGET = function(category_id) {
           reject(Errors.notFound("GET ID " +category_id, "Category"));
         }
         let courses = category.related("courses").toJSON();
-        resolve(courses);
+        resolve(Trimmer.courses(courses));
       }))
       .catch((error) => {
         reject(error);
@@ -64,7 +65,7 @@ exports.categoriesGET = function() {
     Categories
       .fetchAll()
       .then((categories) => {
-        resolve(categories.map(item => item.attributes));
+        resolve(Trimmer.categories(categories.toJSON()));
       })
       .catch((error) => {
         reject(error);
diff --git a/server/service/CoursesService.js b/server/service/CoursesService.js
@@ -8,6 +8,7 @@ var knex = require('../utils/database').knex;
 var jwt = require('jsonwebtoken'); // used to create, sign, and verify tokens
 var Errors = require('../utils/errors');
 var moment = require('moment');
+var Trimmer = require('../utils/trim');
 
 /**
  * apply to participate in specific course
@@ -45,7 +46,7 @@ exports.coursesCourse_idApplyPOST = function (course_id, req) {
               new Applications(generateApplicationFor(user_id, course_id, areSlotsLefToParticipate))
               .save()
               .then((application) => {
-                resolve(application);
+                resolve(application.toJSON());
               })
               .catch((error) => {
                 reject(error);
@@ -106,7 +107,7 @@ exports.coursesCourse_idFeedbackPOST = function (course_id, data) {
     new CourseFeedback({...data, kurs_id: course_id})
       .save()
       .then((feedback) => {
-        resolve(feedback.attributes);
+        resolve(feedback.toJSON());
       })
       .catch((error) => {
         console.log(error);
@@ -133,7 +134,7 @@ exports.coursesCourse_idGET = function (course_id) {
         if (!course) {
           reject(Errors.notFound("GET ID " + course_id, "COURSE"));
         }
-        resolve(course.toJSON());
+        resolve(Trimmer.course(course.toJSON()));
       })
       .catch((error) => {
         reject(error);
@@ -161,11 +162,11 @@ exports.coursesCourse_idSignoffPOST = function (course_id, req) {
       .save({ANM_STAT_ID: 3}, {
         patch: true
       })
-      .then(applicationModel => {
-        if (!applicationModel) {
+      .then(application => {
+        if (!application) {
           reject(Errors.notFound("course with ID ", course_id));
         }
-        resolve(applicationModel);
+        resolve(application.toJSON());
       })
       .catch(err => {
         reject(Errors.notFound("course with ID ", course_id));
@@ -200,7 +201,7 @@ exports.coursesGET = function (query) {
     Courses
       .fetchAll({withRelated: ["location", "teacher"]})
       .then((courses) => {
-        resolve(courses.toJSON());
+        resolve(Trimmer.courses(courses.toJSON()));
       })
       .catch((error) => {
         reject(error);
@@ -222,7 +223,7 @@ exports.coursesHighlightsGET = function () {
       .where({kurs_highlight: 1})
       .fetchAll({withRelated: ["location", "teacher"]})
       .then((courses) => {
-        resolve(courses.toJSON());
+        resolve(Trimmer.courses(courses.toJSON()));
       })
       .catch((error) => {
         reject(error);
@@ -239,10 +240,12 @@ exports.coursesLastminuteGET = function() {
       })
       .fetchAll({withRelated: ["applications", "location", "teacher"]})
       .then((courses) => {
-        resolve(courses
-          .filter(item => item.related('applications').toJSON().length < item.attributes.KURS_TEIL_MAX)
-          .filter(item => item.attributes.KURS_KURSSTAT_ID === 3)
-          .map(item => item.toJSON())
+        resolve(Trimmer.courses(
+          courses
+            .filter(item => item.related('applications').toJSON().length < item.attributes.KURS_TEIL_MAX)
+            .filter(item => item.attributes.KURS_KURSSTAT_ID === 3)
+            .map(item => item.toJSON())
+          )
         )
       })
       .catch((error) => {
diff --git a/server/service/UserService.js b/server/service/UserService.js
@@ -8,6 +8,7 @@ var jwt = require('jsonwebtoken'); // used to create, sign, and verify tokens
 var bcrypt = require('bcryptjs');
 var config = require('../config'); // get config file
 var Errors = require('../utils/errors');
+var Trimmer = require('../utils/trim');
 
 /**
  * get me
@@ -25,7 +26,7 @@ exports.userMeGET = function (id) {
         if (!user) {
           reject(Errors.notFound("GET ID " + id, "USER"))
         }
-        resolve(user);
+        resolve(Trimmer.user(user.toJSON()));
       })
       .catch((error) => {
         reject(error);
@@ -41,11 +42,11 @@ exports.userMeCoursesGET = function (user_id) {
         ANM_STAT_ID: 1 || 2
       })
       .fetchAll({
-        withRelated: ["course.location", "course.teacher"]
+        withRelated: ["course.location"]
       })
       .then((applications) => {
         let courses = applications.map(item => item.related('course').toJSON());
-        resolve(courses);
+        resolve(Trimmer.courses(courses));
       })
       .catch((error) => {
         reject(error);
@@ -63,7 +64,7 @@ exports.userMeCoursesGET = function (user_id) {
  **/
 exports.userPOST = function (data) {
   return new Promise(function (resolve, reject) {
-    User.where({teil_email: data.teil_email})
+    User.where({TEIL_EMAIL  : data.TEIL_EMAIL})
       .fetch()
       .then((model) => {
           if (!model) {
@@ -75,8 +76,11 @@ exports.userPOST = function (data) {
               }, config.secret, {
                 expiresIn: 86400 // expires in 24 hours
               });
+              // for some reason, bookshelf returns TEIL_ID just as id after saving
+              let trimmedUser = Trimmer.user(user.toJSON());
+              trimmedUser.TEIL_ID = user.attributes.id;
               resolve({
-                user: user,
+                user: trimmedUser,
                 token: token
               });
             })
@@ -108,11 +112,11 @@ exports.userPUT = function (id, data) {
       .save(data, {
         patch: true
       })
-      .then(userModel => {
-        if (!userModel) {
+      .then(user => {
+        if (!user) {
           reject(Errors.notFound("PUT ID " + id, "USER"));
         }
-        resolve(userModel);
+        resolve(Trimmer.user(user.toJSON()));
       })
       .catch(err => {
         reject(err);
diff --git a/server/test/helpers/sampleData.js b/server/test/helpers/sampleData.js
@@ -619,15 +619,15 @@ if (process.env.NODE_ENV === 'test') {
 
   exports.user = () => {
     return {
-      teil_vorname: "John",
-      teil_nachname: "Doe",
-      teil_email: "johndoe@vhslq.de",
-      teil_notizen: "john's notes",
-      teil_passwort: "hunter22",
-      eingegeben_von_user: 0,
-      eingegeben_am_datum: "2018-01-01",
-      eingegeben_am_zeit: "00:00:00",
-      datenhistory: "USER_IDENTIFIER"
+      TEIL_VORNAME: "John",
+      TEIL_NACHNAME: "Doe",
+      TEIL_EMAIL: "johndoe@vhslq.de",
+      TEIL_NOTIZEN: "john's notes",
+      TEIL_PASSWORT: "hunter22",
+      EINGEGEBEN_VON_USER: 0,
+      EINGEGEBEN_AM_DATUM: "2018-01-01",
+      EINGEGEBEN_AM_ZEIT: "00:00:00",
+      DATENHISTORY: "USER_IDENTIFIER"
     }
   }
 }
diff --git a/server/test/user.js b/server/test/user.js
@@ -49,10 +49,10 @@ describe('User', () => {
       .end((err, res) => {
         res.should.have.status(200);
         res.body.should.be.a('object');
-        res.body.user.teil_vorname.should.equal(sampleUser.teil_vorname);
-        res.body.user.teil_nachname.should.equal(sampleUser.teil_nachname);
-        res.body.user.teil_email.should.equal(sampleUser.teil_email);
-        userID = res.body.user.id;
+        res.body.user.TEIL_VORNAME.should.equal(sampleUser.TEIL_VORNAME);
+        res.body.user.TEIL_NACHNAME.should.equal(sampleUser.TEIL_NACHNAME);
+        res.body.user.TEIL_EMAIL.should.equal(sampleUser.TEIL_EMAIL);
+        userID = res.body.user.TEIL_ID;
         authToken = res.body.token;
         done();
       })
@@ -73,11 +73,11 @@ describe('User', () => {
     chai.request(server)
       .put('/v1/user/me')
       .set('authorization', 'Bearer ' + authToken)
-      .send({teil_nachname: "Although"})
+      .send({TEIL_NACHNAME: "Although"})
       .end((err, res) => {
         res.should.have.status(200);
         res.body.should.be.a('object');
-        res.body.teil_nachname.should.equal("Although");
+        res.body.TEIL_NACHNAME.should.equal("Although");
         chai.request(server)
           .get('/v1/user/me')
           .set('authorization', 'Bearer ' + authToken)
@@ -92,6 +92,7 @@ describe('User', () => {
   });
   it("it should get John Doe's Courses", (done) => {
     dbHelper.User.addCoursesToSampleUser(userID).then(() => {
+
       chai.request(server)
       .get('/v1/user/me/courses')
       .set('authorization', 'Bearer ' + authToken)
@@ -107,15 +108,15 @@ describe('User', () => {
   })
   it("it should try to create a user with an already used emai and fail", (done) => {
     let user =  {
-      teil_vorname: "Peter",
-      teil_nachname: "Lustig",
-      teil_email: "johndoe@vhslq.de",
-      teil_notizen: "Peter's notes",
-      teil_passwort: "hunter22",
-      eingegeben_von_user: 0,
-      eingegeben_am_datum: "2018-01-01",
-      eingegeben_am_zeit: "00:00:00",
-      datenhistory: "Peters's data history"
+      TEIL_VORNAME: "Peter",
+      TEIL_NACHNAME: "Lustig",
+      TEIL_EMAIL: "johndoe@vhslq.de",
+      TEIL_NOTIZEN: "Peter's notes",
+      TEIL_PASSWORT: "hunter22",
+      EINGEGEBEN_VON_USER: 0,
+      EINGEGEBEN_AM_DATUM: "2018-01-01",
+      EINGEGEBEN_AM_ZEIT: "00:00:00",
+      DATENHISTORY: "Peters's data history"
     }
     chai.request(server)
       .post('/v1/user')
diff --git a/server/utils/trim.js b/server/utils/trim.js
@@ -0,0 +1,60 @@
+
+let courseFields = ["KURS_ID", "KURS_NAME", "KURS_BESCHREIBUNG", "location", "teacher"];
+let categoryFields = ["RUB_ID", "RUB_NAME", "RUB_TITEL", "RUB_TEXT"];
+let userFields = ["TEIL_ID", "TEIL_EMAIL", "TEIL_VORNAME", "TEIL_NACHNAME"];
+let locationFields = ["ORT_ID", "ORT_NAME", "ORT_STRASSE", "ORT_PLZ", "ORT_ORTSNAME"];
+
+// for testing purposes also add field DATENHISTORY to each object 
+if (process.env.NODE_ENV === 'test') {
+    courseFields.push("DATENHISTORY");
+    categoryFields.push("DATENHISTORY");
+    userFields.push("DATENHISTORY");
+    locationFields.push("DATENHISTORY");
+}
+
+let trimObject = (object, array) => {
+    return array
+    .map(item => object[item] ? {[item]: object[item]} : null)
+    .filter(item => item)
+    .reduce((old, current) => { 
+        return {...old, ...current}
+    }, {});
+};
+
+let trimCourse = (course) => {
+    let newCourse = trimObject(course, courseFields);
+    newCourse.teacher = newCourse.teacher ? trimUser(newCourse.teacher) : {};
+    newCourse.location = newCourse.location ? trimLocation(newCourse.location) : {};
+    return newCourse;
+}
+let trimCourses = (courses) => {
+    return courses.map(course => trimCourse(course));
+}
+let trimCategory = (category) => {
+    let newCategory = trimObject(category, categoryFields);
+    newCategory.courses = newCategory.courses ? trimCourses(newCategory.courses) : {};
+    return newCategory;
+}
+
+let trimCategories = (categories) => { 
+    return categories.map(category => trimCategory(category));
+}
+
+let trimUser = (user) => {
+    return trimObject(user, userFields);
+}
+let trimUsers = (users) => {
+    return users.map(user => trimUser(user));
+}
+let trimLocation = (location) => {
+    return trimObject(location, locationFields);
+}
+
+exports.course = trimCourse;
+exports.courses = trimCourses;
+
+exports.category = trimCategory;
+exports.categories = trimCategories;
+
+exports.user = trimUser;
+exports.users = trimUsers;
