initial

Author: Ross Crawford-d'Heureuse

README.md

@@ -0,0 +1,57 @@
+django-dj_authy
+====================
+
+A Django app for integrating with dj_authy
+
+
+Installation
+------------
+
+1. python setup.py
+2. pip install requirements.txt
+3. add dj_authy to INSTALLED_APPS
+
+Settings
+--------
+
+
+__Required__
+
+
+```
+SNOWSHOESTAMP_KEY : the oauth key for your app
+SNOWSHOESTAMP_SECRET : the oauth secret for your app
+```
+
+
+__Example Implementation__
+
+
+```views.py
+```
+
+
+__Please Note__
+
+A signal will be issued when recieving callbacks from dj_authy
+
+
+__Signal Example Implementation__
+
+
+```signals.py
+from django.dispatch import receiver
+
+from dj_authy.signals import dj_authy_event
+
+
+@receiver(dj_authy_event)
+def on_dj_authy_callback(sender, stamp_serial, **kwargs):
+    # do something amazing with the data in the kwargs dict
+    pass
+```
+
+
+__TODO__
+
+1. tests

dj_authy/__init__.py

@@ -0,0 +1,4 @@
+# -*- coding: utf-8 -*-
+from django.contrib import admin
+
+# Register your models here.

dj_authy/admin.py

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+from django.db import models
+from django.db import IntegrityError
+from django.contrib.auth.models import User
+
+from jsonfield import JSONField
+from django_countries.fields import CountryField
+from phonenumber_field.modelfields import PhoneNumberField
+
+from .services import AuthyService
+
+import logging
+logger = logging.getLogger('django.request')
+
+
+class AuthyProfile(models.Model):
+    user = models.OneToOneField('auth.User')
+    authy_id = models.CharField(max_length=64, null=True, db_index=True)
+    cellphone = PhoneNumberField(db_index=True, null=True)
+    country = CountryField(null=True)
+    is_smartphone = models.BooleanField(default=True)
+    data = JSONField(default={})
+
+    @property
+    def service(self):
+        return AuthyService(user=self.user, authy_profile=self)
+
+
+def _get_or_create_authy_profile(user):
+    # set the profile
+    try:
+        profile, is_new = AuthyProfile.objects.get_or_create(user=user)  # added like this so django noobs can see the result of get_or_create
+        return (profile, is_new,)
+    except IntegrityError as e:
+        logger.critical('transaction.atomic() integrity error: %s' % e)
+    return (None, None,)
+
+
+# used to trigger profile creation by accidental reference. Rather use the _create_authy_profile def above
+User.authy_profile = property(lambda u: _get_or_create_authy_profile(user=u)[0])

dj_authy/mixins.py

