updates to folder structure, absolute paths, paths over urls

Author: Dylan Stein

.gitignore

@@ -1,3 +1,105 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

.travis.yml

@@ -1,4 +1,4 @@
-python: '3.5'
+python: '3.6'
 
 language: python
 
@@ -55,4 +55,4 @@ install:
     - pip install tox
 
 script:
-    - tox -e $TOX_ENV
+    - tox -e $TOX_ENV

drfpasswordless/__version__.py

@@ -0,0 +1,3 @@
+VERSION = (1, 1, 5)
+
+__version__ = '.'.join(map(str, VERSION))

drfpasswordless/admin.py

@@ -1,6 +1,6 @@
 from django.contrib import admin
 from django.urls import reverse
-from .models import CallbackToken
+from drfpasswordless.models import CallbackToken
 
 
 class UserLinkMixin(object):

drfpasswordless/apps.py

@@ -1,8 +1,9 @@
 from django.apps import AppConfig
-
+from django.utils.translation import gettext_lazy as _
 
 class DrfpasswordlessConfig(AppConfig):
     name = 'drfpasswordless'
+    verbose = _("DRF Passwordless")
 
     def ready(self):
-        import drfpasswordless.signals  # NOQA
+        import drfpasswordless.signals

drfpasswordless/models.py

@@ -1,5 +1,5 @@
-from random import randint
 import uuid
+from random import randint
 from django.db import models
 from django.conf import settings
 

drfpasswordless/serializers.py

@@ -4,29 +4,22 @@
 from django.core.exceptions import PermissionDenied
 from django.core.validators import RegexValidator
 from rest_framework import serializers
-from .models import CallbackToken
-from .settings import api_settings
-from .utils import authenticate_by_token, verify_user_alias, validate_token_age
+from drfpasswordless.models import CallbackToken
+from drfpasswordless.settings import api_settings
+from drfpasswordless.utils import authenticate_by_token, verify_user_alias, validate_token_age
 
-log = logging.getLogger(__name__)
+logger = logging.getLogger(__name__)
 User = get_user_model()
 
-"""
-Fields
-"""
-
 
 class TokenField(serializers.CharField):
-    default_error_messages = {'required': _('Invalid Token'),
-                              'invalid': _('Invalid Token'),
-                              'blank': _('Invalid Token'),
-                              'max_length': _('Tokens are {max_length} digits long.'),
-                              'min_length': _('Tokens are {min_length} digits long.')}
-
-
-"""
-Auth Token
-"""
+    default_error_messages = {
+        'required': _('Invalid Token'),
+        'invalid': _('Invalid Token'),
+        'blank': _('Invalid Token'),
+        'max_length': _('Tokens are {max_length} digits long.'),
+        'min_length': _('Tokens are {min_length} digits long.')
+    }
 
 
 class AbstractBaseAliasAuthenticationSerializer(serializers.Serializer):
@@ -229,25 +222,25 @@ def validate(self, attrs):
                 # Mark this alias as verified
                 success = verify_user_alias(user, token)
                 if success is False:
-                    log.debug("drfpasswordless: Error verifying alias.")
+                    logger.debug("drfpasswordless: Error verifying alias.")
 
                 attrs['user'] = user
                 return attrs
             else:
                 msg = _('This token is invalid. Try again later.')
-                log.debug("drfpasswordless: User token mismatch when verifying alias.")
+                logger.debug("drfpasswordless: User token mismatch when verifying alias.")
 
         except CallbackToken.DoesNotExist:
             msg = _('Missing authentication token.')
-            log.debug("drfpasswordless: Tried to validate alias with bad token.")
+            logger.debug("drfpasswordless: Tried to validate alias with bad token.")
             pass
         except User.DoesNotExist:
             msg = _('Missing user.')
-            log.debug("drfpasswordless: Tried to validate alias with bad user.")
+            logger.debug("drfpasswordless: Tried to validate alias with bad user.")
             pass
         except PermissionDenied:
             msg = _('Insufficient permissions.')
