#oauth #oauth1

oauth1-request

Yet yet yet another OAuth 1 client library

9 releases

✓ Uses Rust 2018 edition

0.3.0 Sep 5, 2019
0.2.6 Sep 5, 2019
0.2.5 Aug 19, 2019
0.2.1 Dec 2, 2018
0.1.2 Oct 18, 2018

#29 in Authentication

Download history 18/week @ 2019-10-12 85/week @ 2019-10-19 43/week @ 2019-10-26 57/week @ 2019-11-02 15/week @ 2019-11-09 79/week @ 2019-11-16 54/week @ 2019-11-23 57/week @ 2019-11-30 217/week @ 2019-12-07 34/week @ 2019-12-14 38/week @ 2019-12-21 42/week @ 2019-12-28 13/week @ 2020-01-04 219/week @ 2020-01-11 101/week @ 2020-01-18

250 downloads per month
Used in 3 crates

MIT/Apache

66KB
1.5K SLoC

oauth1-request

Build Status Current Version Documentation

Yet yet yet another OAuth 1 client library for Rust.

Usage

Add this to your Cargo.toml:

[dependencies]
oauth = { version = "0.3", package = "oauth1-request" }

Pros

  • Customizable crypto implementations (no dependency onring by default).
  • Slightly lower memory footprint (maybe): it avoids allocating memory for sorting query pairs unlike other crates.

Cons

  • Only dogfed on Twitter and likely to break on other sites.

lib.rs:

Yet yet yet another OAuth 1 client library.

Usage

Add this to your Cargo.toml:

[dependencies]
oauth = { version = "0.2", package = "oauth1-request" }

For brevity we refer to the crate name as oauth throughout the documentation.

Create a GET request

# extern crate oauth1_request as oauth;
#[derive(oauth::Authorize)]
struct SearchComments<'a> {
    article_id: u64,
    text: &'a str,
}

# fn main() {
let client = oauth::Credentials::new("consumer_key", "consumer_secret");
let token = oauth::Credentials::new("token", "token_secret");

let mut builder = oauth::Builder::new(client, oauth::HmacSha1);
builder
    .token(token)
    .nonce("nonce")
    .timestamp(9999999999);

let req = SearchComments {
    article_id: 123456789,
    text: "Rust",
};

let oauth::Request {
    authorization,
    data,
} = builder.get("https://example.com/api/v1/comments/search.json", &req);

assert_eq!(
    authorization,
    "OAuth \
         oauth_consumer_key=\"consumer_key\",\
         oauth_nonce=\"nonce\",\
         oauth_signature_method=\"HMAC-SHA1\",\
         oauth_timestamp=\"9999999999\",\
         oauth_token=\"token\",\
         oauth_signature=\"kAkbCLL7obDyzdjz3uJoWSwiLqU%3D\"",
);
assert_eq!(
    data,
    "https://example.com/api/v1/comments/search.json?article_id=123456789&text=Rust",
);
# }

Create an x-www-form-urlencoded request

# extern crate oauth1_request as oauth;
#[derive(oauth::Authorize)]
struct CreateComment<'a> {
    article_id: u64,
    text: &'a str,
}

# fn main() {
# let client = oauth::Credentials::new("consumer_key", "consumer_secret");
# let token = oauth::Credentials::new("token", "token_secret");
# let mut builder = oauth::Builder::new(client, oauth::HmacSha1);
# builder
#     .token(token)
#     .nonce("nonce")
#     .timestamp(9999999999);
let req = CreateComment {
    article_id: 123456789,
    text: "Rust lang is great 🦀",
};

// Use `post_form` method to create an `x-www-form-urlencoded` request.
let oauth::Request {
    authorization,
    data,
} = builder.post_form("https://example.com/api/v1/comments/create.json", &req);

assert_eq!(
    authorization,
    "OAuth \
         oauth_consumer_key=\"consumer_key\",\
         oauth_nonce=\"nonce\",\
         oauth_signature_method=\"HMAC-SHA1\",\
         oauth_timestamp=\"9999999999\",\
         oauth_token=\"token\",\
         oauth_signature=\"bbhEIrjfisdDBrZkKnEXKa4ykE4%3D\"",
);
assert_eq!(
    data,
    "article_id=123456789&text=Rust%20lang%20is%20great%20%F0%9F%A6%80",
);
# }

See Authorize for more details on the custom derive macro.

Dependencies

~0.5–1MB
~17K SLoC