Moving Github/Bitbucket object create logic from helper functions into appropriate manager methods.

Author: gregmuellegger

readthedocs/oauth/managers.py

@@ -0,0 +1,87 @@
+import logging
+
+from django.conf import settings
+from django.db import models
+
+
+logger = logging.getLogger(__name__)
+
+
+GITHUB_PRIVACY = getattr(settings, 'GITHUB_PRIVACY', 'public')
+BITBUCKET_PRIVACY = getattr(settings, 'BITBUCKET_PRIVACY', GITHUB_PRIVACY)
+
+
+class GithubProjectManager(models.Manager):
+    def create_from_api(self, api_json, user, organization=None,
+                        privacy=GITHUB_PRIVACY):
+        logger.info('Trying GitHub: %s' % api_json['full_name'])
+        if (
+                (api_json['private'] is True and 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.git_url = api_json['git_url']
+            project.ssh_url = api_json['ssh_url']
+            project.html_url = api_json['html_url']
+            project.json = api_json
+            project.save()
+            return project
+        else:
+            logger.debug('Not importing %s because mismatched type' %
+                         api_json['name'])
+
+
+class GithubOrganizationManager(models.Manager):
+    def create_from_api(self, api_json, user):
+        organization, created = self.get_or_create(login=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.json = api_json
+        organization.users.add(user)
+        organization.save()
+        return organization
+
+
+class BitbucketProjectManager(models.Manager):
+    def create_from_api(self, api_json, user, organization=None,
+                        privacy=BITBUCKET_PRIVACY):
+        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.git_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.json = api_json
+            project.save()
+            return project
+        else:
+            logger.debug('Not importing %s because mismatched type' %
+                         api_json['name'])
+
+
+class BitbucketTeamManager(models.Manager):
+    pass

readthedocs/oauth/models.py

@@ -2,6 +2,11 @@
 from django.contrib.auth.models import User
 from django.utils.translation import ugettext_lazy as _
 
+from .managers import BitbucketTeamManager
+from .managers import BitbucketProjectManager
+from .managers import GithubOrganizationManager
+from .managers import GithubProjectManager
+
 
 class GithubOrganization(models.Model):
     # Auto fields
@@ -20,6 +25,8 @@ class GithubOrganization(models.Model):
     active = models.BooleanField(_('Active'), default=False)
     json = models.TextField('JSON')
 
+    objects = GithubOrganizationManager()
+
     def __unicode__(self):
         return "GitHub Organization: %s" % (self.html_url)
 
@@ -44,6 +51,8 @@ class GithubProject(models.Model):
     active = models.BooleanField(_('Active'), default=False)
     json = models.TextField('JSON')
 
+    objects = GithubProjectManager()
+
     def __unicode__(self):
         return "GitHub Project: %s" % (self.html_url)
 
@@ -71,6 +80,8 @@ class BitbucketTeam(models.Model):
     active = models.BooleanField(_('Active'), default=False)
     json = models.TextField('JSON')
 
+    objects = BitbucketTeamManager()
+
     def __unicode__(self):
         return "Bitbucket Team: %s" % (self.html_url)
 
@@ -95,5 +106,7 @@ class BitbucketProject(models.Model):
     active = models.BooleanField(_('Active'), default=False)
     json = models.TextField('JSON')
 
+    objects = BitbucketProjectManager()
+
     def __unicode__(self):
         return "Bitbucket Project: %s" % (self.html_url)

readthedocs/oauth/utils.py

@@ -5,7 +5,7 @@
 from django.conf import settings
 from requests_oauthlib import OAuth1Session, OAuth2Session
 
-from .models import GithubProject, GithubOrganization, BitbucketProject, BitbucketTeam
+from .models import GithubProject, GithubOrganization, BitbucketProject
 from tastyapi import apiv2
 
 log = logging.getLogger(__name__)
@@ -37,45 +37,6 @@ def get_oauth_session(user, provider):
     return session or None
 
 
-def make_github_project(user, org, privacy, repo_json):
-    log.info('Trying GitHub: %s' % repo_json['full_name'])
-    if (repo_json['private'] is True and privacy == 'private' or
-            repo_json['private'] is False and privacy == 'public'):
-        project, created = GithubProject.objects.get_or_create(
-            full_name=repo_json['full_name'],
-            users__pk=user.pk,
-        )
-        if project.organization and project.organization != org:
-            log.debug('Not importing %s because mismatched orgs' % repo_json['name'])
-            return None
-        else:
-            project.organization = org
-        project.users.add(user)
-        project.name = repo_json['name']
-        project.description = repo_json['description']
-        project.git_url = repo_json['git_url']
-        project.ssh_url = repo_json['ssh_url']
-        project.html_url = repo_json['html_url']
-        project.json = repo_json
-        project.save()
-        return project
-    else:
-        log.debug('Not importing %s because mismatched type' % repo_json['name'])
-
-
-def make_github_organization(user, org_json):
-    org, created = GithubOrganization.objects.get_or_create(
-        login=org_json.get('login'),
-    )
-    org.html_url = org_json.get('html_url')
-    org.name = org_json.get('name')
-    org.email = org_json.get('email')
-    org.json = org_json
-    org.users.add(user)
-    org.save()
-    return org
-
-
 def get_token_for_project(project, force_local=False):
     if not getattr(settings, 'ALLOW_PRIVATE_REPOS', False):
         return None
@@ -118,14 +79,13 @@ def github_paginate(session, url):
 def import_github(user, sync):
     """ Do the actual github import """
 
-    repo_type = getattr(settings, 'GITHUB_PRIVACY', 'public')
     session = get_oauth_session(user, provider='github')
     if sync and session:
         # Get user repos
         owner_resp = github_paginate(session, 'https://api.github.com/user/repos?per_page=100')
         try:
             for repo in owner_resp:
-                make_github_project(user=user, org=None, privacy=repo_type, repo_json=repo)
+                GithubProject.objects.create_from_api(repo, user=user)
         except TypeError, e:
             print e
 
@@ -134,11 +94,13 @@ def import_github(user, sync):
             resp = session.get('https://api.github.com/user/orgs')
             for org_json in resp.json():
                 org_resp = session.get('https://api.github.com/orgs/%s' % org_json['login'])
-                org_obj = make_github_organization(user=user, org_json=org_resp.json())
+                org_obj = GithubOrganization.objects.create_from_api(
+                    org_resp.json(), user=user)
                 # Add repos
                 org_repos_resp = github_paginate(session, 'https://api.github.com/orgs/%s/repos?per_page=100' % org_json['login'])
                 for repo in org_repos_resp:
-                    make_github_project(user=user, org=org_obj, privacy=repo_type, repo_json=repo)
+                    GithubProject.objects.create_from_api(
+                        repo, user=user, organization=org_obj)
         except TypeError, e:
             print e
 
@@ -171,58 +133,31 @@ def bitbucket_paginate(session, url):
     return result
 
 
-def make_bitbucket_project(user, org, privacy, repo_json):
-    log.info('Trying Bitbucket: %s' % repo_json['full_name'])
-    if (repo_json['is_private'] is True and privacy == 'private' or
-            repo_json['is_private'] is False and privacy == 'public'):
-        project, created = BitbucketProject.objects.get_or_create(
-            full_name=repo_json['full_name'],
-        )
-        if project.organization and project.organization != org:
-            log.debug('Not importing %s because mismatched orgs' % repo_json['name'])
-            return None
-        else:
-            project.organization = org
-        project.users.add(user)
-        project.name = repo_json['name']
-        project.description = repo_json['description']
-        project.git_url = repo_json['links']['clone'][0]['href']
-        project.ssh_url = repo_json['links']['clone'][1]['href']
-        project.html_url = repo_json['links']['html']['href']
-        project.vcs = repo_json['scm']
-        project.json = repo_json
-        project.save()
-        return project
-    else:
-        log.debug('Not importing %s because mismatched type' % repo_json['name'])
-
-
-def process_bitbucket_json(user, json, repo_type):
+def process_bitbucket_json(user, json):
     try:
         for page in json:
             for repo in page['values']:
-                make_bitbucket_project(user=user, org=None, privacy=repo_type, repo_json=repo)
+                BitbucketProject.objects.create_from_api(repo, user=user)
     except TypeError, e:
         print e
 
 
 def import_bitbucket(user, sync):
     """ Do the actual github import """
 
-    repo_type = getattr(settings, 'GITHUB_PRIVACY', 'public')
     session = get_oauth_session(user, provider='bitbucket')
     if sync and session:
             # Get user repos
         try:
             owner_resp = bitbucket_paginate(session, 'https://bitbucket.org/api/2.0/repositories/{owner}'.format(owner=user.username))
-            process_bitbucket_json(user, owner_resp, repo_type)
+            process_bitbucket_json(user, owner_resp)
         except TypeError, e:
             print e
 
         # Get org repos
         resp = session.get('https://bitbucket.org/api/1.0/user/privileges/')
         for team in resp.json()['teams'].keys():
             org_resp = bitbucket_paginate(session, 'https://bitbucket.org/api/2.0/teams/{team}/repositories'.format(team=team))
-            process_bitbucket_json(user, org_resp, repo_type)
+            process_bitbucket_json(user, org_resp)
 
     return session is not None

readthedocs/rtd_tests/tests/test_oauth.py

@@ -5,7 +5,7 @@
 
 from projects.models import Project
 
-from oauth.utils import make_github_project, make_github_organization, import_github
+from oauth.utils import import_github
 from oauth.models import GithubOrganization, GithubProject
 
 
@@ -30,7 +30,9 @@ def test_make_github_project_pass(self):
             "ssh_url": "",
             "html_url": "",
         }
-        github_project = make_github_project(user=self.user, org=self.org, privacy=self.privacy, repo_json=repo_json)
+        github_project = GithubProject.objects.create_from_api(
+            repo_json, user=self.user, organization=self.org,
+            privacy=self.privacy)
         self.assertIsInstance(github_project, GithubProject)
 
     def test_make_github_project_fail(self):
@@ -43,7 +45,9 @@ def test_make_github_project_fail(self):
             "ssh_url": "",
             "html_url": "",
         }
-        github_project = make_github_project(user=self.user, org=self.org, privacy=self.privacy, repo_json=repo_json)
+        github_project = GithubProject.objects.create_from_api(
+            repo_json, user=self.user, organization=self.org,
+            privacy=self.privacy)
         self.assertIsNone(github_project)
 
     def test_make_github_organization(self):
@@ -53,14 +57,16 @@ def test_make_github_organization(self):
             "email": "",
             "login": "",
         }