-            log.debug("drfpasswordless: Permission denied while validating alias.")
+            logger.debug("drfpasswordless: Permission denied while validating alias.")
             pass
 
         raise serializers.ValidationError(msg)

drfpasswordless/services.py

@@ -1,4 +1,8 @@
-from .utils import create_callback_token_for_user, send_email_with_callback_token, send_sms_with_callback_token
+from drfpasswordless.utils import (
+    create_callback_token_for_user,
+    send_email_with_callback_token,
+    send_sms_with_callback_token
+)
 
 
 class TokenService(object):

drfpasswordless/signals.py

@@ -2,10 +2,10 @@
 from django.contrib.auth import get_user_model
 from django.dispatch import receiver
 from django.db.models import signals
-from .models import CallbackToken
-from .models import generate_numeric_token
-from .settings import api_settings
-from .services import TokenService
+from drfpasswordless.models import CallbackToken
+from drfpasswordless.models import generate_numeric_token
+from drfpasswordless.settings import api_settings
+from drfpasswordless.services import TokenService
 
 logger = logging.getLogger(__name__)
 

drfpasswordless/urls.py

@@ -1,15 +1,18 @@
-from django.conf.urls import url
-from .views import (ObtainEmailCallbackToken,
-                    ObtainMobileCallbackToken,
-                    ObtainAuthTokenFromCallbackToken,
-                    VerifyAliasFromCallbackToken,
-                    ObtainEmailVerificationCallbackToken,
-                    ObtainMobileVerificationCallbackToken,
-                    )
+from django.urls import path
+from drfpasswordless.views import (
+     ObtainEmailCallbackToken,
+     ObtainMobileCallbackToken,
+     ObtainAuthTokenFromCallbackToken,
+     VerifyAliasFromCallbackToken,
+     ObtainEmailVerificationCallbackToken,
+     ObtainMobileVerificationCallbackToken,
+)
 
-urlpatterns = [url(r'^callback/auth/$', ObtainAuthTokenFromCallbackToken.as_view(), name='auth_callback'),
-               url(r'^auth/email/$', ObtainEmailCallbackToken.as_view(), name='auth_email'),
-               url(r'^auth/mobile/$', ObtainMobileCallbackToken.as_view(), name='auth_mobile'),
-               url(r'^callback/verify/$', VerifyAliasFromCallbackToken.as_view(), name='verify_callback'),
-               url(r'^verify/email/$', ObtainEmailVerificationCallbackToken.as_view(), name='verify_email'),
-               url(r'^verify/mobile/$', ObtainMobileVerificationCallbackToken.as_view(), name='verify_mobile')]
+urlpatterns = [
+     path('callback/auth/', ObtainAuthTokenFromCallbackToken.as_view(), name='auth_callback'),
+     path('auth/email/', ObtainEmailCallbackToken.as_view(), name='auth_email'),
+     path('auth/mobile/', ObtainMobileCallbackToken.as_view(), name='auth_mobile'),
+     path('callback/verify/', VerifyAliasFromCallbackToken.as_view(), name='verify_callback'),
+     path('verify/email/', ObtainEmailVerificationCallbackToken.as_view(), name='verify_email'),
+     path('verify/mobile/', ObtainMobileVerificationCallbackToken.as_view(), name='verify_mobile'),
+]

drfpasswordless/utils.py

@@ -5,11 +5,11 @@
 from django.core.mail import send_mail
 from django.template import loader
 from django.utils import timezone
-from .models import CallbackToken
-from .settings import api_settings
+from drfpasswordless.models import CallbackToken
+from drfpasswordless.settings import api_settings
 
 
-log = logging.getLogger(__name__)
+logger = logging.getLogger(__name__)
 User = get_user_model()
 
 
@@ -25,11 +25,11 @@ def authenticate_by_token(callback_token):
         return token.user
 
     except CallbackToken.DoesNotExist:
