Matterwiki/api/articles.js

/*
This file contains all endpoints related to articles.
The endpoint to display articles related to a particular topic (/topics/:id/articles)
is not in this file because that is a topics endpoint.
To avoid any confusion, here is how you filter which file should an endpoint belong to.
Check the first word in the url. If topics comes first (as it does in the above example)
then move it to the topics endpoints file.
*/


// Importing the articles model
var Articles = require('../models/article.js');
var Topics = require('../models/topic.js');
var Archives = require('../models/archive.js');

var db = require('../db.js'); //this file contains the knex file import. it's equal to knex=require('knex')

module.exports =  function(app){


  app.post('/api/articles',function(req,res){
    /*
    This endpoint takes the article title, article body, and topic id from the request body.
    It then saves those values in the database using the insert query.
    After the operation is complete the endpoint returns the success object.
    TODO: create formal guidelines for different object structures and follow that throughout the API.
    */
    Articles.forge().save({title: req.body.title, body: req.body.body, topic_id: req.body.topic_id}).then( function (result) {
        res.json({ success: true, message: 'ok' });     // responds back to request
     })
  });


  app.get('/api/articles',function(req,res){
    /*
    This is a GET endpoint that responds with the list of all the articles in the articles table
    the articles are present in the data object in the returning object.
    the error key in the returning object is a boolen which is false if there is no error and true otherwise
    */
    Articles.forge()
    .fetchAll()
      .then(function (collection) {
        res.json({error: false, data: collection.toJSON()});
      })
      .catch(function (err) {
        res.status(500).json({error: true, data: {message: err.message}});
      });
  });


  app.put('/api/articles',function(req,res){
    /*
    This is a PUT endpoint for updating an article information.
    It takes the id of the topic to be updated and then updates it with the new object.
    the error key in the returning object is a boolen which is false if there is no error and true otherwise

    TODO: Add updates only for columns that are in the request body. Handle exceptions.
    */
    Articles.forge({id: req.body.id}).fetch().then(function(article){
        Articles.forge({id: req.body.id})
          .save({title: req.body.title, body: req.body.body, topic_id: req.body.topic_id})
            .then(function() {
              Archives.forge().save({article_id: req.body.id, title: article.attributes.title, body: article.attributes.body}).then(function(){
                  res.json({ error: false, message: 'ok' });
              })
              .catch(function(err){
                res.status(500).json({error: true, data: {message: err.message}});
              })
            })
            .catch(function (err) {
              res.status(500).json({error: true, data: {message: err.message}});
            });
    }).catch(function(err){
      res.status(500).json({error: true, data: {message: err.message}});
    });
    });


  app.delete('/api/articles',function(req,res){
    /*
    This is a DELETE endpoint for delete a complete article from the database.
    It takes the id of the article and then deletes that record from the database.
    the error key in the returning object is a boolen which is false if there is no error and true otherwise
    */

    Articles.forge({id: req.body.id})
    .destroy()
      .then(function() {
        res.json({ error: false, message: 'ok' });
      })
      .catch(function (err) {
        res.status(500).json({error: true, data: {message: err.message}});
      });
  });


  app.get('/api/articles/compare',function(req,res){
    /*
    This is a GET endpoint that takes IDs of two articles as parameters.
    It then returns both the article which could then be compared with each other
    through diffing which will be done on the front-end.
    The IDs params names are:
    article1: id of the first article
    article2: id of the second article
    The article with ID article1 is the first object in the Data array.
    The article with ID article2 is the second object in the Data array.
    The error key in the returning object is a boolen which is false if there is no error and true otherwise
    */

    Articles.forge({id: req.query.article1})
    .fetch()
      .then(function (article1) {
        Articles.forge({id: req.query.article2}).fetch().then(function(article2){
          result = [];
          result.push(article1.toJSON());
          result.push(article2.toJSON());
        }).then(function(){
            res.json({error: false, data: result});
        })
      })
      .catch(function (err) {
        res.status(500).json({error: true, data: {message: err.message}});
      });
  });


  app.get('/api/articles/:id/',function(req,res){
    /*
    This is a GET endpoint that responds with one article of the specific ID (identified through the ID param)
    the article is present in the data object in the returning object.
    the error key in the returning object is a boolen which is false if there is no error and true otherwise
    */
    Articles.forge({id: req.params.id})
    .fetch()
      .then(function (article) {
        Topics.forge({id: article.attributes.id}).fetch().then(function(topic){
          articleObj = article.toJSON();
          topicObj = topic.toJSON();
          articleObj.topic = topicObj;
        }).then(function(){
            res.json({error: false, data: articleObj});
        })
      })
      .catch(function (err) {
        res.status(500).json({error: true, data: {message: err.message}});
      });
  });


  app.get('/api/articles/:id/history',function(req,res){
    /*
    This is a GET endpoint that responds with previous versions of the
    article of the specific ID (identified through the ID param).
    The article is present in the data object in the returning object.
    The error key in the returning object is a boolen which is false if there is no error and true otherwise
    */

    Articles.where({id: req.params.id}).fetch({withRelated: ['archives']}).then(function(article) {
      res.status(200).json(article.related('archives'));
    })
    .catch(function (err) {
        res.status(500).json({error: true, data: {message: err.message}});
    });
  });



}