New feature: bank card validations (#157)

* Add bank card validations

* Fix linting

Author: TimonPeng

tests/test_card.py

@@ -0,0 +1,190 @@
+# -*- coding: utf-8 -*-
+import pytest
+
+from validators import (
+    amex,
+    card_number,
+    diners,
+    discover,
+    jcb,
+    mastercard,
+    unionpay,
+    ValidationFailure,
+    visa
+)
+
+visa_cards = [
+    '4242424242424242',
+    '4000002760003184'
+]
+mastercard_cards = [
+    '5555555555554444',
+    '2223003122003222'
+]
+amex_cards = [
+    '378282246310005',
+    '371449635398431'
+]
+unionpay_cards = [
+    '6200000000000005'
+]
+diners_cards = [
+    '3056930009020004',
+    '36227206271667'
+]
+jcb_cards = [
+    '3566002020360505'
+]
+discover_cards = [
+    '6011111111111117',
+    '6011000990139424'
+]
+
+
+@pytest.mark.parametrize(
+    "value",
+    visa_cards
+    + mastercard_cards
+    + amex_cards
+    + unionpay_cards
+    + diners_cards
+    + jcb_cards
+    + discover_cards,
+)
+def test_returns_true_on_valid_card_number(value):
+    assert card_number(value)
+
+
+@pytest.mark.parametrize('value', [
+    '4242424242424240',
+    '4000002760003180',
+    '400000276000318X'
+])
+def test_returns_failed_on_valid_card_number(value):
+    assert isinstance(card_number(value), ValidationFailure)
+
+
+@pytest.mark.parametrize('value', visa_cards)
+def test_returns_true_on_valid_visa(value):
+    assert visa(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    mastercard_cards
+    + amex_cards
+    + unionpay_cards
+    + diners_cards
+    + jcb_cards
+    + discover_cards,
+)
+def test_returns_failed_on_valid_visa(value):
+    assert isinstance(visa(value), ValidationFailure)
+
+
+@pytest.mark.parametrize('value', mastercard_cards)
+def test_returns_true_on_valid_mastercard(value):
+    assert mastercard(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    visa_cards
+    + amex_cards
+    + unionpay_cards
+    + diners_cards
+    + jcb_cards
+    + discover_cards,
+)
+def test_returns_failed_on_valid_mastercard(value):
+    assert isinstance(mastercard(value), ValidationFailure)
+
+
+@pytest.mark.parametrize('value', amex_cards)
+def test_returns_true_on_valid_amex(value):
+    assert amex(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    visa_cards
+    + mastercard_cards
+    + unionpay_cards
+    + diners_cards
+    + jcb_cards
+    + discover_cards,
+)
+def test_returns_failed_on_valid_amex(value):
+    assert isinstance(amex(value), ValidationFailure)
+
+
+@pytest.mark.parametrize('value', unionpay_cards)
+def test_returns_true_on_valid_unionpay(value):
+    assert unionpay(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    visa_cards
+    + mastercard_cards
+    + amex_cards
+    + diners_cards
+    + jcb_cards
+    + discover_cards,
+)
+def test_returns_failed_on_valid_unionpay(value):
+    assert isinstance(unionpay(value), ValidationFailure)
+
+
+@pytest.mark.parametrize('value', diners_cards)
+def test_returns_true_on_valid_diners(value):
+    assert diners(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    visa_cards
+    + mastercard_cards
+    + amex_cards
+    + unionpay_cards
+    + jcb_cards
+    + discover_cards,
+)
+def test_returns_failed_on_valid_diners(value):
+    assert isinstance(diners(value), ValidationFailure)
+
+
+@pytest.mark.parametrize('value', jcb_cards)
+def test_returns_true_on_valid_jcb(value):
+    assert jcb(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    visa_cards
+    + mastercard_cards
+    + amex_cards
+    + unionpay_cards
+    + diners_cards
+    + discover_cards,
+)
+def test_returns_failed_on_valid_jcb(value):
+    assert isinstance(jcb(value), ValidationFailure)
+
+
+@pytest.mark.parametrize('value', discover_cards)
+def test_returns_true_on_valid_discover(value):
+    assert discover(value)
+
+
+@pytest.mark.parametrize(
+    "value",
+    visa_cards
+    + mastercard_cards
+    + amex_cards
+    + unionpay_cards
+    + diners_cards
+    + jcb_cards,
+)
+def test_returns_failed_on_valid_discover(value):
+    assert isinstance(discover(value), ValidationFailure)

validators/__init__.py

@@ -1,4 +1,14 @@
 from .between import between
+from .card import (
+    amex,
+    card_number,
+    diners,
+    discover,
+    jcb,
+    mastercard,
+    unionpay,
+    visa
+)
 from .domain import domain
 from .email import email
 from .extremes import Max, Min
@@ -17,6 +27,8 @@
 __all__ = ('between', 'domain', 'email', 'Max', 'Min', 'md5', 'sha1', 'sha224',
            'sha256', 'sha512', 'fi_business_id', 'fi_ssn', 'iban', 'ipv4',
            'ipv4_cidr', 'ipv6', 'ipv6_cidr', 'length', 'mac_address', 'slug',
-           'truthy', 'url', 'ValidationFailure', 'validator', 'uuid')
+           'truthy', 'url', 'ValidationFailure', 'validator', 'uuid',
+           'card_number', 'visa', 'mastercard', 'amex', 'unionpay', 'diners',
+           'jcb', 'discover')
 
 __version__ = '0.14.3'

