Skip to content

E
edx-platform
Commit e285263b by Zia Fazal Committed by Jonathan Piacenti
Options

added new fields to organisation model 

added lookup of organisation by user

merged with master
parent 649ccb53
Showing with 269 additions and 5 deletions
lms/djangoapps/api_manager/migrations/0010_auto__add_field_organization_display_name__add_field_organization_cont.py 0 → 100644
# -*- coding: utf-8 -*-
import datetime
from south.db import db
from south.v2 import SchemaMigration
from django.db import models
class Migration(SchemaMigration):
def forwards(self, orm):
# Adding field 'Organization.display_name'
db.add_column('api_manager_organization', 'display_name',
self.gf('django.db.models.fields.CharField')(max_length=255, null=True, blank=True),
keep_default=False)
# Adding field 'Organization.contact_name'
db.add_column('api_manager_organization', 'contact_name',
self.gf('django.db.models.fields.CharField')(max_length=255, null=True, blank=True),
keep_default=False)
# Adding field 'Organization.contact_email'
db.add_column('api_manager_organization', 'contact_email',
self.gf('django.db.models.fields.EmailField')(max_length=255, null=True, blank=True),
keep_default=False)
# Adding field 'Organization.contact_phone'
db.add_column('api_manager_organization', 'contact_phone',
self.gf('django.db.models.fields.CharField')(max_length=50, null=True, blank=True),
keep_default=False)
def backwards(self, orm):
# Deleting field 'Organization.display_name'
db.delete_column('api_manager_organization', 'display_name')
# Deleting field 'Organization.contact_name'
db.delete_column('api_manager_organization', 'contact_name')
# Deleting field 'Organization.contact_email'
db.delete_column('api_manager_organization', 'contact_email')
# Deleting field 'Organization.contact_phone'
db.delete_column('api_manager_organization', 'contact_phone')
models = {
'api_manager.coursecontentgrouprelationship': {
'Meta': {'unique_together': "(('course_id', 'content_id', 'group_profile'),)", 'object_name': 'CourseContentGroupRelationship'},
'content_id': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
'course_id': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'group_profile': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['api_manager.GroupProfile']"}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
'record_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'})
},
'api_manager.coursegrouprelationship': {
'Meta': {'object_name': 'CourseGroupRelationship'},
'course_id': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'}),
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'group': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['auth.Group']"}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
'record_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'})
},
'api_manager.groupprofile': {
'Meta': {'object_name': 'GroupProfile', 'db_table': "'auth_groupprofile'"},
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'data': ('django.db.models.fields.TextField', [], {'blank': 'True'}),
'group': ('django.db.models.fields.related.OneToOneField', [], {'to': "orm['auth.Group']", 'unique': 'True'}),
'group_type': ('django.db.models.fields.CharField', [], {'max_length': '32', 'null': 'True', 'db_index': 'True'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
'record_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'})
},
'api_manager.grouprelationship': {
'Meta': {'object_name': 'GroupRelationship'},
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'group': ('django.db.models.fields.related.OneToOneField', [], {'to': "orm['auth.Group']", 'unique': 'True', 'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'parent_group': ('django.db.models.fields.related.ForeignKey', [], {'default': '0', 'related_name': "'child_groups'", 'null': 'True', 'blank': 'True', 'to': "orm['api_manager.GroupRelationship']"}),
'record_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'})
},
'api_manager.linkedgrouprelationship': {
'Meta': {'object_name': 'LinkedGroupRelationship'},
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'from_group_relationship': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'from_group_relationships'", 'to': "orm['api_manager.GroupRelationship']"}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
'record_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
'to_group_relationship': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'to_group_relationships'", 'to': "orm['api_manager.GroupRelationship']"})
},
'api_manager.organization': {
'Meta': {'object_name': 'Organization'},
'contact_email': ('django.db.models.fields.EmailField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
'contact_name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
'contact_phone': ('django.db.models.fields.CharField', [], {'max_length': '50', 'null': 'True', 'blank': 'True'}),
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'display_name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'users': ('django.db.models.fields.related.ManyToManyField', [], {'related_name': "'organizations'", 'symmetrical': 'False', 'to': "orm['auth.User']"}),
'workgroups': ('django.db.models.fields.related.ManyToManyField', [], {'related_name': "'organizations'", 'symmetrical': 'False', 'to': "orm['projects.Workgroup']"})
},
'auth.group': {
'Meta': {'object_name': 'Group'},
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'name': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '80'}),
'permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'})
},
'auth.permission': {
'Meta': {'ordering': "('content_type__app_label', 'content_type__model', 'codename')", 'unique_together': "(('content_type', 'codename'),)", 'object_name': 'Permission'},
'codename': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'content_type': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['contenttypes.ContentType']"}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '50'})
},
'auth.user': {
'Meta': {'object_name': 'User'},
'date_joined': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
'email': ('django.db.models.fields.EmailField', [], {'max_length': '75', 'blank': 'True'}),
'first_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
'groups': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Group']", 'symmetrical': 'False', 'blank': 'True'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'is_active': ('django.db.models.fields.BooleanField', [], {'default': 'True'}),
'is_staff': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'is_superuser': ('django.db.models.fields.BooleanField', [], {'default': 'False'}),
'last_login': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
'last_name': ('django.db.models.fields.CharField', [], {'max_length': '30', 'blank': 'True'}),
'password': ('django.db.models.fields.CharField', [], {'max_length': '128'}),
'user_permissions': ('django.db.models.fields.related.ManyToManyField', [], {'to': "orm['auth.Permission']", 'symmetrical': 'False', 'blank': 'True'}),
'username': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '30'})
},
'contenttypes.contenttype': {
'Meta': {'ordering': "('name',)", 'unique_together': "(('app_label', 'model'),)", 'object_name': 'ContentType', 'db_table': "'django_content_type'"},
'app_label': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'model': ('django.db.models.fields.CharField', [], {'max_length': '100'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '100'})
},
'projects.project': {
'Meta': {'unique_together': "(('course_id', 'content_id'),)", 'object_name': 'Project'},
'content_id': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'course_id': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'})
},
'projects.workgroup': {
'Meta': {'object_name': 'Workgroup'},
'created': ('model_utils.fields.AutoCreatedField', [], {'default': 'datetime.datetime.now'}),
'groups': ('django.db.models.fields.related.ManyToManyField', [], {'blank': 'True', 'related_name': "'workgroups'", 'null': 'True', 'symmetrical': 'False', 'to': "orm['auth.Group']"}),
'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
'modified': ('model_utils.fields.AutoLastModifiedField', [], {'default': 'datetime.datetime.now'}),
'name': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
'project': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'workgroups'", 'to': "orm['projects.Project']"}),
'users': ('django.db.models.fields.related.ManyToManyField', [], {'blank': 'True', 'related_name': "'workgroups'", 'null': 'True', 'symmetrical': 'False', 'to': "orm['auth.User']"})
}
}
complete_apps = ['api_manager']
\ No newline at end of file
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()
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment