New Adapter Initialization Framework

adapters/33across/33across.go

@@ -7,6 +7,7 @@ import (
 
 	"github.com/mxmCherry/openrtb"
 	"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"
 )
@@ -219,9 +220,10 @@ func getBidType(ext bidExt) openrtb_ext.BidType {
 	return openrtb_ext.BidTypeBanner
 }
 
-// New33AcrossBidder configures bidder endpoint
-func New33AcrossBidder(endpoint string) *TtxAdapter {
-	return &TtxAdapter{
-		endpoint: endpoint,
+// Builder builds a new instance of the 33Across adapter for the given bidder with the given config.
+func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error) {
+	bidder := &TtxAdapter{
+		endpoint: config.Endpoint,
 	}
+	return bidder, nil
 }

adapters/33across/33across_test.go

@@ -4,8 +4,17 @@ import (
 	"testing"
 
 	"github.com/prebid/prebid-server/adapters/adapterstest"
+	"github.com/prebid/prebid-server/config"
+	"github.com/prebid/prebid-server/openrtb_ext"
 )
 
 func TestJsonSamples(t *testing.T) {
-	adapterstest.RunJSONBidderTest(t, "33acrosstest", New33AcrossBidder("http://ssc.33across.com"))
+	bidder, buildErr := Builder(openrtb_ext.Bidder33Across, config.Adapter{
+		Endpoint: "http://ssc.33across.com"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	adapterstest.RunJSONBidderTest(t, "33acrosstest", bidder)
 }

adapters/acuityads/acuityads.go

@@ -6,9 +6,9 @@ import (
 	"net/http"
 	"text/template"
 
-	"github.com/golang/glog"
 	"github.com/mxmCherry/openrtb"
 	"github.com/prebid/prebid-server/adapters"
+	"github.com/prebid/prebid-server/config"
 	"github.com/prebid/prebid-server/errortypes"
 	"github.com/prebid/prebid-server/macros"
 	"github.com/prebid/prebid-server/openrtb_ext"
@@ -18,13 +18,17 @@ type AcuityAdsAdapter struct {
 	endpoint template.Template
 }
 
-func NewAcuityAdsBidder(endpointTemplate string) *AcuityAdsAdapter {
-	template, err := template.New("endpointTemplate").Parse(endpointTemplate)
+// Builder builds a new instance of the AcuityAds adapter for the given bidder with the given config.
+func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error) {
+	template, err := template.New("endpointTemplate").Parse(config.Endpoint)
 	if err != nil {
-		glog.Fatal("Unable to parse endpoint url template")
-		return nil
+		return nil, fmt.Errorf("unable to parse endpoint url template: %v", err)
+	}
+
+	bidder := &AcuityAdsAdapter{
+		endpoint: *template,
 	}
-	return &AcuityAdsAdapter{endpoint: *template}
+	return bidder, nil
 }
 
 func getHeaders(request *openrtb.BidRequest) http.Header {

adapters/acuityads/acuityads_test.go

@@ -4,8 +4,25 @@ import (
 	"testing"
 
 	"github.com/prebid/prebid-server/adapters/adapterstest"
+	"github.com/prebid/prebid-server/config"
+	"github.com/prebid/prebid-server/openrtb_ext"
+	"github.com/stretchr/testify/assert"
 )
 
 func TestJsonSamples(t *testing.T) {
-	adapterstest.RunJSONBidderTest(t, "acuityadstest", NewAcuityAdsBidder("http://{{.Host}}.example.com/bid?token={{.AccountID}}"))
+	bidder, buildErr := Builder(openrtb_ext.BidderAcuityAds, config.Adapter{
+		Endpoint: "http://{{.Host}}.example.com/bid?token={{.AccountID}}"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	adapterstest.RunJSONBidderTest(t, "acuityadstest", bidder)
+}
+
+func TestEndpointTemplateMalformed(t *testing.T) {
+	_, buildErr := Builder(openrtb_ext.BidderAcuityAds, config.Adapter{
+		Endpoint: "{{Malformed}}"})
+
+	assert.Error(t, buildErr)
 }

adapters/adform/adform.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"encoding/base64"
 	"encoding/json"
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"net/http"
@@ -13,6 +14,7 @@ import (
 	"strings"
 
 	"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"
 	"github.com/prebid/prebid-server/pbs"
@@ -22,6 +24,8 @@ import (
 	"golang.org/x/net/context/ctxhttp"
 )
 
+const version = "0.1.3"
+
 type AdformAdapter struct {
 	http    *adapters.HTTPAdapter
 	URL     *url.URL
@@ -95,8 +99,18 @@ func isPriceTypeValid(priceType string) (string, bool) {
 
 // ADAPTER Interface
 
-func NewAdformAdapter(config *adapters.HTTPAdapterConfig, endpointURL string) *AdformAdapter {
-	return NewAdformBidder(adapters.NewHTTPAdapter(config).Client, endpointURL)
+// Builder builds a new instance of the Adform adapter for the given bidder with the given config.
+func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error) {
+	uri, err := url.Parse(config.Endpoint)
+	if err != nil {
+		return nil, errors.New("unable to parse endpoint")
+	}
+
+	bidder := &AdformAdapter{
+		URL:     uri,
+		version: version,
+	}
+	return bidder, nil
 }
 
 // used for cookies and such
@@ -386,18 +400,17 @@ func parseAdformBids(response []byte) ([]*adformBid, error) {
 
 // BIDDER Interface
 
-func NewAdformBidder(client *http.Client, endpointURL string) *AdformAdapter {
-	a := &adapters.HTTPAdapter{Client: client}
+func NewAdformLegacyAdapter(httpConfig *adapters.HTTPAdapterConfig, endpointURL string) *AdformAdapter {
 	var uriObj *url.URL
 	uriObj, err := url.Parse(endpointURL)
 	if err != nil {
 		panic(fmt.Sprintf("Incorrect Adform request url %s, check the configuration, please.", endpointURL))
 	}
 
 	return &AdformAdapter{
-		http:    a,
+		http:    adapters.NewHTTPAdapter(httpConfig),
 		URL:     uriObj,
-		version: "0.1.3",
+		version: version,
 	}
 }
 

adapters/adform/adform_test.go

@@ -26,7 +26,21 @@ import (
 )
 
 func TestJsonSamples(t *testing.T) {
-	adapterstest.RunJSONBidderTest(t, "adformtest", NewAdformBidder(nil, "http://adx.adform.net/adx"))
+	bidder, buildErr := Builder(openrtb_ext.BidderAdform, config.Adapter{
+		Endpoint: "http://adx.adform.net/adx"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	adapterstest.RunJSONBidderTest(t, "adformtest", bidder)
+}
+
+func TestEndpointMalformed(t *testing.T) {
+	_, buildErr := Builder(openrtb_ext.BidderAdform, config.Adapter{
+		Endpoint: ` https://malformed`})
+
+	assert.Error(t, buildErr)
 }
 
 type aTagInfo struct {
@@ -193,7 +207,7 @@ func initTestData(server *httptest.Server, t *testing.T) (*AdformAdapter, contex
 
 	// prepare adapter
 	conf := *adapters.DefaultHTTPAdapterConfig
-	adapter := NewAdformAdapter(&conf, server.URL)
+	adapter := NewAdformLegacyAdapter(&conf, server.URL)
 
 	prebidRequest := preparePrebidRequest(server.URL, t)
 	ctx := context.TODO()
@@ -285,7 +299,12 @@ func preparePrebidRequestBody(requestData aBidInfo, t *testing.T) *bytes.Buffer
 // OpenRTB auction tests
 
 func TestOpenRTBRequest(t *testing.T) {
-	bidder := NewAdformBidder(nil, "http://adx.adform.net")
+	bidder, buildErr := Builder(openrtb_ext.BidderAdform, config.Adapter{
+		Endpoint: "http://adx.adform.net"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
 
 	testData := createTestData(true)
 	request := createOpenRtbRequest(&testData)
@@ -483,7 +502,7 @@ func TestOpenRTBSurpriseResponse(t *testing.T) {
 // Properties tests
 
 func TestAdformProperties(t *testing.T) {
-	adapter := NewAdformAdapter(adapters.DefaultHTTPAdapterConfig, "adx.adform.net/adx")
+	adapter := NewAdformLegacyAdapter(adapters.DefaultHTTPAdapterConfig, "adx.adform.net/adx")
 
 	if adapter.SkipNoCookies() != false {
 		t.Fatalf("should have been false")

adapters/adgeneration/adgeneration.go

@@ -12,6 +12,7 @@ import (
 
 	"github.com/mxmCherry/openrtb"
 	"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"
 )
@@ -258,10 +259,12 @@ func removeWrapper(ad string) string {
 	return str
 }
 
-func NewAdgenerationAdapter(endpoint string) *AdgenerationAdapter {
-	return &AdgenerationAdapter{
-		endpoint,
+// Builder builds a new instance of the Adgeneration adapter for the given bidder with the given config.
+func Builder(bidderName openrtb_ext.BidderName, config config.Adapter) (adapters.Bidder, error) {
+	bidder := &AdgenerationAdapter{
+		config.Endpoint,
 		"1.0.2",
 		"JPY",
 	}
+	return bidder, nil
 }

adapters/adgeneration/adgeneration_test.go

@@ -7,15 +7,32 @@ import (
 	"github.com/mxmCherry/openrtb"
 	"github.com/prebid/prebid-server/adapters"
 	"github.com/prebid/prebid-server/adapters/adapterstest"
+	"github.com/prebid/prebid-server/config"
+	"github.com/prebid/prebid-server/openrtb_ext"
 	"github.com/stretchr/testify/assert"
 )
 
 func TestJsonSamples(t *testing.T) {
-	adapterstest.RunJSONBidderTest(t, "adgenerationtest", NewAdgenerationAdapter("https://d.socdm.com/adsv/v1"))
+	bidder, buildErr := Builder(openrtb_ext.BidderAdgeneration, config.Adapter{
+		Endpoint: "https://d.socdm.com/adsv/v1"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	adapterstest.RunJSONBidderTest(t, "adgenerationtest", bidder)
 }
 
-func TestGetRequestUri(t *testing.T) {
-	bidder := NewAdgenerationAdapter("https://d.socdm.com/adsv/v1")
+func TestgetRequestUri(t *testing.T) {
+	bidder, buildErr := Builder(openrtb_ext.BidderAdgeneration, config.Adapter{
+		Endpoint: "https://d.socdm.com/adsv/v1"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	bidderAdgeneration, _ := bidder.(*AdgenerationAdapter)
+
 	// Test items
 	failedRequest := &openrtb.BidRequest{
 		ID: "test-failed-bid-request",
@@ -42,7 +59,7 @@ func TestGetRequestUri(t *testing.T) {
 
 	numRequests := len(failedRequest.Imp)
 	for index := 0; index < numRequests; index++ {
-		httpRequests, err := bidder.getRequestUri(failedRequest, index)
+		httpRequests, err := bidderAdgeneration.getRequestUri(failedRequest, index)
 		if err == nil {
 			t.Errorf("getRequestUri: %v did not throw an error", failedRequest.Imp[index])
 		}
@@ -57,15 +74,15 @@ func TestGetRequestUri(t *testing.T) {
 		if err != nil {
 			t.Errorf("unmarshalExtImpAdgeneration: %v did throw an error: %v", successRequest.Imp[index], err)
 		}
-		rawQuery := bidder.getRawQuery(adgExt.Id, successRequest, &successRequest.Imp[index])
+		rawQuery := bidderAdgeneration.getRawQuery(adgExt.Id, successRequest, &successRequest.Imp[index])
 		expectQueries := map[string]string{
 			"posall":        "SSPLOC",
 			"id":            adgExt.Id,
 			"sdktype":       "0",
 			"hb":            "true",
-			"currency":      bidder.getCurrency(successRequest),
+			"currency":      bidderAdgeneration.getCurrency(successRequest),
 			"sdkname":       "prebidserver",
-			"adapterver":    bidder.version,
+			"adapterver":    bidderAdgeneration.version,
 			"sizes":         getSizes(&successRequest.Imp[index]),
 			"tp":            successRequest.Site.Page,
 			"transactionid": successRequest.Source.TID,
@@ -78,11 +95,11 @@ func TestGetRequestUri(t *testing.T) {
 		}
 
 		// RequestUri Test.
-		actualUri, err := bidder.getRequestUri(successRequest, index)
+		actualUri, err := bidderAdgeneration.getRequestUri(successRequest, index)
 		if err != nil {
 			t.Errorf("getRequestUri: %v did throw an error: %v", successRequest.Imp[index], err)
 		}
-		expectedUri := "https://d.socdm.com/adsv/v1?adapterver=" + bidder.version + "&currency=JPY&hb=true&id=58278&posall=SSPLOC&sdkname=prebidserver&sdktype=0&sizes=300x250&t=json3&tp=https%3A%2F%2Fsupership.com&transactionid=SourceTID"
+		expectedUri := "https://d.socdm.com/adsv/v1?adapterver=" + bidderAdgeneration.version + "&currency=JPY&hb=true&id=58278&posall=SSPLOC&sdkname=prebidserver&sdktype=0&sizes=300x250&t=json3&tp=https%3A%2F%2Fsupership.com&transactionid=SourceTID"
 		if actualUri != expectedUri {
 			t.Errorf("getRequestUri: does not match expected %s, actual %s", expectedUri, actualUri)
 		}
@@ -115,20 +132,28 @@ func TestGetSizes(t *testing.T) {
 }
 
 func TestGetCurrency(t *testing.T) {
-	bidder := NewAdgenerationAdapter("https://d.socdm.com/adsv/v1")
+	bidder, buildErr := Builder(openrtb_ext.BidderAdgeneration, config.Adapter{
+		Endpoint: "https://d.socdm.com/adsv/v1"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	bidderAdgeneration, _ := bidder.(*AdgenerationAdapter)
+
 	// Test items
 	var request *openrtb.BidRequest
 	var currency string
 	innerDefaultCur := []string{"USD", "JPY"}
 	usdCur := []string{"USD", "EUR"}
 
 	request = &openrtb.BidRequest{Cur: innerDefaultCur}
-	currency = bidder.getCurrency(request)
+	currency = bidderAdgeneration.getCurrency(request)
 	if currency != "JPY" {
 		t.Errorf("%v does not match currency.", innerDefaultCur)
 	}
 	request = &openrtb.BidRequest{Cur: usdCur}
-	currency = bidder.getCurrency(request)
+	currency = bidderAdgeneration.getCurrency(request)
 	if currency != "USD" {
 		t.Errorf("%v does not match currency.", usdCur)
 	}
@@ -178,7 +203,15 @@ func TestCreateAd(t *testing.T) {
 }
 
 func TestMakeBids(t *testing.T) {
-	bidder := NewAdgenerationAdapter("https://d.socdm.com/adsv/v1")
+	bidder, buildErr := Builder(openrtb_ext.BidderAdgeneration, config.Adapter{
+		Endpoint: "https://d.socdm.com/adsv/v1"})
+
+	if buildErr != nil {
+		t.Fatalf("Builder returned unexpected error %v", buildErr)
+	}
+
+	bidderAdgeneration, _ := bidder.(*AdgenerationAdapter)
+
 	internalRequest := &openrtb.BidRequest{
 		ID: "test-success-bid-request",
 		Imp: []openrtb.Imp{
@@ -198,7 +231,7 @@ func TestMakeBids(t *testing.T) {
 	if len(errs) > 0 {
 		t.Errorf("MakeBids return errors. errors: %v", errs)
 	}
-	checkBidResponse(t, defaultCurBidderResponse, bidder.defaultCurrency)
+	checkBidResponse(t, defaultCurBidderResponse, bidderAdgeneration.defaultCurrency)
 
 	// Specified Currency InternalRequest
 	usdCur := "USD"