Merge 04cc7c6 into 60e7b73

andela · Jul 23, 2019 · 393b7b2 · 393b7b2
2 parents 60e7b73 + 04cc7c6
commit 393b7b2
Show file tree

Hide file tree

Showing 9 changed files with 138 additions and 14 deletions.
diff --git a/src/controllers/article.controller.js b/src/controllers/article.controller.js
@@ -377,7 +377,7 @@ export default {
     let { articleId } = request.params;
     articleId = parseInt(articleId, 10);
 
-    const result = await fetchRatingsService(articleId);
+    const result = await fetchRatingsService(articleId, request, response);
 
     if (result === `Article with id: ${articleId} does not exist`) {
       return Helper.failResponse(response, 404, result);
@@ -413,5 +413,15 @@ export default {
       });
     }
     if (result) return Helper.successResponse(response, 200, result);
+
+    if (result.length < 1) {
+      return Helper.successResponse(
+        response,
+        200,
+        'specified article does not have any ratings'
+      );
+    }
+
+    return Helper.successResponse(response, 200, result);
   }
 };
diff --git a/src/helpers/pagination.js b/src/helpers/pagination.js
@@ -43,7 +43,7 @@ export const pageMetadata = (page = 1, limit = 10, totalItems, entity = '') => {
           1}&limit=${pageLimit}`
       : null;
   if (page > totalPages) {
-    return 'No articles on this page';
+    return 'No content on this page';
   }
   return {
     totalItems,

diff --git a/src/routes/v1/article.route.js b/src/routes/v1/article.route.js
@@ -116,7 +116,11 @@ router
     verifyToken,
     validator('commentLike'),
     checkValidationResult,
-    likeComment
+    likeComment,
+    authorization.verifyToken,
+    validator('fetchRating'),
+    checkValidationResult,
+    articleController.fetchRatings
   );
 
 router.get(

diff --git a/src/services/article.service.js b/src/services/article.service.js
@@ -645,16 +645,29 @@ export const likeCommentService = async (slug, commentId, userId) => {
  * @param {integer} articleId
  */
 
-export const fetchRatingsService = async articleId => {
+export const fetchRatingsService = async (articleId, queryParams) => {
   const articleExist = await Article.findByPk(articleId);
 
   if (!articleExist) return `Article with id: ${articleId} does not exist`;
-
-  const ratings = await Rating.findAll({
+  const { limit, offset } = paginationQueryMetadata(
+    queryParams.query.page,
+    queryParams.query.limit
+  );
+
+  const ratings = await Rating.findAndCountAll({
+    limit,
+    offset,
     where: { articleId },
     attributes: {
       exclude: ['createdAt', 'updatedAt']
     }
   });
-  return ratings;
+  const pageResponse = pageMetadata(
+    queryParams.query.page,
+    queryParams.query.limit,
+    ratings.count,
+    `articles/${articleId}/ratings`
+  );
+  const allRatings = ratings.rows;
+  return { pageResponse, allRatings };
 };
diff --git a/src/tests/controller/article.spec.js b/src/tests/controller/article.spec.js
@@ -215,6 +215,56 @@ describe('Article API endpoints', () => {
         });
     });
 
+    it('Should successfully create an article', done => {
+      chai
+        .request(app)
+        .post(`${process.env.API_VERSION}/articles`)
+        .set({ Authorization: `Bearer ${userToken}` })
+        .field('title', 'first article')
+        .field('description', 'this is a description')
+        .field('body', 'this is a description this is a description')
+        .end((error, response) => {
+          expect(response.status).to.equal(201);
+          expect(response).to.be.an('Object');
+          expect(response.body).to.have.property('status');
+          expect(response.body).to.have.property('data');
+          expect(response.body.status).to.equal('success');
+          expect(response.body.data.title).to.equal('first article');
+          expect(response.body.data.description).to.equal(
+            'this is a description'
+          );
+          expect(response.body.data.body).to.equal(
+            'this is a description this is a description'
+          );
+          done();
+        });
+    });
+
+    it('Should successfully create an article', done => {
+      chai
+        .request(app)
+        .post(`${process.env.API_VERSION}/articles`)
+        .set({ Authorization: `Bearer ${userToken}` })
+        .field('title', 'first article')
+        .field('description', 'this is a description')
+        .field('body', 'this is a description this is a description')
+        .end((error, response) => {
+          expect(response.status).to.equal(201);
+          expect(response).to.be.an('Object');
+          expect(response.body).to.have.property('status');
+          expect(response.body).to.have.property('data');
+          expect(response.body.status).to.equal('success');
+          expect(response.body.data.title).to.equal('first article');
+          expect(response.body.data.description).to.equal(
+            'this is a description'
+          );
+          expect(response.body.data.body).to.equal(
+            'this is a description this is a description'
+          );
+          done();
+        });
+    });
+
     it('Should successfully create an article', done => {
       chai
         .request(app)
@@ -617,17 +667,37 @@ describe('Article API endpoints', () => {
     });
   });
   describe('GET single article /articles/:slug', () => {
+    it('Should successfully publish articles by user', done => {
+      chai
+        .request(app)
+        .put(
+          `${process.env.API_VERSION}/articles/publish/${secondArticle.slug}`
+        )
+        .set({ Authorization: `Bearer ${userToken}` })
+        .end((error, response) => {
+          expect(response.status).to.equal(200);
+          expect(response).to.be.an('Object');
+          expect(response.body).to.have.property('status');
+          expect(response.body).to.have.property('data');
+          expect(response.body.status).to.equal('success');
+          expect(response.body.data.message).to.equal(
+            'Article published successfully'
+          );
+          done();
+        });
+    });
+
     it('Should successfully fetch a single article', done => {
       chai
         .request(app)
-        .get(`${process.env.API_VERSION}/articles/${createdArticle.slug}`)
+        .get(`${process.env.API_VERSION}/articles/${secondArticle.slug}`)
         .end((error, response) => {
           expect(response.status).to.equal(200);
           expect(response).to.be.an('Object');
           expect(response.body).to.have.property('status');
           expect(response.body).to.have.property('data');
           expect(response.body.status).to.equal('success');
-          expect(response.body.data.title).to.equal('first article');
+          expect(response.body.data.title).to.equal('new article');
           expect(response.body.data.description).to.equal(
             'this is a description'
           );
@@ -1183,18 +1253,16 @@ describe('Article API endpoints', () => {
         .request(app)
         .get(`${API_VERSION}/articles/${article.id}/ratings`)
         .set({ Authorization: `Bearer ${userToken}` });
-
       expect(response).to.have.status(200);
       expect(response.body.status).to.equal('success');
-      expect(response.body.data[0].articleId).to.equal(article.id);
+      expect(response.body.data.allRatings[0].articleId).to.equal(article.id);
     });
 
     it('should return error for article id that is less than 1', async () => {
       const response = await chai
         .request(app)
         .get(`${API_VERSION}/articles/-1/ratings`)
         .set({ Authorization: `Bearer ${userToken}` });
-
       expect(response).to.have.status(400);
       expect(response.body.status).to.equal('fail');
       expect(response.body.data[0].msg).to.equal(
@@ -1207,7 +1275,6 @@ describe('Article API endpoints', () => {
         .request(app)
         .get(`${API_VERSION}/articles/notNumber/ratings`)
         .set({ Authorization: `Bearer ${userToken}` });
-
       expect(response).to.have.status(400);
       expect(response.body.status).to.equal('fail');
       expect(response.body.data[0].msg).to.equal('Invalid value');

diff --git a/src/tests/controller/auth.spec.js b/src/tests/controller/auth.spec.js
@@ -221,7 +221,6 @@ describe('Auth API endpoints', () => {
       expect(response.status).to.have.been.calledWith(500);
     });
   });
-
   describe('POST /users/login', () => {
     it('Should log user in successfully', async () => {
       const user = getUser();

diff --git a/src/tests/controller/stats.spec.js b/src/tests/controller/stats.spec.js
@@ -43,6 +43,13 @@ describe('Page View Count Tests', () => {
       });
   });
 
+  beforeEach(async () => {
+    await chai
+      .request(app)
+      .put(`${process.env.API_VERSION}/articles/publish/${firstArticle.slug}`)
+      .set({ Authorization: `Bearer ${userToken}` });
+  });
+
   it('Should successfully increase the view count this article by 1', done => {
     chai
       .request(app)

diff --git a/src/validators/article.validator.js b/src/validators/article.validator.js
@@ -58,6 +58,7 @@ const ArticleValidator = {
           param('articleId')
             .isNumeric({ gt: 0 })
             .not()
+            .not()
             .matches('[-, +, %]')
             .withMessage(
               'Article ID must be a number and can not be less than 1'

diff --git a/swagger.json b/swagger.json
@@ -1095,6 +1095,29 @@
           }
         }
       }
+    },
+    "get": {
+      "tags": ["Articles"],
+      "summary": "Post endpoint to rate an article",
+      "produces": ["application/json"],
+      "consumes": ["application/x-www-form-urlencoded"],
+      "parameters": [
+        {
+          "name": "articleId",
+          "in": "path",
+          "description": "id of the article's ratings to be fetched",
+          "required": true,
+          "type": "integer"
+        }
+      ],
+      "responses": {
+        "400": {
+          "description": "Error in input"
+        },
+        "401": {
+          "description": "Error with authentication"
+        }
+      }
     }
   },
   "securityDefinitions": {