:sparkles: added membership plugin | membership service grabs memberships and list of groupings

backend/lib/plugins/membership.js

@@ -0,0 +1,33 @@
+const Objection = require('objection');
+const Schmervice = require('@hapipal/schmervice');
+
+const GroupingModel = require('../models/grouping');
+const MembershipModel = require('../models/membership');
+
+const MembershipService = require('../services/membership');
+
+const MembershipJoinRoute = require('../routes/membership/join');
+const MembershipLeaveRoute = require('../routes/membership/leave');
+const MembershipActiveRoute = require('../routes/membership/active');
+
+module.exports = {
+    name: 'membership-plugin',
+    version: '1.0.0',
+    register: async (server, options) => {
+        await server.registerModel(GroupingModel)
+        await server.registerModel(MembershipModel)
+
+        // 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(MembershipService)
+
+        await server.route(MembershipJoinRoute)
+        await server.route(MembershipLeaveRoute)
+        await server.route(MembershipActiveRoute)
+    }
+}

backend/lib/routes/membership/active.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const Joi = require('joi');
+
+const pluginConfig = {
+    handlerType: 'grouping',
+    docs: {
+        description: 'active memberships',
+        notes: 'A list of groupings with active membership'
+    }
+}
+
+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 = {
+    groupingsList: Joi.object({
+        grouping_id: Joi.number(),
+        grouping_name: Joi.string(),
+        grouping_type: Joi.string()
+    })
+}
+
+module.exports = {
+    method: 'GET',
+    path: '/active/{user_id}',
+    options: {
+        ...pluginConfig.docs,
+        tags: ['api'],
+        /** Protect this route with authentication? */
+        auth: false,
+
+        handler: async function (request, h) {
+            const { membershipService } = request.services()
+            const userId = request.params.user_id
+            const groupings = await membershipService.findGroupingsById(userId)
+            try {
+                return {
+                    ok: true,
+                    handler: pluginConfig.handlerType,
+                    data: groupings
+                }
+            }
+            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.groupingsList),
+            })
+        }
+    }
+}

backend/lib/routes/membership/join.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const Joi = require('joi');
+
+const pluginConfig = {
+    handlerType: 'grouping',
+    docs: {
+        description: 'join',
+        notes: 'Join a grouping by creating a membership record'
+    }
+}
+
+const validators = {
+    join: {
+        payload: Joi.object()
+    }
+}
+
+module.exports = {
+    method: 'POST',
+    path: '/join',
+    options: {
+        ...pluginConfig.docs,
+        tags: ['api'],
+        auth: false,
+        handler: async function (request, h) {
+            try {
+                return {
+                    ok: true,
+                    handler: pluginConfig.handlerType,
+                    data: { foo: 'bar' }
+                }
+            }
+            catch(err) {
+                return {
+                    ok: false,
+                    handler: pluginConfig.handlerType,
+                    data: { error: `${err}` },
+                }
+            }
+        },
+        validate: validators.join,
+        response: {
+            schema: Joi.object({
+                ok: Joi.bool(),
+                handler: Joi.string(),
+                data: validators.join
+            }),
+            failAction: 'log'
+        }
+    }
+}

backend/lib/routes/membership/leave.js

@@ -0,0 +1,52 @@
+'use strict';
+
+const Joi = require('joi');
+
+const pluginConfig = {
+    handlerType: 'grouping',
+    docs: {
+        description: 'leave',
+        notes: 'Leave a grouping by creating a membership record'
+    }
+}
+
+const validators = {
+    leave: {
+        payload: Joi.object()
+    }
+}
+
+module.exports = {
+    method: 'POST',
+    path: '/leave',
+    options: {
+        ...pluginConfig.docs,
+        tags: ['api'],
+        auth: false,
+        handler: async function (request, h) {
+            try {
+                return {
+                    ok: true,
+                    handler: pluginConfig.handlerType,
+                    data: { foo: 'bar' }
+                }
+            }
+            catch(err) {
+                return {
+                    ok: false,
+                    handler: pluginConfig.handlerType,
+                    data: { error: `${err}` },
+                }
+            }
+        },
+        validate: validators.leave,
+        response: {
+            schema: Joi.object({
+                ok: Joi.bool(),
+                handler: Joi.string(),
+                data: validators.leave
+            }),
+            failAction: 'log'
+        }
+    }
+}

backend/lib/services/membership.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const Schmervice = require('@hapipal/schmervice');
+
+module.exports = class MembershipService extends Schmervice.Service {
+    constructor(...args) {
+        super(...args)
+    }
+    async findGroupingsById(id) {
+        const { Membership, Grouping } = this.server.models()
+
+        /** Grab every Membership associated with this id */
+        const allMemberships = await Membership.query()
+            .throwIfNotFound()
+            .where('user_id', id)
+
+        /** Copy a list of the just the Groupings */
+        const groupingIdsToGrab = allMemberships.map(membership => membership.grouping_id)
+
+        /** Uncomment to dedupe the list just in case */
+        const dedupedGroupings = [...new Set(groupingIdsToGrab)]
+
+        /** Grab just the Groupings this id has a Membership for */
+        return await Grouping.query()
+            .throwIfNotFound()
+            .whereIn('grouping_id', dedupedGroupings)
+    }
+}