Refactor code into modules.

Author: teemulehtinen

README.md

@@ -17,17 +17,21 @@ A+ is a Django 1.7+ and Python 3 application which has been run in production us
 Testing environment
 -------------------
 
-See [doc/README.md](doc/README.md) on how to create and run a test environment for development.
-
-Structure
----------
-
-Included Django applications
-* `course` : The course instances
-* `exercise` : Learning modules and exercises for the course instances
-* `userprofile` : Additional user information and groups
-* `django_shibboleth` : Handles users for Apache Shibboleth headers
-* `notification` : User messaging framework
-* `inheritance` : Utilities for model class hierarchy
-* `external_services` : Linking to external services, optionally LTI authenticated
-* `apps` Provides plugins (tabs disabled) that integrate additional parts to main content
+See [doc/](doc) on how to create and run a test environment for development.
+
+The [selenium_test/](selenium_test) offers an integration test suite run with Selenium Firefox driver.
+
+Code Organization
+-----------------
+
+[a-plus/](a-plus) : Django main settings
+[course/](course) : The course instances
+[exercise/](exercise) : Learning modules and exercises for the course instances
+[userprofile/](userprofile) : Additional user information and groups
+[django_shibboleth/](django_shibboleth) : Handles users for Apache Shibboleth request headers
+[notification/](notification) : User messaging framework
+[inheritance/](inheritance) : Utilities for model class hierarchy
+[external_services/](external_services) : Linking to external services, optionally LTI authenticated
+[apps/](apps) : Provides plugins that can integrate additional content to course instances
+[api/](api) : An HTTP service API for accessing A+ data
+[lib/](lib) : More general libraries

a-plus/__init__.py

@@ -7,7 +7,7 @@
 # Build paths inside the project like this: os.path.join(BASE_DIR, ...)
 import os
 
-BASE_DIR = os.path.dirname(__file__)
+BASE_DIR = os.path.dirname(os.path.dirname(__file__))
 
 
 # Quick-start development settings - unsuitable for production
@@ -83,7 +83,7 @@
     "django.core.files.uploadhandler.TemporaryFileUploadHandler",
 )
 
-ROOT_URLCONF = 'urls'
+ROOT_URLCONF = 'a-plus.urls'
 
 LOGIN_REDIRECT_URL = "/"
 

settings.py a-plus/settings.py

@@ -1,34 +1,32 @@
-# A+
-from views import login, home, privacy
-
-# Django
+from django.conf import settings
 from django.conf.urls import patterns, url, include
 from django.contrib import admin
-from django.conf import settings
+from django.views.generic import TemplateView
+
 
 admin.autodiscover()
 
 urlpatterns = patterns('',
 
     # A+
-    (r'^$', home),
-    url(r'^privacy-policy(?:.html)?$', privacy, name="privacy_policy"),
-
+    url(r'^privacy-policy$', TemplateView.as_view(template_name='aaltoplus/privacy.html'),
+        name="privacy_policy"),
+    (r'^$', 'course.views.home'),
     (r'^exercise/', include('exercise.urls')),
     (r'^course/', include('course.urls')),
-    (r'^api/', include('api_urls')),
+    (r'^api/', include('api.urls')),
     (r'^userprofile/', include('userprofile.urls')),
     (r'^apps/', include('apps.urls')),
     (r'^external/', include('external_services.urls')),
 
     # Shibboleth
     (r'^shibboleth/', include('django_shibboleth.urls')),
 
-    # Django:
-    (r'^admin/', include(admin.site.urls)),
-    (r'^accounts/login/$', login),
+    # Django
+    (r'^accounts/login/$', 'userprofile.views.login'),
     url(r'^accounts/logout/$', "django.contrib.auth.views.logout",
         { "template_name": "aaltoplus/logout.html" }, name="logout"),
+    (r'^admin/', include(admin.site.urls)),
 )
 
 if settings.DEBUG:

urls.py a-plus/urls.py

@@ -0,0 +1,14 @@
+"""
+WSGI config for A+ project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/
+"""
+
+import os
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "a-plus.settings")
+
+from django.core.wsgi import get_wsgi_application
+application = get_wsgi_application()

a-plus/wsgi.py

@@ -17,7 +17,6 @@
 api.register(LearningObjectResource())
 api.register(CourseInstanceSummaryResource())
 
-
 urlpatterns = patterns('',
     (r'^', include(api.urls)),
 )

api/__init__.py

