Merge pull request #295 from AdExNetwork/clean-up-marketing-campaign

Clean up for Supermarket

Author: elpiel

adview-manager/src/lib.rs

@@ -296,8 +296,12 @@ fn get_unit_html(
 #[cfg(test)]
 mod test {
     use super::*;
+    use adex_primitives::ValidatorId;
+    use std::convert::TryFrom;
 
     fn get_ad_unit(media_mime: &str) -> AdUnit {
+        let owner = ValidatorId::try_from("0xce07CbB7e054514D590a0262C93070D838bFBA2e")
+            .expect("Should be valid ValidatorId string");
         AdUnit {
             ipfs: "".to_string(),
             ad_type: "".to_string(),
@@ -307,7 +311,7 @@ mod test {
             targeting: vec![],
             min_targeting_score: None,
             tags: vec![],
-            owner: "".to_string(),
+            owner,
             created: Utc::now(),
             title: None,
             description: None,

primitives/src/ad_slot.rs

@@ -0,0 +1,69 @@
+use crate::{BigNum, TargetingTag, ValidatorId};
+use chrono::serde::{ts_milliseconds, ts_milliseconds_option};
+use chrono::{DateTime, Utc};
+use serde::{Deserialize, Serialize};
+use std::collections::HashMap;
+
+/// See [AdEx Protocol adSlot.md][protocol] & [adex-models AdSlot.js][adex-models] for more details.
+/// [protocol]: https://github.com/AdExNetwork/adex-protocol/blob/master/adSlot.md
+/// [adex-models]: https://github.com/AdExNetwork/adex-models/blob/master/src/models/AdSlot.js
+#[derive(Serialize, Deserialize, Debug, Clone)]
+#[serde(rename_all = "camelCase")]
+pub struct AdSlot {
+    /// valid ipfs hash of spec props below
+    pub ipfs: String,
+    /// The type of the AdSlot
+    /// currently, possible values are:
+    /// > legacy_300x250, legacy_250x250, legacy_240x400, legacy_336x280,
+    /// > legacy_180x150, legacy_300x100, legacy_720x300, legacy_468x60,
+    /// > legacy_234x60, legacy_88x31, legacy_120x90, legacy_120x60,
+    /// > legacy_120x240, legacy_125x125, legacy_728x90, legacy_160x600,
+    /// > legacy_120x600, legacy_300x600
+    /// see IAB ad unit guidelines and iab_flex_{adUnitName} (see IAB's new ad portfolio and PDF)
+    #[serde(rename = "type")]
+    pub ad_type: String,
+    /// A URL to the resource (usually PNG)
+    /// * must use the ipfs:// protocol, to guarantee data immutability
+    pub media_url: String,
+    /// MIME type of the media.
+    // Possible values at the moment are:
+    /// * image/jpeg
+    /// * image/png
+    pub media_mime: String,
+    /// Advertised URL
+    pub target_url: String,
+    /// Array of TargetingTag
+    #[serde(default)]
+    pub targeting: Vec<TargetingTag>,
+    // HashMap<DepositAsset, BigNum> for the minimum payment accepted per impression
+    #[serde(default)]
+    pub min_per_impression: Option<HashMap<String, BigNum>>,
+    /// Array of TargetingTag
+    /// meant for discovery between publishers/advertisers
+    #[serde(default)]
+    pub tags: Vec<TargetingTag>,
+    #[serde(default)]
+    pub auto_tags: Vec<TargetingTag>,
+    /// Valid ipfs hash for Ad Unit object. It will be used as fallback data (optional)
+    #[serde(default)]
+    pub fallback_unit: Option<String>,
+    /// User address from the session
+    pub owner: ValidatorId,
+    /// UTC timestamp in milliseconds, used as nonce for escaping duplicated spec ipfs hashes
+    #[serde(with = "ts_milliseconds")]
+    pub created: DateTime<Utc>,
+    /// the name of the unit used in platform UI
+    #[serde(default)]
+    pub title: Option<String>,
+    /// arbitrary text used in platform UI
+    #[serde(default)]
+    pub description: Option<String>,
+    #[serde(default)]
+    pub webiste: Option<String>,
+    /// user can change it - used for filtering in platform UI
+    #[serde(default)]
+    pub archived: bool,
+    /// UTC timestamp in milliseconds, changed every time modifiable property is changed
+    #[serde(default, with = "ts_milliseconds_option")]
+    pub modified: Option<DateTime<Utc>>,
+}

primitives/src/ad_unit.rs

@@ -2,7 +2,7 @@ use chrono::serde::{ts_milliseconds, ts_milliseconds_option};
 use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
 
-use crate::TargetingTag;
+use crate::{TargetingTag, ValidatorId};
 
 #[derive(Serialize, Deserialize, Debug, Clone)]
 #[serde(rename_all = "camelCase")]
@@ -34,7 +34,7 @@ pub struct AdUnit {
     #[serde(default)]
     pub tags: Vec<TargetingTag>,
     /// user address from the session
-    pub owner: String,
+    pub owner: ValidatorId,
     /// number, UTC timestamp in milliseconds, used as nonce for escaping duplicated spec ipfs hashes
     #[serde(with = "ts_milliseconds")]
     pub created: DateTime<Utc>,

primitives/src/balances_map.rs

@@ -39,6 +39,10 @@ impl BalancesMap {
     pub fn insert(&mut self, key: ValidatorId, value: BigNum) -> Option<BigNum> {
         self.0.insert(key, value)
     }
+
+    pub fn is_empty(&self) -> bool {
+        self.0.is_empty()
+    }
 }
 
 impl FromIterator<(ValidatorId, BigNum)> for BalancesMap {

primitives/src/big_num.rs

@@ -1,4 +1,5 @@
 use std::convert::TryFrom;
+use std::fmt;
 use std::iter::Sum;
 use std::ops::{Add, AddAssign, Div, Mul, Sub};
 use std::str::FromStr;
@@ -9,19 +10,7 @@ use num_derive::{Num, NumOps, One, Zero};
 use serde::{Deserialize, Deserializer, Serialize, Serializer};
 
 #[derive(
-    Serialize,
-    Deserialize,
-    Debug,
-    Clone,
-    PartialEq,
-    Eq,
-    PartialOrd,
-    Ord,
-    NumOps,
-    One,
-    Zero,
-    Num,
-    Default,
+    Serialize, Deserialize, Clone, PartialEq, Eq, PartialOrd, Ord, NumOps, One, Zero, Num, Default,
 )]
 pub struct BigNum(
     #[serde(
@@ -57,6 +46,14 @@ impl BigNum {
     }
 }
 
+impl fmt::Debug for BigNum {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        let radix = 10;
+        let value = self.to_str_radix(radix);
+        write!(f, "BigNum(radix: {}; {})", radix, value)
+    }
+}
+
 impl Integer for BigNum {
     fn div_floor(&self, other: &Self) -> Self {
         self.0.div_floor(&other.0).into()

primitives/src/channel.rs

@@ -153,6 +153,7 @@ pub struct ChannelSpec {
     pub ad_units: Vec<AdUnit>,
     #[serde(default, skip_serializing_if = "Vec::is_empty")]
     pub price_multiplication_rules: Vec<PriceMultiplicationRules>,
+    #[serde(default)]
     pub price_dynamic_adjustment: bool,
 }
 

primitives/src/config.rs

@@ -4,7 +4,6 @@ use lazy_static::lazy_static;
 use serde::{Deserialize, Serialize};
 use serde_hex::{SerHex, StrictPfx};
 use std::fs;
-use toml;
 
 lazy_static! {
     static ref DEVELOPMENT_CONFIG: Config =

primitives/src/lib.rs

@@ -3,7 +3,8 @@
 use std::error;
 use std::fmt;
 
-pub mod ad_unit;
+mod ad_slot;
+mod ad_unit;
 pub mod adapter;
 pub mod balances_map;
 pub mod big_num;
@@ -27,6 +28,7 @@ pub mod analytics;
 mod eth_checksum;
 pub mod validator;
 
+pub use self::ad_slot::AdSlot;
 pub use self::ad_unit::AdUnit;
 pub use self::balances_map::BalancesMap;
 pub use self::big_num::BigNum;