added new fields to organisation model

added lookup of organisation by user

merged with master

lms/djangoapps/api_manager/models.py

@@ -136,6 +136,10 @@ class Organization(TimeStampedModel):
     primarily a collection of Users.
     """
     name = models.CharField(max_length=255)
+    display_name = models.CharField(max_length=255, null=True, blank=True)
+    contact_name = models.CharField(max_length=255, null=True, blank=True)
+    contact_email = models.EmailField(max_length=255, null=True, blank=True)
+    contact_phone = models.CharField(max_length=50, null=True, blank=True)
     workgroups = models.ManyToManyField(Workgroup, related_name="organizations")
     users = models.ManyToManyField(User, related_name="organizations")
 

lms/djangoapps/api_manager/organizations/serializers.py

@@ -5,11 +5,13 @@ from rest_framework import serializers
 from api_manager.models import Organization
 
 
-class OrganizationSerializer(serializers.HyperlinkedModelSerializer):
+class OrganizationSerializer(serializers.ModelSerializer):
     """ Serializer for Organization model interactions """
+    url = serializers.HyperlinkedIdentityField(view_name='organization-detail')
 
     class Meta:
         """ Serializer/field specification """
         model = Organization
-        fields = ('url', 'id', 'name', 'workgroups', 'users', 'created', 'modified')
+        fields = ('url', 'id', 'name', 'display_name', 'contact_name', 'contact_email', 'contact_phone', 'workgroups',
+                  'users', 'created', 'modified')
         read_only = ('url', 'id', 'created')

lms/djangoapps/api_manager/organizations/tests.py

@@ -32,7 +32,12 @@ class OrganizationsApiTests(TestCase):
     def setUp(self):
         self.test_server_prefix = 'https://testserver'
         self.test_organizations_uri = '/api/organizations/'
+        self.test_users_uri = '/api/users'
         self.test_organization_name = str(uuid.uuid4())
+        self.test_organization_display_name = 'Test Org'
+        self.test_organization_contact_name = 'John Org'
+        self.test_organization_contact_email = 'john@test.org'
+        self.test_organization_contact_phone = '+1 332 232 24234'
 
         self.client = SecureClient()
         cache.clear()
@@ -67,8 +72,27 @@ class OrganizationsApiTests(TestCase):
         return response
 
     def test_organizations_list_post(self):
+        users = []
+        for i in xrange(1, 6):
+            data = {
+                'email': 'test{}@example.com'.format(i),
+                'username': 'test_user{}'.format(i),
+                'password': 'test_pass',
+                'first_name': 'John{}'.format(i),
+                'last_name': 'Doe{}'.format(i)
+            }
+            response = self.do_post(self.test_users_uri, data)
+            self.assertEqual(response.status_code, 201)
+            users.append(response.data['id'])
+
+
         data = {
-            'name': self.test_organization_name
+            'name': self.test_organization_name,
+            'display_name': self.test_organization_display_name,
+            'contact_name': self.test_organization_contact_name,
+            'contact_email': self.test_organization_contact_email,
+            'contact_phone': self.test_organization_contact_phone,
+            'users': users
         }
         response = self.do_post(self.test_organizations_uri, data)
         self.assertEqual(response.status_code, 201)
@@ -81,13 +105,23 @@ class OrganizationsApiTests(TestCase):
         self.assertEqual(response.data['url'], confirm_uri)
         self.assertGreater(response.data['id'], 0)
         self.assertEqual(response.data['name'], self.test_organization_name)
+        self.assertEqual(response.data['display_name'], self.test_organization_display_name)
+        self.assertEqual(response.data['contact_name'], self.test_organization_contact_name)
+        self.assertEqual(response.data['contact_email'], self.test_organization_contact_email)
+        self.assertEqual(response.data['contact_phone'], self.test_organization_contact_phone)
         self.assertIsNotNone(response.data['workgroups'])
-        self.assertIsNotNone(response.data['users'])
+        self.assertEqual(len(response.data['users']), len(users))
         self.assertIsNotNone(response.data['created'])
         self.assertIsNotNone(response.data['modified'])
 
     def test_organizations_detail_get(self):
-        data = {'name': self.test_organization_name}
+        data = {
+            'name': self.test_organization_name,
+            'display_name': self.test_organization_display_name,
+            'contact_name': self.test_organization_contact_name,
+            'contact_email': self.test_organization_contact_email,
+            'contact_phone': self.test_organization_contact_phone
+        }
         response = self.do_post(self.test_organizations_uri, data)
         self.assertEqual(response.status_code, 201)
         test_uri = '{}{}/'.format(self.test_organizations_uri, str(response.data['id']))
@@ -97,6 +131,10 @@ class OrganizationsApiTests(TestCase):
         self.assertEqual(response.data['url'], confirm_uri)
         self.assertGreater(response.data['id'], 0)
         self.assertEqual(response.data['name'], self.test_organization_name)
+        self.assertEqual(response.data['display_name'], self.test_organization_display_name)
+        self.assertEqual(response.data['contact_name'], self.test_organization_contact_name)
+        self.assertEqual(response.data['contact_email'], self.test_organization_contact_email)
+        self.assertEqual(response.data['contact_phone'], self.test_organization_contact_phone)
         self.assertIsNotNone(response.data['workgroups'])
         self.assertIsNotNone(response.data['users'])
         self.assertIsNotNone(response.data['created'])
@@ -118,3 +156,14 @@ class OrganizationsApiTests(TestCase):
         self.assertEqual(response.status_code, 204)
         response = self.do_get(test_uri)
         self.assertEqual(response.status_code, 404)
+
+    def test_organizations_list_post_invalid(self):
+        data = {
+            'name': self.test_organization_name,
+            'display_name': self.test_organization_display_name,
+            'contact_name': self.test_organization_contact_name,
+            'contact_email': 'testatme.com',
+            'contact_phone': self.test_organization_contact_phone
+        }
+        response = self.do_post(self.test_organizations_uri, data)
+        self.assertEqual(response.status_code, 400)

lms/djangoapps/api_manager/users/tests.py

@@ -925,3 +925,24 @@ class UsersApiTests(TestCase):
             response.data['level_of_education'], data["level_of_education"])
         self.assertEqual(
             str(response.data['year_of_birth']), data["year_of_birth"])
+
+    def test_user_organizations_list(self):
+        user_id = self._create_test_user()
+        for i in xrange(1, 7):
+            data = {
+                'name': 'Org ' + str(i),
+                'display_name': 'Org display name' + str(i),
+                'users': [user_id]
+            }
+            response = self.do_post('/api/organizations/', data)
+            self.assertEqual(response.status_code, 201)
+
+        test_uri = '/api/users/{}/organizations/'.format(user_id)
+        response = self.do_get(test_uri)
+        self.assertEqual(response.data['count'], 6)
+        self.assertEqual(len(response.data['results']), 6)
+        self.assertEqual(response.data['num_pages'], 1)
+
+        # test with invalid user
+        response = self.do_get('/api/users/4356340/organizations/')
+        self.assertEqual(response.status_code, 404)

lms/djangoapps/api_manager/users/urls.py

@@ -15,6 +15,7 @@ urlpatterns = patterns(
     url(r'^(?P<user_id>[0-9]+)/groups/*$', users_views.UsersGroupsList.as_view(), name='users-groups-list'),
     url(r'^(?P<user_id>[0-9]+)/groups/(?P<group_id>[0-9]+)$', users_views.UsersGroupsDetail.as_view(), name='users-groups-detail'),
     url(r'^(?P<user_id>[0-9]+)/preferences$', users_views.UsersPreferences.as_view(), name='users-preferences-list'),
+    url(r'^(?P<user_id>[0-9]+)/organizations/$', users_views.UserOraganizationsList.as_view(), name='users-organizations-list'),
 )
 
 urlpatterns = format_suffix_patterns(urlpatterns)

lms/djangoapps/api_manager/users/views.py

@@ -7,6 +7,7 @@ from django.core.exceptions import ObjectDoesNotExist
 from django.db import IntegrityError
 from django.core.validators import validate_email, validate_slug, ValidationError
 from django.conf import settings
+from django.http import Http404
 from django.utils.translation import get_language, ugettext_lazy as _
 from rest_framework import status
 from rest_framework.response import Response
@@ -15,6 +16,7 @@ from django.db.models import Q
 
 from api_manager.permissions import SecureAPIView, SecureListAPIView
 from api_manager.models import GroupProfile
+from api_manager.organizations.serializers import OrganizationSerializer
 from .serializers import UserSerializer
 
 from courseware import module_render
@@ -876,3 +878,23 @@ class UsersPreferences(SecureAPIView):
                 status_code = status.HTTP_201_CREATED
 
         return Response({}, status_code)
+
+
+class UserOraganizationsList(SecureListAPIView):
+    """
+    ### The UserOrganizationsList view allows clients to retrieve a list of organizations a user
+    belongs to
+    - URI: ```/api/users/{user_id}/organizations/```
+    - GET: Provides paginated list of organizations for a user
+    """
+
+    serializer_class = OrganizationSerializer
+
+    def get_queryset(self):
+        user_id = self.kwargs['user_id']
+        try:
+            user = User.objects.get(id=user_id)
+        except ObjectDoesNotExist:
+            raise Http404
+
+        return user.organizations.all()