versioneye-slack/index.js

Send versioneye report to slack

'use strict';

const VersionEye = require('versioneye-api-client');
const slack = require('slack-incoming-webhook');

/**
 * Class to report VersionEye's information to Slack
 */
class VersionEyeSlack {
    /**
     * Constructor
     * @param {string} versioneyeApiKey API key for VersionEye
     * @param {string} slackWebhookUrl Webhook URL for Slack
     * @param {?string=} opt_versioneyeHost Host for VersionEye (default: https://www.versioneye.com)
     * @param {?string=} opt_slackChannel Channel name for Slack
     */
    constructor(versioneyeApiKey, slackWebhookUrl, opt_versioneyeHost, opt_slackChannel) {
        this._versioneyeHost = opt_versioneyeHost || 'https://www.versioneye.com';
        this._versioneye = new VersionEye(versioneyeApiKey, this._versioneyeHost + '/api/v2');
        this._slack = slack({
            url: slackWebhookUrl,
            channel: opt_slackChannel,
            username: 'VersionEye',
            icon_url: 'https://raw.githubusercontent.com/miyajan/versioneye-slack/master/image/versioneye.png'
        });
    }

    /**
     * Post unread notifications of VersionEye to Slack
     * @return {!Promise}
     */
    postNotifications() {
        return this._versioneye.me.listNotifications().then(json => {
            const attachments = [];
            json['notifications'].forEach(notification => {
                if (notification['read']) {
                    // already read
                    return;
                }
                const productKey = notification['product']['prod_key'];
                const language = notification['product']['language'];
                const url = this._versioneyeHost + '/' + language + '/' + productKey;
                const name = notification['product']['name'];
                const version = notification['version'];
                attachments.push({
                    text: '<' + url + '|' + name + '> (' + version + ')'
                });
            });

            if (attachments.length > 0) {
                return this._postSlack('There are notifications for new releases!', {
                    attachments: attachments
                });
            }

            return Promise.resolve('no notifications');
        });
    }

    /**
     * Post a summary for the specific project
     * @param {string} projectName Project name
     * @param {string?} opt_orgName Organization Name the project is assigned to. This is required when you execute with a personal API key.
     * @return {!Promise}
     */
    postProjectSummary(projectName, opt_orgName) {
        return this._versioneye.projects.list(opt_orgName).then(json => {
            const project = json.find(project => project['name'] === projectName);

            if (!project) {
                return Promise.reject(new Error('Not found: ' + projectName));
            }

            const projectId = project['id']['$oid'];

            return this._versioneye.projects.show(projectId);
        }).then(project => {
            const projectId = project['id'];
            const url = this._versioneyeHost + '/user/projects/' + projectId;
            const outdated = project['out_number_sum'];
            const licensesRed = project['licenses_red_sum'];
            const licensesUnknown = project['licenses_unknown_sum'];
            const security = project['sv_count_sum'];

            const attachments = [];
            attachments.push({
                color: outdated > 0 ? 'danger' : 'good',
                text: 'Outdated: ' + outdated
            });
            attachments.push({
                color: licensesRed > 0 ? 'danger' : licensesUnknown > 0 ? 'warning' : 'good',
                text: 'Licenses: ' + licensesRed + ' : ' + licensesUnknown
            });
            attachments.push({
                color: security > 0 ? 'danger' : 'good',
                text: 'Security: ' + security
            });

            return this._postSlack('Project summary for <' + url + '|' + projectName + '>', {
                attachments: attachments
            });
        });
    }

    /**
     * @param {string} message Message
     * @param {!Object} opts Options
     * @return {!Promise}
     * @private
     */
    _postSlack(message, opts) {
        return new Promise((resolve, reject) => {
            // post to slack
            this._slack(message, opts, (err, response) => {
                if (err) {
                    return reject(err); // Error with message
                }
                return resolve(response); // 'ok'
            });
        });
    }
}

module.exports = VersionEyeSlack;