Skip to content

Commit 6a84d85

Browse files
committed
Add change in documentation and tests for social connect
1 parent 3eb546f commit 6a84d85

File tree

4 files changed

+201
-16
lines changed

4 files changed

+201
-16
lines changed

docs/installation.rst

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -111,23 +111,18 @@ Facebook
111111
.. code-block:: python
112112
113113
from allauth.socialaccount.providers.facebook.views import FacebookOAuth2Adapter
114-
from rest_auth.registration.views import SocialLoginView, SocialConnectView
114+
from rest_auth.registration.views import SocialLoginView
115115
116116
class FacebookLogin(SocialLoginView):
117117
adapter_class = FacebookOAuth2Adapter
118118
119-
# Add a connect view if you want to allow connecting existing accounts
120-
class FacebookConnect(SocialConnectView):
121-
adapter_class = FacebookOAuth2Adapter
122-
123119
4. Create url for FacebookLogin view:
124120

125121
.. code-block:: python
126122
127123
urlpatterns += [
128124
...,
129125
url(r'^rest-auth/facebook/$', FacebookLogin.as_view(), name='fb_login')
130-
url(r'^rest-auth/facebook/connect/$', FacebookConnect.as_view(), name='fb_connect')
131126
]
132127
133128
@@ -142,18 +137,12 @@ If you are using Twitter for your social authentication, it is a bit different s
142137
143138
from allauth.socialaccount.providers.twitter.views import TwitterOAuthAdapter
144139
from rest_auth.registration.views import SocialLoginView
145-
from rest_auth.social_serializers import TwitterLoginSerializer, TwitterConnectSerializer
140+
from rest_auth.social_serializers import TwitterLoginSerializer
146141
147142
class TwitterLogin(SocialLoginView):
148143
serializer_class = TwitterLoginSerializer
149144
adapter_class = TwitterOAuthAdapter
150145
151-
# Add a connect view if you want to allow connecting existing accounts
152-
class TwitterConnect(SocialConnectView):
153-
serializer_class = TwitterConnectSerializer
154-
adapter_class = TwitterOAuthAdapter
155-
156-
157146
4. Create url for TwitterLogin view:
158147

159148
.. code-block:: python
@@ -168,7 +157,32 @@ If you are using Twitter for your social authentication, it is a bit different s
168157
Additional Social Connect Views
169158
###############################
170159

171-
If you are using social connect views, you can also use additional views to check all social accounts attached to the current authenticated user and disconnect selected social accounts.
160+
If you want to allow connecting existing accounts in addition to just login, you can use connect views:
161+
162+
.. code-block:: python
163+
164+
from allauth.socialaccount.providers.facebook.views import FacebookOAuth2Adapter
165+
from rest_auth.registration.views import SocialConnectView
166+
from rest_auth.social_serializers import TwitterConnectSerializer
167+
168+
class FacebookConnect(SocialConnectView):
169+
adapter_class = FacebookOAuth2Adapter
170+
171+
class TwitterConnect(SocialConnectView):
172+
serializer_class = TwitterConnectSerializer
173+
adapter_class = TwitterOAuthAdapter
174+
175+
In urls.py:
176+
177+
.. code-block:: python
178+
179+
urlpatterns += [
180+
...,
181+
url(r'^rest-auth/facebook/connect/$', FacebookConnect.as_view(), name='fb_connect')
182+
url(r'^rest-auth/twitter/connect/$', TwitterConnect.as_view(), name='twitter_connect')
183+
]
184+
185+
You can also use additional views to check all social accounts attached to the current authenticated user and disconnect selected social accounts.
172186

173187
.. code-block:: python
174188

rest_auth/tests/mixins.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,9 @@ def init(self):
9090
self.tw_login_url = reverse('tw_login')
9191
self.tw_login_no_view_url = reverse('tw_login_no_view')
9292
self.tw_login_no_adapter_url = reverse('tw_login_no_adapter')
93+
self.fb_connect_url = reverse('fb_connect')
94+
self.tw_connect_url = reverse('tw_connect')
95+
self.social_account_list_url = reverse('social_account_list')
9396

