feat: added GET /api/tags endpoint

Author: mvegter

lib/database/adapters/LogAdapter.js

@@ -12,6 +12,7 @@
  */
 
 const { Log } = require('../../domain/entities');
+const TagAdapter = require('./TagAdapter');
 
 /**
  * LogAdapter
@@ -23,20 +24,28 @@ class LogAdapter {
      * @param {Object} databaseObject Object to convert.
      * @returns {Object} Converted entity object.
      */
-    static toEntity(databaseObject) {
-        return Object.assign(new Log(), {
-            entryId: databaseObject.id,
-            authorID: 'Batman',
-            title: databaseObject.title,
-            creationTime: new Date(databaseObject.createdAt).getTime(),
-            tags: [`Tag${databaseObject.id}`, `Tag${++databaseObject.id}`],
-            origin: databaseObject.origin,
+    static toEntity({ id, title, tags, createdAt, origin, subtype }) {
+        const entityObject = Object.assign(new Log(), {
+            entryId: id,
+            authorID: 'John Doe',
+            title: title,
+            creationTime: new Date(createdAt).getTime(),
             content: [
                 { content: 'Batman wrote this...', sender: 'Batman' },
                 { content: 'Nightwing wrote this...', sender: 'Nightwing' },
                 { content: 'Gordon wrote this...', sender: 'Commissioner Gordon' },
             ],
+            origin: origin,
+            subtype: subtype,
         });
+
+        if (tags) {
+            entityObject.tags = tags.map(TagAdapter.toEntity);
+        } else {
+            entityObject.tags = [];
+        }
+
+        return entityObject;
     }
 
     /**

lib/database/adapters/TagAdapter.js

@@ -0,0 +1,39 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+/**
+ * TagAdapter
+ */
+class TagAdapter {
+    /**
+     * Converts the given database object to an entity object.
+     *
+     * @param {Object} databaseObject Object to convert.
+     * @returns {Object} Converted entity object.
+     */
+    static toEntity({ id, text }) {
+        return { id, text };
+    }
+
+    /**
+     * Converts the given entity object to a database object.
+     *
+     * @param {Object} entityObject Object to convert.
+     * @returns {Object} Converted database object.
+     */
+    static toDatabase(entityObject) {
+        return entityObject;
+    }
+}
+
+module.exports = TagAdapter;

lib/database/adapters/index.js

@@ -12,7 +12,9 @@
  */
 
 const LogAdapter = require('./LogAdapter');
+const TagAdapter = require('./TagAdapter');
 
 module.exports = {
     LogAdapter,
+    TagAdapter,
 };

lib/database/models/log.js

@@ -51,7 +51,7 @@ module.exports = (sequelize, Sequelize) => {
         Log.belongsTo(models.Log, { foreignKey: 'parent_log_id', as: 'parentLog' });
 
         Log.belongsToMany(models.Run, { through: 'log_runs' });
-        Log.belongsToMany(models.Tag, { through: 'log_tags' });
+        Log.belongsToMany(models.Tag, { as: 'tags', through: 'log_tags' });
     };
 
     return Log;

lib/database/repositories/LogRepository.js

@@ -40,11 +40,12 @@ class LogRepository {
     /**
      * Returns a specific entity.
      *
-     * @param {Number} id ID primary key of the entity to find.
+     * @param {Object} queryBuilder The QueryBuilder to use.
      * @returns {Promise|Null} Promise object representing the full mock data
      */
-    async findOneById(id) {
-        const result = await Log.findByPk(id);
+    async findOne(queryBuilder) {
+        queryBuilder.limit(1);
+        const result = await Log.findOne(queryBuilder.toImplementation());
         return result ? LogAdapter.toEntity(result) : null;
     }
 

lib/database/repositories/TagRepository.js

@@ -0,0 +1,64 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+const { TagAdapter } = require('../adapters');
+const { models: { Tag } } = require('../');
+
+/**
+ * Sequelize implementation of the TagRepository.
+ */
+class TagRepository {
+    /**
+     * Returns the total number of entities.
+     *
+     * @returns {Promise<Number>} Promise object representing the total number of entities.
+     */
+    async count() {
+        return Tag.count();
+    }
+
+    /**
+     * Returns all entities.
+     *
+     * @param {Object} queryBuilder The QueryBuilder to use.
+     * @returns {Promise} Promise object representing the full mock data
+     */
+    async findAll(queryBuilder) {
+        return Tag.findAll(queryBuilder.toImplementation()).map(TagAdapter.toEntity);
+    }
+
+    /**
+     * Returns a specific entity.
+     *
+     * @param {Object} queryBuilder The QueryBuilder to use.
+     * @returns {Promise|Null} Promise object representing the full mock data
+     */
+    async findOne(queryBuilder) {
+        queryBuilder.limit(1);
+        const result = await Tag.findOne(queryBuilder.toImplementation());
+        return result ? TagAdapter.toEntity(result) : null;
+    }
+
+    /**
+     * Insert entity.
+     *
+     * @param {Object} entity entity to insert.
+     * @returns {Promise} Promise object represents the just inserted Tag.
+     */
+    async insert(entity) {
+        const result = await Tag.create(TagAdapter.toDatabase(entity));
+        return TagAdapter.toEntity(result);
+    }
+}
+
+module.exports = new TagRepository();

lib/database/repositories/index.js

@@ -12,7 +12,9 @@
  */
 
 const LogRepository = require('./LogRepository');
+const TagRepository = require('./TagRepository');
 
 module.exports = {
     LogRepository,
+    TagRepository,
 };

lib/database/seeders/20200511151010-tags.js

@@ -0,0 +1,28 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+module.exports = {
+    up: (queryInterface, _Sequelize) => queryInterface.bulkInsert('tags', [
+        {
+            text: 'FOOD',
+        },
+        {
+            text: 'RUN',
+        },
+        {
+            text: 'MAINTENANCE',
+        },
+    ]),
+
+    down: (queryInterface, _Sequelize) => queryInterface.bulkDelete('tags', null, {}),
+};

lib/database/seeders/20200511151016-logs-tags.js

@@ -0,0 +1,27 @@
+/**
+ * @license
+ * Copyright CERN and copyright holders of ALICE O2. This software is
+ * distributed under the terms of the GNU General Public License v3 (GPL
+ * Version 3), copied verbatim in the file "COPYING".
+ *
+ * See http://alice-o2.web.cern.ch/license for full licensing information.
+ *
+ * In applying this license CERN does not waive the privileges and immunities
+ * granted to it by virtue of its status as an Intergovernmental Organization
+ * or submit itself to any jurisdiction.
+ */
+
+module.exports = {
+    up: (queryInterface, _Sequelize) => queryInterface.bulkInsert('log_tags', [
+        {
+            log_id: 3,
+            tag_id: 1,
+        },
+        {
+            log_id: 2,
+            tag_id: 2,
+        },
+    ]),
+
+    down: (queryInterface, _Sequelize) => queryInterface.bulkDelete('log_tags', null, {}),
+};

lib/database/utilities/QueryBuilder.js

@@ -22,6 +22,21 @@ class QueryBuilder {
         this.options = {};
     }
 
+    /**
+     * The numbers of items to return.
+     *
+     * @param {*} expression The include expression.
+     * @returns {Object} The current QueryBuilder instance.
+     */
+    include(expression) {
+        if (!this.options.include) {
+            this.options.include = [];
+        }
+
+        this.options.include.push(expression);
+        return this;
+    }
+
     /**
      * The numbers of items to return.
      *