Skip to main content

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