added response, validates and test

Author: Eggya Chiquita

openrtb.go

@@ -72,6 +72,54 @@ type Request struct {
 	Ext     Extensions
 }
 
+// ID and at least one “seatbid” object is required, which contains a bid on at least one impression.
+// Other attributes are optional since an exchange may establish default values.
+// No-Bids on all impressions should be indicated as a HTTP 204 response.
+// For no-bids on specific impressions, the bidder should omit these from the bid response.
+type Response struct {
+	Id         *string    `json:"id"`                   // Reflection of the bid request ID for logging purposes
+	Seatbid    []Seatbid  `json:"seatbid"`              // Array of seatbid objects
+	Bidid      *string    `json:"bidid,omitempty"`      // Optional response tracking ID for bidders
+	Cur        *string    `json:"cur,omitempty"`        // Bid currency
+	Customdata *string    `json:"customdata,omitempty"` // Encoded user features
+	Ext        Extensions `json:"ext,omitempty"`        // Custom specifications in Json
+}
+
+// At least one of Bid is required.
+// A bid response can contain multiple “seatbid” objects, each on behalf of a different bidder seat.
+// Seatbid object can contain multiple bids each pertaining to a different impression on behalf of a seat.
+// Each “bid” object must include the impression ID to which it pertains as well as the bid price.
+// Group attribute can be used to specify if a seat is willing to accept any impressions that it can win (default) or if it is
+// only interested in winning any if it can win them all (i.e., all or nothing).
+type Seatbid struct {
+	Bid   []Bid      `json:"id"`             // Array of bid objects; each realtes to an imp, if exchange supported can have many bid objects.
+	Seat  *string    `json:"seat,omiempty"`  // ID of the bidder seat optional string ID of the bidder seat on whose behalf this bid is made.
+	Group *int       `json:"group,omiempty"` // '1' means impression must be won-lost as a group; default is '0'.
+	Ext   Extensions `json:"ext,omiempty"`
+}
+
+// ID, Impid and Price are required; all other optional.
+// If the bidder wins the impression, the exchange calls notice URL (nurl)
+// a) to inform the bidder of the win;
+// b) to convey certain information using substitution macros.
+// Adomain can be used to check advertiser block list compliance.
+// Cid can be used to block ads that were previously identified as inappropriate.
+// Substitution macros may allow a bidder to use a static notice URL for all of its bids.
+type Bid struct {
+	Id      *string    `json:"id"`
+	Impid   *string    `json:"impid"`             // Required string ID of the impression object to which this bid applies.
+	Price   *float32   `json:"price"`             // Bid price in CPM. Suggests using integer math for accounting to avoid rounding errors.
+	Adid    *string    `json:"adid,omitempty"`    // References the ad to be served if the bid wins.
+	Nurl    *string    `json:"nurl,omitempty"`    // Win notice URL.
+	Adm     *string    `json:"adm,omitempty"`     // Actual ad markup. XHTML if a response to a banner object, or VAST XML if a response to a video object.
+	Adomain []string   `json:"adomain,omitempty"` // Advertiser’s primary or top-level domain for advertiser checking; or multiple if imp rotating.
+	Iurl    *string    `json:"iurl,omitempty"`    // Sample image URL.
+	Cid     *string    `json:"cid,omitempty"`     // Campaign ID that appears with the Ad markup.
+	Crid    *string    `json:"crid,omitempty"`    // Creative ID for reporting content issues or defects. This could also be used as a reference to a creative ID that is posted with an exchange.
+	Attr    []int      `json:"attr,omitempty"`    // Array of creative attributes.
+	Ext     Extensions `json:"ext,omitempty"`
+}
+
 // The "imp" object describes the ad position or impression being auctioned.  A single bid request
 // can include multiple "imp" objects, a use case for which might be an exchange that supports
 // selling all ad positions on a given page as a bundle.  Each "imp" object has a required ID so that

parser.go request.goparser.go renamed to request.go

