Improvements for OpenRTB 2.2

Author: dim

Makefile

@@ -0,0 +1,7 @@
+default: test
+
+deps:
+	go get -t ./...
+
+test: deps
+	go test ./...

app_test.go

@@ -1,23 +1,25 @@
 package openrtb
 
 import (
-	"github.com/stretchr/testify/assert"
-	"testing"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
 )
 
-func TestApp_IsPrivacyPolicy(t *testing.T) {
-	a := &App{}
-	assert.Equal(t, a.IsPrivacyPolicy(), false)
-}
+var _ = Describe("App", func() {
+	var subject *App
 
-func TestApp_IsPaid(t *testing.T) {
-	a := &App{}
-	assert.Equal(t, a.IsPaid(), false)
-}
+	BeforeEach(func() {
+		subject = new(App)
+	})
 
-func TestApp_WithDefaults(t *testing.T) {
-	a := &App{}
-	app := a.WithDefaults()
-	assert.Equal(t, *app.Privacypolicy, 0)
-	assert.Equal(t, *app.Paid, 0)
-}
+	It("should have accessors", func() {
+		Expect(subject.IsPrivacyPolicy()).To(BeFalse())
+		Expect(subject.IsPaid()).To(BeFalse())
+	})
+
+	It("should have defaults", func() {
+		subject.WithDefaults()
+		Expect(*subject.Privacypolicy).To(Equal(0))
+		Expect(*subject.Paid).To(Equal(0))
+	})
+})

banner.go

