SublimeBidAdapter: Update to version 0.5.1 (prebid#4977)

* add prebid version of adapter * Feature/update sublime adapter (#21) * Update sublimeBidAdapter to 0.5.1 * Add tests for private functions * Remove window.sublime * Update pixel name for bid event * Remove pixels on non-event and add onBidWon (#22) * add prebid version of adapter * Feature/update sublime adapter (#21) * Update sublimeBidAdapter to 0.5.1 * Add tests for private functions * Remove window.sublime * Update pixel name for bid event * Remove pixels on non-event and add onBidWon * Incremente version of sublimeBidAdapter * Renamed pixel for timeout and introduce gvlid * Remove unnecessary params for sendEvent Co-Authored-By: fgcloutier <fg.cloutier@sublimeskinz.com> Co-authored-by: Gaby <gaby.hourlier@sublimeskinz.com> Co-authored-by: fgcloutier <fg.cloutier@sublimeskinz.com> * Remove trailing-space * Fix version in tests Co-authored-by: Gaby <gaby.hourlier@sublimeskinz.com> Co-authored-by: fgcloutier <fg.cloutier@sublimeskinz.com>
SublimeSkinz · Apr 21, 2020 · 6311c46 · 6311c46
1 parent f0a8abd
commit 6311c46
Show file tree

Hide file tree

Showing 2 changed files with 223 additions and 114 deletions.
diff --git a/modules/sublimeBidAdapter.js b/modules/sublimeBidAdapter.js
@@ -1,136 +1,218 @@
 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 BIDDER_GVLID = 114;
 const DEFAULT_BID_HOST = 'pbjs.sskzlabs.com';
 const DEFAULT_CURRENCY = 'EUR';
 const DEFAULT_PROTOCOL = 'https';
 const DEFAULT_TTL = 600;
-const SUBLIME_VERSION = '0.4.0';
+const SUBLIME_ANTENNA = 'antenna.ayads.co';
+const SUBLIME_VERSION = '0.5.2';
+
+/**
+ * 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: ''
+};
 
-export const spec = {
- code: BIDDER_CODE,
- gvlid: 114,
- aliases: [],
+/**
+ * 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
+ */
+export function sendEvent(eventName) {
+ 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,
+ };
+
+ log('Sending pixel for event: ' + eventName, eventObject);
+
+ const queryString = url.formatQS(eventObject);
+ utils.triggerPixel('https://' + SUBLIME_ANTENNA + '/?' + queryString);
+}
+
+/**
+ * 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 = {
- sublimeVersion: 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;
+
+ 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,
- };
+ 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);
- }
+ bidResponses.push(bidResponse);
+ }
+
+ return bidResponses;
+}
+
+/**
+ * Send pixel when bidWon event is triggered
+ * @param {Object} timeoutData
+ */
+function onBidWon(bid) {
+ log('Bid won', bid);
+ sendEvent('bidwon');
+}
+
+/**
+ * Send debug when we timeout
+ * @param {Object} timeoutData
+ */
+function onTimeout(timeoutData) {
+ log('Timeout from adapter', timeoutData);
+ sendEvent('bidtimeout');
+}
 
- return bidResponses;
- },
+export const spec = {
+ code: BIDDER_CODE,
+ gvlid: BIDDER_GVLID,
+ aliases: [],
+ isBidRequestValid: isBidRequestValid,
+ buildRequests: buildRequests,
+ interpretResponse: interpretResponse,
+ onBidWon: onBidWon,
+ onTimeout: onTimeout,
 };
 
 registerBidder(spec);
diff --git a/test/spec/modules/sublimeBidAdapter_spec.js b/test/spec/modules/sublimeBidAdapter_spec.js
@@ -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');
@@ -129,6 +149,7 @@ describe('Sublime Adapter', function() {
  currency: 'USD',
  netRevenue: true,
  ttl: 600,
+ pbav: '0.5.2',
  ad: '',
  },
  ];
@@ -170,6 +191,7 @@ describe('Sublime Adapter', function() {
  netRevenue: true,
  ttl: 600,
  ad: '<!-- Creative -->',
+ pbav: '0.5.2',
  };
 
  expect(result[0]).to.deep.equal(expectedResponse);
@@ -219,6 +241,7 @@ describe('Sublime Adapter', function() {
  netRevenue: true,
  ttl: 600,
  ad: '<!-- ad -->',
+ pbav: '0.5.2',
  };
 
  expect(result[0]).to.deep.equal(expectedResponse);
@@ -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);
+ });
  });
  });
 });