:sparkles: added survey plugin which grabs all response questions | added profile plug which grabs profiles and responses by user

backend/lib/index.js

@@ -1,5 +1,7 @@
 const UserPlugin = require('./plugins/user')
 const MembershipPlugin = require('./plugins/membership')
+const SurveyPlugin = require('./plugins/survey')
+const ProfilePlugin = require('./plugins/profile')
 const TestPlugin = require('./plugins/example')
 
 /**
@@ -23,15 +25,23 @@ exports.plugin = {
      */
     register: async (server, options) => {
         await server.register(TestPlugin, {
-            routes: { prefix: `/example` },
+            routes: { prefix: '/example' },
         })
 
         await server.register(UserPlugin, {
-            routes: { prefix: `/user` },
+            routes: { prefix: '/user' },
         })
 
         await server.register(MembershipPlugin, {
-            routes: { prefix: `/membership` },
+            routes: { prefix: '/membership' },
+        })
+
+        await server.register(SurveyPlugin, {
+            routes: { prefix: '/survey' },
+        })
+
+        await server.register(ProfilePlugin, {
+            routes: { prefix: '/profile' },
         })
     },
 }

backend/lib/plugins/profile.js

@@ -0,0 +1,29 @@
+const Objection = require('objection')
+const Schmervice = require('@hapipal/schmervice')
+
+const ProfileModel = require('../models/profile')
+const ResponseModel = require('../models/response')
+
+const ProfileService = require('../services/profile')
+
+const ProfileProfilesRoute = require('../routes/profile/profiles')
+
+module.exports = {
+    name: 'profile-plugin',
+    version: '1.0.0',
+    register: async (server, options) => {
+        await server.registerModel(ProfileModel)
+        await server.registerModel(ResponseModel)
+
+        // Bind to global context
+        // So we can use Objection transactions
+        server.bind({
+            transaction: fn => Objection.transaction(server.knex(), fn),
+        })
+
+        await server.register(Schmervice)
+        server.registerService(ProfileService)
+
+        await server.route(ProfileProfilesRoute)
+    },
+}

backend/lib/plugins/survey.js

@@ -0,0 +1,27 @@
+const Objection = require('objection')
+const Schmervice = require('@hapipal/schmervice')
+
+const ReponseKeyModel = require('../models/response-key')
+
+const ResponseService = require('../services/response')
+
+const ResponseQuestionsRoute = require('../routes/survey/questions')
+
+module.exports = {
+    name: 'survey-plugin',
+    version: '1.0.0',
+    register: async (server, options) => {
+        await server.registerModel(ReponseKeyModel)
+
+        // Bind to global context
+        // So we can use Objection transactions
+        server.bind({
+            transaction: fn => Objection.transaction(server.knex(), fn),
+        })
+
+        await server.register(Schmervice)
+        server.registerService(ResponseService)
+
+        await server.route(ResponseQuestionsRoute)
+    },
+}

backend/lib/routes/profile/profiles.js

@@ -0,0 +1,85 @@
+'use strict'
+
+const Joi = require('joi')
+
+const pluginConfig = {
+    handlerType: 'profile',
+    docs: {
+        description: 'profiles',
+        notes: 'A list of profiles associated with this user',
+    },
+}
+
+const validators = {
+    /** Validate the header (cookie check) */
+    // headers: true,
+
+    /** Validate the route params (/active/{thing}) */
+    params: Joi.object({ user_id: Joi.number() }),
+
+    /** Validate the route query (/active/{thing}?limit=10&offset=10) */
+    // query: true,
+    /** Validate the incoming payload (POST method) */
+    // payload: true,
+}
+
+const responseSchemas = {
+    profilesList: Joi.object({
+        profile_id: Joi.number().required(),
+        user_id: Joi.number().required(),
+        responses: Joi.array().items(
+            Joi.object({
+                response_id: Joi.number().required(),
+                profile_id: Joi.number().required(),
+                response_key_id: Joi.number().required(),
+                val: Joi.string().required(),
+            }),
+        ),
+        response_keys: Joi.array(),
+    }),
+}
+
+module.exports = {
+    method: 'GET',
+    path: '/{user_id}',
+    options: {
+        ...pluginConfig.docs,
+        tags: ['api'],
+        /** Protect this route with authentication? */
+        auth: false,
+
+        handler: async function (request, h) {
+            const { profileService } = request.services()
+            const userId = request.params.user_id
+            const profiles = await profileService.getCompleteProfilesFor(userId)
+            try {
+                return {
+                    ok: true,
+                    handler: pluginConfig.handlerType,
+                    data: profiles,
+                }
+            } catch (err) {
+                return {
+                    ok: false,
+                    handler: pluginConfig.handlerType,
+                    data: { error: `${err}` },
+                }
+            }
+        },
+
+        /** Validate based on validators object */
+        validate: {
+            ...validators,
+            failAction: 'log',
+        },
+
+        /** Validate the server response */
+        response: {
+            schema: Joi.object({
+                ok: Joi.bool(),
+                handler: Joi.string(),
+                data: Joi.array().items(responseSchemas.profilesList),
+            }),
+        },
+    },
+}

