drive-v3 0.5.1

A library for interacting the Google Drive API
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
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167

use reqwest::Method;

use crate::{Credentials, Error, objects, request_builder};

request_builder!(
    /// A request builder to get information about the user, the user's Drive,
    /// and system capabilities.
    pub GetRequest {},

    // HTTP Method
    Method::GET,

    // API endpoint
    ("https://www.googleapis.com/drive/v3/about"),
);

impl GetRequest {
    /// Executes this request.
    ///
    /// # Errors:
    ///
    /// - a [`UrlParsing`](crate::ErrorKind::UrlParsing) error, if the creation of the request's URL failed.
    /// - a [`Request`](crate::ErrorKind::Request) error, if unable to send the request or get a body from the response.
    /// - a [`Response`](crate::ErrorKind::Response) error, if the request returned an error response.
    /// - a [`Json`](crate::ErrorKind::Json) error, if unable to parse the response's body to an [`About`](objects::About) object.
    pub fn execute( &self ) -> Result<objects::About, Error> {
        let response = self.send()?;
        let about_object: objects::About = serde_json::from_str( &response.text()? )?;

        Ok(about_object)
    }
}

/// Information about the user, the user's Drive, and system capabilities.
///
/// # Examples:
///
/// ```no_run
/// use drive_v3::{Credentials, Drive};
/// # use drive_v3::Error;
///
/// let credentials_path = "my_credentials.json";
/// let scopes = ["https://www.googleapis.com/auth/drive.metadata.readonly"];
///
/// let credentials = Credentials::from_file(&credentials_path, &scopes)?;
/// let drive = Drive::new(&credentials);
///
/// let my_information = drive.about.get()
///     .fields("storageQuota, canCreateDrives, appInstalled")
///     .execute()?;
///
/// println!("look at all this information:\n{}", my_information);
/// # Ok::<(), Error>(())
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct About {
    /// Credentials used to authenticate a user's access to this resource.
    credentials: Credentials,
}

impl About {
    /// Creates a new [`About`] resource with the given [`Credentials`].
    pub fn new( credentials: &Credentials ) -> Self {
        Self { credentials: credentials.clone() }
    }

    /// Gets information about the user, the user's Drive, and system capabilities.
    ///
    /// See Google's [documentation](https://developers.google.com/drive/api/reference/rest/v3/about/get) for more information.
    ///
    /// # Note:
    ///
    /// This request requires you to set the [`fields`](GetRequest::fields) parameter.
    ///
    /// # Requires one of the following OAuth scopes:
    ///
    /// - `https://www.googleapis.com/auth/drive`
    /// - `https://www.googleapis.com/auth/drive.appdata`
    /// - `https://www.googleapis.com/auth/drive.file`
    /// - `https://www.googleapis.com/auth/drive.metadata`
    /// - `https://www.googleapis.com/auth/drive.metadata.readonly`
    /// - `https://www.googleapis.com/auth/drive.photos.readonly`
    /// - `https://www.googleapis.com/auth/drive.readonly`
    ///
    /// # Examples:
    ///
    /// ```no_run
    /// use drive_v3::{Credentials, Drive};
    /// # use drive_v3::Error;
    ///
    /// let credentials_path = "my_credentials.json";
    /// let scopes = ["https://www.googleapis.com/auth/drive.metadata.readonly"];
    ///
    /// let credentials = Credentials::from_file(&credentials_path, &scopes)?;
    /// let drive = Drive::new(&credentials);
    ///
    /// let my_information = drive.about.get()
    ///     .fields("storageQuota, canCreateDrives, appInstalled")
    ///     .execute()?;
    ///
    /// println!("look at all this information:\n{}", my_information);
    /// # Ok::<(), Error>(())
    /// ```
    pub fn get( &self ) -> GetRequest {
        GetRequest::new(&self.credentials)
    }
}

#[cfg(test)]
mod tests {
    use reqwest::Method;

    use super::About;
    use crate::ErrorKind;
    use crate::utils::test::{VALID_CREDENTIALS, INVALID_CREDENTIALS};

    fn get_resource() -> About {
        About::new(&VALID_CREDENTIALS)
    }

    fn get_invalid_resource() -> About {
        About::new(&INVALID_CREDENTIALS)
    }

    #[test]
    fn new_test() {
        let credentials = VALID_CREDENTIALS.clone();
        let resource = About::new(&credentials);

        assert_eq!(resource.credentials, credentials);
    }

    #[test]
    fn get_test() {
        let about_request = get_resource().get();

        assert_eq!(about_request.method, Method::GET);
        assert_eq!(&about_request.url, "https://www.googleapis.com/drive/v3/about");
    }

    #[test]
    fn fields_test() {
        let about_request = get_resource().get()
            .fields("test-fields");

        assert_eq!( about_request.fields, Some("test-fields".into()) );
    }

    #[test]
    fn execute_test() {
        let response = get_resource().get()
            .fields("kind")
            .execute();

        assert!( response.is_ok() );
    }

    #[test]
    fn execute_invalid_credentials_test() {
        let response = get_invalid_resource().get()
            .fields("kind")
            .execute();

        assert!( response.is_err() );
        assert_eq!( response.unwrap_err().kind, ErrorKind::Response );
    }
}