heroku_rs 0.6.0

Rust bindings for the Heroku API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//Anything related to POST requests for Heroku tests goes here.
use super::TestRun;

use crate::framework::endpoint::{HerokuEndpoint, Method};

/// Test Run Update
///
/// Update a test-run’s status.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#test-run-update)
///
/// # Example:
///
/// TestRunUpdate takes three required parameters, run_id, message and status, returns the updated [`TestRun`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create("API_KEY").unwrap();
///
/// let status = "cancelled";
/// let message = None;
/// let response = api_client.request(&TestRunUpdate::new("RUN_ID", message, status));
///
///match response {
///     Ok(success) => println!("Success: {:#?}", success),
///     Err(e) => println!("Error: {}", e),
///}
///
/// ```
/// See how to create the Heroku [`api_client`][httpApiClientConfig].
///
/// [httpApiClientConfig]: ../../../framework/struct.HttpApiClient.html
/// [response]: ../struct.TestRun.html
pub struct TestRunUpdate<'a> {
    pub run_id: &'a str,
    /// The parameters to pass to the Heroku API
    pub params: TestRunUpdateParams<'a>,
}

#[cfg(feature = "builder")]
impl<'a> TestRunUpdate<'a> {
    pub fn new(run_id: &'a str, message: Option<&'a str>, status: &'a str) -> TestRunUpdate<'a> {
        TestRunUpdate {
            run_id,
            params: TestRunUpdateParams { message, status },
        }
    }
}

/// Update a test run with parameters
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#test-run-update-required-parameters)
#[derive(Serialize, Clone, Debug)]
pub struct TestRunUpdateParams<'a> {
    /// human friendly message indicating reason for an error. [Nullable]
    pub message: Option<&'a str>,
    /// current state of the test run
    ///  one of:"pending" or "cancelled" or "creating" or "building" or "running" or "succeeded" or "failed" or "errored" or "debugging"
    pub status: &'a str,
}

impl<'a> HerokuEndpoint<TestRun, (), TestRunUpdateParams<'a>> for TestRunUpdate<'a> {
    fn method(&self) -> Method {
        Method::Post
    }
    fn path(&self) -> String {
        format!("test-runs/{}", self.run_id)
    }
    fn body(&self) -> Option<TestRunUpdateParams<'a>> {
        Some(self.params.clone())
    }
}