feat(sharing-article): users should be able to share an article

- create the endpoints of social networks sharing with validation as middleware
- unit test and swagger documention

[Finishes #166789890]

package.json

@@ -44,6 +44,7 @@
     "node-cron": "^2.0.3",
     "nodemailer": "^6.2.1",
     "nyc": "^14.1.1",
+    "open": "^6.4.0",
     "passport": "^0.4.0",
     "passport-facebook": "^3.0.0",
     "passport-google-oauth20": "^2.0.0",

src/controllers/shareArticleController.js

@@ -0,0 +1,66 @@
+import open from 'open';
+
+/**
+ * share article controller
+ */
+class ShareArticleManager {
+  /**
+   *
+   * @param {object} req
+   * @param {object} res
+   * @returns{object} object of response with open new email window
+   */
+  static async shareOnEmail(req, res) {
+    const { title, link } = req.article;
+    res.status(200).send({
+      message: 'Article shared on E-mail',
+      link
+    });
+    open(`mailto:?subject=${title}&body=${link}`);
+  }
+
+  /**
+   *
+   * @param {object} req
+   * @param {object} res
+   * @returns{object} object of response with open new twitter window
+   */
+  static async shareOnTwitter(req, res) {
+    const { link } = req.article;
+    res.status(200).send({
+      message: 'Article shared on Twitter',
+      link
+    });
+    open(`https://twitter.com/intent/tweet?url=${link}`);
+  }
+
+  /**
+   *
+   * @param {object} req
+   * @param {object} res
+   * @returns{object} object of response with open new facebook window
+   */
+  static async shareOnFacebook(req, res) {
+    const { link: shareLink } = req.article;
+    res.status(200).send({
+      message: 'Post shared on Facebook',
+      shareLink
+    });
+    open(`https:www.facebook.com/sharer/sharer.php?u=${shareLink}`);
+  }
+
+  /**
+   *
+   * @param {object} req
+   * @param {object} res
+   * @returns{object} object of response with open new Whatsapp window
+   */
+  static async shareOnWhatsapp(req, res) {
+    res.status(200).send({
+      message: 'Article shared on Whatsapp',
+      whatsapp: req.article.link
+    });
+    open(`https://wa.me/?text=${req.article.link}`);
+  }
+}
+export default ShareArticleManager;

src/middlewares/articleValidation.js

@@ -1,5 +1,6 @@
 import Joi from '@hapi/joi';
 import model from '../db/models/index';
+import config from '../db/config/envirnoment';
 
 const { Articles } = model;
 
@@ -48,5 +49,26 @@ class ArticleRatingValidation {
     if (!findArticle) { return res.status(404).json({ error: 'article not found' }); }
     next();
   }
+
+  /**
+    * @param {object} req
+    * @param {object} res
+    * @param {object} next
+    * @returns {Object} error message
+    */
+  static async validArticle(req, res, next) {
+    const { slug } = req.params;
+    const link = `${config.host}/articles/${slug}`;
+    const findOneArticle = await Articles
+      .findOne({ where: { slug } });
+    if (!findOneArticle) {
+      return res.status(404).send({
+        error: 'Article not found, please create an article first'
+      });
+    }
+    findOneArticle.link = link;
+    req.article = findOneArticle;
+    next();
+  }
 }
 export default ArticleRatingValidation;

src/routes/api/articles.js

@@ -1,5 +1,6 @@
 import express from 'express';
 import articleController from '../../controllers/articleController';
+import shareArticleController from '../../controllers/shareArticleController';
 import auth from '../../middlewares/auth';
 import checkUser from '../../middlewares/checkUser';
 import { multerUploads } from '../../middlewares/multer';
@@ -21,4 +22,9 @@ router.get('/ratings/:articleId', articleRatingControllers.ratingAverage);
 router.post('/articles/like/:slug', auth.checkAuthentication, articleValidation.checkSlug, likeDislikeController.likeArticle);
 router.post('/articles/dislike/:slug', auth.checkAuthentication, articleValidation.checkSlug, likeDislikeController.dislikeArticle);
 
+router.get('/articles/:slug/email-share', auth.checkAuthentication, articleValidation.validArticle, shareArticleController.shareOnEmail);
+router.get('/articles/:slug/twitter-share', auth.checkAuthentication, articleValidation.validArticle, shareArticleController.shareOnTwitter);
+router.get('/articles/:slug/facebook-share', auth.checkAuthentication, articleValidation.validArticle, shareArticleController.shareOnFacebook);
+router.get('/articles/:slug/whatsapp-share', auth.checkAuthentication, articleValidation.validArticle, shareArticleController.shareOnWhatsapp);
+
 export default router;

swagger.json

@@ -290,6 +290,20 @@
                 "type": "string"
             }
         }
