Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Pub-X Bid adapter #5676

Merged
merged 3 commits into from
Sep 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions modules/pubxBidAdapter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import { registerBidder } from '../src/adapters/bidderFactory.js';
const BIDDER_CODE = 'pubx';
const BID_ENDPOINT = 'https://api.primecaster.net/adlogue/api/slot/bid';
export const spec = {
code: BIDDER_CODE,
isBidRequestValid: function(bid) {
if (!(bid.params.sid)) {
return false;
} else { return true }
},
buildRequests: function(validBidRequests) {
return validBidRequests.map(bidRequest => {
const bidId = bidRequest.bidId;
const params = bidRequest.params;
const sid = params.sid;
const payload = {
sid: sid
};
return {
id: bidId,
method: 'GET',
url: BID_ENDPOINT,
data: payload,
}
});
},
interpretResponse: function(serverResponse, bidRequest) {
const body = serverResponse.body;
const bidResponses = [];
if (body.cid) {
const bidResponse = {
requestId: bidRequest.id,
cpm: body.cpm,
currency: body.currency,
width: body.width,
height: body.height,
creativeId: body.cid,
netRevenue: true,
ttl: body.TTL,
ad: body.adm
};
bidResponses.push(bidResponse);
} else {};
return bidResponses;
}
}
registerBidder(spec);
32 changes: 32 additions & 0 deletions modules/pubxBidAdapter.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Overview

Module Name: pubx Bid Adapter

Maintainer: x@pub-x.io

# Description

Module that connects to Pub-X's demand sources
Supported MediaTypes: banner only

# Test Parameters
```javascript
var adUnits = [
{
code: 'test',
mediaTypes: {
banner: {
sizes: [300,250]
}
},
bids: [
{
bidder: 'pubx',
params: {
sid: 'eDMR' //ID should be provided by Pub-X
}
}
]
}
];
```
125 changes: 125 additions & 0 deletions test/spec/modules/pubxBidAdapter_spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
import {expect} from 'chai';
import {spec} from 'modules/pubxBidAdapter.js';
import {newBidder} from 'src/adapters/bidderFactory.js';

describe('pubxAdapter', function () {
const adapter = newBidder(spec);
const ENDPOINT = 'https://api.primecaster.net/adlogue/api/slot/bid';

describe('inherited functions', function () {
it('exists and is a function', function () {
expect(adapter.callBids).to.exist.and.to.be.a('function');
});
});

describe('isBidRequestValid', function () {
const bid = {
bidder: 'pubx',
params: {
sid: '12345abc'
}
};

it('should return true when required params found', function () {
expect(spec.isBidRequestValid(bid)).to.equal(true);
});

it('should return false when required params are not passed', function () {
let bid = Object.assign({}, bid);
delete bid.params;
bid.params = {};
expect(spec.isBidRequestValid(bid)).to.equal(false);
});
});

describe('buildRequests', function () {
const bidRequests = [
{
id: '26c1ee0038ac11',
params: {
sid: '12345abc'
}
}
];

const data = {
banner: {
sid: '12345abc'
}
};

it('sends bid request to ENDPOINT via GET', function () {
const request = spec.buildRequests(bidRequests)[0];
expect(request.url).to.equal(ENDPOINT);
expect(request.method).to.equal('GET');
});

it('should attach params to the banner request', function () {
const request = spec.buildRequests(bidRequests)[0];
expect(request.data).to.deep.equal(data.banner);
});
});

describe('interpretResponse', function () {
const serverResponse = {
body: {
TTL: 300,
adm: '<div>some creative</div>',
cid: 'TKmB',
cpm: 500,
currency: 'JPY',
height: 250,
width: 300,
}
}

const bidRequests = [
{
id: '26c1ee0038ac11',
params: {
sid: '12345abc'
}
}
];

const bidResponses = [
{
requestId: '26c1ee0038ac11',
cpm: 500,
currency: 'JPY',
width: 300,
height: 250,
creativeId: 'TKmB',
netRevenue: true,
ttl: 300,
ad: '<div>some creative</div>'
}
];
it('should return empty array when required param is empty', function () {
const serverResponseWithCidEmpty = {
body: {
TTL: 300,
adm: '<div>some creative</div>',
cid: '',
cpm: '',
currency: 'JPY',
height: 250,
width: 300,
}
}
const result = spec.interpretResponse(serverResponseWithCidEmpty, bidRequests[0]);
expect(result).to.be.empty;
});
it('handles banner responses', function () {
const result = spec.interpretResponse(serverResponse, bidRequests[0])[0];
expect(result.requestId).to.equal(bidResponses[0].requestId);
expect(result.width).to.equal(bidResponses[0].width);
expect(result.height).to.equal(bidResponses[0].height);
expect(result.creativeId).to.equal(bidResponses[0].creativeId);
expect(result.currency).to.equal(bidResponses[0].currency);
expect(result.netRevenue).to.equal(bidResponses[0].netRevenue);
expect(result.ttl).to.equal(bidResponses[0].ttl);
expect(result.ad).to.equal(bidResponses[0].ad);
});
});
});