ossify 0.4.0

A modern, easy-to-use, and reqwest-powered Rust SDK for Alibaba Cloud Object Storage Service (OSS)
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

//! PutBucketReferer.
//!
//! Official document: <https://www.alibabacloud.com/help/en/oss/developer-reference/putbucketreferer>

use std::future::Future;

use http::Method;
use serde::{Deserialize, Serialize};
use serde_with::skip_serializing_none;

use crate::body::XMLBody;
use crate::error::Result;
use crate::response::EmptyResponseProcessor;
use crate::ser::OnlyKeyField;
use crate::{Client, Ops, Prepared, Request};

#[derive(Debug, Clone, Default, Serialize)]
pub struct PutBucketRefererParams {
    referer: OnlyKeyField,
}

/// `<RefererList>` / `<RefererBlacklist>` container. OSS wraps the repeated
/// `<Referer>` elements in one of these two containers.
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
pub struct RefererList {
    #[serde(rename = "Referer", default, skip_serializing_if = "Vec::is_empty")]
    pub referers: Vec<String>,
}

/// Root `<RefererConfiguration>` element.
#[skip_serializing_none]
#[derive(Debug, Clone, Default, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename = "RefererConfiguration", rename_all = "PascalCase")]
pub struct RefererConfiguration {
    pub allow_empty_referer: bool,
    pub allow_truncate_query_string: Option<bool>,
    pub truncate_path: Option<bool>,
    pub referer_list: Option<RefererList>,
    pub referer_blacklist: Option<RefererList>,
}

pub struct PutBucketReferer {
    pub config: RefererConfiguration,
}

impl Ops for PutBucketReferer {
    type Response = EmptyResponseProcessor;
    type Body = XMLBody<RefererConfiguration>;
    type Query = PutBucketRefererParams;

    fn prepare(self) -> Result<Prepared<PutBucketRefererParams, RefererConfiguration>> {
        Ok(Prepared {
            method: Method::PUT,
            query: Some(PutBucketRefererParams::default()),
            body: Some(self.config),
            ..Default::default()
        })
    }
}

pub trait PutBucketRefererOps {
    /// Configure the Referer whitelist / blacklist on the bucket.
    ///
    /// Official document: <https://www.alibabacloud.com/help/en/oss/developer-reference/putbucketreferer>
    fn put_bucket_referer(&self, config: RefererConfiguration) -> impl Future<Output = Result<()>>;
}

impl PutBucketRefererOps for Client {
    async fn put_bucket_referer(&self, config: RefererConfiguration) -> Result<()> {
        self.request(PutBucketReferer { config }).await
    }
}

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

    #[test]
    fn params_serialize() {
        assert_eq!(crate::ser::to_string(&PutBucketRefererParams::default()).unwrap(), "referer");
    }

    #[test]
    fn round_trip_whitelist_and_blacklist() {
        let cfg = RefererConfiguration {
            allow_empty_referer: false,
            allow_truncate_query_string: Some(true),
            truncate_path: Some(true),
            referer_list: Some(RefererList {
                referers: vec!["http://www.aliyun.com".to_string()],
            }),
            referer_blacklist: Some(RefererList {
                referers: vec!["http://www.refuse.com".to_string()],
            }),
        };
        let xml = quick_xml::se::to_string(&cfg).unwrap();
        let back: RefererConfiguration = quick_xml::de::from_str(&xml).unwrap();
        assert_eq!(back, cfg);
    }
}