BidsCube Bid Adapter: add new adapter (#6730)

modules/bidscubeBidAdapter.js

@@ -0,0 +1,90 @@
+import { registerBidder } from '../src/adapters/bidderFactory.js'
+import { BANNER, NATIVE, VIDEO } from '../src/mediaTypes.js'
+import * as utils from '../src/utils.js'
+
+const BIDDER_CODE = 'bidscube'
+const URL = 'https://supply.bidscube.com/?c=o&m=multi'
+const URL_SYNC = 'https://supply.bidscube.com/?c=o&m=cookie'
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: function (opts) {
+    return Boolean(opts.bidId && opts.params && !isNaN(parseInt(opts.params.placementId)))
+  },
+
+  buildRequests: function (validBidRequests) {
+    validBidRequests = validBidRequests || []
+    let winTop = window
+    try {
+      window.top.location.toString()
+      winTop = window.top
+    } catch (e) { utils.logMessage(e) }
+
+    const location = utils.getWindowLocation()
+    const placements = []
+
+    for (let i = 0; i < validBidRequests.length; i++) {
+      const p = validBidRequests[i]
+
+      placements.push({
+        placementId: p.params.placementId,
+        bidId: p.bidId,
+        traffic: p.params.traffic || BANNER,
+        allParams: JSON.stringify(p)
+      })
+    }
+
+    return {
+      method: 'POST',
+      url: URL,
+      data: {
+        deviceWidth: winTop.screen.width,
+        deviceHeight: winTop.screen.height,
+        language: (navigator && navigator.language) ? navigator.language : '',
+        secure: +(location.protocol === 'https:'),
+        host: location.hostname,
+        page: location.pathname,
+        placements: placements
+      }
+    }
+  },
+
+  interpretResponse: function (opts) {
+    const body = opts.body
+    const response = []
+
+    for (let i = 0; i < body.length; i++) {
+      const item = body[i]
+      if (isBidResponseValid(item)) {
+        response.push(item)
+      }
+    }
+
+    return response
+  },
+
+  getUserSyncs: function (syncOptions, serverResponses) {
+    return [{ type: 'image', url: URL_SYNC }]
+  }
+}
+
+registerBidder(spec)
+
+function isBidResponseValid (bid) {
+  if (!bid.requestId || !bid.cpm || !bid.creativeId ||
+    !bid.ttl || !bid.currency) {
+    return false
+  }
+  switch (bid['mediaType']) {
+    case BANNER:
+      return Boolean(bid.width && bid.height && bid.ad)
+    case VIDEO:
+      return Boolean(bid.vastUrl)
+    case NATIVE:
+      return Boolean(bid.title && bid.image && bid.impressionTrackers)
+    default:
+      return false
+  }
+}

modules/bidscubeBidAdapter.md

@@ -0,0 +1,30 @@
+# Overview
+
+```
+Module Name: BidsCube Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: [email protected]
+```
+
+# Description
+
+Module that connects to BidsCube' demand sources
+
+# Test Parameters
+```
+    var adUnits = [{
+        code: 'placementId_0',
+        mediaTypes: {
+            banner: {
+                sizes: [[300, 250]]
+            }
+        },
+        bids: [{
+            bidder: 'bidscube',
+            params: {
+                placementId: 0,
+                traffic: 'banner'
+            }
+        }]
+    }];
+```

test/spec/modules/bidscubeBidAdapter_spec.js

