fetch.js

var fs = require('fs');

var _ = require('lodash');
var moment = require('moment');
var request = require('request');

var MILLISECONDS_IN_A_DAY = 1000 * 60 * 60 * 24;
var DATE_FORMAT = 'YYYY-MM-DD';
var PROJECT_FILE = 'data/projects.js';

var TOKEN = process.env.CLUBHOUSE_API_TOKEN;

function fetchProjects(callback) {
  request({
    url: 'https://api.clubhouse.io/api/beta/projects?token=' + TOKEN,
    json: true
  }, callback);
}

function fetchCompletedStoriesForProject(projectID, callback) {
  request({
    url: 'https://api.clubhouse.io/api/beta/stories/search?token=' + TOKEN,
    method: 'POST',
    json: true,
    body: { archived: false, project_ids: [projectID], workflow_state_types: ['done'] }
  }, callback);
}

function createDateRange(fromDate, toDate) {
  var stack = [];
  var fromMoment = moment(fromDate);
  var toMoment = moment(toDate);

  while (fromMoment.isBefore(toMoment) || fromMoment.isSame(toMoment, 'days')) {
    stack.push(fromMoment.format(DATE_FORMAT));
    fromMoment = fromMoment.add(1, 'days');
  }

  return stack;
}

function storiesToCompletedTimestamps(stories) {
  return _.map(stories, function (story) {
    return new Date(story.completed_at).getTime();
  });
}

function calculateDateRangeForStories(stories) {
  var timestamps = storiesToCompletedTimestamps(stories);
  var fromDate = _.min(timestamps);
  var toDate = _.max(timestamps);

  return createDateRange(fromDate, toDate);
}

function calculateStoryRatioData(stories, dateRange) {
  var data = 'Data.StoryTypeRatios = [\n';
  var totals = {
    feature: 0,
    bug: 0,
    chore: 0,
    total: 0
  };

  _.each(dateRange, function (day) {
    _.each(stories, function (story) {
      if (story.completed_at.split('T')[0] === day) {
        // Measure by story count:
        totals[story.story_type] += 1;
        totals.total += 1;

        // Measure by points:
        // if (story.estimate) {
        //   totals[story.story_type] += story.estimate;
        // }
      }
    });
    data += '  [new Date("' + day + '"), ' + (totals.feature / totals.total) + ', ' + (totals.bug / totals.total) + ', ' + (totals.chore / totals.total) + '],\n';
  });

  data += '];\n';

  return data;
}

function calculateStoryTypeData(stories, dateRange) {
  var data = 'Data.StoryTypeData = [\n';
  var totals = {
    feature: 0,
    bug: 0,
    chore: 0
  };

  _.each(dateRange, function (day) {
    _.each(stories, function (story) {
      if (story.completed_at.split('T')[0] === day) {
        // Measure by story count:
        totals[story.story_type] += 1;

        // Measure by points:
        // if (story.estimate) {
        //   totals[story.story_type] += story.estimate;
        // }
      }
    });
    data += '  [new Date("' + day + '"), ' + totals.feature + ', ' + totals.bug + ', ' + totals.chore + '],\n';
  });

  data += '];\n';

  return data;
}

function calculateMonthlyVelocityChartData(stories, dateRange) {
  var data = 'Data.MonthlyVelocityChart = [\n';
  var velocity = 0;

  _.each(dateRange, function (day) {
    _.each(stories, function (story) {
      if (story.completed_at.split('T')[0] === day) {
        // Measure by story count:
        velocity += 1;

        // Measure by points:
        // if (story.estimate) {
        //   velocity += story.estimate;
        // }
      }
    });

    if (day.split('-')[2] === '01') {
      data += '  [new Date("' + day + '"), ' + velocity + '],\n';
      velocity = 0;
    }
  });

  data += '];\n';

  return data;
}

