engagebdr adapter

adapters/engagebdr/engagebdr.go

@@ -0,0 +1,139 @@
+package engagebdr
+
+import (
+	"encoding/json"
+	"github.com/prebid/prebid-server/openrtb_ext"
+	"net/http"
+
+	"fmt"
+
+	"github.com/mxmCherry/openrtb"
+	"github.com/prebid/prebid-server/adapters"
+	"github.com/prebid/prebid-server/errortypes"
+)
+
+type EngageBDRAdapter struct {
+	http *adapters.HTTPAdapter
+	URI  string
+}
+
+func (adapter *EngageBDRAdapter) MakeRequests(request *openrtb.BidRequest, reqInfo *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
+
+	errors := make([]error, 0)
+
+	// EngageBDR uses different sspid parameters for banner and video.
+	sspidImps := make(map[string][]openrtb.Imp)
+	for _, imp := range request.Imp {
+		if imp.Native != nil {
+			// filter native imps from bid request
+			continue
+		}
+		var bidderExt adapters.ExtImpBidder
+		if err := json.Unmarshal(imp.Ext, &bidderExt); err != nil {
+			errors = append(errors, &errortypes.BadInput{
+				Message: fmt.Sprintf("Ignoring imp id=%s, error while decoding extImpBidder, err: %s", imp.ID, err),
+			})
+		}
+		impExt := openrtb_ext.ExtImpEngageBDR{}
+		err := json.Unmarshal(bidderExt.Bidder, &impExt)
+		if err != nil {
+			errors = append(errors, &errortypes.BadInput{
+				Message: fmt.Sprintf("Ignoring imp id=%s, error while decoding impExt, err: %s", imp.ID, err),
+			})
+		}
+		if impExt.Sspid == "" {
+			errors = append(errors, &errortypes.BadInput{
+				Message: fmt.Sprintf("Ignoring imp id=%s, no sspid present", imp.ID),
+			})
+		}
+		sspidImps[impExt.Sspid] = append(sspidImps[impExt.Sspid], imp)
+	}
+
+	var adapterRequests []*adapters.RequestData
+
+	headers := http.Header{}
+	headers.Add("Content-Type", "application/json;charset=utf-8")
+
+	for sspid, imps := range sspidImps {
+		if len(imps) > 0 {
+			// Make a copy as we don't want to change the original request
+			reqCopy := *request
+			reqCopy.Imp = imps
+			reqJSON, err := json.Marshal(reqCopy)
+			if err != nil {
+				errors = append(errors, err)
+				return nil, errors
+			}
+			adapterReq := adapters.RequestData{
+				Method:  "POST",
+				Uri:     adapter.URI + "?zoneid=" + sspid,
+				Body:    reqJSON,
+				Headers: headers,
+			}
+			adapterRequests = append(adapterRequests, &adapterReq)
+		}
+	}
+
+	if len(adapterRequests) == 0 {
+		errors = append(errors, &errortypes.BadInput{Message: fmt.Sprintf("No imps present")})
+		return nil, errors
+	}
+
+	return adapterRequests, errors
+}
+
+func (adapter *EngageBDRAdapter) MakeBids(internalRequest *openrtb.BidRequest, externalRequest *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error) {
+	if response.StatusCode == http.StatusNoContent {
+		return nil, nil
+	}
+
+	if response.StatusCode == http.StatusBadRequest {
+		return nil, []error{&errortypes.BadInput{
+			Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info", response.StatusCode),
+		}}
+	}
+
+	if response.StatusCode != http.StatusOK {
+		return nil, []error{&errortypes.BadServerResponse{
+			Message: fmt.Sprintf("Unexpected status code: %d. Run with request.debug = 1 for more info", response.StatusCode),
+		}}
+	}
+
+	var bidResp openrtb.BidResponse
+	if err := json.Unmarshal(response.Body, &bidResp); err != nil {
+		return nil, []error{err}
+	}
+
+	bidResponse := adapters.NewBidderResponseWithBidsCapacity(5)
+
+	for _, sb := range bidResp.SeatBid {
+		for i := range sb.Bid {
+			bidResponse.Bids = append(bidResponse.Bids, &adapters.TypedBid{
+				Bid:     &sb.Bid[i],
+				BidType: getMediaTypeForImp(sb.Bid[i].ImpID, internalRequest.Imp),
+			})
+		}
+	}
+	return bidResponse, nil
+}
+
+func getMediaTypeForImp(impId string, imps []openrtb.Imp) openrtb_ext.BidType {
+	mediaType := openrtb_ext.BidTypeBanner
+	for _, imp := range imps {
+		if imp.ID == impId {
+			if imp.Banner == nil && imp.Video != nil {
+				mediaType = openrtb_ext.BidTypeVideo
+			}
+			return mediaType
+		}
+	}
+	return mediaType
+}
+
+func NewEngageBDRBidder(client *http.Client, endpoint string) *EngageBDRAdapter {
+	adapter := &adapters.HTTPAdapter{Client: client}
+	return &EngageBDRAdapter{
+		http: adapter,
+		URI:  endpoint,
+	}
+}

