New adapter: Adagio

adapters/adagio/adagio.go

@@ -0,0 +1,145 @@
+package adagio
+
+import (
+	"bytes"
+	"compress/gzip"
+	"encoding/json"
+	"fmt"
+	"github.com/mxmCherry/openrtb/v15/openrtb2"
+	"github.com/prebid/prebid-server/adapters"
+	"github.com/prebid/prebid-server/config"
+	"github.com/prebid/prebid-server/errortypes"
+	"github.com/prebid/prebid-server/openrtb_ext"
+	"net/http"
+)
+
+// Builder builds a new instance of the Adagio adapter for the given bidder with the given config.
+func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error) {
+	bidder := &adapter{
+		endpoint: config.Endpoint,
+	}
+	return bidder, nil
+}
+
+type adapter struct {
+	endpoint string
+}
+
+// MakeRequests prepares the HTTP requests which should be made to fetch bids.
+func (a *adapter) MakeRequests(request *openrtb2.BidRequest, _ *adapters.ExtraRequestInfo) ([]*adapters.RequestData, []error) {
+	json, err := json.Marshal(request)
+	if err != nil {
+		return nil, []error{err}
+	}
+
+	headers := http.Header{}
+	headers.Add("Content-Type", "application/json;charset=utf-8")
+	headers.Add("Accept", "application/json")
+
+	if request.Device != nil {
+		if len(request.Device.IPv6) > 0 {
+			headers.Add("X-Forwarded-For", request.Device.IPv6)
+		}
+		if len(request.Device.IP) > 0 {
+			headers.Add("X-Forwarded-For", request.Device.IP)
+		}
+	}
+
+	if request.Test == 0 {
+		// Gzip the body
+		// Note: Gzipping could be handled natively later: https://github.com/prebid/prebid-server/issues/1812
+		var bodyBuf bytes.Buffer
+		gz := gzip.NewWriter(&bodyBuf)
+		_, err = gz.Write(json)
+		if err == nil {
+			err = gz.Close()
+			if err == nil {
+				json = bodyBuf.Bytes()
+				headers.Add("Content-Encoding", "gzip")
+				// /!\ Go already sets the `Accept-Encoding: gzip` header. Never add it manually, or Go won't decompress the response.
+				//headers.Add("Accept-Encoding", "gzip")
+			}
+		}
+	}
+
+	requestToBidder := &adapters.RequestData{
+		Method:  "POST",
+		Uri:     a.endpoint,
+		Body:    json,
+		Headers: headers,
+	}
+
+	return []*adapters.RequestData{requestToBidder}, nil
+}
+
+const unexpectedStatusCodeFormat = "Unexpected status code: %d. Run with request.debug = 1 for more info"
+
+// MakeBids unpacks the server's response into Bids.
+func (a *adapter) MakeBids(internalRequest *openrtb2.BidRequest, _ *adapters.RequestData, response *adapters.ResponseData) (*adapters.BidderResponse, []error) {
+	switch response.StatusCode {
+	case http.StatusOK:
+		break
+	case http.StatusNoContent:
+		return nil, nil
+	case http.StatusServiceUnavailable:
+		fallthrough
+	case http.StatusBadRequest:
+		fallthrough
+	case http.StatusUnauthorized:
+		fallthrough
+	case http.StatusForbidden:
+		err := &errortypes.BadInput{
+			Message: fmt.Sprintf(unexpectedStatusCodeFormat, response.StatusCode),
+		}
+		return nil, []error{err}
+	default:
+		err := &errortypes.BadServerResponse{
+			Message: fmt.Sprintf(unexpectedStatusCodeFormat, response.StatusCode),
+		}
+		return nil, []error{err}
+	}
+
+	var openRTBBidderResponse openrtb2.BidResponse
+	if err := json.Unmarshal(response.Body, &openRTBBidderResponse); err != nil {
+		return nil, []error{err}
+	}
+
+	bidsCapacity := len(internalRequest.Imp)
+	errs := make([]error, 0, bidsCapacity)
+	bidderResponse := adapters.NewBidderResponseWithBidsCapacity(bidsCapacity)
+	var typedBid *adapters.TypedBid
+	for _, seatBid := range openRTBBidderResponse.SeatBid {
+		for _, bid := range seatBid.Bid {
+			activeBid := bid
+			bidType, err := getMediaTypeForImp(activeBid.ImpID, internalRequest.Imp)
+			if err != nil {
+				errs = append(errs, err)
+				continue
+			}
+
+			typedBid = &adapters.TypedBid{Bid: &activeBid, BidType: bidType}
+			bidderResponse.Bids = append(bidderResponse.Bids, typedBid)
+		}
+	}
+
+	return bidderResponse, nil
+}
+
+func getMediaTypeForImp(impID string, imps []openrtb2.Imp) (openrtb_ext.BidType, error) {
+	for _, imp := range imps {
+		if imp.ID == impID {
+			if imp.Native != nil {
+				return openrtb_ext.BidTypeNative, nil
+			} else if imp.Banner != nil {
+				return openrtb_ext.BidTypeBanner, nil
+			} else if imp.Video != nil {
+				return openrtb_ext.BidTypeVideo, nil
+			}
+
+		}
+	}
+
+	return "", &errortypes.BadInput{
+		Message: fmt.Sprintf("Failed to find native/banner/video impression \"%s\" ", impID),
+	}
+}

