A4G prebid adapter

modules/a4gBidAdapter.js

@@ -0,0 +1,77 @@
+import {registerBidder} from 'src/adapters/bidderFactory';
+import * as utils from 'src/utils';
+
+const A4G_BIDDER_CODE = 'a4g';
+const A4G_CURRENCY = 'USD';
+const A4G_DEFAULT_BID_URL = '//ads.ad4game.com/v1/bid';
+const A4G_TTL = 120;
+
+const LOCATION_PARAM_NAME = 'siteurl';
+const ID_PARAM_NAME = 'id';
+const ZONE_ID_PARAM_NAME = 'zoneId';
+const SIZE_PARAM_NAME = 'size';
+
+const ARRAY_PARAM_SEPARATOR = ';';
+const ARRAY_SIZE_SEPARATOR = ',';
+const SIZE_SEPARATOR = 'x';
+
+export const spec = {
+  code: A4G_BIDDER_CODE,
+  isBidRequestValid: function(bid) {
+    return bid.params && !!bid.params.zoneId;
+  },
+
+  buildRequests: function(validBidRequests) {
+    let deliveryUrl = '';
+    const idParams = [];
+    const sizeParams = [];
+    const zoneIds = [];
+
+    utils._each(validBidRequests, function(bid) {
+      if (!deliveryUrl && typeof bid.params.deliveryUrl === 'string') {
+        deliveryUrl = bid.params.deliveryUrl;
+      }
+      idParams.push(bid.adUnitCode);
+      sizeParams.push(bid.sizes.map(size => size.join(SIZE_SEPARATOR)).join(ARRAY_SIZE_SEPARATOR));
+      zoneIds.push(bid.params.zoneId);
+    });
+
+    if (!deliveryUrl) {
+      deliveryUrl = A4G_DEFAULT_BID_URL;
+    }
+
+    return {
+      method: 'GET',
+      url: deliveryUrl,
+      data: {
+        [LOCATION_PARAM_NAME]: utils.getTopWindowUrl(),
+        [SIZE_PARAM_NAME]: sizeParams.join(ARRAY_PARAM_SEPARATOR),
+        [ID_PARAM_NAME]: idParams.join(ARRAY_PARAM_SEPARATOR),
+        [ZONE_ID_PARAM_NAME]: zoneIds.join(ARRAY_PARAM_SEPARATOR)
+      }
+    };
+  },
+
+  interpretResponse: function(serverResponses, request) {
+    const bidResponses = [];
+    utils._each(serverResponses, function(response) {
+      const bidResponse = {
+        requestId: request.bidId,
+        bidderCode: spec.code,
+        cpm: response.cpm,
+        width: response.width,
+        height: response.height,
+        creativeId: response.zoneid,
+        currency: A4G_CURRENCY,
+        netRevenue: true,
+        ttl: A4G_TTL,
+        ad: response.ad
+      };
+      bidResponses.push(bidResponse);
+    });
+
+    return bidResponses;
+  }
+};
+
+registerBidder(spec);

modules/a4gBidAdapter.md

@@ -0,0 +1,40 @@
+# Overview
+
+Module Name: Ad4Game Bidder Adapter
+Module Type: Bidder Adapter
+Maintainer: [email protected]
+
+# Description
+
+Ad4Game Bidder Adapter for Prebid.js
+
+# Test Parameters
+```
+    var adUnits = [
+       {
+           code: 'test-div',
+           sizes: [[300, 250]],  // a display size
+           bids: [
+               {
+                    bidder: 'a4g',
+                    params: {
+                        zoneId: 59304,
+                        deliveryUrl: 'http://dev01.ad4game.com/v1/bid'
+                    }
+               }
+           ]
+       },{
+           code: 'test-div',
+           sizes: [[300, 50]],   // a mobile size
+           bids: [
+               {
+                    bidder: 'a4g',
+                    params: {
+                        zoneId: 59354,
+                        deliveryUrl: 'http://dev01.ad4game.com/v1/bid'
+                    }
+               }
+           ]
+       }
+    ];
+```

test/spec/modules/a4gBidAdapter_spec.js