-        log.debug("drfpasswordless: Challenged with a callback token that doesn't exist.")
+        logger.debug("drfpasswordless: Challenged with a callback token that doesn't exist.")
     except User.DoesNotExist:
-        log.debug("drfpasswordless: Authenticated user somehow doesn't exist.")
+        logger.debug("drfpasswordless: Authenticated user somehow doesn't exist.")
     except PermissionDenied:
-        log.debug("drfpasswordless: Permission denied while authenticating.")
+        logger.debug("drfpasswordless: Permission denied while authenticating.")
 
     return None
 
@@ -133,15 +133,15 @@ def send_email_with_callback_token(user, email_token, **kwargs):
                 html_message=html_message,)
 
         else:
-            log.debug("Failed to send token email. Missing PASSWORDLESS_EMAIL_NOREPLY_ADDRESS.")
+            logger.debug("Failed to send token email. Missing PASSWORDLESS_EMAIL_NOREPLY_ADDRESS.")
             return False
         return True
 
     except Exception as e:
-        log.debug("Failed to send token email to user: %d."
+        logger.debug("Failed to send token email to user: %d."
                   "Possibly no email on user object. Email entered was %s" %
                   (user.id, getattr(user, api_settings.PASSWORDLESS_USER_EMAIL_FIELD_NAME)))
-        log.debug(e)
+        logger.debug(e)
         return False
 
 
@@ -170,17 +170,17 @@ def send_sms_with_callback_token(user, mobile_token, **kwargs):
             )
             return True
         else:
-            log.debug("Failed to send token sms. Missing PASSWORDLESS_MOBILE_NOREPLY_NUMBER.")
+            logger.debug("Failed to send token sms. Missing PASSWORDLESS_MOBILE_NOREPLY_NUMBER.")
             return False
     except ImportError:
-        log.debug("Couldn't import Twilio client. Is twilio installed?")
+        logger.debug("Couldn't import Twilio client. Is twilio installed?")
         return False
     except KeyError:
-        log.debug("Couldn't send SMS."
+        logger.debug("Couldn't send SMS."
                   "Did you set your Twilio account tokens and specify a PASSWORDLESS_MOBILE_NOREPLY_NUMBER?")
     except Exception as e:
-        log.debug("Failed to send token SMS to user: %d. "
+        logger.debug("Failed to send token SMS to user: %d. "
                   "Possibly no mobile number on user object or the twilio package isn't set up yet. "
                   "Number entered was %s" % (user.id, getattr(user, api_settings.PASSWORDLESS_USER_MOBILE_FIELD_NAME)))
-        log.debug(e)
+        logger.debug(e)
         return False

drfpasswordless/views.py

@@ -15,7 +15,7 @@
 )
 from drfpasswordless.services import TokenService
 
-log = logging.getLogger(__name__)
+logger = logging.getLogger(__name__)
 
 
 class AbstractBaseObtainCallbackToken(APIView):
@@ -146,7 +146,7 @@ def post(self, request, *args, **kwargs):
                 # Return our key for consumption.
                 return Response({'token': token.key}, status=status.HTTP_200_OK)
         else:
-            log.error(
+            logger.error(
                 "Couldn't log in unknown user. Errors on serializer: %s" % (serializer.error_messages, ))
         return Response({'detail': 'Couldn\'t log you in. Try again later.'},
                         status=status.HTTP_400_BAD_REQUEST)
@@ -177,7 +177,7 @@ def post(self, request, *args, **kwargs):
 
             return Response({'detail': 'Alias verified.'}, status=status.HTTP_200_OK)
         else:
-            log.error(
+            logger.error(
                 "Couldn't verify unknown user. Errors on serializer: %s" % (serializer.error_messages, ))
 
         return Response({'detail': 'We couldn\'t verify this alias. Try again later.'}, status.HTTP_400_BAD_REQUEST)