Merge pull request #6 from applift/2_3

Add Native support from OpenRTB 2.3 specifications

Author: dim

README.md

@@ -1,4 +1,4 @@
-# Go OpenRTB 2.2 
+# Go OpenRTB 2.3
 
 [![Build Status](https://travis-ci.org/bsm/openrtb.svg?branch=master)](https://travis-ci.org/bsm/openrtb)
 

asset.go

@@ -0,0 +1,44 @@
+package openrtb
+
+// TODO: Add description, use cases and other details
+type Asset struct {
+	Id       *int         `json:"id"`                 // Unique asset ID, assigned by exchange
+	Required *int         `json:"required,omitempty"` // Set to 1 if asset is required
+	Title    *Title       `json:"title,omitempty"`    // Title object for title assets
+	Img      *Image       `json:"img,omitempty"`      // Image object for image assets
+	Video    *NativeVideo `json:"video,omitempty"`    // Video object for video assets
+	Data     *NativeData  `json:"data,omitempty"`     // Data object for ratings, price, etc.
+	Ext      Extensions   `json:"ext,omitempty"`
+}
+
+type Title struct {
+	Len *int       `json:"len"` // Maximum length of the text in the title element
+	Ext Extensions `json:"ext,omitempty"`
+}
+
+type Image struct {
+	Type  *int       `json:"type,omitempty"`  // Type ID of the image element supported by the publisher
+	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:"wmin,omitempty"`  // Width minimum
+	Hmin  *int       `json:"hmin,omitempty"`  // Height minimum
+	Mimes []string   `json:"mimes,omitempty"` // Whitelist of content MIME types supported
+	Ext   Extensions `json:"ext,omitempty"`
+}
+
+type NativeData struct {
+	Type *int       `json:"type"`          // Type ID of the image element supported by the publisher
+	Len  *int       `json:"len,omitempty"` // Maximum length of the text in the element’s response
+	Ext  Extensions `json:"ext,omitempty"`
+}
+
+// Applies defaults
+func (a *Asset) WithDefaults() *Asset {
+	if a.Required == nil {
+		a.Required = new(int)
+		*a.Required = 0
+	}
+	return a
+}

asset_test.go

@@ -0,0 +1,19 @@
+package openrtb
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Asset", func() {
+	var subject *Asset
+
+	BeforeEach(func() {
+		subject = new(Asset)
+	})
+
+	It("should have defaults", func() {
+		subject.WithDefaults()
+		Expect(*subject.Required).To(Equal(0))
+	})
+})

fixtures_test.go

@@ -1,9 +1,19 @@
 package openrtb
 
+var sptr = func(s string) *string { return &s }
+var iptr = func(i int) *int { return &i }
+
 var testFixtures = struct {
-	simpleBanner       []byte
-	expandableCreative []byte
-	simpleResponse     []byte
+	simpleBanner         []byte
+	expandableCreative   []byte
+	simpleResponse       []byte
+	simpleNativeResponse []byte
+	simpleLink           Link
+	simpleImg            ResponseImg
+	simpleTitle          ResponseTitle
+	simpleData           ResponseData
+	installData          ResponseData
+	fullLink             Link
 }{
 	simpleBanner: []byte(`
 {
@@ -160,4 +170,63 @@ var testFixtures = struct {
     "cur": "USD"
 }
 `),
+	simpleNativeResponse: []byte(`
+{
+    "native": {
+        "ver": "1",
+        "link": {
+            "url": "deeplink://deeplink/url/into/app",
+            "fallback": "http: //i.am.a/URL",
+            "clicktrackers": [
+                "http: //a.com/a",
+                "http: //b.com/b"
+            ]
+        },
+        "imptrackers": [
+            "http: //a.com/a",
+            "http: //b.com/b"
+        ],
+        "assets": [
+            {
+                "id": 1,
+                "title": {
+                    "text": "InstallBOA"
+                },
+                "link": {
+                    "url": "http: //i.am.a/URL"
+                }
+            },
+            {
+                "id": 2,
+                "data": {
+                    "value": "5"
+                }
+            },
+            {
+                "id": 3,
+                "img": {
+                    "url": "http: //cdn.mobad.com/ad.png",
+                    "w": 64,
+                    "h": 64
+                }
+            },
+            {
+                "id": 4,
+                "data": {
+                    "value": "Install"
+                },
+                "link": {
+                    "url": "http: //i.am.a/URL"
+                }
+            }
+        ]
+    }
+}
+`),
+	simpleLink:  Link{Url: sptr("http: //i.am.a/URL")},
+	simpleImg:   ResponseImg{Url: sptr("http: //cdn.mobad.com/ad.png"), W: iptr(64), H: iptr(64)},
+	simpleTitle: ResponseTitle{Text: sptr("InstallBOA")},
+	simpleData:  ResponseData{Value: sptr("5")},
+	installData: ResponseData{Value: sptr("Install")},
+	fullLink:    Link{Url: sptr("deeplink://deeplink/url/into/app"), Clicktrackers: []string{"http: //a.com/a", "http: //b.com/b"}, Fallback: sptr("http: //i.am.a/URL")},
 }

impression.go

@@ -13,6 +13,7 @@ type Impression struct {
 	Id                *string    `json:"id"` // A unique identifier for this impression
 	Banner            *Banner    `json:"banner,omitempty"`
 	Video             *Video     `json:"video,omitempty"`
+	Native            *Native    `json:"native,omitempty"`
 	Displaymanager    *string    `json:"displaymanager,omitempty"`    // Name of ad mediation partner, SDK technology, etc
 	Displaymanagerver *string    `json:"displaymanagerver,omitempty"` // Version of the above
 	Instl             *int       `json:"instl,omitempty"`             // Interstitial, Default: 0 ("1": Interstitial, "0": Something else)

native.go

@@ -0,0 +1,29 @@
+package openrtb
+
+// TODO: Add description, use cases and other details
+type Native struct {
+	Ver      *string    `json:"ver,omitempty"`      // Version of the Native Markup version in use
+	Layout   *int       `json:"layout,omitempty"`   // Layout ID of the native ad unit
+	Adunit   *int       `json:"adunit,omitempty"`   // Ad unit ID of the native ad unit
+	Plcmtcnt *int       `json:"plcmtcnt,omitempty"` // Number of identical placements in this Layout
+	Seq      *int       `json:"seq,omitempty"`      // This is not the sequence number of the content in the stream
+	Assets   []Asset    `json:"assets"`             // Array of Asset Objects
+	Ext      Extensions `json:"ext,omitempty"`
+}
+
+// Applies defaults
+func (n *Native) WithDefaults() *Native {
+	if n.Ver == nil {
+		n.Ver = new(string)
+		*n.Ver = "1"
+	}
+	if n.Plcmtcnt == nil {
+		n.Plcmtcnt = new(int)
+		*n.Plcmtcnt = 1
+	}
+	if n.Seq == nil {
+		n.Seq = new(int)
+		*n.Seq = 0
+	}
+	return n
+}

native_response.go

@@ -0,0 +1,105 @@
+package openrtb
+
+import (
+	"encoding/json"
+	"io"
+)
+
+type NativeAdm struct {
+	Native *NativeResponse
+}
+
+type NativeResponse struct {
+	Ver         *string         `json:"ver,omitempty"` // Version of the Native Markup version in use
+	Assets      []ResponseAsset `json:"assets"`        // Array of Asset Objects
+	Link        *Link           `json:"link"`
+	Imptrackers []string        `json:"imptrackers,omitempty"`
+	Jstracker   *string         `json:"jstracker, omitempty"`
+	Ext         Extensions      `json:"ext,omitempty"`
+}
+
+type ResponseAsset struct {
+	Id       *int           `json:"id"`                 // Unique asset ID, assigned by exchange
+	Required *int           `json:"required,omitempty"` // Set to 1 if asset is required
+	Title    *ResponseTitle `json:"title,omitempty"`    // Title object for title assets
+	Img      *ResponseImg   `json:"img,omitempty"`      // Image object for image assets
+	Video    *ResponseVideo `json:"video,omitempty"`    // Video object for video assets
+	Data     *ResponseData  `json:"data,omitempty"`     // Data object for ratings, price, etc.
+	Link     *Link          `json:"link"`
+	Ext      Extensions     `json:"ext,omitempty"`
+}
+
+type Link struct {
+	Url           *string    `json:"url"`
+	Clicktrackers []string   `json:"clicktrackers,omitempty"`
+	Fallback      *string    `json:"fallback,omitempty"`
+	Ext           Extensions `json:"ext,omitempty"`
+}
+
+type ResponseTitle struct {
+	Text *string    `json:"text"`
+	Ext  Extensions `json:"ext,omitempty"`
+}
+
+type ResponseImg struct {
+	Url *string    `json:"url"`
+	W   *int       `json:"w,omitempty"` // Width
+	H   *int       `json:"h,omitempty"` // Height
+	Ext Extensions `json:"ext,omitempty"`
+}
+
+type ResponseData struct {
+	Label *string    `json:"label,omitempty"`
+	Value *string    `json:"value"`
+	Ext   Extensions `json:"ext,omitempty"`
+}
+
+type ResponseVideo struct {
+	Vasttag *string `json:"vasttag"`
+}
+
+// Set the Asset
+func (nativeResponse *NativeResponse) SetAssets(a *ResponseAsset) *NativeResponse {
+	nativeResponse.Assets = append(nativeResponse.Assets, *a)
+	return nativeResponse
+}
+
+//Parses an OpenRTB Native Response from an io.Reader
+func ParseNativeAdm(reader io.Reader) (adm *NativeAdm, err error) {
+	dec := json.NewDecoder(reader)
+	if err = dec.Decode(&adm); err != nil {
+		return nil, err
+	}
+	adm.Native = adm.Native.WithDefaults()
+	return adm, nil
+}
+
+//Parses an OpenRTB Native Response from bytes
+func ParseNativeAdmBytes(data []byte) (adm *NativeAdm, err error) {
+	if err = json.Unmarshal(data, &adm); err != nil {
+		return nil, err
+	}
+	adm.Native = adm.Native.WithDefaults()
+	return adm, nil
+}
+
+// Applies NativeResponse defaults
+func (resp *NativeResponse) WithDefaults() *NativeResponse {
+	if resp.Ver == nil {
+		resp.Ver = new(string)
+		*resp.Ver = "1"
+	}
+	for id, asset := range resp.Assets {
+		resp.Assets[id] = *asset.WithDefaults()
+	}
+	return resp
+}
+
+// Applies ResponseAsset defaults
+func (asset *ResponseAsset) WithDefaults() *ResponseAsset {
+	if asset.Required == nil {
+		asset.Required = new(int)
+		*asset.Required = 0
+	}
+	return asset
+}

native_response_test.go

@@ -0,0 +1,64 @@
+package openrtb
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("NativeResponse", func() {
+	var sptr = func(s string) *string { return &s }
+	var iptr = func(i int) *int { return &i }
+
+	var subject *NativeResponse
+
+	BeforeEach(func() {
+		subject = new(NativeResponse)
+	})
+
+	It("should have defaults", func() {
+		subject.SetAssets(&ResponseAsset{})
+		subject.WithDefaults()
+
+		Expect(*subject.Ver).To(Equal("1"))
+		Expect(*subject.Assets[0].Required).To(Equal(0))
+	})
+
+	It("should parse native adm", func() {
+		resp, err := ParseNativeAdmBytes(testFixtures.simpleNativeResponse)
+
+		Expect(err).NotTo(HaveOccurred())
+		nativeAdm := NativeAdm{
+			&NativeResponse{
+				Ver: sptr("1"),
+				Assets: []ResponseAsset{
+					ResponseAsset{
+						Id:       iptr(1),
+						Required: iptr(0),
+						Title:    &testFixtures.simpleTitle,
+						Link:     &testFixtures.simpleLink,
+					},
+					ResponseAsset{
+						Id:       iptr(2),
+						Required: iptr(0),
+						Data:     &testFixtures.simpleData,
+					},
+					ResponseAsset{
+						Id:       iptr(3),
+						Required: iptr(0),
+						Img:      &testFixtures.simpleImg,
+					},
+					ResponseAsset{
+						Id:       iptr(4),
+						Required: iptr(0),
+						Data:     &testFixtures.installData,
+						Link:     &testFixtures.simpleLink,
+					},
+				},
+				Link:        &testFixtures.fullLink,
+				Imptrackers: []string{"http: //a.com/a", "http: //b.com/b"},
+			},
+		}
+
+		Expect(resp).To(Equal(&nativeAdm))
+	})
+})

native_test.go

@@ -0,0 +1,21 @@
+package openrtb
+
+import (
+	. "github.com/onsi/ginkgo"
+	. "github.com/onsi/gomega"
+)
+
+var _ = Describe("Native", func() {
+	var subject *Native
+
+	BeforeEach(func() {
+		subject = new(Native)
+	})
+
+	It("should have defaults", func() {
+		subject.WithDefaults()
+		Expect(*subject.Ver).To(Equal("1"))
+		Expect(*subject.Plcmtcnt).To(Equal(1))
+		Expect(*subject.Seq).To(Equal(0))
+	})
+})