adapters/engagebdr/engagebdr_test.go

@@ -0,0 +1,11 @@
+package engagebdr
+
+import (
+	"github.com/prebid/prebid-server/adapters/adapterstest"
+	"net/http"
+	"testing"
+)
+
+func TestJsonSamples(t *testing.T) {
+	adapterstest.RunJSONBidderTest(t, "engagebdrtest", NewEngageBDRBidder(new(http.Client), "http://dsp.bnmla.com/hb"))
+}

adapters/engagebdr/engagebdrtest/exemplary/banner.json

@@ -0,0 +1,89 @@
+{
+  "mockBidRequest": {
+    "id": "test-request-id",
+    "imp": [
+      {
+        "id": "test-imp-id",
+        "banner": {
+          "w": 300,
+          "h": 250
+        },
+        "ext": {
+            "bidder": {
+                "sspid": "99999"
+            }
+        }
+      }
+    ]
+  },
+
+  "httpCalls": [
+    {
+      "expectedRequest": {
+        "uri": "http://dsp.bnmla.com/hb?zoneid=99999",
+        "body":{
+          "id": "test-request-id",
+          "imp": [{
+            "id": "test-imp-id",
+            "banner": {
+              "w": 300,
+              "h": 250
+            },
+            "ext": {
+                "bidder": {
+                    "sspid":"99999"
+                }
+            }
+          }]
+        }
+      },
+      "mockResponse": {
+        "status": 200,
+        "body": {
+          "id": "test-request-id",
+          "seatbid": [
+            {
+              "bid": [
+              ],
+              "seat": "test-request-id"
+            }
+          ],
+          "bidid": "test-request-id",
+          "cur": "USD"
+        }
+      }
+    }
+  ],
+
+  "expectedBidResponses": [
+  {
+      "id": "test-request-id",
+      "seatbid": [
+      {
+          "bid": [
+          {
+              "id": "test-imp-id",
+              "impid": "test-imp-id",
+              "price": 9.81,
+              "adid": "abcde-12345",
+              "adm": "<div><img src=\"https://cdn0.bnmla.com/0b1c6e85e9376e3092df8c9fc8ab9095.gif    \" width=350 height=250 /></div>",
+              "adomain":[
+                  "advertiserdomain.com"
+              ],
+              "iurl": "http://match.bnmla.com/usersync?sspid=59&redir=",
+              "cid": "campaign1",
+              "crid": "abcde-12345",
+              "w": 300,
+              "h": 250
+          }
+          ],
+          "seat": "test-request-id"
+      }
+      ],
+      "bidid": "test-request-id",
+      "cur": "USD"
+
+  }
+  ]
+}
+

adapters/engagebdr/engagebdrtest/exemplary/video.json

