diff --git a/integrationExamples/gpt/gpt_aliasingBidder.html b/integrationExamples/gpt/gpt_aliasingBidder.html
index f9c7120079d..693be76e82e 100644
--- a/integrationExamples/gpt/gpt_aliasingBidder.html
+++ b/integrationExamples/gpt/gpt_aliasingBidder.html
@@ -35,7 +35,7 @@
// Load the Prebid Javascript Library Async. We recommend loading it immediately after
// the initAdserver() and setTimeout functions.
(function () {
- var d = document, pbs = d.createElement("script"), pro = d.location.protocal;
+ var d = document, pbs = d.createElement("script"), pro = d.location.protocol;
pbs.type = "text/javascript";
pbs.src = '/build/dist/prebid.js';
var target = document.getElementsByTagName("head")[0];
diff --git a/integrationExamples/gpt/pbjs_yieldbot_gpt.html b/integrationExamples/gpt/pbjs_yieldbot_gpt.html
new file mode 100644
index 00000000000..986eed8fc5e
--- /dev/null
+++ b/integrationExamples/gpt/pbjs_yieldbot_gpt.html
@@ -0,0 +1,201 @@
+
+
+
+
+
+
+
+
+ Prebid.js Yieldbot Adapter Basic Example
+ Use the links below to enable and disable Yieldbot test bids.Note: Enable - Yieldbot Test Bids
+ Enable - Yieldbot Test Bids Disable - Yieldbot Test Bids
+ Div-0, 728x90
+ Refresh 728x90 Ad Unit
+
+
+
+ Div-1, 300x250 or 300x600
+ Refresh 300x250, 300x600 Ad Unit
+
+
+
+ Div-2, 300x250 or 300x600
+ The bid for the 300x250 | 300x600 slot is shown under Div-1
+ Refresh this slot after initial page view and you should see the Yieldbot test creative.
+
+ Refresh 300x250, 300x600 Ad Unit
+
+
+
+
+
diff --git a/modules/adformBidAdapter.js b/modules/adformBidAdapter.js
index 5d1bb98b4ec..69908e70888 100644
--- a/modules/adformBidAdapter.js
+++ b/modules/adformBidAdapter.js
@@ -1,14 +1,15 @@
-var utils = require('src/utils.js');
-var adloader = require('src/adloader.js');
-var bidmanager = require('src/bidmanager.js');
-var bidfactory = require('src/bidfactory.js');
+var utils = require('src/utils');
+var adloader = require('src/adloader');
+var bidmanager = require('src/bidmanager');
+var bidfactory = require('src/bidfactory');
var STATUSCODES = require('src/constants.json').STATUS;
var adaptermanager = require('src/adaptermanager');
+var Adapter = require('src/adapter').default;
+
+const ADFORM_BIDDER_CODE = 'adform';
function AdformAdapter() {
- return {
- callBids: _callBids
- };
+ let baseAdapter = new Adapter(ADFORM_BIDDER_CODE);
function _callBids(params) {
var bid, _value, _key, i, j, k, l, reqParams;
@@ -47,7 +48,7 @@ function AdformAdapter() {
$$PREBID_GLOBAL$$[callbackName] = handleCallback(bids);
adloader.loadScript(request.join('&'));
- }
+ };
function formRequestUrl(reqData) {
var key;
@@ -63,7 +64,7 @@ function AdformAdapter() {
function handleCallback(bids) {
return function handleResponse(adItems) {
var bidObject;
- var bidder = 'adform';
+ var bidder = baseAdapter.getBidderCode();
var adItem;
var bid;
for (var i = 0, l = adItems.length; i < l; i++) {
@@ -160,8 +161,11 @@ function AdformAdapter() {
return utftext;
}
-}
-adaptermanager.registerBidAdapter(new AdformAdapter(), 'adform');
+ return Object.assign(this, baseAdapter, {
+ callBids: _callBids
+ });
+}
+adaptermanager.registerBidAdapter(new AdformAdapter(), ADFORM_BIDDER_CODE);
module.exports = AdformAdapter;
diff --git a/modules/adxcgBidAdapter.js b/modules/adxcgBidAdapter.js
new file mode 100644
index 00000000000..ccb0287a866
--- /dev/null
+++ b/modules/adxcgBidAdapter.js
@@ -0,0 +1,139 @@
+import bidfactory from 'src/bidfactory';
+import bidmanager from 'src/bidmanager';
+import * as utils from 'src/utils';
+import { STATUS } from 'src/constants';
+import adaptermanager from 'src/adaptermanager';
+import { ajax } from 'src/ajax';
+import * as url from 'src/url';
+
+/**
+ * Adapter for requesting bids from Adxcg
+ * updated from latest prebid repo on 2017.08.30
+ */
+function AdxcgAdapter() {
+ let bidRequests = {};
+
+ function _callBids(params) {
+ if (params.bids && params.bids.length > 0) {
+ let adZoneIds = [];
+ let prebidBidIds = [];
+ let sizes = [];
+
+ params.bids.forEach(bid => {
+ bidRequests[bid.bidId] = bid;
+ adZoneIds.push(utils.getBidIdParameter('adzoneid', bid.params));
+ prebidBidIds.push(bid.bidId);
+ sizes.push(utils.parseSizesInput(bid.sizes).join('|'));
+ });
+
+ let location = utils.getTopWindowLocation();
+ let secure = location.protocol == 'https:';
+
+ let requestUrl = url.parse(location.href);
+ requestUrl.search = null;
+ requestUrl.hash = null;
+
+ let adxcgRequestUrl = url.format({
+ protocol: secure ? 'https' : 'http',
+ hostname: secure ? 'ad-emea-secure.adxcg.net' : 'ad-emea.adxcg.net',
+ pathname: '/get/adi',
+ search: {
+ renderformat: 'javascript',
+ ver: 'r20141124',
+ adzoneid: adZoneIds.join(','),
+ format: sizes.join(','),
+ prebidBidIds: prebidBidIds.join(','),
+ url: escape(url.format(requestUrl)),
+ secure: secure ? '1' : '0'
+ }
+ });
+
+ utils.logMessage(`submitting request: ${adxcgRequestUrl}`);
+ ajax(adxcgRequestUrl, handleResponse, null, {
+ withCredentials: true
+ });
+ }
+ }
+
+ function handleResponse(response) {
+ let adxcgBidReponseList;
+
+ try {
+ adxcgBidReponseList = JSON.parse(response);
+ utils.logMessage(`adxcgBidReponseList: ${JSON.stringify(adxcgBidReponseList)}`);
+ } catch (error) {
+ adxcgBidReponseList = [];
+ utils.logError(error);
+ }
+
+ adxcgBidReponseList.forEach(adxcgBidReponse => {
+ let bidRequest = bidRequests[adxcgBidReponse.bidId];
+ delete bidRequests[adxcgBidReponse.bidId];
+
+ let bid = bidfactory.createBid(STATUS.GOOD, bidRequest);
+
+ bid.creative_id = adxcgBidReponse.creativeId;
+ bid.code = 'adxcg';
+ bid.bidderCode = 'adxcg';
+ bid.cpm = adxcgBidReponse.cpm;
+
+ if (adxcgBidReponse.ad) {
+ bid.ad = adxcgBidReponse.ad;
+ } else if (adxcgBidReponse.vastUrl) {
+ bid.vastUrl = adxcgBidReponse.vastUrl;
+ bid.descriptionUrl = adxcgBidReponse.vastUrl;
+ bid.mediaType = 'video';
+ } else if (adxcgBidReponse.nativeResponse) {
+ bid.mediaType = 'native';
+
+ let nativeResponse = adxcgBidReponse.nativeResponse;
+
+ bid.native = {
+ clickUrl: escape(nativeResponse.link.url),
+ impressionTrackers: nativeResponse.imptrackers
+ };
+
+ nativeResponse.assets.forEach(asset => {
+ if (asset.title && asset.title.text) {
+ bid.native.title = asset.title.text;
+ }
+
+ if (asset.img && asset.img.url) {
+ bid.native.image = asset.img.url;
+ }
+
+ if (asset.data && asset.data.label == 'DESC' && asset.data.value) {
+ bid.native.body = asset.data.value;
+ }
+
+ if (asset.data && asset.data.label == 'SPONSORED' && asset.data.value) {
+ bid.native.sponsoredBy = asset.data.value;
+ }
+ });
+ }
+
+ bid.width = adxcgBidReponse.width;
+ bid.height = adxcgBidReponse.height;
+
+ utils.logMessage(`submitting bid[${bidRequest.placementCode}]: ${JSON.stringify(bid)}`);
+ bidmanager.addBidResponse(bidRequest.placementCode, bid);
+ });
+
+ Object.keys(bidRequests)
+ .map(bidId => bidRequests[bidId].placementCode)
+ .forEach(placementCode => {
+ utils.logMessage(`creating no_bid bid for: ${placementCode}`);
+ bidmanager.addBidResponse(placementCode, bidfactory.createBid(STATUS.NO_BID));
+ });
+ };
+
+ return {
+ callBids: _callBids
+ };
+};
+
+adaptermanager.registerBidAdapter(new AdxcgAdapter(), 'adxcg', {
+ supportedMediaTypes: ['video', 'native']
+});
+
+module.exports = AdxcgAdapter;
diff --git a/modules/aerservBidAdapter.js b/modules/aerservBidAdapter.js
new file mode 100644
index 00000000000..64a02e77325
--- /dev/null
+++ b/modules/aerservBidAdapter.js
@@ -0,0 +1,117 @@
+import bidfactory from 'src/bidfactory';
+import bidmanager from 'src/bidmanager';
+import * as utils from 'src/utils';
+import {ajax} from 'src/ajax';
+import {STATUS} from 'src/constants';
+import adaptermanager from 'src/adaptermanager';
+
+const BIDDER_CODE = 'aerserv';
+
+const AerServAdapter = function AerServAdapter() {
+ const ENVIRONMENTS = {
+ local: '127.0.0.1:8080',
+ dev: 'dev-ads.aerserv.com',
+ stage: 'staging-ads.aerserv.com',
+ prod: 'ads.aerserv.com'
+ };
+
+ const BANNER_PATH = '/as/json/pbjs/v1?';
+ const VIDEO_PATH = '/as/json/pbjsvast/v1?';
+ const REQUIRED_PARAMS = ['plc'];
+
+ function _isResponseValid(bidRequest, response) {
+ return ((bidRequest.mediaType === 'video' && response.vastUrl) || (bidRequest.mediaType !== 'video' && response.adm)) &&
+ response.cpm && response.cpm > 0;
+ }
+
+ function _createBid(bidRequest, response) {
+ if (_isResponseValid(bidRequest, response)) {
+ let bid = bidfactory.createBid(1, bidRequest);
+ bid.bidderCode = BIDDER_CODE;
+ bid.cpm = response.cpm;
+ bid.width = response.w;
+ bid.height = response.h;
+ if (bidRequest.mediaType === 'video') {
+ bid.vastUrl = response.vastUrl;
+ bid.descriptionUrl = response.vastUrl;
+ bid.mediaType = 'video';
+ } else {
+ bid.ad = response.adm;
+ }
+ bidmanager.addBidResponse(bidRequest.placementCode, bid);
+ } else {
+ bidmanager.addBidResponse(bidRequest.placementCode, bidfactory.createBid(STATUS.NO_BID, bidRequest));
+ }
+ }
+
+ function _getFirstSize(sizes) {
+ let sizeObj = {};
+ if (utils.isArray(sizes) && sizes.length > 0 && utils.isArray(sizes[0]) && sizes[0].length === 2) {
+ sizeObj['vpw'] = sizes[0][0];
+ sizeObj['vph'] = sizes[0][1];
+ }
+ return sizeObj;
+ }
+
+ function _buildQueryParameters(bid, requestParams) {
+ Object.keys(bid.params).filter(param => param !== 'video')
+ .forEach(param => requestParams[param] = bid.params[param]);
+
+ if (bid.mediaType === 'video') {
+ let videoDimensions = _getFirstSize(bid.sizes);
+ Object.keys(videoDimensions).forEach(param => requestParams[param] = videoDimensions[param]);
+ Object.keys(bid.params.video || {}).forEach(param => requestParams[param] = bid.params.video[param]);
+ }
+
+ return utils.parseQueryStringParameters(requestParams);
+ }
+
+ function _handleResponse(bidRequest) {
+ return response => {
+ if (!response && response.length <= 0) {
+ bidmanager.addBidResponse(bidRequest.placementCode, bidfactory.createBid(STATUS.NO_BID, bidRequest));
+ utils.logError('Empty response');
+ return;
+ }
+
+ try {
+ response = JSON.parse(response);
+ } catch (e) {
+ bidmanager.addBidResponse(bidRequest.placementCode, bidfactory.createBid(STATUS.NO_BID, bidRequest));
+ utils.logError('Invalid JSON in response');
+ return;
+ }
+
+ _createBid(bidRequest, response);
+ };
+ }
+
+ function _callBids(bidRequests) {
+ let currentUrl = (window.parent !== window) ? document.referrer : window.location.href;
+ currentUrl = currentUrl && encodeURIComponent(currentUrl);
+
+ let bids = bidRequests.bids || [];
+ bids.forEach(bid => {
+ if (utils.hasValidBidRequest(bid.params, REQUIRED_PARAMS, BIDDER_CODE)) {
+ let env = ENVIRONMENTS[bid.params['env']] || ENVIRONMENTS['prod'];
+ let requestPath = bid.mediaType === 'video' ? VIDEO_PATH : BANNER_PATH;
+ let pageParameters = {url: currentUrl};
+ let parameterStr = _buildQueryParameters(bid, pageParameters);
+
+ let url = `//${env}${requestPath}${parameterStr}`;
+ utils.logMessage('sending request to: ' + url);
+ ajax(url, _handleResponse(bid), null, {withCredentials: true});
+ } else {
+ bidmanager.addBidResponse(bid.placementCode, bidfactory.createBid(STATUS.NO_BID, bid));
+ }
+ });
+ }
+
+ return {
+ callBids: _callBids
+ }
+};
+
+adaptermanager.registerBidAdapter(new AerServAdapter(), BIDDER_CODE, {supportedMediaTypes: ['video']});
+
+module.exports = AerServAdapter;
diff --git a/modules/appnexusAstBidAdapter.js b/modules/appnexusAstBidAdapter.js
index 80e2472e9ef..5ca2178d0a4 100644
--- a/modules/appnexusAstBidAdapter.js
+++ b/modules/appnexusAstBidAdapter.js
@@ -25,6 +25,7 @@ const NATIVE_MAPPING = {
},
sponsoredBy: 'sponsored_by'
};
+const SOURCE = 'pbjs';
/**
* Bidder adapter for /ut endpoint. Given the list of all ad unit tag IDs,
@@ -142,7 +143,14 @@ function AppnexusAstAdapter() {
});
if (!utils.isEmpty(tags)) {
- const payloadJson = {tags: [...tags], user: userObj};
+ const payloadJson = {
+ tags: [...tags],
+ user: userObj,
+ sdk: {
+ source: SOURCE,
+ version: '$prebid.version$'
+ }
+ };
if (member > 0) {
payloadJson.member_id = member;
}
diff --git a/modules/currency.js b/modules/currency.js
new file mode 100644
index 00000000000..1d0286ed569
--- /dev/null
+++ b/modules/currency.js
@@ -0,0 +1,255 @@
+import bidfactory from 'src/bidfactory';
+import { STATUS } from 'src/constants';
+import { ajax } from 'src/ajax';
+import * as utils from 'src/utils';
+import bidmanager from 'src/bidmanager';
+import { config } from 'src/config';
+
+const DEFAULT_CURRENCY_RATE_URL = 'http://currency.prebid.org/latest.json';
+const CURRENCY_RATE_PRECISION = 4;
+
+var bidResponseQueue = [];
+var conversionCache = {};
+var currencyRatesLoaded = false;
+var adServerCurrency = 'USD';
+
+// Used as reference to the original bidmanager.addBidResponse
+var originalBidResponse;
+
+export var currencySupportEnabled = false;
+export var currencyRates = {};
+var bidderCurrencyDefault = {};
+
+/**
+ * Configuration function for currency
+ * @param {string} [config.adServerCurrency = 'USD']
+ * ISO 4217 3-letter currency code that represents the target currency. (e.g. 'EUR'). If this value is present,
+ * the currency conversion feature is activated.
+ * @param {number} [config.granularityMultiplier = 1]
+ * A decimal value representing how mcuh to scale the price granularity calculations.
+ * @param {object} config.bidderCurrencyDefault
+ * An optional argument to specify bid currencies for bid adapters. This option is provided for the transitional phase
+ * before every bid adapter will specify its own bid currency. If the adapter specifies a bid currency, this value is
+ * ignored for that bidder.
+ *
+ * example:
+ * {
+ * rubicon: 'USD'
+ * }
+ * @param {string} [config.conversionRateFile = 'http://currency.prebid.org/latest.json']
+ * Optional path to a file containing currency conversion data. Prebid.org hosts a file that is used as the default,
+ * if not specified.
+ * @param {object} [config.rates]
+ * This optional argument allows you to specify the rates with a JSON object, subverting the need for a external
+ * config.conversionRateFile parameter. If this argument is specified, the conversion rate file will not be loaded.
+ *
+ * example:
+ * {
+ * 'GBP': { 'CNY': 8.8282, 'JPY': 141.7, 'USD': 1.2824 },
+ * 'USD': { 'CNY': 6.8842, 'GBP': 0.7798, 'JPY': 110.49 }
+ * }
+ */
+export function setConfig(config) {
+ let url = DEFAULT_CURRENCY_RATE_URL;
+
+ if (typeof config.rates === 'object') {
+ currencyRates.conversions = config.rates;
+ currencyRatesLoaded = true;
+ }
+
+ if (typeof config.adServerCurrency === 'string') {
+ utils.logInfo('enabling currency support', arguments);
+
+ adServerCurrency = config.adServerCurrency;
+ if (config.conversionRateFile) {
+ utils.logInfo('currency using override conversionRateFile:', config.conversionRateFile);
+ url = config.conversionRateFile;
+ }
+ initCurrency(url);
+ } else {
+ // currency support is disabled, setting defaults
+ utils.logInfo('disabling currency support');
+ resetCurrency();
+ }
+ if (typeof config.bidderCurrencyDefault === 'object') {
+ bidderCurrencyDefault = config.bidderCurrencyDefault;
+ }
+}
+config.getConfig('currency', config => setConfig(config.currency));
+
+function initCurrency(url) {
+ conversionCache = {};
+ currencySupportEnabled = true;
+
+ if (!originalBidResponse) {
+ utils.logInfo('Installing addBidResponse decorator for currency module', arguments);
+
+ originalBidResponse = bidmanager.addBidResponse;
+ bidmanager.addBidResponse = addBidResponseDecorator(bidmanager.addBidResponse);
+ }
+
+ if (!currencyRates.conversions) {
+ ajax(url, function (response) {
+ try {
+ currencyRates = JSON.parse(response);
+ utils.logInfo('currencyRates set to ' + JSON.stringify(currencyRates));
+ currencyRatesLoaded = true;
+ processBidResponseQueue();
+ } catch (e) {
+ utils.logError('failed to parse currencyRates response: ' + response);
+ }
+ });
+ }
+}
+
+function resetCurrency() {
+ if (originalBidResponse) {
+ utils.logInfo('Uninstalling addBidResponse decorator for currency module', arguments);
+
+ bidmanager.addBidResponse = originalBidResponse;
+ originalBidResponse = undefined;
+ }
+
+ adServerCurrency = 'USD';
+ conversionCache = {};
+ currencySupportEnabled = false;
+ currencyRatesLoaded = false;
+ currencyRates = {};
+ bidderCurrencyDefault = {};
+}
+
+export function addBidResponseDecorator(fn) {
+ return function(adUnitCode, bid) {
+ if (!bid) {
+ return fn.apply(this, arguments); // if no bid, call original and let it display warnings
+ }
+
+ let bidder = bid.bidderCode || bid.bidder;
+ if (bidderCurrencyDefault[bidder]) {
+ let currencyDefault = bidderCurrencyDefault[bidder];
+ if (bid.currency && currencyDefault !== bid.currency) {
+ utils.logWarn(`Currency default '${bidder}: ${currencyDefault}' ignored. adapter specified '${bid.currency}'`);
+ } else {
+ bid.currency = currencyDefault;
+ }
+ }
+
+ // default to USD if currency not set
+ if (!bid.currency) {
+ utils.logWarn('Currency not specified on bid. Defaulted to "USD"');
+ bid.currency = 'USD';
+ }
+
+ // execute immediately if the bid is already in the desired currency
+ if (bid.currency === adServerCurrency) {
+ return fn.apply(this, arguments);
+ }
+
+ bidResponseQueue.push(wrapFunction(fn, this, arguments));
+ if (!currencySupportEnabled || currencyRatesLoaded) {
+ processBidResponseQueue();
+ }
+ }
+}
+
+function processBidResponseQueue() {
+ while (bidResponseQueue.length > 0) {
+ (bidResponseQueue.shift())();
+ }
+}
+
+function wrapFunction(fn, context, params) {
+ return function() {
+ var bid = params[1];
+ if (bid !== undefined && 'currency' in bid && 'cpm' in bid) {
+ var fromCurrency = bid.currency;
+ try {
+ var conversion = getCurrencyConversion(fromCurrency);
+ bid.originalCpm = bid.cpm;
+ bid.originalCurrency = bid.currency;
+ if (conversion !== 1) {
+ bid.cpm = (parseFloat(bid.cpm) * conversion).toFixed(4);
+ bid.currency = adServerCurrency;
+ }
+ } catch (e) {
+ utils.logWarn('Returning NO_BID, getCurrencyConversion threw error: ', e);
+ params[1] = bidfactory.createBid(STATUS.NO_BID, {
+ bidder: bid.bidderCode || bid.bidder,
+ bidId: bid.adId
+ });
+ }
+ }
+ return fn.apply(context, params);
+ };
+}
+
+function getCurrencyConversion(fromCurrency) {
+ var conversionRate = null;
+ var rates;
+
+ if (fromCurrency in conversionCache) {
+ conversionRate = conversionCache[fromCurrency];
+ utils.logMessage('Using conversionCache value ' + conversionRate + ' for fromCurrency ' + fromCurrency);
+ } else if (currencySupportEnabled === false) {
+ if (fromCurrency === 'USD') {
+ conversionRate = 1;
+ } else {
+ throw new Error('Prebid currency support has not been enabled and fromCurrency is not USD');
+ }
+ } else if (fromCurrency === adServerCurrency) {
+ conversionRate = 1;
+ } else {
+ var toCurrency = adServerCurrency;
+
+ if (fromCurrency in currencyRates.conversions) {
+ // using direct conversion rate from fromCurrency to toCurrency
+ rates = currencyRates.conversions[fromCurrency];
+ if (!(toCurrency in rates)) {
+ // bid should fail, currency is not supported
+ throw new Error('Specified adServerCurrency in config \'' + toCurrency + '\' not found in the currency rates file');
+ }
+ conversionRate = rates[toCurrency];
+ utils.logInfo('getCurrencyConversion using direct ' + fromCurrency + ' to ' + toCurrency + ' conversionRate ' + conversionRate);
+ } else if (toCurrency in currencyRates.conversions) {
+ // using reciprocal of conversion rate from toCurrency to fromCurrency
+ rates = currencyRates.conversions[toCurrency];
+ if (!(fromCurrency in rates)) {
+ // bid should fail, currency is not supported
+ throw new Error('Specified fromCurrency \'' + fromCurrency + '\' not found in the currency rates file');
+ }
+ conversionRate = roundFloat(1 / rates[fromCurrency], CURRENCY_RATE_PRECISION);
+ utils.logInfo('getCurrencyConversion using reciprocal ' + fromCurrency + ' to ' + toCurrency + ' conversionRate ' + conversionRate);
+ } else {
+ // first defined currency base used as intermediary
+ var anyBaseCurrency = Object.keys(currencyRates.conversions)[0];
+
+ if (!(fromCurrency in currencyRates.conversions[anyBaseCurrency])) {
+ // bid should fail, currency is not supported
+ throw new Error('Specified fromCurrency \'' + fromCurrency + '\' not found in the currency rates file');
+ }
+ var toIntermediateConversionRate = 1 / currencyRates.conversions[anyBaseCurrency][fromCurrency];
+
+ if (!(toCurrency in currencyRates.conversions[anyBaseCurrency])) {
+ // bid should fail, currency is not supported
+ throw new Error('Specified adServerCurrency in config \'' + toCurrency + '\' not found in the currency rates file');
+ }
+ var fromIntermediateConversionRate = currencyRates.conversions[anyBaseCurrency][toCurrency];
+
+ conversionRate = roundFloat(toIntermediateConversionRate * fromIntermediateConversionRate, CURRENCY_RATE_PRECISION);
+ utils.logInfo('getCurrencyConversion using intermediate ' + fromCurrency + ' thru ' + anyBaseCurrency + ' to ' + toCurrency + ' conversionRate ' + conversionRate);
+ }
+ }
+ if (!(fromCurrency in conversionCache)) {
+ utils.logMessage('Adding conversionCache value ' + conversionRate + ' for fromCurrency ' + fromCurrency);
+ conversionCache[fromCurrency] = conversionRate;
+ }
+ return conversionRate;
+}
+
+function roundFloat(num, dec) {
+ var d = 1;
+ for (let i = 0; i < dec; i++) {
+ d += '0';
+ }
+ return Math.round(num * d) / d;
+}
diff --git a/modules/improvedigitalBidAdapter.js b/modules/improvedigitalBidAdapter.js
new file mode 100644
index 00000000000..51fb61b03e2
--- /dev/null
+++ b/modules/improvedigitalBidAdapter.js
@@ -0,0 +1,384 @@
+const LIB_VERSION_GLOBAL = '3.0.5';
+
+const CONSTANTS = require('src/constants');
+const utils = require('src/utils');
+const bidfactory = require('src/bidfactory');
+const bidmanager = require('src/bidmanager');
+const adloader = require('src/adloader');
+const Adapter = require('src/adapter').default;
+const adaptermanager = require('src/adaptermanager');
+
+const IMPROVE_DIGITAL_BIDDER_CODE = 'improvedigital';
+
+const ImproveDigitalAdapter = function () {
+ let baseAdapter = new Adapter(IMPROVE_DIGITAL_BIDDER_CODE);
+ baseAdapter.idClient = new ImproveDigitalAdServerJSClient('hb');
+
+ const LIB_VERSION = LIB_VERSION_GLOBAL;
+
+ // Ad server needs to implement JSONP using this function as the callback
+ const CALLBACK_FUNCTION = '$$PREBID_GLOBAL$$' + '.improveDigitalResponse';
+
+ baseAdapter.getNormalizedBidRequest = function(bid) {
+ let adUnitId = utils.getBidIdParameter('placementCode', bid) || null;
+ let placementId = utils.getBidIdParameter('placementId', bid.params) || null;
+ let publisherId = null;
+ let placementKey = null;
+
+ if (placementId === null) {
+ publisherId = utils.getBidIdParameter('publisherId', bid.params) || null;
+ placementKey = utils.getBidIdParameter('placementKey', bid.params) || null;
+ }
+ let keyValues = utils.getBidIdParameter('keyValues', bid.params) || null;
+ let localSize = utils.getBidIdParameter('size', bid.params) || null;
+ let bidId = utils.getBidIdParameter('bidId', bid);
+
+ let normalizedBidRequest = {};
+ if (placementId) {
+ normalizedBidRequest.placementId = placementId;
+ } else {
+ if (publisherId) {
+ normalizedBidRequest.publisherId = publisherId;
+ }
+ if (placementKey) {
+ normalizedBidRequest.placementKey = placementKey;
+ }
+ }
+
+ if (keyValues) {
+ normalizedBidRequest.keyValues = keyValues;
+ }
+ if (localSize && localSize.w && localSize.h) {
+ normalizedBidRequest.size = {};
+ normalizedBidRequest.size.h = localSize.h;
+ normalizedBidRequest.size.w = localSize.w;
+ }
+ if (bidId) {
+ normalizedBidRequest.id = bidId;
+ }
+ if (adUnitId) {
+ normalizedBidRequest.adUnitId = adUnitId;
+ }
+ return normalizedBidRequest;
+ }
+
+ let submitNoBidResponse = function(bidRequest) {
+ let bid = bidfactory.createBid(CONSTANTS.STATUS.NO_BID, bidRequest);
+ bid.bidderCode = IMPROVE_DIGITAL_BIDDER_CODE;
+ bidmanager.addBidResponse(bidRequest.placementCode, bid);
+ };
+
+ $$PREBID_GLOBAL$$.improveDigitalResponse = function(response) {
+ let bidRequests = utils.getBidderRequestAllAdUnits(IMPROVE_DIGITAL_BIDDER_CODE);
+ if (bidRequests && bidRequests.bids && bidRequests.bids.length > 0) {
+ utils._each(bidRequests.bids, function (bidRequest) {
+ let bidObjects = response.bid || [];
+ utils._each(bidObjects, function (bidObject) {
+ if (bidObject.id === bidRequest.bidId) {
+ if (!bidObject.price || bidObject.price === null) {
+ submitNoBidResponse(bidRequest);
+ return;
+ }
+ if (bidObject.errorCode && bidObject.errorCode !== 0) {
+ submitNoBidResponse(bidRequest);
+ return;
+ }
+ if (!bidObject.adm || bidObject.adm === null || typeof bidObject.adm !== 'string') {
+ submitNoBidResponse(bidRequest);
+ return;
+ }
+
+ let bid = bidfactory.createBid(CONSTANTS.STATUS.GOOD, bidRequest);
+
+ let syncString = '';
+ let syncArray = (bidObject.sync && bidObject.sync.length > 0) ? bidObject.sync : [];
+
+ utils._each(syncArray, function (syncElement) {
+ let syncInd = syncElement.replace(/\//g, '\\\/');
+ syncString = `${syncString}${(syncString === '') ? 'document.writeln(\"' : ''} })
* "low": $0.50 increments, capped at $5 CPM
* "medium": $0.10 increments, capped at $20 CPM (the default)
@@ -656,7 +654,7 @@ $$PREBID_GLOBAL$$.getAllWinningBids = function () {
/**
* Build master video tag from publishers adserver tag
* @param {string} adserverTag default url
- * @param {object} options options for video tag
+ * @param {Object} options options for video tag
*
* @deprecated Include the dfpVideoSupport module in your build, and use the $$PREBID_GLOBAL$$.adservers.dfp.buildVideoAdUrl function instead.
* This function will be removed in Prebid 1.0.
@@ -703,7 +701,7 @@ $$PREBID_GLOBAL$$.setBidderSequence = adaptermanager.setBidderSequence
* Get array of highest cpm bids for all adUnits, or highest cpm bid
* object for the given adUnit
* @param {string} adUnitCode - optional ad unit code
- * @return {array} array containing highest cpm bid object(s)
+ * @return {Array} array containing highest cpm bid object(s)
*/
$$PREBID_GLOBAL$$.getHighestCpmBids = function (adUnitCode) {
return targeting.getWinningBids(adUnitCode);
@@ -748,13 +746,13 @@ $$PREBID_GLOBAL$$.setS2SConfig = function(options) {
/**
* Get Prebid config options
- * @param {object} options
+ * @param {Object} options
*/
$$PREBID_GLOBAL$$.getConfig = config.getConfig;
/**
* Set Prebid config options
- * @param {object} options
+ * @param {Object} options
*/
$$PREBID_GLOBAL$$.setConfig = config.setConfig;
@@ -775,14 +773,15 @@ $$PREBID_GLOBAL$$.que.push(() => listenMessagesFromCreative());
* by prebid once it's done loading. If it runs after prebid loads, then this monkey-patch causes their
* function to execute immediately.
*
- * @param {function} cmd A function which takes no arguments. This is guaranteed to run exactly once, and only after
- * the Prebid script has been fully loaded.
+ * @memberof $$PREBID_GLOBAL$$
+ * @param {function} command A function which takes no arguments. This is guaranteed to run exactly once, and only after
+ * the Prebid script has been fully loaded.
* @alias module:$$PREBID_GLOBAL$$.cmd.push
*/
-$$PREBID_GLOBAL$$.cmd.push = function(cmd) {
- if (typeof cmd === 'function') {
+$$PREBID_GLOBAL$$.cmd.push = function(command) {
+ if (typeof command === 'function') {
try {
- cmd.call();
+ command.call();
} catch (e) {
utils.logError('Error processing command :' + e.message);
}
diff --git a/src/utils.js b/src/utils.js
index 0a81503e1d3..0c1846b18ce 100644
--- a/src/utils.js
+++ b/src/utils.js
@@ -157,6 +157,8 @@ export function parseGPTSingleSizeArray(singleSize) {
exports.getTopWindowLocation = function () {
let location;
try {
+ // force an exception in x-domain enviornments. #1509
+ window.top.location.toString();
location = window.top.location;
} catch (e) {
location = window.location;
@@ -677,3 +679,20 @@ export function groupBy(xs, key) {
return rv;
}, {});
}
+
+/**
+ * deepAccess utility function useful for doing safe access (will not throw exceptions) of deep object paths.
+ * @param {object} obj The object containing the values you would like to access.
+ * @param {string|number} path Object path to the value you would like to access. Non-strings are coerced to strings.
+ * @returns {*} The value found at the specified object path, or undefined if path is not found.
+ */
+export function deepAccess(obj, path) {
+ path = String(path).split('.');
+ for (let i = 0; i < path.length; i++) {
+ obj = obj[path[i]];
+ if (typeof obj === 'undefined') {
+ return;
+ }
+ }
+ return obj;
+}
diff --git a/src/videoCache.js b/src/videoCache.js
index 73d249c13f0..fe126fad6e0 100644
--- a/src/videoCache.js
+++ b/src/videoCache.js
@@ -20,7 +20,7 @@ const BASE_URL = 'https://prebid.adnxs.com/pbc/v1/cache'
/**
* @typedef {object} CacheablePayloadBid
- * @property {string} vastPayload Some VAST XML which loads an ad in a video player.
+ * @property {string} vastXml Some VAST XML which loads an ad in a video player.
*/
/**
@@ -58,7 +58,7 @@ function wrapURI(uri) {
* @param {CacheableBid} bid
*/
function toStorageRequest(bid) {
- const vastValue = bid.vastPayload ? bid.vastPayload : wrapURI(bid.vastUrl);
+ const vastValue = bid.vastXml ? bid.vastXml : wrapURI(bid.vastUrl);
return {
type: 'xml',
value: vastValue
diff --git a/test/fixtures/fixtures.js b/test/fixtures/fixtures.js
index 59b812acc5c..8108da3c555 100644
--- a/test/fixtures/fixtures.js
+++ b/test/fixtures/fixtures.js
@@ -1370,3 +1370,13 @@ export function getBidRequestedPayload() {
'start': 1465426155412
};
}
+
+export function getCurrencyRates() {
+ return {
+ 'dataAsOf': '2017-04-25',
+ 'conversions': {
+ 'GBP': { 'CNY': 8.8282, 'JPY': 141.7, 'USD': 1.2824 },
+ 'USD': { 'CNY': 6.8842, 'GBP': 0.7798, 'JPY': 110.49 }
+ }
+ };
+}
diff --git a/test/fixtures/video/vastPayloadResponse.json b/test/fixtures/video/vastPayloadResponse.json
index 5ffdf99350b..9b621c21d30 100644
--- a/test/fixtures/video/vastPayloadResponse.json
+++ b/test/fixtures/video/vastPayloadResponse.json
@@ -8,6 +8,6 @@
"height": 480,
"mediaType": "video",
"requestId": "6172477f-987f-4523-a967-fa6d7a434ddf",
- "vastPayload": " {
+ improveDigitalAdapter = new Adapter();
+ sandbox = sinon.sandbox.create();
+ sandbox.stub(
+ utils,
+ 'getUniqueIdentifierStr',
+ function() {
+ var retValue = randomNumber.toString();
+ randomNumber++;
+ return retValue;
+ }
+ );
+ bidsRequestedOriginal = $$PREBID_GLOBAL$$._bidsRequested;
+ $$PREBID_GLOBAL$$._bidsRequested = [];
+ });
+
+ afterEach(() => {
+ sandbox.restore();
+ $$PREBID_GLOBAL$$._bidsRequested = bidsRequestedOriginal;
+ });
+
+ describe('callBids simpleBidRequest', () => {
+ beforeEach(() => {
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(simpleBidRequest);
+ });
+ it('should call loadScript with correct parameters', () => {
+ sinon.assert.calledOnce(adloader.loadScript);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543210%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%221a2b3c%22%2C%22pid%22%3A1012544%2C%22banner%22%3A%7B%7D%7D%5D%7D%7D', null);
+ });
+ });
+
+ describe('callBids simpleSmartTagBidRequest', () => {
+ beforeEach(() => {
+ randomNumber = 9876543210;
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(simpleSmartTagBidRequest);
+ });
+ it('should call loadScript with correct parameters', () => {
+ sinon.assert.calledOnce(adloader.loadScript);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543210%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%221a2b3c%22%2C%22pubid%22%3A1032%2C%22pkey%22%3A%22data_team_test_hb_smoke_test%22%2C%22banner%22%3A%7B%7D%7D%5D%7D%7D', null);
+ });
+ });
+
+ describe('callBids keyValueBidRequest', () => {
+ beforeEach(() => {
+ randomNumber = 9876543210;
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(keyValueBidRequest);
+ });
+ it('should call loadScript with correct parameters', () => {
+ sinon.assert.calledOnce(adloader.loadScript);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543210%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%221a2b3c%22%2C%22pid%22%3A1012546%2C%22kvw%22%3A%7B%22hbkv%22%3A%5B%2201%22%5D%7D%2C%22banner%22%3A%7B%7D%7D%5D%7D%7D', null);
+ });
+ });
+
+ describe('callBids sizeBidRequest', () => {
+ beforeEach(() => {
+ randomNumber = 9876543210;
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(sizeBidRequest);
+ });
+ it('should call loadScript with correct parameters', () => {
+ sinon.assert.calledOnce(adloader.loadScript);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543210%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%221a2b3c%22%2C%22pid%22%3A1012545%2C%22banner%22%3A%7B%22w%22%3A800%2C%22h%22%3A600%7D%7D%5D%7D%7D', null);
+ });
+ });
+
+ describe('callBids twoAdSlots', () => {
+ beforeEach(() => {
+ randomNumber = 9876543210;
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(twoAdSlots);
+ });
+ it('should call loadScript twice with correct parameters', () => {
+ sinon.assert.calledTwice(adloader.loadScript);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543210%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%221a2b3c%22%2C%22pid%22%3A1012544%2C%22banner%22%3A%7B%7D%7D%5D%7D%7D', null);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543211%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%224d5e6f%22%2C%22pid%22%3A1012545%2C%22banner%22%3A%7B%22w%22%3A800%2C%22h%22%3A600%7D%7D%5D%7D%7D', null);
+ });
+ });
+
+ describe('callBids threeAdSlots', () => {
+ beforeEach(() => {
+ randomNumber = 9876543210;
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(threeAdSlots);
+ });
+ it('should call loadScript thrice with correct parameters', () => {
+ sinon.assert.calledThrice(adloader.loadScript);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543210%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%221a2b3c%22%2C%22pid%22%3A1012544%2C%22banner%22%3A%7B%7D%7D%5D%7D%7D', null);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543211%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%224d5e6f%22%2C%22pid%22%3A1012545%2C%22banner%22%3A%7B%22w%22%3A800%2C%22h%22%3A600%7D%7D%5D%7D%7D', null);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543212%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%227g8h9i%22%2C%22pid%22%3A1012546%2C%22kvw%22%3A%7B%22hbkv%22%3A%5B%2201%22%5D%7D%2C%22banner%22%3A%7B%7D%7D%5D%7D%7D', null);
+ });
+ });
+
+ describe('callBids bad request 1', () => {
+ beforeEach(() => {
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(badRequest1);
+ });
+ it('should not call loadScript', () => {
+ sinon.assert.notCalled(adloader.loadScript);
+ });
+ });
+
+ describe('callBids twoAdSlotsSingleRequest', () => {
+ beforeEach(() => {
+ randomNumber = 9876543210;
+ sandbox.stub(
+ adloader,
+ 'loadScript'
+ );
+ improveDigitalAdapter.callBids(twoAdSlotsSingleRequest);
+ });
+ it('should call loadScript twice with correct parameters', () => {
+ sinon.assert.calledOnce(adloader.loadScript);
+ sinon.assert.calledWith(adloader.loadScript, 'http://ad.360yield.com/hb?jsonp=%7B%22bid_request%22%3A%7B%22id%22%3A%229876543210%22%2C%22callback%22%3A%22pbjs.improveDigitalResponse%22%2C%22secure%22%3A0%2C%22version%22%3A%22' + improveDigitalAdapter.LIB_VERSION + '-' + improveDigitalAdapter.idClient.CONSTANTS.CLIENT_VERSION + '%22%2C%22imp%22%3A%5B%7B%22id%22%3A%221a2b3c%22%2C%22pid%22%3A1012544%2C%22banner%22%3A%7B%7D%7D%2C%7B%22id%22%3A%224d5e6f%22%2C%22pid%22%3A1012545%2C%22banner%22%3A%7B%22w%22%3A800%2C%22h%22%3A600%7D%7D%5D%7D%7D', null);
+ });
+ });
+
+ describe('improveDigitalResponse no response', () => {
+ beforeEach(() => {
+ sandbox.stub(
+ bidmanager,
+ 'addBidResponse'
+ );
+ $$PREBID_GLOBAL$$._bidsRequested.push(simpleBidRequest);
+ improveDigitalAdapter.callBids(simpleBidRequest);
+ $$PREBID_GLOBAL$$.improveDigitalResponse([]);
+ });
+ it('should not call bidmanager.addBidResponse', () => {
+ sinon.assert.notCalled(bidmanager.addBidResponse);
+ });
+ });
+
+ describe('improveDigitalResponse simpleResponse', () => {
+ beforeEach(() => {
+ sandbox.stub(
+ bidmanager,
+ 'addBidResponse'
+ );
+ $$PREBID_GLOBAL$$._bidsRequested.push(simpleBidRequest);
+ improveDigitalAdapter.callBids(simpleBidRequest);
+ $$PREBID_GLOBAL$$.improveDigitalResponse(simpleResponse);
+ });
+ it('should call bidmanager.addBidResponse once with correct parameters', () => {
+ sinon.assert.calledOnce(bidmanager.addBidResponse);
+ sinon.assert.calledWith(bidmanager.addBidResponse, 'placement1', sinon.match({bidderCode: 'improvedigital', width: 300, height: 300, statusMessage: 'Bid available', ad: 'not end in "localSetupTest", adapter and
+ * mock bid requests are executed
+ * 3. Test titles ending in "localSetupTest" are special case tests and are
+ * expected to call setupTest(object, MAKE_BID_REQUEST) where
+ * applicable
+ * @param {object} testRequest bidder request bids fixture
+ * @param {boolean} force trigger adapter callBids and Yieldbot library request
+ * @private
+ */
+function setupTest(testRequest, force = false) {
sandbox = sinon.sandbox.create();
createYieldbotMockLib();
sandbox.stub(adLoader, 'loadScript');
- yieldbotLibStub = sandbox.stub(window.yieldbot);
- yieldbotLibStub.getSlotCriteria.restore();
+
+ yieldbotLibStub = {};
+ yieldbotLibStub.nextPageview = sandbox.stub(window.yieldbot, 'nextPageview');
+ yieldbotLibStub.defineSlot = sandbox.stub(window.yieldbot, 'defineSlot');
+ yieldbotLibStub.pub = sandbox.stub(window.yieldbot, 'pub');
+ yieldbotLibStub.enableAsync = sandbox.stub(window.yieldbot, 'enableAsync');
+
+ yieldbotLibStub.getSlotCriteria =
+ sandbox.stub(
+ window.yieldbot,
+ 'getSlotCriteria',
+ (slotName) => {
+ return YB_BID_FIXTURE[slotName] || {ybot_ad: 'n'};
+ });
+
+ yieldbotLibStub.go =
+ sandbox.stub(
+ window.yieldbot,
+ 'go',
+ () => {
+ window.yieldbot._initialized = true;
+ });
bidManagerStub = sandbox.stub(bidManager, 'addBidResponse');
- const adapter = new YieldbotAdapter();
- adapter.callBids(bidderRequest);
- mockYieldbotBidRequest();
+ const ybAdapter = new YieldbotAdapter();
+ let request = testRequest || cloneJson(bidderRequest);
+ if ((this && !this.currentTest.parent.title.match(localSetupTestRegex)) || force === MAKE_BID_REQUEST) {
+ ybAdapter.callBids(request);
+ mockYieldbotBidRequest();
+ }
+ return { adapter: ybAdapter, localRequest: request };
}
function restoreTest() {
@@ -97,15 +146,71 @@ function restoreTest() {
}
describe('Yieldbot adapter tests', function() {
- describe('callBids', function() {
- beforeEach(function () {
- setupTest();
+ let adapter;
+ let localRequest;
+ beforeEach(function () {
+ const testSetupCtx = setupTest.call(this);
+ adapter = testSetupCtx.adapter;
+ localRequest = testSetupCtx.localRequest;
+ });
+
+ afterEach(function() {
+ restoreTest();
+ });
+
+ describe('getUniqueSlotSizes', function() {
+ it('should return [] for string sizes', function() {
+ const sizes = adapter.getUniqueSlotSizes('widthxheight');
+ expect(sizes).to.deep.equal([]);
});
- afterEach(function() {
- restoreTest();
+ it('should return [] for Object sizes', function() {
+ const sizes = adapter.getUniqueSlotSizes({width: 300, height: 250});
+ expect(sizes).to.deep.equal([]);
+ });
+
+ it('should return [] for boolean sizes', function() {
+ const sizes = adapter.getUniqueSlotSizes(true);
+ expect(sizes).to.deep.equal([]);
});
+ it('should return [] for undefined sizes', function() {
+ const sizes = adapter.getUniqueSlotSizes(undefined);
+ expect(sizes).to.deep.equal([]);
+ });
+
+ it('should return [] for function sizes', function() {
+ const sizes = adapter.getUniqueSlotSizes(function () {});
+ expect(sizes).to.deep.equal([]);
+ });
+
+ it('should return [] for number sizes', function() {
+ const sizes = adapter.getUniqueSlotSizes(1111);
+ expect(sizes).to.deep.equal([]);
+ });
+
+ it('should return [] for array of numbers', function() {
+ const sizes = adapter.getUniqueSlotSizes([300, 250]);
+ expect(sizes).to.deep.equal([]);
+ });
+
+ it('should return array of unique strings', function() {
+ const sizes = adapter.getUniqueSlotSizes(['300x250', '300x600', '728x90', '300x250']);
+ expect(sizes).to.deep.equal([['300', '250'], ['300', '600'], ['728', '90']]);
+ });
+
+ it('should return array of unique strings for string elements only', function() {
+ const sizes = adapter.getUniqueSlotSizes(['300x250', ['threexfour']]);
+ expect(sizes).to.deep.equal([['300', '250']]);
+ });
+
+ it('should return array of unique strings, including non-numeric', function() {
+ const sizes = adapter.getUniqueSlotSizes(['300x250', 'threexfour', 'fivexsix']);
+ expect(sizes).to.deep.equal([['300', '250'], ['three', 'four'], ['five', 'si']]);
+ });
+ });
+
+ describe('callBids', function() {
it('should request the yieldbot library', function() {
sinon.assert.calledOnce(adLoader.loadScript);
sinon.assert.calledWith(adLoader.loadScript, '//cdn.yldbt.com/js/yieldbot.intent.js');
@@ -116,24 +221,35 @@ describe('Yieldbot adapter tests', function() {
sinon.assert.calledWith(yieldbotLibStub.pub, '1234');
});
- it('should define yieldbot slots', function() {
+ it('should not repeat multiply defined slot sizes', function() {
sinon.assert.calledTwice(yieldbotLibStub.defineSlot);
- sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'medrec', {sizes: [[300, 250], [300, 600]]});
- sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'leaderboard', {sizes: [[728, 90], [970, 90]]});
+ sinon.assert.neverCalledWith(yieldbotLibStub.defineSlot, 'medrec', {sizes: [['300', '250'], ['300', '600'], ['300', '250']]});
});
- it('should not use inherited Object properties', function() {
- restoreTest();
+ it('should define yieldbot slots', function() {
+ sinon.assert.calledTwice(yieldbotLibStub.defineSlot);
+ sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'medrec', {sizes: [['300', '250'], ['300', '600']]});
+ sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'leaderboard', {sizes: [['728', '90'], ['970', '90']]});
+ });
+ it('should not use inherited Object properties, localSetupTest', function() {
let oProto = Object.prototype;
- oProto.superProp = [300, 250];
+ oProto.superProp = ['300', '250'];
expect(Object.prototype.superProp).to.be.an('array');
- setupTest();
+ localRequest.bids.forEach((bid) => {
+ expect(bid.superProp).to.be.an('array');
+ });
+
+ expect(YB_BID_FIXTURE.medrec.superProp).to.deep.equal(['300', '250']);
+ expect(YB_BID_FIXTURE.leaderboard.superProp).to.deep.equal(['300', '250']);
- sinon.assert.neverCalledWith(yieldbotLibStub.defineSlot, 'superProp', {sizes: [300, 250]});
- sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'medrec', {sizes: [[300, 250], [300, 600]]});
- sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'leaderboard', {sizes: [[728, 90], [970, 90]]});
+ restoreTest();
+ setupTest(localRequest, MAKE_BID_REQUEST);
+
+ sinon.assert.neverCalledWith(yieldbotLibStub.defineSlot, 'superProp', {sizes: ['300', '250']});
+ sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'medrec', {sizes: [['300', '250'], ['300', '600']]});
+ sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'leaderboard', {sizes: [['728', '90'], ['970', '90']]});
delete oProto.superProp;
expect(Object.prototype.superProp).to.be.an('undefined');
@@ -145,7 +261,7 @@ describe('Yieldbot adapter tests', function() {
it('should add bid response after yieldbot request callback', function() {
const plc1 = bidManagerStub.firstCall.args[0];
- expect(plc1).to.equal(bidderRequest.bids[0].placementCode);
+ expect(plc1).to.equal(localRequest.bids[0].placementCode);
const pb_bid1 = bidManagerStub.firstCall.args[1];
expect(pb_bid1.bidderCode).to.equal('yieldbot');
@@ -161,7 +277,7 @@ describe('Yieldbot adapter tests', function() {
expect(pb_bid1.ad).to.match(/yieldbot\.renderAd\('medrec:300x250'\)/);
const plc2 = bidManagerStub.secondCall.args[0];
- expect(plc2).to.equal(bidderRequest.bids[1].placementCode);
+ expect(plc2).to.equal(localRequest.bids[1].placementCode);
const pb_bid2 = bidManagerStub.secondCall.args[1];
expect(pb_bid2.bidderCode).to.equal('yieldbot');
@@ -169,104 +285,234 @@ describe('Yieldbot adapter tests', function() {
expect(pb_bid2.height).to.equal(0);
expect(pb_bid2.statusMessage).to.match(/empty.*response/);
});
- });
- describe('callBids, refresh', function() {
- beforeEach(function () {
- if (sandbox) { sandbox.restore(); }
- sandbox = sinon.sandbox.create();
+ it('should validate slot dimensions, localSetupTest', function() {
+ let invalidSizeBid = {
+ bidId: '2640ad280208ce',
+ sizes: [[728, 90], [300, 250], [970, 90]],
+ bidder: 'yieldbot',
+ bidderRequestId: '187a340cb9ccc3',
+ params: { psn: '1234', slot: 'medrec' },
+ requestId: '5f297a1f-3163-46c2-854f-b55fd2e74ec3',
+ placementCode: '/4294967296/adunit3'
+ };
+
+ const bidResponseMedrec = {
+ bidderCode: 'yieldbot',
+ width: '300',
+ height: '250',
+ statusMessage: 'Bid available',
+ cpm: 2,
+ ybot_ad: 'y',
+ ybot_slot: 'medrec',
+ ybot_cpm: '200',
+ ybot_size: '300x250'
+ };
+
+ localRequest.bids = [invalidSizeBid];
+ restoreTest();
+ setupTest(localRequest, MAKE_BID_REQUEST);
- createYieldbotMockLib();
+ let bidManagerFirstCall = bidManagerStub.firstCall;
- sandbox.stub(adLoader, 'loadScript');
- yieldbotLibStub = sandbox.stub(window.yieldbot);
- yieldbotLibStub.getSlotCriteria.restore();
- yieldbotLibStub.go.restore();
- bidManagerStub = sandbox.stub(bidManager, 'addBidResponse');
+ expect(bidManagerFirstCall.args[0]).to.equal('/4294967296/adunit3');
+ expect(bidManagerFirstCall.args[1]).to.include(bidResponseMedrec);
});
- afterEach(function() {
- sandbox.restore();
- restoreYieldbotMockLib();
+ it('should make slot bid available once only', function() {
+ const bidResponseMedrec = {
+ bidderCode: 'yieldbot',
+ width: '300',
+ height: '250',
+ statusMessage: 'Bid available',
+ cpm: 2,
+ ybot_ad: 'y',
+ ybot_slot: 'medrec',
+ ybot_cpm: '200',
+ ybot_size: '300x250'
+ };
+
+ const bidResponseNone = {
+ bidderCode: 'yieldbot',
+ width: 0,
+ height: 0,
+ statusMessage: 'Bid returned empty or error response'
+ };
+
+ let firstCall = bidManagerStub.firstCall;
+ let secondCall = bidManagerStub.secondCall;
+ let thirdCall = bidManagerStub.thirdCall;
+
+ expect(firstCall.args[0]).to.equal('/4294967296/adunit0');
+ expect(firstCall.args[1]).to.include(bidResponseMedrec);
+
+ expect(secondCall.args[0]).to.equal('/4294967296/adunit1');
+ expect(secondCall.args[1]).to.include(bidResponseNone);
+
+ expect(thirdCall.args[0]).to.equal('/4294967296/adunit2');
+ expect(thirdCall.args[1]).to.include(bidResponseNone);
});
+ });
+ describe('callBids, refresh', function() {
it('should use yieldbot.nextPageview after first callBids', function() {
- const adapter = new YieldbotAdapter();
- adapter.callBids(bidderRequest);
- mockYieldbotBidRequest();
-
expect(window.yieldbot._initialized).to.equal(true);
- adapter.callBids(bidderRequest);
+ adapter.callBids(localRequest);
mockYieldbotBidRequest();
sinon.assert.calledOnce(yieldbotLibStub.nextPageview);
});
it('should call yieldbot.nextPageview with slot config of requested bids', function() {
- window.$$PREBID_GLOBAL$$._bidsRequested = window.$$PREBID_GLOBAL$$._bidsRequested.filter(o => {
- return o.bidderCode !== 'yieldbot';
- });
-
- const adapter = new YieldbotAdapter();
- adapter.callBids(bidderRequest);
- mockYieldbotBidRequest();
-
expect(window.yieldbot._initialized).to.equal(true);
sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'medrec');
sinon.assert.calledWith(yieldbotLibStub.defineSlot, 'leaderboard');
- window.$$PREBID_GLOBAL$$._bidsRequested = window.$$PREBID_GLOBAL$$._bidsRequested.filter(o => {
- return o.bidderCode !== 'yieldbot';
- });
-
- const refreshBids = bidderRequest.bids.filter((object) => { return object.placementCode === '/4294967296/adunit1'; });
- let refreshRequest = Object.assign({}, bidderRequest);
+ const refreshBids = localRequest.bids.filter((object) => { return object.placementCode === '/4294967296/adunit1'; });
+ let refreshRequest = cloneJson(localRequest);
refreshRequest.bids = refreshBids;
expect(refreshRequest.bids.length).to.equal(1);
adapter.callBids(refreshRequest);
mockYieldbotBidRequest();
- const bid = refreshBids[0];
- const expectedSlots = { 'leaderboard': [[728, 90], [970, 90]] };
+ const expectedSlots = { 'leaderboard': [['728', '90'], ['970', '90']] };
sinon.assert.calledWithExactly(yieldbotLibStub.nextPageview, expectedSlots);
});
- it('should not throw on callBids without bidsRequested', function() {
- const adapter = new YieldbotAdapter();
- adapter.callBids(bidderRequest);
+ it('should not repeat multiply defined slot sizes', function() {
+ // placementCode: '/4294967296/adunit0'
+ // placementCode: '/4294967296/adunit2'
+ // Both placements declare medrec:300x250
+ adapter.callBids(localRequest);
mockYieldbotBidRequest();
+ sinon.assert.calledOnce(yieldbotLibStub.nextPageview);
+ const expectedSlots = { 'leaderboard': [['728', '90'], ['970', '90']], 'medrec': [['300', '250'], ['300', '600']]};
+ sinon.assert.calledWithExactly(yieldbotLibStub.nextPageview, expectedSlots);
+ });
+
+ it('should not add empty bidResponse on callBids without bidsRequested', function() {
expect(window.yieldbot._initialized).to.equal(true);
+ expect(bidManagerStub.calledThrice).to.equal(true);
+
+ adapter.callBids({});
+ mockYieldbotBidRequest();
+
+ expect(bidManagerStub.calledThrice).to.equal(true); // the initial bids
+ sinon.assert.notCalled(yieldbotLibStub.nextPageview);
+ });
- window.$$PREBID_GLOBAL$$._bidsRequested = window.$$PREBID_GLOBAL$$._bidsRequested.filter(o => {
- return o.bidderCode !== 'yieldbot';
+ it('should validate slot dimensions', function() {
+ localRequest.bids.map(bid => {
+ bid.sizes = [[640, 480], [1024, 768]];
});
- adapter.callBids(bidderRequest);
+ const bidResponseNone = {
+ bidderCode: 'yieldbot',
+ width: 0,
+ height: 0,
+ statusMessage: 'Bid returned empty or error response'
+ };
+
+ adapter.callBids(localRequest);
mockYieldbotBidRequest();
- sinon.assert.calledOnce(yieldbotLibStub.nextPageview);
+
+ expect(bidManagerStub.getCalls().length).to.equal(6);
+
+ let lastNextPageview = yieldbotLibStub.nextPageview.lastCall;
+ let nextPageviewSlots = lastNextPageview.args[0];
+ expect(nextPageviewSlots.medrec).to.deep.equal([['640', '480'], ['1024', '768']]);
+ expect(nextPageviewSlots.leaderboard).to.deep.equal([['640', '480'], ['1024', '768']]);
+
+ let fourthCall = bidManagerStub.getCall(3);
+ let fifthCall = bidManagerStub.getCall(4);
+ let sixthCall = bidManagerStub.getCall(5);
+
+ expect(fourthCall.args[0]).to.equal('/4294967296/adunit0');
+ expect(fourthCall.args[1]).to.include(bidResponseNone);
+
+ expect(fifthCall.args[0]).to.equal('/4294967296/adunit1');
+ expect(fifthCall.args[1]).to.include(bidResponseNone);
+
+ expect(sixthCall.args[0]).to.equal('/4294967296/adunit2');
+ expect(sixthCall.args[1]).to.include(bidResponseNone);
});
- it('should not add empty bidResponse on callBids without bidsRequested', function() {
- window.$$PREBID_GLOBAL$$._bidsRequested = window.$$PREBID_GLOBAL$$._bidsRequested.filter(o => {
- return o.bidderCode !== 'yieldbot';
+ it('should not make requests for previously requested bids', function() {
+ const bidResponseMedrec = {
+ bidderCode: 'yieldbot',
+ width: '300',
+ height: '250',
+ statusMessage: 'Bid available',
+ cpm: 2,
+ ybot_ad: 'y',
+ ybot_slot: 'medrec',
+ ybot_cpm: '200',
+ ybot_size: '300x250'
+ };
+
+ const bidResponseNone = {
+ bidderCode: 'yieldbot',
+ width: 0,
+ height: 0,
+ statusMessage: 'Bid returned empty or error response'
+ };
+
+ // Refresh #1
+ adapter.callBids(localRequest);
+ mockYieldbotBidRequest();
+
+ expect(bidManagerStub.getCalls().length).to.equal(6);
+
+ let lastNextPageview = yieldbotLibStub.nextPageview.lastCall;
+ let nextPageviewSlots = lastNextPageview.args[0];
+ expect(nextPageviewSlots.medrec).to.deep.equal([['300', '250'], ['300', '600']]);
+ expect(nextPageviewSlots.leaderboard).to.deep.equal([['728', '90'], ['970', '90']]);
+
+ let fourthCall = bidManagerStub.getCall(3);
+ let fifthCall = bidManagerStub.getCall(4);
+ let sixthCall = bidManagerStub.getCall(5);
+
+ expect(fourthCall.args[0]).to.equal('/4294967296/adunit0');
+ expect(fourthCall.args[1]).to.include(bidResponseMedrec);
+
+ expect(fifthCall.args[0]).to.equal('/4294967296/adunit1');
+ expect(fifthCall.args[1]).to.include(bidResponseNone);
+
+ expect(sixthCall.args[0]).to.equal('/4294967296/adunit2');
+ expect(sixthCall.args[1]).to.include(bidResponseNone);
+
+ localRequest.bids.map(bid => {
+ bid.sizes = [[640, 480], [1024, 768]];
});
+ let bidForNinethCall = localRequest.bids[localRequest.bids.length - 1];
+ bidForNinethCall.sizes = [[300, 250]];
- const adapter = new YieldbotAdapter();
- adapter.callBids(bidderRequest);
+ // Refresh #2
+ adapter.callBids(localRequest);
mockYieldbotBidRequest();
- let bidResponses = window.$$PREBID_GLOBAL$$._bidsReceived.filter(o => {
- return o.bidderCode === 'yieldbot';
- });
+ expect(bidManagerStub.getCalls().length).to.equal(9);
- expect(bidResponses.length).to.equal(0);
+ lastNextPageview = yieldbotLibStub.nextPageview.lastCall;
+ nextPageviewSlots = lastNextPageview.args[0];
+ expect(nextPageviewSlots.medrec).to.deep.equal([['640', '480'], ['1024', '768'], ['300', '250']]);
+ expect(nextPageviewSlots.leaderboard).to.deep.equal([['640', '480'], ['1024', '768']]);
- adapter.callBids(bidderRequest);
- mockYieldbotBidRequest();
- sinon.assert.calledOnce(yieldbotLibStub.nextPageview);
+ let seventhCall = bidManagerStub.getCall(6);
+ let eighthCall = bidManagerStub.getCall(7);
+ let ninethCall = bidManagerStub.getCall(8);
+
+ expect(seventhCall.args[0]).to.equal('/4294967296/adunit0');
+ expect(seventhCall.args[1]).to.include(bidResponseNone);
+
+ expect(eighthCall.args[0]).to.equal('/4294967296/adunit1');
+ expect(eighthCall.args[1]).to.include(bidResponseNone);
+
+ expect(ninethCall.args[0]).to.equal('/4294967296/adunit2');
+ expect(ninethCall.args[1]).to.include(bidResponseMedrec);
});
});
});
diff --git a/test/spec/unit/bidmanager_spec.js b/test/spec/unit/bidmanager_spec.js
index f70c9906440..d51a0ab8a8f 100644
--- a/test/spec/unit/bidmanager_spec.js
+++ b/test/spec/unit/bidmanager_spec.js
@@ -59,7 +59,7 @@ describe('The Bid Manager', () => {
expect(bid.cpm).to.equal(adjustCpm(0.1));
if (usePayloadResponse) {
- expect(bid.vastPayload).to.equal('