feat(phone_verify): Add Kavenegar backend

.gitignore

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

README.rst

@@ -83,6 +83,7 @@ Configuration
         "VERIFY_SECURITY_CODE_ONLY_ONCE": False,  # If False, then a security code can be used multiple times for verification
     }
 
+- In case of using Kavenegar as your backend service, you have to replace ``BACKEND`` with ``phone_verify.backends.kavenegar.KavenegarBackend`` and locate your ``API-KEY`` in ``SECRET`` and ``SENDER`` in ``FROM``, extra fields could be omitted.
 Usage
 -----
 

conftest.py

@@ -16,7 +16,7 @@
 
 from tests import test_settings
 
-backends = {"twilio.TwilioBackend", "nexmo.NexmoBackend"}
+backends = {"twilio.TwilioBackend", "nexmo.NexmoBackend", "kavenegar.KavenegarBackend"}
 sandbox_backends = {"twilio.TwilioSandboxBackend", "nexmo.NexmoSandboxBackend"}
 all_backends = list(backends) + list(sandbox_backends)
 

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

phone_verify/backends/kavenegar.py

@@ -0,0 +1,28 @@
+# -*- 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().__init__(**options)
+        # Lower case it just to be sure
+        options = {key.lower(): value for key, value in options.items()}
+        self.api_key = options.get("secret", None)
+        self.sender = options.get("from", None)
+
+        self.client = KavenegarAPI(self.api_key)
+        self.exception_class = APIException, HTTPException
+
+    def send_sms(self, number, message):
+        params = {'sender': self.sender, 'receptor': number, 'message': message, }
+        self.client.sms_send(params)
+
+    def send_bulk_sms(self, numbers, message):
+        params = {'sender': self.sender, 'receptor': numbers, 'message': message, }
+        self.client.sms_sendarray(params)

requirements/common.txt

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

setup.py

@@ -27,6 +27,7 @@
         "phonenumbers>=8.10.2",
         "django-phonenumber-field>=2.1.0",
         "twilio>=6.21.0",
+        "kavenegar>=1.1.2",
         "nexmo>=2.4.0",
     ],
     classifiers=[

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

tests/test_api.py

@@ -24,14 +24,14 @@ def test_phone_registration_sends_message(client, mocker, backend):
     url = reverse("phone-register")
     phone_number = PHONE_NUMBER
     data = {"phone_number": phone_number}
-    twilio_api = mocker.patch(
+
+    mock_api = mocker.patch(
         "phone_verify.services.PhoneVerificationService.send_verification"
     )
-
     response = client.post(url, data)
 
     assert response.status_code == 200
-    assert twilio_api.called
+    assert mock_api.assert_called_once
     assert "session_token" in response.data
     SMSVerification = apps.get_model("phone_verify", "SMSVerification")
     assert SMSVerification.objects.get(

tests/test_backends.py

@@ -57,6 +57,17 @@ def test_backends(client, mocker, backend):
                 "phone_verify.backends.twilio.TwilioRestClient.messages"
             )
             mock_twilio_send_message.create = mocker.MagicMock()
+        elif backend_cls == "kavenegar.KavenegarBackend":
+            # Mock the Kavenegar client
+            mock_kavenegar_send_message = mocker.patch(
+                "phone_verify.backends.kavenegar.KavenegarAPI.sms_send"
+            )
+            test_data = {
+                "receptor": phone_number,
+                "template": "",
+                "token": message,
+                "type": "sms",
+            }
 
         response = client.post(url, data)
         assert response.status_code == 200
@@ -67,6 +78,8 @@ def test_backends(client, mocker, backend):
             mock_twilio_send_message.create.assert_called_once_with(
                 to=phone_number, body=message, from_=from_number
             )
+        elif backend_cls == "kavenegar.KavenegarBackend":
+            mock_kavenegar_send_message.assert_called_once_with(test_data)
 
         # Get the last part of the backend and check if that is a Sandbox Backend
         if backend_cls in sandbox_backends: