splinter 0.6.14

Splinter is a privacy-focused platform for distributed applications that provides a blockchain-inspired networking environment for communication and transactions between organizations.
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

// Copyright 2018-2022 Cargill Incorporated
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use crate::oauth::GithubProfileProvider;
use crate::oauth::{
    builder::OAuthClientBuilder, error::OAuthClientBuildError, store::InflightOAuthRequestStore,
    GithubSubjectProvider, OAuthClient,
};

/// Builds a new `OAuthClient` with GitHub's authorization and token URLs.
pub struct GithubOAuthClientBuilder {
    inner: OAuthClientBuilder,
}

impl GithubOAuthClientBuilder {
    /// Constructs a Github OAuthClient builder.
    pub fn new() -> Self {
        let inner = OAuthClientBuilder::new()
            .with_auth_url("https://github.com/login/oauth/authorize".into())
            .with_token_url("https://github.com/login/oauth/access_token".into())
            .with_subject_provider(Box::new(GithubSubjectProvider))
            .with_profile_provider(Box::new(GithubProfileProvider));

        Self { inner }
    }

    /// Sets the client ID for the OAuth2 provider.
    pub fn with_client_id(self, client_id: String) -> Self {
        Self {
            inner: self.inner.with_client_id(client_id),
        }
    }

    /// Sets the client secret for the OAuth2 provider.
    pub fn with_client_secret(self, client_secret: String) -> Self {
        Self {
            inner: self.inner.with_client_secret(client_secret),
        }
    }

    /// Sets the redirect URL for the OAuth2 provider.
    pub fn with_redirect_url(self, redirect_url: String) -> Self {
        Self {
            inner: self.inner.with_redirect_url(redirect_url),
        }
    }

    /// Sets the in-flight request store in order to store values between requests to and from the
    /// OAuth2 provider.
    pub fn with_inflight_request_store(
        self,
        inflight_request_store: Box<dyn InflightOAuthRequestStore>,
    ) -> Self {
        Self {
            inner: self
                .inner
                .with_inflight_request_store(inflight_request_store),
        }
    }

    /// Builds an OAuthClient.
    ///
    /// # Errors
    ///
    /// Returns an [`OAuthClientBuildError`] if there are required fields missing, or any URL's
    /// provided are invalid.
    pub fn build(self) -> Result<OAuthClient, OAuthClientBuildError> {
        self.inner.build()
    }
}

impl Default for GithubOAuthClientBuilder {
    fn default() -> Self {
        Self::new()
    }
}