Merge pull request #1850 from rtfd/bitbucket-oauth2

Changes to support Bitbucket OAuth2

Author: agjohnson

.gitignore

@@ -7,6 +7,8 @@
 .idea
 .vagrant
 .tox
+.rope_project/
+.ropeproject/
 _build
 cnames
 bower_components/
@@ -35,4 +37,3 @@ whoosh_index
 xml_output
 public_cnames
 public_symlinks
-.rope_project/

media/css/core.css

@@ -348,9 +348,21 @@ div.search-sponsored { margin-top: 50px; }
   .module-item .module-item-menu li a:hover { background-color: #697983; box-shadow: 0 1px 0px #465158; -moz-box-shadow: 0 1px 0px #465158; -webkit-box-shadow: 0 1px 0px #465158; }
 
   li.module-item ul.module-item-menu li input[type="submit"] {
-    font-size: 16px;
-    line-height: 16px;
-    margin: 4px;
+      font-size: 16px;
+      line-height: 16px;
+      margin: 4px;
+  }
+
+  li.module-item > img {
+      height: 24px;
+      width: 24px;
+      vertical-align: middle;
+  }
+
+  li.module-item > p.error {
+      padding-top: .75em;
+      font-size: .8em;
+      line-height: 1.5em;
   }
 
   /* for links that span the column */
@@ -653,12 +665,15 @@ div.project-import-remote button.remote-sync:before {
     content: "\f021";
 }
 
-div.project-import-remote form.import-connect-github button:before {
+div.project-import-remote form.import-connect-github button:before,
+a.socialaccount-provider.github:before {
     font-family: FontAwesome;
     content: "\f09b";
 }
 
-div.project-import-remote form.import-connect-bitbucket button:before {
+div.project-import-remote form.import-connect-bitbucket button:before,
+a.socialaccount-provider.bitbucket:before,
+a.socialaccount-provider.bitbucket_oauth2:before {
     font-family: FontAwesome;
     content: "\f171";
 }

readthedocs/core/management/commands/import_github.py

@@ -1,12 +1,14 @@
 from django.core.management.base import BaseCommand
 from django.contrib.auth.models import User
 
-from readthedocs.oauth.utils import import_github
+from readthedocs.oauth.services import GitHubService
 
 
 class Command(BaseCommand):
 
     def handle(self, *args, **options):
         if len(args):
             for slug in args:
-                import_github(user=User.objects.get(username=slug), sync=True)
+                service = GitHubService.for_user(User.objects.get(username=slug))
+                if service is not None:
+                    service.sync()

readthedocs/oauth/managers.py

@@ -1,108 +1,11 @@
-import logging
-import json
-import re
-
-from django.conf import settings
-from django.db import models
+"""Managers for OAuth models"""
 
 from readthedocs.privacy.loader import RelatedUserManager
 
-from .constants import OAUTH_SOURCE_GITHUB, OAUTH_SOURCE_BITBUCKET
-
-
-logger = logging.getLogger(__name__)
-
-
-DEFAULT_PRIVACY_LEVEL = getattr(settings, 'DEFAULT_PRIVACY_LEVEL', 'public')
-
 
 class RemoteRepositoryManager(RelatedUserManager):
-
-    """Model managers for remote repositories"""
-
-    def create_from_github_api(self, api_json, user, organization=None,
-                               privacy=DEFAULT_PRIVACY_LEVEL):
-        logger.info('Trying GitHub: %s' % api_json['full_name'])
-        if (
-                (privacy == 'private') or
-                (api_json['private'] is False and privacy == 'public')):
-            project, created = self.get_or_create(
-                full_name=api_json['full_name'],
-                users__pk=user.pk,
-            )
-            if project.organization and project.organization != organization:
-                logger.debug('Not importing %s because mismatched orgs' %
-                             api_json['name'])
-                return None
-            else:
-                project.organization = organization
-            project.users.add(user)
-            project.name = api_json['name']
-            project.description = api_json['description']
-            project.ssh_url = api_json['ssh_url']
-            project.html_url = api_json['html_url']
-            project.private = api_json['private']
-            if project.private:
-                project.clone_url = api_json['ssh_url']
-            else:
-                project.clone_url = api_json['clone_url']
-            project.admin = api_json.get('permissions', {}).get('admin', False)
-            project.vcs = 'git'
-            project.source = OAUTH_SOURCE_GITHUB
-            project.avatar_url = api_json.get('owner', {}).get('avatar_url')
-            project.json = json.dumps(api_json)
-            project.save()
-            return project
-        else:
-            logger.debug('Not importing %s because mismatched type' %
-                         api_json['name'])
-
-    def create_from_bitbucket_api(self, api_json, user, organization=None,
-                                  privacy=DEFAULT_PRIVACY_LEVEL):
-        logger.info('Trying Bitbucket: %s' % api_json['full_name'])
-        if (api_json['is_private'] is True and privacy == 'private' or
-                api_json['is_private'] is False and privacy == 'public'):
-            project, created = self.get_or_create(
-                full_name=api_json['full_name'])
-            if project.organization and project.organization != organization:
-                logger.debug('Not importing %s because mismatched orgs' %
-                             api_json['name'])
-                return None
-            else:
-                project.organization = organization
-            project.users.add(user)
-            project.name = api_json['name']
-            project.description = api_json['description']
-            project.clone_url = api_json['links']['clone'][0]['href']
-            project.ssh_url = api_json['links']['clone'][1]['href']
-            project.html_url = api_json['links']['html']['href']
-            project.vcs = api_json['scm']
-            project.private = api_json['is_private']
-            project.source = OAUTH_SOURCE_BITBUCKET
-
-            avatar_url = api_json['links']['avatar']['href'] or ''
-            project.avatar_url = re.sub(r'\/16\/$', r'/32/', avatar_url)
-
-            project.json = json.dumps(api_json)
-            project.save()
-            return project
-        else:
-            logger.debug('Not importing %s because mismatched type' %
-                         api_json['name'])
+    pass
 
 
 class RemoteOrganizationManager(RelatedUserManager):
-
-    def create_from_github_api(self, api_json, user):
-        organization, created = self.get_or_create(slug=api_json.get('login'))
-        organization.html_url = api_json.get('html_url')
-        organization.name = api_json.get('name')
-        organization.email = api_json.get('email')
-        organization.avatar_url = api_json.get('avatar_url')
-        organization.json = json.dumps(api_json)
-        organization.users.add(user)
-        organization.save()
-        return organization
-
-    def create_from_bitbucket_api(self):
-        pass
+    pass

readthedocs/oauth/migrations/0005_add_account_relation.py

@@ -0,0 +1,25 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('socialaccount', '0002_token_max_lengths'),
+        ('oauth', '0004_drop_github_and_bitbucket_models'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='remoteorganization',
+            name='account',
+            field=models.ForeignKey(related_name='remote_organizations', verbose_name='Connected account', blank=True, to='socialaccount.SocialAccount', null=True),
+        ),
+        migrations.AddField(
+            model_name='remoterepository',
+            name='account',
+            field=models.ForeignKey(related_name='remote_repositories', verbose_name='Connected account', blank=True, to='socialaccount.SocialAccount', null=True),
+        ),
+    ]

readthedocs/oauth/migrations/0006_move_oauth_source.py

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+
+
+def forwards_move_repo_source(apps, schema_editor):
+    """Use source field to set repository account"""
+    RemoteRepository = apps.get_model('oauth', 'RemoteRepository')
+    SocialAccount = apps.get_model('socialaccount', 'SocialAccount')
+    for account in SocialAccount.objects.all():
+        rows = (RemoteRepository.objects
+                .filter(users=account.user, source=account.provider)
+                .update(account=account))
+
+
+def backwards_move_repo_source(apps, schema_editor):
+    RemoteRepository = apps.get_model('oauth', 'RemoteRepository')
+    SocialAccount = apps.get_model('socialaccount', 'SocialAccount')
+    for account in SocialAccount.objects.all():
+        rows = (account.remote_repositories
+                .update(account=None, source=account.provider))
+
+
+def forwards_move_org_source(apps, schema_editor):
+    """Use source field to set organization account"""
+    RemoteOrganization = apps.get_model('oauth', 'RemoteOrganization')
+    SocialAccount = apps.get_model('socialaccount', 'SocialAccount')
+    for account in SocialAccount.objects.all():
+        rows = (RemoteOrganization.objects
+                .filter(users=account.user, source=account.provider)
+                .update(account=account))
+
+
+def backwards_move_org_source(apps, schema_editor):
+    """Use source field to set organization account"""
+    RemoteOrganization = apps.get_model('oauth', 'RemoteOrganization')
+    SocialAccount = apps.get_model('socialaccount', 'SocialAccount')
+    for account in SocialAccount.objects.all():
+        rows = (account.remote_organizations
+                .update(account=None, source=account.provider))
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oauth', '0005_add_account_relation'),
+    ]
+
+    operations = [
+        migrations.RunPython(forwards_move_repo_source,
+                             backwards_move_repo_source),
+        migrations.RunPython(forwards_move_org_source,
+                             backwards_move_org_source),
+    ]

readthedocs/oauth/migrations/0007_org_slug_nonunique.py

@@ -0,0 +1,27 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('oauth', '0006_move_oauth_source'),
+    ]
+
+    operations = [
+        migrations.RemoveField(
+            model_name='remoteorganization',
+            name='source',
+        ),
+        migrations.RemoveField(
+            model_name='remoterepository',
+            name='source',
+        ),
+        migrations.AlterField(
+            model_name='remoteorganization',
+            name='slug',
+            field=models.CharField(max_length=255, verbose_name='Slug'),
+        ),
+    ]

