footballcli/cli.js

Command Line Interface for next fixtures, live scores and more

#!/usr/bin/env node

'use strict';

const yargs = require('yargs');
const fs = require('fs');
const ora = require('ora');
const chalk = require('chalk');
const request = require('request');
const moment = require('moment');
const inquirer = require('inquirer');
const Table = require('cli-table3');
const config = require('./config');
const leagueIds = require('./leagueIds');
const helpers = require('./helpers');
const path = require('path');
const URLS = require('./constants');

const footballRequest = request.defaults({
  baseUrl: URLS.API_URL,
  headers: {
    'X-Auth-Token': config.API_KEY,
  },
});

/**
 * Get league ids url
 */
const LEAGUE_IDS_URL = URLS.LEAGUE_IDS_URL;

/**
 * Get all helpers from `helpers.js`
 */
const fixturesHelper = helpers.fixturesHelper;
const scoresHelper = helpers.scoresHelper;
const standingsHelper = helpers.standings;
const updateMessage = helpers.updateMessage;

/**
 * Command line interface code for the app
 */
const argv = yargs
  .usage('$0 <command>')
  .command('scores', 'Get scores of past and live fixtures', (yargsScores) => {
    /**
     * Get all the options set for `scores` command
     */
    const scores = yargsScores
      .usage('Usage: $0 scores [options]')
      .alias('l', 'live')
        .describe('l', 'Live scores')
        .boolean('l')
      .alias('t', 'team')
        .describe('t', 'Select team')
        .string('t')
      .example('$0 scores -t "Manchester United" -l')
      .argv;

    const spinner = ora('Fetching data').start();

    const team = (scores.t === undefined) ? '' : (scores.t).toLowerCase();

    /**
     * timeFrameStart Set start date from which fixtures is to be fetch
     * timeFrameEnd   Set end date till which fixtures is to be fetch
     * End Point for fetching all fixtures between `timeFrameStart` and `timeFrameEnd`
     */
    const timeFrameStart = moment().subtract(1, 'days').format('YYYY-MM-DD');
    const timeFrameEnd = moment().add(1, 'days').format('YYYY-MM-DD');
    const url = `fixtures?timeFrameStart=${timeFrameStart}&timeFrameEnd=${timeFrameEnd}`;

    /**
     * Creates request to fetch fixtures and show them
     * @param  {String} url:     End point from where data to be fetched
     * @return {None}            None
     */
    footballRequest(url, (err, res, body) => {
      spinner.stop();

      if (err) {
        updateMessage('REQ_ERROR');
      } else {
        scoresHelper(scores.l, team, body);
      }
    });
  })
  .command('fixtures', 'Get upcoming and past fixtures of a league and team', (yargsFixtures) => {
    /**
     * Get all the options set for `fixtures` command
     */
    const fixtures = yargsFixtures
      .usage('Usage: $0 fixtures [options]')
      .alias('d', 'days')
        .describe('d', 'Number of days from today')
        .number('d')
      .alias('l', 'league')
        .describe('l', 'League')
        .string('l')
      .alias('t', 'team')
        .describe('t', 'Team name or substring of it')
        .string('t')
      .alias('n', 'next')
        .describe('n', 'Next or upcoming matches')
        .boolean('n')
      .example('$0 fixtures -l PL -d 5 -t "Manchester United" -n')
      .argv;

    const spinner = ora('Fetching data').start();

    /**
     * days   Number of days for which data needs to be fetched
     * league League code for which data needs to be fetched
     * team   Team for which fixtures is requested
     * time   Past or present depending on flag `n` set
     */
    const days = fixtures.d || 10;
    const league = fixtures.l;
    const team = fixtures.t || '';
    const time = (fixtures.n === true) ? 'n' : 'p';

    if (days < 0) {
      updateMessage('FIX_INPUT_ERR');
    }

    /**
     * timeFrame Combination of `time` and `days` as per API requirements
     * @type {String}
     */
    const timeFrame = `${time}${days}`;

    if (league !== undefined) {
      if (leagueIds[league] === undefined) {
        spinner.stop();
        updateMessage('LEAGUE_ERR');
      }

      const id = leagueIds[league].id;
      const name = leagueIds[league].caption;

      footballRequest(`competitions/${id}/fixtures?timeFrame=${timeFrame}`, (err, res, body) => {
        spinner.stop();

        if (err) {
          updateMessage('REQ_ERROR');
        } else {
          fixturesHelper(league, name, team, body);
        }
      });
    } else {
      footballRequest(`fixtures?timeFrame=${timeFrame}`, (err, res, body) => {
        spinner.stop();

        if (err) {
          updateMessage('REQ_ERROR');
        } else {
          fixturesHelper(league, undefined, team, body);
        }
      });
    }
  })
  .command('standings', 'Get standings of particular league', (yargsStandings) => {
    /**
     * Get all the options set for `standings` command
     */
    const standings = yargsStandings
      .usage('Usage: $0 standings [options]')
      .alias('l', 'league')
        .describe('l', 'League to be searched')
        .demand('l')
      .example('$0 standings -l PL')
      .argv;

    const spinner = ora('Fetching data').start();

    const league = standings.l;

    if (leagueIds[league] === undefined) {
      spinner.stop();
      updateMessage('LEAGUE_ERR');
    }

    const id = leagueIds[league].id;

    footballRequest(`competitions/${id}/leagueTable`, (err, res, body) => {
      spinner.stop();

      if (err) {
        updateMessage('REQ_ERROR');
      } else {
        standingsHelper(body);
      }
    });
  })
  .command('lists', 'List of codes of various competitions', (yargsLists) => {
    /**
     * Get all the options set for `lists` command
     */
    const lists = yargsLists
      .usage('Usage: sudo $0 lists [options]')
      .alias('r', 'refresh')
        .describe('r', 'Refresh league ids')
        .boolean('r')
      .example('sudo $0 lists -r')
      .argv;

    const spinner = ora('Fetching data').start();
    const refreshHeaders = { 'User-Agent': 'node.js' };

    if (lists.r) {
      request({
        url: LEAGUE_IDS_URL,
        headers: refreshHeaders,
        json: true,
      }, (err, res, body) => {
        spinner.stop();

        if (err) {
          updateMessage('REQ_ERROR');
        } else {
          const newLeagueIDs = Buffer.from(body.content, 'base64').toString('utf8');
          fs.writeFileSync(
            path.resolve(__dirname, 'leagueIds.json'),
            newLeagueIDs,
            'utf8'
          );
          updateMessage('UPDATE', 'New list fetched and saved');
        }
      });
    } else {
      const table = new Table({
        head: [
          chalk.bold.white.bgBlue(' League '),
          chalk.bold.white.bgBlue(' League Code '),
        ],
        colWidths: [40, 20],
      });

      for (let league of Object.keys(leagueIds)) {
        table.push([
          chalk.bold.cyan(leagueIds[league].caption),
          chalk.bold.green(league),
        ]);
      }
      spinner.stop();
      console.log(table.toString());
    }
  })
  .command('config', 'Change configuration and defaults', (yargsConfig) => {
    /**
     * Get all the options set for `config` command
     */
    const configs = yargsConfig
      .usage('Usage: sudo $0 config')
      .example('sudo $0 config')
      .argv;

    if (configs.h) {
      return;
    }

    const questions = [{
      type: 'input',
      name: 'API_KEY',
      message: 'Enter API KEY <leave blank in case unchanged>',
    }];

    inquirer.prompt(questions).then((answers) => {
      const obj = config;

      if (answers.API_KEY !== '') {
        obj.API_KEY = answers.API_KEY;
      }

      fs.writeFileSync(path.resolve(__dirname, 'config.json'), JSON.stringify(obj, null, 2), 'utf8');
      updateMessage('UPDATE', 'API KEY has been updated.');
    }).catch((err) => {
      updateMessage('CUSTOM_ERR', 'Please run the following command with root access');
    });
  })
  .help('h')
  .alias('h', 'help')
  .version()
  .argv;