change settings name and import setup

Author: Marco DiDomenico

README.md

@@ -27,10 +27,21 @@ Register Your Application with Replyify
 Configure the django-replyify-oauth2 module
 -------------------------------------------
 
-From your previously configured app, found at https://app.replyify.com/oauth2/applications:
-* _settings.REPLYIFY_CLIENT_ID
-* _settings.REPLYIFY_CLIENT_SECRET
-* _settings.REPLYIFY_REDIRECT_URI
+From your previously configured app, found at https://app.replyify.com/oauth2/applications add the following to your Django settings:
+* REPLYIFY_CLIENT_ID
+* REPLYIFY_CLIENT_SECRET
+* REPLYIFY_REDIRECT_URI
+* REPLYIFY_USER_ID_FIELD
+
+And add the following to your `urls.py`
+
+	urlpatterns = patterns(
+    	...
+    	url(r'^replyify/', include('replyify_oauth2.urls', namespace='replyify')),
+    	...
+    )
+
+
 
 
 Using the Replyify API

README.rst

@@ -31,10 +31,20 @@ Register Your Application with Replyify
 Configure the django-replyify-oauth2 module
 -------------------------------------------
 
-From your previously configured app, found at
-https://app.replyify.com/oauth2/applications: \*
-\_settings.REPLYIFY\_CLIENT\_ID \* \_settings.REPLYIFY\_CLIENT\_SECRET
-\* \_settings.REPLYIFY\_REDIRECT\_URI
+From your previously configured app, found at https://app.replyify.com/oauth2/applications add the following to your Django settings:
+* REPLYIFY_CLIENT_ID
+* REPLYIFY_CLIENT_SECRET
+* REPLYIFY_REDIRECT_URI
+* REPLYIFY_USER_ID_FIELD
+
+And add the following to your :: urls.py
+::
+	urlpatterns = patterns(
+    	...
+    	url(r'^replyify/', include('replyify_oauth2.urls', namespace='replyify')),
+    	...
+    )
+
 
 Using the Replyify API
 ----------------------

replyify_oauth2/_settings.py

@@ -3,19 +3,21 @@
 
 from django.db import migrations, models
 import django.utils.timezone