-        org = make_github_organization(self.user, org_json)
+        org = GithubOrganization.objects.create_from_api(
+            org_json, user=self.user)
         self.assertIsInstance(org, GithubOrganization)
 
     def test_import_github_with_no_token(self):
         github_connected = import_github(self.user, sync=True)
         self.assertEqual(github_connected, False)
 
     def test_multiple_users_same_repo(self):
+        user2 = User.objects.get(pk=2)
         repo_json = {
             "name": "",
             "full_name": "testrepo/multiple",
@@ -70,21 +76,31 @@ def test_multiple_users_same_repo(self):
             "ssh_url": "",
             "html_url": "",
         }
-        github_project = make_github_project(user=self.user, org=self.org, privacy=self.privacy, repo_json=repo_json)
-        github_project_2 = make_github_project(user=User.objects.get(pk=2), org=self.org, privacy=self.privacy, repo_json=repo_json)
+
+        github_project = GithubProject.objects.create_from_api(
+            repo_json, user=self.user, organization=self.org,
+            privacy=self.privacy)
+        github_project_2 = GithubProject.objects.create_from_api(
+            repo_json, user=user2, organization=self.org, privacy=self.privacy)
         self.assertIsInstance(github_project, GithubProject)
         self.assertIsInstance(github_project_2, GithubProject)
         self.assertNotEqual(github_project_2, github_project)
 
