assinafy 0.1.2

Idiomatic async Rust SDK for the Assinafy electronic signature API (https://api.assinafy.com.br/v1).
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

//! Credential handling.

use std::fmt;

use reqwest::RequestBuilder;
use reqwest::header::AUTHORIZATION;

/// Credential used to authenticate API requests.
#[derive(Clone, Default)]
pub enum Auth {
    /// API key sent as `X-Api-Key`. Use for server-to-server integrations.
    ApiKey(String),
    /// Bearer token sent as `Authorization: Bearer <token>`. Returned by
    /// [`AuthApi::login`](crate::resources::AuthApi::login).
    Bearer(String),
    /// Bearer token sent as the `?access-token=<token>` query parameter.
    ///
    /// Prefer [`Auth::Bearer`] for new integrations. This variant exists for
    /// endpoints and deployments that rely on the URL-parameter form documented
    /// by the API.
    AccessToken(String),
    /// Signer access code sent as the `?signer-access-code=<code>` query
    /// parameter. Used by signer-facing endpoints.
    AccessCode(String),
    /// No credential. Only valid for the handful of public endpoints
    /// (e.g. `/login`, `/documents/{hash}/verify`).
    #[default]
    None,
}

impl Auth {
    /// Apply the credential to a [`RequestBuilder`].
    pub(crate) fn apply(&self, req: RequestBuilder) -> RequestBuilder {
        match self {
            Auth::ApiKey(k) => req.header("X-Api-Key", k),
            Auth::Bearer(t) => req.header(AUTHORIZATION, format!("Bearer {t}")),
            Auth::AccessToken(t) => req.query(&[("access-token", t)]),
            Auth::AccessCode(c) => req.query(&[("signer-access-code", c)]),
            Auth::None => req,
        }
    }

    /// Returns the signer access code when this credential carries one.
    pub(crate) fn signer_access_code(&self) -> Option<&str> {
        if let Auth::AccessCode(code) = self {
            Some(code.as_str())
        } else {
            None
        }
    }
}

impl fmt::Debug for Auth {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Auth::ApiKey(_) => f.write_str("ApiKey(**redacted**)"),
            Auth::Bearer(_) => f.write_str("Bearer(**redacted**)"),
            Auth::AccessToken(_) => f.write_str("AccessToken(**redacted**)"),
            Auth::AccessCode(_) => f.write_str("AccessCode(**redacted**)"),
            Auth::None => f.write_str("None"),
        }
    }
}