Update adapter to prebid v1.0 (#1908)

* Update adapter to prebid v1.0 * corrected some things following pullrequest review * slight change to avoid potential error * added the maintainer email * Updated the tests to fit changes * Updated the doc, removed the bidderCode, added adUrl * fix adapter * Added try catch around JSON.parse
prebid · Jan 23, 2018 · 9b56b11 · 9b56b11
1 parent a264553
commit 9b56b11
Show file tree

Hide file tree

Showing 3 changed files with 284 additions and 0 deletions.
diff --git a/modules/smartadserverBidAdapter.js b/modules/smartadserverBidAdapter.js
@@ -0,0 +1,92 @@
+import * as utils from 'src/utils';
+import {
+  config
+} from 'src/config';
+import {
+  registerBidder
+} from 'src/adapters/bidderFactory';
+const BIDDER_CODE = 'smartadserver';
+export const spec = {
+  code: BIDDER_CODE,
+  aliases: ['smart'], // short code
+  /**
+   * 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: function (bid) {
+    return !!(bid.params && bid.params.siteId && bid.params.pageId && bid.params.formatId && bid.params.domain);
+  },
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {validBidRequests[]} - an array of bids
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function (validBidRequests) {
+    // use bidderRequest.bids[] to get bidder-dependent request info
+
+    // if your bidder supports multiple currencies, use config.getConfig(currency)
+    // to find which one the ad server needs
+
+    // pull requested transaction ID from bidderRequest.bids[].transactionId
+    var bid = validBidRequests[0];
+    const payload = {
+      siteid: bid.params.siteId,
+      pageid: bid.params.pageId,
+      formatid: bid.params.formatId,
+      currencyCode: config.getConfig('currency.adServerCurrency'),
+      bidfloor: bid.params.bidfloor || 0.0,
+      targeting: bid.params.target && bid.params.target != '' ? bid.params.target : undefined,
+      tagId: bid.adUnitCode,
+      sizes: bid.sizes.map(size => ({
+        w: size[0],
+        h: size[1]
+      })),
+      pageDomain: utils.getTopWindowUrl(),
+      transactionId: bid.transactionId,
+      timeout: config.getConfig('bidderTimeout'),
+      bidId: bid.bidId
+    };
+    const payloadString = JSON.stringify(payload);
+    return {
+      method: 'POST',
+      url: bid.params.domain + '/prebid/v1',
+      data: payloadString,
+    };
+  },
+  /**
+   * 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: function (serverResponse, bidRequest) {
+    const bidResponses = [];
+    var response = serverResponse.body;
+    try {
+      if (response) {
+        const bidResponse = {
+          requestId: JSON.parse(bidRequest.data).bidId,
+          cpm: response.cpm,
+          width: response.width,
+          height: response.height,
+          creativeId: response.creativeId,
+          dealId: response.dealId,
+          currency: response.currency,
+          netRevenue: response.isNetCpm,
+          ttl: response.ttl,
+          referrer: utils.getTopWindowUrl(),
+          adUrl: response.adUrl,
+          ad: response.ad
+        };
+        bidResponses.push(bidResponse);
+      }
+    } catch (error) {
+      console.log('Error while parsing smart server response');
+    }
+    return bidResponses;
+  }
+}
+registerBidder(spec);
diff --git a/modules/smartadserverBidAdapter.md b/modules/smartadserverBidAdapter.md
@@ -0,0 +1,35 @@
+# Overview
+
+```
+Module Name: Smart Ad Server Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: gcarnec@smartadserver.com
+```
+
+# Description
+
+Connect to Smart for bids.
+
+The Smart adapter requires setup and approval from the Smart team.
+Please reach out to your Technical account manager for more information.
+
+# Test Parameters
+```
+    var adUnits = [
+           {
+               code: 'test-div',
+               sizes: [[300, 250]],  // a display size
+               bids: [
+                   {
+                       bidder: "smart",
+                       params: {
+                            domain: 'http://prg.smartadserver.com',
+                            siteId: 207435,
+                            pageId: 896536,
+                            formatId: 62913
+                       }
+                   }
+               ]
+           }
+       ];
+```
diff --git a/test/spec/modules/smartadserverBidAdapter_spec.js b/test/spec/modules/smartadserverBidAdapter_spec.js
@@ -0,0 +1,157 @@
+import {
+  expect
+} from 'chai';
+import {
+  spec
+} from 'modules/smartadserverBidAdapter';
+import {
+  getTopWindowLocation
+} from 'src/utils';
+import {
+  newBidder
+} from 'src/adapters/bidderFactory';
+import {
+  config
+} from 'src/config';
+import * as utils from 'src/utils';
+
+describe('Smart ad server bid adapter tests', () => {
+  var DEFAULT_PARAMS = [{
+    adUnitCode: 'sas_42',
+    bidId: 'abcd1234',
+    sizes: [
+      [300, 250],
+      [300, 200]
+    ],
+    bidder: 'smartadserver',
+    params: {
+      domain: 'http://prg.smartadserver.com',
+      siteId: '1234',
+      pageId: '5678',
+      formatId: '90',
+      target: 'test=prebid',
+      bidfloor: 0.420
+    },
+    requestId: 'efgh5678',
+    transactionId: 'zsfgzzg'
+  }];
+
+  var DEFAULT_PARAMS_WO_OPTIONAL = [{
+    adUnitCode: 'sas_42',
+    bidId: 'abcd1234',
+    sizes: [
+      [300, 250],
+      [300, 200]
+    ],
+    bidder: 'smartadserver',
+    params: {
+      domain: 'http://prg.smartadserver.com',
+      siteId: '1234',
+      pageId: '5678',
+      formatId: '90'
+    },
+    requestId: 'efgh5678'
+  }];
+
+  var BID_RESPONSE = {
+    body: {
+      cpm: 12,
+      width: 300,
+      height: 250,
+      creativeId: 'zioeufg',
+      currency: 'GBP',
+      isNetCpm: true,
+      ttl: 300,
+      adUrl: 'http://awesome.fake.url',
+      ad: '< --- awesome script --- >'
+    }
+  };
+
+  it('Verify build request', () => {
+    config.setConfig({
+      'currency': {
+        'adServerCurrency': 'EUR'
+      }
+    });
+    const request = spec.buildRequests(DEFAULT_PARAMS);
+    expect(request).to.have.property('url').and.to.equal('http://prg.smartadserver.com/prebid/v1');
+    expect(request).to.have.property('method').and.to.equal('POST');
+    const requestContent = JSON.parse(request.data);
+    expect(requestContent).to.have.property('siteid').and.to.equal('1234');
+    expect(requestContent).to.have.property('pageid').and.to.equal('5678');
+    expect(requestContent).to.have.property('formatid').and.to.equal('90');
+    expect(requestContent).to.have.property('currencyCode').and.to.equal('EUR');
+    expect(requestContent).to.have.property('bidfloor').and.to.equal(0.42);
+    expect(requestContent).to.have.property('targeting').and.to.equal('test=prebid');
+    expect(requestContent).to.have.property('tagId').and.to.equal('sas_42');
+    expect(requestContent).to.have.property('sizes');
+    expect(requestContent.sizes[0]).to.have.property('w').and.to.equal(300);
+    expect(requestContent.sizes[0]).to.have.property('h').and.to.equal(250);
+    expect(requestContent.sizes[1]).to.have.property('w').and.to.equal(300);
+    expect(requestContent.sizes[1]).to.have.property('h').and.to.equal(200);
+    expect(requestContent).to.have.property('pageDomain').and.to.equal(utils.getTopWindowUrl());
+    expect(requestContent).to.have.property('transactionId').and.to.not.equal(null).and.to.not.be.undefined;
+  });
+
+  it('Verify parse response', () => {
+    const request = spec.buildRequests(DEFAULT_PARAMS);
+    const bids = spec.interpretResponse(BID_RESPONSE, request);
+    expect(bids).to.have.lengthOf(1);
+    const bid = bids[0];
+    expect(bid.cpm).to.equal(12);
+    expect(bid.adUrl).to.equal('http://awesome.fake.url');
+    expect(bid.ad).to.equal('< --- awesome script --- >');
+    expect(bid.width).to.equal(300);
+    expect(bid.height).to.equal(250);
+    expect(bid.creativeId).to.equal('zioeufg');
+    expect(bid.currency).to.equal('GBP');
+    expect(bid.netRevenue).to.equal(true);
+    expect(bid.ttl).to.equal(300);
+    expect(bid.requestId).to.equal(DEFAULT_PARAMS[0].bidId);
+    expect(bid.referrer).to.equal(utils.getTopWindowUrl());
+  });
+
+  it('Verifies bidder code', () => {
+    expect(spec.code).to.equal('smartadserver');
+  });
+
+  it('Verifies bidder aliases', () => {
+    expect(spec.aliases).to.have.lengthOf(1);
+    expect(spec.aliases[0]).to.equal('smart');
+  });
+
+  it('Verifies if bid request valid', () => {
+    expect(spec.isBidRequestValid(DEFAULT_PARAMS[0])).to.equal(true);
+    expect(spec.isBidRequestValid(DEFAULT_PARAMS_WO_OPTIONAL[0])).to.equal(true);
+    expect(spec.isBidRequestValid({})).to.equal(false);
+    expect(spec.isBidRequestValid({
+      params: {}
+    })).to.equal(false);
+    expect(spec.isBidRequestValid({
+      params: {
+        pageid: 123
+      }
+    })).to.equal(false);
+    expect(spec.isBidRequestValid({
+      params: {
+        siteid: 123
+      }
+    })).to.equal(false);
+    expect(spec.isBidRequestValid({
+      params: {
+        formatid: 123,
+        pageid: 234
+      }
+    })).to.equal(false);
+    expect(spec.isBidRequestValid({
+      params: {
+        domain: 'www.test.com',
+        pageid: 234
+      }
+    })).to.equal(false);
+  });
+
+  it('Verifies sync options', () => {
+    expect(spec.getUserSyncs).to.be.undefined;
+  });
+});