Merge branch 'master' of github.com:CuriousLearner/django-phone-verify into SepehrHasanabadi-kavenegar-api

* 'master' of github.com:CuriousLearner/django-phone-verify:
  chore(deps-dev): Bump django from 2.1.11 to 2.2.10 in /requirements (#36)
  fix(backends): Emit `post_save` signal on phone number verification (#29)

Author: CuriousLearner

README.rst

@@ -120,6 +120,11 @@ Added
 - Support ``Nexmo`` as a backend service alongwith ``Twilio``.
 - Add docs for writing custom backend.
 
+Changed
+"""""""
+
+- Update ``backends.base.BaseBackend.validate_security_code`` to use ``save()`` instead of ``update()`` to allow Django to emit its ``post_save()`` signal.
+
 [1.0.0]
 ^^^^^^^
 

docs/usage.rst

@@ -200,3 +200,27 @@ This is the case when you choose to integrate your user registration process wit
 Otherwise, serializer classes for ``verify`` and ``register`` views will not be available.
 
 3. Latest ``security_code`` generated for a ``phone_number`` can be found at ``/admin/phone_verify/smsverification/`` URL.
+
+4. Django's ``post_save`` signal can be leveraged through its usage in ``phone_verify.models.SMSVerification`` function. Additional functionality can be hooked via the ``post_save`` signal by creating the following receiver.
+
+.. code-block:: python
+
+    # In signals.py
+    from phone_verify.models import SMSVerification
+    from django.db.models.signals import post_save
+    from django.dispatch import receiver
+    from django.core.mail import send_mail
+
+
+    # `send_phone_verify_email` function will get fired when a new entry is created or the model instance is updated
+    @receiver(post_save, sender=SMSVerification)
+    def send_phone_verify_email(sender, instance=None, created=None, **kwargs):
+        # Check if the instance is created or not
+        if created:
+            send_mail(
+                subject='Subject here',
+                message='Here is the message.',
+                from_email='[email protected]',
+                recipient_list=['[email protected]'],
+                fail_silently=False,
+            )

phone_verify/backends/base.py

@@ -132,10 +132,7 @@ def validate_security_code(self, security_code, phone_number, session_token):
             return stored_verification, self.SECURITY_CODE_VERIFIED
 
         # mark security_code as verified
-        stored_verification = SMSVerification.objects.filter(
-            security_code=security_code,
-            phone_number=phone_number,
-            session_token=session_token,
-        ).update(is_verified=True)
+        stored_verification.is_verified = True
+        stored_verification.save()
 
         return stored_verification, self.SECURITY_CODE_VALID

requirements/development.txt

@@ -3,7 +3,7 @@
 
 # Core Stuff
 # -------------------------------------
-Django==2.1.11
+Django==2.2.10
 djangorestframework==3.9.1
 
 # Code quality

tox.ini

@@ -11,7 +11,7 @@ python =
 [testenv]
 usedevelop = True
 deps =
-    -rrequirements/testing.txt
+    -r requirements/testing.txt
     django20: Django>=2.0,<2.1
     django21: Django>=2.1,<2.2
     django22: Django>=2.2a1,<3.0