feat: add support for company tin and vat in Oman (#41)

Author: gustav

stdnum/om/__init__.py

@@ -0,0 +1,4 @@
+"""Collection of Omani numbers."""
+from stdnum.om import tin as business_tin  # noqa: F401
+from stdnum.om import cid as personal_tin  # noqa: F401
+from stdnum.om import vat as vat  # noqa: F401

stdnum/om/cid.py

@@ -0,0 +1,64 @@
+"""CID (Omani Civil ID Number).
+
+The Omani Civil ID Number is a unique identifier assigned to citizens and residents
+of Oman. It is used for identification purposes on the Omani National ID Card 
+(Civil Card).
+
+The CID in Oman is a numeric sequence comprising exactly 8 digits.
+
+More information:
+* https://www.rop.gov.om/english/id_card.html
+
+>>> validate('12345678')
+'12345678'
+>>> validate('1234 5678')
+'12345678'
+>>> is_valid('12345678')
+True
+>>> is_valid('')  # empty
+False
+>>> is_valid('1234567')  # too short
+False
+>>> is_valid('123456789')  # too long
+False
+>>> is_valid('1234567A')  # non-digits
+False
+>>> format('12345678')
+'12345678'
+"""
+
+from stdnum.exceptions import *
+from stdnum.util import clean, isdigits
+
+
+def compact(number):
+    """Convert the number to the minimal representation. This strips the
+    number of any valid separators and removes surrounding whitespace."""
+    return clean(number, ' -').strip()
+
+
+def validate(number):
+    """Check if the number is a valid Civil ID Number.
+    
+    This checks that the number is a numeric sequence of exactly 8 digits."""
+    number = compact(number)
+    if not number:
+        raise InvalidFormat("Empty number provided")
+    if len(number) != 8:
+        raise InvalidLength("The number must be exactly 8 digits long")
+    if not isdigits(number):
+        raise InvalidFormat("The number must contain only digits")
+    return number
+
+
+def is_valid(number):
+    """Check if the number provided is a valid Civil ID Number."""
+    try:
+        return bool(validate(number))
+    except ValidationError:
+        return False
+
+
+def format(number):
+    """Format the number according to the standard presentation format."""
+    return compact(number) 

stdnum/om/tin.py

@@ -0,0 +1,63 @@
+"""TIN (Omani Tax Identification Number).
+
+The Omani Tax Identification Number is a unique identifier assigned by the
+Oman Tax Authority to taxpayers (companies only, not individuals).
+
+The TIN in Oman is a numeric sequence comprising up to seven digits, represented as {xxxxxxx}.
+
+More information:
+* https://tms.taxoman.gov.om/
+* https://lookuptax.com/docs/tax-identification-number/oman-tax-id-guide
+* https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/oman-tin.pdf
+
+>>> validate('123456')
+'123456'
+>>> validate('1 234 567')
+'1234567'
+>>> is_valid('1234567')
+True
+>>> is_valid('')  # empty
+False
+>>> is_valid('12345678')  # too long
+False
+>>> is_valid('123456A')  # non-digits
+False
+>>> format('1234567')
+'1234567'
+"""
+
+from stdnum.exceptions import *
+from stdnum.util import clean, isdigits
+
+
+def compact(number):
+    """Convert the number to the minimal representation. This strips the
+    number of any valid separators and removes surrounding whitespace."""
+    return clean(number, ' -').strip()
+
+
+def validate(number):
+    """Check if the number is a valid TIN.
+    
+    This checks that the number is a numeric sequence of up to seven digits."""
+    number = compact(number)
+    if not number:
+        raise InvalidFormat("Empty number provided")
+    if len(number) > 7:
+        raise InvalidLength("The number must be at most 7 digits long")
+    if not isdigits(number):
+        raise InvalidFormat("The number must contain only digits")
+    return number
+
+
+def is_valid(number):
+    """Check if the number provided is a valid TIN."""
+    try:
+        return bool(validate(number))
+    except ValidationError:
+        return False
+
+
+def format(number):
+    """Format the number according to the standard presentation format."""
+    return compact(number) 

stdnum/om/vat.py

@@ -0,0 +1,71 @@
+"""VAT (Omani Value Added Tax number) or VATIN.
+
+The VAT number (VATIN) is issued by the Oman Tax Authority for VAT registered entities.
+The VATIN consists of an 'OM' prefix followed by 10 digits where:
+- First digit after the prefix is typically '1'
+- The following digits form a sequential number
+- The last digit is a check digit
+
+VAT was introduced in Oman in April 2021.
+
+More information:
+* https://tms.taxoman.gov.om/portal/web/taxportal/vat-tax
+* https://tms.taxoman.gov.om/portal/web/taxportal/tax-data-validation
+* https://lookuptax.com/docs/tax-identification-number/oman-tax-id-guide
+* https://www.oecd.org/content/dam/oecd/en/topics/policy-issue-focus/aeoi/oman-tin.pdf
+
+>>> validate('1234567890')
+'1234567890'
+>>> validate('OM1234567890')
+'1234567890'
+>>> validate('OM1 2345678 90')
+'1234567890'
+>>> is_valid('1234567890')
+True
+>>> is_valid('123456789')  # too short
+False
+>>> is_valid('12345678901')  # too long
+False
+>>> is_valid('123456789A')  # non-digits
+False
+>>> format('1234567890')
+'OM1 2345678 90'
+"""
+
+from stdnum.exceptions import *
+from stdnum.util import clean, isdigits
+
+
+def compact(number):
+    """Convert the number to the minimal representation. This strips the
+    number of any valid separators and removes surrounding whitespace."""
+    number = clean(number, ' -').upper().strip()
+    if number.startswith('OM'):
+        number = number[2:]
+    return number
+
+
+def validate(number):
+    """Check if the number is a valid VAT number.
+    
+    This checks the length and formatting."""
+    number = compact(number)
+    if len(number) != 10:
+        raise InvalidLength()
+    if not isdigits(number):
+        raise InvalidFormat()
+    return number
+
+
+def is_valid(number):
+    """Check if the number provided is a valid VAT number."""
+    try:
+        return bool(validate(number))
+    except ValidationError:
+        return False
+
+
+def format(number):
+    """Format the number according to the standard presentation format."""
+    number = compact(number)
+    return 'OM{} {} {}'.format(number[0], number[1:8], number[8:])