@@ -1,20 +1,18 @@
-# Django
 from django.conf.urls import url
-from django.core.urlresolvers import reverse
 from django.contrib.auth.models import User
+from django.core.urlresolvers import reverse
 
-# Tastypie
-from tastypie.resources import ModelResource, Resource
-from tastypie.authentication import Authentication #, OAuthAuthentication
-from tastypie.authorization import DjangoAuthorization, ReadOnlyAuthorization
-from tastypie import fields
-from tastypie.bundle import Bundle
-
-# A+
 from course.models import Course, CourseInstance
 from exercise.exercise_summary import UserCourseSummary
+from tastypie import fields
+from tastypie.authentication import Authentication  # , OAuthAuthentication
+from tastypie.authorization import DjangoAuthorization, ReadOnlyAuthorization
+from tastypie.bundle import Bundle
+from tastypie.resources import ModelResource, Resource
 from userprofile.models import UserProfile
 
+
+# A+
 class CourseResource(ModelResource):
     instances           = fields.ToManyField('course.api.CourseInstanceResource', 'instances')
 

api_permissions.py api/permissions.py

@@ -1,23 +1,33 @@
 from collections import defaultdict
-import datetime
 from django.contrib import messages
 from django.contrib.auth.decorators import login_required
 from django.http import HttpResponse, HttpResponseForbidden, \
     HttpResponseRedirect
 from django.shortcuts import get_object_or_404, render_to_response
 from django.template import loader
+from django.template.context import RequestContext
+from django.utils.datetime_safe import datetime
 from django.utils.translation import ugettext_lazy as _
 
 from apps.app_renderers import build_plugin_renderers
 from course.context import CourseContext
 from course.forms import CourseModuleForm
-from course.models import Course, CourseInstance
+from course.models import Course, CourseInstance, get_visible_open_course_instances
 from course.results import ResultTable
 from exercise.exercise_models import CourseModule, BaseExercise, LearningObjectCategory
 from exercise.exercise_summary import UserCourseSummary
 from icalendar import Calendar, Event
 
 
+def home(request):
+    if request.user.is_authenticated():
+        instances = get_visible_open_course_instances(request.user.userprofile)
+    else:
+        instances = get_visible_open_course_instances()
+    context = RequestContext(request, {"instances": instances})
+    return render_to_response("aaltoplus/home.html", context)
+
+
 # TODO: The string constant "You are not allowed to access this view." is
 # repeated a lot in this file. Giving this error message should be somehow
 # unified.

api_urls.py api/urls.py

@@ -1,80 +1,76 @@
-# Python
 from base64 import b64encode
 
-# Tastypie
-from tastypie.resources import ModelResource, Resource, ALL
-from api_permissions import *
-from tastypie.authentication import ApiKeyAuthentication #,OAuthAuthentication 
-from tastypie.authorization import DjangoAuthorization, ReadOnlyAuthorization
+from api.permissions import SuperuserAuthorization
 from tastypie import fields
+from tastypie.authentication import Authentication, ApiKeyAuthentication 
+from tastypie.authorization import DjangoAuthorization, ReadOnlyAuthorization
+from tastypie.resources import ModelResource, Resource, ALL
+
+from .exercise_models import LearningObject, BaseExercise, CourseModule
+from .submission_models import Submission
 
-# A+
-from userprofile.models import UserProfile
-from .exercise_models import LearningObject, BaseExercise, CourseModule, CourseInstance
-from .submission_models import Submission, SubmittedFile
-from api_permissions import SuperuserAuthorization
 
 class LearningObjectResource(ModelResource):
     class Meta:
-        queryset        = LearningObject.objects.all()
-        resource_name   = 'learning_object'
-        excludes        = []
+        queryset = LearningObject.objects.all()
+        resource_name = 'learning_object'
+        excludes = []
 
         # In the first version GET (read only) requests are
         # allowed and no authentication is required
         allowed_methods = ['get']
-        authentication  = Authentication()
-        authorization   = ReadOnlyAuthorization()
+        authentication = Authentication()
+        authorization = ReadOnlyAuthorization()
 
 
 class ExerciseResource(ModelResource):
-    submissions         = fields.ToManyField('exercise.api.SubmissionResource', 'submissions')
+    submissions = fields.ToManyField('exercise.api.SubmissionResource', 'submissions')
 
     class Meta:
