Jkmarx/add config model (#3177)

* Extend site_profile model and add api.

* Add model tests.

* Add site_video model.

* Add unit tests, not all are passing.

* Passing unit tests.

* Refactor.

* Fix typo.

* Update admin and added more error handling to api.

refinery/core/admin.py

@@ -14,7 +14,7 @@
 from .models import (
     Analysis, AnalysisNodeConnection, AnalysisResult, DataSet, Download,
     ExtendedGroup, Event, InvestigationLink, Invitation, Ontology, Project,
-    SiteProfile, SiteStatistics, Tutorials, UserProfile, Workflow,
+    SiteProfile, SiteStatistics, SiteVideo, Tutorials, UserProfile, Workflow,
     WorkflowEngine)
 from .utils import admin_ui_deletion
 
@@ -154,6 +154,10 @@ class SiteStatisticsAdmin(AdminFieldPopulator):
     change_list_template = "admin/core/sitestatistics/change_list.html"
 
 
+class SiteVideoAdmin(AdminFieldPopulator):
+    pass
+
+
 class EventAdmin(AdminFieldPopulator):
     pass
 
@@ -173,5 +177,6 @@ class EventAdmin(AdminFieldPopulator):
 admin.site.register(Tutorials, TutorialsAdmin)
 admin.site.register(Ontology, OntologyAdmin)
 admin.site.register(SiteProfile, SiteProfileAdmin)
+admin.site.register(SiteVideo, SiteVideoAdmin)
 admin.site.register(SiteStatistics, SiteStatisticsAdmin)
 admin.site.register(Event, EventAdmin)

refinery/core/migrations/0029_extend_site_profile_and_add_site_video.py

@@ -0,0 +1,44 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('core', '0028_auto_20180611_1640'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='SiteVideo',
+            fields=[
+                ('id', models.AutoField(verbose_name='ID', serialize=False,
+                                        auto_created=True, primary_key=True)),
+                ('caption', models.TextField(blank=True)),
+                ('source', models.CharField(max_length=100, blank=True)),
+                ('source_id', models.CharField(max_length=100)),
+            ],
+        ),
+        migrations.AddField(
+            model_name='siteprofile',
+            name='about_markdown',
+            field=models.TextField(blank=True),
+        ),
+        migrations.AddField(
+            model_name='siteprofile',
+            name='intro_markdown',
+            field=models.TextField(blank=True),
+        ),
+        migrations.AddField(
+            model_name='siteprofile',
+            name='twitter_username',
+            field=models.CharField(max_length=100, blank=True),
+        ),
+        migrations.AddField(
+            model_name='sitevideo',
+            name='site_profile',
+            field=models.ForeignKey(to='core.SiteProfile'),
+        ),
+    ]

refinery/core/models.py

@@ -2221,6 +2221,9 @@ class SiteProfile(models.Model):
 
     site = models.OneToOneField(Site, related_name='profile')
     repo_mode_home_page_html = models.TextField(blank=True)
+    about_markdown = models.TextField(blank=True)
+    intro_markdown = models.TextField(blank=True)
+    twitter_username = models.CharField(max_length=100, blank=True)
 
     def __unicode__(self):
         return self.site.name
@@ -2340,6 +2343,13 @@ def get_aggregate_sum(field_name):
         ]
 
 
+class SiteVideo(models.Model):
+    caption = models.TextField(blank=True)
+    site_profile = models.ForeignKey(SiteProfile)
+    source = models.CharField(max_length=100, blank=True)
+    source_id = models.CharField(max_length=100)
+
+
 class Event(models.Model):
     date_time = models.DateTimeField(default=timezone.now)
     data_set = models.ForeignKey(DataSet, null=True)

refinery/core/serializers.py

@@ -4,7 +4,8 @@
 from rest_framework import serializers
 from rest_framework.validators import UniqueValidator
 
-from .models import DataSet, Event, User, UserProfile, Workflow
+from .models import (DataSet, Event, SiteProfile, SiteVideo, User,
+                     UserProfile, Workflow)
 
 logger = logging.getLogger(__name__)
 
