13 releases

0.5.1 Jun 19, 2024
0.5.0 Jun 12, 2022
0.4.2 Dec 8, 2021
0.4.1 Oct 21, 2020
0.2.0 Dec 2, 2018

#57 in #o-auth

Download history 2807/week @ 2024-07-09 1364/week @ 2024-07-16 729/week @ 2024-07-23 902/week @ 2024-07-30 1012/week @ 2024-08-06 1151/week @ 2024-08-13 621/week @ 2024-08-20 816/week @ 2024-08-27 759/week @ 2024-09-03 582/week @ 2024-09-10 843/week @ 2024-09-17 856/week @ 2024-09-24 532/week @ 2024-10-01 729/week @ 2024-10-08 589/week @ 2024-10-15 834/week @ 2024-10-22

2,774 downloads per month
Used in 3 crates (2 directly)

MIT/Apache

31KB
733 lines

oauth1-request

Build Status Current Version Documentation

Yet yet yet another OAuth 1.0 client library for Rust.

Usage

Add this to your Cargo.toml:

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

A typical authorization flow looks like this:

// Define a type to represent your request.
#[derive(oauth::Request)]
struct CreateComment<'a> {
    article_id: u64,
    text: &'a str,
}

let uri = "https://example.com/api/v1/comments/create.json";

let request = CreateComment {
    article_id: 123456789,
    text: "A request signed with OAuth & Rust 🦀 🔏",
};

// Prepare your credentials.
let token =
    oauth::Token::from_parts("consumer_key", "consumer_secret", "token", "token_secret");

// Create the `Authorization` header.
let authorization_header = oauth::post(uri, &request, &token, oauth::HmacSha1);
// `oauth_nonce` and `oauth_timestamp` vary on each execution.
assert_eq!(
    authorization_header,
    "OAuth \
         oauth_consumer_key=\"consumer_key\",\
         oauth_nonce=\"Dk-OGluFEQ4f\",\
         oauth_signature_method=\"HMAC-SHA1\",\
         oauth_timestamp=\"1234567890\",\
         oauth_token=\"token\",\
         oauth_signature=\"n%2FrUgos4CFFZbZK8Z8wFR7drU4c%3D\"",
);

// You can create an `x-www-form-urlencoded` string or a URI with query pairs from the request.

let form = oauth::to_form(&request);
assert_eq!(
    form,
    "article_id=123456789&text=A%20request%20signed%20with%20OAuth%20%26%20Rust%20%F0%9F%A6%80%20%F0%9F%94%8F",
);

let uri = oauth::to_query(uri.to_owned(), &request);
assert_eq!(
    uri,
    "https://example.com/api/v1/comments/create.json?article_id=123456789&text=A%20request%20signed%20with%20OAuth%20%26%20Rust%20%F0%9F%A6%80%20%F0%9F%94%8F",
);

lib.rs:

This crate provides a derive macro for oauth1_request::Request:

#[derive(oauth::Request)]

oauth1_request crate re-exports the derive macro if the derive feature of the crate is enabled (which is on by default). You should use the re-export instead of depending on this crate directly.

Dependencies

~1.4–2MB
~41K SLoC