ronlobo / egg-mode

a twitter api crate for rust

egg-mode

Twitter library for Rust

Documentation

This is a library for interacting with Twitter from Rust. You can see how much of the Public API is available in the file TODO.md. In addition to eventually implementing the entire Public API, an explicit goal for egg-mode is to make it as easy as possible for a client of this library to interact with the Twitter API. Parts of this library are added as a convenience on top of the API mechanisms; for example, cursored lists of users and tweets can be used as an iterator in addition to being able to manually load a page at a time.

Starting in version v0.14, egg-mode uses the async/await syntax and therefore requires Rust v1.39.0+.

NOTE: Previous versions of egg-mode contained a port of twitter-text to use for character counting and mention/hashtag/url extraction. That has since been extracted into its own crate, egg-mode-text.

To start using this library, put the following into your Cargo.toml:

[dependencies]
egg-mode = "0.15"

By default, egg-mode uses native-tls for encryption, but also supports rustls. This may be helpful if you wish to avoid linking against OpenSSL. To enable, modify your Cargo.toml entry:

egg-mode = { version = "0.15", features = ["rustls"], default-features = false }

If you also want to avoid using the root certificates on your operating system, the feature rustls_webpki can be used instead to enable rustls and compile the Mozilla root certificates into the final binary, bypassing the operating system's root certificates. To use this feature, put this in your Cargo.toml instead:

egg-mode = { version = "0.15", features = ["rustls_webpki"], default-features = false }

See available methods and tips to get started in the Documentation.

To authenticate a user and request an access token:

// NOTE: this assumes you are running inside an `async` function

let con_token = egg_mode::KeyPair::new("consumer key", "consumer secret");
// "oob" is needed for PIN-based auth; see docs for `request_token` for more info
let request_token = egg_mode::auth::request_token(&con_token, "oob").await.unwrap();
let auth_url = egg_mode::auth::authorize_url(&request_token);

// give auth_url to the user, they can sign in to Twitter and accept your app's permissions.
// they'll receive a PIN in return, they need to give this to your application

let verifier = "123456"; //read the PIN from the user here

// note this consumes con_token; if you want to sign in multiple accounts, clone it here
let (token, user_id, screen_name) =
    egg_mode::auth::access_token(con_token, &request_token, verifier).await.unwrap();

// token can be given to any egg_mode method that asks for a token
// user_id and screen_name refer to the user who signed in

As the last line shows, this also returns the User ID and username of the user that authenticated with your application. With this access token, all of the other Twitter functions become available.

With this token in hand, you can get a user's profile information like this:

let rustlang = egg_mode::user::show("rustlang", &token).await.unwrap();

println!("{} (@{})", rustlang.name, rustlang.screen_name);

For more examples of how to use this library, check the files in the examples folder. The authentication code for most of them is in examples/common/mod.rs, though that's also mostly wrapped up in code to write the access token to disk and load it back in. examples/bearer.rs is an example of using application-only authentication to get a Bearer token and use it to load a user's posts. Other examples showcase a handful of actions from their related module. To run any of the examples for yourself, see the notes in examples/common/mod.rs.

If you've found egg-mode useful, or just want to communicate your first impressions of it, please track me down on Twitter and let me know!

License

This library is licensed under the Mozilla Public License, version 2.0. See the LICENSE file for details.