@@ -8,7 +8,7 @@ import (
 
 var (
 	errValidationReqId            = errors.New("openrtb parse: request ID missing")
-	errValidationImp              = errors.New("openrtb parse: no impressions")
+	errValidationReqImp           = errors.New("openrtb parse: no impressions")
 	errValidationReqSaA           = errors.New("openrtb parse: request has site and app")
 	errValidationImpId            = errors.New("openrtb parse: impression ID missing")
 	errValidationImpBoV           = errors.New("openrtb parse: impression has neither a banner nor video")
@@ -57,7 +57,7 @@ func validateReq(req *Request) error {
 	if req.Id == nil {
 		return errValidationReqId
 	} else if len(req.Imp) == 0 {
-		return errValidationImp
+		return errValidationReqImp
 	} else if req.Site != nil && req.App != nil {
 		return errValidationReqSaA
 	} else if req.Site != nil {

parser_test.go request_test.goparser_test.go renamed to request_test.go

@@ -0,0 +1,103 @@
+package openrtb
+
+import (
+	"encoding/json"
+	"errors"
+)
+
+var (
+	errValidationResId      = errors.New("openrtb response: missing ID")
+	errValidationResSeatbid = errors.New("openrtb response: missing seatbids")
+	errValidationSeatbidBid = errors.New("openrtb response: seatbid is missing bids")
+	errValidationBidId      = errors.New("openrtb response: bid is missing ID")
+	errValidationBidImpid   = errors.New("openrtb response: bid is missing impression ID")
+	errValidationBidPrice   = errors.New("openrtb response: bid is missing price")
+)
+
+// Response object to_json
+// @return [Json,Error]
+func (res *Response) JSON() ([]byte, error) {
+	return json.Marshal(res)
+}
+
+// Validate Response required attributes
+// @return [Boolean,Error] true if response,seatbid,bid required attrs present
+func (res *Response) Valid() (bool, error) {
+
+	if res.Id == nil {
+		return false, errValidationResId
+	} else if res.Seatbid == nil || len(res.Seatbid) < 1 {
+		return false, errValidationResSeatbid
+	}
+
+	for _, sb := range res.Seatbid {
+		if ok, err := sb.Valid(); !ok {
+			return ok, err
+		}
+	}
+
+	return true, nil
+}
+
+// Seatbid methods
+
+// Validate Seatbid required attributes
+// @return [Boolean,Error]
+func (sb *Seatbid) Valid() (bool, error) {
+
+	if sb.Bid == nil || len(sb.Bid) < 1 {
+		return false, errValidationSeatbidBid
+	}
+
+	for _, bid := range sb.Bid {
+		if ok, err := bid.Valid(); !ok {
+			return ok, err
+		}
+	}
+
+	return true, nil
+}
+
+// Bid methods
+
+// Validate Bid required attributes
+// @return [Boolean,Error]
+func (bid *Bid) Valid() (bool, error) {
+
+	if bid.Id == nil {
+		return false, errValidationBidId
+	} else if bid.Impid == nil {
+		return false, errValidationBidImpid
+	} else if bid.Price == nil {
+		return false, errValidationBidPrice
+	}
+
+	return true, nil
+}
+
+// Set the ID
+func (bid *Bid) SetID(id string) *Bid {
+	if bid.Id == nil {
+		bid.Id = new(string)
+	}
+	*bid.Id = id
+	return bid
+}
+
+// Set the ImpID
+func (bid *Bid) SetImpID(id string) *Bid {
+	if bid.Impid == nil {
+		bid.Impid = new(string)
+	}
+	*bid.Impid = id
+	return bid
+}
+
+// Set the Price
+func (bid *Bid) SetPrice(p float32) *Bid {
+	if bid.Price == nil {
+		bid.Price = new(float32)
+	}
+	*bid.Price = p
+	return bid
+}

response.go

@@ -0,0 +1,95 @@
+package openrtb
+
+import (
+	"github.com/stretchr/testify/assert"
+	"testing"
+)
+
+func TestResponse_JSON(t *testing.T) {
+	res := &Response{}
+	res.Id = new(string)
+	*res.Id = "RES_ID"
+	res.Cur = new(string)
+	*res.Cur = "USD"
+
+	bytes, err := res.JSON()
+	assert.Nil(t, err)
+	assert.Equal(t, string(bytes), `{"id":"RES_ID","seatbid":null,"cur":"USD"}`)
+}
+
+func TestResponse_Valid(t *testing.T) {
+	res := &Response{}
+
+	ok, err := res.Valid()
+	assert.Equal(t, ok, false)
+	if err != nil {
+		assert.Equal(t, err.Error(), "openrtb response: missing ID")
+	}
+
+	res.Id = new(string)
+	*res.Id = "RES_ID"
+
+	ok, err = res.Valid()
+	assert.Equal(t, ok, false)
+	if err != nil {
+		assert.Equal(t, err.Error(), "openrtb response: missing seatbids")
+	}
+
+	bid := &Bid{}
+	bid.SetID("BIDID").SetImpID("IMPID").SetPrice(0.0)
+
+	sb := &Seatbid{}
+	sb.Bid = append(sb.Bid, *bid)
+
+	res.Seatbid = append(res.Seatbid, *sb)
+
+	ok, err = res.Valid()
+	assert.Equal(t, ok, true)
+	assert.Nil(t, err)
+}
+
+func TestSeatbid_Valid(t *testing.T) {
+	sb := &Seatbid{}
+
+	ok, err := sb.Valid()
+	assert.Equal(t, ok, false)
+	if err != nil {
+		assert.Equal(t, err.Error(), "openrtb response: seatbid is missing bids")
+	}
+
+	bid := &Bid{}
+	bid.SetID("BIDID").SetImpID("IMPID").SetPrice(0.0)
+	sb.Bid = append(sb.Bid, *bid)
+
+	ok, err = sb.Valid()
+	assert.Equal(t, ok, true)
+	assert.Nil(t, err)
+}
+
+func TestBid_Valid(t *testing.T) {
+	bid := &Bid{}
+
+	ok, err := bid.Valid()
+	assert.Equal(t, ok, false)
+	if err != nil {
+		assert.Equal(t, err.Error(), "openrtb response: bid is missing ID")
+	}
+
+	bid.SetID("BIDID")
+	ok, err = bid.Valid()
+	assert.Equal(t, ok, false)
+	if err != nil {
+		assert.Equal(t, err.Error(), "openrtb response: bid is missing impression ID")
+	}
+
+	bid.SetImpID("IMPID")
+	ok, err = bid.Valid()
+	assert.Equal(t, ok, false)
+	if err != nil {
+		assert.Equal(t, err.Error(), "openrtb response: bid is missing price")
+	}
+
+	bid.SetPrice(0.0)
+	ok, err = bid.Valid()
+	assert.Equal(t, ok, true)
+}