rubicon-htb.js

/**
 * @author:    Partner
 * @license:   UNLICENSED
 *
 * @copyright: Copyright (c) 2016 by Index Exchange. All rights reserved.
 *
 * The information contained within this document is confidential, copyrighted
 * and or a trade secret. No part of this document may be reproduced or
 * distributed in any form or by any means, in whole or in part, without the
 * prior written permission of Index Exchange.
 */

'use strict';

////////////////////////////////////////////////////////////////////////////////
// Dependencies ////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////

var Browser = require('browser.js');
var Classify = require('classify.js');
var Constants = require('constants.js');
var Network = require('network.js');
var Partner = require('partner.js');
var Size = require('size.js');
var SpaceCamp = require('space-camp.js');
var System = require('system.js');
var Utilities = require('utilities.js');
var Whoopsie = require('whoopsie.js');
var EventsService;
var RenderService;
var ComplianceService;

//? if (DEBUG) {
var ConfigValidators = require('config-validators.js');
var Inspector = require('schema-inspector.js');
var PartnerSpecificValidator = require('rubicon-htb-validator.js');
var Scribe = require('scribe.js');
//? }

////////////////////////////////////////////////////////////////////////////////
// Main ////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////

/**
 * Partner module template
 *
 * @class
 */
function RubiconModule(configs) {

    /* Rubicon endpoint only works with AJAX */
    if (!Network.isXhrSupported()) {
        //? if (DEBUG) {
        Scribe.warn('Partner RubiconHtb requires AJAX support. Aborting instantiation.');
        //? }

        return null;
    }

    /* =====================================
     * Data
     * ---------------------------------- */

    /* Private
     * ---------------------------------- */

    /**
     * Reference to the partner base class.
     *
     * @private {object}
     */
    var __baseClass;

    /**
     * Profile for this partner.
     *
     * @private {object}
     */
    var __profile;

    /**
     * Base URL for the bidding end-point.
     *
     * @private {object}
     */
    var __baseUrl;

    /**
     * Mapping of sizes to rubicon size IDs
     *
     * @private {object}
     */
    var __sizeToSizeIdMapping;

    var __pageFirstPartyData;

    /* =====================================
     * Functions
     * ---------------------------------- */

    /* Utilities
     * ---------------------------------- */

    /**
     * Translates an array of size arrays to an array of Rubicon size IDs
     * @param  {array} sizes [description]
     * @return {array}       [description]
     */
    function __mapSizesToRubiconSizeIds(sizes) {
        var rubiSizeIds = [];

        for (var i = 0; i < sizes.length; i++) {
            var sizeKey = Size.arrayToString(sizes[i]);
            if (__sizeToSizeIdMapping.hasOwnProperty(sizeKey)) {
                rubiSizeIds.push(__sizeToSizeIdMapping[sizeKey]);
            } else {
                //? if(DEBUG) {
                Scribe.warn('No rubicon size id for size ' + sizeKey);
                //? }
            }
        }

        return rubiSizeIds;
    }

    /**
     * Gets the actual size represented by a rubicon size id
     *
     * @param  {string} rubiconSize [description]
     * @return {[type]}             [description]
     */
    function __mapRubiconSizeIdToSize(rubiconSize) {
        for (var sizeKey in __sizeToSizeIdMapping) {
            if (!__sizeToSizeIdMapping.hasOwnProperty(sizeKey)) {
                continue;
            }
            if (__sizeToSizeIdMapping[sizeKey] === Number(rubiconSize)) {
                return Size.stringToArray(sizeKey)[0];
            }
        }
        //? if(DEBUG) {
        Scribe.warn('Unknown rubicon size id ' + rubiconSize);
        //? }
        return [];
    }

    function __evalVariable(variableString) {
        try {
            return eval.call(null, variableString);
        } catch (ex) {
            //? if (DEBUG) {
            Scribe.error('Error evaluating variable ' + variableString + ': ' + ex);
            //? }
        }
        return null;
    }

    function __evalFunction(functionString, args) {
        try {
            return eval.call(null, functionString + '(' + args.join() + ')');
        } catch (ex) {
            //? if (DEBUG) {
            Scribe.error('Error evaluating function ' + functionString + ': ' + ex);
            //? }
        }
        return null;
    }

    function __transformFpdSubobject(subobject) {
        var returnSubobject = {};

        if (subobject.vars) {
            var vars = subobject.vars;

            for (var varsKey in vars) {
                if (!vars.hasOwnProperty(varsKey)) {
                    continue;
                }

                returnSubobject[varsKey] = returnSubobject[varsKey] || [];

                for (var i = 0; i < vars[varsKey].length; i++) {
                    var evaledVariable = __evalVariable(vars[varsKey][i]);

                    if (evaledVariable !== null && evaledVariable !== undefined) {
                        returnSubobject[varsKey].push(evaledVariable);
                    }
                }
            }
        }

        if (subobject.strs) {
            var strs = subobject.strs;

            for (var strsKey in strs) {
                if (!strs.hasOwnProperty(strsKey)) {
                    continue;
                }

                returnSubobject[strsKey] = returnSubobject[strsKey] || [];

                for (var j = 0; j < strs[strsKey].length; j++) {
                    returnSubobject[strsKey].push(strs[strsKey][j]);
                }
            }
        }

        if (subobject.fns) {
            var fns = subobject.fns;

            for (var fnsKey in fns) {
                if (!fns.hasOwnProperty(fnsKey)) {
                    continue;
                }

                returnSubobject[fnsKey] = returnSubobject[fnsKey] || [];

                var evaledValue = __evalFunction(fns[fnsKey].fn, fns[fnsKey].args);

                if (evaledValue !== null && evaledValue !== undefined) {
                    if (Utilities.isArray(evaledValue)) {
                        for (var k = 0; k < evaledValue.length; k++) {
                            returnSubobject[fnsKey].push(evaledValue[k]);
                        }
                    } else {
                        returnSubobject[fnsKey].push(evaledValue);
                    }
                }
            }
        }

        return returnSubobject;
    }

    function __transformFirstPartyData(fpdObject) {
        var firstPartyData = {};

        if (fpdObject.inventory) {
            firstPartyData.inventory = __transformFpdSubobject(fpdObject.inventory);
        }
        if (fpdObject.visitor) {
            firstPartyData.visitor = __transformFpdSubobject(fpdObject.visitor);
        }
        if (fpdObject.position) {
            firstPartyData.position = fpdObject.position;
        }
        if (fpdObject.keywords) {
            if (Utilities.isString(fpdObject.keywords)) {
                firstPartyData.keywords = [fpdObject.keywords];
            } else {
                firstPartyData.keywords = fpdObject.keywords;
            }
        }

        return firstPartyData;
    }

    function _getDigiTrustQueryParams() {
        function getDigiTrustId() {
            if (!Browser.isTopFrame()) {
                try {
                var _window = window.top;
                } catch(e) {
                    console.log("impossible to reach top window, get topmost accessible window context  ");
                    var _window = Browser.topWindow;
                }
            } else {
                var _window = window;
            }
            try {
                var digiTrustUser =  _window.DigiTrust.getUser({member: 'T9QSFKPDN9'});
            } catch(e) {
                console.log("digiTrustUser not defined");
            }
            return (digiTrustUser && digiTrustUser.success && digiTrustUser.identity) || null;
        }
        var digiTrustId = configs.digitrustId || getDigiTrustId();
        // Verify there is an ID and this user has not opted out
        if (!digiTrustId || (digiTrustId.privacy && digiTrustId.privacy.optout)) {
        return {};
        }
        var _dt = {
            id: digiTrustId.id,
            keyv: digiTrustId.keyv,
            pref: 0
        }
        return _dt;
    }
    /**
     * Generates the request URL to the endpoint for the xSlots in the given
     * returnParcels.
     *
     * @param  {object[]} returnParcels [description]
     * @return {string}            [description]
     */
    function __generateRequestObj(returnParcels) {
        //? if (DEBUG){
        var results = Inspector.validate({
            type: 'array',
            exactLength: 1,
            items: {
                type: 'object',
                properties: {
                    htSlot: {
                        type: 'object'
                    },
                    xSlotRef: {
                        type: 'object'
                    },
                    xSlotName: {
                        type: 'string',
                        minLength: 1
                    },
                    firstPartyData: {
                        optional: true,
                        properties: {
                            rubicon: {
                                optional: true,
                                type: 'object',
                                strict: true,
                                properties: {
                                    keywords: {
                                        optional: true,
                                        type: 'array',
                                        items: {
                                            type: 'string'
                                        }
                                    },
                                    inventory: {
                                        optional: true,
                                        properties: {
                                            '*': {
                                                type: 'array',
                                                items: {
                                                    type: 'string'
                                                }
                                            }
                                        }
                                    },
                                    visitor: {
                                        optional: true,
                                        properties: {
                                            '*': {
                                                type: 'array',
                                                items: {
                                                    type: 'string'
                                                }
                                            }
                                        }
                                    },
                                    position: {
                                        optional: true,
                                        type: 'string'
                                    }
                                }
                            }
                        }
                    }
                }
            }
        }, returnParcels);
        if (!results.valid) {
            throw Whoopsie('INVALID_ARGUMENT', results.format());
        }
        //? }

        var callbackId = System.generateUniqueId();
        var parcel = returnParcels[0];
        var slotFirstPartyData = {};
        var pageFirstPartyData = {};

        if (parcel.firstPartyData && parcel.firstPartyData.rubicon) {
            slotFirstPartyData = parcel.firstPartyData.rubicon;
        } else if (parcel.xSlotRef.slotFpd) {
            slotFirstPartyData = __transformFirstPartyData(parcel.xSlotRef.slotFpd);
        }

        if (__pageFirstPartyData) {
            pageFirstPartyData = __pageFirstPartyData;
        } else if (configs.partnerFpd) {
            pageFirstPartyData = __transformFirstPartyData(configs.partnerFpd);
        }

        var rubiSizeIds = __mapSizesToRubiconSizeIds(parcel.xSlotRef.sizes);
        var referrer = Browser.getPageUrl();
        
        var gdprConsent = ComplianceService.gdpr && ComplianceService.gdpr.getConsent();
        var privacyEnabled = ComplianceService.isPrivacyEnabled();

        var queryObj = {
            account_id: configs.accountId, //jshint ignore:line
            size_id: rubiSizeIds[0], //jshint ignore:line
            p_pos: slotFirstPartyData.position ? slotFirstPartyData.position : 'btf', //jshint ignore:line
            rp_floor: 0.01, //jshint ignore:line
            rf: referrer ? referrer : '',
            p_screen_res: Browser.getScreenWidth() + 'x' + Browser.getScreenHeight(), //jshint ignore:line
            site_id: parcel.xSlotRef.siteId, //jshint ignore:line
            zone_id: parcel.xSlotRef.zoneId, //jshint ignore:line
            kw: 'rp.fastlane',
            tk_flint: 'custom', //jshint ignore:line
            rand: Math.random(),
            dt: _getDigiTrustQueryParams()
        };
        
        if (gdprConsent && privacyEnabled && typeof gdprConsent === 'object') {
            if (typeof gdprConsent.applies === 'boolean') {
                queryObj.gdpr = Number(gdprConsent.applies);
            }
            queryObj.gdpr_consent = gdprConsent.consentString;
        }    

        for (var pageInv in pageFirstPartyData.inventory) {
            if (!pageFirstPartyData.inventory.hasOwnProperty(pageInv)) {
                continue;
            }
            queryObj['tg_i.' + pageInv] = pageFirstPartyData.inventory[pageInv].toString();
        }
        for (var slotInv in slotFirstPartyData.inventory) {
            if (!slotFirstPartyData.inventory.hasOwnProperty(slotInv)) {
                continue;
            }
            if (queryObj.hasOwnProperty('tg_i.' + slotInv)) {
                queryObj['tg_i.' + slotInv] += (',' + slotFirstPartyData.inventory[slotInv].toString());
            } else {
                queryObj['tg_i.' + slotInv] = slotFirstPartyData.inventory[slotInv].toString();
            }
        }
        for (var pageVis in pageFirstPartyData.visitor) {
            if (!pageFirstPartyData.visitor.hasOwnProperty(pageVis)) {
                continue;
            }
            queryObj['tg_v.' + pageVis] = pageFirstPartyData.visitor[pageVis].toString();
        }
        for (var slotVis in slotFirstPartyData.visitor) {
            if (!slotFirstPartyData.visitor.hasOwnProperty(slotVis)) {
                continue;
            }
            if (queryObj.hasOwnProperty('tg_v.' + slotVis)) {
                queryObj['tg_v.' + slotVis] += (',' + slotFirstPartyData.visitor[slotVis].toString());
            } else {
                queryObj['tg_v.' + slotVis] = slotFirstPartyData.visitor[slotVis].toString();
            }
        }
        var keywords = [];
        if (pageFirstPartyData.keywords) {
            keywords = keywords.concat(pageFirstPartyData.keywords);
        }
        if (slotFirstPartyData.keywords) {
            keywords = keywords.concat(slotFirstPartyData.keywords);
        }
        if (keywords.length > 0) {
            queryObj.kw += (',' + keywords.toString());
        }

        if (rubiSizeIds.length > 1) {
            queryObj.alt_size_ids = rubiSizeIds.slice(1).join(','); //jshint ignore:line
        }

        return {
            url: __baseUrl,
            data: queryObj,
            callbackId: callbackId
        };
    }

    /* Helpers
     * ---------------------------------- */

    /* parses adResponse and ads any demand into outParcels */
    function __parseResponse(sessionId, adResponse, returnParcels) {
        //? if (DEBUG){
        var results = Inspector.validate({
            type: 'array',
            exactLength: 1,
            items: {
                type: 'object',
                properties: {
                    htSlot: {
                        type: 'object'
                    },
                    xSlotRef: {
                        type: 'object'
                    },
                    xSlotName: {
                        type: 'string',
                        minLength: 1
                    }
                }
            }
        }, returnParcels);
        if (!results.valid) {
            throw Whoopsie('INVALID_ARGUMENT', results.format());
        }
        //? }

        /* prepare the info to send to header stats */
        var headerStatsInfo = {
            sessionId: sessionId,
            statsId: __profile.statsId
        };

        var bidReceived = false;

        var bids = adResponse.ads || [];

        /* If no bids returned, mark the original parcel as pass */
        if (!bids.length) {
            returnParcels[0].pass = true;
        }

        for (var i = 0; i < bids.length; i++) {
            var curReturnParcel;

            /* A rubicon slot may have more than one size, so we might need to return more than
               one parcel */
            if (i === 0) {
                curReturnParcel = returnParcels[0];
                /* fill out the other required headerstats info from the parcel */
                headerStatsInfo.htSlotId = curReturnParcel.htSlot.getId();
                headerStatsInfo.requestId = curReturnParcel.requestId;
                headerStatsInfo.xSlotNames = [curReturnParcel.xSlotName];
            } else {
                curReturnParcel = {
                    partnerId: returnParcels[0].partnerId,
                    htSlot: returnParcels[0].htSlot,
                    ref: returnParcels[0].ref,
                    xSlotRef: returnParcels[0].xSlotRef,
                    xSlotName: returnParcels[0].xSlotName,
                    requestId: returnParcels[0].requestId
                };

                returnParcels.push(curReturnParcel);
            }

            var bidPrice = bids[i].cpm || 0;

            if (bids[i].status !== 'ok' || !Utilities.isNumber(bidPrice) || bidPrice <= 0) {
                //? if (DEBUG) {
                Scribe.info(__profile.partnerId + ' returned no demand for { zoneId: ' + curReturnParcel.xSlotRef.zoneId + ' }.');
                //? }

                curReturnParcel.pass = true;
                continue;
            }

            bidReceived = true;

            var bidDealId = bids[i].deal || '';
            var bidSize = __mapRubiconSizeIdToSize(bids[i].size_id); //jshint ignore:line
            var bidCreative = '<html><head><scr' + 'ipt type="text/javascript">inDapIF=true;</scr' + 'ipt>' +
                '</head><body style="margin : 0; padding: 0;"><!-- Rubicon Project Ad Tag -->' +
                '<div data-rp-impression-id="' + bids[i].impression_id + '">' + //jshint ignore:line
                '<scr' + 'ipt type="text/javascript">' + bids[i].script + '</scr' + 'ipt></div></body></html>';

            curReturnParcel.size = bidSize;
            curReturnParcel.targetingType = 'slot';
            curReturnParcel.targeting = {};

            var targetingCpm = '';
            var rubiSizeId = '';

            //? if(FEATURES.GPT_LINE_ITEMS) {
            targetingCpm = __baseClass._bidTransformers.targeting.apply(bidPrice);
            if (__baseClass._configs.lineItemType === Constants.LineItemTypes.CUSTOM) {
                if (!bids[i].targeting) {
                    continue;
                }

                var rubiTargeting = bids[i].targeting;
                rubiSizeId = bids[i].size_id; //jshint ignore:line

                for (var j = 0; j < rubiTargeting.length; j++) {
                    curReturnParcel.targeting[rubiTargeting[j].key] = rubiTargeting[j].values;
                }

                curReturnParcel.targeting.rpfl_elemid = [curReturnParcel.requestId]; //jshint ignore:line
                curReturnParcel.targeting.hb_pb_rubicon = targetingCpm;  //add Rubicon keys
            } else {
                var sizeKey = Size.arrayToString(curReturnParcel.size);

                if (bidDealId) {
                    curReturnParcel.targeting[__baseClass._configs.targetingKeys.pm] = [sizeKey + '_' + bidDealId];
                }

                /* set the om key as long as they sent _something_ in the cpm, even if it was zero */
                if (bids[i].hasOwnProperty('cpm')) {
                    curReturnParcel.targeting[__baseClass._configs.targetingKeys.om] = [sizeKey + '_' + targetingCpm];
                }

                curReturnParcel.targeting[__baseClass._configs.targetingKeys.id] = [curReturnParcel.requestId];
            }
            //? }

            //? if(FEATURES.RETURN_CREATIVE) {
            curReturnParcel.adm = bidCreative;
            //? }

            //? if(FEATURES.RETURN_PRICE) {
            curReturnParcel.price = Number(__baseClass._bidTransformers.price.apply(bidPrice));
            //? }

            var pubKitAdId = RenderService.registerAd({
                sessionId: sessionId,
                partnerId: __profile.partnerId,
                adm: bidCreative,
                requestId: curReturnParcel.requestId,
                size: rubiSizeId ? rubiSizeId : curReturnParcel.size,
                price: targetingCpm ? targetingCpm : undefined,
                dealId: bidDealId ? bidDealId : undefined,
                timeOfExpiry: __profile.features.demandExpiry.enabled ? (__profile.features.demandExpiry.value + System.now()) : 0
            });

            //? if(FEATURES.INTERNAL_RENDER) {
            curReturnParcel.targeting.pubKitAdId = pubKitAdId;
            //? }
        }

        if (__profile.enabledAnalytics.requestTime) {
            var result = 'hs_slot_pass';

            if (bidReceived) {
                result = 'hs_slot_bid';
            } else if (adResponse.status !== 'ok') {
                result = 'hs_slot_error';
            }

            EventsService.emit(result, headerStatsInfo);
        }
    }

    /**
     * Set page-level first party data
     *
     * @param {object} data [description]
     */
    function setFirstPartyData(data) {
        //? if (DEBUG){
        var results = Inspector.validate({
            type: 'object',
            strict: true,
            properties: {
                keywords: {
                    optional: true,
                    type: 'array',
                    items: {
                        type: 'string'
                    }
                },
                inventory: {
                    optional: true,
                    properties: {
                        '*': {
                            type: 'array',
                            items: {
                                type: 'string'
                            }
                        }
                    }
                },
                visitor: {
                    optional: true,
                    properties: {
                        '*': {
                            type: 'array',
                            items: {
                                type: 'string'
                            }
                        }
                    }
                }
            }
        }, data);
        if (!results.valid) {
            throw Whoopsie('INVALID_ARGUMENT', results.format());
        }
        //? }

        __pageFirstPartyData = data;
    }

    /* =====================================
     * Constructors
     * ---------------------------------- */

    (function __constructor() {
        EventsService = SpaceCamp.services.EventsService;
        RenderService = SpaceCamp.services.RenderService;
        ComplianceService = SpaceCamp.services.ComplianceService;

        __profile = {
            partnerId: 'RubiconHtb',
            namespace: 'RubiconHtb',
            statsId: 'RUBI',
            version: '2.1.3',
            targetingType: 'slot',
            enabledAnalytics: {
                requestTime: true
            },
            features: {
                demandExpiry: {
                    enabled: false,
                    value: 0
                },
                rateLimiting: {
                    enabled: false,
                    value: 0
                }
            },
            targetingKeys: {
                id: 'ix_rubi_id',
                om: 'ix_rubi_om',
                pm: 'ix_rubi_pm'
            },
            bidUnitInCents: 100,
            lineItemType: Constants.LineItemTypes.ID_AND_SIZE,
            callbackType: Partner.CallbackTypes.NONE,
            architecture: Partner.Architectures.MRA,
            requestType: Partner.RequestTypes.AJAX
        };

        //? if (DEBUG) {
        var results = ConfigValidators.partnerBaseConfig(configs) || PartnerSpecificValidator(configs);

        if (results) {
            throw Whoopsie('INVALID_CONFIG', results);
        }
        //? }

        __sizeToSizeIdMapping = {
            '468x60': 1,
            '728x90': 2,
            '120x600': 8,
            '160x600': 9,
            '300x600': 10,
            '250x250': 14,
            '300x250': 15,
            '336x280': 16,
            '300x100': 19,
            '980x120': 31,
            '250x360': 32,
            '180x500': 33,
            '980x150': 35,
            '468x400': 37,
            '930x180': 38,
            '320x50': 43,
            '300x50': 44,
            '300x300': 48,
            '300x1050': 54,
            '970x90': 55,
            '970x250': 57,
            '1000x90': 58,
            '320x80': 59,
            '320x150': 60,
            '1000x1000': 61,
            '640x480': 65,
            '320x480': 67,
            '1800x1000': 68,
            '320x320': 72,
            '320x160': 73,
            '980x240': 78,
            '980x300': 79,
            '980x400': 80,
            '480x300': 83,
            '970x310': 94,
            '970x210': 96,
            '480x320': 101,
            '768x1024': 102,
            '480x280': 103,
            '320x240': 108,
            '1000x300': 113,
            '320x100': 117,
            '800x250': 125,
            '200x600': 126
        };

        __baseUrl = Browser.getProtocol() + '//fastlane.rubiconproject.com/a/api/fastlane.json';

        __baseClass = Partner(__profile, configs, null, {
            parseResponse: __parseResponse,
            generateRequestObj: __generateRequestObj
        });
    })();

    /* =====================================
     * Public Interface
     * ---------------------------------- */

    var derivedClass = {
        /* Class Information
         * ---------------------------------- */

        //? if (DEBUG) {
        __type__: 'RubiconModule',
        //? }

        //? if (TEST) {
        __baseClass: __baseClass,
        //? }

        /* Data
         * ---------------------------------- */

        //? if (TEST) {
        __profile: __profile,
        __baseUrl: __baseUrl,
        //? }

        /* Functions
         * ---------------------------------- */

        setFirstPartyData: setFirstPartyData,

        //? if (TEST) {
        __parseResponse: __parseResponse,
        __generateRequestObj: __generateRequestObj
        //? }
    };

    return Classify.derive(__baseClass, derivedClass);
}

////////////////////////////////////////////////////////////////////////////////
// Exports /////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////

module.exports = RubiconModule;