validaten 0.1.0

Common validators for cryptocurrency, creditcards, domain, url, etc that can be used across projects
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
use regex::Regex;
use std::ops::Range;
use checkluhn;

lazy_static! {
    // Debit Cards
    static ref VISAELECTRON: Regex = Regex::new(r"^4(026|17500|405|508|844|91[37])").unwrap();
    static ref MAESTRO: Regex = Regex::new(r"^(5(018|0[23]|[68])|6(39|7))").unwrap();
    static ref FORBRUGSFORENINGEN: Regex = Regex::new(r"^600").unwrap();
    static ref DANKORT: Regex = Regex::new(r"^5019").unwrap();

    // Credit Cards
    static ref VISA: Regex = Regex::new(r"^4").unwrap();
    static ref MASTERCARD: Regex = Regex::new(r"^(5[1-5]|2[2-7])").unwrap();
    static ref AMEX: Regex = Regex::new(r"^3[47]").unwrap();
    static ref DINERSCLUB: Regex = Regex::new(r"^3[0689]").unwrap();
    static ref DISCOVER: Regex = Regex::new(r"^6([045]|22)").unwrap();
    static ref UNIONPAY: Regex = Regex::new(r"^(62|88)").unwrap();
    static ref JCB: Regex = Regex::new(r"^35").unwrap();
}

enum Type {
    VisaElectron,
    Maestro,
    Forbrugsforeningen,
    Dankort,
    Visa,
    MasterCard,
    Amex,
    DinersClub,
    Discover,
    UnionPay,
    JCB,
}

impl Type {
    fn name<'a>(&self) -> &'a str {
        match *self {
            Type::VisaElectron => "Visa Electron",
            Type::Maestro => "Maestro",
            Type::Forbrugsforeningen => "Forbrugsforeningen",
            Type::Dankort => "Dankort",
            Type::Visa => "Visa",
            Type::MasterCard => "MasterCard",
            Type::Amex => "Amex",
            Type::DinersClub => "Diners Club",
            Type::Discover => "Discover",
            Type::UnionPay => "UnionPay",
            Type::JCB => "JCB",
        }
    }

    fn pattern<'a>(&self) -> &'a Regex {
        match *self {
            Type::VisaElectron => &VISAELECTRON,
            Type::Maestro => &MAESTRO,
            Type::Forbrugsforeningen => &FORBRUGSFORENINGEN,
            Type::Dankort => &DANKORT,
            Type::Visa => &VISA,
            Type::MasterCard => &MASTERCARD,
            Type::Amex => &AMEX,
            Type::DinersClub => &DINERSCLUB,
            Type::Discover => &DISCOVER,
            Type::UnionPay => &UNIONPAY,
            Type::JCB => &JCB,
        }
    }

    fn length<'a>(&self) -> Range<usize> {
        match *self {
            Type::VisaElectron => Range { start: 16, end: 16 },
            Type::Maestro => Range { start: 12, end: 19 },
            Type::Forbrugsforeningen => Range { start: 16, end: 16 },
            Type::Dankort => Range { start: 16, end: 16 },
            Type::Visa => Range { start: 13, end: 16 },
            Type::MasterCard => Range { start: 16, end: 16 },
            Type::Amex => Range { start: 15, end: 15 },
            Type::DinersClub => Range { start: 13, end: 16 },
            Type::Discover => Range { start: 16, end: 16 },
            Type::JCB => Range { start: 16, end: 16 },
            Type::UnionPay => Range { start: 16, end: 19 },
        }
    }

    fn all() -> Vec<Type> {
        vec![
            // Debit Cards
            Type::VisaElectron,
            Type::Maestro,
            Type::Forbrugsforeningen,
            Type::Dankort,

            // Credit Cards
            Type::Visa,
            Type::MasterCard,
            Type::Amex,
            Type::DinersClub,
            Type::Discover,
            Type::UnionPay,
            Type::JCB,
        ]
    }
}

/// Check if the given card number and card type has a valid length
fn is_length_valid(card_number: &str, card_type: &Type) -> bool {
    let size = card_number.len();
    let range = card_type.length();

    size >= range.start && size <= range.end
}

/// Check if card number passes luhn test
fn is_luhn_valid(card_number: &str) -> bool {
    checkluhn::validate(&card_number)
}

/// Evaluate Card Type & Validate Card for its Brand
fn validate(value: &str) -> bool {
    // if card number (value) contains spaces in between, remove them
    let value = value.replace(" ", "");
    for card in Type::all() {
        if card.pattern().is_match(&value) {
            // Check Length
            if is_length_valid(&value, &card) {
                // Check if it passes luhn algorithm
                if is_luhn_valid(&value) {
                    return true
                }
                // luhn check failed
                return false
            }
            // card type length check failed
            return false
        }
    }
    false
}

