added ccxAdapter (prebid#2575)

* added ccxAdapter

* add ccxAdapter - lint formatting fixes

modules/ccxBidAdapter.js

@@ -0,0 +1,192 @@
+import * as utils from 'src/utils'
+import { registerBidder } from 'src/adapters/bidderFactory'
+import { config } from 'src/config'
+const BIDDER_CODE = 'ccx'
+const BID_URL = 'https://delivery.clickonometrics.pl/ortb/prebid/bid'
+const SUPPORTED_VIDEO_PROTOCOLS = [2, 3, 5, 6]
+const SUPPORTED_VIDEO_MIMES = ['video/mp4', 'video/x-flv']
+const SUPPORTED_VIDEO_PLAYBACK_METHODS = [1, 2, 3, 4]
+
+function _getDeviceObj () {
+  let device = {}
+  device.w = screen.width
+  device.y = screen.height
+  device.ua = navigator.userAgent
+  return device
+}
+
+function _getSiteObj () {
+  let site = {}
+  let url = config.getConfig('pageUrl') || utils.getTopWindowUrl()
+  if (url.length > 0) {
+    url = url.split('?')[0]
+  }
+  site.page = url
+
+  return site
+}
+
+function _validateSizes (sizeObj, type) {
+  if (!utils.isArray(sizeObj)) {
+    return false
+  }
+
+  if (type === 'video' && (typeof sizeObj[0] === 'undefined' || !utils.isArray(sizeObj[0]) || sizeObj[0].length !== 2)) {
+    return false
+  }
+
+  if (type === 'banner') {
+    if (typeof sizeObj[0] === 'undefined') {
+      return false
+    } else {
+      let result = true
+      utils._each(sizeObj, function (size) {
+        if (!utils.isArray(size) || (size.length !== 2)) {
+          result = false
+        }
+      })
+      return result
+    }
+  }
+
+  return true
+}
+
+function _buildBid (bid) {
+  let placement = {}
+  placement.id = bid.bidId
+  placement.secure = 1
+
+  if (utils.deepAccess(bid, 'mediaTypes.banner')) {
+    placement.banner = {'format': []}
+    let sizes = utils.deepAccess(bid, 'mediaTypes.banner.sizes')
+    utils._each(sizes, function (size) {
+      placement.banner.format.push({'w': size[0], 'h': size[1]})
+    })
+  } else if (utils.deepAccess(bid, 'mediaTypes.video')) {
+    placement.video = {}
+
+    let size = utils.deepAccess(bid, 'mediaTypes.video.playerSize')
+
+    if (typeof size !== 'undefined') {
+      placement.video.w = size[0][0]
+      placement.video.h = size[0][1]
+    }
+
+    placement.video.protocols = utils.deepAccess(bid, 'params.video.protocols') || SUPPORTED_VIDEO_PROTOCOLS
+    placement.video.mimes = utils.deepAccess(bid, 'params.video.mimes') || SUPPORTED_VIDEO_MIMES
+    placement.video.playbackmethod = utils.deepAccess(bid, 'params.video.playbackmethod') || SUPPORTED_VIDEO_PLAYBACK_METHODS
+    placement.video.skip = utils.deepAccess(bid, 'params.video.skip') || 0
+    if (placement.video.skip === 1 && utils.deepAccess(bid, 'params.video.skipafter')) {
+      placement.video.skipafter = utils.deepAccess(bid, 'params.video.skipafter')
+    }
+  }
+
+  placement.ext = {'pid': bid.params.placementId}
+
+  return placement
+}
+
+function _buildResponse (bid, currency, ttl) {
+  let resp = {
+    requestId: bid.impid,
+    cpm: bid.price,
+    width: bid.w,
+    height: bid.h,
+    creativeId: bid.crid,
+    netRevenue: false,
+    ttl: ttl,
+    currency: currency
+  }
+
+  if (bid.ext.type === 'video') {
+    resp.vastXml = bid.adm
+  } else {
+    resp.ad = bid.adm
+  }
+
+  if (utils.deepAccess(bid, 'dealid')) {
+    resp.dealId = bid.dealid
+  }
+
+  return resp
+}
+
+export const spec = {
+  code: BIDDER_CODE,
+  supportedMediaTypes: ['banner', 'video'],
+
+  isBidRequestValid: function (bid) {
+    if (!utils.deepAccess(bid, 'params.placementId')) {
+      utils.logWarn('placementId param is reqeuired.')
+      return false
+    }
+    if (utils.deepAccess(bid, 'mediaTypes.banner.sizes')) {
+      let isValid = _validateSizes(bid.mediaTypes.banner.sizes, 'banner')
+      if (!isValid) {
+        utils.logWarn('Bid sizes are invalid.')
+      }
+      return isValid
+    } else if (utils.deepAccess(bid, 'mediaTypes.video.playerSize')) {
+      let isValid = _validateSizes(bid.mediaTypes.video.playerSize, 'video')
+      if (!isValid) {
+        utils.logWarn('Bid sizes are invalid.')
+      }
+      return isValid
+    } else {
+      utils.logWarn('Bid sizes are required.')
+      return false
+    }
+  },
+  buildRequests: function (validBidRequests, bidderRequest) {
+    // check if validBidRequests is not empty
+    if (validBidRequests.length > 0) {
+      let requestBody = {}
+      requestBody.imp = []
+      requestBody.site = _getSiteObj()
+      requestBody.device = _getDeviceObj()
+      requestBody.id = bidderRequest.bids[0].auctionId
+      requestBody.ext = {'ce': (utils.cookiesAreEnabled() ? 1 : 0)}
+      utils._each(validBidRequests, function (bid) {
+        requestBody.imp.push(_buildBid(bid))
+      })
+      // Return the server request
+      return {
+        'method': 'POST',
+        'url': BID_URL,
+        'data': JSON.stringify(requestBody)
+      }
+    }
+  },
+  interpretResponse: function (serverResponse, request) {
+    const bidResponses = []
+
+    // response is not empty (HTTP 204)
+    if (!utils.isEmpty(serverResponse.body)) {
+      utils._each(serverResponse.body.seatbid, function (seatbid) {
+        utils._each(seatbid.bid, function (bid) {
+          bidResponses.push(_buildResponse(bid, serverResponse.body.cur, serverResponse.body.ext.ttl))
+        })
+      })
+    }
+
+    return bidResponses
+  },
+  getUserSyncs: function (syncOptions, serverResponses) {
+    const syncs = []
+
+    if (utils.deepAccess(serverResponses[0], 'body.ext.usersync') && !utils.isEmpty(serverResponses[0].body.ext.usersync)) {
+      utils._each(serverResponses[0].body.ext.usersync, function (match) {
+        if ((syncOptions.iframeEnabled && match.type === 'iframe') || (syncOptions.pixelEnabled && match.type === 'image')) {
+          syncs.push({
+            type: match.type,
+            url: match.url
+          })
+        }
+      })
+    }
+
+    return syncs
+  }
+}
+registerBidder(spec)

modules/ccxBidAdapter.md

@@ -0,0 +1,57 @@
+# Overview
+
+Module Name: Clickonometrics Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: it@clickonometrics.pl
+
+# Description
+
+Module that connects to Clickonometrics's demand sources
+
+# Test Parameters
+
+    var adUnits = [
+	{
+	    code: 'test-banner',
+	    mediaTypes: {
+		banner: {
+		    sizes: [[300, 250]],
+		}
+	    },
+	    bids: [
+		{
+		    bidder: "ccx",
+		    params: {
+			placementId: 3286844
+		    }
+		}
+	    ]
+	},
+	{
+	    code: 'test-video',
+	    mediaTypes: {
+		video: {
+		    playerSize: [1920, 1080]
+
+		}
+	    },
+	    bids: [
+		{
+		    bidder: "ccx",
+		    params: {
+			placementId: 3287742,
+			//following options are not required, default values will be used. Uncomment if you want to use custom values
+			/*video: {
+			    //check OpenRTB documentation for following options description
+			    protocols: [2, 3, 5, 6], //default
+			    mimes: ["video/mp4", "video/x-flv"], //default 
+			    playbackmethod: [1, 2, 3, 4], //default
+			    skip: 1, //default 0
+			    skipafter: 5 //delete this key if skip = 0
+			}*/
+		    }
+		}
+	    ]
+	}
+
+    ];