backend/lib/routes/survey/questions.js

@@ -0,0 +1,72 @@
+'use strict'
+
+const Joi = require('joi')
+
+const pluginConfig = {
+    handlerType: 'survey',
+    docs: {
+        description: 'Get survey questions',
+        notes: 'Returns a list of all possible survey questions in the form of response_keys',
+    },
+}
+
+/** Validator functions by request method */
+const validators = {
+    /** Validate the header (cookie check) */
+    // headers: true,
+    /** Validate the route params (/active/{thing}) */
+    // params: true,
+    /** Validate the route query (/active/{thing}?limit=10&offset=10) */
+    // query: true,
+    /** Validate the incoming payload (POST method) */
+    // payload: true,
+}
+const responseSchemas = {
+    responseKeysList: Joi.object({
+        response_key_id: Joi.number().required(),
+        profile_id: Joi.number().required(),
+        val: Joi.string().required(),
+    }),
+}
+
+module.exports = {
+    method: 'GET',
+    path: '/questions',
+    options: {
+        ...pluginConfig.docs,
+        tags: ['api'],
+        /** Protect this route with authentication? */
+        auth: false,
+
+        handler: async function (request, h) {
+            const { responseService } = request.services()
+            const responseKeys = await responseService.getResponseKeys()
+            try {
+                return {
+                    ok: true,
+                    handler: pluginConfig.handlerType,
+                    data: responseKeys,
+                }
+            } catch (err) {
+                return {
+                    ok: false,
+                    handler: pluginConfig.handlerType,
+                    data: { error: err },
+                }
+            }
+        },
+
+        /** Validate based on validators object */
+        validate: { ...validators, failAction: 'log' },
+
+        /** Validate the server response */
+        response: {
+            schema: Joi.object({
+                ok: Joi.bool(),
+                handler: Joi.string(),
+                data: Joi.array().items(responseSchemas.responseKeysList),
+            }),
+            failAction: 'log',
+        },
+    },
+}

backend/lib/routes/survey/responses.js