@@ -0,0 +1,91 @@
+{
+  "mockBidRequest": {
+    "id": "test-request-id",
+    "imp": [
+      {
+        "id": "test-imp-id",
+        "video": {
+          "w": 300,
+          "mimes": null,
+          "h": 250
+        },
+        "ext": {
+            "bidder": {
+                "sspid":"99998"
+            }
+        }
+      }
+    ]
+  },
+
+  "httpCalls": [
+    {
+      "expectedRequest": {
+        "uri": "http://dsp.bnmla.com/hb?zoneid=99998",
+        "body":{
+          "id": "test-request-id",
+          "imp": [{
+            "id": "test-imp-id",
+            "video": {
+              "w": 300,
+              "mimes": null,
+              "h": 250
+            },
+            "ext": {
+                "bidder": {
+                    "sspid":"99998"
+                }
+            }
+          }]
+        }
+      },
+      "mockResponse": {
+        "status": 200,
+        "body": {
+          "id": "test-request-id",
+          "seatbid": [
+            {
+              "bid": [
+              ],
+              "seat": "test-request-id"
+            }
+          ],
+          "bidid": "test-request-id",
+          "cur": "USD"
+        }
+      }
+    }
+  ],
+
+  "expectedBidResponses": [
+  {
+      "id": "test-request-id",
+      "seatbid": [
+      {
+          "bid": [
+          {
+              "id": "test-imp-id",
+              "impid": "test-imp-id",
+              "price": 9.81,
+              "adid": "abcde-12345",
+              "adm": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<VAST version=\"3.0\"><Ad id=\"static\"><InLine><AdSystem>Static VAST</AdSystem><AdTitle>Static VAST Tag</AdTitle><Error><![CDATA[https://video.bnmla.com/count?vTracking=ERROR&vStatus=[ERRORCODE]&vBaId=6&vZId=9100&VGuid=eng-c719ae10-2349-4c6f-9b93-1bb872e2f13d]]></Error><Impression><![CDATA[https://video.bnmla.com/count?vTracking=IMPRESSION&vStatus=61&vBaId=6&vZId=9100&VGuid=eng-c719ae10-2349-4c6f-9b93-1bb872e2f13d]]></Impression><Creatives><Creative><Linear><Duration><![CDATA[00:00:15]]></Duration><TrackingEvents><Tracking event=\"start\" /><Tracking event=\"firstQuartile\" /><Tracking event=\"midpoint\" /><Tracking event=\"thirdQuartile\" /><Tracking event=\"complete\" /><Tracking event=\"pause\" /><Tracking event=\"mute\" /><Tracking event=\"fullscreen\" /><Tracking event=\"start\"><![CDATA[https://video.bnmla.com/count?vTracking=START&vStatus=61&vBaId=6&vZId=9100&VGuid=eng-c719ae10-2349-4c6f-9b93-1bb872e2f13d]]></Tracking></TrackingEvents><VideoClicks><ClickThrough><![CDATA[http://www.engagebdr.com/]]></ClickThrough><ClickTracking /><ClickTracking><![CDATA[https://video.bnmla.com/count?vTracking=VIDEOCLICKING&vStatus=61&vBaId=6&vZId=9100&VGuid=eng-c719ae10-2349-4c6f-9b93-1bb872e2f13d]]></ClickTracking></VideoClicks><MediaFiles><MediaFile delivery=\"progressive\" type=\"video/mp4\" bitrate=\"350\" width=\"428\" height=\"240\"><![CDATA[http://cdnin.bnmla.com/vsbmedia/AEX_Outdoors_HD_ENG_15_exp2016-01-21_sm.mp4]]></MediaFile><MediaFile delivery=\"progressive\" type=\"video/mp4\" bitrate=\"700\" width=\"640\" height=\"360\"><![CDATA[http://cdnin.bnmla.com/vsbmedia/AEX_Outdoors_HD_ENG_15_exp2016-01-21_md.mp4]]></MediaFile><MediaFile delivery=\"progressive\" type=\"video/mp4\" bitrate=\"1600\" width=\"1024\" height=\"576\"><![CDATA[http://cdnin.bnmla.com/vsbmedia/AEX_Outdoors_HD_ENG_15_exp2016-01-21_lg.mp4]]></MediaFile></MediaFiles></Linear></Creative></Creatives></InLine></Ad></VAST>",
+              "adomain":[
+                  "advertiserdomain.com"
+              ],
+              "iurl": "https://cdn0.bnmla.com/vtest.xml",
+              "cid": "campaign1",
+              "crid": "abcde-12345",
+              "w": 300,
+              "h": 250
+          }
+          ],
+          "seat": "test-request-id"
+      }
+      ],
+      "bidid": "test-request-id",
+      "cur": "USD"
+
+  }
+  ]
+}
+

adapters/engagebdr/engagebdrtest/params/race/banner.json

@@ -0,0 +1,3 @@
+{
+  "zoneid": "10589"
+}

adapters/engagebdr/engagebdrtest/params/race/video.json

@@ -0,0 +1,3 @@
+{
+  "zoneid": "10592"
+}

adapters/engagebdr/params_test.go

@@ -0,0 +1,43 @@
+package engagebdr
+
+import (
+	"encoding/json"
+	"testing"
+
+	"github.com/prebid/prebid-server/openrtb_ext"
+)
+
+func TestValidParams(t *testing.T) {
+	validator, err := openrtb_ext.NewBidderParamsValidator("../../static/bidder-params")
+	if err != nil {
+		t.Fatalf("Failed to fetch the json-schemas. %v", err)
+	}
+
+	for _, validParam := range validParams {
+		if err := validator.Validate(openrtb_ext.BidderEngageBDR, json.RawMessage(validParam)); err != nil {
+			t.Errorf("Schema rejected beachfront params: %s", validParam)
+		}
+	}
+}
+
+func TestInvalidParams(t *testing.T) {
+	validator, err := openrtb_ext.NewBidderParamsValidator("../../static/bidder-params")
+	if err != nil {
+		t.Fatalf("Failed to fetch the json-schemas. %v", err)
+	}
+
+	for _, invalidParam := range invalidParams {
+		if err := validator.Validate(openrtb_ext.BidderEngageBDR, json.RawMessage(invalidParam)); err == nil {
+			t.Errorf("Schema allowed unexpected params: %s", invalidParam)
+		}
+	}
+}
+
+var validParams = []string{
+	`{"sspid":"12345"}`,
+}
+
+var invalidParams = []string{
+	`{"sspid":null}`,
+	`{"appId":"11bc5dd5-7421-4dd8-c926-40fa653bec76"}`,
+}

adapters/engagebdr/usersync.go

@@ -0,0 +1,11 @@
+package engagebdr
+
+import (
+	"github.com/prebid/prebid-server/adapters"
+	"github.com/prebid/prebid-server/usersync"
+	"text/template"
+)
+
+func NewEngageBDRSyncer(temp *template.Template) usersync.Usersyncer {
+	return adapters.NewSyncer("engagebdr", 62, temp, adapters.SyncTypeIframe)
+}