pubky 0.11.0

Pubky SDK
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

use std::{fmt::Display, str::FromStr};

use super::DeepLinkParseError;

const PUBKY_AUTH_SCHEME: &str = "pubkyauth";
/// Deprecated schema
const PUBKY_RING_SCHEME: &str = "pubkyring";
const EXPECTED_DEEP_LINK_SCHEMES: &str = "pubkyauth or pubkyring";

/// Supported Pubky deep-link URI schemes.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DeepLinkScheme {
    /// Current Pubky auth deep-link scheme.
    PubkyAuth,
    /// Deprecated Pubky Ring deep-link scheme.
    PubkyRing,
}

impl DeepLinkScheme {
    /// Return the canonical URI scheme string.
    #[must_use]
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::PubkyAuth => PUBKY_AUTH_SCHEME,
            Self::PubkyRing => PUBKY_RING_SCHEME,
        }
    }
}

impl Display for DeepLinkScheme {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.write_str(self.as_str())
    }
}

impl FromStr for DeepLinkScheme {
    type Err = DeepLinkParseError;

    fn from_str(value: &str) -> Result<Self, Self::Err> {
        match value {
            PUBKY_AUTH_SCHEME => Ok(Self::PubkyAuth),
            PUBKY_RING_SCHEME => Ok(Self::PubkyRing),
            _ => Err(DeepLinkParseError::InvalidSchema(
                EXPECTED_DEEP_LINK_SCHEMES,
            )),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn parses_pubky_auth_scheme() {
        let scheme: DeepLinkScheme = "pubkyauth".parse().unwrap();

        assert_eq!(scheme, DeepLinkScheme::PubkyAuth);
    }

    #[test]
    fn parses_pubky_ring_scheme() {
        let scheme: DeepLinkScheme = "pubkyring".parse().unwrap();

        assert_eq!(scheme, DeepLinkScheme::PubkyRing);
    }

    #[test]
    fn rejects_unknown_scheme() {
        let error = "https".parse::<DeepLinkScheme>().unwrap_err();

        assert!(matches!(error, DeepLinkParseError::InvalidSchema(_)));
    }

    #[test]
    fn formats_pubky_auth_scheme() {
        assert_eq!(DeepLinkScheme::PubkyAuth.to_string(), "pubkyauth");
    }

    #[test]
    fn formats_pubky_ring_scheme() {
        assert_eq!(DeepLinkScheme::PubkyRing.to_string(), "pubkyring");
    }
}