@@ -0,0 +1,126 @@
+import { expect} from 'chai';
+import { spec } from 'modules/a4gBidAdapter';
+
+describe('a4gAdapterTests', () => {
+  describe('bidRequestValidity', () => {
+    it('bidRequest with zoneId and deliveryUrl params', () => {
+      expect(spec.isBidRequestValid({
+        bidder: 'a4g',
+        params: {
+          zoneId: 59304,
+          deliveryUrl: 'http://dev01.ad4game.com/v1/bid'
+        }
+      })).to.equal(true);
+    });
+
+    it('bidRequest with only zoneId', () => {
+      expect(spec.isBidRequestValid({
+        bidder: 'a4g',
+        params: {
+          zoneId: 59304
+        }
+      })).to.equal(true);
+    });
+
+    it('bidRequest with only deliveryUrl', () => {
+      expect(spec.isBidRequestValid({
+        bidder: 'a4g',
+        params: {
+          deliveryUrl: 'http://dev01.ad4game.com/v1/bid'
+        }
+      })).to.equal(false);
+    });
+  });
+
+  describe('bidRequest', () => {
+    const bidRequests = [{
+      'bidder': 'a4g',
+      'bidId': '51ef8751f9aead',
+      'params': {
+        'zoneId': 59304,
+      },
+      'adUnitCode': 'div-gpt-ad-1460505748561-0',
+      'transactionId': 'd7b773de-ceaa-484d-89ca-d9f51b8d61ec',
+      'sizes': [[320, 50], [300, 250], [300, 600]],
+      'bidderRequestId': '418b37f85e772c',
+      'auctionId': '18fd8b8b0bd757'
+    }, {
+      'bidder': 'a4g',
+      'bidId': '51ef8751f9aead',
+      'params': {
+        'zoneId': 59354,
+        'deliveryUrl': '//dev01.ad4game.com/v1/bid'
+      },
+      'adUnitCode': 'div-gpt-ad-1460505748561-0',
+      'transactionId': 'd7b773de-ceaa-484d-89ca-d9f51b8d61ec',
+      'sizes': [[320, 50], [300, 250], [300, 600]],
+      'bidderRequestId': '418b37f85e772c',
+      'auctionId': '18fd8b8b0bd757'
+    }];
+
+    it('bidRequest method', () => {
+      const request = spec.buildRequests(bidRequests);
+      expect(request.method).to.equal('GET');
+    });
+
+    it('bidRequest url', () => {
+      const request = spec.buildRequests(bidRequests);
+      expect(request.url).to.match(new RegExp(`${bidRequests[1].params.deliveryUrl}`));
+    });
+
+    it('bidRequest data', () => {
+      const request = spec.buildRequests(bidRequests);
+      expect(request.data).to.exists;
+    });
+
+    it('bidRequest zoneIds', () => {
+      const request = spec.buildRequests(bidRequests);
+      expect(request.data.zoneId).to.equal('59304;59354');
+    });
+  });
+
+  describe('interpretResponse', () => {
+    const bidRequest = [{
+      'bidder': 'a4g',
+      'bidId': '51ef8751f9aead',
+      'params': {
+        'zoneId': 59304,
+      },
+      'adUnitCode': 'div-gpt-ad-1460505748561-0',
+      'transactionId': 'd7b773de-ceaa-484d-89ca-d9f51b8d61ec',
+      'sizes': [[320, 50], [300, 250], [300, 600]],
+      'bidderRequestId': '418b37f85e772c',
+      'auctionId': '18fd8b8b0bd757'
+    }];
+
+    const bidResponse = [{
+      'id': 'div-gpt-ad-1460505748561-0',
+      'ad': 'test ad',
+      'width': 320,
+      'height': 250,
+      'cpm': 5.2
+    }];
+
+    it('required keys', () => {
+      const result = spec.interpretResponse(bidResponse, bidRequest);
+
+      let requiredKeys = [
+        'requestId',
+        'bidderCode',
+        'cpm',
+        'width',
+        'height',
+        'ad',
+        'ttl',
+        'creativeId',
+        'netRevenue',
+        'currency'
+      ];
+
+      let resultKeys = Object.keys(result[0]);
+      resultKeys.forEach(function(key) {
+        expect(requiredKeys.indexOf(key) !== -1).to.equal(true);
+      });
+    })
+  });
+});

yarn.lock

@@ -1925,7 +1925,7 @@ d@1:
   dependencies:
     es5-ext "^0.10.9"
 
-"dargs@github:christian-bromann/dargs":
+dargs@christian-bromann/dargs:
   version "4.0.1"
   resolved "https://codeload.github.com/christian-bromann/dargs/tar.gz/7d6d4164a7c4106dbd14ef39ed8d95b7b5e9b770"
   dependencies: