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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

//Anything related to PATCH requests for oauth authorizations and it's properties goes here.
use super::OAuthClient;

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

/// OAuth Client Update
///
/// Update OAuth client
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#oauth-client-update)
/// 
/// # Example:
///
/// OAuthClientUpdate takes one required parameter, client_id, and returns the updated [`OAuthClient`][response].
/// ```rust
/// use heroku_rs::prelude::*;
///#    let api_client = HttpApiClient::create("API_KEY").unwrap();
/// let redirect_uri = "https://www.blog.redirecting_site_here.dev";
///
/// let response = api_client.request(
///     &OAuthClientUpdate::new("CLIENT_ID")
///         .name("CLIENT NAME")
///         .redirect_uri(redirect_uri)
///         .build(),
/// );
///
///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.OAuthClient.html
pub struct OAuthClientUpdate<'a> {
    /// unique identifier of OAuth Client authorization
    pub client_id: &'a str,
    /// The parameters to pass to the Heroku API
    pub params: OAuthClientUpdateParams<'a>,
}

#[cfg(feature = "builder")]
impl<'a> OAuthClientUpdate<'a> {
    pub fn new(client_id: &'a str) -> OAuthClientUpdate<'a> {
        OAuthClientUpdate {
            client_id,
            params: OAuthClientUpdateParams {
                name: None,
                redirect_uri: None,
            },
        }
    }

    /// # name: OAuth client name
    pub fn name(&mut self, name: &'a str) -> &mut Self {
        self.params.name = Some(name);
        self
    }

    /// # redirect_uri: endpoint for redirection after authorization with OAuth client
    pub fn redirect_uri(&mut self, redirect_uri: &'a str) -> &mut Self {
        self.params.redirect_uri = Some(redirect_uri);
        self
    }

    pub fn build(&self) -> OAuthClientUpdate<'a> {
        OAuthClientUpdate {
            client_id: self.client_id,
            params: OAuthClientUpdateParams {
                name: self.params.name,
                redirect_uri: self.params.redirect_uri,
            },
        }
    }
}

/// Update existing oauth client with parameters.
///
/// [See Heroku documentation for more information about this endpoint](https://devcenter.heroku.com/articles/platform-api-reference#oauth-client-update-optional-parameters)
#[derive(Serialize, Clone, Debug)]
pub struct OAuthClientUpdateParams<'a> {
    /// OAuth client name
    pub name: Option<&'a str>,
    /// endpoint for redirection after authorization with OAuth client
    pub redirect_uri: Option<&'a str>,
}

impl<'a> HerokuEndpoint<OAuthClient, (), OAuthClientUpdateParams<'a>> for OAuthClientUpdate<'a> {
    fn method(&self) -> Method {
        Method::Patch
    }
    fn path(&self) -> String {
        format!("oauth/clients/{}", self.client_id)
    }
    fn body(&self) -> Option<OAuthClientUpdateParams<'a>> {
        Some(self.params.clone())
    }
}