3648 prebidjs pxyz adapter

gulpfile.js

@@ -39,7 +39,7 @@ var port = 9999;
 // Tasks
 gulp.task('default', ['webpack']);
 
-gulp.task('serve', ['lint', 'build-bundle-dev', 'watch', 'test']);
+gulp.task('serve', ['build-bundle-dev', 'watch']);
 
 gulp.task('serve-nw', ['lint', 'watch', 'e2etest']);
 
@@ -49,8 +49,8 @@ gulp.task('build', ['build-bundle-prod']);
 
 gulp.task('clean', function () {
  return gulp.src(['build'], {
-  read: false
-  })
+ read: false
+ })
  .pipe(clean());
 });
 
@@ -78,13 +78,13 @@ var explicitModules = [
 
 function bundle(dev, moduleArr) {
  var modules = moduleArr || helpers.getArgModules(),
-  allModules = helpers.getModuleNames(modules);
+ allModules = helpers.getModuleNames(modules);
 
- if(modules.length === 0) {
+ if (modules.length === 0) {
  modules = allModules.filter(module => !explicitModules.includes(module));
  } else {
  var diff = _.difference(modules, allModules);
- if(diff.length !== 0) {
+ if (diff.length !== 0) {
  throw new gutil.PluginError({
  plugin: 'bundle',
  message: 'invalid modules: ' + diff.join(', ')
@@ -106,13 +106,13 @@ function bundle(dev, moduleArr) {
  gutil.log('Generating bundle:', outputFileName);
 
  return gulp.src(
-  entries
-  )
+ entries
+ )
  .pipe(gulpif(dev, sourcemaps.init({loadMaps: true})))
  .pipe(concat(outputFileName))
  .pipe(gulpif(!argv.manualEnable, footer('\n<%= global %>.processQueue();', {
-  global: prebid.globalVarName
-  }
+ global: prebid.globalVarName
+ }
  )))
  .pipe(gulpif(dev, sourcemaps.write('.')));
 }
@@ -229,11 +229,11 @@ gulp.task('watch', function () {
  'modules/**/*.js',
  'test/spec/**/*.js',
  '!test/spec/loaders/**/*.js'
- ], ['lint', 'build-bundle-dev', 'test']);
+ ], ['build-bundle-dev']);
  gulp.watch([
  'loaders/**/*.js',
  'test/spec/loaders/**/*.js'
- ], ['lint']);
+ ], []);
  connect.server({
  https: argv.https,
  port: port,
@@ -264,7 +264,7 @@ gulp.task('docs', ['clean-docs'], function () {
 
 gulp.task('e2etest', ['devpack', 'webpack'], function() {
  var cmdQueue = [];
- if(argv.browserstack) {
+ if (argv.browserstack) {
  var browsers = require('./browsers.json');
  delete browsers['bs_ie_9_windows_7'];
 
@@ -276,11 +276,11 @@ gulp.task('e2etest', ['devpack', 'webpack'], function() {
 
  var startWith = 'bs';
 
- Object.keys(browsers).filter(function(v){
+ Object.keys(browsers).filter(function(v) {
  return v.substring(0, startWith.length) === startWith && browsers[v].browser !== 'iphone';
- }).map(function(v,i,arr) {
- var newArr = (i%2 === 0) ? arr.slice(i,i+2) : null;
- if(newArr) {
+ }).map(function(v, i, arr) {
+ var newArr = (i % 2 === 0) ? arr.slice(i, i + 2) : null;
+ if (newArr) {
  var cmd = 'nightwatch --env ' + newArr.join(',') + cmdStr;
  cmdQueue.push(cmd);
  }

karma.conf.maker.js

@@ -142,7 +142,8 @@ module.exports = function(codeCoverage, browserstack, watchMode, file) {
 
  reporters: ['mocha'],
  mochaReporter: {
- showDiff: true
+ showDiff: true,
+ output: 'minimal'
  },
 
  // Continuous Integration mode

modules/aardvarkBidAdapter.js

@@ -0,0 +1,159 @@
+import * as utils from 'src/utils';
+import {registerBidder} from 'src/adapters/bidderFactory';
+
+const BIDDER_CODE = 'aardvark';
+const DEFAULT_ENDPOINT = 'bidder.rtk.io';
+const SYNC_ENDPOINT = 'sync.rtk.io';
+const AARDVARK_TTL = 300;
+const AARDVARK_CURRENCY = 'USD';
+
+let hasSynced = false;
+
+export function resetUserSync() {
+ hasSynced = false;
+}
+
+export const spec = {
+ code: BIDDER_CODE,
+
+ isBidRequestValid: function(bid) {
+ return ((typeof bid.params.ai === 'string') && !!bid.params.ai.length &&
+ (typeof bid.params.sc === 'string') && !!bid.params.sc.length);
+ },
+
+ buildRequests: function(validBidRequests, bidderRequest) {
+ var auctionCodes = [];
+ var requests = [];
+ var requestsMap = {};
+ var referer = utils.getTopWindowUrl();
+ var pageCategories = [];
+
+ if (window.top.rtkcategories && Array.isArray(window.top.rtkcategories)) {
+ pageCategories = window.top.rtkcategories;
+ }
+
+ utils._each(validBidRequests, function(b) {
+ var rMap = requestsMap[b.params.ai];
+ if (!rMap) {
+ rMap = {
+ shortCodes: [],
+ payload: {
+ version: 1,
+ jsonp: false,
+ rtkreferer: referer
+ },
+ endpoint: DEFAULT_ENDPOINT
+ };
+
+ if (pageCategories && pageCategories.length) {
+ rMap.payload.categories = pageCategories.slice(0);
+ }
+
+ if (b.params.categories && b.params.categories.length) {
+ rMap.payload.categories = rMap.payload.categories || []
+ utils._each(b.params.categories, function(cat) {
+ rMap.payload.categories.push(cat);
+ });
+ }
+
+ if (bidderRequest && bidderRequest.gdprConsent) {
+ rMap.payload.gdpr = false;
+ if (typeof bidderRequest.gdprConsent.gdprApplies === 'boolean') {
+ rMap.payload.gdpr = bidderRequest.gdprConsent.gdprApplies;
+ }
+ if (rMap.payload.gdpr) {
+ rMap.payload.consent = bidderRequest.gdprConsent.consentString;
+ }
+ }
+
+ requestsMap[b.params.ai] = rMap;
+ auctionCodes.push(b.params.ai);
+ }
+
+ rMap.shortCodes.push(b.params.sc);
+ rMap.payload[b.params.sc] = b.bidId;
+
+ if ((typeof b.params.host === 'string') && b.params.host.length &&
+ (b.params.host !== rMap.endpoint)) {
+ rMap.endpoint = b.params.host;
+ }
+ });
+
+ utils._each(auctionCodes, function(auctionId) {
+ var req = requestsMap[auctionId];
+ requests.push({
+ method: 'GET',
+ url: `//${req.endpoint}/${auctionId}/${req.shortCodes.join('_')}/aardvark`,
+ data: req.payload,
+ bidderRequest
+ });
+ });
+
+ return requests;
+ },
+
+ interpretResponse: function(serverResponse, bidRequest) {
+ var bidResponses = [];
+
+ if (!Array.isArray(serverResponse.body)) {
+ serverResponse.body = [serverResponse.body];
+ }
+
+ utils._each(serverResponse.body, function(rawBid) {
+ var bidResponse = {
+ requestId: rawBid.cid,
+ cpm: rawBid.cpm || 0,
+ width: rawBid.width || 0,
+ height: rawBid.height || 0,
+ currency: rawBid.currency ? rawBid.currency : AARDVARK_CURRENCY,
+ netRevenue: rawBid.netRevenue ? rawBid.netRevenue : true,
+ ttl: rawBid.ttl ? rawBid.ttl : AARDVARK_TTL,
+ creativeId: rawBid.creativeId || 0
+ };
+
+ if (rawBid.hasOwnProperty('dealId')) {
+ bidResponse.dealId = rawBid.dealId
+ }
+
+ switch (rawBid.media) {
+ case 'banner':
+ bidResponse.ad = rawBid.adm + utils.createTrackPixelHtml(decodeURIComponent(rawBid.nurl));
+ break;
+
+ default:
+ return utils.logError('bad Aardvark response (media)', rawBid);
+ }
+
+ bidResponses.push(bidResponse);
+ });
+
+ return bidResponses;
+ },
+
+ getUserSyncs: function(syncOptions, serverResponses, gdprConsent) {
+ const syncs = [];
+ var url = '//' + SYNC_ENDPOINT + '/cs';
+ var gdprApplies = false;
+ if (gdprConsent && (typeof gdprConsent.gdprApplies === 'boolean')) {
+ gdprApplies = gdprConsent.gdprApplies;
+ }
+
+ if (syncOptions.iframeEnabled) {
+ if (!hasSynced) {
+ hasSynced = true;
+ if (gdprApplies) {
+ url = url + '?g=1&c=' + encodeURIComponent(gdprConsent.consentString);
+ }
+ syncs.push({
+ type: 'iframe',
+ url: url
+ });
+ }
+ } else {
+ utils.logWarn('Aardvark: Please enable iframe based user sync.');
+ }
+ return syncs;
+ }
+};
+
+registerBidder(spec);

modules/aardvarkBidAdapter.md

@@ -0,0 +1,30 @@
+# Overview
+
+**Module Name**: Aardvark Bidder Adapter
+**Module Type**: Bidder Adapter
+**Maintainer**: chris@rtk.io
+
+# Description
+
+Module that connects to a RTK.io Ad Units to fetch bids.
+
+# Test Parameters
+```
+ var adUnits = [{
+ mediaTypes: {
+ banner: {
+ sizes: [[300, 250]],
+ }
+ },
+ code: 'div-gpt-ad-1460505748561-0',
+
+ bids: [{
+ bidder: 'aardvark',
+ params: {
+ ai: '0000',
+ sc: '1234'
+ }
+ }]
+
+ }];
+```

modules/consentManagement.js

@@ -37,8 +37,9 @@ const cmpCallMap = {
  * based on the appropriate result.
  * @param {function(string)} cmpSuccess acts as a success callback when CMP returns a value; pass along consentObject (string) from CMP
  * @param {function(string)} cmpError acts as an error callback while interacting with CMP; pass along an error message (string)
+ * @param {[objects]} adUnits used in the safeframe workflow to know what sizes to include in the $sf.ext.register call
  */
-function lookupIabConsent(cmpSuccess, cmpError) {
+function lookupIabConsent(cmpSuccess, cmpError, adUnits) {
  let cmpCallbacks;
 
  // check if the CMP is located on the same window level as the prebid code.
@@ -47,10 +48,37 @@ function lookupIabConsent(cmpSuccess, cmpError) {
  // in this case, use the IAB's iframe locator sample code (which is slightly cutomized) to try to find the CMP and use postMessage() to communicate with the CMP.
  if (utils.isFn(window.__cmp)) {
  window.__cmp('getVendorConsents', null, cmpSuccess);
+ } else if (inASafeFrame() && typeof window.$sf.ext.cmp === 'function') {
+ callCmpWhileInSafeFrame();
  } else {
  callCmpWhileInIframe();
  }
 
+ function inASafeFrame() {
+ return !!(window.$sf && window.$sf.ext);
+ }
+
+ function callCmpWhileInSafeFrame() {
+ function sfCallback(msgName, data) {
+ if (msgName === 'cmpReturn') {
+ cmpSuccess(data.vendorConsents);
+ }
+ }
+
+ // find sizes from adUnits object
+ let width = 1;
+ let height = 1;
+
+ if (Array.isArray(adUnits) && adUnits.length > 0) {
+ let sizes = utils.getAdUnitSizes(adUnits[0]);
+ width = sizes[0][0];
+ height = sizes[0][1];
+ }
+
+ window.$sf.ext.register(width, height, sfCallback);
+ window.$sf.ext.cmp('getVendorConsents');
+ }
+
  function callCmpWhileInIframe() {
  /**
  * START OF STOCK CODE FROM IAB 1.1 CMP SPEC
@@ -134,6 +162,7 @@ export function requestBidsHook(config, fn) {
  args = arguments;
  nextFn = fn;
  haveExited = false;
+ let adUnits = config.adUnits || $$PREBID_GLOBAL$$.adUnits;
 
  // in case we already have consent (eg during bid refresh)
  if (consentData) {
@@ -145,7 +174,7 @@ export function requestBidsHook(config, fn) {
  return nextFn.apply(context, args);
  }
 
- cmpCallMap[userCMP].call(this, processCmpData, cmpFailed);
+ cmpCallMap[userCMP].call(this, processCmpData, cmpFailed, adUnits);
 
  // only let this code run if module is still active (ie if the callbacks used by CMPs haven't already finished)
  if (!haveExited) {
@@ -245,6 +274,7 @@ function exitModule(errMsg) {
  */
 export function resetConsentData() {
  consentData = undefined;
+ gdprDataHandler.setConsentData(null);
 }
 
 /**