added tests, serializers to include profile urls in profile info

Author: dvidsilva

profile/migrations/0001_initial.py

@@ -1,4 +1,4 @@
-# Generated by Django 2.1.2 on 2018-10-06 17:06
+# Generated by Django 2.1.2 on 2018-10-06 22:16
 
 from django.conf import settings
 from django.db import migrations, models
@@ -30,6 +30,10 @@ class Migration(migrations.Migration):
                 ('blog', models.CharField(blank=True, max_length=255)),
                 ('public_repos', models.CharField(blank=True, max_length=255)),
                 ('hireable', models.BooleanField(default=False)),
+                ('name', models.CharField(blank=True, max_length=255)),
+                ('avatar_url', models.TextField(null=True)),
+                ('hero_image_url', models.TextField(null=True)),
+                ('private', models.BooleanField(default=False)),
                 ('user', models.OneToOneField(on_delete=django.db.models.deletion.DO_NOTHING, related_name='profile', to=settings.AUTH_USER_MODEL, verbose_name='user')),
             ],
             options={
@@ -46,9 +50,12 @@ class Migration(migrations.Migration):
                 ('updated_at', models.DateTimeField(auto_now=True)),
                 ('name', models.CharField(max_length=250)),
                 ('description', models.TextField(blank=True)),
-                ('description', models.TextField(blank=True)),
                 ('url', models.TextField(null=True)),
-                ('profile', models.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, to='profile.Profile')),
+                ('profile', models.ForeignKey(on_delete=django.db.models.deletion.DO_NOTHING, related_name='urls', to='profile.Profile')),
             ],
+            options={
+                'verbose_name': 'Profile URLs',
+                'verbose_name_plural': 'Profile URLs',
+            },
         ),
     ]

profile/models.py

@@ -22,6 +22,10 @@ class Profile(models.Model):
     blog = models.CharField(max_length=255, blank=True)
     public_repos = models.CharField(max_length=255, blank=True)
     hireable = models.BooleanField(default=False)
+    name = models.CharField(max_length=255, blank=True)
+    avatar_url = models.TextField(null=True)
+    hero_image_url = models.TextField(null=True)
+    private = models.BooleanField(default=False)
 
     class Meta:
         verbose_name = "Profile"

profile/serializers.py

@@ -1,20 +1,34 @@
 from rest_framework_json_api import serializers
-from .models import Profile
+from .models import Profile, ProfileURL
 from accounts.serializers import UserSerializer
 from accounts.models import User
 from rest_framework_json_api.relations import ResourceRelatedField
 
+class ProfileURLSerializer(serializers.ModelSerializer):
+    class Meta:
+        model = ProfileURL
+        fields = ('name', 'description', 'url',)
+
 class ProfileSerializer(serializers.ModelSerializer):
     class Meta:
         model = Profile
-        fields = ('bio', 'user',)
+        fields = ('user', 'urls', 'bio', 'tagline', '___location', 'linkedin_url', 'hero_image_url',
+            'name', 'avatar_url', 'twitter_url', 'github_url', 'company', 'blog', 'public_repos', 'hireable')
 
-    included_serializers = { 'user': UserSerializer }
+    included_serializers = {
+        'user': UserSerializer,
+        'urls':  ProfileURLSerializer,
+    }
 
     user = ResourceRelatedField(
-        queryset=User.objects  # queryset argument is required
-    )                              # except when read_only=True
+        queryset=User.objects
+    )
+
+    urls = ResourceRelatedField(
+        queryset=ProfileURL.objects,
+        many=True,
+    )
 
     class JSONAPIMeta:
-        included_resources = ['user',]
+        included_resources = ['user', 'urls']
 

profile/tests/test_requests/test_profile.py

@@ -1,7 +1,7 @@
 from django.test import TestCase
 from rest_framework.test import APIClient, APITestCase
 from accounts.models import User
-from profile.models import Profile
+from profile.models import Profile, ProfileURL
 import sure
 import json
 
@@ -28,3 +28,29 @@ def test_profile_create_with_user(self):
         relationships = response_data['data'][0]['relationships']
         attributes['bio'].should.equal(profile.bio)
         relationships['user']['data']['id'].should.equal(str(user.id))
+
+    def test_profile_create_with_urls(self):
+        """
+        Ensure we get the correct profile and project urls
+        """
+        user = User.objects.create(username="poodle")
+
+        profile = Profile.objects.create(user=user, bio="Woof! in French")
+
+        url1 = ProfileURL.objects.create(profile=profile, name='codecorgi', url='https://codecorgi.co')
+        url2 = ProfileURL.objects.create(profile=profile, name='codecorgi gh', url=None)
+
+        response = self.client.get("/services/api/profiles",
+                                   content_type=self.content_type)
+
+        response.status_code.should.equal(200)
+
+        response_data = json.loads(response.content)
+        attributes = response_data['data'][0]['attributes']
+        relationships = response_data['data'][0]['relationships']
+
+        attributes['bio'].should.equal(profile.bio)
+
+        relationships['urls']['meta']['count'].should.equal(2)
+        relationships['urls']['data'][0]['id'].should.equal(str(url2.id))
+        relationships['urls']['data'][1]['id'].should.equal(str(url1.id))

profile/views.py

@@ -1,7 +1,20 @@
 from rest_framework import viewsets
-from .models import Profile
-from .serializers import ProfileSerializer
+from .models import Profile, ProfileURL
+from .serializers import ProfileSerializer, ProfileURLSerializer
 
 class ProfileViewSet(viewsets.ModelViewSet):
     queryset = Profile.objects.all()
     serializer_class = ProfileSerializer
+
+class ProfileURLsViewSet(viewsets.ModelViewSet):
+    queryset = ProfileURL.objects
+    serializer_class = ProfileURLSerializer
+
+    def get_queryset(self):
+        queryset = super(ProfileURL, self).get_queryset()
+
+        if 'profile_pk' in self.kwargs:
+            order_pk = self.kwargs['profile_pk']
+            queryset = queryset.filter(profile__pk=order_pk)
+
+        return queryset