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
 -----
 

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,32 @@
+# -*- coding: utf-8 -*-
+from __future__ import absolute_import
+
+# Third Party Stuff
+from kavenegar import KavenegarAPI, APIException, HTTPException
+
+# Local
+from .base import BaseBackend
+
+
+class KavenegarException(APIException, HTTPException):
+    pass
+
+
+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("secret", None)
+        self.sender = options.get("from", None)
+
+        self.client = KavenegarAPI(self.api_key)
+        self.exception_class = KavenegarException
+
+    def send_sms(self, number, message):
+        params = {'receptor': number, 'template': '', 'token': message, 'type': 'sms'}
+        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,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,10 +1,10 @@
 # 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
+django-dynamic-fixture==3.0.2
 flake8-mypy==17.8.0
 pytest-mock==1.10.0
 tox==3.13.2

setup.py

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

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

@@ -17,25 +17,29 @@
 SECURITY_CODE = "123456"
 PHONE_NUMBER = "+13478379634"
 SESSION_TOKEN = "phone-auth-session-token"
+BACKEND_SERVICES = [
+    ("twilio.rest.Client", "phone_verify.backends.twilio.TwilioBackend"),
+    ("kavenegar.KavenegarAPI", 'phone_verify.backends.kavenegar.KavenegarBackend')
+]
 
 
 def test_phone_registration_sends_message(client, mocker):
     url = reverse("phone-register")
     phone_number = PHONE_NUMBER
     data = {"phone_number": phone_number}
-    twilio_api = mocker.patch(
-        "phone_verify.services.PhoneVerificationService.send_verification"
-    )
-
-    response = client.post(url, data)
 
-    assert response.status_code == 200
-    assert twilio_api.called
-    assert "session_token" in response.data
-    SMSVerification = apps.get_model("phone_verify", "SMSVerification")
-    assert SMSVerification.objects.get(
-        session_token=response.data["session_token"], phone_number=phone_number
-    )
+    for backend_service, backend in BACKEND_SERVICES:
+        settings.DJANGO_SETTINGS["PHONE_VERIFICATION"]["BACKEND"] = backend
+        api = mocker.patch(backend_service)
+        response = client.post(url, data)
+
+        assert response.status_code == 200
+        assert api.called
+        assert "session_token" in response.data
+        SMSVerification = apps.get_model("phone_verify", "SMSVerification")
+        assert SMSVerification.objects.get(
+            session_token=response.data["session_token"], phone_number=phone_number
+        )
 
 
 def test_security_code_session_token_verification_api(client):

tests/test_services.py

@@ -2,6 +2,7 @@
 
 # Third Party Stuff
 import pytest
+from django.conf import settings
 
 # phone_verify Stuff
 from phone_verify.services import PhoneVerificationService
@@ -11,7 +12,7 @@
 
 def test_message_generation_and_sending_service(client, mocker):
     service = PhoneVerificationService(phone_number="+13478379634")
-    twilio_api = mocker.patch("phone_verify.backends.twilio.TwilioBackend.send_sms")
+    service_api = mocker.patch(f'{settings.PHONE_VERIFICATION["BACKEND"]}.send_sms')
     service.send_verification("+13478379634", "123456")
 
-    assert twilio_api.called
+    assert service_api.called