Added support for GDPR, COPPA, and USP (#5210)

* Added CPMStar Bid Adapter * Updated getPlayerSize for cpmstarBidAdapter * Improved cpmstarBidAdapter code coverage * updated test spec, removed empty functions, made imports relative, added warnings to erroneous server responses, and removed the default value for ad in bid response. * added test video ad unit * added support for gdpr and coppa * changed != undefined to != null * changed let to var * added unit for GDPR, COPPA, and USP. Co-authored-by: Nicholas Elek <nelek@cpmstar.com>
prebid · May 21, 2020 · 25b7189 · 25b7189
1 parent ef7acc2
commit 25b7189
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 14 deletions.
diff --git a/modules/cpmstarBidAdapter.js b/modules/cpmstarBidAdapter.js
@@ -1,7 +1,8 @@
 
 import * as utils from '../src/utils.js';
 import { registerBidder } from '../src/adapters/bidderFactory.js';
-import {VIDEO, BANNER} from '../src/mediaTypes.js';
+import { VIDEO, BANNER } from '../src/mediaTypes.js';
+import { config } from '../src/config.js';
 
 const BIDDER_CODE = 'cpmstar';
 
@@ -17,12 +18,12 @@ export const spec = {
   supportedMediaTypes: [BANNER, VIDEO],
   pageID: Math.floor(Math.random() * 10e6),
 
-  getMediaType: function(bidRequest) {
+  getMediaType: function (bidRequest) {
     if (bidRequest == null) return BANNER;
     return !utils.deepAccess(bidRequest, 'mediaTypes.video') ? BANNER : VIDEO;
   },
 
-  getPlayerSize: function(bidRequest) {
+  getPlayerSize: function (bidRequest) {
     var playerSize = utils.deepAccess(bidRequest, 'mediaTypes.video.playerSize');
     if (playerSize == null) return [640, 440];
     if (playerSize[0] != null) playerSize = playerSize[0];
@@ -46,9 +47,33 @@ export const spec = {
       var mediaType = spec.getMediaType(bidRequest);
       var playerSize = spec.getPlayerSize(bidRequest);
       var videoArgs = '&fv=0' + (playerSize ? ('&w=' + playerSize[0] + '&h=' + playerSize[1]) : '');
+
+      var url = ENDPOINT + '?media=' + mediaType + (mediaType == VIDEO ? videoArgs : '') +
+        '&json=c_b&mv=1&poolid=' + utils.getBidIdParameter('placementId', bidRequest.params) +
+        '&reachedTop=' + encodeURIComponent(bidderRequest.refererInfo.reachedTop) +
+        '&requestid=' + bidRequest.bidId +
+        '&referer=' + encodeURIComponent(referer);
+
+      if (bidderRequest.gdprConsent) {
+        if (bidderRequest.gdprConsent.consentString != null) {
+          url += '&gdpr_consent=' + bidderRequest.gdprConsent.consentString;
+        }
+        if (bidderRequest.gdprConsent.gdprApplies != null) {
+          url += '&gdpr=' + (bidderRequest.gdprConsent.gdprApplies ? 1 : 0);
+        }
+      }
+
+      if (bidderRequest.uspConsent != null) {
+        url += '&us_privacy=' + bidderRequest.uspConsent;
+      }
+
+      if (config.getConfig('coppa')) {
+        url += '&tfcd=' + (config.getConfig('coppa') ? 1 : 0);
+      }
+
       requests.push({
         method: 'GET',
-        url: ENDPOINT + '?media=' + mediaType + (mediaType == VIDEO ? videoArgs : '') + '&json=c_b&mv=1&poolid=' + utils.getBidIdParameter('placementId', bidRequest.params) + '&reachedTop=' + encodeURIComponent(bidderRequest.refererInfo.reachedTop) + '&requestid=' + bidRequest.bidId + '&referer=' + referer,
+        url: url,
         bidRequest: bidRequest,
       });
     }

diff --git a/modules/cpmstarBidAdapter.md b/modules/cpmstarBidAdapter.md
@@ -4,6 +4,9 @@
 Module Name: Cpmstar Bidder Adapter
 Module Type: Bidder Adapter
 Maintainer: josh@cpmstar.com
+gdpr_supported: true
+usp_supported: true
+coppa_supported: true
 ```
 
 # Description

diff --git a/test/spec/modules/cpmstarBidAdapter_spec.js b/test/spec/modules/cpmstarBidAdapter_spec.js
@@ -1,6 +1,7 @@
 import { expect } from 'chai';
 import { spec } from 'modules/cpmstarBidAdapter.js';
 import { deepClone } from 'src/utils.js';
+import { config } from 'src/config.js';
 
 describe('Cpmstar Bid Adapter', function () {
   describe('isBidRequestValid', function () {
@@ -15,22 +16,26 @@ describe('Cpmstar Bid Adapter', function () {
       expect(spec.isBidRequestValid(bid)).to.equal(false);
     })
 
-    it('should return a valid player size', function() {
-      var bid = { mediaTypes: {
-        video: {
-          playerSize: [[960, 540]]
+    it('should return a valid player size', function () {
+      var bid = {
+        mediaTypes: {
+          video: {
+            playerSize: [[960, 540]]
+          }
         }
-      }}
+      }
       expect(spec.getPlayerSize(bid)[0]).to.equal(960);
       expect(spec.getPlayerSize(bid)[1]).to.equal(540);
     })
 
-    it('should return a default player size', function() {
-      var bid = { mediaTypes: {
-        video: {
-          playerSize: null
+    it('should return a default player size', function () {
+      var bid = {
+        mediaTypes: {
+          video: {
+            playerSize: null
+          }
         }
-      }}
+      }
       expect(spec.getPlayerSize(bid)[0]).to.equal(640);
       expect(spec.getPlayerSize(bid)[1]).to.equal(440);
     })
@@ -79,6 +84,31 @@ describe('Cpmstar Bid Adapter', function () {
       expect(requests[0]).to.have.property('bidRequest');
       expect(requests[0].url).to.include('https://dev.server.cpmstar.com/view.aspx');
     });
+    it('should produce a request with support for GDPR', function () {
+      var gdpr_bidderRequest = deepClone(bidderRequest);
+      gdpr_bidderRequest.gdprConsent = {
+        consentString: 'consentString',
+        gdprApplies: true
+      };
+      var requests = spec.buildRequests(valid_bid_requests, gdpr_bidderRequest);
+      expect(requests[0]).to.have.property('url');
+      expect(requests[0].url).to.include('gdpr_consent=consentString');
+      expect(requests[0].url).to.include('gdpr=1');
+    });
+    it('should produce a request with support for USP', function () {
+      var usp_bidderRequest = deepClone(bidderRequest);
+      usp_bidderRequest.uspConsent = '1YYY';
+      var requests = spec.buildRequests(valid_bid_requests, usp_bidderRequest);
+      expect(requests[0]).to.have.property('url');
+      expect(requests[0].url).to.include('us_privacy=1YYY');
+    });
+    it('should produce a request with support for COPPA', function () {
+      sinon.stub(config, 'getConfig').withArgs('coppa').returns(true);
+      var requests = spec.buildRequests(valid_bid_requests, bidderRequest);
+      config.getConfig.restore();
+      expect(requests[0]).to.have.property('url');
+      expect(requests[0].url).to.include('tfcd=1');
+    });
   })
 
   describe('interpretResponse', function () {