Merge pull request #22 from andela/feature/166816209-rate-article

166816209 Rate an article

controllers/articles/index.js

@@ -116,7 +116,46 @@ export default {
       });
     }
   },
-
+  rateArticle: async (req, res) => {
+    const { params: { slug }, body: { rate }, user } = req;
+    try {
+      const foundArticle = await db.Article.findOne({
+        where: { slug }
+      });
+      if (!foundArticle) {
+        return res.status(404).json({
+          message: 'Article does not exist'
+        });
+      }
+      const checkRating = await db.Ratings.findOne({
+        where: {
+          userId: user.id,
+          articleId: foundArticle.id
+        }
+      });
+      if (checkRating) {
+        checkRating.update({
+          stars: rate
+        });
+        return res.status(200).json({
+          message: 'Rating updated successfully'
+        });
+      }
+      const rating = await user.createRate({
+        articleId: foundArticle.id,
+        stars: rate
+      });
+      return res.status(201).json({
+        message: 'Article rated successfully',
+        rating,
+      });
+    } catch (e) {
+      return res.status(500).json({
+        message: 'Something went wrong',
+        error: e.message
+      });
+    }
+  },
   deleteArticle: async (req, res) => {
     try {
       const data = { ...req.params };

controllers/users/index.js

@@ -24,7 +24,6 @@ export default {
         user: user.response()
       });
     } catch (e) {
-      console.log(e);
       return res.status(500).json({
         message: 'Something went wrong'
       });
@@ -80,7 +79,6 @@ export default {
         user: user.response()
       });
     } catch (e) {
-      console.log(e);
       return res.status(500).json({
         message: 'Something went wrong'
       });

db/migrations/20190708163548-create-ratings.js

@@ -0,0 +1,45 @@
+
+module.exports = {
+  up: (queryInterface, Sequelize) => queryInterface.createTable('Ratings', {
+    id: {
+      allowNull: false,
+      autoIncrement: true,
+      primaryKey: true,
+      type: Sequelize.INTEGER
+    },
+    userId: {
+      type: Sequelize.INTEGER,
+      required: true,
+      references: {
+        model: 'Users',
+        key: 'id',
+        as: 'user'
+      }
+    },
+    articleId: {
+      type: Sequelize.INTEGER,
+      required: true,
+      references: {
+        model: 'Articles',
+        key: 'id',
+        as: 'article'
+      }
+    },
+    stars: {
+      type: Sequelize.INTEGER,
+      defaultValue: null,
+      validate: { min: 0, max: 5 }
+    },
+    createdAt: {
+      allowNull: false,
+      type: Sequelize.DATE,
+      defaultValue: Sequelize.literal('NOW()')
+    },
+    updatedAt: {
+      allowNull: false,
+      type: Sequelize.DATE,
+      defaultValue: Sequelize.literal('NOW()')
+    }
+  }),
+  down: queryInterface => queryInterface.dropTable('Ratings')
+};

db/models/Ratings.js

@@ -0,0 +1,20 @@
+
+module.exports = (sequelize, DataTypes) => {
+  const Ratings = sequelize.define('Ratings', {
+    userId: DataTypes.INTEGER,
+    articleId: DataTypes.INTEGER,
+    stars: DataTypes.INTEGER
+  }, {});
+  Ratings.associate = (models) => {
+    Ratings.belongsTo(models.User, {
+      foreignKey: 'userId',
+      as: 'user'
+    });
+    Ratings.belongsTo(models.Article, {
+      foreignKey: 'articleId',
+      as: 'article',
+      cascade: true
+    });
+  };
+  return Ratings;
+};

db/models/User.js

@@ -46,11 +46,18 @@ module.exports = (sequelize, DataTypes) => {
       },
     }
   );
-  User.associate = models => User.hasMany(models.Article, {
-    foreignKey: 'userId',
-    as: 'article',
-    cascade: true,
-  });
+  User.associate = (models) => {
+    User.hasMany(models.Article, {
+      foreignKey: 'userId',
+      as: 'article',
+      cascade: true,
+    }),
+    User.hasMany(models.Ratings, {
+      foreignKey: 'userId',
+      as: 'rate',
+      cascade: true,
+    });
+  };
 
   User.prototype.passwordsMatch = function match(password) {
     return bcrypt.compare(password, this.password);

package.json

@@ -75,4 +75,4 @@
 		"cloudinary": "^1.14.0",
 		"express-fileupload": "^1.1.5"
 	}
-}
+}

routes/v1/articles.js

@@ -12,6 +12,13 @@ router.post(
   Validation.createArticle,
   Article.createArticle,
 );
+router.post(
+  '/rate/:slug',
+  Middleware.authenticate,
+  Middleware.isblackListedToken,
+  Validation.rateArticle,
+  Article.rateArticle,
+);
 router.get(
   '/:slug',
   Validation.articleSlug,

swagger.yaml

@@ -148,6 +148,39 @@ paths:
       responses:
         '201':
           description: Article created successfully
+  /articles/rate/{slug}:
+    post:
+      tags:
+        - Articles
+      summary: rate an article
+      operationId: rateArticle
+      consumes:
+        - application/json
+        - application/x-www-form-urlencoded
+      produces:
+        - application/json
+      parameters:
+        - name: "slug"
+          in: "path"
+          description: An article slug to be rated by a user
+          required: true
+          type: string
+        - name: x-access-token
+          in: header
+          description: Authorization token
+          required: true
+          type: string
+        - name: "rate"
+          in: body
+          description: A user rating
+          required: true
+          schema:
+            $ref: '#/definitions/ratings'
+      responses:
+        '201':
+          description: Article rated successfully
+        '400':
+          description: "Invalid rating supplied"
   /articles/{slug}:
     get:
       tags:
@@ -299,6 +332,15 @@ definitions:
         type: string
     xml:
       name: NewArticle
+  ratings:
+    type: object
+    required:
+      - rate
+    properties:
+      rate:
+        type: string
+    xml:
+      name: rateArticle
   UpdateProfile:
     type: object
     required:

tests/helpers.js

@@ -1,6 +1,7 @@
 /* eslint-disable require-jsdoc */
 import { db } from '../server';
 
+
 /**
  * App Middleware.
  * middleware methods.
@@ -44,17 +45,5 @@ export const createUser = async (user) => {
   return newUser;
 };
 
-export const createArticle = async (author, article) => {
-  const newUser = await createUser(author);
-  const {
-    description, body, title
-  } = article;
-  /* console.log(newUser); */
-  const newArticle = await newUser.createArticle({
-    description,
-    body,
-    title
-  });
-
-  return { newUser, newArticle };
-};
+export const createArticle = async article => db.Article.create(article);
+export const createRate = async rating => db.Ratings.create(rating);