@@ -9,6 +9,10 @@ package openrtb
 type Banner struct {
 	W        *int       `json:"w,omitempty"`        // Width
 	H        *int       `json:"h,omitempty"`        // Height
+	Wmax     *int       `json:"wmax,omitempty"`     // Width maximum
+	Hmax     *int       `json:"hmax,omitempty"`     // Height maximum
+	Wmin     *int       `json:"wmax,omitempty"`     // Width minimum
+	Hmin     *int       `json:"hmax,omitempty"`     // Height minimum
 	Id       *string    `json:"id,omitempty"`       // A unique identifier
 	Pos      *int       `json:"pos,omitempty"`      // Ad Position
 	Btype    []int      `json:"btype,omitempty"`    // Blocked creative types

banner_test.go

@@ -1,23 +1,25 @@
 package openrtb
 
 import (
-	"github.com/stretchr/testify/assert"
-	"testing"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
 )
 
-func TestBanner_IsTopFrame(t *testing.T) {
-	b := &Banner{}
-	assert.Equal(t, b.IsTopFrame(), false)
-}
+var _ = Describe("Banner", func() {
+	var subject *Banner
 
-func TestBanner_Position(t *testing.T) {
-	b := &Banner{}
-	assert.Equal(t, b.Position(), 0)
-}
+	BeforeEach(func() {
+		subject = new(Banner)
+	})
 
-func TestBanner_WithDefaults(t *testing.T) {
-	b := &Banner{}
-	banner := b.WithDefaults()
-	assert.Equal(t, *banner.Topframe, 0)
-	assert.Equal(t, *banner.Pos, AD_POS_UNKNOWN)
-}
+	It("should have accessors", func() {
+		Expect(subject.IsTopFrame()).To(BeFalse())
+		Expect(subject.Position()).To(Equal(0))
+	})
+
+	It("should have defaults", func() {
+		subject.WithDefaults()
+		Expect(*subject.Topframe).To(Equal(0))
+		Expect(*subject.Pos).To(Equal(AD_POS_UNKNOWN))
+	})
+})

bid.go

@@ -29,20 +29,20 @@ type Bid struct {
 
 // Validation errors
 var (
-	invalidBidId    = errors.New("openrtb response: bid is missing ID")
-	invalidBidImpid = errors.New("openrtb response: bid is missing impression ID")
-	invalidBidPrice = errors.New("openrtb response: bid is missing price")
+	ErrInvalidBidID    = errors.New("openrtb response: bid is missing ID")
+	ErrInvalidBidImpID = errors.New("openrtb response: bid is missing impression ID")
+	ErrInvalidBidPrice = errors.New("openrtb response: bid is missing price")
 )
 
 // Validate Bid required attributes
 func (bid *Bid) Valid() (bool, error) {
 
 	if bid.Id == nil {
-		return false, invalidBidId
+		return false, ErrInvalidBidID
 	} else if bid.Impid == nil {
-		return false, invalidBidImpid
+		return false, ErrInvalidBidImpID
 	} else if bid.Price == nil {
-		return false, invalidBidPrice
+		return false, ErrInvalidBidPrice
 	}
 
 	return true, nil

bid_test.go

@@ -1,34 +1,29 @@
 package openrtb
 
 import (
-	"github.com/stretchr/testify/assert"
-	"testing"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
 )
 
-func TestBid_Valid(t *testing.T) {
-	bid := &Bid{}
+var _ = Describe("Bid", func() {
+	var subject *Bid
 
-	ok, err := bid.Valid()
-	assert.Equal(t, ok, false)
-	if err != nil {
-		assert.Equal(t, err.Error(), "openrtb response: bid is missing ID")
-	}
+	BeforeEach(func() {
+		subject = new(Bid)
+	})
 
-	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")
-	}
+	It("should have validation", func() {
+		ok, err := subject.Valid()
+		Expect(err).To(HaveOccurred())
+		Expect(ok).To(BeFalse())
 
-	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")
-	}
+		subject.SetID("BIDID")
+		subject.SetImpID("IMPID")
+		subject.SetPrice(0.0)
 
-	bid.SetPrice(0.0)
-	ok, err = bid.Valid()
-	assert.Equal(t, ok, true)
-}
+		ok, err = subject.Valid()
+		Expect(err).NotTo(HaveOccurred())
+		Expect(ok).To(BeTrue())
+	})
+
+})

device.go

@@ -12,6 +12,8 @@ type Device struct {
 	Didmd5         *string    `json:"didmd5,omitempty"`   // MD5 hashed device ID
 	Dpidsha1       *string    `json:"dpidsha1,omitempty"` // SHA1 hashed platform device ID
 	Dpidmd5        *string    `json:"dpidmd5,omitempty"`  // MD5 hashed platform device ID
+	Macsha1        *string    `json:"macsha1,omitempty"`  // SHA1 hashed device ID; IMEI when available, else MEID or ESN
+	Macmd5         *string    `json:"macmd5,omitempty"`   // MD5 hashed device ID; IMEI when available, else MEID or ESN
 	Ipv6           *string    `json:"ipv6,omitempty"`     // IPv6
 	Carrier        *string    `json:"carrier,omitempty"`  // Carrier or ISP derived from the IP address
 	Language       *string    `json:"language,omitempty"` // Browser language
@@ -23,6 +25,7 @@ type Device struct {
 	Connectiontype *int       `json:"connectiontype,omitempty"`
 	Devicetype     *int       `json:"devicetype,omitempty"`
 	Flashver       *string    `json:"flashver,omitempty"` // Flash version
+	Ifa            *string    `json:"ifa,omitempty"`      // Native identifier for advertisers
 	Ext            Extensions `json:"ext,omitempty"`
 }
 

device_test.go

@@ -1,36 +1,29 @@
 package openrtb
 
 import (
-	"github.com/stretchr/testify/assert"
-	"testing"
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
 )
 
-func TestDevice_IsDnt(t *testing.T) {
-	d := &Device{}
-	assert.Equal(t, d.IsDnt(), false)
-}
+var _ = Describe("Device", func() {
+	var subject *Device
 
-func TestDevice_IsJs(t *testing.T) {
-	d := &Device{}
-	assert.Equal(t, d.IsJs(), false)
-}
+	BeforeEach(func() {
+		subject = new(Device)
+	})
 
-func TestDevice_ConnectionType(t *testing.T) {
-	d := &Device{}
-	assert.Equal(t, d.ConnectionType(), 0)
-}
+	It("should have accessors", func() {
+		Expect(subject.IsDnt()).To(BeFalse())
+		Expect(subject.IsJs()).To(BeFalse())
+		Expect(subject.ConnectionType()).To(Equal(0))
+		Expect(subject.DeviceType()).To(Equal(0))
+	})
 
-func TestDevice_DeviceType(t *testing.T) {
-	d := &Device{}
-	assert.Equal(t, d.DeviceType(), 0)
-}
-
-func TestDevice_WithDefaults(t *testing.T) {
-	d := &Device{}
-	device := d.WithDefaults()
-
-	assert.Equal(t, *device.Dnt, 0)
-	assert.Equal(t, *device.Js, 0)
-	assert.Equal(t, *device.Connectiontype, CONN_TYPE_UNKNOWN)
-	assert.Equal(t, *device.Devicetype, DEVICE_TYPE_UNKNOWN)
-}
+	It("should have defaults", func() {
+		subject.WithDefaults()
+		Expect(*subject.Dnt).To(Equal(0))
+		Expect(*subject.Js).To(Equal(0))
+		Expect(*subject.Connectiontype).To(Equal(CONN_TYPE_UNKNOWN))
+		Expect(*subject.Connectiontype).To(Equal(DEVICE_TYPE_UNKNOWN))
+	})
+})

impression.go

@@ -19,30 +19,32 @@ type Impression struct {
 	Tagid             *string    `json:"tagid,omitempty"`             // Identifier for specific ad placement or ad tag
 	Bidfloor          *float32   `json:"bidfloor,omitempty"`          // Bid floor for this impression in CPM
 	Bidfloorcur       *string    `json:"bidfloorcur,omitempty"`       // Currency of bid floor
+	Secure            *int       `json:"secure,omitempty"`            // Flag to indicate whether the impression requires secure HTTPS URL creative assets and markup.
 	Iframebuster      []string   `json:"iframebuster,omitempty"`      // Array of names for supportediframe busters.
+	Pmp               *Pmp       `json:"pmp,omitempty"`               // A reference to the PMP object containing any Deals eligible for the impression object.
 	Ext               Extensions `json:"ext,omitempty"`
 }
 
 // Validation errors
 var (
-	invalidImpId  = errors.New("openrtb parse: impression ID missing")
-	invalidImpBoV = errors.New("openrtb parse: impression has neither a banner nor video")
-	invalidImpBaV = errors.New("openrtb parse: impression has banner and video")
+	ErrInvalidImpID  = errors.New("openrtb parse: impression ID missing")
+	ErrInvalidImpBoV = errors.New("openrtb parse: impression has neither a banner nor video")
+	ErrInvalidImpBaV = errors.New("openrtb parse: impression has banner and video")
 )
 
 // Validates the `imp` object
 func (imp *Impression) Valid() (bool, error) {
 
 	if imp.Id == nil {
-		return false, invalidImpId
+		return false, ErrInvalidImpID
 	} else if imp.Banner != nil && imp.Video != nil {
-		return false, invalidImpBaV
+		return false, ErrInvalidImpBaV
 	} else if imp.Video != nil {
 		if ok, err := imp.Video.Valid(); !ok {
 			return ok, err
 		}
 	} else if imp.Banner == nil {
-		return false, invalidImpBoV
+		return false, ErrInvalidImpBoV
 	}
 
 	return true, nil
@@ -86,19 +88,13 @@ func (imp *Impression) SetId(id string) *Impression {
 }
 
 // Set the Banner
-func (imp *Impression) SetBanner(b Banner) *Impression {
-	if imp.Banner == nil {
-		imp.Banner = new(Banner)
-	}
-	*imp.Banner = b
+func (imp *Impression) SetBanner(b *Banner) *Impression {
+	imp.Banner = b
 	return imp
 }
 
 // Set the Video
-func (imp *Impression) SetVideo(v Video) *Impression {
-	if imp.Video == nil {
-		imp.Video = new(Video)
-	}
-	*imp.Video = v
+func (imp *Impression) SetVideo(v *Video) *Impression {
+	imp.Video = v
 	return imp
 }