@@ -0,0 +1,80 @@
+# -*- coding: utf-8 -*-
+from django.conf import settings
+from authy.api import AuthyApiClient
+
+AUTHY_KEY = getattr(settings, 'AUTHY_KEY', None)
+AUTHY_FORCE_VERIFICATION = getattr(settings, 'AUTHY_FORCE_VERIFICATION', True)
+
+assert AUTHY_KEY, 'You must define a settings.AUTHY_KEY'
+
+from .signals import authy_event
+
+import logging
+logger = logging.getLogger('django.request')
+
+
+class AuthyService(object):
+    """
+    Service for interacting with Authy
+    """
+    user = None
+    authy_profile = None
+
+    client = None
+    force_verification = False
+
+    def __init__(self, user, *args, **kwargs):
+        # Allow overrides
+        self.user = user
+        self.authy_profile = kwargs.get('authy_profile', user.authy_profile) # hope its passed in otherwise get it, efficent
+
+        self.key = kwargs.get('key', AUTHY_KEY)
+        self.force_verification = kwargs.get('force_verification', AUTHY_FORCE_VERIFICATION)
+
+        self.client = AuthyApiClient(self.key)
+        logger.info('Initialized authy.Client with key: %s' % self.key)
+
+        self.ensure_user_registered()
+
+    @property
+    def authy_id(self):
+        return int(self.authy_profile.authy_id)
+
+    def ensure_user_registered(self):
+        if self.authy_profile.authy_id is None:
+
+            authy_user = self.client.users.create(self.user.email,
+                                                  int(self.authy_profile.cellphone.national_number), # phonenumberfield stores as long
+                                                  self.authy_profile.cellphone.country_code) #email, cellphone, area_code
+
+            if authy_user.ok():
+                self.authy_profile.authy_id = authy_user.id
+                self.authy_profile.save(update_fields=['authy_id'])
+
+            else:
+                errors = authy_user.errors()
+                msg = 'Could not register Auth.user: %s' % errors
+                logger.error(msg)
+                raise Exception(msg)
+        logger.info('Authy user: %s %s' % (self.user, self.authy_profile.authy_id))
+        return True
+
+    def request_sms_token(self):
+        if self.authy_profile.is_smartphone is True:
+            sms = self.client.users.request_sms(self.authy_id)
+        else:
+            sms = self.client.users.request_sms(self.authy_id, {"force": True})  # force as the user is on an older phone with no app installed
+
+        ok = sms.ok()
+        return ok if ok is True else sms.errors()
+
+    def verify_token(self, token):
+        if type(token) not in [int]:
+            raise Exception('Authy token must be an integer')
+
+        verification = self.client.tokens.verify(self.authy_id, token, {"force": self.force_verification})
+        verified = verification.ok()
+        errors = verification.errors()
+        if not verified:
+            logger.error('User: %s could not be verified using the token: %s due to: %s' % (self.user, token, errors))
+        return verified

dj_authy/models.py

@@ -0,0 +1,10 @@
+# -*- coding: utf-8 -*-
+"""
+Webhook signals
+"""
+from django.dispatch import Signal
+
+#
+# Outgoing Events
+#
+authy_event = Signal(providing_args=[])

dj_authy/services.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

dj_authy/signals.py

@@ -0,0 +1 @@
+# -*- coding: utf-8 -*-

dj_authy/tests.py

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+from django.shortcuts import render
+
+# Create your views here.
+

dj_authy/urls.py

@@ -0,0 +1,4 @@
+authy
+django-phonenumber-field
+django-countries
+-e git+https://github.com/rosscdh/django-jsonfield.git@lawpal#egg=django-jsonfield

dj_authy/views.py

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+import os, sys
+from django.conf import settings
+from django.core.management import call_command
+
+DIRNAME = os.path.dirname(__file__)
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(DIRNAME, 'database.db'),
+    }
+}
+
+settings.configure(DEBUG = True,
+                   DATABASES=DATABASES,
+                   USE_TZ=True,
+                   AUTHY_KEY='12345678910111213141516171819201234567891011121314151617181920',
+                   ROOT_URLCONF='authy.urls',
+                   PASSWORD_HASHERS=('django.contrib.auth.hashers.MD5PasswordHasher',),  # simple fast hasher but not secure
+                   INSTALLED_APPS = ('django.contrib.auth',
+                                     'django.contrib.contenttypes',
+                                     'django.contrib.sessions',
+                                     'django.contrib.admin',
+                                     'authy',))
+
+
+from django.test.simple import DjangoTestSuiteRunner
+
+call_command('syncdb', interactive=False)
+
+failures = DjangoTestSuiteRunner().run_tests(['authy',], verbosity=1)
+if failures:
+    sys.exit(failures)

requirements.txt

@@ -0,0 +1,19 @@
+from setuptools import setup
+
+setup(
+    name="authy",
+    packages=['authy'],
+    version='0.1.0',
+    author="Ross Crawford-d'Heureuse",
+    license="MIT",
+    author_email="[email protected]",
+    url="https://github.com/rosscdh/django-authy",
+    description="A Django app for integrating with authy",
+    zip_safe=False,
+    include_package_data=True,
+    install_requires = [
+        'authy',
+        'django-phonenumber-field',
+        'django-countries',
+    ]
+)