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 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557
// This Source Code Form is subject to the terms of the Mozilla Public
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
//! Access to the Streaming API.
//!
//! The Streaming API gives real-time access to tweets, narrowed by
//! search phrases, user id or location. A standard user is able to filter by up to
//! 400 keywords, 5,000 user ids and 25 locations.
//! See the [official documentation](https://developer.twitter.com/en/docs/tweets/filter-realtime/overview) for more details.
//!
//! ### Example
//! ```rust,no_run
//! # #[tokio::main]
//! # async fn main() {
//! # let token: egg_mode::Token = unimplemented!();
//! use egg_mode::stream::{filter, StreamMessage};
//! use futures::{Stream, TryStreamExt};
//!
//! let stream = filter()
//! // find tweets mentioning any of the following:
//! .track(&["rustlang", "python", "java", "javascript"])
//! .start(&token);
//!
//! stream.try_for_each(|m| {
//! // Check the message type and print tweet to console
//! if let StreamMessage::Tweet(tweet) = m {
//! println!("Received tweet from {}:\n{}\n", tweet.user.unwrap().name, tweet.text);
//! }
//! futures::future::ok(())
//! }).await.expect("Stream error");
//! # }
//! ```
//! ### Connection notes
//! To maintain a stable streaming connection requires a certain amount of effort to take
//! account of random disconnects, networks resets and stalls. The key points are:
//!
//! * The Twitter API sends a Ping message every 30 seconds of message inactivity. So set a timeout
//! such that after (say) 1 minute of inactivity, the client bounces the connection. This will protect
//! against network stalls
//! * Twitter will rate-limit reconnect attempts. So attempt conenctions with a linear or exponential
//! backoff strategy
//! * In the case of an unreliable connection (e.g. mobile network), fall back to the polling API
//!
//! The [official guide](https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/connecting) has more information.
use std::future::Future;
use std::pin::Pin;
use std::str::FromStr;
use std::task::{Context, Poll};
use std::{self, io};
use futures::Stream;
use hyper::client::ResponseFuture;
use hyper::{Body, Request};
use serde::de::Error;
use serde::{Deserialize, Deserializer, Serialize};
use serde_json;
use crate::auth::Token;
use crate::common::*;
use crate::tweet::Tweet;
use crate::{error, links};
// TODO rewrite this
// https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/streaming-message-types
/// Represents the kinds of messages that can be sent over Twitter's Streaming API.
#[derive(Debug)]
pub enum StreamMessage {
/// A blank line, sent periodically to keep the connection alive.
Ping,
/// A list of accounts the authenticated user follows, sent at the beginning of the session for
/// user streams.
FriendList(Vec<u64>),
/// A new tweet.
///
/// Note that the `entities` inside the `user` field will be empty for tweets received via the
/// Streaming API.
Tweet(Tweet),
/// Notice given when a user deletes a post.
///
/// Clients are expected to comply with these notices by removing the status "from memory and
/// any storage or archive, even in the rare case where a deletion message arrives earlier in
/// the stream than the Tweet it references."
Delete {
/// The status that was deleted.
status_id: u64,
/// The user that deleted the status.
user_id: u64,
},
/// Notice given when a user removes geolocation information from their profile.
///
/// Clients are expected to comply by deleting cached geolocation information from tweets by
/// the given user, for any tweets up to and including the given status ID. According to
/// Twitter's documentation, "These messages may also arrive before a Tweet which falls into
/// the specified range, although this is rare."
ScrubGeo {
/// The user whose geolocation information needs to be scrubbed.
user_id: u64,
/// The last status ID to scrub information from.
up_to_status_id: u64,
},
/// Placeholder message used to indicate that a specific tweet has been withheld in certain
/// countries.
StatusWithheld {
/// The status that was withheld.
status_id: u64,
/// The user that posted the status.
user_id: u64,
/// A list of uppercase two-character country codes listing the countries where the tweet
/// was withheld.
withheld_in_countries: Vec<String>,
},
/// Placeholder message used to indicate that a specific user's content has been withheld in
/// certain countries.
UserWithheld {
/// The user whose content was withheld.
user_id: u64,
/// A list of uppercase two-character country codes listing the countries where the content
/// was withheld.
withheld_in_countries: Vec<String>,
},
/// An error message that may be delivered immediately prior to Twitter disconnecting the
/// stream.
///
/// Note that if the stream is disconnected due to network issues or the client reading
/// messages too slowly, it's possible that this message may not be received.
///
/// The enclosed values are an error code and error description. A non-exhaustive list of error
/// codes and their associated reasons are available on [Twitter's stream
/// docmentation][stream-doc], under "Disconnect messages (disconnect)".
///
/// [stream-doc]: https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/streaming-message-types
Disconnect(u64, String),
/// An unhandled message payload.
///
/// Twitter can add new streaming messages to the API, and egg-mode includes them here so that
/// they can be used before egg-mode has a chance to handle them.
Unknown(serde_json::Value),
//TODO: stall warnings? "follows over limit" warnings? (other warnings?)
}
impl<'de> Deserialize<'de> for StreamMessage {
fn deserialize<D>(deser: D) -> Result<StreamMessage, D::Error>
where
D: Deserializer<'de>,
{
macro_rules! fetch {
($input: ident, $key: expr) => {
$input
.get($key)
.and_then(|val| serde_json::from_value(val.clone()).ok())
.ok_or_else(|| D::Error::custom("Failed"))
};
}
let input = serde_json::Value::deserialize(deser)?;
let msg = if let Some(del) = input.get("delete").and_then(|d| d.get("status")) {
StreamMessage::Delete {
status_id: fetch!(del, "id")?,
user_id: fetch!(del, "user_id")?,
}
} else if let Some(scrub) = input.get("scrub_geo") {
StreamMessage::ScrubGeo {
user_id: fetch!(scrub, "user_id")?,
up_to_status_id: fetch!(scrub, "up_to_status_id")?,
}
} else if let Some(tweet) = input.get("status_withheld") {
StreamMessage::StatusWithheld {
status_id: fetch!(tweet, "id")?,
user_id: fetch!(tweet, "user_id")?,
withheld_in_countries: fetch!(tweet, "withheld_in_countries")?,
}
} else if let Some(user) = input.get("user_withheld") {
StreamMessage::UserWithheld {
user_id: fetch!(user, "id")?,
withheld_in_countries: fetch!(user, "withheld_in_countries")?,
}
} else if let Some(err) = input.get("disconnect") {
StreamMessage::Disconnect(fetch!(err, "code")?, fetch!(err, "reason")?)
} else if let Some(friends) = input.get("friends") {
StreamMessage::FriendList(
serde_json::from_value(friends.clone())
.map_err(|e| D::Error::custom(format!("{}", e)))?,
)
// TODO remove clone?
} else if let Ok(tweet) = serde_json::from_value::<Tweet>(input.clone()) {
StreamMessage::Tweet(tweet)
} else {
StreamMessage::Unknown(input.clone())
};
Ok(msg)
}
}
impl FromStr for StreamMessage {
type Err = error::Error;
fn from_str(input: &str) -> Result<Self, error::Error> {
let input = input.trim();
if input.is_empty() {
Ok(StreamMessage::Ping)
} else {
Ok(serde_json::from_str(input)?)
}
}
}
/// A `Stream` that represents a connection to the Twitter Streaming API.
#[must_use = "Streams are lazy and do nothing unless polled"]
pub struct TwitterStream {
buf: Vec<u8>,
request: Option<Request<Body>>,
response: Option<ResponseFuture>,
body: Option<Body>,
}
impl TwitterStream {
pub(crate) fn new(request: Request<Body>) -> TwitterStream {
TwitterStream {
buf: vec![],
request: Some(request),
response: None,
body: None,
}
}
}
impl Stream for TwitterStream {
type Item = Result<StreamMessage, error::Error>;
fn poll_next(mut self: Pin<&mut Self>, cx: &mut Context) -> Poll<Option<Self::Item>> {
if let Some(req) = self.request.take() {
self.response = Some(get_response(req));
}
if let Some(mut resp) = self.response.take() {
match Pin::new(&mut resp).poll(cx) {
Poll::Pending => {
self.response = Some(resp);
return Poll::Pending;
}
Poll::Ready(Err(e)) => return Poll::Ready(Some(Err(e.into()))),
Poll::Ready(Ok(resp)) => {
let status = resp.status();
if !status.is_success() {
//TODO: should i try to pull the response regardless?
return Poll::Ready(Some(Err(error::Error::BadStatus(status))));
}
self.body = Some(resp.into_body());
}
}
}
if let Some(mut body) = self.body.take() {
loop {
match Pin::new(&mut body).poll_next(cx) {
Poll::Pending => {
self.body = Some(body);
return Poll::Pending;
}
Poll::Ready(None) => {
return Poll::Ready(None);
}
Poll::Ready(Some(Err(e))) => {
self.body = Some(body);
return Poll::Ready(Some(Err(e.into())));
}
Poll::Ready(Some(Ok(chunk))) => {
self.buf.extend(&*chunk);
if let Some(pos) = self.buf.windows(2).position(|w| w == b"\r\n") {
self.body = Some(body);
let pos = pos + 2;
let resp = if let Ok(msg_str) = std::str::from_utf8(&self.buf[..pos]) {
StreamMessage::from_str(msg_str)
} else {
Err(io::Error::new(
io::ErrorKind::InvalidData,
"stream did not contain valid UTF-8",
)
.into())
};
self.buf.drain(..pos);
return Poll::Ready(Some(Ok(resp?)));
}
}
}
}
} else {
Poll::Ready(Some(Err(error::Error::FutureAlreadyCompleted)))
}
}
}
/// Represents the amount of filtering that can be done to streams on Twitter's side.
///
/// According to Twitter's documentation, "When displaying a stream of Tweets to end users
/// (dashboards or live feeds at a presentation or conference, for example) it is suggested that
/// you set this value to medium."
#[derive(Copy, Clone, Debug, Deserialize, Serialize)]
pub enum FilterLevel {
/// No filtering.
#[serde(rename = "none")]
None,
/// A light amount of filtering.
#[serde(rename = "low")]
Low,
/// A medium amount of filtering.
#[serde(rename = "medium")]
Medium,
}
/// `Display` impl to turn `FilterLevel` variants into the form needed for stream parameters. This
/// is basically "the variant name, in lowercase".
// TODO Probably can remove this somehow
impl ::std::fmt::Display for FilterLevel {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
match *self {
FilterLevel::None => write!(f, "none"),
FilterLevel::Low => write!(f, "low"),
FilterLevel::Medium => write!(f, "medium"),
}
}
}
/// Represents a `TwitterStream` before it is started. Use the various methods to build
/// up the filters on your stream.
///
/// Bear in mind that the `track`, `follow` and `locations` filters are `OR`ed rather than `AND`ed
/// together. E.g. if you specify a user id to follow and a phrase to track, you will receive
/// all tweets that match (user id OR phrase), NOT (user id AND phrase).
/// For more details see the [official docs](https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/basic-stream-parameters)
///
/// __Note__: The user __must__ specify at least one `track`, `follow` or `locations` filter or else
/// the stream will __fail__ at point of connection.
pub struct StreamBuilder {
url: &'static str,
follow: Vec<u64>,
track: Vec<String>,
language: Vec<String>,
locations: Vec<BoundingBox>,
filter_level: Option<FilterLevel>,
}
impl StreamBuilder {
fn new(url: &'static str) -> Self {
StreamBuilder {
url,
follow: Vec::new(),
track: Vec::new(),
language: Vec::new(),
locations: Vec::new(),
filter_level: None,
}
}
/// Filter stream to only return Tweets relating to given user IDs.
/// ### Example
/// ```rust,no_run
/// # fn main() {
/// # let token: egg_mode::Token = unimplemented!();
/// use egg_mode::stream::filter;
/// let stream = filter()
/// // View tweets related to BBC news, the Guardian and the New York Times
/// .follow(&[612473, 87818409, 807095])
/// .start(&token);
/// # }
/// ```
pub fn follow(mut self, to_follow: &[u64]) -> Self {
self.follow.extend(to_follow.iter());
self
}
/// Filter stream to only return Tweets containing given phrases.
///
/// A phrase may be one or more terms separated by spaces, and a phrase will match if all
/// of the terms in the phrase are present in the Tweet, regardless of order and ignoring case.
pub fn track<I: IntoIterator<Item = S>, S: AsRef<str>>(mut self, to_track: I) -> Self {
self.track
.extend(to_track.into_iter().map(|s| s.as_ref().to_string()));
self
}
/// Filter stream to only return Tweets that have been detected as being written
/// in the specified languages.
///
/// Languages are specified as a list of
/// [BCP 47](http://tools.ietf.org/html/bcp47) language identifiers
/// corresponding to any of the languages listed on Twitter’s
/// [advanced search](https://twitter.com/search-advancedpage) page.
///
/// __Note__ This library does __not__ validate the language codes.
pub fn language<I: IntoIterator<Item = S>, S: AsRef<str>>(mut self, languages: I) -> Self {
self.language
.extend(languages.into_iter().map(|s| s.as_ref().to_string()));
self
}
/// A list of bounding boxes by which to filter Tweets
///
/// ### Example
/// ```rust,no_run
/// # fn main() {
/// # let token: egg_mode::Token = unimplemented!();
/// use egg_mode::stream::{filter, BoundingBox};
/// let stream = filter()
/// // Only show tweets sent from New York
/// .locations(&[BoundingBox::new((-74.0,40.0),(-73.0,41.0))])
/// .start(&token);
/// # }
/// ```
pub fn locations(mut self, locations: &[BoundingBox]) -> Self {
self.locations.extend(locations.iter());
self
}
/// Applies the given `FilterLevel` to the stream. Tweets with a `filter_level` below the given
/// value will not be shown in the stream.
///
/// When displaying a stream of Tweets to end users
/// (dashboards or live feeds at a presentation or conference, for example) it is suggested
/// that you set this value to medium.
pub fn filter_level(self, filter_level: FilterLevel) -> StreamBuilder {
StreamBuilder {
filter_level: Some(filter_level),
..self
}
}
/// Finalizes the stream parameters and returns the resulting `TwitterStream`.
pub fn start(self, token: &Token) -> TwitterStream {
// Re connection failure, arguably this library should check that either 'track' or
// 'follow' exist and return an error if not. However, in such a case the request is not
// 'invalid' from POV of twitter api, rather it is invalid at the application level.
// So I think the current behaviour make sense.
let mut params =
ParamList::new().add_opt_param("filter_level", self.filter_level.map_string());
if !self.follow.is_empty() {
let to_follow = self
.follow
.iter()
.map(|id| id.to_string())
.collect::<Vec<String>>()
.join(",");
params.add_param_ref("follow", to_follow);
}
if !self.track.is_empty() {
let to_track = self.track.join(",");
params.add_param_ref("track", to_track);
}
if !self.language.is_empty() {
let langs = self.language.join(",");
params.add_param_ref("language", langs);
}
if !self.locations.is_empty() {
let locs = self
.locations
.iter()
.map(|bb| bb.to_string())
.collect::<Vec<String>>()
.join(",");
params.add_param_ref("locations", locs);
}
let req = post(self.url, token, Some(¶ms));
TwitterStream::new(req)
}
}
/// Begins building a request to a filtered public stream.
pub fn filter() -> StreamBuilder {
StreamBuilder::new(links::stream::FILTER)
}
/// Opens a `TwitterStream` returning "a small random sample of all public statuses".
///
/// As sample streams don't have the same configuration options as filter streams,
/// this directly returns a `TwitterStream`, rather than going through a [`StreamBuilder`]. To apply
/// filter options on the public stream, start with [`filter`] and add parameters to the
/// [`StreamBuilder`] returned there.
///
/// [`StreamBuilder`]: struct.StreamBuilder.html
/// [`filter`]: fn.filter.html
pub fn sample(token: &Token) -> TwitterStream {
let req = get(links::stream::SAMPLE, token, None);
TwitterStream::new(req)
}
#[derive(Debug, Clone, Copy, PartialEq, PartialOrd)]
/// Represents a bounding box of (longitude, latitude) pairs.
///
/// Guaranteed to be in-bounds.
pub struct BoundingBox {
southwest: (f64, f64),
northeast: (f64, f64),
}
impl ::std::fmt::Display for BoundingBox {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
write!(
f,
"{},{},{},{}",
self.southwest.0, self.southwest.1, self.northeast.0, self.northeast.1
)
}
}
impl BoundingBox {
/// New BoundingBox. Expects (logitude, latitude pairs) describing the southwest and
/// northeast points of the bounding box. Checks the values are in-bounds.
pub fn new(southwest: (f64, f64), northeast: (f64, f64)) -> BoundingBox {
// TODO integrate with `bounding_box` in `place` module.
// TODO check consitency
BoundingBox {
southwest,
northeast,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::common::tests::load_file;
fn load_stream(path: &str) -> StreamMessage {
let sample = load_file(path);
::serde_json::from_str(&sample).unwrap()
}
#[test]
fn parse_tweet_stream() {
let msg = load_stream("sample_payloads/sample-stream.json");
if let StreamMessage::Tweet(_tweet) = msg {
// OK
} else {
panic!("Not a tweet")
}
}
#[test]
fn parse_empty_stream() {
let msg = StreamMessage::from_str("").unwrap();
if let StreamMessage::Ping = msg {
// OK
} else {
panic!("Not a ping")
}
}
}