EPlanning: Add schain support

adapters/eplanning/eplanning.go

@@ -1,12 +1,12 @@
 package eplanning
 
 import (
+	"encoding/json"
 	"math/rand"
 	"net/http"
 	"net/url"
-	"strings"
-
 	"regexp"
+	"strings"
 
 	"fmt"
 
@@ -195,6 +195,9 @@ func (adapter *EPlanningAdapter) MakeRequests(request *openrtb2.BidRequest, reqI
 		query.Set("vctx", strconv.Itoa(impType))
 		query.Set("vv", vastVersionDefault)
 	}
+	if request.Source != nil && request.Source.Ext != nil {
+		setSchain(request.Source.Ext, &query)
+	}
 
 	uriObj.RawQuery = query.Encode()
 	uri := uriObj.String()
@@ -212,6 +215,78 @@ func (adapter *EPlanningAdapter) MakeRequests(request *openrtb2.BidRequest, reqI
 	return requests, errors
 }
 
+func setSchain(ext json.RawMessage, query *url.Values) {
+	openRtbSchain := unmarshalSupplyChain(ext)
+	if openRtbSchain == nil || len(openRtbSchain.Nodes) > 2 {
+		return
+	}
+	if schainValue := makeSupplyChain(*openRtbSchain); schainValue != "" {
+		query.Set("sch", schainValue)
+	}
+}
+
+func unmarshalSupplyChain(ext json.RawMessage) *openrtb2.SupplyChain {
+	var extSChain openrtb_ext.ExtRequestPrebidSChain
+	err := jsonutil.Unmarshal(ext, &extSChain)
+	if err != nil {
+		return nil
+	}
+	return &extSChain.SChain
+}
+
+func makeSupplyChain(openRtbSchain openrtb2.SupplyChain) string {
+	if len(openRtbSchain.Nodes) == 0 {
+		return ""
+	}
+
+	const schainPrefixFmt = "%s,%d"
+	const schainNodeFmt = "!%s,%s,%s,%s,%s,%s,%s"
+	schainPrefix := fmt.Sprintf(schainPrefixFmt, openRtbSchain.Ver, openRtbSchain.Complete)
+	var sb strings.Builder
+	sb.WriteString(schainPrefix)
+	for _, node := range openRtbSchain.Nodes {
+		// has to be in order: asi,sid,hp,rid,name,domain,ext
+		schainNode := fmt.Sprintf(
+			schainNodeFmt,
+			makeNodeValue(node.ASI),
+			makeNodeValue(node.SID),
+			makeNodeValue(node.HP),
+			makeNodeValue(node.RID),
+			makeNodeValue(node.Name),
+			makeNodeValue(node.Domain),
+			makeNodeValue(node.Ext),
+		)
+		sb.WriteString(schainNode)
+	}
+	return sb.String()
+}
+
+func makeNodeValue(nodeParam any) string {
+	switch nodeParam := nodeParam.(type) {
+	case string:
+		return url.QueryEscape(nodeParam)
+	case *int8:
+		pointer := nodeParam
+		if pointer == nil {
+			return ""
+		}
+		return makeNodeValue(int(*pointer))
+	case int:
+		return strconv.Itoa(nodeParam)
+	case json.RawMessage:
+		if nodeParam != nil {
+			freeFormJson, err := json.Marshal(nodeParam)
+			if err != nil {
+				return ""
+			}
+			return makeNodeValue(string(freeFormJson))
+		}
+		return ""
+	default:
+		return ""
+	}
+}
+
 func isMobileDevice(request *openrtb2.BidRequest) bool {
 	return request.Device != nil && (request.Device.DeviceType == adcom1.DeviceMobile || request.Device.DeviceType == adcom1.DevicePhone || request.Device.DeviceType == adcom1.DeviceTablet)
 }

adapters/eplanning/eplanningtest/supplemental/bid-with-2-nodes-schain.json

@@ -0,0 +1,106 @@
+{
+  "mockBidRequest": {
+	"id": "test-request-id",
+	"source": {
+	  "ext": {
+		"schain": {
+		  "ver": "1.0",
+		  "complete": 1,
+		  "nodes": [
+			{
+			  "asi": "exchange1.com",
+			  "sid": "1234",
+			  "hp": 1,
+			  "ext": "text"
+			},
+			{
+			  "asi": "exchange2.com",
+			  "sid": "abcd",
+			  "hp": 1,
+			  "ext": 1
+			},
+			{
+			  "asi": "exchange3.com",
+			  "sid": "abcdf",
+			  "hp": 1,
+			  "ext": 1
+			}
+		  ]
+		}
+	  }
+	},
+	"imp": [
+	  {
+		"id": "test-imp-id",
+		"banner": {
+		  "format": [
+			{
+			  "w": 300,
+			  "h": 250
+			},
+			{
+			  "w": 300,
+			  "h": 600
+			}
+		  ]
+		},
+		"ext": {
+		  "bidder": {
+			"ci": "12345"
+		  }
+		}
+	  }
+	]
+  },
+	"httpCalls": [
+	{
+	  "expectedRequest": {
+		"uri": "http://rtb.e-planning.net/pbs/1/12345/1/FILE/ROS?e=300x250%3A300x250&ncb=1&ur=FILE",
+		"body": {},
+		"impIDs":["test-imp-id"]
+	  },
+	  "mockResponse": {
+		"status": 200,
+		"body": {
+		  "sI": { "k": "12345" },
+		  "sec": "ROS",
+		  "sp": [
+			{
+			  "k": "300x250",
+			  "a": [{
+				"i": "123456789abcdef",
+				"pr": "0.5",
+				"adm": "<div>test</div>",
+				"crid": "abcdef123456789",
+				"id": "adid12345",
+				"w": 300,
+				"h": 250
+			  }]
+			}
+		  ]
+		}
+	  }
+	}
+  ],
+
+  "expectedBidResponses": [
+	{
+	  "currency": "USD",
+	  "bids": [
+		{
+		  "bid": {
+			"id": "123456789abcdef",
+			"impid": "test-imp-id",
+			"price": 0.5,
+			"adm": "<div>test</div>",
+			"adid": "adid12345",
+			"crid": "abcdef123456789",
+			"w": 300,
+			"h": 250
+		  },
+		  "type": "banner"
+		}
+	  ]
+	}
+  ]
+}

adapters/eplanning/eplanningtest/supplemental/bid-with-schain.json

@@ -0,0 +1,94 @@
+{
+  "mockBidRequest": {
+	"id": "test-request-id",
+	"source": {
+	  "ext": {
+		"schain": {
+		  "ver": "1.0",
+		  "complete": 1,
+		  "nodes": [
+			{
+			  "asi": "exchange1.com",
+			  "sid": "1234",
+			  "hp": 1,
+			  "ext": "text"
+			}
+		  ]
+		}
+	  }
+	},
+	"imp": [
+	  {
+		"id": "test-imp-id",
+		"banner": {
+		  "format": [
+			{
+			  "w": 300,
+			  "h": 250
+			},
+			{
+			  "w": 300,
+			  "h": 600
+			}
+		  ]
+		},
+		"ext": {
+		  "bidder": {
+			"ci": "12345"
+		  }
+		}
+	  }
+	]
+  },
+	"httpCalls": [
+	{
+	  "expectedRequest": {
+		"uri": "http://rtb.e-planning.net/pbs/1/12345/1/FILE/ROS?e=300x250%3A300x250&ncb=1&sch=1.0%2C1%21exchange1.com%2C1234%2C1%2C%2C%2C%2C%2522text%2522&ur=FILE",
+		"body": {},
+		"impIDs":["test-imp-id"]
+	  },
+	  "mockResponse": {
+		"status": 200,
+		"body": {
+		  "sI": { "k": "12345" },
+		  "sec": "ROS",
+		  "sp": [
+			{
+			  "k": "300x250",
+			  "a": [{
+				"i": "123456789abcdef",
+				"pr": "0.5",
+				"adm": "<div>test</div>",
+				"crid": "abcdef123456789",
+				"id": "adid12345",
+				"w": 300,
+				"h": 250
+			  }]
+			}
+		  ]
+		}
+	  }
+	}
+  ],
+
+  "expectedBidResponses": [
+	{
+	  "currency": "USD",
+	  "bids": [
+		{
+		  "bid": {
+			"id": "123456789abcdef",
+			"impid": "test-imp-id",
+			"price": 0.5,
+			"adm": "<div>test</div>",
+			"adid": "adid12345",
+			"crid": "abcdef123456789",
+			"w": 300,
+			"h": 250
+		  },
+		  "type": "banner"
+		}
+	  ]
+	}
+  ]
+}