-        github_project_3 = make_github_project(user=self.user, org=self.org, privacy=self.privacy, repo_json=repo_json)
-        github_project_4 = make_github_project(user=User.objects.get(pk=2), org=self.org, privacy=self.privacy, repo_json=repo_json)
+        github_project_3 = GithubProject.objects.create_from_api(
+            repo_json, user=self.user, organization=self.org,
+            privacy=self.privacy)
+        github_project_4 = GithubProject.objects.create_from_api(
+            repo_json, user=user2, organization=self.org, privacy=self.privacy)
         self.assertIsInstance(github_project_3, GithubProject)
         self.assertIsInstance(github_project_4, GithubProject)
         self.assertEqual(github_project, github_project_3)
         self.assertEqual(github_project_2, github_project_4)
 
-        github_project_5 = make_github_project(user=self.user, org=self.org, privacy=self.privacy, repo_json=repo_json)
-        github_project_6 = make_github_project(user=User.objects.get(pk=2), org=self.org, privacy=self.privacy, repo_json=repo_json)
+        github_project_5 = GithubProject.objects.create_from_api(
+            repo_json, user=self.user, organization=self.org,
+            privacy=self.privacy)
+        github_project_6 = GithubProject.objects.create_from_api(
+            repo_json, user=user2, organization=self.org, privacy=self.privacy)
 
         self.assertEqual(github_project, github_project_5)
         self.assertEqual(github_project_2, github_project_6)