octocrab 0.54.2

A modern, extensible GitHub API client.
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

use crate::models::apps::{AppAuthorization, CreateScopedAccessToken, TokenBody};
use crate::{Octocrab, Result};

/// A client for managing OAuth authorizations for a specific application.
///
/// Created with [`AppsRequestHandler::application`][super::AppsRequestHandler::application] or
/// [`Octocrab::applications`].
pub struct ApplicationHandler<'octo> {
    crab: &'octo Octocrab,
    client_id: String,
}

impl<'octo> ApplicationHandler<'octo> {
    pub(crate) fn new(crab: &'octo Octocrab, client_id: String) -> Self {
        Self { crab, client_id }
    }

    /// Deletes an OAuth application authorization (grant) for a user.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/apps/oauth-applications?apiVersion=2022-11-28#delete-an-app-authorization)
    pub async fn delete_grant(&self, access_token: impl Into<String>) -> Result<()> {
        let route = format!("/applications/{}/grant", self.client_id);
        let body = TokenBody {
            access_token: access_token.into(),
        };
        let resp = self.crab._delete(route, Some(&body)).await?;
        crate::map_github_error(resp).await?;
        Ok(())
    }

    /// Checks the validity of an OAuth application token.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/apps/oauth-applications?apiVersion=2022-11-28#check-a-token)
    pub async fn check_token(&self, access_token: impl Into<String>) -> Result<AppAuthorization> {
        let route = format!("/applications/{}/token", self.client_id);
        let body = TokenBody {
            access_token: access_token.into(),
        };
        self.crab.post(route, Some(&body)).await
    }

    /// Resets an OAuth application token.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/apps/oauth-applications?apiVersion=2022-11-28#reset-a-token)
    pub async fn reset_token(&self, access_token: impl Into<String>) -> Result<AppAuthorization> {
        let route = format!("/applications/{}/token", self.client_id);
        let body = TokenBody {
            access_token: access_token.into(),
        };
        self.crab.patch(route, Some(&body)).await
    }

    /// Deletes an OAuth application token.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/apps/oauth-applications?apiVersion=2022-11-28#delete-an-app-token)
    pub async fn delete_token(&self, access_token: impl Into<String>) -> Result<()> {
        let route = format!("/applications/{}/token", self.client_id);
        let body = TokenBody {
            access_token: access_token.into(),
        };
        let resp = self.crab._delete(route, Some(&body)).await?;
        crate::map_github_error(resp).await?;
        Ok(())
    }

    /// Creates a scoped access token for an OAuth application.
    ///
    /// See: [GitHub API Documentation](https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#create-a-scoped-access-token)
    pub async fn scoped_token(&self, body: &CreateScopedAccessToken) -> Result<AppAuthorization> {
        let route = format!("/applications/{}/token/scoped", self.client_id);
        self.crab.post(route, Some(body)).await
    }
}