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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use pubky_common::crypto::PublicKey;
use url::Url;

use super::{
    DeepLinkParseError,
    query_params::{append_direct_signup_params, optional_query, parse_homeserver},
    typed_deep_link::{DeepLinkIntent, DeepLinkParams, TypedDeepLink},
};

/// Intent marker for direct signup deep links.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct DirectSignupIntent;

impl DeepLinkIntent for DirectSignupIntent {
    const NAME: &'static str = "direct_signup";
}

/// Typed parameters for direct signup deep links.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DirectSignupParams {
    /// Homeserver public key.
    pub homeserver: PublicKey,
    /// Optional signup token.
    pub signup_token: Option<String>,
}

impl DeepLinkParams for DirectSignupParams {
    fn parse(url: &Url) -> Result<Self, DeepLinkParseError> {
        Ok(Self {
            homeserver: parse_homeserver(url)?,
            signup_token: optional_query(url, "st"),
        })
    }

    fn append_query_pairs(&self, url: &mut Url) {
        append_direct_signup_params(url, &self.homeserver, self.signup_token.as_deref());
    }
}

/// A deep link for registering an account directly on a Pubky homeserver.
pub type DirectSignupDeepLink = TypedDeepLink<DirectSignupIntent, DirectSignupParams>;

#[cfg(test)]
mod tests {
    use std::str::FromStr;

    use super::*;
    use crate::actors::auth::deep_links::DeepLinkScheme;

    const HOMESERVER: &str = "5jsjx1o6fzu6aeeo697r3i5rx15zq41kikcye8wtwdqm4nb4tryo";

    #[test]
    fn parses_direct_signup_deep_link() {
        let deep_link: DirectSignupDeepLink = format!("pubkyauth://direct_signup?hs={HOMESERVER}")
            .parse()
            .unwrap();

        assert_eq!(deep_link.scheme(), DeepLinkScheme::PubkyAuth);
        assert_eq!(deep_link.intent(), "direct_signup");
        assert_eq!(deep_link.params().homeserver.z32(), HOMESERVER);
        assert_eq!(deep_link.params().signup_token, None);
    }

    #[test]
    fn parses_direct_signup_deep_link_with_token() {
        let deep_link: DirectSignupDeepLink =
            format!("pubkyauth://direct_signup?hs={HOMESERVER}&st=1234567890")
                .parse()
                .unwrap();

        assert_eq!(deep_link.params().signup_token, Some("1234567890".into()));
    }

    #[test]
    fn direct_signup_deep_link_round_trips() {
        let deep_link = DirectSignupDeepLink::new(
            DeepLinkScheme::PubkyAuth,
            DirectSignupParams {
                homeserver: PublicKey::from_str(HOMESERVER).unwrap(),
                signup_token: None,
            },
        );

        assert_eq!(
            deep_link.to_string(),
            format!("pubkyauth://direct_signup?hs={HOMESERVER}")
        );
        assert_eq!(
            DirectSignupDeepLink::parse_url(&deep_link.to_url()).unwrap(),
            deep_link
        );
    }

    #[test]
    fn rejects_missing_homeserver() {
        let error = "pubkyauth://direct_signup"
            .parse::<DirectSignupDeepLink>()
            .unwrap_err();

        assert!(matches!(
            error,
            DeepLinkParseError::MissingQueryParameter("hs")
        ));
    }
}