Skip to content

Commit

Permalink
New bidder adapter for collectcent (prebid#3365)
Browse files Browse the repository at this point in the history
* Create collectcentBidAdapter.js

New bider adapter for collectcent

* Create collectcentBidAdapter.md

Description and integration example

* Create collectcentBidAdapter_spec.js

Collectcent bidder adapter tests added

* Update collectcentBidAdapter_spec.js

edit

* Update collectcentBidAdapter.js

Used bidderRequest.refererInfo.referer instead of window.location

* Update collectcentBidAdapter.js

* Update collectcentBidAdapter.js

Rename URL to URL_MULTI
  • Loading branch information
devcollectcent authored and Pedro López Jiménez committed Mar 18, 2019
1 parent ff6f62a commit 96a8724
Show file tree
Hide file tree
Showing 3 changed files with 238 additions and 0 deletions.
93 changes: 93 additions & 0 deletions modules/collectcentBidAdapter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
import { registerBidder } from 'src/adapters/bidderFactory';
import { BANNER, NATIVE, VIDEO } from 'src/mediaTypes';
import * as utils from 'src/utils';

const BIDDER_CODE = 'collectcent';
const URL_MULTI = '//publishers.motionspots.com/?c=o&m=multi';
const URL_SYNC = '//publishers.motionspots.com/?c=o&m=cookie';

export const spec = {
code: BIDDER_CODE,
supportedMediaTypes: [BANNER, VIDEO, NATIVE],

/**
* Determines whether or not the given bid request is valid.
*
* @param {object} bid The bid to validate.
* @return boolean True if this is a valid bid, and false otherwise.
*/
isBidRequestValid: (bid) => {
return Boolean(bid.bidId &&
bid.params &&
!isNaN(bid.params.placementId) &&
spec.supportedMediaTypes.indexOf(bid.params.traffic) !== -1
);
},

/**
* Make a server request from the list of BidRequests.
*
* @param {BidRequest[]} validBidRequests A non-empty list of valid bid requests that should be sent to the Server.
* @return ServerRequest Info describing the request to the server.
*/
buildRequests: (validBidRequests, bidderRequest) => {
let winTop;
try {
winTop = window.top;
} catch (e) {
utils.logMessage(e);
winTop = window;
};

const placements = [];
const location = bidderRequest ? new URL(bidderRequest.refererInfo.referer) : winTop.location;
const request = {
'secure': (location.protocol === 'https:') ? 1 : 0,
'deviceWidth': winTop.screen.width,
'deviceHeight': winTop.screen.height,
'host': location.host,
'page': location.pathname,
'placements': placements
};

for (let i = 0; i < validBidRequests.length; i++) {
const bid = validBidRequests[i];
const params = bid.params;
placements.push({
placementId: params.placementId,
bidId: bid.bidId,
sizes: bid.sizes,
traffic: params.traffic
});
}
return {
method: 'POST',
url: URL_MULTI,
data: request
};
},

/**
* Unpack the response from the server into a list of bids.
*
* @param {*} serverResponse A successful response from the server.
* @return {Bid[]} An array of bids which were nested inside the server.
*/
interpretResponse: (serverResponse) => {
try {
serverResponse = serverResponse.body;
} catch (e) {
utils.logMessage(e);
};
return serverResponse;
},

getUserSyncs: () => {
return [{
type: 'image',
url: URL_SYNC
}];
}
};

registerBidder(spec);
27 changes: 27 additions & 0 deletions modules/collectcentBidAdapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Overview

```
Module Name: Collectcent SSP Bidder Adapter
Module Type: Bidder Adapter
Maintainer: dev.collectcent@gmail.com
```

# Description

Module that connects to Collectcent SSP demand sources

# Test Parameters
```
var adUnits = [{
code: 'placementCode',
sizes: [[300, 250]],
bids: [{
bidder: 'collectcent',
params: {
placementId: 0,
traffic: 'banner'
}
}]
}
];
```
118 changes: 118 additions & 0 deletions test/spec/modules/collectcentBidAdapter_spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
import {expect} from 'chai';
import {spec} from '../../../modules/collectcentBidAdapter';

describe('Collectcent', function () {
let bid = {
bidId: '2dd581a2b6281d',
bidder: 'collectcent',
bidderRequestId: '145e1d6a7837c9',
params: {
placementId: 123,
traffic: 'banner'
},
placementCode: 'placement_0',
auctionId: '74f78609-a92d-4cf1-869f-1b244bbfb5d2',
sizes: [[300, 250]],
transactionId: '3bb2f6da-87a6-4029-aeb0-bfe951372e62'
};

describe('isBidRequestValid', function () {
it('Should return true when placementId can be cast to a number', function () {
expect(spec.isBidRequestValid(bid)).to.be.true;
});
it('Should return false when placementId is not a number', function () {
bid.params.placementId = 'aaa';
expect(spec.isBidRequestValid(bid)).to.be.false;
});
});

describe('buildRequests', function () {
let serverRequest = spec.buildRequests([bid]);
it('Creates a ServerRequest object with method, URL and data', function () {
expect(serverRequest).to.exist;
expect(serverRequest.method).to.exist;
expect(serverRequest.url).to.exist;
expect(serverRequest.data).to.exist;
});
it('Returns POST method', function () {
expect(serverRequest.method).to.equal('POST');
});
it('Returns valid URL', function () {
expect(serverRequest.url).to.equal('//publishers.motionspots.com/?c=o&m=multi');
});
it('Returns valid data if array of bids is valid', function () {
let data = serverRequest.data;
expect(data).to.be.an('object');
expect(data).to.have.all.keys('deviceWidth', 'deviceHeight', 'secure', 'host', 'page', 'placements');
expect(data.deviceWidth).to.be.a('number');
expect(data.deviceHeight).to.be.a('number');
expect(data.secure).to.be.within(0, 1);
expect(data.host).to.be.a('string');
expect(data.page).to.be.a('string');
let placements = data['placements'];
for (let i = 0; i < placements.length; i++) {
let placement = placements[i];
expect(placement).to.have.all.keys('placementId', 'bidId', 'traffic', 'sizes');
expect(placement.placementId).to.be.a('number');
expect(placement.bidId).to.be.a('string');
expect(placement.traffic).to.be.a('string');
expect(placement.sizes).to.be.an('array');
}
});
it('Returns empty data if no valid requests are passed', function () {
serverRequest = spec.buildRequests([]);
let data = serverRequest.data;
expect(data.placements).to.be.an('array').that.is.empty;
});
});
describe('interpretResponse', function () {
let resObject = {
body: [ {
requestId: '123',
mediaType: 'banner',
cpm: 0.3,
width: 320,
height: 50,
ad: '<h1>Hello ad</h1>',
ttl: 1000,
creativeId: '123asd',
netRevenue: true,
currency: 'USD'
} ]
};
let serverResponses = spec.interpretResponse(resObject);
it('Returns an array of valid server responses if response object is valid', function () {
expect(serverResponses).to.be.an('array').that.is.not.empty;
for (let i = 0; i < serverResponses.length; i++) {
let dataItem = serverResponses[i];
expect(dataItem).to.have.all.keys('requestId', 'cpm', 'width', 'height', 'ad', 'ttl', 'creativeId',
'netRevenue', 'currency', 'mediaType');
expect(dataItem.requestId).to.be.a('string');
expect(dataItem.cpm).to.be.a('number');
expect(dataItem.width).to.be.a('number');
expect(dataItem.height).to.be.a('number');
expect(dataItem.ad).to.be.a('string');
expect(dataItem.ttl).to.be.a('number');
expect(dataItem.creativeId).to.be.a('string');
expect(dataItem.netRevenue).to.be.a('boolean');
expect(dataItem.currency).to.be.a('string');
expect(dataItem.mediaType).to.be.a('string');
}
it('Returns an empty array if invalid response is passed', function () {
serverResponses = spec.interpretResponse('invalid_response');
expect(serverResponses).to.be.an('array').that.is.empty;
});
});
});

describe('getUserSyncs', function () {
let userSync = spec.getUserSyncs();
it('Returns valid URL and `', function () {
expect(userSync).to.be.an('array').with.lengthOf(1);
expect(userSync[0].type).to.exist;
expect(userSync[0].url).to.exist;
expect(userSync[0].type).to.be.equal('image');
expect(userSync[0].url).to.be.equal('//publishers.motionspots.com/?c=o&m=cookie');
});
});
});

0 comments on commit 96a8724

Please sign in to comment.