captval 0.1.2

Captcha validators
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
106
107
108
109
110
111
112
113
114
115

use crate::{Code, Error};
use std::collections::HashSet;
use std::fmt;
use std::net::{Ipv4Addr, Ipv6Addr};
use std::str::FromStr;

#[derive(Debug, Default, Clone, serde::Deserialize, serde::Serialize)]
pub struct Remoteip(String);

impl fmt::Display for Remoteip {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.0)
    }
}

impl Remoteip {
    #[cfg_attr(
        feature = "trace",
        tracing::instrument(name = "Validate User IP.", skip(s), level = "debug")
    )]
    pub fn parse(s: String) -> Result<Self, Error> {
        empty_ip_string(&s)?;
        invalid_ip_string(&s)?;

        Ok(Remoteip(s))
    }
}

#[cfg_attr(
    feature = "trace",
    tracing::instrument(name = "Return error on empty string.", skip(s), level = "debug")
)]
fn empty_ip_string(s: &str) -> Result<(), Error> {
    if s.trim().is_empty() {
        let mut codes = HashSet::new();
        codes.insert(Code::MissingUserIp);

        #[cfg(feature = "trace")]
        tracing::debug!("UserIP string is missing");
        Err(Error::Codes(codes))
    } else {
        Ok(())
    }
}

#[cfg_attr(
    feature = "trace",
    tracing::instrument(name = "Return error if not an ip string.", skip(s), level = "debug")
)]
fn invalid_ip_string(s: &str) -> Result<(), Error> {
    let invalid_ip4 = Ipv4Addr::from_str(s).is_err();
    let invalid_ip6 = Ipv6Addr::from_str(s).is_err();
    if invalid_ip4 && invalid_ip6 {
        let mut codes = HashSet::new();
        codes.insert(Code::InvalidUserIp);

        #[cfg(feature = "trace")]
        tracing::debug!("UserIP string is invalid");
        Err(Error::Codes(codes))
    } else {
        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use super::Remoteip;
    use crate::Code;
    use crate::Error;
    use claims::{assert_err, assert_ok};

    #[test]
    fn whitespace_only_ip_strings_are_rejected() {
        let ip_string = " ".to_string();
        assert_err!(Remoteip::parse(ip_string));
    }

    #[test]
    fn empty_string_is_rejected() {
        let ip_string = "".to_string();
        assert_err!(Remoteip::parse(ip_string));
    }

    #[test]
    fn error_set_contains_missing_ip_string_error() {
        let ip_string = "".to_string();
        if let Err(Error::Codes(hs)) = Remoteip::parse(ip_string) {
            assert!(hs.contains(&Code::MissingUserIp));
        }
    }

    #[test]
    fn error_set_contains_invalid_ip_string_error() {
        let ip_string = "1922.20".to_string();
        let res = Remoteip::parse(ip_string);
        assert_err!(&res);

        if let Err(Error::Codes(hs)) = res {
            println!("Error Codes: {:?}", &hs);
            assert!(hs.contains(&Code::InvalidUserIp));
        }
    }

    #[test]
    fn test_ip_string_key_is_valid_ip4() {
        let ip_string = mockd::internet::ipv4_address();
        assert_ok!(Remoteip::parse(ip_string));
    }

    #[test]
    fn test_ip_string_key_is_valid_ip6() {
        let ip_string = mockd::internet::ipv6_address();
        assert_ok!(Remoteip::parse(ip_string));
    }
}