heroku_rs

Intro

This crate is a API wrapper for the Heroku v3 API.

See the documentation for more information on which endpoints are covered by the crate.

Getting Started

Add the following to your Cargo.toml and run cargo build. Voila.

[dependencies]
heroku_rs = "0.4.2"

Here's a simple example which fetches the apps list. At the moment, the client is blocking by default. For more examples see the examples directory.

use heroku_rs::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let api_client = HttpApiClient::create("API_KEY")?;
    let response = api_client.request(&apps::AppList {});

    match response {
        Ok(success) => println!("Success: {:#?}", success),
        Err(e) => println!("Error: {}", e),
    }

    Ok(())
}

You can also call custom endpoints that have not been supported by the library yet. e.g. :

use heroku_rs::prelude::*;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let api_client = HttpApiClient::create("API_KEY")?;

    // This will do a GET request on https://api.heroku.com/apps/my_app_name_here
    let query = format!("{}{}", "apps/", "my_app_name_here");
    let method = Method::Get;
    let response = api_client.request(&custom::CustomEndpointSimple::new(query, method);

    Ok(())
}

See more examples on how to use these custom endpoints.

Useful links

Heroku quickstart

Heroku API reference

Generating a heroku API key

License

Licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Licensing