openrtb 0.2.1

OpenRTB v2.5 and OpenRTB Dynamic Native Ads v1.2 types for rust.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

// Copyright (c) 2018 The openrtb-rust authors
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use serde_utils;

use super::audio::Audio;
use super::banner::Banner;
use super::metric::Metric;
use super::native::Native;
use super::pmp::PMP;
use super::video::Video;

#[derive(Serialize, Deserialize, Debug, Clone, PartialEq)]
pub struct Imp {
    pub id: String,

    #[serde(default, skip_serializing_if = "Vec::is_empty")]
    pub metric: Vec<Metric>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub banner: Option<Banner>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub video: Option<Video>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub audio: Option<Audio>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub native: Option<Native>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub pmp: Option<PMP>,

    #[serde(rename = "displaymanager", skip_serializing_if = "Option::is_none")]
    pub display_manager: Option<String>,

    #[serde(rename = "displaymanagerver", skip_serializing_if = "Option::is_none")]
    pub display_manager_ver: Option<String>,

    #[serde(
        default,
        rename = "instl",
        skip_serializing_if = "Option::is_none",
        serialize_with = "serde_utils::mbool_to_u8",
        deserialize_with = "serde_utils::u8_to_mbool"
    )]
    pub interstitial: Option<bool>,

    #[serde(rename = "tagid", skip_serializing_if = "Option::is_none")]
    pub tag_id: Option<String>,

    #[serde(rename = "bidfloor", skip_serializing_if = "Option::is_none")]
    pub bid_floor: Option<f32>,

    #[serde(rename = "bidfloorcur", skip_serializing_if = "Option::is_none")]
    pub bid_floor_cur: Option<String>,

    // TODO: add properly
    // #[serde(
    //     rename = "clickbrowser",
    //     skip_serializing_if = "serde_utils::is_false",
    //     serialize_with = "serde_utils::bool_to_u8",
    //     deserialize_with = "serde_utils::u8_to_bool"
    // )]
    // pub click_browser: Option<bool>,
    #[serde(
        default,
        skip_serializing_if = "Option::is_none",
        serialize_with = "serde_utils::mbool_to_u8",
        deserialize_with = "serde_utils::u8_to_mbool"
    )]
    pub secure: Option<bool>,

    // TODO: add properly
    // iframebuster
    /// Advisory as to the number of seconds that may elapse
    /// between the auction and the actual impression.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub exp: Option<u64>,

    #[serde(skip_serializing_if = "Option::is_none")]
    pub ext: Option<serde_utils::Ext>,
}

#[cfg(test)]
mod tests {
    use super::*;
    use serde_json;

    #[test]
    fn serialization_skip_fields() {
        let i = Imp {
            id: "1234".to_string(),
            metric: vec![],
            banner: None,
            video: None,
            audio: None,
            native: None,
            pmp: None,
            display_manager: None,
            display_manager_ver: None,
            interstitial: None,
            tag_id: None,
            bid_floor: None,
            bid_floor_cur: None,
            secure: None,
            ext: None,
            exp: None,
        };

        let expected = r#"{"id":"1234"}"#;
        let serialized = serde_json::to_string(&i).unwrap();

        assert_eq!(expected, serialized)
    }

    #[test]
    fn check_simple() {
        assert_eq!(
            serde_json::from_str::<Imp>("{\"id\":\"7a5156a2-50f5-4dea-9eeb-a767f975d500\",\"banner\":{\"w\":300,\"h\":250},\"bidfloor\":0.1}").unwrap().id,
            "7a5156a2-50f5-4dea-9eeb-a767f975d500",
        )
    }
}