readthedocs/oauth/models.py

@@ -9,6 +9,7 @@
 from django.utils.translation import ugettext_lazy as _
 from django.core.validators import URLValidator
 from django.core.urlresolvers import reverse
+from allauth.socialaccount.models import SocialAccount
 
 from readthedocs.projects.constants import REPO_CHOICES
 from readthedocs.projects.models import Project
@@ -33,23 +34,24 @@ class RemoteOrganization(models.Model):
 
     users = models.ManyToManyField(User, verbose_name=_('Users'),
                                    related_name='oauth_organizations')
+    account = models.ForeignKey(
+        SocialAccount, verbose_name=_('Connected account'),
+        related_name='remote_organizations', null=True, blank=True)
     active = models.BooleanField(_('Active'), default=False)
 
-    slug = models.CharField(_('Slug'), max_length=255, unique=True)
+    slug = models.CharField(_('Slug'), max_length=255)
     name = models.CharField(_('Name'), max_length=255, null=True, blank=True)
     email = models.EmailField(_('Email'), max_length=255, null=True, blank=True)
     avatar_url = models.URLField(_('Avatar image URL'), null=True, blank=True)
     url = models.URLField(_('URL to organization page'), max_length=200,
                           null=True, blank=True)
 
-    source = models.CharField(_('Repository source'), max_length=16,
-                              choices=OAUTH_SOURCE)
     json = models.TextField(_('Serialized API response'))
 
     objects = RemoteOrganizationManager()
 
     def __unicode__(self):