9497
def _login(self):
9598
payload = {

rest_auth/tests/test_social.py

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@
55
from django.test.utils import override_settings
66
from django.contrib.sites.models import Site
77

8+
try:
9+
from django.urls import reverse
10+
except ImportError:
11+
from django.core.urlresolvers import reverse
12+
813
from allauth.socialaccount.models import SocialApp
914
from allauth.socialaccount.providers.facebook.provider import GRAPH_API_URL
1015
import responses
@@ -303,3 +308,147 @@ def test_jwt(self):
303308
self.assertIn('user', self.response.json.keys())
304309

305310
self.assertEqual(get_user_model().objects.all().count(), users_count + 1)
311+
312+
313+
@override_settings(ROOT_URLCONF="tests.urls")
314+
class TestSocialConnectAuth(TestsMixin, TestCase):
315+
316+
USERNAME = 'person'
317+
PASS = 'person'
318+
319+
REGISTRATION_DATA = {
320+
"username": USERNAME,
321+
"password1": PASS,
322+
"password2": PASS,
323+
"email": EMAIL
324+
}
325+
LOGIN_DATA = {
326+
"username": USERNAME,
327+
"password": PASS,
328+
}
329+
330+
def setUp(self):
331+
self.init()
332+
333+
facebook_social_app = SocialApp.objects.create(
334+
provider='facebook',
335+
name='Facebook',
336+
client_id='123123123',
337+
secret='321321321',
338+
)
339+
340+
twitter_social_app = SocialApp.objects.create(
341+
provider='twitter',
342+
name='Twitter',
343+
client_id='11223344',
344+
secret='55667788',
345+
)
346+
347+
site = Site.objects.get_current()
348+
facebook_social_app.sites.add(site)
349+
twitter_social_app.sites.add(site)
350+
self.graph_api_url = GRAPH_API_URL + '/me'
351+
self.twitter_url = 'https://api.twitter.com/1.1/account/verify_credentials.json'
352+
353+
@responses.activate
354+
def test_social_connect_no_auth(self):
355+
responses.add(
356+
responses.GET,
357+
self.graph_api_url,
358+
body='',
359+
status=200,
360+
content_type='application/json'
361+
)
362+
363+
payload = {
364+
'access_token': 'abc123'
365+
}
366+
self.post(self.fb_connect_url, data=payload, status_code=403)
367+
self.post(self.tw_connect_url, data=payload, status_code=403)
368+
369+
@responses.activate
370+
def test_social_connect(self):
371+
# register user
372+
self.post(
373+
self.register_url,
374+
data=self.REGISTRATION_DATA,
375+
status_code=201
376+
)
377+
378+
# Test Facebook
379+
resp_body = {
380+
"id": "123123123123",
381+
"first_name": "John",
382+
"gender": "male",
383+
"last_name": "Smith",
384+
"link": "https://www.facebook.com/john.smith",
385+
"locale": "en_US",
386+
"name": "John Smith",
387+
"timezone": 2,
388+
"updated_time": "2014-08-13T10:14:38+0000",
389+
"username": "john.smith",
390+
"verified": True
391+
}
392+
393+
responses.add(
394+
responses.GET,
395+
self.graph_api_url,
396+
body=json.dumps(resp_body),
397+
status=200,
398+
content_type='application/json'
399+
)
400+
401+
payload = {
402+
'access_token': 'abc123'
403+
}
404+
self.post(self.fb_connect_url, data=payload, status_code=200)
405+
self.assertIn('key', self.response.json.keys())
406+
407+
# Test Twitter
408+
self.post(self.logout_url)
409+
self.post(self.login_url, data=self.LOGIN_DATA)
410+
411+
resp_body = {
412+
"id": "123123123123",
413+
}
414+
415+
responses.add(
416+
responses.GET,
417+
self.twitter_url,
418+
body=json.dumps(resp_body),
419+
status=200,
420+
content_type='application/json'
421+
)
422+
423+
payload = {
424+
'access_token': 'abc123',
425+
'token_secret': '1111222233334444'
426+
}
427+
428+
self.post(self.tw_connect_url, data=payload)
429+
430+
self.assertIn('key', self.response.json.keys())
431+
432+
# Check current social accounts
433+
self.get(self.social_account_list_url)
434+
self.assertEqual(len(self.response.json), 2)
435+
self.assertEqual(self.response.json[0]['provider'], 'facebook')
436+
self.assertEqual(self.response.json[1]['provider'], 'twitter')
437+
438+
facebook_social_account_id = self.response.json[0]['id']
439+
440+
# Try disconnecting accounts
441+
self.incorrect_disconnect_url = reverse(
442+
'social_account_disconnect', args=[999]
443+
)
444+
self.post(self.incorrect_disconnect_url, status_code=404)
445+
446+
self.disconnect_url = reverse(
447+
'social_account_disconnect', args=[facebook_social_account_id]
448+
)
449+
self.post(self.disconnect_url, status_code=200)
450+
451+
# Check social accounts after disconnecting
452+
self.get(self.social_account_list_url)
453+
self.assertEqual(len(self.response.json), 1)
454+
self.assertEqual(self.response.json[0]['provider'], 'twitter')

rest_auth/tests/urls.py

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,13 @@
88
from rest_framework.decorators import api_view
99

1010
from rest_auth.urls import urlpatterns
11-
from rest_auth.registration.views import SocialLoginView
12-
from rest_auth.social_serializers import TwitterLoginSerializer
11+
from rest_auth.registration.views import (
12+
SocialLoginView, SocialConnectView, SocialAccountListView,
13+
SocialAccountDisconnectView
14+
)
15+
from rest_auth.social_serializers import (
16+
TwitterLoginSerializer, TwitterConnectSerializer
17+
)
1318

1419

1520
class FacebookLogin(SocialLoginView):
@@ -21,6 +26,15 @@ class TwitterLogin(SocialLoginView):
2126
serializer_class = TwitterLoginSerializer
2227

2328

29+
class FacebookConnect(SocialConnectView):
30+
adapter_class = FacebookOAuth2Adapter
31+
32+
33+
class TwitterConnect(SocialConnectView):
34+
adapter_class = TwitterOAuthAdapter
35+
serializer_class = TwitterConnectSerializer
36+
37+
2438
class TwitterLoginSerializerFoo(TwitterLoginSerializer):
2539
pass
2640

@@ -49,5 +63,10 @@ class TwitterLoginNoAdapter(SocialLoginView):
4963
url(r'^social-login/twitter/$', TwitterLogin.as_view(), name='tw_login'),
5064
url(r'^social-login/twitter-no-view/$', twitter_login_view, name='tw_login_no_view'),
5165
url(r'^social-login/twitter-no-adapter/$', TwitterLoginNoAdapter.as_view(), name='tw_login_no_adapter'),
66+
url(r'^social-login/facebook/connect/$', FacebookConnect.as_view(), name='fb_connect'),
67+
url(r'^social-login/twitter/connect/$', TwitterConnect.as_view(), name='tw_connect'),
68+
url(r'^socialaccounts/$', SocialAccountListView.as_view(), name='social_account_list'),
69+
url(r'^socialaccounts/(?P<pk>\d+)/disconnect/$', SocialAccountDisconnectView.as_view(),
70+
name='social_account_disconnect'),
5271
url(r'^accounts/', include('allauth.socialaccount.urls'))
5372
]

0 commit comments

Comments
 (0)