Merge c6adf51 into 0524f71

server/controllers/article.js

@@ -136,6 +136,9 @@ class ArticleController {
         'totalClaps',
         'createdAt',
         'updatedAt'
+      ],
+      order: [
+        ['id', 'ASC'],
       ]
     };
 

server/controllers/articleClap.js

@@ -0,0 +1,45 @@
+import dotenv from 'dotenv';
+import db from '../database/models';
+import { response } from '../utils';
+
+const { Article, ArticleClap } = db;
+dotenv.config();
+
+/**
+ * @description Class to implement clap and unclap
+ */
+export default class ArticleClapToggle {
+  /**
+     * @description claps and retrieves claap from articles
+     * @param {object} req
+     * @param {object} res
+     * @returns {object} response object
+     */
+  static async clapToggle(req, res) {
+    const { id } = req.user;
+    const { slug } = req.params;
+
+    const getArticle = await Article.findOne({ where: { slug } });
+
+    if (!getArticle) response(res).notFound({ message: 'article not found' });
+
+    else if (getArticle.userId === id) response(res).forbidden({ message: 'you cannot rate your own article' });
+
+    else {
+      const clap = await ArticleClap.findOrCreate({
+        where: { userId: id, articleId: getArticle.id },
+        defaults: { clap: true }
+      });
+
+      if (clap[1] === true) response(res).created({ message: 'you just clapped for this article' });
+
+      else {
+        await ArticleClap.destroy({
+          where: { userId: id, articleId: getArticle.id }
+        });
+
+        response(res).success({ message: 'you just retrieved your clap' });
+      }
+    }
+  }
+}

server/controllers/index.js

@@ -2,7 +2,8 @@ import Users from './user';
 import ArticleController from './article';
 import Comment from './articleComment';
 import Follow from './follow';
+import ArticleClap from './articleClap';
 
 export {
-  Users, ArticleController, Follow, Comment
+  Users, ArticleController, Comment, Follow, ArticleClap
 };

server/database/migrations/20190305175826-create-article-clap.js

@@ -0,0 +1,30 @@
+/* eslint no-unused-vars: "off" */
+
+module.exports = {
+  up: (queryInterface, Sequelize) => queryInterface.createTable('ArticleClaps', {
+    id: {
+      allowNull: false,
+      autoIncrement: true,
+      primaryKey: true,
+      type: Sequelize.INTEGER
+    },
+    userId: {
+      type: Sequelize.INTEGER
+    },
+    articleId: {
+      type: Sequelize.INTEGER
+    },
+    clap: {
+      type: Sequelize.BOOLEAN
+    },
+    createdAt: {
+      allowNull: false,
+      type: Sequelize.DATE
+    },
+    updatedAt: {
+      allowNull: false,
+      type: Sequelize.DATE
+    }
+  }),
+  down: (queryInterface, Sequelize) => queryInterface.dropTable('ArticleClaps')
+};

server/database/models/article.js

@@ -26,6 +26,11 @@ export default (sequelize, DataTypes) => {
     Article.hasMany(models.ArticleComment, {
       foreignKey: 'id',
     });
+
+    Article.hasMany(models.ArticleClap, {
+      foreignKey: 'articleId',
+      as: 'claps'
+    });
   };
   return Article;
 };

server/database/models/articleclap.js

@@ -0,0 +1,30 @@
+export default (sequelize, DataTypes) => {
+  const ArticleClap = sequelize.define('ArticleClap', {
+    userId: {
+      type: DataTypes.INTEGER,
+      allowNull: false
+    },
+    articleId: {
+      type: DataTypes.INTEGER,
+      allowNull: false
+    },
+    clap: {
+      type: DataTypes.BOOLEAN,
+    }
+  }, {});
+  ArticleClap.associate = (models) => {
+    // associations can be defined here
+    const { User, Article } = models;
+
+    ArticleClap.belongsTo(User, {
+      foreignKey: 'userId',
+      onDelete: 'CASCADE'
+    });
+
+    ArticleClap.belongsTo(Article, {
+      foreignKey: 'articleId',
+      onDelete: 'CASCADE'
+    });
+  };
+  return ArticleClap;
+};

