twapi_v2/api/
get_2_tweets_sample10_stream.rs

1use crate::fields::{
2    media_fields::MediaFields, place_fields::PlaceFields, poll_fields::PollFields,
3    tweet_fields::TweetFields, user_fields::UserFields,
4};
5use crate::responses::{errors::Errors, includes::Includes, tweets::Tweets};
6use crate::{
7    api::{apply_options, execute_twitter, make_url, Authentication, TwapiOptions},
8    error::Error,
9    headers::Headers,
10};
11use chrono::prelude::*;
12use itertools::Itertools;
13use reqwest::RequestBuilder;
14use serde::{Deserialize, Serialize};
15use std::collections::HashSet;
16
17const URL: &str = "/2/tweets/sample10/stream";
18
19#[derive(Serialize, Deserialize, Debug, Eq, Hash, PartialEq, Clone)]
20pub enum Expansions {
21    #[serde(rename = "article.cover_media")]
22    ArticleCoverMedia,
23    #[serde(rename = "article.media_entities")]
24    ArticleMediaEntities,
25    #[serde(rename = "attachments.media_keys")]
26    AttachmentsMediaKeys,
27    #[serde(rename = "attachments.media_source_tweet")]
28    AttachmentsMediaSourceTweet,
29    #[serde(rename = "attachments.poll_ids")]
30    AttachmentsPollIds,
31    #[serde(rename = "author_id")]
32    AuthorId,
33    #[serde(rename = "edit_history_tweet_ids")]
34    EditHistoryTweetIds,
35    #[serde(rename = "entities.mentions.username")]
36    EntitiesMentionsUsername,
37    #[serde(rename = "geo.place_id")]
38    GeoPlaceId,
39    #[serde(rename = "in_reply_to_user_id")]
40    InReplyToUserId,
41    #[serde(rename = "entities.note.mentions.username")]
42    EntitiesNoteMentionsUsername,
43    #[serde(rename = "referenced_tweets.id")]
44    ReferencedTweetsId,
45    #[serde(rename = "referenced_tweets.id.author_id")]
46    ReferencedTweetsIdAuthorId,
47}
48
49impl Expansions {
50    pub fn all() -> HashSet<Self> {
51        let mut result = HashSet::new();
52        result.insert(Self::ArticleCoverMedia);
53        result.insert(Self::ArticleMediaEntities);
54        result.insert(Self::AttachmentsMediaKeys);
55        result.insert(Self::AttachmentsMediaSourceTweet);
56        result.insert(Self::AttachmentsPollIds);
57        result.insert(Self::AuthorId);
58        result.insert(Self::EditHistoryTweetIds);
59        result.insert(Self::EntitiesMentionsUsername);
60        result.insert(Self::GeoPlaceId);
61        result.insert(Self::InReplyToUserId);
62        result.insert(Self::EntitiesNoteMentionsUsername);
63        result.insert(Self::ReferencedTweetsId);
64        result.insert(Self::ReferencedTweetsIdAuthorId);
65        result
66    }
67}
68
69impl std::fmt::Display for Expansions {
70    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
71        match self {
72            Self::ArticleCoverMedia => write!(f, "article.cover_media"),
73            Self::ArticleMediaEntities => write!(f, "article.media_entities"),
74            Self::AttachmentsMediaKeys => write!(f, "attachments.media_keys"),
75            Self::AttachmentsMediaSourceTweet => write!(f, "attachments.media_source_tweet"),
76            Self::AttachmentsPollIds => write!(f, "attachments.poll_ids"),
77            Self::AuthorId => write!(f, "author_id"),
78            Self::EditHistoryTweetIds => write!(f, "edit_history_tweet_ids"),
79            Self::EntitiesMentionsUsername => write!(f, "entities.mentions.username"),
80            Self::GeoPlaceId => write!(f, "geo.place_id"),
81            Self::InReplyToUserId => write!(f, "in_reply_to_user_id"),
82            Self::EntitiesNoteMentionsUsername => write!(f, "entities.note.mentions.username"),
83            Self::ReferencedTweetsId => write!(f, "referenced_tweets.id"),
84            Self::ReferencedTweetsIdAuthorId => write!(f, "referenced_tweets.id.author_id"),
85        }
86    }
87}
88
89impl Default for Expansions {
90    fn default() -> Self {
91        Self::ArticleCoverMedia
92    }
93}
94
95#[derive(Debug, Clone, Default)]
96pub struct Api {
97    partition: usize,
98    backfill_minutes: Option<usize>,
99    end_time: Option<DateTime<Utc>>,
100    expansions: Option<HashSet<Expansions>>,
101    media_fields: Option<HashSet<MediaFields>>,
102    place_fields: Option<HashSet<PlaceFields>>,
103    poll_fields: Option<HashSet<PollFields>>,
104    start_time: Option<DateTime<Utc>>,
105    tweet_fields: Option<HashSet<TweetFields>>,
106    user_fields: Option<HashSet<UserFields>>,
107    twapi_options: Option<TwapiOptions>,
108}
109
110impl Api {
111    pub fn new(partition: usize) -> Self {
112        Self {
113            partition,
114            ..Default::default()
115        }
116    }
117
118    pub fn all(partition: usize) -> Self {
119        Self {
120            partition,
121            expansions: Some(Expansions::all()),
122            media_fields: Some(MediaFields::all()),
123            place_fields: Some(PlaceFields::all()),
124            poll_fields: Some(PollFields::all()),
125            tweet_fields: Some(TweetFields::organic()),
126            user_fields: Some(UserFields::all()),
127            ..Default::default()
128        }
129    }
130
131    pub fn open(partition: usize) -> Self {
132        Self {
133            partition,
134            expansions: Some(Expansions::all()),
135            media_fields: Some(MediaFields::open()),
136            place_fields: Some(PlaceFields::all()),
137            poll_fields: Some(PollFields::all()),
138            tweet_fields: Some(TweetFields::open()),
139            user_fields: Some(UserFields::all()),
140            ..Default::default()
141        }
142    }
143
144    pub fn backfill_minutes(mut self, value: usize) -> Self {
145        self.backfill_minutes = Some(value);
146        self
147    }
148
149    pub fn end_time(mut self, value: DateTime<Utc>) -> Self {
150        self.end_time = Some(value);
151        self
152    }
153
154    pub fn expansions(mut self, value: HashSet<Expansions>) -> Self {
155        self.expansions = Some(value);
156        self
157    }
158
159    pub fn media_fields(mut self, value: HashSet<MediaFields>) -> Self {
160        self.media_fields = Some(value);
161        self
162    }
163
164    pub fn place_fields(mut self, value: HashSet<PlaceFields>) -> Self {
165        self.place_fields = Some(value);
166        self
167    }
168
169    pub fn poll_fields(mut self, value: HashSet<PollFields>) -> Self {
170        self.poll_fields = Some(value);
171        self
172    }
173
174    pub fn start_time(mut self, value: DateTime<Utc>) -> Self {
175        self.start_time = Some(value);
176        self
177    }
178
179    pub fn tweet_fields(mut self, value: HashSet<TweetFields>) -> Self {
180        self.tweet_fields = Some(value);
181        self
182    }
183
184    pub fn user_fields(mut self, value: HashSet<UserFields>) -> Self {
185        self.user_fields = Some(value);
186        self
187    }
188
189    pub fn twapi_options(mut self, value: TwapiOptions) -> Self {
190        self.twapi_options = Some(value);
191        self
192    }
193
194    pub fn build(self, authentication: &impl Authentication) -> RequestBuilder {
195        let mut query_parameters = vec![];
196        query_parameters.push(("partition", self.partition.to_string()));
197        if let Some(backfill_minutes) = self.backfill_minutes {
198            query_parameters.push(("backfill_minutes", backfill_minutes.to_string()));
199        }
200        if let Some(end_time) = self.end_time {
201            query_parameters.push(("end_time", end_time.format("%Y-%m-%dT%H%M%SZ").to_string()));
202        }
203        if let Some(expansions) = self.expansions {
204            query_parameters.push(("expansions", expansions.iter().join(",")));
205        }
206        if let Some(media_fields) = self.media_fields {
207            query_parameters.push(("media.fields", media_fields.iter().join(",")));
208        }
209        if let Some(place_fields) = self.place_fields {
210            query_parameters.push(("place.fields", place_fields.iter().join(",")));
211        }
212        if let Some(poll_fields) = self.poll_fields {
213            query_parameters.push(("poll.fields", poll_fields.iter().join(",")));
214        }
215        if let Some(start_time) = self.start_time {
216            query_parameters.push((
217                "start_time",
218                start_time.format("%Y-%m-%dT%H%M%SZ").to_string(),
219            ));
220        }
221        if let Some(tweet_fields) = self.tweet_fields {
222            query_parameters.push(("tweet.fields", tweet_fields.iter().join(",")));
223        }
224        if let Some(user_fields) = self.user_fields {
225            query_parameters.push(("user.fields", user_fields.iter().join(",")));
226        }
227        let client = reqwest::Client::new();
228        let url = make_url(&self.twapi_options, URL);
229        let builder = client.get(&url).query(&query_parameters);
230        authentication.execute(
231            apply_options(builder, &self.twapi_options),
232            "GET",
233            &url,
234            &query_parameters
235                .iter()
236                .map(|it| (it.0, it.1.as_str()))
237                .collect::<Vec<_>>(),
238        )
239    }
240
241    pub async fn execute(
242        self,
243        authentication: &impl Authentication,
244    ) -> Result<(Response, Headers), Error> {
245        execute_twitter(self.build(authentication)).await
246    }
247}
248
249#[derive(Serialize, Deserialize, Debug, Clone, Default)]
250pub struct Response {
251    #[serde(skip_serializing_if = "Option::is_none")]
252    pub data: Option<Tweets>,
253    #[serde(skip_serializing_if = "Option::is_none")]
254    pub errors: Option<Vec<Errors>>,
255    #[serde(skip_serializing_if = "Option::is_none")]
256    pub includes: Option<Includes>,
257    #[serde(flatten)]
258    pub extra: std::collections::HashMap<String, serde_json::Value>,
259}
260
261impl Response {
262    pub fn is_empty_extra(&self) -> bool {
263        let res = self.extra.is_empty()
264            && self
265                .data
266                .as_ref()
267                .map(|it| it.is_empty_extra())
268                .unwrap_or(true)
269            && self
270                .errors
271                .as_ref()
272                .map(|it| it.iter().all(|item| item.is_empty_extra()))
273                .unwrap_or(true)
274            && self
275                .includes
276                .as_ref()
277                .map(|it| it.is_empty_extra())
278                .unwrap_or(true);
279        if !res {
280            println!("Response {:?}", self.extra);
281        }
282        res
283    }
284}