validators/card.py

@@ -0,0 +1,183 @@
+import re
+
+from .utils import validator
+
+
+@validator
+def card_number(value):
+    """
+    Return whether or not given value is a valid card number.
+
+    This validator is based on Luhn algorithm.
+
+    .. luhn:
+       https://github.com/mmcloughlin/luhn
+
+    Examples::
+
+        >>> card_number('4242424242424242')
+        True
+
+        >>> card_number('4242424242424241')
+        ValidationFailure(func=card_number, args={'value': '4242424242424241'})
+
+    .. versionadded:: 0.2
+
+    :param value: card number string to validate
+    """
+    try:
+        digits = list(map(int, value))
+        odd_sum = sum(digits[-1::-2])
+        even_sum = sum([sum(divmod(2 * d, 10)) for d in digits[-2::-2]])
+        return (odd_sum + even_sum) % 10 == 0
+    except ValueError:
+        return False
+
+
+@validator
+def visa(value):
+    """
+    Return whether or not given value is a valid Visa card number.
+
+    Examples::
+
+        >>> visa('4242424242424242')
+        True
+
+        >>> visa('2223003122003222')
+        ValidationFailure(func=visa, args={'value': '2223003122003222'})
+
+    .. versionadded:: 0.2
+
+    :param value: Visa card number string to validate
+    """
+    pattern = re.compile(r'^4')
+    return card_number(value) and len(value) == 16 and pattern.match(value)
+
+
+@validator
+def mastercard(value):
+    """
+    Return whether or not given value is a valid Mastercard card number.
+
+    Examples::
+
+        >>> mastercard('5555555555554444')
+        True
+
+        >>> mastercard('4242424242424242')
+        ValidationFailure(func=mastercard, args={'value': '4242424242424242'})
+
+    .. versionadded:: 0.2
+
+    :param value: Mastercard card number string to validate
+    """
+    pattern = re.compile(r'^(51|52|53|54|55|22|23|24|25|26|27)')
+    return card_number(value) and len(value) == 16 and pattern.match(value)
+
+
+@validator
+def amex(value):
+    """
+    Return whether or not given value is a valid American Express card number.
+
+    Examples::
+
+        >>> amex('378282246310005')
+        True
+
+        >>> amex('4242424242424242')
+        ValidationFailure(func=amex, args={'value': '4242424242424242'})
+
+    .. versionadded:: 0.2
+
+    :param value: American Express card number string to validate
+    """
+    pattern = re.compile(r'^(34|37)')
+    return card_number(value) and len(value) == 15 and pattern.match(value)
+
+
+@validator
+def unionpay(value):
+    """
+    Return whether or not given value is a valid UnionPay card number.
+
+    Examples::
+
+        >>> unionpay('6200000000000005')
+        True
+
+        >>> unionpay('4242424242424242')
+        ValidationFailure(func=unionpay, args={'value': '4242424242424242'})
+
+    .. versionadded:: 0.2
+
+    :param value: UnionPay card number string to validate
+    """
+    pattern = re.compile(r'^62')
+    return card_number(value) and len(value) == 16 and pattern.match(value)
+
+
+@validator
+def diners(value):
+    """
+    Return whether or not given value is a valid Diners Club card number.
+
+    Examples::
+
+        >>> diners('3056930009020004')
+        True
+
+        >>> diners('4242424242424242')
+        ValidationFailure(func=diners, args={'value': '4242424242424242'})
+
+    .. versionadded:: 0.2
+
+    :param value: Diners Club card number string to validate
+    """
+    pattern = re.compile(r'^(30|36|38|39)')
+    return (
+        card_number(value) and len(value) in [14, 16] and pattern.match(value)
+    )
+
+
+@validator
+def jcb(value):
+    """
+    Return whether or not given value is a valid JCB card number.
+
+    Examples::
+
+        >>> jcb('3566002020360505')
+        True
+
+        >>> jcb('4242424242424242')
+        ValidationFailure(func=jcb, args={'value': '4242424242424242'})
+
+    .. versionadded:: 0.2
+
+    :param value: JCB card number string to validate
+    """
+    pattern = re.compile(r'^35')
+    return card_number(value) and len(value) == 16 and pattern.match(value)
+
+
+@validator
+def discover(value):
+    """
+    Return whether or not given value is a valid Discover card number.
+
+    Examples::
+
+        >>> discover('6011111111111117')
+        True
+
+        >>> discover('4242424242424242')
+        ValidationFailure(func=discover, args={'value': '4242424242424242'})
+
+    .. versionadded:: 0.2
+
+    :param value: Discover card number string to validate
+    """
+    pattern = re.compile(r'^(60|64|65)')
+    return card_number(value) and len(value) == 16 and pattern.match(value)