server/database/models/user.js

@@ -47,7 +47,7 @@ export default (sequelize, DataTypes) => {
     }
   }, {});
   User.associate = (models) => {
-    const { Follower } = models;
+    const { Follower, ArticleClap } = models;
     User.belongsToMany(User, {
       through: Follower,
       foreignKey: 'userId',
@@ -60,6 +60,10 @@ export default (sequelize, DataTypes) => {
       as: 'followers'
     });
 
+    User.hasMany(ArticleClap, {
+      foreignKey: 'userId',
+    });
+
     // Relations for articles.
     User.hasMany(models.Article, {
       foreignKey: 'id',

server/routes/articleClap.js

@@ -0,0 +1,10 @@
+import express from 'express';
+import { ArticleClap } from '../controllers';
+import { AuthenticateUser } from '../middlewares';
+
+const articleClapRoute = express.Router();
+
+// Article toggle route
+articleClapRoute.post('/articles/:slug/clapToggle', AuthenticateUser.verifyUser, ArticleClap.clapToggle);
+
+export default articleClapRoute;

server/routes/index.js

@@ -2,11 +2,14 @@ import express from 'express';
 import articleRoutes from './articles';
 import authRoute from './users';
 import profileRoutes from './profile';
+import articleClapRoute from './articleClap';
 
 const router = express.Router();
 
 router.use(articleRoutes);
 router.use(authRoute);
 router.use(profileRoutes);
+router.use(articleClapRoute);
+
 
 export default router;

server/test/articleClap.spec.js

@@ -0,0 +1,129 @@
+import chaiHttp from 'chai-http';
+import chai, { expect } from 'chai';
+import dotenv from 'dotenv';
+import app from '../app';
+
+dotenv.config();
+
+
+const articleURL = '/api/articles';
+const signupURL = '/api/users';
+let userToken;
+let secondUserToken;
+let anArticleSlug = '';
+const data = {
+  firstUser: {
+    firstname: 'John',
+    lastname: 'Doe',
+    email: 'obiora44@gmail.com',
+    username: 'john466',
+    password: '1234567122'
+  },
+  secondUser: {
+    firstname: 'adaeze',
+    lastname: 'Doe',
+    email: 'adaezeboo@gmail.com',
+    username: 'john500',
+    password: '1234536719'
+  },
+  createArticle: {
+    title: 'some title',
+    description: 'some weird talk',
+    body: 'article body'
+  }
+};
+
+chai.use(chaiHttp);
+
+describe('Clap endpoint test', () => {
+  // SignUp first user
+  before('should create user', (done) => {
+    chai
+      .request(app)
+      .post(signupURL)
+      .send(data.firstUser)
+      .end((err, res) => {
+        userToken = res.body.user.token;
+        done();
+      });
+  });
+  // SignUp second user
+  before('should create user', (done) => {
+    chai
+      .request(app)
+      .post(signupURL)
+      .send(data.secondUser)
+      .end((err, res) => {
+        secondUserToken = res.body.user.token;
+        done();
+      });
+  });
+  // Create article
+
+  it('should create an article', (done) => {
+    chai
+      .request(app)
+      .post(articleURL)
+      .set('Authorization', `Bearer ${userToken}`)
+      .send(data.createArticle)
+      .end((err, res) => {
+        anArticleSlug = res.body.article.slug;
+        done();
+      });
+  });
+  // Test for article not found
+  it('should return 404 for article not found', (done) => {
+    chai
+      .request(app)
+      .post(`${articleURL}/somenewarticleSlug/clapToggle`)
+      .set('Authorization', `Bearer ${secondUserToken}`)
+      .end((err, res) => {
+        expect(res.status).to.equal(404);
+        expect(res.body.message).to.be.a('string');
+        expect(res.body.message).to.equal('article not found');
+        done();
+      });
+  });
+
+  // Test article clap
+  it('should like an article and return 200', (done) => {
+    chai
+      .request(app)
+      .post(`${articleURL}/${anArticleSlug}/clapToggle`)
+      .set('Authorization', `Bearer ${secondUserToken}`)
+      .end((err, res) => {
+        expect(res.status).to.equal(201);
+        expect(res.body.message).to.be.a('string');
+        expect(res.body.message).to.equal('you just clapped for this article');
+        done();
+      });
+  });
+
+  // Test for article belonging to the user
+  it('user should be unable to clap for own article', (done) => {
+    chai
+      .request(app)
+      .post(`${articleURL}/${anArticleSlug}/clapToggle`)
+      .set('Authorization', `Bearer ${userToken}`)
+      .end((err, res) => {
+        expect(res.status).to.equal(403);
+        expect(res.body.message).to.be.a('string');
+        expect(res.body.message).to.equal('you cannot rate your own article');
+        done();
+      });
+  });
+
+  // Test clap retrieval
+  it('should retrieve clap from an article and return 200', (done) => {
+    chai
+      .request(app)
+      .post(`${articleURL}/${anArticleSlug}/clapToggle`)
+      .set('Authorization', `Bearer ${secondUserToken}`)
+      .end((err, res) => {
+        expect(res.status).to.equal(200);
+        expect(res.body.message).to.be.a('string');
+        expect(res.body.message).to.equal('you just retrieved your clap');
+        done();
+      });
+  });
+});

server/test/articles.spec.js

@@ -441,7 +441,7 @@ describe('GET single article /api/articles/:slug', () => {
   it('should return 200 if article exists', (done) => {
     chai
       .request(app)
-      .get('/api/articles/this-is-an-article-3')
+      .get('/api/articles/the-second-article-3')
       .end((err, res) => {
         const { id } = res.body.messages;
         expect(res.status).to.be.equal(200);

server/test/comment.spec.js

@@ -28,15 +28,14 @@ describe('POST comment /api/articles/:id/comment', () => {
 
   it('should create a new comment', (done) => {
     chai.request(app)
-      .post('/api/articles/this-is-an-article-1/comment')
+      .post('/api/articles/this-is-an-article-2/comment')
       .set('authorization', `Bearer ${userToken}`)
       .send({
         comment: 'This is a random comment'
       })
       .end((err, res) => {
-        const { articleId, comment } = res.body.userComment;
+        const { comment } = res.body.userComment;
         expect(res.status).to.be.equal(201);
-        expect(articleId).to.be.equal(1);
         expect(comment).to.be.equal('This is a random comment');
         done(err);
       });
@@ -98,9 +97,8 @@ describe('PATCH update comment', () => {
         comment: 'This is an updated random comment'
       })
       .end((err, res) => {
-        const { articleId, comment } = res.body.userComment;
+        const { comment } = res.body.userComment;
         expect(res.status).to.be.equal(200);
-        expect(articleId).to.be.equal(1);
         expect(comment).to.be.equal('This is an updated random comment');
         done(err);
       });

server/test/index.js

@@ -3,3 +3,4 @@ import './articles.spec';
 import './comment.spec';
 import './follow.spec';
 import './profile.spec';
+import './articleClap.spec';

server/test/profile.spec.js

@@ -1,7 +1,6 @@
 import chaiHttp from 'chai-http';
 import chai, { expect } from 'chai';
 import dotenv from 'dotenv';
-// import HelperUtils from '../utils';
 import app from '../app';
 
 dotenv.config();
@@ -19,7 +18,7 @@ before('It should return a 201 and create a new user', (done) => {
   const data = {
     firstname: 'John',
     lastname: 'Doe',
-    email: 'obiora@gmail.com',
+    email: 'obiora200@gmail.com',
     username: 'john46',
     password: '12345671'
   };