Skip to content

Commit

Permalink
Feature/update sublime adapter (#21)
Browse files Browse the repository at this point in the history 
* Update sublimeBidAdapter to 0.5.1
* Add tests for private functions
* Remove window.sublime
* Update pixel name for bid event
  • Loading branch information
@SublimeLeo
SublimeLeo authored and Léo GRAND committed Apr 7, 2020
1 parent f2fbf49 commit e14b9e9
Show file tree
Hide file tree
Showing 2 changed files with 221 additions and 114 deletions.
306 changes: 193 additions & 113 deletions modules/sublimeBidAdapter.js
View file
Original file line number Diff line number Diff line change
@@ -1,137 +1,217 @@
import { registerBidder } from '../src/adapters/bidderFactory.js';
import { config } from '../src/config.js';
import * as utils from '../src/utils.js';
import * as url from '../src/url.js';

const BIDDER_CODE = 'sublime';
const DEFAULT_BID_HOST = 'pbjs.sskzlabs.com';
const DEFAULT_CURRENCY = 'EUR';
const DEFAULT_PROTOCOL = 'https';
const DEFAULT_TTL = 600;
const SUBLIME_ANTENNA = 'antenna.ayads.co';
const SUBLIME_VERSION = '0.5.1';

export const spec = {
code: BIDDER_CODE,
gvlid: 114,
aliases: [],
/**
* Debug log message
* @param {String} msg
* @param {Object=} obj
*/
export function log(msg, obj) {
utils.logInfo('SublimeBidAdapter - ' + msg, obj);
}

// Default state
export const state = {
zoneId: '',
transactionId: ''
};

/**
* Set a new state
* @param {Object} value
*/
export function setState(value) {
Object.assign(state, value);
log('State has been updated :', state);
}

/**
* Send pixel to our debug endpoint
* @param {string} eventName - Event name that will be send in the e= query string
* @param {Boolean=} isMandatoryPixel - If set to true, will always send the pixel
*/
export function sendEvent(eventName, isMandatoryPixel = false) {
const shoudSendPixel = (isMandatoryPixel || state.debug);
const ts = Date.now();
const eventObject = {
t: ts,
tse: ts,
z: state.zoneId,
e: eventName,
src: 'pa',
puid: state.transactionId,
trId: state.transactionId,
ver: SUBLIME_VERSION,
};

if (shoudSendPixel) {
log('Sending pixel for event: ' + eventName, eventObject);

const queryString = url.formatQS(eventObject);
utils.triggerPixel('https://' + SUBLIME_ANTENNA + '/?' + queryString);
} else {
log('Not sending pixel for event (use debug: true to send it): ' + eventName, eventObject);
}
}

/**
* Determines whether or not the given bid request is valid.
*
* @param {BidRequest} bid The bid params to validate.
* @return {Boolean} True if this is a valid bid, and false otherwise.
*/
function isBidRequestValid(bid) {
return !!Number(bid.params.zoneId);
}

/**
* Make a server request from the list of BidRequests.
*
* @param {BidRequest[]} validBidRequests - An array of bids
* @param {Object} bidderRequest - Info describing the request to the server.
* @return {ServerRequest|ServerRequest[]} - Info describing the request to the server.
*/
function buildRequests(validBidRequests, bidderRequest) {
const commonPayload = {
pbav: SUBLIME_VERSION,
// Current Prebid params
prebidVersion: '$prebid.version$',
currencyCode: config.getConfig('currency.adServerCurrency') || DEFAULT_CURRENCY,
timeout: (typeof bidderRequest === 'object' && !!bidderRequest) ? bidderRequest.timeout : config.getConfig('bidderTimeout'),
};

// RefererInfo
if (bidderRequest && bidderRequest.refererInfo) {
commonPayload.referer = bidderRequest.refererInfo.referer;
commonPayload.numIframes = bidderRequest.refererInfo.numIframes;
}
// GDPR handling
if (bidderRequest && bidderRequest.gdprConsent) {
commonPayload.gdprConsent = bidderRequest.gdprConsent.consentString;
commonPayload.gdpr = bidderRequest.gdprConsent.gdprApplies; // we're handling the undefined case server side
}

return validBidRequests.map(bid => {
const bidHost = bid.params.bidHost || DEFAULT_BID_HOST;
const protocol = bid.params.protocol || DEFAULT_PROTOCOL;

setState({
transactionId: bid.transactionId,
zoneId: bid.params.zoneId,
debug: bid.params.debug || false,
});

/**
* Determines whether or not the given bid request is valid.
*
* @param {BidRequest} bid The bid params to validate.
* @return boolean True if this is a valid bid, and false otherwise.
*/
isBidRequestValid: (bid) => {
return !!bid.params.zoneId;
},

/**
* Make a server request from the list of BidRequests.
*
* @param {BidRequest[]} validBidRequests An array of bids
* @param {Object} bidderRequest - Info describing the request to the server.
* @return ServerRequest Info describing the request to the server.
*/
buildRequests: (validBidRequests, bidderRequest) => {
let commonPayload = {
pbav: SUBLIME_VERSION,
// Current Prebid params
prebidVersion: '$prebid.version$',
currencyCode: config.getConfig('currency.adServerCurrency') || DEFAULT_CURRENCY,
timeout: config.getConfig('bidderTimeout'),
const bidPayload = {
adUnitCode: bid.adUnitCode,
auctionId: bid.auctionId,
bidder: bid.bidder,
bidderRequestId: bid.bidderRequestId,
bidRequestsCount: bid.bidRequestsCount,
requestId: bid.bidId,
sizes: bid.sizes.map(size => ({
w: size[0],
h: size[1],
})),
transactionId: bid.transactionId,
zoneId: bid.params.zoneId,
};

// RefererInfo
if (bidderRequest && bidderRequest.refererInfo) {
commonPayload.referer = bidderRequest.refererInfo.referer;
commonPayload.numIframes = bidderRequest.refererInfo.numIframes;
const payload = Object.assign({}, commonPayload, bidPayload);

return {
method: 'POST',
url: protocol + '://' + bidHost + '/bid',
data: payload,
options: {
contentType: 'application/json',
withCredentials: true
},
}
// GDPR handling
if (bidderRequest && bidderRequest.gdprConsent) {
commonPayload.gdprConsent = bidderRequest.gdprConsent.consentString;
commonPayload.gdpr = bidderRequest.gdprConsent.gdprApplies; // we're handling the undefined case server side
});
}

/**
* Unpack the response from the server into a list of bids.
*
* @param {*} serverResponse A successful response from the server.
* @param {*} bidRequest An object with bid request informations
* @return {Bid[]} An array of bids which were nested inside the server.
*/
function interpretResponse(serverResponse, bidRequest) {
const bidResponses = [];
const response = serverResponse.body;

sendEvent('dintres');

if (response) {
if (response.timeout || !response.ad || /<!--\s+No\s+ad\s+-->/gmi.test(response.ad)) {
return bidResponses;
}

return validBidRequests.map(bid => {
let bidPayload = {
adUnitCode: bid.adUnitCode,
auctionId: bid.auctionId,
bidder: bid.bidder,
bidderRequestId: bid.bidderRequestId,
bidRequestsCount: bid.bidRequestsCount,
requestId: bid.bidId,
sizes: bid.sizes.map(size => ({
w: size[0],
h: size[1],
})),
transactionId: bid.transactionId,
zoneId: bid.params.zoneId,
};
// Setting our returned sizes object to default values
let returnedSizes = {
width: 1800,
height: 1000
};

let protocol = bid.params.protocol || DEFAULT_PROTOCOL;
let bidHost = bid.params.bidHost || DEFAULT_BID_HOST;
let payload = Object.assign({}, commonPayload, bidPayload);

return {
method: 'POST',
url: protocol + '://' + bidHost + '/bid',
data: payload,
options: {
contentType: 'application/json',
withCredentials: true
},
};
});
},

/**
* Unpack the response from the server into a list of bids.
*
* @param {*} serverResponse A successful response from the server.
* @param {*} bidRequest An object with bid request informations
* @return {Bid[]} An array of bids which were nested inside the server.
*/
interpretResponse: (serverResponse, bidRequest) => {
const bidResponses = [];
const response = serverResponse.body;

if (response) {
if (response.timeout || !response.ad || response.ad.match(/<!-- No ad -->/gmi)) {
return bidResponses;
}

// Setting our returned sizes object to default values
let returnedSizes = {
width: 1800,
height: 1000
// Verifying Banner sizes
if (bidRequest && bidRequest.data && bidRequest.data.w === 1 && bidRequest.data.h === 1) {
// If banner sizes are 1x1 we set our default size object to 1x1
returnedSizes = {
width: 1,
height: 1
};
}

// Verifying Banner sizes
if (bidRequest && bidRequest.data && bidRequest.data.w === 1 && bidRequest.data.h === 1) {
// If banner sizes are 1x1 we set our default size object to 1x1
returnedSizes = {
width: 1,
height: 1
};
}

const bidResponse = {
requestId: response.requestId || '',
cpm: response.cpm || 0,
width: response.width || returnedSizes.width,
height: response.height || returnedSizes.height,
creativeId: response.creativeId || 1,
dealId: response.dealId || 1,
currency: response.currency || DEFAULT_CURRENCY,
netRevenue: response.netRevenue || true,
ttl: response.ttl || DEFAULT_TTL,
ad: response.ad,
pbav: SUBLIME_VERSION
};
const bidResponse = {
requestId: response.requestId || '',
cpm: response.cpm || 0,
width: response.width || returnedSizes.width,
height: response.height || returnedSizes.height,
creativeId: response.creativeId || 1,
dealId: response.dealId || 1,
currency: response.currency || DEFAULT_CURRENCY,
netRevenue: response.netRevenue || true,
ttl: response.ttl || DEFAULT_TTL,
ad: response.ad,
pbav: SUBLIME_VERSION
};

bidResponses.push(bidResponse);
}
sendEvent('bida', true);
bidResponses.push(bidResponse);
} else {
sendEvent('dnobid');
}

return bidResponses;
},
return bidResponses;
}

/**
* Send debug when we timeout
* @param {Object} timeoutData
*/
function onTimeout(timeoutData) {
log('Timeout from adapter', timeoutData);
sendEvent('dbidtimeout', true);
}

export const spec = {
code: BIDDER_CODE,
aliases: [],
isBidRequestValid: isBidRequestValid,
buildRequests: buildRequests,
interpretResponse: interpretResponse,
onTimeout: onTimeout,
};

registerBidder(spec);
29 changes: 28 additions & 1 deletion test/spec/modules/sublimeBidAdapter_spec.js
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,30 @@
import { expect } from 'chai';
import { spec } from 'modules/sublimeBidAdapter.js';
import { spec, sendEvent, log, setState, state } from 'modules/sublimeBidAdapter.js';
import { newBidder } from 'src/adapters/bidderFactory.js';

let utils = require('src/utils');

describe('Sublime Adapter', function() {
const adapter = newBidder(spec);

describe('sendEvent', function() {
let sandbox;

beforeEach(function () {
sandbox = sinon.sandbox.create();
});

it('should trigger pixel', function () {
sandbox.spy(utils, 'triggerPixel');
sendEvent('test', true);
expect(utils.triggerPixel.called).to.equal(true);
});

afterEach(function () {
sandbox.restore();
});
})

describe('inherited functions', function() {
it('exists and is a function', function() {
expect(adapter.callBids).to.exist.and.to.be.a('function');
Expand Down Expand Up @@ -129,6 +149,7 @@ describe('Sublime Adapter', function() {
currency: 'USD',
netRevenue: true,
ttl: 600,
pbav: '0.5.1',
ad: '',
},
];
Expand Down Expand Up @@ -170,6 +191,7 @@ describe('Sublime Adapter', function() {
netRevenue: true,
ttl: 600,
ad: '<!-- Creative -->',
pbav: '0.5.1',
};

expect(result[0]).to.deep.equal(expectedResponse);
Expand Down Expand Up @@ -219,6 +241,7 @@ describe('Sublime Adapter', function() {
netRevenue: true,
ttl: 600,
ad: '<!-- ad -->',
pbav: '0.5.1',
};

expect(result[0]).to.deep.equal(expectedResponse);
Expand Down Expand Up @@ -250,6 +273,10 @@ describe('Sublime Adapter', function() {
let expectedResponse = [];

expect(result).to.deep.equal(expectedResponse);

describe('On bid Time out', function () {
spec.onTimeout(result);
});
});
});
});

0 comments on commit e14b9e9

Please sign in to comment.