twapi-v2-rs

Twitter API v2 library.

Documentation

• Request builder
• Retrive response headers
• Convenience setted parameter methods
• Bearer authentication(OAuth 2.0 Authorization Code Flow with PKCE)
• OAuth1.0a authentication(OAuth 1.0a User Contex)
• Upload Media upload.twitter.com apis
• Optional retriable and timeout and logging
• Optional OAuth with web example
• Optional v1 to v2 parser
• Streaming example
• Supported mocks. For example, mockito.
• Experimental type support.

Features

default

• reqwest/default-tls

rustls-tls

• reqwest/rustls-tls

retry

• Retriable
• Timeout
• Logging

oauth

• Twitter OAuth

oauth10a

• Use api by OAuth1.0a

models

• From v1 to v2

upload

• Upload Media

Changes

CHANGELOG.md

Test status

TEST.md

Examples

API(bearer)

use twapi_v2::api::{get_2_tweets_id, BearerAuthentication};

#[tokio::main]
async fn main() {
    let bearer_code = std::env::var("BEARER_CODE").unwrap();
    let auth = BearerAuthentication::new(bearer_code);
    let tweet_id = std::env::var("TWEET_ID").unwrap();
    let res = get_2_tweets_id::Api::open(&tweet_id)
        .execute(&auth)
        .await;
    if let Some((val, headers)) = res {
        println!("{:?}", val);
        println!("{}", headers);
    }
}

API(OAuth1.0a)

use twapi_v2::api::{get_2_tweets_id, BearerAuthentication};
use twapi_v2::oauth10a::OAuthAuthentication;

#[tokio::main]
async fn main() {
    let auth = OAuthAuthentication::new(
        std::env::var("CONSUMER_KEY").unwrap_or_default(),
        std::env::var("CONSUMER_SECRET").unwrap_or_default(),
        std::env::var("ACCESS_KEY").unwrap_or_default(),
        std::env::var("ACCESS_SECRET").unwrap_or_default(),
    );
    let tweet_id = std::env::var("TWEET_ID").unwrap();
    let res = get_2_tweets_id::Api::open(&tweet_id)
        .execute(&auth)
        .await;
    if let Some((val, headers)) = res {
        println!("{:?}", val);
        println!("{}", headers);
    }
}

V1 parse

use std::{fs::File, io::{Read, Write}};
use twapi_v2::models::TweetModel;

#[tokio::main]
async fn main() {
    let mut file = File::open("samples/v1_tweet.json").unwrap();
    let mut data = String::new();
    file.read_to_string(&mut data).unwrap();
    let src = serde_json::from_str::<serde_json::Value>(&data).unwrap();
    let res = TweetModel::from_v1(&src);
    let mut file = File::create("result.json").unwrap();
    write!(file, "{}", serde_json::to_string_pretty(&res).unwrap()).unwrap();
    file.flush().unwrap();
}

Upload Media

use twapi_v2::{
    oauth10a::OAuthAuthentication,
    upload::{self, media_category::MediaCategory},
};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let auth = OAuthAuthentication::new(
        std::env::var("CONSUMER_KEY").unwrap_or_default(),
        std::env::var("CONSUMER_SECRET").unwrap_or_default(),
        std::env::var("ACCESS_KEY").unwrap_or_default(),
        std::env::var("ACCESS_SECRET").unwrap_or_default(),
    );
    let response = upload::upload_media(
        &std::path::PathBuf::from("test.jpg"),
        "image/jpeg",
        Some(MediaCategory::TweetImage),
        None,
        &auth,
    )
    .await?;
    println!("{:?}", response);
    Ok(())
}

Twitter OAuth Web

cd examples/oauth-web
API_KEY_CODE=XXXX API_SECRET_CODE=XXXX CALLBACK_URL=http://localhost:3000/oauth cargo run

http://localhost:3000/

Streaming

cd examples/streaming
BEARER_CODE=XXXXX cargo run

Mock(Use mockito)

#[tokio::test]
async fn test_mock_get_2_tweets_search_recent_oauth() -> Result<()> {
    let mut server = Server::new_async().await;
    api::setup_prefix_url(&server.url());

    let mock = server
        .mock("GET", "/2/tweets/search/recent")
        .match_query(mockito::Matcher::Any)
        .with_status(200)
        .with_header("content-type", "application/json")
        .with_body("{ \"origin\": \"0.0.0.0\" }")
        .create_async()
        .await;

    let auth = OAuthAuthentication::new(
        std::env::var("CONSUMER_KEY").unwrap_or_default(),
        std::env::var("CONSUMER_SECRET").unwrap_or_default(),
        std::env::var("ACCESS_KEY").unwrap_or_default(),
        std::env::var("ACCESS_SECRET").unwrap_or_default(),
    );
    let builder = get_2_tweets_search_recent::Api::open("東京")
        .max_results(10)
        .build(&auth);
    let (res, _headers) = execute_twitter::<get_2_tweets_search_recent::Response>(builder).await?;
    assert_eq!(res.extra.get("origin"), Some(&json!("0.0.0.0")));
    mock.assert();
    Ok(())
}