function calculateCycleTimeChartData(stories, dateRange) {
  var data = 'Data.CycleTimeChart = [\n';
  var cycleTimes = [];

  _.each(dateRange, function (day) {
    _.each(stories, function (story) {
      if (story.completed_at.split('T')[0] === day) {
        var cycleTime = (new Date(story.completed_at).getTime() - new Date(story.started_at).getTime()) / MILLISECONDS_IN_A_DAY;

        cycleTimes.push(cycleTime);
      }
    });

    if (day.split('-')[2] === '01') {
      data += '  [new Date("' + day + '"), ' + _.max(cycleTimes) + ', ' + _.mean(cycleTimes) + ', ' + _.min(cycleTimes) + '],\n';
      cycleTimes = [];
    }
  });

  data += '];\n';

  return data;
}

function calculateEstimateChartData(stories) {
  var estimates = { None: 0 };

  _.each(stories, function (story) {
    var estimate = _.isNumber(story.estimate) ? story.estimate : 'None';

    if (estimates[estimate]) {
      estimates[estimate]++;
    } else {
      estimates[estimate] = 1;
    }
  });

  var data = 'Data.EstimateChart = ' + JSON.stringify(estimates) + ';\n';

  return data;
}

function compileChartData(stories, project) {
  console.log('Compiling story data...');
  stories = _.sortBy(stories, function (story) {
    return new Date(story.completed_at).getTime();
  });

  var dateRange = calculateDateRangeForStories(stories);

  var data = 'var Data = {}; Data.ProjectName = "' + project.name + '"; Data.LastFetched="' + moment().format('MMMM D, YYYY') + '"; ';
  data += calculateStoryTypeData(stories, dateRange);
  data += calculateStoryRatioData(stories, dateRange);
  data += calculateMonthlyVelocityChartData(stories, dateRange);
  data += calculateCycleTimeChartData(stories, dateRange);
  data += calculateEstimateChartData(stories);

  fs.writeFileSync('data/project-' + project.id + '.js', data);
}

function saveProjectsToFile(projects) {
  var data = 'var ClubhouseProjects = [];';
  _.each(_.filter(projects, { archived: false }), function (project) {
    data += 'ClubhouseProjects.push({ id: ' + project.id + ', name: "' + project.name + '" });';
  });
  _.each(_.filter(projects, { archived: true }), function (project) {
    data += 'ClubhouseProjects.push({ id: ' + project.id + ', name: "' + project.name + ' (archived)" });';
  });
  fs.writeFileSync(PROJECT_FILE, data);
}

function fetchAndCompileChartForProject(project, callback) {
  callback = _.isFunction(callback) ? callback : _.noop;
  console.log('Fetching completed stories for project "' + project.name + '"...');

  fetchCompletedStoriesForProject(project.id, function (err, res, stories) {
    compileChartData(stories, project);
    callback();
  });
}

function fetchAndCompileChartsForAllProjects(projects) {
  var project = projects.shift();

  if (project) {
    fetchAndCompileChartForProject(project, function () {
      fetchAndCompileChartsForAllProjects(projects);
    });
  }
}

function findMatchingProjects(projects, query) {
  if (query === 'all') {
    return _.filter(projects, { archived: false });
  }

  return _.filter(projects, function (project) {
    return parseInt(query, 10) === project.id || project.name.toLowerCase().indexOf(query) === 0;
  });
}

function compileProjectData() {
  var query = process.argv[2];
  console.log('Fetching projects...');

  fetchProjects(function (err, res, projects) {
    if (err || !projects || projects.length === 0) {
      console.log('No projects found!');
      return false;
    }

    projects = _.sortBy(projects, 'name');
    saveProjectsToFile(projects);

    var foundProjects = findMatchingProjects(projects, query);
    if (!query || foundProjects.length === 0) {
      if (foundProjects.length === 0) {
        console.log('Matching project not found!');
      }
      console.log('You have access to the following projects:\n');

      projects.forEach(function (project) {
        console.log('  - ' + project.name);
      });

      return false;
    }

    fetchAndCompileChartsForAllProjects(foundProjects);
  });
}

function displayNoTokenMessage() {
  console.log('Missing CLUBHOUSE_API_TOKEN environment variable.');
  console.log('If you don\'t already have one, go to Clubhouse > Settings > Your Account > API Tokens to create one.');
  console.log('Then run this command:');
  console.log('CLUBHOUSE_API_TOKEN="MYTOKEN"');
}

function init() {
  if (!TOKEN) {
    return displayNoTokenMessage();
  }

  compileProjectData();
}

init();