tax_ids 0.1.0

A library to validate and verify Tax Ids. Handle European, British, Norwegian or Swiss VAT numbers.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

use serde_json::json;
use crate::errors::VerificationError;
use crate::TaxId;
use crate::verification::{Verification, VerificationResponse, VerificationStatus::{*}, Verifier};
use crate::verification::UnavailableReason::ServiceUnavailable;

// INFO(2024-05-08 mollemoll):
// Data from HMRC
// https://www.tax.service.gov.uk/check-vat-number/enter-vat-details
// https://developer.service.hmrc.gov.uk/api-documentation/docs/api/service/vat-registered-companies-api/1.0/oas/page

static BASE_URI: &'static str = "https://api.service.hmrc.gov.uk/organisations/vat/check-vat-number/lookup";
const NOT_FOUND: &str = "NOT_FOUND";
#[allow(dead_code)]
const SERVER_ERROR: &str = "SERVER_ERROR";


#[derive(Debug)]
pub struct Hmrc;

impl Verifier for Hmrc {
    fn make_request(&self, tax_id: &TaxId) -> Result<VerificationResponse, VerificationError> {
        let client = reqwest::blocking::Client::new();
        let res = client
            .get(format!("{}/{}", BASE_URI, tax_id.local_value()))
            .header("Accept", "application/vnd.hmrc.1.0+json")
            .send()
            .map_err(VerificationError::HttpError)?;

        Ok(
            VerificationResponse::new(
                res.status().as_u16(),
                res.text().map_err(VerificationError::HttpError)?
            )
        )
    }

    fn parse_response(&self, response: VerificationResponse) -> Result<Verification, VerificationError> {
        let v: serde_json::Value = serde_json::from_str(response.body())
            .map_err(VerificationError::JsonParsingError)?;
        let hash = v.as_object().unwrap();
        let fault = hash.get("code").and_then(|v| v.as_str());

        let verification_result = match fault {
            None => {
                Verification::new(
                    Verified,
                    json!(hash.get("target"))
                )
            },
            Some(fault_code) if fault_code == NOT_FOUND => {
                Verification::new(
                    Unverified,
                    json!(hash)
                )
            },
            Some(_) => {
                Verification::new(
                    Unavailable(ServiceUnavailable),
                    json!(hash)
                )
            },
        };

        Ok(verification_result)
    }
}

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

    #[cfg(feature = "gb_vat")]
    #[test]
    fn test_parse_response_verified() {
        let response = VerificationResponse::new(
            200,
            r#"{
                "target": {
                    "name": "VIRGIN ATLANTIC AIRWAYS LTD",
                    "vatNumber": "425216184",
                    "address": {
                        "line1": "THE VHQ",
                        "line2": "FLEMING WAY",
                        "line3": "CRAWLEY",
                        "line4": "WEST SUSSEX",
                        "postcode": "RH10 9DF",
                        "countryCode": "GB"
                    }
                },
                "processingDate": "2024-05-06T09:18:58+01:00"
            }"#.to_string()
        );

        let verifier = Hmrc;
        let verification = verifier.parse_response(response).unwrap();

        assert_eq!(verification.status(), &Verified);
        assert_eq!(verification.data(), &json!({
            "name": "VIRGIN ATLANTIC AIRWAYS LTD",
            "vatNumber": "425216184",
            "address": {
                "line1": "THE VHQ",
                "line2": "FLEMING WAY",
                "line3": "CRAWLEY",
                "line4": "WEST SUSSEX",
                "postcode": "RH10 9DF",
                "countryCode": "GB"
            }
        }));
    }

    #[cfg(feature = "gb_vat")]
    #[test]
    fn test_parse_response_unverified() {
        let response = VerificationResponse::new(
            404,
            r#"{
                "code": "NOT_FOUND",
                "reason": "targetVrn does not match a registered company"
            }"#.to_string()
        );

        let verifier = Hmrc;
        let verification = verifier.parse_response(response).unwrap();

        assert_eq!(verification.status(), &Unverified);
        assert_eq!(verification.data(), &json!({
            "code": "NOT_FOUND",
            "reason": "targetVrn does not match a registered company"
        }));
    }

    #[cfg(feature = "gb_vat")]
    #[test]
    fn test_parse_response_unavailable() {
        let response = VerificationResponse::new(
            500,
            r#"{
            "code": "SERVER_ERROR"
            }"#.to_string()
        );

        let verifier = Hmrc;
        let verification = verifier.parse_response(response).unwrap();

        assert_eq!(verification.status(), &Unavailable(ServiceUnavailable));
        assert_eq!(verification.data().get("code").unwrap(), SERVER_ERROR);
    }
}