Merge pull request #505 from edx/tasawer/ecom-6090-institution/course-dmin-widget

Added API for getting users based on selected institution

course_discovery/apps/publisher/api/serializers.py

@@ -2,6 +2,7 @@
 
 from rest_framework import serializers
 
+from course_discovery.apps.core.models import User
 from course_discovery.apps.publisher.models import CourseUserRole
 
 
@@ -21,3 +22,11 @@ class CourseUserRoleSerializer(serializers.ModelSerializer):
             validated_values.update({'changed_by': request.user})
 
         return validated_values
+
+
+class GroupUserSerializer(serializers.ModelSerializer):
+    """Serializer for the `User` model used in OrganizationGroupUserView. """
+
+    class Meta:
+        model = User
+        fields = ('id', 'full_name', )

course_discovery/apps/publisher/api/tests/test_serializers.py

@@ -3,7 +3,8 @@ from unittest import TestCase
 
 from django.test import RequestFactory
 
-from course_discovery.apps.publisher.api.serializers import CourseUserRoleSerializer
+from course_discovery.apps.core.tests.factories import UserFactory
+from course_discovery.apps.publisher.api.serializers import CourseUserRoleSerializer, GroupUserSerializer
 from course_discovery.apps.publisher.tests.factories import CourseUserRoleFactory
 
 
@@ -28,3 +29,13 @@ class CourseUserRoleSerializerTests(TestCase):
         serializer = self.serializer_class(self.course_user_role, context={'request': self.request})
         validated_data = serializer.validate(serializer.data)
         self.assertEqual(validated_data, self.get_expected_data())
+
+
+class GroupUserSerializerTests(TestCase):
+    def test_date(self):
+        """ Verify that UserSerializer serialize the user object. """
+
+        user = UserFactory(full_name="test user")
+        serializer = GroupUserSerializer(user)
+
+        self.assertDictEqual(serializer.data, {'id': user.id, 'full_name': user.full_name})

course_discovery/apps/publisher/api/tests/test_views.py

@@ -93,3 +93,56 @@ class CourseRoleAssignmentViewTests(TestCase):
         }
         self.assertDictEqual(response.data, expected)
         self.assertEqual(self.internal_user, self.course.course_user_roles.get(role=user_course_role.role).user)
+
+
+class OrganizationGroupUserViewTests(TestCase):
+
+    def setUp(self):
+        super(OrganizationGroupUserViewTests, self).setUp()
+
+        user = UserFactory.create(username="test_user", password=USER_PASSWORD)
+        self.client.login(username=user.username, password=USER_PASSWORD)
+
+        # create group and add test users in the group
+        group = factories.GroupFactory()
+        self.org_user1 = UserFactory.create(full_name="org user1")
+        self.org_user2 = UserFactory.create(full_name="org user2")
+        group.user_set.add(self.org_user1)
+        group.user_set.add(self.org_user2)
+
+        self.organization = OrganizationFactory()
+        factories.OrganizationExtensionFactory.create(organization=self.organization, group=group)
+
+    def test_get_organization_user_group(self):
+        """ Verify that view returns list of users associated with the group
+        related to given organization id.
+        """
+        response = self.client.get(path=self._get_organization_group_user_url(self.organization.id),
+                                   content_type=JSON_CONTENT_TYPE)
+        self.assertEqual(response.status_code, 200)
+
+        expected_results = [
+            {
+                "id": self.org_user1.id,
+                "full_name": self.org_user1.full_name
+            },
+            {
+                "id": self.org_user2.id,
+                "full_name": self.org_user2.full_name
+            }
+        ]
+
+        self.assertEqual(json.loads(response.content.decode("utf-8"))["results"], expected_results)
+
+    def test_get_organization_not_found(self):
+        """ Verify that view returns status=404 if organization is not found
+        in OrganizationExtension.
+        """
+        response = self.client.get(path=self._get_organization_group_user_url(org_id=0000),
+                                   content_type=JSON_CONTENT_TYPE)
+        self.assertEqual(response.status_code, 404)
+
+    def _get_organization_group_user_url(self, org_id):
+        return reverse(
+            'publisher:api:organization_group_users', kwargs={'pk': org_id}
+        )

course_discovery/apps/publisher/api/urls.py

 """ Publisher API URLs. """
 from django.conf.urls import url
 
-from course_discovery.apps.publisher.api.views import CourseRoleAssignmentView
+from course_discovery.apps.publisher.api.views import CourseRoleAssignmentView, OrganizationGroupUserView
 
 urlpatterns = [
-    url(
-        r'^course_role_assignments/(?P<pk>\d+)/$', CourseRoleAssignmentView.as_view(), name='course_role_assignments'
-    ),
+    url(r'^course_role_assignments/(?P<pk>\d+)/$', CourseRoleAssignmentView.as_view(), name='course_role_assignments'),
+    url(r'^admins/organizations/(?P<pk>\d+)/users/$', OrganizationGroupUserView.as_view(),
+        name='organization_group_users'),
 ]

course_discovery/apps/publisher/api/views.py

-from rest_framework.generics import UpdateAPIView
+from rest_framework.generics import UpdateAPIView, ListAPIView, get_object_or_404
 from rest_framework.permissions import IsAuthenticated
 
-from course_discovery.apps.publisher.models import CourseUserRole
+from course_discovery.apps.core.models import User
+from course_discovery.apps.publisher.models import CourseUserRole, OrganizationExtension
 from course_discovery.apps.publisher.api.permissions import CanViewAssociatedCourse, InternalUserPermission
-from course_discovery.apps.publisher.api.serializers import CourseUserRoleSerializer
+from course_discovery.apps.publisher.api.serializers import CourseUserRoleSerializer, GroupUserSerializer
 
 
 class CourseRoleAssignmentView(UpdateAPIView):
     permission_classes = (IsAuthenticated, CanViewAssociatedCourse, InternalUserPermission,)
     queryset = CourseUserRole.objects.all()
     serializer_class = CourseUserRoleSerializer
+
+
+class OrganizationGroupUserView(ListAPIView):
+    serializer_class = GroupUserSerializer
+    permission_classes = (IsAuthenticated,)
+
+    def get_queryset(self):
+        org_extension = get_object_or_404(OrganizationExtension, organization=self.kwargs.get('pk'))
+        queryset = User.objects.filter(groups__name=org_extension.group)
+        return queryset