44 releases

0.8.0-rc.1 May 29, 2024
0.7.0 Jul 19, 2023
0.7.0-rc.1 Jun 12, 2023
0.3.2 Mar 30, 2023
0.1.16 Jul 27, 2021

#50 in Web programming

Download history 2825/week @ 2024-03-14 2626/week @ 2024-03-21 2616/week @ 2024-03-28 3083/week @ 2024-04-04 2546/week @ 2024-04-11 3328/week @ 2024-04-18 3566/week @ 2024-04-25 3365/week @ 2024-05-02 2697/week @ 2024-05-09 2892/week @ 2024-05-16 2524/week @ 2024-05-23 2842/week @ 2024-05-30 2796/week @ 2024-06-06 3152/week @ 2024-06-13 1715/week @ 2024-06-20 1449/week @ 2024-06-27

9,744 downloads per month
Used in 4 crates (3 directly)

MIT license

2.5MB
55K SLoC

octorust

A fully generated, opinionated API client library for GitHub.

docs.rs

API Details

GitHub's v3 REST API.

API Terms of Service

Contact

name url
Support https://support.github.com/contact?tags=rest-api

License

name url
MIT https://spdx.org/licenses/MIT

Client Details

This client is generated from the GitHub OpenAPI specs based on API spec version 1.1.4. This way it will remain up to date as features are added. The documentation for the crate is generated along with the code to make this library easy to use.

To install the library, add the following to your Cargo.toml file.

[dependencies]
octorust = "0.8.0-rc.1"

Basic example

Typical use will require intializing a Client. This requires a user agent string and set of auth::Credentials.

use octorust::{auth::Credentials, Client};

let github = Client::new(
  String::from("user-agent-name"),
  Credentials::Token(
    String::from("personal-access-token")
  ),
);

If you are a GitHub enterprise customer, you will want to create a client with the Client#host_override method.

Feature flags

httpcache

Github supports conditional HTTP requests using etags to checksum responses Experimental support for utilizing this to cache responses locally with the httpcache feature flag.

To enable this, add the following to your Cargo.toml file:

[dependencies]
octorust = { version = "0.8.0-rc.1", features = ["httpcache"] }

Then use the Client::custom constructor to provide a cache implementation.

Here is an example:

use octorust::{auth::Credentials, Client};
#[cfg(feature = "httpcache")]
use octorust::http_cache::HttpCache;

#[cfg(feature = "httpcache")]
let http_cache = HttpCache::in_home_dir();

#[cfg(not(feature = "httpcache"))]
let github = Client::custom(
    concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
    Credentials::Token(
      String::from("personal-access-token")
    ),
    reqwest::Client::builder().build().unwrap(),
);

#[cfg(feature = "httpcache")]
let github = Client::custom(
    concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
    Credentials::Token(
      String::from("personal-access-token")
    ),
    reqwest::Client::builder().build().unwrap(),
    http_cache
);

Authenticating GitHub apps

You can also authenticate via a GitHub app.

Here is an example:

use std::env;

use octorust::{Client, auth::{Credentials, InstallationTokenGenerator, JWTCredentials}};
#[cfg(feature = "httpcache")]
use octorust::http_cache::FileBasedCache;
use base64::{Engine, engine::general_purpose::STANDARD};

let app_id_str = env::var("GH_APP_ID").unwrap();
let app_id = app_id_str.parse::<u64>().unwrap();

let app_installation_id_str = env::var("GH_INSTALLATION_ID").unwrap();
let app_installation_id = app_installation_id_str.parse::<u64>().unwrap();

let encoded_private_key = env::var("GH_PRIVATE_KEY").unwrap();
let private_key = STANDARD.decode(encoded_private_key).unwrap();

// Decode the key.
let key = nom_pem::decode_block(&private_key).unwrap();

// Get the JWT credentials.
let jwt = JWTCredentials::new(app_id, key.data).unwrap();

// Create the HTTP cache.
#[cfg(feature = "httpcache")]
let mut dir = dirs::home_dir().expect("Expected a home dir");
#[cfg(feature = "httpcache")]
dir.push(".cache/github");
#[cfg(feature = "httpcache")]
let http_cache = Box::new(FileBasedCache::new(dir));

let token_generator = InstallationTokenGenerator::new(app_installation_id, jwt);

#[cfg(not(feature = "httpcache"))]
let github = Client::custom(
    concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
    Credentials::InstallationToken(token_generator),
    reqwest::Client::builder().build().unwrap(),
);

#[cfg(feature = "httpcache")]
let github = Client::custom(
    concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION")),
    Credentials::InstallationToken(token_generator),
    reqwest::Client::builder().build().unwrap(),
    http_cache,
);

Acknowledgements

Shout out to hubcaps for paving the way here. This extends that effort in a generated way so the library is always up to the date with the OpenAPI spec and no longer requires manual contributions to add new endpoints.

Dependencies

~16–34MB
~597K SLoC