-        queryset        = BaseExercise.objects.all()
-        resource_name   = 'exercise'
-        excludes        = []
+        queryset = BaseExercise.objects.all()
+        resource_name = 'exercise'
+        excludes = []
 
         # In the first version GET (read only) requests are
         # allowed and no authentication is required
         allowed_methods = ['get']
-        authentication  = Authentication()
-        authorization   = ReadOnlyAuthorization()
+        authentication = Authentication()
+        authorization = ReadOnlyAuthorization()
 
 class CourseModuleResource(ModelResource):
-    learning_objects    = fields.ToManyField('exercise.api.LearningObjectResource', 'learning_objects')
+    learning_objects = fields.ToManyField('exercise.api.LearningObjectResource', 'learning_objects')
 
     class Meta:
-        queryset        = CourseModule.objects.all()
-        resource_name   = 'coursemodule'
-        excludes        = []
+        queryset = CourseModule.objects.all()
+        resource_name = 'coursemodule'
+        excludes = []
 
         # In the first version GET (read only) requests are
         # allowed and no authentication is required
         allowed_methods = ['get']
-        authentication  = Authentication()
-        authorization   = ReadOnlyAuthorization()
+        authentication = Authentication()
+        authorization = ReadOnlyAuthorization()
 
 class SubmissionResource(ModelResource):
-    exercise            = fields.ToOneField('exercise.api.ExerciseResource', 'exercise')
-    grader              = fields.ToOneField('userprofile.api.UserProfileResource', 'grader', null=True, blank=True)
-    submitters          = fields.ToManyField('userprofile.api.UserProfileResource', 'submitters', null=True, blank=True)
+    exercise = fields.ToOneField('exercise.api.ExerciseResource', 'exercise')
+    grader = fields.ToOneField('userprofile.api.UserProfileResource', 'grader', null=True, blank=True)
+    submitters = fields.ToManyField('userprofile.api.UserProfileResource', 'submitters', null=True, blank=True)
 
     def dehydrate(self, bundle):
         """
         This method iterates over the URLs of the files submitted with each
         submission and adds them in the file_urls lists of submissions.
         """
-        file_urls       = []
+        file_urls = []
         for file in bundle.obj.files.all():
             file_urls.append(file.get_absolute_url())
         bundle.data.update({"files": file_urls})
         return bundle
 
     class Meta:
-        queryset        = Submission.objects.all()
-        resource_name   = 'submission'
-        excludes        = ['feedback']
+        queryset = Submission.objects.all()
+        resource_name = 'submission'
+        excludes = ['feedback']
         allowed_methods = ['get']
         include_absolute_url = True
 
@@ -88,9 +84,8 @@ class Meta:
         }
 
         # In this version only superusers are allowed to access
-        # submissions after being authenticated with OAuth
-        # authentication  = OAuthAuthentication()
-        authorization   = SuperuserAuthorization()
+        # submissions.
+        authorization = SuperuserAuthorization()
 
 class SubmissionContentResource(ModelResource):
     """
@@ -122,9 +117,9 @@ def dehydrate(self, bundle):
         return bundle
 
     class Meta:
-        queryset        = Submission.objects.all()
-        resource_name   = 'submission_content'
-        excludes        = ['feedback']
+        queryset = Submission.objects.all()
+        resource_name = 'submission_content'
+        excludes = ['feedback']
         allowed_methods = ['get']
         include_absolute_url = True
 
@@ -137,5 +132,5 @@ class Meta:
             "id": ALL
         }
 
-        authentication  = ApiKeyAuthentication()
-        authorization   = ReadOnlyAuthorization()
+        authentication = ApiKeyAuthentication()
+        authorization = ReadOnlyAuthorization()

course/api.py

@@ -3,7 +3,7 @@
 import sys
 
 if __name__ == "__main__":
-    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings")
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "a-plus.settings")
 
     from django.core.management import execute_from_command_line
 

course/views.py

@@ -1,10 +1,6 @@
-# Tastypie
+from api.permissions import SuperuserAuthorization
 from tastypie.resources import ModelResource
-#from tastypie.authentication import OAuthAuthentication #TODO FIX
-
-# A+
 from userprofile.models import UserProfile
-from api_permissions import SuperuserAuthorization #TODO FIX
 
 
 class UserProfileResource(ModelResource):
@@ -29,5 +25,4 @@ class Meta:
         # In this version of the API only superusers are allowed to access
         # userprofile objects
         allowed_methods = ['get']
-        #authentication  = OAuthAuthentication()  #TODO fix
         authorization   = SuperuserAuthorization()