Zos/Skills/@be/node_modules/node-hue-api/hue-api/commands/groups-api.js

"use strict";

//
// The Documented Phillips Hue Bridge API for groups http://www.developers.meethue.com/documentation/groups-api
//
// This module wraps up all the functionality for the definition and basic processing of the parameters for the API
// so that it can be called from the httpPromise module.
//
// The benefits of keeping all this code here is that it is much simpler to update the keep in step with the Phillips
// Hue API documentation, than having it scatter piece meal through various other classes and functions.
//

var Trait = require("traits").Trait
    , deepExtend = require("deep-extend")
    , tApiMethod = require("./traits/tApiMethod")
    , tDescription = require("./traits/tDescription")
    , tBodyArguments = require("./traits/tBodyArguments")
    , tLightStateBody = require("./traits/tLightStateBody")
    , tPostProcessing = require("./traits/tPostProcessing")
    , tErrorHandling = require("./traits/tErrorHandling")
    , ApiError = require("../errors").ApiError
    , utils = require("../utils")
    ;

var ALL_LIGHTS_NAME = "Lightset 0"
    , apiTraits = {}
    ;

/**
 * Parses the results from the All Groups request into a more useful format.
 * @param result The result from the Hue Bridge.
 * @returns {Array} An array of groups {"id": {*}, name: {*}} known to the bridge.
 * @private
 */
function processAllGroups(result) {
    var groupArray = [];

    // There is an implicit all lights group that is not returned in the results of the lookup, so explicitly add it
    groupArray.push({id: "0", name: ALL_LIGHTS_NAME, type: "LightGroup"});

    Object.keys(result).forEach(function (value) {
        groupArray.push(deepExtend({id: value}, result[value]));
    });
    return groupArray;
}

function ensureSuccessful(result) {
    if (!utils.wasSuccessful(result)) {
        throw new ApiError(utils.parseErrors(result).join(", "));
    }
    return true;
}

function processCreateGroup(result) {
    var idString;

    ensureSuccessful(result);

    idString = result[0].success.id;
    idString = idString.substr(idString.lastIndexOf("/") + 1);

    return {id: idString};
}

function processSetLightStateResult(result) {
    if (!utils.wasSuccessful(result)) {
        throw new ApiError(utils.parseErrors(result).join(", "));
    }
    return true;
}

apiTraits.getAllGroups = Trait.compose(
    tApiMethod(
        "/api/<username>/groups",
        "GET",
        "1.0",
        "Whitelist"
    ),
    tDescription("Gets a list of all groups that have been added to the bridge. A group is a list of lights that can be created, modified and deleted by a user. The maximum numbers of groups is 16. N.B. For the first bridge firmware release, bridge software version 01003542 only, a limited number of these APIs are supported in the firmware so only control of groups/0 is supported."),
    tPostProcessing(processAllGroups)
);

apiTraits.getGroupAttributes = Trait.compose(
    tApiMethod(
        "/api/<username>/groups/<id>",
        "GET",
        "1.0",
        "Whitelist"
    ),
    tDescription("Gets the name, light membership and last command for a given group.")
//    tPostProcessing(_processGroupResult) // Cannot use this as we need to inject the id we were called with
);

apiTraits.setGroupAttributes = Trait.compose(
    tApiMethod(
        "/api/<username>/groups/<id>",
        "PUT",
        "1.0",
        "Whitelist"
    ),
    tDescription("Allows the user to modify the name and light membership of a group."),
    tBodyArguments(
        "application/json",
        [
            {name: "name", type: "string", maxLength: 32, optional: true},
            {name: "lights", type: "list int", optional: true}
        ]
    ),
    tPostProcessing(ensureSuccessful)
);

apiTraits.setGroupState = Trait.compose(
    tApiMethod(
        "/api/<username>/groups/<id>/action",
        "PUT",
        "1.0",
        "Whitelist"
    ),
    tDescription("Modifies the state of all lights in a group"),
    tLightStateBody(true, true),
    tPostProcessing(processSetLightStateResult)
);

apiTraits.createGroup = Trait.compose(
    tApiMethod(
        "/api/<username>/groups",
        "POST",
        "1.0",
        "Whitelist"
    ),
    tDescription("Creates a new group containing the lights specified and optional name. A new group "
    + "is created in the bridge with the next available id. Note: For bridges < 1.4 lights must be on, otherwise "
    + "they won't be saved in the group. For 1.4 there is no such restriction."),
    tBodyArguments(
        "application/json",
        [
            {name: "name", type: "string", maxLength: 32, optional: true},
            {name: "lights", type: "list int", optional: false}
        ]
    ),
    tPostProcessing(processCreateGroup)
);

apiTraits.deleteGroup = Trait.compose(
    tApiMethod(
        "/api/<username>/groups/<id>",
        "DELETE",
        "1.0",
        "Whitelist"
    ),
    tDescription("Deletes the specified group from the bridge."),
    tPostProcessing(ensureSuccessful),
    tErrorHandling({305: "It is not allowed to update or delete group of this type"})
);


module.exports = {
    getAllGroups: Trait.create(Object.prototype, apiTraits.getAllGroups),
    getGroupAttributes: Trait.create(Object.prototype, apiTraits.getGroupAttributes),
    setGroupAttributes: Trait.create(Object.prototype, apiTraits.setGroupAttributes),
    setGroupState: Trait.create(Object.prototype, apiTraits.setGroupState),
    createGroup: Trait.create(Object.prototype, apiTraits.createGroup),
    deleteGroup: Trait.create(Object.prototype, apiTraits.deleteGroup)
};