cordova-fabric-plugin/hooks/lib/utilities.js

Cordova Fabric.io Plugin

/**
 * Utilities and shared functionality for the build hooks.
 */

var path = require("path");
var fs = require("fs");

/**
 * Used to get the path to the build.gradle file for the Android project.
 *
 * @returns {string} The path to the build.gradle file.
 */
function getBuildGradlePath() {
    var target = path.join("platforms", "android", "app", "build.gradle");
    if (fs.existsSync(target)) {
        return target;
    }

    return path.join("platforms", "android", "build.gradle");
};

module.exports = {

    /**
     * Used to get the name of the application as defined in the config.xml.
     * 
     * @param {object} context - The Cordova context.
     * @returns {string} The value of the name element in config.xml.
     */
    getAppName: function(context) {
        var ConfigParser = context.requireCordovaModule("cordova-lib").configparser;
        var config = new ConfigParser("config.xml");
        return config.name();
    },

    /**
     * The ID of the plugin; this should match the ID in plugin.xml.
     */
    getPluginId: function () {
        return "cordova-fabric-plugin";
    },

    /**
     * Used to get the plugin configuration for the given platform.
     *
     * The plugin configuration object will have the API and secret keys
     * for the Fabric.io service that were specified when the plugin
     * was installed.
     *
     * This configuration is obtained from, where "ios" is the platform name:
     *    platforms/ios/ios.json
     *
     * @param {string} platform - The platform to get plugin configuration for, either "ios" or "android".
     * @returns {string} The path to the platform's plugin JSON configuration file.
     */
    getPluginConfig: function(platform) {

        var platformConfigPath = path.join("..", "..", "..", platform + ".json");

        var platformConfig = require(platformConfigPath);

        var pluginId = this.getPluginId();

        var apiKey = platformConfig.installed_plugins[pluginId].FABRIC_API_KEY;
        var apiSecret = platformConfig.installed_plugins[pluginId].FABRIC_API_SECRET;

        var config = {
            apiKey: apiKey,
            apiSecret: apiSecret
        };

        return config;
    },

    /**
     * Used to get the path to the XCode project's .pbxproj file.
     *
     * @param {object} context - The Cordova context.
     * @returns The path to the XCode project's .pbxproj file.
     */
    getXcodeProjectPath: function(context) {

        var appName = this.getAppName(context);

        return path.join("platforms", "ios", appName + ".xcodeproj", "project.pbxproj");
    },

    /**
     * Used to read the contents of the Android project's build.gradle file.
     *
     * @returns {string} The contents of the Android project's build.gradle file.
     */
    readBuildGradle: function() {
        return fs.readFileSync(getBuildGradlePath(), "utf-8");
    },

    /**
     * Used to write the given build.gradle contents to the Android project's
     * build.gradle file.
     *
     * @param {string} buildGradle The body of the build.gradle file to write.
     */
    writeBuildGradle: function(buildGradle) {
        fs.writeFileSync(getBuildGradlePath(), buildGradle);
    }
};