ambilight/ambilight-api/commands/traits/tBodyArguments.js

An API library for Node.js that interacts with a Philips Ambilight TV.

"use strict";

var Trait = require("traits").Trait;

/**
 *
 * @param type the encoding type of the options, i.e. application/json
 * @param optionsArray The array of body options.
 * @returns {*}
 */
module.exports = function (type, optionsArray) {
    var options = {};

    optionsArray.forEach(function (opt) {
        options[opt.name] = Trait.create(Object.prototype, _createBodyArgumentTrait(opt));
    });

    return Trait(
        {
            "bodyType"     : type,
            "bodyArguments": options,

            "buildRequestBody": function (values) {
                var body = {},
                    self = this;

                Object.keys(self.bodyArguments).forEach(function (argName) {
                    var value = values ? values[argName] : undefined, // default to undefined if not set
                        arg = self.bodyArguments[argName];

                    if (self.bodyArguments.hasOwnProperty(argName)) {
                        if (arg.optional) {
                            body[argName] = value;
                        } else {
                            // We must have a value provided
                            if (!value) {
                                throw new Error("The required argument '" + argName + "' is missing a value");
                            }
                            body[argName] = value;
                        }
                        //TODO add checking on the ranges/limits etc...
                    }
                });

                return body;
            }
        }
    );
};


var _createBodyArgumentTrait = function (options) {
    var traitProperties = {
        "name"    : options.name,
        "type"    : options.type,
        "optional": options.optional
    };

    //TODO add more validation

    if (options.type === "string") {
        if (options.validValues) {
            traitProperties.validValues = options.validValues;
        }

        if (options.maxLength) {
            traitProperties.maxLength = options.maxLength;
        }

        if (options.minLength) {
            traitProperties.minLength = options.minLength;
        }
    }

    if (options.minValue !== undefined && options.maxValue !== undefined) {
        traitProperties.range = {"min": options.minValue, "max": options.maxValue};
    }

    return Trait(traitProperties);
};