+from django.conf import settings
 
 
 class Migration(migrations.Migration):
 
     dependencies = [
+        migrations.swappable_dependency(settings.AUTH_USER_MODEL),
     ]
 
     operations = [
         migrations.CreateModel(
             name='Credentials',
             fields=[
                 ('id', models.AutoField(verbose_name='ID', serialize=False, auto_created=True, primary_key=True)),
-                ('uid', models.CharField(max_length=50)),
+                ('user', models.OneToOneField(null=True, to=settings.AUTH_USER_MODEL)),
                 ('access_token', models.CharField(max_length=50)),
                 ('refresh_token', models.CharField(max_length=50)),
                 ('expires', models.DateTimeField(default=django.utils.timezone.now)),

replyify_oauth2/migrations/0001_initial.py

@@ -7,19 +7,25 @@
 #
 
 from __future__ import unicode_literals
+from django.conf import settings
 from django.db import models
 from django.utils import timezone
 
 
 class Credentials(models.Model):
-    uid = models.CharField(max_length=50)
+    user = models.OneToOneField(getattr(settings, 'AUTH_USER_MODEL', 'auth.User'), on_delete=models.CASCADE)
     access_token = models.CharField(max_length=50)
     refresh_token = models.CharField(max_length=50)
     expires = models.DateTimeField(default=timezone.now)
     scope = models.CharField(max_length=50)
     token_type = models.CharField(max_length=50)
+    updated = models.DateTimeField(auto_now=True)
+    created = models.DateTimeField(auto_now_add=True)
 
     def expired(self):
         if timezone.now() > self.expires:
             return True
         return False
+
+    def __unicode__(self):
+        return '<Replyify Creds: {}>'.format(self.access_token)

replyify_oauth2/models.py

@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+#
+# This file is subject to the terms and conditions defined in
+# file 'LICENSE.md', which is part of this source code package.
+#
+from django.conf import settings
+
+REPLYIFY_CLIENT_ID = getattr(settings, 'REPLYIFY_CLIENT_ID', None)
+REPLYIFY_CLIENT_SECRET = getattr(settings, 'REPLYIFY_CLIENT_SECRET', None)
+REPLYIFY_REDIRECT_URI = getattr(settings, 'REPLYIFY_REDIRECT_URI', None)
+
+REPLYIFY_AUTH_URL = getattr(settings, 'REPLYIFY_AUTH_URL', 'https://app.replyify.com/oauth2/authorize')
+REPLYIFY_TOKEN_URL = getattr(settings, 'REPLYIFY_TOKEN_URL', 'https://app.replyify.com/oauth2/token')
+
+REPLYIFY_USER_ID_FIELD = getattr(settings, 'REPLYIFY_USER_ID_FIELD', 'id')

replyify_oauth2/settings.py

@@ -6,17 +6,18 @@
 # file 'LICENSE.md', which is part of this source code package.
 #
 
-from datetime import timedelta
-
-import requests
+try:
+    from . import settings
+except ImportError:
+    import settings
 from django.contrib.auth.decorators import login_required
 from django.http import HttpResponse
 from django.shortcuts import redirect
 from django.utils import timezone
 from django.utils.crypto import get_random_string
-
-import _settings
 from .models import Credentials
+from datetime import timedelta
+import requests
 
 
 def index(request=None):
@@ -25,9 +26,9 @@ def index(request=None):
 
 @login_required
 def authorize(request=None):
-    uid = _get_uid(request)
-    client_id = _settings.REPLYIFY_CLIENT_ID
-    redirect_uri = _settings.REPLYIFY_REDIRECT_URI
+    uid = getattr(request.user, settings.REPLYIFY_USER_ID_FIELD)
+    client_id = settings.REPLYIFY_CLIENT_ID
+    redirect_uri = settings.REPLYIFY_REDIRECT_URI
     response_type = 'code'
 
     state = get_random_string(20, "abcdefghijklmnopqrstuvwxyz0123456789")
@@ -39,7 +40,7 @@ def authorize(request=None):
         "response_type={0}".format(response_type),
         "state={0}".format(state)
     ]
-    url = "{0}?{1}".format(_settings.REPLYIFY_AUTH_URL, "&".join(args))
+    url = "{0}?{1}".format(settings.REPLYIFY_AUTH_URL, "&".join(args))
 
     return redirect(url)
 
@@ -61,39 +62,29 @@ def refresh(request=None):
     if 'error' in request.GET:
         raise Exception(request.GET['error'])
 
-    uid = _get_uid(request)
-
     try:
-        creds = Credentials.objects.get(uid=uid)
+        creds = Credentials.objects.get(user=request.user)
 
         data = {
             'grant_type': 'refresh_token',
-            'client_id': _settings.REPLYIFY_CLIENT_ID,
-            'client_secret': _settings.REPLYIFY_CLIENT_SECRET,
+            'client_id': settings.REPLYIFY_CLIENT_ID,
+            'client_secret': settings.REPLYIFY_CLIENT_SECRET,
             'refresh_token': creds.refresh_token
         }
 
-        url = _settings.REPLYIFY_TOKEN_URL
+        url = settings.REPLYIFY_TOKEN_URL
         r = requests.post(url=url, data=data)
         data = r.json()
 
-        creds = _store_credentials(uid=uid, data=data)
+        creds = _store_credentials(user=request.user, data=data)
         return HttpResponse(creds)
 
     except Credentials.DoesNotExist:
         authorize(request)
 
 
-def _get_uid(request=None):
-    if hasattr(request.user, 'guid'):
-        uid = request.user.guid
-    else:
-        uid = request.user.id
-    return uid
-
-
 def _check_state(request=None):
-    uid = _get_uid(request)
+    uid = getattr(request.user, settings.REPLYIFY_USER_ID_FIELD)
     msg = "Something fishy is happening. Abort ..."
 
     if 'state' not in request.session:
@@ -112,32 +103,21 @@ def _exchange_auth_code(request=None):
     data = {
         'grant_type': 'authorization_code',
         'code': code,
-        'client_id': _settings.REPLYIFY_CLIENT_ID,
-        'redirect_uri': _settings.REPLYIFY_REDIRECT_URI
+        'client_id': settings.REPLYIFY_CLIENT_ID,
+        'redirect_uri': settings.REPLYIFY_REDIRECT_URI
     }
-    url = _settings.REPLYIFY_TOKEN_URL
+    url = settings.REPLYIFY_TOKEN_URL
     r = requests.post(url=url, data=data)
     return r.json()
 
 
-def _store_credentials(uid=None, data=None):
-    try:
-        creds = Credentials.objects.get(uid=uid)
-        creds.access_token = data['access_token']
-        creds.refresh_token = data['refresh_token']
-        creds.expires = timezone.now() + timedelta(seconds=data['expires_in'])
-        creds.scope = data['scope']
-        creds.token_type = data['token_type']
-        creds.save()
-
-    except Credentials.DoesNotExist:
-        creds = Credentials.objects.create(
-            uid=uid,
-            access_token=data['access_token'],
-            refresh_token=data['refresh_token'],
-            expires=timezone.now() + timedelta(seconds=data['expires_in']),
-            scope=data['scope'],
-            token_type=data['token_type']
-        )
-
+def _store_credentials(user, data=None):
+    assert user is not None
+    creds, _ = Credentials.objects.get_or_create(user=user)
+    creds.access_token = data['access_token']
+    creds.refresh_token = data['refresh_token']
+    creds.expires = timezone.now() + timedelta(seconds=data['expires_in'])
+    creds.scope = data['scope']
+    creds.token_type = data['token_type']
+    creds.save()
     return creds