Add initial prototype code.

README.md

-edx-tim
-=======
+This is an initial prototype for redesigning Peer Grading and general Open Ended Submission Evaluation.
 
-A prototype.
+Installation
+------------
+
+./manage.py runserver
+
+The intent of this prototype is to be installed as a plugin for the edx-platform. Refer to XBlock and
+XModule documentation for more details. (Though I should have more here once this prototype is better
+refined...)
+
+
+License
+-------
+
+The code in this repository is licensed under version 3 of the AGPL unless
+otherwise noted.
+
+Please see ``LICENSE.txt`` for details.
+
+Documentation
+------------
+
+TODO
+
+How to Contribute
+-----------------
+
+Currently locked down.
+
+Reporting Security Issues
+-------------------------
+
+Please do not report security issues in public. Please email security@edx.org
+
+Mailing List and IRC Channel
+----------------------------
+
+You can discuss this code on the [edx-code Google Group](https://groups.google.com/forum/#!forum/edx-code) or in the
+`edx-code` IRC channel on Freenode.

peer_grading/manage.py

+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "peer_grading.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

peer_grading/peer_grading/__init__.py

+"""
+The Peer Grading Application pushes a student submission through the Peer Grading Workflow, allowing other students
+and instructors to give and receive grades for any open ended submission.
+"""
\ No newline at end of file

peer_grading/peer_grading/settings.py

+# Django settings for peer_grading project.
+
+DEBUG = True
+TEMPLATE_DEBUG = DEBUG
+
+ADMINS = (
+    # ('Your Name', 'your_email@example.com'),
+)
+
+MANAGERS = ADMINS
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.', # Add 'postgresql_psycopg2', 'mysql', 'sqlite3' or 'oracle'.
+        'NAME': '',                      # Or path to database file if using sqlite3.
+        'USER': '',                      # Not used with sqlite3.
+        'PASSWORD': '',                  # Not used with sqlite3.
+        'HOST': '',                      # Set to empty string for localhost. Not used with sqlite3.
+        'PORT': '',                      # Set to empty string for default. Not used with sqlite3.
+    }
+}
+
+# Local time zone for this installation. Choices can be found here:
+# http://en.wikipedia.org/wiki/List_of_tz_zones_by_name
+# although not all choices may be available on all operating systems.
+# On Unix systems, a value of None will cause Django to use the same
+# timezone as the operating system.
+# If running in a Windows environment this must be set to the same as your
+# system time zone.
+TIME_ZONE = 'America/Chicago'
+
+# Language code for this installation. All choices can be found here:
+# http://www.i18nguy.com/unicode/language-identifiers.html
+LANGUAGE_CODE = 'en-us'
+
+SITE_ID = 1
+
+# If you set this to False, Django will make some optimizations so as not
+# to load the internationalization machinery.
+USE_I18N = True
+
+# If you set this to False, Django will not format dates, numbers and
+# calendars according to the current locale.
+USE_L10N = True
+
+# If you set this to False, Django will not use timezone-aware datetimes.
+USE_TZ = True
+
+# Absolute filesystem path to the directory that will hold user-uploaded files.
+# Example: "/home/media/media.lawrence.com/media/"
+MEDIA_ROOT = ''
+
+# URL that handles the media served from MEDIA_ROOT. Make sure to use a
+# trailing slash.
+# Examples: "http://media.lawrence.com/media/", "http://example.com/media/"
+MEDIA_URL = ''
+
+# Absolute path to the directory static files should be collected to.
+# Don't put anything in this directory yourself; store your static files
+# in apps' "static/" subdirectories and in STATICFILES_DIRS.
+# Example: "/home/media/media.lawrence.com/static/"
+STATIC_ROOT = ''
+
+# URL prefix for static files.
+# Example: "http://media.lawrence.com/static/"
+STATIC_URL = '/static/'
+
+# Additional locations of static files
+STATICFILES_DIRS = (
+    # Put strings here, like "/home/html/static" or "C:/www/django/static".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+)
+
+# List of finder classes that know how to find static files in
+# various locations.
+STATICFILES_FINDERS = (
+    'django.contrib.staticfiles.finders.FileSystemFinder',
+    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
+#    'django.contrib.staticfiles.finders.DefaultStorageFinder',
+)
+
+# Make this unique, and don't share it with anybody.
+SECRET_KEY = ')68&-c!+og)cy$o9pju_$c707+fett&ph%t%gqgu-@5)!cl$cr'
+
+# List of callables that know how to import templates from various sources.
+TEMPLATE_LOADERS = (
+    'django.template.loaders.filesystem.Loader',
+    'django.template.loaders.app_directories.Loader',
+#     'django.template.loaders.eggs.Loader',
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.middleware.common.CommonMiddleware',
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    # Uncomment the next line for simple clickjacking protection:
+    # 'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = 'peer_grading.urls'
+
+# Python dotted path to the WSGI application used by Django's runserver.
+WSGI_APPLICATION = 'peer_grading.wsgi.application'
+
+TEMPLATE_DIRS = (
+    # Put strings here, like "/home/html/django_templates" or "C:/www/django/templates".
+    # Always use forward slashes, even on Windows.
+    # Don't forget to use absolute paths, not relative paths.
+)
+
+INSTALLED_APPS = (
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.sites',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    # Uncomment the next line to enable the admin:
+    # 'django.contrib.admin',
+    # Uncomment the next line to enable admin documentation:
+    # 'django.contrib.admindocs',
+)
+
+# A sample logging configuration. The only tangible logging
+# performed by this configuration is to send an email to
+# the site admins on every HTTP 500 error when DEBUG=False.
+# See http://docs.djangoproject.com/en/dev/topics/logging for
+# more details on how to customize your logging configuration.
+LOGGING = {
+    'version': 1,
+    'disable_existing_loggers': False,
+    'filters': {
+        'require_debug_false': {
+            '()': 'django.utils.log.RequireDebugFalse'
+        }
+    },
+    'handlers': {
+        'mail_admins': {
+            'level': 'ERROR',
+            'filters': ['require_debug_false'],
+            'class': 'django.utils.log.AdminEmailHandler'
+        }
+    },
+    'loggers': {
+        'django.request': {
+            'handlers': ['mail_admins'],
+            'level': 'ERROR',
+            'propagate': True,
+        },
+    }
+}

peer_grading/peer_grading/urls.py

+from django.conf.urls import patterns, include, url
+
+# Uncomment the next two lines to enable the admin:
+# from django.contrib import admin
+# admin.autodiscover()
+
+urlpatterns = patterns('peer_grading.views',
+    url(r'^submit_peer_essay', 'submit_peer_essay'),
+)

peer_grading/peer_grading/views.py

+"""
+RESTful interface for all Peer Grading Workflow. Covers all requests made for Peer Grading.
+"""
+import logging
+import util
+
+log = logging.getLogger(__name__)
+
+_INTERFACE_VERSION = 0
+
+
+def submit_peer_essay(request):
+    """
+    The Peer Grading XModule will push submissions to this interface.
+
+    request - dict with keys header and body
+    header needs submission_id,submission_key,queue_name
+    body needs grader_payload, student_info, student_response, max_score
+    grader_payload needs location, course_id,problem_id,grader
+    student_info needs anonymous_student_id, submission_time
+
+    Output:
+    Returns status code indicating success (0) or failure (1) and message
+    """
+    if request.method != 'POST':
+        return util._error_response("'submit' must use HTTP POST", _INTERFACE_VERSION)
+
+    #Minimal parsing of reply
+    reply_is_valid, header, body = _is_valid_reply(request.POST.copy())
+
+    if not reply_is_valid:
+        log.error("Invalid xqueue object added: request_ip: {0} request.POST: {1}".format(
+            util.get_request_ip(request),
+            request.POST,
+        ))
+        return util._error_response('Incorrect format', _INTERFACE_VERSION)
+
+    #Retrieve individual values from xqueue body and header.
+    prompt = util._value_or_default(body['grader_payload']['prompt'], "")
+    rubric = util._value_or_default(body['grader_payload']['rubric'], "")
+    student_id = util._value_or_default(body['student_info']['anonymous_student_id'])
+    location = util._value_or_default(body['grader_payload']['location'])
+    course_id = util._value_or_default(body['grader_payload']['course_id'])
+    problem_id = util._value_or_default(body['grader_payload']['problem_id'], location)
+    grader_settings = util._value_or_default(body['grader_payload']['grader_settings'], "")
+    student_response = util._value_or_default(body['student_response'])
+    student_response = util.sanitize_html(student_response)
+    xqueue_submission_id = util._value_or_default(header['submission_id'])
+    xqueue_submission_key = util._value_or_default(header['submission_key'])
+    state_code = SubmissionState.waiting_to_be_graded
+    xqueue_queue_name = util._value_or_default(header["queue_name"])
+    max_score = util._value_or_default(body['max_score'])
+
+    submission_time_string = util._value_or_default(body['student_info']['submission_time'])
+    student_submission_time = datetime.strptime(submission_time_string, "%Y%m%d%H%M%S")
+
+    control_fields = json.loads(body['grader_payload'].get('control', {}))
+
+
+    skip_basic_checks = util._value_or_default(body['grader_payload']['skip_basic_checks'], False)
+    if isinstance(skip_basic_checks, basestring):
+        skip_basic_checks = (skip_basic_checks.lower() == "true")
+
+    #TODO: find a better way to do this
+    #Need to set rubric to whatever the first submission for this location had
+    #as its rubric.  If the rubric is changed in the course XML, it will break things.
+    try:
+        first_sub_for_location = Submission.objects.filter(location=location).order_by('date_created')[0]
+        rubric = first_sub_for_location.rubric
+    except Exception:
+        error_message = "Could not find an existing submission in location.  rubric is original."
+        log.info(error_message)
+
+    initial_display = ""
+    if 'initial_display' in body['grader_payload'].keys():
+        initial_display = util._value_or_default(body['grader_payload']['initial_display'], "")
+    answer = ""
+    if 'answer' in body['grader_payload'].keys():
+        answer = util._value_or_default(body['grader_payload']['answer'], "")
+
+    #Without this, sometimes a race condition creates duplicate submissions
+    sub_count = Submission.objects.filter(
+        prompt=prompt,
+        rubric=rubric,
+        student_id=student_id,
+        problem_id=problem_id,
+        student_submission_time=student_submission_time,
+        xqueue_submission_id=xqueue_submission_id,
+        xqueue_submission_key=xqueue_submission_key,
+        xqueue_queue_name=xqueue_queue_name,
+        location=location,
+        course_id=course_id,
+        grader_settings=grader_settings,
+    ).count()
+
+    if sub_count > 0:
+        return util._error_response('Submission already exists.', _INTERFACE_VERSION)
+
+    #Create submission object
+    sub, created = Submission.objects.get_or_create(
+        prompt=prompt,
+        rubric=rubric,
+        student_id=student_id,
+        problem_id=problem_id,
+        state=state_code,
+        student_response=student_response,
+        student_submission_time=student_submission_time,
+        xqueue_submission_id=xqueue_submission_id,
+        xqueue_submission_key=xqueue_submission_key,
+        xqueue_queue_name=xqueue_queue_name,
+        location=location,
+        course_id=course_id,
+        max_score=max_score,
+        grader_settings=grader_settings,
+        initial_display=initial_display,
+        answer=answer,
+        skip_basic_checks=skip_basic_checks,
+        control_fields=json.dumps(control_fields)
+    )
+
+    if not created:
+        return util._error_response('Submission already exists.', _INTERFACE_VERSION)
+
+    #Handle submission and write to db
+    success = handle_submission(sub)
+    if not success:
+        return util._error_response("Failed to handle submission.", _INTERFACE_VERSION)
+
+    util.log_connection_data()
+    return util._success_response({'message': "Saved successfully."}, _INTERFACE_VERSION)

peer_grading/peer_grading/wsgi.py

+"""
+WSGI config for peer_grading project.
+
+This module contains the WSGI application used by Django's development server
+and any production WSGI deployments. It should expose a module-level variable
+named ``application``. Django's ``runserver`` and ``runfcgi`` commands discover
+this application via the ``WSGI_APPLICATION`` setting.
+
+Usually you will have the standard Django WSGI application here, but it also
+might make sense to replace the whole Django WSGI application with a custom one
+that later delegates to the Django one. For example, you could introduce WSGI
+middleware here, or combine a Django application with an application of another
+framework.
+
+"""
+import os
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "peer_grading.settings")
+
+# This application object is used by any WSGI server configured to use this
+# file. This includes Django's development server, if the WSGI_APPLICATION
+# setting points here.
+from django.core.wsgi import get_wsgi_application
+application = get_wsgi_application()
+
+# Apply WSGI middleware here.
+# from helloworld.wsgi import HelloWorldApplication
+# application = HelloWorldApplication(application)

peer_grading/peer_grading/xmodule/__init__.py

+"""
+Contains all Peer Grading XModule code.
+"""
+__author__ = 'stephensanchez'

peer_grading/peer_grading/xmodule/peer_grading_module.py

+"""
+New Peer Grading XModule.
+"""
+__author__ = 'stephensanchez'
+