@@ -0,0 +1,226 @@
+import { expect } from 'chai'
+import { spec } from '../../../modules/bidscubeBidAdapter.js'
+import { deepStrictEqual, notEqual, ok, strictEqual } from 'assert'
+
+describe('BidsCubeAdapter', () => {
+  const bid = {
+    bidId: '9ec5b177515ee2e5',
+    bidder: 'bidscube',
+    params: {
+      placementId: 0,
+      traffic: 'banner',
+      allParams: '{}'
+    }
+  }
+
+  describe('isBidRequestValid', () => {
+    it('Should return true if there are bidId, params and placementId parameters present', () => {
+      strictEqual(true, spec.isBidRequestValid(bid))
+    })
+
+    it('Should return false if at least one of parameters is not present', () => {
+      const b = { ...bid }
+      delete b.params.placementId
+      strictEqual(false, spec.isBidRequestValid(b))
+    })
+  })
+
+  describe('buildRequests', () => {
+    const serverRequest = spec.buildRequests([bid])
+
+    it('Creates a ServerRequest object with method, URL and data', () => {
+      ok(serverRequest)
+      ok(serverRequest.method)
+      ok(serverRequest.url)
+      ok(serverRequest.data)
+    })
+
+    it('Returns POST method', () => {
+      strictEqual('POST', serverRequest.method)
+    })
+
+    it('Returns valid URL', () => {
+      strictEqual('https://supply.bidscube.com/?c=o&m=multi', serverRequest.url)
+    })
+
+    it('Returns valid data if array of bids is valid', () => {
+      const { data } = serverRequest
+      strictEqual('object', typeof data)
+      deepStrictEqual(['deviceWidth', 'deviceHeight', 'language', 'secure', 'host', 'page', 'placements'], Object.keys(data))
+      strictEqual('number', typeof data.deviceWidth)
+      strictEqual('number', typeof data.deviceHeight)
+      strictEqual('string', typeof data.language)
+      strictEqual('string', typeof data.host)
+      strictEqual('string', typeof data.page)
+      notEqual(-1, [0, 1].indexOf(data.secure))
+
+      const placement = data.placements[0]
+      deepStrictEqual(['placementId', 'bidId', 'traffic', 'allParams'], Object.keys(placement))
+      strictEqual(0, placement.placementId)
+      strictEqual('9ec5b177515ee2e5', placement.bidId)
+      strictEqual('banner', placement.traffic)
+      strictEqual('{"bidId":"9ec5b177515ee2e5","bidder":"bidscube","params":{"placementId":0,"traffic":"banner","allParams":"{}"}}', placement.allParams)
+    })
+
+    it('Returns empty data if no valid requests are passed', () => {
+      const { placements } = spec.buildRequests([]).data
+
+      expect(spec.buildRequests([]).data.placements).to.be.an('array')
+      strictEqual(0, placements.length)
+    })
+  })
+
+  describe('interpretResponse', () => {
+    const validData = [
+      {
+        body: [{
+          mediaType: 'banner',
+          width: 300,
+          height: 250,
+          cpm: 0.4,
+          ad: 'Test',
+          requestId: '9ec5b177515ee2e5',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1',
+          meta: {
+            advertiserDomains: ['test.com']
+          }
+        }]
+      },
+      {
+        body: [{
+          vastUrl: 'bidscube.com',
+          mediaType: 'video',
+          cpm: 0.5,
+          requestId: '9ec5b177515ee2e5',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1',
+          meta: {
+            advertiserDomains: ['test.com']
+          }
+        }]
+      },
+      {
+        body: [{
+          mediaType: 'native',
+          clickUrl: 'bidscube.com',
+          title: 'Test',
+          image: 'bidscube.com',
+          creativeId: '2',
+          impressionTrackers: ['bidscube.com'],
+          ttl: 120,
+          cpm: 0.4,
+          requestId: '9ec5b177515ee2e5',
+          netRevenue: true,
+          currency: 'USD',
+          meta: {
+            advertiserDomains: ['test.com']
+          }
+        }]
+      }
+    ]
+
+    for (const obj of validData) {
+      const { mediaType } = obj.body[0]
+
+      it(`Should interpret ${mediaType} response`, () => {
+        const response = spec.interpretResponse(obj)
+
+        expect(response).to.be.an('array')
+        strictEqual(1, response.length)
+
+        const copy = { ...obj.body[0] }
+        deepStrictEqual(copy, response[0])
+      })
+    }
+
+    for (const obj of validData) {
+      it(`Should interpret response has meta.advertiserDomains`, () => {
+        const response = spec.interpretResponse(obj)
+
+        expect(response[0]['meta']['advertiserDomains']).to.be.an('array')
+        expect(response[0]['meta']['advertiserDomains'][0]).to.be.an('string')
+      })
+    }
+
+    const invalidData = [
+      {
+        body: [{
+          width: 300,
+          cpm: 0.4,
+          ad: 'Test',
+          requestId: '9ec5b177515ee2e5',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1'
+        }]
+      },
+      {
+        body: [{
+          mediaType: 'video',
+          cpm: 0.5,
+          requestId: '9ec5b177515ee2e5',
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1'
+        }]
+      },
+      {
+        body: [{
+          mediaType: 'native',
+          clickUrl: 'bidscube.com',
+          title: 'Test',
+          impressionTrackers: ['bidscube.com'],
+          ttl: 120,
+          requestId: '9ec5b177515ee2e5',
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+        }]
+      }
+    ]
+
+    for (const obj of invalidData) {
+      const { mediaType } = obj.body[0]
+
+      it(`Should return an empty array if invalid ${mediaType} response is passed `, () => {
+        const response = spec.interpretResponse(obj)
+
+        expect(response).to.be.an('array')
+        strictEqual(0, response.length)
+      })
+    }
+
+    it('Should return an empty array if invalid response is passed', () => {
+      const response = spec.interpretResponse({
+        body: [{
+          ttl: 120,
+          creativeId: '2',
+          netRevenue: true,
+          currency: 'USD',
+          dealId: '1'
+        }]
+      })
+
+      expect(response).to.be.an('array')
+      strictEqual(0, response.length)
+    })
+  })
+
+  describe('getUserSyncs', () => {
+    it('Returns valid URL and type', () => {
+      const expectedResult = [{ type: 'image', url: 'https://supply.bidscube.com/?c=o&m=cookie' }]
+      deepStrictEqual(expectedResult, spec.getUserSyncs())
+    })
+  })
+})