@@ -82,6 +83,52 @@ def partial_update(self, instance, validated_data):
         return instance
 
 
+class SiteVideoSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = SiteVideo
+        fields = ('caption', 'site_profile', 'source', 'source_id', 'id')
+
+    def create(self, validated_data):
+        return SiteVideo.objects.create(**validated_data)
+
+    def partial_update(self, instance, validated_data):
+        instance.caption = validated_data.get('caption', instance.caption)
+        instance.source = validated_data.get('source', instance.source)
+        instance.source_id = validated_data.get('source_id',
+                                                instance.source_id)
+        instance.save()
+        return instance
+
+
+class SiteProfileSerializer(serializers.ModelSerializer):
+    site_videos = serializers.SerializerMethodField()
+
+    def get_site_videos(self, site_profile):
+        site_videos = site_profile.sitevideo_set.all()
+        serializer = SiteVideoSerializer(site_videos, many=True)
+        return serializer.data
+
+    class Meta:
+        model = SiteProfile
+        fields = ('about_markdown', 'site', 'intro_markdown',
+                  'twitter_username', 'site_videos')
+
+    def partial_update(self, instance, validated_data):
+        """
+        Update and return an existing `SiteProfile` instance, given the
+        validated data.
+        """
+        instance.about_markdown = validated_data.get('about_markdown',
+                                                     instance.about_markdown)
+        instance.intro_markdown = validated_data.get('intro_markdown',
+                                                     instance.intro_markdown)
+        instance.twitter_username = validated_data.get(
+            'twitter_username',  instance.twitter_username
+        )
+        instance.save()
+        return instance
+
+
 class UserProfileSerializer(serializers.ModelSerializer):
 
     class Meta:

refinery/core/test_models.py

@@ -2,6 +2,7 @@
 
 from django.conf import settings
 from django.contrib.auth.models import User
+from django.contrib.sites.models import Site
 from django.core.files.base import ContentFile
 from django.core.files.uploadedfile import SimpleUploadedFile
 from django.test import TestCase
@@ -32,8 +33,8 @@
 from .models import (INPUT_CONNECTION, OUTPUT_CONNECTION, Analysis,
                      AnalysisNodeConnection, AnalysisResult, BaseResource,
                      DataSet, Event, ExtendedGroup, InvestigationLink,
-                     Project, SiteStatistics, Tutorials, UserProfile,
-                     Workflow, WorkflowEngine)
+                     Project, SiteProfile, SiteStatistics, SiteVideo,
+                     Tutorials, UserProfile, Workflow, WorkflowEngine)
 from .tasks import collect_site_statistics
 
 
@@ -997,6 +998,38 @@ def test_set_owner_data_set_adds_share_perms(self):
         self.assertTrue('share_dataset' in user_perms)
 
 
+class SiteProfileUnitTests(TestCase):
+    def setUp(self):
+        self.current_site = Site.objects.get_current()
+        self.site_profile = SiteProfile.objects.create(site=self.current_site)
+
+    def test_site_profile_created_fk(self):
+        self.assertEqual(self.site_profile.site, self.current_site)
+
+    def test_site_profile_creates_blank_fields(self):
+        self.assertEqual(self.site_profile.about_markdown, '')
+        self.assertEqual(self.site_profile.twitter_username, '')
+
+
+class SiteVideoUnitTests(TestCase):
+    def setUp(self):
+        self.current_site = Site.objects.get_current()
+        self.site_profile = SiteProfile.objects.create(site=self.current_site)
+        self.source_id_1 = 'yt_id_5'
+        self.site_video = SiteVideo.objects.create(
+            site_profile=self.site_profile, source_id=self.source_id_1
+        )
+
+    def test_site_profile_creates_blank_fields(self):
+        self.assertEqual(self.site_video.caption, '')
+        self.assertEqual(self.site_video.source, '')
+
+    def test_site_returns_videos(self):
+        self.site_profile.refresh_from_db()
+        self.assertEqual(self.site_profile.sitevideo_set.all()[0],
+                         self.site_video)
+
+
 class SiteStatisticsUnitTests(TestCase):
     def setUp(self):
         # Simulate a day of user activity