adapters/adagio/adagio_test.go

@@ -0,0 +1,134 @@
+package adagio
+
+import (
+	"encoding/json"
+	"fmt"
+	"github.com/mxmCherry/openrtb/v15/openrtb2"
+	"github.com/prebid/prebid-server/adapters"
+	"github.com/stretchr/testify/assert"
+	"net/http"
+	"testing"
+
+	"github.com/prebid/prebid-server/adapters/adapterstest"
+	"github.com/prebid/prebid-server/config"
+	"github.com/prebid/prebid-server/openrtb_ext"
+)
+
+func buildFakeBidRequest() openrtb2.BidRequest {
+	imp1 := openrtb2.Imp{
+		ID:     "1",
+		Banner: &openrtb2.Banner{},
+		Ext: json.RawMessage(`{"bidder": {"organizationId": "1000", "site": "test-site"}}`),
+	}
+	imp2 := openrtb2.Imp{
+		ID:    "2",
+		Banner: &openrtb2.Banner{},
+		Video: &openrtb2.Video{},
+		Ext: json.RawMessage(`{"bidder": {"organizationId": "1000", "site": "test-site"}}`),
+	}
+	imp3 := openrtb2.Imp{
+		ID:     "3",
+		Native: &openrtb2.Native{},
+		Ext: json.RawMessage(`{"bidder": {"organizationId": "1000", "site": "test-site"}}`),
+	}
+
+	fakeBidRequest := openrtb2.BidRequest{
+		ID: "abc-123",
+		Imp: []openrtb2.Imp{imp1, imp2, imp3},
+	}
+
+	return fakeBidRequest
+}
+
+func buildFakeRequestData(t *testing.T, fakeBidRequest openrtb2.BidRequest) adapters.RequestData {
+	imps, err := json.Marshal(fakeBidRequest.Imp)
+	if err != nil {
+		t.Fatalf("Json marshal failed: %v", err)
+	}
+
+	fakeRequestData := adapters.RequestData{
+		Method: "POST",
+		Body: []byte(fmt.Sprintf(`{"imp": %v}`, imps)),
+	}
+
+	return fakeRequestData
+}
+
+func TestJsonSamples(t *testing.T) {
+	bidder, buildErr := Builder(openrtb_ext.BidderAdagio, config.Adapter{
+		Endpoint: "http://localhost/prebid_server"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	adapterstest.RunJSONBidderTest(t, "adagiotest", bidder)
+}
+
+func TestMakeRequests(t *testing.T) {
+	fakeBidRequest := buildFakeBidRequest()
+	fakeBidRequest.Test = 1
+
+	bidder, buildErr := Builder(openrtb_ext.BidderAdagio, config.Adapter{
+		Endpoint: "http://localhost/prebid_server"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	requestData, err := bidder.MakeRequests(&fakeBidRequest, nil)
+
+	assert.Nil(t, err)
+	assert.Equal(t, 1, len(requestData))
+
+	body := &openrtb2.BidRequest{}
+	_ = json.Unmarshal(requestData[0].Body, body)
+
+	assert.Equal(t, 3, len(body.Imp))
+}
+
+func TestAdapter_MakeRequestsGzip(t *testing.T) {
+	fakeBidRequest := buildFakeBidRequest()
+
+	bidder, buildErr := Builder(openrtb_ext.BidderAdagio, config.Adapter{
+		Endpoint: "http://localhost/prebid_server"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	requestData, _ := bidder.MakeRequests(&fakeBidRequest, nil)
+	assert.Equal(t, []string([]string{"gzip"}), requestData[0].Headers["Content-Encoding"])
+}
+
+func TestMakeBids(t *testing.T) {
+	fakeBidRequest := buildFakeBidRequest()
+	fakeRequestData := buildFakeRequestData(t, fakeBidRequest)
+
+	bidder, buildErr := Builder(openrtb_ext.BidderAdagio, config.Adapter{
+		Endpoint: "http://localhost/prebid_server"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	fakeBidResponse := &adapters.ResponseData{}
+
+	fakeBidResponse.StatusCode = http.StatusForbidden
+	_, err := bidder.MakeBids(&fakeBidRequest, &fakeRequestData, fakeBidResponse)
+	assert.NotNil(t, err)
+
+	fakeBidResponse.StatusCode = http.StatusInternalServerError
+	_, err = bidder.MakeBids(&fakeBidRequest, &fakeRequestData, fakeBidResponse)
+	assert.NotNil(t, err)
+
+	fakeBidResponse.StatusCode = http.StatusOK
+	fakeBidResponse.Body = []byte(`"imp": 1`)
+	_, err = bidder.MakeBids(&fakeBidRequest, &fakeRequestData, fakeBidResponse)
+	assert.NotNil(t, err)
+
+	fakeBidResponse.Body = []byte(`{"id": "abc", "seatbid": [{"bid": [{"id": "internal-id", "impid": "1", "banner": {}}]}]}`)
+	re, err := bidder.MakeBids(&fakeBidRequest, &fakeRequestData, fakeBidResponse)
+	assert.Equal(t, 1, len(re.Bids))
+
+}