captcha-sdk 0.0.1

Unified server-side CAPTCHA verification for Rust
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

use std::net::IpAddr;

use crate::CaptchaToken;

/// Provider-independent input for one verification attempt.
#[derive(Debug)]
#[non_exhaustive]
pub struct VerificationRequest {
    /// Opaque token produced by the provider's client-side widget.
    token: CaptchaToken,
    /// End-user IP address, when available and appropriate to forward.
    remote_ip: Option<IpAddr>,
}

impl VerificationRequest {
    /// Creates a request containing the required client token.
    #[must_use]
    pub const fn new(token: CaptchaToken) -> Self {
        Self {
            token,
            remote_ip: None,
        }
    }

    /// Returns the opaque client token.
    #[must_use]
    pub const fn token(&self) -> &CaptchaToken {
        &self.token
    }

    /// Returns the end-user IP address, when one was supplied.
    #[must_use]
    pub const fn remote_ip(&self) -> Option<IpAddr> {
        self.remote_ip
    }

    /// Adds the end-user IP address.
    #[must_use]
    pub const fn with_remote_ip(mut self, remote_ip: IpAddr) -> Self {
        self.remote_ip = Some(remote_ip);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::VerificationRequest;
    use crate::CaptchaToken;

    #[test]
    fn request_preserves_the_supplied_token() {
        let raw_token = "request-preservation-test-token";
        let token = CaptchaToken::new(raw_token).expect("token should be valid");

        let request = VerificationRequest::new(token);

        assert_eq!(request.token().expose(), raw_token);
    }
}