Add FairTrade Bid Adapter (#2147)

Author: VaticSSP

modules/fairtradeBidAdapter.js

@@ -0,0 +1,150 @@
+import * as utils from 'src/utils';
+import {registerBidder} from 'src/adapters/bidderFactory';
+const BIDDER_CODE = 'fairtrade';
+const ENDPOINT_URL = '//pool.fair-trademedia.com/hb';
+const TIME_TO_LIVE = 360;
+const ADAPTER_SYNC_URL = '//pool.fair-trademedia.com/push_sync';
+const LOG_ERROR_MESS = {
+  noAuid: 'Bid from response has no auid parameter - ',
+  noAdm: 'Bid from response has no adm parameter - ',
+  noBid: 'Array of bid objects is empty',
+  noPlacementCode: 'Can\'t find in requested bids the bid with auid - ',
+  emptyUids: 'Uids should be not empty',
+  emptySeatbid: 'Seatbid array from response has empty item',
+  emptyResponse: 'Response is empty',
+  hasEmptySeatbidArray: 'Response has empty seatbid array',
+  hasNoArrayOfBids: 'Seatbid from response has no array of bid objects - '
+};
+export const spec = {
+  code: BIDDER_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.uid;
+  },
+  /**
+   * Make a server request from the list of BidRequests.
+   *
+   * @param {BidRequest[]} validBidRequests - an array of bids
+   * @return ServerRequest Info describing the request to the server.
+   */
+  buildRequests: function(validBidRequests) {
+    const auids = [];
+    const bidsMap = {};
+    const bids = validBidRequests || [];
+    let priceType = 'net';
+    let reqId;
+
+    bids.forEach(bid => {
+      if (bid.params.priceType === 'gross') {
+        priceType = 'gross';
+      }
+      reqId = bid.bidderRequestId;
+      if (!bidsMap[bid.params.uid]) {
+        bidsMap[bid.params.uid] = [bid];
+        auids.push(bid.params.uid);
+      } else {
+        bidsMap[bid.params.uid].push(bid);
+      }
+    });
+
+    const payload = {
+      u: utils.getTopWindowUrl(),
+      pt: priceType,
+      auids: auids.join(','),
+      r: reqId
+    };
+
+    return {
+      method: 'GET',
+      url: ENDPOINT_URL,
+      data: payload,
+      bidsMap: bidsMap,
+    };
+  },
+  /**
+   * Unpack the response from the server into a list of bids.
+   *
+   * @param {*} serverResponse A successful response from the server.
+   * @param {*} bidRequest
+   * @return {Bid[]} An array of bids which were nested inside the server.
+   */
+  interpretResponse: function(serverResponse, bidRequest) {
+    serverResponse = serverResponse && serverResponse.body
+    const bidResponses = [];
+    const bidsMap = bidRequest.bidsMap;
+    const priceType = bidRequest.data.pt;
+
+    let errorMessage;
+
+    if (!serverResponse) errorMessage = LOG_ERROR_MESS.emptyResponse;
+    else if (serverResponse.seatbid && !serverResponse.seatbid.length) {
+      errorMessage = LOG_ERROR_MESS.hasEmptySeatbidArray;
+    }
+
+    if (!errorMessage && serverResponse.seatbid) {
+      serverResponse.seatbid.forEach(respItem => {
+        _addBidResponse(_getBidFromResponse(respItem), bidsMap, priceType, bidResponses);
+      });
+    }
+    if (errorMessage) utils.logError(errorMessage);
+    return bidResponses;
+  },
+  getUserSyncs: function(syncOptions) {
+    if (syncOptions.pixelEnabled) {
+      return [{
+        type: 'image',
+        url: ADAPTER_SYNC_URL
+      }];
+    }
+  }
+}
+
+function _getBidFromResponse(respItem) {
+  if (!respItem) {
+    utils.logError(LOG_ERROR_MESS.emptySeatbid);
+  } else if (!respItem.bid) {
+    utils.logError(LOG_ERROR_MESS.hasNoArrayOfBids + JSON.stringify(respItem));
+  } else if (!respItem.bid[0]) {
+    utils.logError(LOG_ERROR_MESS.noBid);
+  }
+  return respItem && respItem.bid && respItem.bid[0];
+}
+
+function _addBidResponse(serverBid, bidsMap, priceType, bidResponses) {
+  if (!serverBid) return;
+  let errorMessage;
+  if (!serverBid.auid) errorMessage = LOG_ERROR_MESS.noAuid + JSON.stringify(serverBid);
+  if (!serverBid.adm) errorMessage = LOG_ERROR_MESS.noAdm + JSON.stringify(serverBid);
+  else {
+    const awaitingBids = bidsMap[serverBid.auid];
+    if (awaitingBids) {
+      awaitingBids.forEach(bid => {
+        const bidResponse = {
+          requestId: bid.bidId, // bid.bidderRequestId,
+          cpm: serverBid.price,
+          width: serverBid.w,
+          height: serverBid.h,
+          creativeId: serverBid.auid, // bid.bidId,
+          currency: 'USD',
+          netRevenue: priceType !== 'gross',
+          ttl: TIME_TO_LIVE,
+          ad: serverBid.adm,
+          dealId: serverBid.dealid
+        };
+        bidResponses.push(bidResponse);
+      });
+    } else {
+      errorMessage = LOG_ERROR_MESS.noPlacementCode + serverBid.auid;
+    }
+  }
+  if (errorMessage) {
+    utils.logError(errorMessage);
+  }
+}
+
+registerBidder(spec);

modules/fairtradeBidAdapter.md

@@ -0,0 +1,28 @@
+# Overview
+
+Module Name: FairTrade Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: [email protected]
+
+# Description
+
+Module that connects to FairTrade demand source to fetch bids.
+
+# Test Parameters
+```
+    var adUnits = [
+           {
+               code: 'test-div',
+               sizes: [[300, 250]],
+               bids: [
+                   {
+                       bidder: "fairtrade",
+                       params: {
+                           uid: '166',
+                           priceType: 'gross' // by default is 'net'
+                       }
+                   }
+               ]
+           }
+       ];
+```