Merge 24afc95 into 840a9bc

.babelrc

@@ -1,3 +1,13 @@
 {
-  "presets": ["env"]
+  "presets": [
+    ["env", {
+    "targets": {
+      "node": "current"
+    }
+  }]
+],
+"plugins": [
+  "transform-runtime",
+  "transform-async-to-generator"
+]
 }

config/config.js

@@ -1,3 +1,5 @@
+import { } from 'dotenv/config';
+
 module.exports = {
   development: {
     username: process.env.DB_USER,
@@ -13,14 +15,18 @@ module.exports = {
     database: process.env.TEST_DB_DATABASE,
     host: process.env.TEST_DB_HOST,
     dialect: 'postgres',
-    operatorsAliases: false
+    operatorsAliases: false,
+
   },
   production: {
     username: process.env.PROD_DB_USER,
     password: process.env.PROD_DB_PASSWORD,
     database: process.env.PROD_DB_DATABASE,
     host: process.env.PROD_DB_HOST,
     dialect: 'postgres',
+    dialectOptions: {
+      ssl: true
+    },
     operatorsAliases: false
   }
 };

controllers/ArticleController.js

@@ -87,12 +87,12 @@ class ArticleController {
   static listAllArticles(req, res, next) {
     const { page, limit } = req;
     let offset = null;
+    if (req.query.author || req.query.tag || req.query.title) return next();
 
     if (page || limit) {
     // calculate offset
       offset = limit * (page - 1);
     }
-
     return Article
       .findAll({
         include: [{
@@ -171,9 +171,7 @@ class ArticleController {
   */
   static deleteArticle(req, res, next) {
     const { slug } = req.params;
-    Article.destroy({
-      where: { slug }
-    })
+    Article.destroy({ where: { slug } })
       .then(() => res.status(200).json({ message: 'Article successfully deleted' }))
       .catch(next);
   }

controllers/UsersController.js

@@ -171,7 +171,7 @@ export default class UsersController {
   static async verifyEmail(req, res) {
     const { token } = req.params;
     try {
-      const decodedUserData = jwt.verify(token, process.env.SECRETE_KEY);
+      const decodedUserData = jwt.verify(token, process.env.SECRET_KEY);
       const userFound = await User.findOne({ where: { id: decodedUserData.id } });
       if (userFound) {
         if (userFound.isverified) {

helpers/exports.js

@@ -1,6 +1,10 @@
+import Sequelize from 'sequelize';
+import { trim, escape } from 'validator';
 import { User } from '../models';
 import sendVerificationEmail from './sendmail';
 
+const { Op } = Sequelize;
+
 exports.resendVerificationEmail = async (req, res) => {
   const { email } = req.body.user;
   try {
@@ -35,3 +39,60 @@ exports.resendVerificationEmail = async (req, res) => {
 
   }
 };
+
+/**
+  * @function searchByTagAuthorOrTitle
+  * @summary Articles can be searched by Tag, Author or TItle
+  * @param {object} req - Request object
+  * @param {object} res - Response object
+  * @returns {object} returns the list of articles matching the search criteria
+  */
+exports.searchByTagAuthorOrTitle = (req, res) => {
+  const searchParameters = {};
+  // Get every parameter and key passed in the query string
+  const keysAndValues = Object.entries(req.query);
+  let { pageNumber = 1, pageSize = 10 } = req.query;
+  pageNumber = parseInt(pageNumber, 10);
+  pageSize = parseInt(pageSize, 10);
+  if ((pageNumber < 1 || !Number.isInteger(pageNumber)) || pageSize < 10) {
+    return res.status(400).json({
+      errors: {
+        body: [
+          'Please ensure your query is an integer and pageSize is greater than 9'
+        ]
+      }
+    });
+  }
+  const limit = pageSize;
+  const offset = (pageNumber - 1) * limit;
+  const queryStringValues = Object.values(req.query);
+  let textToSearch = queryStringValues[0];
+  textToSearch = trim(escape(textToSearch));
+
+  // selects the search value from the key
+  const searchCriteria = keysAndValues[0][0];
+  if (searchCriteria === 'tag') {
+    searchParameters.where = {
+      [Op.or]: [{ tagList: { [Op.contains]: [textToSearch] } }]
+    };
+  }
+  if (searchCriteria === 'title') {
+    searchParameters.where = {
+      title: { [Op.iLike]: `%${textToSearch}%` }
+    };
+  }
+  /**
+  * set the relationship to search from the right table
+  * since the attribute to be searched for is on the right table
+  * */
+  if (searchCriteria === 'author') {
+    searchParameters.where = { username: Sequelize.where(Sequelize.col('User.username'), { [Op.eq]: `${textToSearch}` }) };
+  }
+  searchParameters.limit = limit;
+  searchParameters.offset = offset;
+  searchParameters.include = [{
+    model: User,
+    attributes: ['username'],
+  }];
+  return searchParameters;
+};

helpers/sendmail.js

@@ -3,7 +3,7 @@ import jwt from 'jsonwebtoken';
 import winston from 'winston';
 import mailtemplate from './mailtemplate';
 
-exports.sendEmail = async (userToBeVerified) => {
+exports.sendEmail = (userToBeVerified) => {
   const token = jwt.sign(
     { id: userToBeVerified.id },
     process.env.SECRET_KEY, { expiresIn: 60 * process.env.VERIFYTOKEN_EXPIRY }

helpers/utilities.js

@@ -5,7 +5,6 @@ import mailer from 'nodemailer';
 import stubTransport from 'nodemailer-stub-transport';
 import { User } from '../models';
 
-
 /**
  *  Class representing all utility functions
  *
@@ -143,12 +142,18 @@ export default class Utilities {
 
   /**
   * @function increaseCount
-  * @summary: A funtion to increase count
-  * each time an article is updated
-  * @param {Integer} count: input param
-  * @returns {Integer} number of count: for updating articles
+  * @summary: API controller to handle requests
+  * to delete an article
+  * @param {Integer} num: input param
+  * @returns {object} api response: article object for
+  * successful requests, or error object for
+  * requests that fail
   */
-  static increaseCount(count) {
-    if (Number.isInteger(count)) return count + 1;
+  static increaseCount(num) {
+    if (Number.isInteger(num)) {
+      let updateCount = num;
+      updateCount += 1;
+      return updateCount;
+    }
   }
 }

middlewares/searchArticles.js

@@ -0,0 +1,26 @@
+import models from '../models';
+import { searchByTagAuthorOrTitle } from '../helpers/exports';
+
+const { Article } = models;
+/**
+  * @function searchForArticle
+  * @summary Return a user's profile after updating it
+  * @param {object} req - Request object
+  * @param {object} res - Response object
+  * @param {objecg} next - passes error to the error handler
+  * @returns {object} An object containing all the data related to the user if update successful
+  */
+const searchForArticles = async (req, res, next) => {
+  try {
+    // query the database
+    const searchParameters = searchByTagAuthorOrTitle(req, res);
+    const articles = await Article.findAll(searchParameters);
+    if (articles.length > 0) {
+      return res.status(200).send({ articles, message: 'These are the articles found' });
+    }
+    return res.status(200).json({ message: 'No article found for your search' });
+  } catch (err) {
+    next(err);
+  }
+};
+export default searchForArticles;

package.json

@@ -64,12 +64,15 @@
     "slugify": "^1.3.0",
     "underscore": "^1.9.1",
     "validatorjs": "^3.14.2",
+    "validator": "^10.5.0",
     "winston": "^3.0.0"
   },
   "devDependencies": {
     "@types/dotenv": "^4.0.3",
     "babel-cli": "^6.26.0",
     "babel-istanbul": "^0.12.2",
+    "babel-plugin-transform-async-to-generator": "^6.24.1",
+    "babel-plugin-transform-runtime": "^6.23.0",
     "babel-preset-env": "^1.7.0",
     "eslint": "^5.2.0",
     "eslint-config-airbnb": "^17.0.0",

routes/api/articleRoutes.js

@@ -7,7 +7,7 @@ import ParamsValidator from '../../middlewares/ParamsValidator';
 import idIsInteger from '../../middlewares/idIsInteger';
 import checkArticle from '../../middlewares/checkArticle';
 import { checkCount, articleExists } from '../../middlewares/checkUser';
-
+import searchForArticles from '../../middlewares/searchArticles';
 
 const router = Router();
 
@@ -20,9 +20,8 @@ router.delete('/articles/:slug', verifyToken, articleExists, ArticleControllers.
 
 router.get('/articles/:slug', ArticleControllers.getArticle);
 
-router.get('/articles', ParamsValidator.validatePageQuery, ArticleControllers.listAllArticles);
-router.get('/articles', ArticleControllers.listAllArticles);
 router.post('/articles/:slug/like', verifyToken, ArticleControllers.likeArticle);
+router.get('/articles', ParamsValidator.validatePageQuery, ArticleControllers.listAllArticles, searchForArticles);
 
 router.put('/articles/:id/like', verifyToken, idIsInteger, checkArticle, ArticleControllers.likeArticle);