Implement online TC Kimlik check

arthurdejong · arthurdejong · commit feab9177256f · 2016-04-09T23:09:58.000+02:00
This refactors out the SOAP client function that was implemented for
VIES to the stdnum.utils module.
diff --git a/stdnum/eu/vat.py b/stdnum/eu/vat.py
@@ -40,7 +40,7 @@
 """
 
 from stdnum.exceptions import *
-from stdnum.util import clean, get_vat_module
+from stdnum.util import clean, get_vat_module, get_soap_client
 
 
 country_codes = set([
@@ -118,18 +118,7 @@ def _get_client():  # pragma: no cover (no tests for this function)
     # it are not automatically tested
     global _vies_client
     if _vies_client is None:
-        try:
-            from urllib import getproxies
-        except ImportError:
-            from urllib.request import getproxies
-        # try suds first
-        try:
-            from suds.client import Client
-            _vies_client = Client(vies_wsdl, proxy=getproxies()).service
-        except ImportError:
-            # fall back to using pysimplesoap
-            from pysimplesoap.client import SoapClient
-            _vies_client = SoapClient(wsdl=vies_wsdl, proxy=getproxies())
+        _vies_client = get_soap_client(vies_wsdl)
     return _vies_client
 
 
diff --git a/stdnum/tr/tckimlik.py b/stdnum/tr/tckimlik.py
@@ -45,7 +45,15 @@
 """
 
 from stdnum.exceptions import *
-from stdnum.util import clean
+from stdnum.util import clean, get_soap_client
+
+
+tckimlik_wsdl = 'https://tckimlik.nvi.gov.tr/Service/KPSPublic.asmx?WSDL'
+"""The WSDL URL of the T.C. Kimlik validation service."""
+
+
+# a cached version of the SOAP client for Kimlik validation
+_tckimlik_client = None
 
 
 def compact(number):
@@ -83,3 +91,27 @@ def is_valid(number):
         return bool(validate(number))
     except ValidationError:
         return False
+
+
+def _get_client():  # pragma: no cover (no tests for this function)
+    """Get a SOAP client for performing T.C. Kimlik validation."""
+    # this function isn't automatically tested because the functions using
+    # it are not automatically tested
+    global _tckimlik_client
+    if _tckimlik_client is None:
+        _tckimlik_client = get_soap_client(tckimlik_wsdl)
+    return _tckimlik_client
+
+
+def check_kps(number, name, surname, birth_year):  # pragma: no cover
+    """Queries the online T.C. Kimlik validation service run by the
+    Directorate of Population and Citizenship Affairs. This returns a boolean
+    but may raise a SOAP exception for missing or invalid values."""
+    # this function isn't automatically tested because it would require
+    # network access for the tests and unnecessarily load the online service
+    number = compact(number)
+    result = _get_client().TCKimlikNoDogrula(
+        TCKimlikNo=number, Ad=name, Soyad=surname, DogumYili=birth_year)
+    if hasattr(result, 'get'):
+        return result.get('TCKimlikNoDogrulaResult')
+    return result
diff --git a/stdnum/util.py b/stdnum/util.py
@@ -1,7 +1,7 @@
 # util.py - common utility functions
 # coding: utf-8
 #
-# Copyright (C) 2012, 2013, 2015 Arthur de Jong
+# Copyright (C) 2012-2016 Arthur de Jong
 #
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Lesser General Public
@@ -178,3 +178,21 @@ def get_vat_module(cc):
     cc = cc.lower()
     cc = _cc_translations.get(cc, cc)
     return __import__('stdnum.%s' % cc, globals(), locals(), ['vat']).vat
+
+
+def get_soap_client(wsdlurl):  # pragma: no cover (no tests for this function)
+    """Get a SOAP client for performing requests."""
+    # this function isn't automatically tested because the functions using
+    # it are not automatically tested
+    try:
+        from urllib import getproxies
+    except ImportError:
+        from urllib.request import getproxies
+    # try suds first
+    try:
+        from suds.client import Client
+        return Client(wsdlurl, proxy=getproxies()).service
+    except ImportError:
+        # fall back to using pysimplesoap
+        from pysimplesoap.client import SoapClient
+        return SoapClient(wsdl=wsdlurl, proxy=getproxies())
