getpocket 0.2.7

Rust crate for GetPocket API (https://getpocket.com/)
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
#![allow(dead_code)]
use crate::ApiRequestError;
use anyhow::{bail, Result};
use serde::{Deserialize, Serialize};
use serde_qs as qs;
use thiserror::Error;

pub static ENDPOINT: &'static str = "https://getpocket.com/v3/send";

const RATE_LIMIT_HEADERS: [(&str, &str); 6] = [
    ("X-Limit-User-Limit", "Current rate limit enforced per user"),
    (
        "X-Limit-User-Remaining",
        "Number of calls remaining before hitting user's rate limit",
    ),
    (
        "X-Limit-User-Reset",
        "Seconds until user's rate limit resets",
    ),
    (
        "X-Limit-Key-Limit",
        "Current rate limit enforced per consumer key",
    ),
    (
        "X-Limit-Key-Remaining",
        "Number of calls remaining before hitting consumer key's rate limit",
    ),
    (
        "X-Limit-Key-Reset:",
        "Seconds until consumer key rate limit resets",
    ),
];

#[derive(Debug, Error)]
pub enum ClientError<'a> {
    #[error("{0}")]
    JsonError(serde_json::Error),
    #[error("There was an issue with the parameters. `{0}`")]
    InvalidParams(&'a str),
    #[error("Access to this resource is restricted")]
    AccessDenied,
    #[error("Token authentication failed. Please check your token and try again.")]
    TokenError,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct StandardResponse {
    pub action_results: Vec<bool>,
    pub action_errors: Vec<Option<String>>,
    pub status: i32,
}

#[derive(Debug, Serialize, Deserialize)]
pub struct ExtendedResponse {
    pub action_results: serde_json::Value,
    pub action_errors: Vec<Option<String>>,
    pub status: i32,
}

#[derive(Debug, Deserialize)]
#[serde(untagged)]
pub enum RecordSendDirect {
    Standart(StandardResponse),
    Extended(ExtendedResponse),
}

#[derive(Deserialize, Default, Clone, Debug)]
pub struct Token {
    pub code: Option<String>,
    pub access_token: Option<String>,
}

impl<'a> Token {
    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    fn new() -> Self {
        Self::default()
    }

    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    fn set_code(&mut self, code: &str) {
        let code = code.to_string();
        self.code = Some(code);
    }

    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    fn set_access_token(&mut self, access_token: &str) {
        let access_token = access_token.to_string();
        self.access_token = Some(access_token);
    }
}

#[derive(Debug, Clone)]
pub struct Reqwester {
    pub client: reqwest::Client,
}

#[derive(Debug, Clone)]
pub struct GetPocket {
    pub consumer_key: String,
    pub redirect_uri: String,
    pub token: Token,
    pub reqwester: Reqwester,
}

impl GetPocket {
    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    pub async fn init<F, C>(
        consumer_key: String,
        redirect_uri: String,
        store_fn: F,
        opener_fn: C,
    ) -> Result<Self>
    where
        F: for<'a> FnOnce(&'a str),
        C: for<'b> FnOnce(&'b str) -> Result<bool>,
    {
        let token = Token::new();

        let reqwester = Self::init_reqwester();

        let mut get_pocket = Self {
            consumer_key,
            redirect_uri,
            reqwester,
            token,
        };

        get_pocket
            .get_access_token_manual_open(opener_fn, None)
            .await?;

        if let Some(ref access_token) = get_pocket.token.access_token {
            store_fn(access_token);

            Ok(get_pocket)
        } else {
            bail!(ClientError::TokenError);
        }
    }

    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    pub async fn new(
        consumer_key: String,
        redirect_uri: String,
        access_token: String,
    ) -> Result<Self> {
        let mut token = Token::new();

        token.set_access_token(&access_token);

        let reqwester = Self::init_reqwester();

        let get_pocket = Self {
            consumer_key,
            redirect_uri,
            reqwester,
            token,
        };

        Ok(get_pocket)
    }

    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    pub async fn send<T>(&self, params: T) -> Result<RecordSendDirect>
    where
        T: Serialize,
    {
        #[derive(Serialize)]
        struct RequestParams<'a, T> {
            consumer_key: &'a str,
            access_token: &'a str,
            actions: T,
        }

        let access_token = match &self.token.access_token {
            Some(access_token) => access_token,
            None => bail!(ClientError::TokenError),
        };

        let consumer_key = &self.consumer_key;

        let req_param = RequestParams {
            consumer_key,
            access_token,
            actions: params,
        };

        let urlencoded = qs::to_string(&req_param)?;

        let params = format!("{ENDPOINT}?{urlencoded}");

        let client = &self.reqwester.client;
        let res = client.post(&params).send().await?;

        if let Err(err) = ApiRequestError::handler_status(res.status()) {
            bail!(err);
        }

        let res_body = &res.text().await?;

        let res_ser: Result<RecordSendDirect, serde_json::Error> = serde_json::from_str(&res_body);

        match res_ser {
            Ok(res_ser) => Ok(res_ser),
            Err(err) => Err(ClientError::JsonError(err).into()),
        }
    }

    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    async fn token_code(&mut self) -> Result<String> {
        if let Some(access_token) = &self.token.access_token {
            return Ok(access_token.clone());
        }

        let endpoint = "https://getpocket.com/v3/oauth/request";

        #[derive(Serialize)]
        struct RequestParams<'a> {
            consumer_key: &'a str,
            redirect_uri: &'a str,
        }

        #[derive(Deserialize)]
        struct RequestCode {
            code: String,
        }

        let map = RequestParams {
            consumer_key: &self.consumer_key,
            redirect_uri: &self.redirect_uri,
        };

        let client = &self.reqwester.client;
        let res = client.post(endpoint).json(&map).send().await?;

        if let Err(err) = ApiRequestError::handler_status(res.status()) {
            bail!(err);
        }

        res.json::<RequestCode>()
            .await
            .map(|request_code| request_code.code)
            .map_err(Into::into)
    }

    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    async fn get_access_token_manual_open<F>(
        &mut self,
        f: F,
        redirect_uri: Option<&str>,
    ) -> Result<&mut Self>
    where
        F: for<'b> FnOnce(&'b str) -> Result<bool>,
    {
        let code = self.token_code().await?;

        let redirect_uri = match redirect_uri {
            Some(redirect_uri) => redirect_uri,
            None => "https://getpocket.com",
        };

        let is_save = f(&format!(
            "https://getpocket.com/auth/authorize?request_token={code}&redirect_uri={redirect_uri}"
        ))?;

        if is_save {
            self.token.set_code(&code);
            self.get_request_access_token().await?;

            Ok(self)
        } else {
            bail!(ClientError::InvalidParams(
                "No token was provided from the callback function."
            ));
        }
    }

    fn init_reqwester() -> Reqwester {
        use reqwest::header;

        let mut headers = header::HeaderMap::new();
        headers.insert(
            "Content-Type",
            header::HeaderValue::from_static("application/json; charset=UTF-8"),
        );
        headers.insert(
            "X-Accept",
            header::HeaderValue::from_static("application/json"),
        );

        let client = reqwest::Client::builder()
            .default_headers(headers)
            .build()
            .unwrap();

        Reqwester { client }
    }

    #[deprecated(
        since = "0.3.0",
        note = "This function will be removed in next version. Please see the README for migration guidance."
    )]
    async fn get_request_access_token(&mut self) -> Result<&mut Self> {
        let endpoint = "https://getpocket.com/v3/oauth/authorize";

        #[derive(Debug, Serialize)]
        struct RequestParams<'a> {
            consumer_key: &'a str,
            code: &'a str,
        }

        let map = match &self.token.code {
            Some(code) => RequestParams {
                consumer_key: &self.consumer_key,
                code,
            },
            None => bail!(ClientError::TokenError),
        };

        #[derive(Deserialize)]
        struct RequestAccessToken {
            access_token: String,
        }

        let client = &self.reqwester.client;
        let res = client.post(endpoint).json(&map).send().await?;

        if let Err(err) = ApiRequestError::handler_status(res.status()) {
            bail!(err);
        }

        match res.json::<RequestAccessToken>().await {
            Ok(RequestAccessToken { access_token }) => self.token.set_access_token(&access_token),
            Err(err) => Err(err)?,
        }

        Ok(self)
    }
}

#[derive(Default)]
pub enum RecordItemState {
    All,
    #[default]
    Unread,
    Archive,
}

#[derive(Default)]
pub enum RecordItemFavorite {
    #[default]
    All,
    Unfavorited,
    Favorited,
}

#[derive(Default)]
pub enum RecordItemTag<'a> {
    #[default]
    All,
    TagName(&'a str),
    Untagged,
}

#[derive(Default)]
pub enum RecordItemContentType {
    #[default]
    All,
    Article,
    Video,
    Image,
}

#[derive(Default)]
pub enum RecordItemSort {
    #[default]
    All,
    Newest,
    Oldest,
    Title,
    Site,
}

#[derive(Default)]
pub enum RecordItemDetailType {
    #[default]
    All,
    Simple,
    Complete,
}