+    },
+    "shareArticle": {
+        "required": [
+            "token",
+            "slug"
+        ],
+        "properties": {
+            "token": {
+                "type": "string"
+            },
+            "slug": {
+                "type": "string"
+            }
+        }
     }
   },
   "paths": {
@@ -1187,6 +1201,146 @@
             }
         }
       }
+    },
+    "/api/articles/{slug}/email-share": {
+        "get": {
+            "tags": [
+                "share article"
+            ],
+            "description": "Share article on email",
+            "parameters": [
+                {
+                    "name": "token",
+                    "in": "header",
+                    "description": "user token",
+                    "required":true,
+                    "type":"string"
+                },
+                {
+                    "name": "slug",
+                    "in": "path",
+                    "description": "Article slug",
+                    "required":true,
+                    "type":"string"
+                }
+            ],
+            "produces": [
+                "application/json"
+            ],
+            "responses": {
+                "200": {
+                    "description": "Sharing on Email",
+                    "schema": {
+                        "$ref": "#/definitions/shareArticle"
+                    }
+                }
+            }
+        }
+    },
+     "/api/articles/{slug}/twitter-share": {
+        "get": {
+            "tags": [
+                "share article"
+            ],
+            "description": "Post article on twitter",
+            "parameters": [
+                {
+                    "name": "token",
+                    "in": "header",
+                    "description": "user token",
+                    "required":true,
+                    "type":"string"
+                },
+                {
+                    "name": "slug",
+                    "in": "path",
+                    "description": "Article slug",
+                    "required":true,
+                    "type":"string"
+                }
+            ],
+            "produces": [
+                "application/json"
+            ],
+            "responses": {
+                "200": {
+                    "description": "Sharing on twitter",
+                    "schema": {
+                        "$ref": "#/definitions/shareArticle"
+                    }
+                }
+            }
+        }
+    },
+    "/api/articles/{slug}/facebook-share": {
+        "get": {
+            "tags": [
+                "share article"
+            ],
+            "description": "Post article on facebook",
+            "parameters": [
+                {
+                    "name": "token",
+                    "in": "header",
+                    "description": "user token",
+                    "required":true,
+                    "type":"string"
+                },
+                {
+                    "name": "slug",
+                    "in": "path",
+                    "description": "Article slug",
+                    "required":true,
+                    "type":"string"
+                }
+            ],
+            "produces": [
+                "application/json"
+            ],
+            "responses": {
+                "200": {
+                    "description": "Sharing on facebook",
+                    "schema": {
+                        "$ref": "#/definitions/shareArticle"
+                    }
+                }
+            }
+        }
+    },
+    "/api/articles/{slug}/whatsapp-share": {
+        "get": {
+            "tags": [
+                "share article"
+            ],
+            "description": "Share article on whatsapp",
+            "parameters": [
+                {
+                    "name": "token",
+                    "in": "header",
+                    "description": "user token",
+                    "required":true,
+                    "type":"string"
+                },
+                {
+                    "name": "slug",
+                    "in": "path",
+                    "description": "Article slug",
+                    "required":true,
+                    "type":"string"
+                }
+            ],
+            "produces": [
+                "application/json"
+            ],
+            "responses": {
+                "200": {
+                    "description": "Sharing on whatsapp",
+                    "schema": {
+                        "$ref": "#/definitions/shareArticle"
+                    }
+                }
+            }
+        }
     }
   }
 }

tests/articlesTest.js

@@ -213,4 +213,59 @@ describe('Article test', () => {
       });
     done();
   });
+
+  it('Should not share an invalid article', (done) => {
+    chai.request(index)
+      .get('/api/articles/TIA-588/facebook-share')
+      .set('token', userToken)
+      .end((err, res) => {
+        res.body.should.be.an('object');
+        res.status.should.be.equal(404);
+        done();
+      });
+  });
+
+  it('Should post an article on facebook', (done) => {
+    chai.request(index)
+      .get('/api/articles/TIA/facebook-share')
+      .set('token', userToken)
+      .end((err, res) => {
+        res.body.should.be.an('object');
+        res.status.should.be.equal(200);
+        done();
+      });
+  });
+
+  it('Should share an article on email', (done) => {
+    chai.request(index)
+      .get('/api/articles/TIA/email-share')
+      .set('token', userToken)
+      .end((err, res) => {
+        res.body.should.be.an('object');
+        res.status.should.be.equal(200);
+        done();
+      });
+  });
+
+  it('Should share an article on twitter', (done) => {
+    chai.request(index)
+      .get('/api/articles/TIA/twitter-share')
+      .set('token', userToken)
+      .end((err, res) => {
+        res.body.should.be.an('object');
+        res.status.should.be.equal(200);
+        done();
+      });
+  });
+
+  it('Should post an article on whatsapp', (done) => {
+    chai.request(index)
+      .get('/api/articles/TIA/whatsapp-share')
+      .set('token', userToken)
+      .end((err, res) => {
+        res.body.should.be.an('object');
+        res.status.should.be.equal(200);
+        done();
+      });
+  });
 });