@@ -0,0 +1,71 @@
+'use strict'
+
+const Joi = require('joi')
+
+const pluginConfig = {
+    handlerType: 'survey',
+    docs: {
+        description: 'Get responses to questions',
+        notes: 'Returns a list of all survey responses for a user',
+    },
+}
+
+/** Validator functions by request method */
+const validators = {
+    /** Validate the header (cookie check) */
+    // headers: true,
+    /** Validate the route params (/active/{thing}) */
+    params: Joi.object({ user_id: Joi.number() }),
+    /** Validate the route query (/active/{thing}?limit=10&offset=10) */
+    // query: true,
+    /** Validate the incoming payload (POST method) */
+    // payload: true,
+}
+const responseSchemas = {
+    responseKeysList: Joi.object({
+        response_key_id: Joi.number().required(),
+        profile_id: Joi.number().required(),
+    }),
+}
+
+module.exports = {
+    method: 'GET',
+    path: '/questions',
+    options: {
+        ...pluginConfig.docs,
+        tags: ['api'],
+        /** Protect this route with authentication? */
+        auth: false,
+
+        handler: async function (request, h) {
+            const { responseService } = request.services()
+            const responseKeys = await responseService.getResponseKeys()
+            try {
+                return {
+                    ok: true,
+                    handler: pluginConfig.handlerType,
+                    data: responseKeys,
+                }
+            } catch (err) {
+                return {
+                    ok: false,
+                    handler: pluginConfig.handlerType,
+                    data: { error: err },
+                }
+            }
+        },
+
+        /** Validate based on validators object */
+        validate: { ...validators, failAction: 'log' },
+
+        /** Validate the server response */
+        response: {
+            schema: Joi.object({
+                ok: Joi.bool(),
+                handler: Joi.string(),
+                data: Joi.array().items(responseSchemas.responseKeysList),
+            }),
+            failAction: 'log',
+        },
+    },
+}

backend/lib/services/profile.js

@@ -0,0 +1,79 @@
+const Schmervice = require('@hapipal/schmervice')
+
+module.exports = class ProfileService extends Schmervice.Service {
+    constructor(...args) {
+        super(...args)
+    }
+
+    /**
+     * Internal method to get list of profile_ids for this user
+     * @param {number} userId
+     * @returns {Array} List of all profile_ids for user
+     */
+    async _getProfileIdsForUserId(userId) {
+        const { Profile } = this.server.models()
+
+        /** Grab every Profile associated with this id */
+        const allProfiles = await Profile.query().where('user_id', userId)
+
+        /** Copy a list of the just the Profiles */
+        const profileIdsToGrab = allProfiles.map(profile => profile.profile_id)
+
+        /** Uncomment to dedupe the list just in case */
+        return [...new Set(profileIdsToGrab)]
+    }
+
+    async getCompleteProfilesFor(userId) {
+        const { Profile, Response } = this.server.models()
+
+        const dedupedProfiles = await this._getProfileIdsForUserId(userId)
+
+        const responses = await Response.query().whereIn(
+            'profile_id',
+            dedupedProfiles,
+        )
+        const profiles = await Profile.query().whereIn(
+            'profile_id',
+            dedupedProfiles,
+        )
+
+        //** Get responses asociated with each profile_id */
+        return profiles.map(profile => {
+            if (!profile.responses) profile.responses = []
+            profile.response_keys = []
+            responses.forEach(response => {
+                if (response.profile_id !== profile.profile_id) return
+                profile.response_keys.push(response.response_key_id)
+                profile.responses.push(response)
+            })
+
+            return profile
+        })
+    }
+
+    /**
+     * Save responses in a profile
+     * @param {number} userId
+     * @param {Array} responses
+     * @returns
+     */
+    async saveProfile(userId, responses, txn) {
+        console.warn(userId, responses, txn)
+    }
+    /**
+     * Delete a profile
+     * @param {number} userId
+     * @param {number} profileId
+     * @returns
+     */
+    async deleteProfile(userId, profileId) {
+        const { Profile } = this.server.models()
+
+        const dedupedGroupings = await this._getProfileIdsForUserId(userId)
+
+        /** Do NOTHING if NOT in Grouping */
+        if (!dedupedGroupings.includes(profileId)) return
+
+        return await Profile.query().delete().where('profile_id', profileId)
+    }
+}

backend/lib/services/response.js

@@ -0,0 +1,21 @@
+const Schmervice = require('@hapipal/schmervice')
+
+module.exports = class ResponseService extends Schmervice.Service {
+    constructor(...args) {
+        super(...args)
+    }
+
+    /**
+     * Internal method to get list of possible response_keys (questions)
+     * @returns {Array} List of all response_keys
+     */
+    async getResponseKeys() {
+        const { ResponseKey } = this.server.models()
+
+        /** Grab every ResponseKey */
+        const allResponseKeys = await ResponseKey.query()
+
+        /** Uncomment to dedupe the list just in case */
+        return [...new Set(allResponseKeys)]
+    }
+}