Add Bright Mountain Media Bid Adapter (#5593)

* Add Bright Mountain Media Bid Adapter * Fix missing quotes around placement_id string * Update maintainer email
prebid · Aug 18, 2020 · 8646ba7 · 8646ba7
1 parent cc58b23
commit 8646ba7
Show file tree

Hide file tree

Showing 3 changed files with 262 additions and 0 deletions.
diff --git a/modules/brightMountainMediaBidAdapter.js b/modules/brightMountainMediaBidAdapter.js
@@ -0,0 +1,89 @@
+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 = 'brightmountainmedia';
+const AD_URL = 'https://console.brightmountainmedia.com/hb/bid';
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: [BANNER, VIDEO, NATIVE],
+
+  isBidRequestValid: (bid) => {
+    return Boolean(bid.bidId && bid.params && bid.params.placement_id);
+  },
+
+  buildRequests: (validBidRequests, bidderRequest) => {
+    let winTop = window;
+    let location;
+    try {
+      location = new URL(bidderRequest.refererInfo.referer)
+      winTop = window.top;
+    } catch (e) {
+      location = winTop.location;
+      utils.logMessage(e);
+    };
+    let placements = [];
+    let request = {
+      'deviceWidth': winTop.screen.width,
+      'deviceHeight': winTop.screen.height,
+      'language': (navigator && navigator.language) ? navigator.language : '',
+      'secure': 1,
+      'host': location.host,
+      'page': location.pathname,
+      'placements': placements
+    };
+    if (bidderRequest) {
+      if (bidderRequest.gdprConsent) {
+        request.gdpr_consent = bidderRequest.gdprConsent.consentString || 'ALL'
+        request.gdpr_require = bidderRequest.gdprConsent.gdprApplies ? 1 : 0
+      }
+    }
+    for (let i = 0; i < validBidRequests.length; i++) {
+      let bid = validBidRequests[i];
+      let traff = bid.params.traffic || BANNER
+      let placement = {
+        placementId: bid.params.placement_id,
+        bidId: bid.bidId,
+        sizes: bid.mediaTypes[traff].sizes,
+        traffic: traff
+      };
+      if (bid.schain) {
+        placement.schain = bid.schain;
+      }
+      placements.push(placement);
+    }
+    return {
+      method: 'POST',
+      url: AD_URL,
+      data: request
+    };
+  },
+
+  interpretResponse: (serverResponse) => {
+    let response = [];
+    try {
+      serverResponse = serverResponse.body;
+      for (let i = 0; i < serverResponse.length; i++) {
+        let resItem = serverResponse[i];
+
+        response.push(resItem);
+      }
+    } catch (e) {
+      utils.logMessage(e);
+    };
+    return response;
+  },
+
+  getUserSyncs: (syncOptions) => {
+    if (syncOptions.iframeEnabled) {
+      return [{
+        type: 'iframe',
+        url: 'https://console.brightmountainmedia.com:4444/cookieSync'
+      }];
+    }
+  },
+
+};
+
+registerBidder(spec);
diff --git a/modules/brightMountainMediaBidAdapter.md b/modules/brightMountainMediaBidAdapter.md
@@ -0,0 +1,34 @@
+# Overview
+
+```
+Module Name:  Bright Mountain Media Bidder Adapter
+Module Type:  Bidder Adapter
+Maintainer: dev@brightmountainmedia.com
+```
+
+# Description
+
+Connects to Bright Mountain Media exchange for bids.
+
+Bright Mountain Media bid adapter currently supports Banner.
+
+# Test Parameters
+```
+ var adUnits = [
+      code: 'placementid_0',
+      mediaTypes: {
+          banner: {
+              sizes: [[300, 250]]
+          }
+      },
+      bids: [
+          {
+              bidder: 'brightmountainmedia',
+              params: {
+                  placement_id: '5f21784949be82079d08c',
+                  traffic: 'banner'
+              }
+          }
+      ]
+    ];
+```
diff --git a/test/spec/modules/brightMountainMediaBidAdapter_spec.js b/test/spec/modules/brightMountainMediaBidAdapter_spec.js
@@ -0,0 +1,139 @@
+import { expect } from 'chai';
+import { spec } from '../../../modules/brightMountainMediaBidAdapter.js';
+
+describe('brightMountainMediaBidAdapter_spec', function () {
+  let bid = {
+    bidId: '2dd581a2b6281d',
+    bidder: 'brightmountainmedia',
+    bidderRequestId: '145e1d6a7837c9',
+    params: {
+      placement_id: '123qwerty'
+    },
+    placementCode: 'placementid_0',
+    auctionId: '74f78609-a92d-4cf1-869f-1b244bbfb5d2',
+    mediaTypes: {
+      banner: {
+        sizes: [[300, 250]]
+      }
+    },
+    transactionId: '3bb2f6da-87a6-4029-aeb0-bfe951372e62',
+  };
+  let bidderRequest = {
+    bidderCode: 'brightmountainmedia',
+    auctionId: 'fffffff-ffff-ffff-ffff-ffffffffffff',
+    bidderRequestId: 'ffffffffffffff',
+    start: 1472239426002,
+    auctionStart: 1472239426000,
+    timeout: 5000,
+    uspConsent: '1YN-',
+    refererInfo: {
+      referer: 'http://www.example.com',
+      reachedTop: true,
+    },
+    bids: [bid]
+  }
+
+  describe('isBidRequestValid', function () {
+    it('Should return true when  when required params found', function () {
+      expect(spec.isBidRequestValid(bid)).to.be.true;
+    });
+    it('Should return false when required params are not passed', function () {
+      bid.params = {}
+      expect(spec.isBidRequestValid(bid)).to.be.false;
+    });
+  });
+
+  describe('buildRequests', function () {
+    let serverRequest = spec.buildRequests([bid], bidderRequest);
+    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('https://console.brightmountainmedia.com/hb/bid');
+    });
+
+    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', 'language', 'secure', 'host', 'page', 'placements');
+      expect(data.deviceWidth).to.be.a('number');
+      expect(data.deviceHeight).to.be.a('number');
+      expect(data.language).to.be.a('string');
+      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('string');
+        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 syncoptionsIframe = {
+      'iframeEnabled': 'true'
+    }
+    it('should return iframe sync option', function () {
+      expect(spec.getUserSyncs(syncoptionsIframe)).to.be.an('array').with.lengthOf(1);
+      expect(spec.getUserSyncs(syncoptionsIframe)[0].type).to.exist;
+      expect(spec.getUserSyncs(syncoptionsIframe)[0].url).to.exist;
+      expect(spec.getUserSyncs(syncoptionsIframe)[0].type).to.equal('iframe')
+      expect(spec.getUserSyncs(syncoptionsIframe)[0].url).to.equal('https://console.brightmountainmedia.com:4444/cookieSync')
+    });
+  });
+});