-        return "Remote Organization: %s" % (self.url)
+        return 'Remote organization: {name}'.format(name=self.slug)
 
     def get_serialized(self, key=None, default=None):
         try:
@@ -75,6 +77,9 @@ class RemoteRepository(models.Model):
     # This should now be a OneToOne
     users = models.ManyToManyField(User, verbose_name=_('Users'),
                                    related_name='oauth_repositories')
+    account = models.ForeignKey(
+        SocialAccount, verbose_name=_('Connected account'),
+        related_name='remote_repositories', null=True, blank=True)
     organization = models.ForeignKey(
         RemoteOrganization, verbose_name=_('Organization'),
         related_name='repositories', null=True, blank=True)
@@ -102,8 +107,6 @@ class RemoteRepository(models.Model):
     vcs = models.CharField(_('vcs'), max_length=200, blank=True,
                            choices=REPO_CHOICES)
 
-    source = models.CharField(_('Repository source'), max_length=16,
-                              choices=OAUTH_SOURCE)
     json = models.TextField(_('Serialized API response'))
 
     objects = RemoteRepositoryManager()

readthedocs/oauth/services/__init__.py

@@ -0,0 +1,13 @@
+"""Conditional classes for OAuth services"""
+
+from django.utils.module_loading import import_by_path
+from django.conf import settings
+
+GitHubService = import_by_path(
+    getattr(settings, 'OAUTH_GITHUB_SERVICE',
+            'readthedocs.oauth.services.github.GitHubService'))
+BitbucketService = import_by_path(
+    getattr(settings, 'OAUTH_BITBUCKET_SERVICE',
+            'readthedocs.oauth.services.bitbucket.BitbucketService'))
+
+registry = [GitHubService, BitbucketService]