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
// 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/. use std::collections::HashMap; use common::*; use auth; use links; use cursor; use super::*; //---Groups of users--- /// Look up profile information for several Twitter users. /// /// This function is set up so it can be called with a few different Item types; whether just IDs /// with `u64`, just screen names with `&str` or `String`, or even a mix of both (by using `UserID` /// directly). /// /// ## Examples /// /// ```rust,no_run /// # extern crate egg_mode; extern crate tokio_core; extern crate futures; /// # use egg_mode::Token; use tokio_core::reactor::{Core, Handle}; /// # fn main() { /// # let (token, mut core, handle): (Token, Core, Handle) = unimplemented!(); /// let mut list: Vec<u64> = Vec::new(); /// /// list.push(1234); /// list.push(2345); /// /// let users = core.run(egg_mode::user::lookup(&list, &token, &handle)).unwrap(); /// # } /// ``` /// /// ```rust,no_run /// # extern crate egg_mode; extern crate tokio_core; extern crate futures; /// # use egg_mode::Token; use tokio_core::reactor::{Core, Handle}; /// # fn main() { /// # let (token, mut core, handle): (Token, Core, Handle) = unimplemented!(); /// let mut list: Vec<&str> = Vec::new(); /// /// list.push("rustlang"); /// list.push("ThisWeekInRust"); /// /// let users = core.run(egg_mode::user::lookup(&list, &token, &handle)).unwrap(); /// # } /// ``` /// /// ```rust,no_run /// # extern crate egg_mode; extern crate tokio_core; extern crate futures; /// # use egg_mode::Token; use tokio_core::reactor::{Core, Handle}; /// # fn main() { /// # let (token, mut core, handle): (Token, Core, Handle) = unimplemented!(); /// let mut list: Vec<String> = Vec::new(); /// /// list.push("rustlang".to_string()); /// list.push("ThisWeekInRust".to_string()); /// /// let users = core.run(egg_mode::user::lookup(&list, &token, &handle)).unwrap(); /// # } /// ``` /// /// ```rust,no_run /// # extern crate egg_mode; extern crate tokio_core; extern crate futures; /// # use egg_mode::Token; use tokio_core::reactor::{Core, Handle}; /// # fn main() { /// # let (token, mut core, handle): (Token, Core, Handle) = unimplemented!(); /// let mut list: Vec<egg_mode::user::UserID> = Vec::new(); /// /// list.push(1234.into()); /// list.push("rustlang".into()); /// /// let users = core.run(egg_mode::user::lookup(&list, &token, &handle)).unwrap(); /// # } /// ``` pub fn lookup<'a, 'h, T, I>(accts: I, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, Vec<TwitterUser>> where T: Into<UserID<'a>>, I: IntoIterator<Item=T> { let mut params = HashMap::new(); let (id_param, name_param) = multiple_names_param(accts); add_param(&mut params, "user_id", id_param); add_param(&mut params, "screen_name", name_param); let req = auth::post(links::users::LOOKUP, token, Some(¶ms)); make_parsed_future(handle, req) } /// Lookup user information for a single user. pub fn show<'a, 'h, T: Into<UserID<'a>>>(acct: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); let req = auth::get(links::users::SHOW, token, Some(¶ms)); make_parsed_future(handle, req) } /// Lookup the user IDs that the authenticating user has disabled retweets from. /// /// Use `update_follow` to enable/disable viewing retweets from a specific user. pub fn friends_no_retweets<'a>(token: &auth::Token, handle: &'a Handle) -> FutureResponse<'a, Vec<u64>> { let req = auth::get(links::users::FRIENDS_NO_RETWEETS, token, None); make_parsed_future(handle, req) } /// Lookup relationship settings between two arbitrary users. pub fn relation<'a, 'h, F, T>(from: F, to: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, Relationship> where F: Into<UserID<'a>>, T: Into<UserID<'a>> { let mut params = HashMap::new(); match from.into() { UserID::ID(id) => add_param(&mut params, "source_id", id.to_string()), UserID::ScreenName(name) => add_param(&mut params, "source_screen_name", name), }; match to.into() { UserID::ID(id) => add_param(&mut params, "target_id", id.to_string()), UserID::ScreenName(name) => add_param(&mut params, "target_screen_name", name), }; let req = auth::get(links::users::FRIENDSHIP_SHOW, token, Some(¶ms)); make_parsed_future(handle, req) } /// Lookup the relations between the authenticated user and the given accounts. pub fn relation_lookup<'a, 'h, T, I>(accts: I, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, Vec<RelationLookup>> where T: Into<UserID<'a>>, I: IntoIterator<Item=T> { let mut params = HashMap::new(); let (id_param, name_param) = multiple_names_param(accts); add_param(&mut params, "user_id", id_param); add_param(&mut params, "screen_name", name_param); let req = auth::get(links::users::FRIENDSHIP_LOOKUP, token, Some(¶ms)); make_parsed_future(handle, req) } //---Cursored collections--- /// Lookup users based on the given search term. /// /// This function returns a stream over the `TwitterUser` objects returned by Twitter. Due to a /// limitation in the API, you can only obtain the first 1000 search results. This method defaults /// to returning 10 users in a single network call; the maximum is 20. See the [`UserSearch`][] /// page for details. /// /// [`UserSearch`]: struct.UserSearch.html pub fn search<'a>(query: &'a str, token: &'a auth::Token, handle: &'a Handle) -> UserSearch<'a> { UserSearch::new(query, token, handle) } /// Lookup the users a given account follows, also called their "friends" within the API. /// /// This function returns a stream over the `TwitterUser` objects returned by Twitter. This /// method defaults to returning 20 users in a single network call; the maximum is 200. pub fn friends_of<'a, T: Into<UserID<'a>>>(acct: T, token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::UserCursor> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); cursor::CursorIter::new(links::users::FRIENDS_LIST, token, handle, Some(params), Some(20)) } /// Lookup the users a given account follows, also called their "friends" within the API, but only /// return their user IDs. /// /// This function returns a stream over the User IDs returned by Twitter. This method defaults to /// returning 500 IDs in a single network call; the maximum is 5000. /// /// Choosing only to load the user IDs instead of the full user information results in a call that /// can return more accounts per-page, which can be useful if you anticipate having to page through /// several results and don't need all the user information. pub fn friends_ids<'a, T: Into<UserID<'a>>>(acct: T, token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::IDCursor> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); cursor::CursorIter::new(links::users::FRIENDS_IDS, token, handle, Some(params), Some(500)) } /// Lookup the users that follow a given account. /// /// This function returns a stream over the `TwitterUser` objects returned by Twitter. This /// method defaults to returning 20 users in a single network call; the maximum is 200. pub fn followers_of<'a, T: Into<UserID<'a>>>(acct: T, token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::UserCursor> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); cursor::CursorIter::new(links::users::FOLLOWERS_LIST, token, handle, Some(params), Some(20)) } /// Lookup the users that follow a given account, but only return their user IDs. /// /// This function returns a stream over the User IDs returned by Twitter. This method defaults to /// returning 500 IDs in a single network call; the maximum is 5000. /// /// Choosing only to load the user IDs instead of the full user information results in a call that /// can return more accounts per-page, which can be useful if you anticipate having to page through /// several results and don't need all the user information. pub fn followers_ids<'a, T: Into<UserID<'a>>>(acct: T, token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::IDCursor> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); cursor::CursorIter::new(links::users::FOLLOWERS_IDS, token, handle, Some(params), Some(500)) } /// Lookup the users that have been blocked by the authenticated user. /// /// Note that while loading a user's blocks list is a cursored search, it does not allow you to set /// the page size. Calling `with_page_size` on a stream returned by this function will not /// change the page size used by the network call. Setting `page_size` manually may result in an /// error from Twitter. pub fn blocks<'a>(token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::UserCursor> { cursor::CursorIter::new(links::users::BLOCKS_LIST, token, handle, None, None) } /// Lookup the users that have been blocked by the authenticated user, but only return their user /// IDs. /// /// Choosing only to load the user IDs instead of the full user information results in a call that /// can return more accounts per-page, which can be useful if you anticipate having to page through /// several results and don't need all the user information. /// /// Note that while loading a user's blocks list is a cursored search, it does not allow you to set /// the page size. Calling `with_page_size` on a stream returned by this function will not /// change the page size used by the network call. Setting `page_size` manually may result in an /// error from Twitter. pub fn blocks_ids<'a>(token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::IDCursor> { cursor::CursorIter::new(links::users::BLOCKS_IDS, token, handle, None, None) } /// Lookup the users that have been muted by the authenticated user. /// /// Note that while loading a user's mutes list is a cursored search, it does not allow you to set /// the page size. Calling `with_page_size` on a stream returned by this function will not /// change the page size used by the network call. Setting `page_size` manually may result in an /// error from Twitter. pub fn mutes<'a>(token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::UserCursor> { cursor::CursorIter::new(links::users::MUTES_LIST, token, handle, None, None) } /// Lookup the users that have been muted by the authenticated user, but only return their user IDs. /// /// Choosing only to load the user IDs instead of the full user information results in a call that /// can return more accounts per-page, which can be useful if you anticipate having to page through /// several results and don't need all the user information. /// /// Note that while loading a user's mutes list is a cursored search, it does not allow you to set /// the page size. Calling `with_page_size` on a stream returned by this function will not /// change the page size used by the network call. Setting `page_size` manually may result in an /// error from Twitter. pub fn mutes_ids<'a>(token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::IDCursor> { cursor::CursorIter::new(links::users::MUTES_IDS, token, handle, None, None) } /// Lookup the user IDs who have pending requests to follow the authenticated protected user. /// /// If the authenticated user is not a protected account, this will return an empty collection. pub fn incoming_requests<'a>(token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::IDCursor> { cursor::CursorIter::new(links::users::FRIENDSHIPS_INCOMING, token, handle, None, None) } /// Lookup the user IDs with which the authenticating user has a pending follow request. pub fn outgoing_requests<'a>(token: &'a auth::Token, handle: &'a Handle) -> cursor::CursorIter<'a, cursor::IDCursor> { cursor::CursorIter::new(links::users::FRIENDSHIPS_OUTGOING, token, handle, None, None) } //---User actions--- /// Follow the given account with the authenticated user, and set whether device notifications /// should be enabled. /// /// Upon success, the future returned by this function yields the user that was just followed, even /// when following a protected account. In the latter case, this indicates that the follow request /// was successfully sent. /// /// Calling this with an account the user already follows may return an error, or ("for performance /// reasons") may return success without changing any account settings. pub fn follow<'a, 'h, T: Into<UserID<'a>>>(acct: T, notifications: bool, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); add_param(&mut params, "follow", notifications.to_string()); let req = auth::post(links::users::FOLLOW, token, Some(¶ms)); make_parsed_future(handle, req) } /// Unfollow the given account with the authenticated user. /// /// Upon success, the future returned by this function yields the user that was just unfollowed. /// /// Calling this with an account the user doesn't follow will return success, even though it doesn't /// change any settings. pub fn unfollow<'a, 'h, T: Into<UserID<'a>>>(acct: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); let req = auth::post(links::users::UNFOLLOW, token, Some(¶ms)); make_parsed_future(handle, req) } /// Update notification settings and reweet visibility for the given user. /// /// Calling this for an account the authenticated user does not already follow will not cause them /// to follow that user. It will return an error if you pass `Some(true)` for `notifications` or /// `Some(false)` for `retweets`. Any other combination of arguments will return a `Relationship` as /// if you had called `relation` between the authenticated user and the given user. pub fn update_follow<'a, 'h, T>(acct: T, notifications: Option<bool>, retweets: Option<bool>, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, Relationship> where T: Into<UserID<'a>> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); if let Some(notifications) = notifications { add_param(&mut params, "device", notifications.to_string()); } if let Some(retweets) = retweets { add_param(&mut params, "retweets", retweets.to_string()); } let req = auth::post(links::users::FRIENDSHIP_UPDATE, token, Some(¶ms)); make_parsed_future(handle, req) } /// Block the given account with the authenticated user. /// /// Upon success, the future returned by this function yields the given user. pub fn block<'a, 'h, T: Into<UserID<'a>>>(acct: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); let req = auth::post(links::users::BLOCK, token, Some(¶ms)); make_parsed_future(handle, req) } /// Block the given account and report it for spam, with the authenticated user. /// /// Upon success, the future returned by this function yields the given user. pub fn report_spam<'a, 'h, T: Into<UserID<'a>>>(acct: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); let req = auth::post(links::users::REPORT_SPAM, token, Some(¶ms)); make_parsed_future(handle, req) } /// Unblock the given user with the authenticated user. /// /// Upon success, the future returned by this function yields the given user. pub fn unblock<'a, 'h, T: Into<UserID<'a>>>(acct: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); let req = auth::post(links::users::UNBLOCK, token, Some(¶ms)); make_parsed_future(handle, req) } /// Mute the given user with the authenticated user. /// /// Upon success, the future returned by this function yields the given user. pub fn mute<'a, 'h, T: Into<UserID<'a>>>(acct: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); let req = auth::post(links::users::MUTE, token, Some(¶ms)); make_parsed_future(handle, req) } /// Unmute the given user with the authenticated user. /// /// Upon success, the future returned by this function yields the given user. pub fn unmute<'a, 'h, T: Into<UserID<'a>>>(acct: T, token: &auth::Token, handle: &'h Handle) -> FutureResponse<'h, TwitterUser> { let mut params = HashMap::new(); add_name_param(&mut params, &acct.into()); let req = auth::post(links::users::UNMUTE, token, Some(¶ms)); make_parsed_future(handle, req) }