feat(phone_verify): Add Kavenegar backend

.gitignore

@@ -102,3 +102,6 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# vscode configuration
+.vscode

phone_verify/backends/__init__.py

@@ -13,8 +13,8 @@ def get_sms_backend(phone_number):
     if not backend:
         backend_import = DEFAULT_SERVICE
 
-        if settings.PHONE_VERIFICATION.get("BACKEND", None):
-            backend_import = settings.PHONE_VERIFICATION["BACKEND"]
+        if settings.PHONE_VERIFICATION['DEFAULT'].get("BACKEND", None):
+            backend_import = settings.PHONE_VERIFICATION['DEFAULT']["BACKEND"]
 
         backend_cls = import_string(backend_import)
-        return backend_cls(**settings.PHONE_VERIFICATION["OPTIONS"])
+        return backend_cls(**settings.PHONE_VERIFICATION['DEFAULT']["OPTIONS"])

phone_verify/backends/base.py

@@ -24,7 +24,7 @@ def __init__(self, **settings):
         self.exception_class = None
 
     @abstractmethod
-    def send_sms(self, numbers, message):
+    def send_sms(self, number, message):
         raise NotImplementedError()
 
     @abstractmethod
@@ -36,7 +36,7 @@ def generate_security_code(cls):
         """
         Returns a unique random `security_code` for given `TOKEN_LENGTH` in the settings.
         """
-        token_length = django_settings.PHONE_VERIFICATION.get(
+        token_length = django_settings.PHONE_VERIFICATION['DEFAULT'].get(
             "TOKEN_LENGTH", DEFAULT_TOKEN_LENGTH
         )
         return get_random_string(token_length, allowed_chars="0123456789")
@@ -56,7 +56,7 @@ def check_security_code_expiry(cls, stored_verification):
         Returns True if the `security_code` for the `stored_verification` is expired.
         """
         time_difference = timezone.now() - stored_verification.created_at
-        if time_difference.seconds > django_settings.PHONE_VERIFICATION.get(
+        if time_difference.seconds > django_settings.PHONE_VERIFICATION['DEFAULT'].get(
             "SECURITY_CODE_EXPIRATION_TIME"
         ):
             return True
@@ -126,7 +126,7 @@ def validate_security_code(self, security_code, phone_number, session_token):
             return stored_verification, self.SECURITY_CODE_EXPIRED
 
         # check security_code is not verified
-        if stored_verification.is_verified and django_settings.PHONE_VERIFICATION.get(
+        if stored_verification.is_verified and django_settings.PHONE_VERIFICATION['DEFAULT'].get(
             "VERIFY_SECURITY_CODE_ONLY_ONCE"
         ):
             return stored_verification, self.SECURITY_CODE_VERIFIED

phone_verify/backends/kavenegar.py

@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import
+
+# Third Party Stuff
+from kavenegar import KavenegarAPI, APIException, HTTPException
+
+# Local
+from .base import BaseBackend
+
+
+class KavenegarBackend(BaseBackend):
+	def __init__(self, **options):
+		super(KavenegarBackend, self).__init__(**options)
+		# Lower case it just to be sure
+		options = {key.lower(): value for key, value in options.items()}
+		self._api_key = options.get("api_key", None)
+		self._sender = options.get("sender", None)
+
+		self._api = KavenegarAPI(self._api_key)
+
+	def send_sms(self, number, message):
+		try:
+			params = {
+				'receptor': number,
+				'template': '',
+				'token': message,
+				'type': 'sms'
+			}
+			response = self._api.sms_send(params)
+			print(response)
+		except APIException as exp:
+			print(exp)
+		except HTTPException as exp:
+			print(exp)
+
+	def send_bulk_sms(self, numbers, message):
+		try:
+			params = {
+				'sender': self._sender,
+				'receptor': numbers,
+				'message': message,
+			}
+			response = self._api.sms_sendarray(params)
+			print(response)
+		except APIException as exp:
+			print(exp)
+		except HTTPException as exp:
+			print(exp)

phone_verify/serializers.py

@@ -15,35 +15,35 @@
 
 
 class PhoneSerializer(serializers.Serializer):
-    phone_number = PhoneNumberField()
+	phone_number = PhoneNumberField()
 
 
 class SMSVerificationSerializer(serializers.Serializer):
-    phone_number = PhoneNumberField(required=True)
-    session_token = serializers.CharField(required=True)
-    security_code = serializers.CharField(required=True)
-
-    def validate(self, attrs):
-        attrs = super().validate(attrs)
-        phone_number = attrs.get("phone_number", None)
-        security_code, session_token = (
-            attrs.get("security_code", None),
-            attrs.get("session_token", None),
-        )
-        backend = get_sms_backend(phone_number=phone_number)
-        verification, token_validatation = backend.validate_security_code(
-            security_code=security_code,
-            phone_number=phone_number,
-            session_token=session_token,
-        )
-
-        if verification is None:
-            raise serializers.ValidationError(_("Security code is not valid"))
-        elif token_validatation == backend.SESSION_TOKEN_INVALID:
-            raise serializers.ValidationError(_("Session Token mis-match"))
-        elif token_validatation == backend.SECURITY_CODE_EXPIRED:
-            raise serializers.ValidationError(_("Security code has expired"))
-        elif token_validatation == backend.SECURITY_CODE_VERIFIED:
-            raise serializers.ValidationError(_("Security code is already verified"))
-
-        return attrs
+	phone_number = PhoneNumberField(required=True)
+	session_token = serializers.CharField(required=True)
+	security_code = serializers.CharField(required=True)
+
+	def validate(self, attrs):
+		attrs = super().validate(attrs)
+		phone_number = attrs.get("phone_number", None)
+		security_code, session_token = (
+			attrs.get("security_code", None),
+			attrs.get("session_token", None),
+		)
+		backend = get_sms_backend(phone_number=phone_number)
+		verification, token_validatation = backend.validate_security_code(
+			security_code=security_code,
+			phone_number=phone_number,
+			session_token=session_token,
+		)
+
+		if verification is None:
+			raise serializers.ValidationError(_("Security code is not valid"))
+		elif token_validatation == backend.SESSION_TOKEN_INVALID:
+			raise serializers.ValidationError(_("Session Token mis-match"))
+		elif token_validatation == backend.SECURITY_CODE_EXPIRED:
+			raise serializers.ValidationError(_("Security code has expired"))
+		elif token_validatation == backend.SECURITY_CODE_VERIFIED:
+			raise serializers.ValidationError(_("Security code is already verified"))
+
+		return attrs

requirements/common.txt

@@ -11,3 +11,4 @@ python-dotenv==0.10.0
 phonenumbers==8.10.2
 django-phonenumber-field==2.1.0
 twilio==6.21.0
+kavenegar==1.1.2

requirements/testing.txt

@@ -1,7 +1,7 @@
 # Testing
 # -------------------------------------
-pytest==4.2.1
-pytest-django==3.4.4
+pytest==5.3.1
+pytest-django==3.7.0
 pytest-cov==2.6.1
 
 django-dynamic-fixture==2.0.0

tests/factories.py

@@ -7,6 +7,6 @@
 
 
 def create_verification(**kwargs):
-    SMSVerification = apps.get_model("phone_verify", "SMSVerification")
-    verification = G(SMSVerification, **kwargs)
+    sms_verification = apps.get_model("phone_verify", "SMSVerification")
+    verification = G(sms_verification, **kwargs)
     return verification