pub fn is_valid_visa_electron(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is Visa Electron
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_visa_electron;
    //! fn main() {
    //!     assert_eq!(is_valid_visa_electron("4844 1614 5954 6174"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_maestro(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is Maestro
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_maestro;
    //! fn main() {
    //!     assert_eq!(is_valid_maestro("5898009041197"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_forbrugsforeningen(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is Forbrugsforeningen
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_forbrugsforeningen;
    //! fn main() {
    //! assert_eq!(is_valid_forbrugsforeningen("6007221111111110"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_dankort(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is Dankort
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_dankort;
    //! fn main() {
    //! assert_eq!(is_valid_dankort("5019118545073189"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_visa(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is VISA
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_visa;
    //! fn main() {
    //! assert_eq!(is_valid_visa("4035 3005 3980 4083"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_mastercard(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is MasterCard
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_mastercard;
    //! fn main() {
    //! assert_eq!(is_valid_mastercard("5463 1135 8998 2388"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_amex(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is American Express
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_amex;
    //! fn main() {
    //! assert_eq!(is_valid_amex("3707 897090 84107"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_diners_club(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is Dinners Club
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_diners_club;
    //! fn main() {
    //! assert_eq!(is_valid_diners_club("3022143741431999"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_discover(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is Discover
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_discover;
    //! fn main() {
    //! assert_eq!(is_valid_discover("6011575126600688"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_unionpay(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is UnionPay
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_unionpay;
    //! fn main() {
    //! assert_eq!(is_valid_unionpay("62600094752489242"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_valid_jcb(value: &str) -> bool {
    //! Check if the Given Credit/Debit card number is JCB
    //! and that if its valid.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::is_valid_jcb;
    //! fn main() {
    //! assert_eq!(is_valid_jcb("3588337499926343"), true)
    //! }
    //! ```
    validate(value)
}

pub fn is_card_any(value: &str) -> bool {
    //! Check if a given value is a credit/debit card number.
    //!
    //! ## Example usage
    //! ```rust
    //! use validaten::creditcard::is_card_any;
    //! fn main() {
    //!     assert_eq!(is_card_any("3588337499926343"), true);
    //! }
    //! ```
    validate(value)
}

pub fn which_card(value: &str) -> Option<&str> {
    //! Determines which Credit/Debit Card is provided.
    //!
    //! ## Example Usage
    //! ```rust
    //! use validaten::creditcard::which_card;
    //!
    //! fn main() {
    //!     println!("{:?}", which_card("3707 897090 84107"));
    //! }
    //! ```
    // remove the spaces if the card number contains
    let value = value.replace(" ", "");
    for card in Type::all() {
        if card.pattern().is_match(&value) {
            return Some(card.name())
        }
    }
    None
}

#[cfg(test)]
mod tests {
    // Card numbers are generated from: https://debitcard-generator.com/validator
    use super::*;

    #[test]
    fn test_which_card() {
        // Visa Electron
        assert_eq!(which_card("4844161459546175"), Some("Visa Electron"));
        // Maestro
        assert_eq!(which_card("5898009041193"), Some("Maestro"));
        // Forbrugsforeningen
        assert_eq!(which_card("6007221111111110"), Some("Forbrugsforeningen"));
        // Dankort
        assert_eq!(which_card("5019118545073184"), Some("Dankort"));
        // VISA
        assert_eq!(which_card("4035300539804083"), Some("Visa"));
        // MasterCard
        assert_eq!(which_card("5463113589982388"), Some("MasterCard"));
        // Amex
        assert_eq!(which_card("370789709084107"), Some("Amex"));
        // Dinners Club
        assert_eq!(which_card("3022143741431999"), Some("Diners Club"));
        // Discover
        assert_eq!(which_card("6011575126600688"), Some("Discover"));
        // China UnionPay
        assert_eq!(which_card("62600094752489245"), Some("UnionPay"));
        // JCB
        assert_eq!(which_card("3588337499926343"), Some("JCB"));
    }

    #[test]
    fn test_is_card_any() {
        assert!(is_card_any("3588337499926343"));
        assert!(is_card_any("5019118545073189"));
        assert!(!is_card_any("5019112"));
    }

    #[test]
    fn test_is_valid_visa_electron() {
        assert!(is_valid_visa_electron("4844 1614 5954 6174"));
        assert!(!is_valid_visa_electron("4844161459546175"));
    }

    #[test]
    fn test_is_valid_maestro() {
        assert!(is_valid_maestro("6796265520244"));
        assert!(!is_valid_maestro("5898009041193"));
    }

    #[test]
    fn test_is_valid_forbrugsforeningen() {
        assert!(is_valid_forbrugsforeningen("6007221111111110"));
        assert!(!is_valid_forbrugsforeningen("6007221111111111"));
    }

    #[test]
    fn test_is_valid_dankort() {
        assert!(is_valid_dankort("5019118545073189"));
        assert!(!is_valid_dankort("5019118545073184"));
    }

    #[test]
    fn test_is_valid_visa() {
        assert!(is_valid_visa("4035300539804083"));
        assert!(!is_valid_visa("4035300539804082"));
    }

    #[test]
    fn test_is_valid_mastercard() {
        assert!(is_valid_mastercard("5463113589982388"));
        assert!(!is_valid_mastercard("5463113589982387"));
    }

    #[test]
    fn test_is_valid_amex() {
        assert!(is_valid_amex("370789709084107"));
        assert!(!is_valid_amex("370789709084106"));
    }

    #[test]
    fn test_is_valid_diners_club() {
        assert!(is_valid_diners_club("3022143741431999"));
        assert!(!is_valid_diners_club("3022143741431990"));
        assert!(is_valid_diners_club("3860847190349"));
        assert!(is_valid_diners_club("30043277253245"));
    }

    #[test]
    fn test_is_valid_discover() {
        assert!(is_valid_discover("6011575126600688"));
        assert!(!is_valid_discover("6011575126600689"))
    }

    #[test]
    fn test_is_valid_unionpay() {
        assert!(is_valid_unionpay("62600094752489242"));
        assert!(!is_valid_unionpay("62600094752489245"));
    }

    #[test]
    fn test_is_valid_jcb() {
        assert!(is_valid_jcb("3588337499926343"));
        assert!(!is_valid_jcb("3588337499926345"))
    }
}