Skip to content

E
edx-proctoring
Commit 4fe36066 by chrisndodge
Options

Merge pull request #35 from edx/cdodge/implement-proctoring-setup-complete-page 

Add matching header bar to heartbeat page
parents c16f9772 62871df8
Showing with 305 additions and 9 deletions
edx_proctoring/callbacks.py
""" """
Various callback paths Various callback paths that support callbacks from SoftwareSecure
""" """
import logging import logging
from django.template import Context, loader from django.template import Context, loader
from django.http import HttpResponse from django.http import HttpResponse
from django.core.urlresolvers import reverse
from rest_framework.views import APIView from rest_framework.views import APIView
from rest_framework.response import Response from rest_framework.response import Response
...@@ -27,7 +28,10 @@ def start_exam_callback(request, attempt_code): # pylint: disable=unused-argume ...@@ -27,7 +28,10 @@ def start_exam_callback(request, attempt_code): # pylint: disable=unused-argume
NOTE: This returns HTML as it will be displayed in an embedded browser NOTE: This returns HTML as it will be displayed in an embedded browser
This is an authenticated endpoint and the attempt_code is passed in This is an authenticated endpoint and the attempt_code is passed in
as a query string parameter as part of the URL path
IMPORTANT: This is an unauthenticated endpoint, so be VERY CAREFUL about extending
this endpoint
""" """
attempt = get_exam_attempt_by_code(attempt_code) attempt = get_exam_attempt_by_code(attempt_code)
...@@ -41,13 +45,27 @@ def start_exam_callback(request, attempt_code): # pylint: disable=unused-argume ...@@ -41,13 +45,27 @@ def start_exam_callback(request, attempt_code): # pylint: disable=unused-argume
template = loader.get_template('proctoring/proctoring_launch_callback.html') template = loader.get_template('proctoring/proctoring_launch_callback.html')
return HttpResponse(template.render(Context({}))) poll_url = reverse(
'edx_proctoring.anonymous.proctoring_poll_status',
args=[attempt_code]
)
return HttpResponse(
template.render(
Context({
'exam_attempt_status_url': poll_url,
})
)
)
class ExamReviewCallback(APIView): class ExamReviewCallback(APIView):
""" """
This endpoint is called by a 3rd party proctoring review service when This endpoint is called by a 3rd party proctoring review service when
there are results available for us to record there are results available for us to record
IMPORTANT: This is an unauthenticated endpoint, so be VERY CAREFUL about extending
this endpoint
""" """
def post(self, request): def post(self, request):
...@@ -63,3 +81,36 @@ class ExamReviewCallback(APIView): ...@@ -63,3 +81,36 @@ class ExamReviewCallback(APIView):
data='OK', data='OK',
status=200 status=200
) )
class AttemptStatus(APIView):
"""
This endpoint is called by a 3rd party proctoring review service to determine
status of an exam attempt.
IMPORTANT: This is an unauthenticated endpoint, so be VERY CAREFUL about extending
this endpoint
"""
def get(self, request, attempt_code): # pylint: disable=unused-argument
"""
Returns the status of an exam attempt. Given that this is an unauthenticated
caller, we will only return the status string, no additional information
about the exam
"""
attempt = get_exam_attempt_by_code(attempt_code)
if not attempt:
return HttpResponse(
content='You have entered an exam code that is not valid.',
status=404
)
return Response(
data={
# IMPORTANT: Don't add more information to this as it is an
# unauthenticated endpoint
'status': attempt['status'],
},
status=200
)
edx_proctoring/templates/proctoring/proctoring_launch_callback.html
{% load i18n %} <!DOCTYPE html>
<html> <html lang="en">
<body> <head>
</body> <meta charset="UTF-8">
<title>Sample Progress Steps edX</title>
<style>
body {
background-color: #FAFAFA;
color: #3c3c3c;
font-family: "Open Sans", "Helvetica Neue", Helvetica, Arial, sans-serif;
padding: 0;
margin: 0;
}
.steps-bk {
background: #DFE6E8;
}
.steps-container {
width: 100%;
}
.body-container {
width: 85%;
}
.steps-container p {
line-height: 28px;
font-size: 16px;
color: #5F626C;
margin-bottom: 20px;
}
#steps-wrapper {
width: 960px;
margin: 0 auto;
text-align: center;
position: relative;
}
.steps {
overflow: hidden;
padding: 0;
margin-top: 0;
margin-bottom: 0;
}
.steps li {
list-style-type: none;
font-size: 12px;
width: 25%;
float: left;
position: relative;
padding: 40px 0 20px;
color: #3C464A;
font-weight: bold;
}
.steps li:before {
content: '';
width: 12px;
font-size: 12px;
margin: 0 auto 5px -6px;
border-radius: 9px;
border: 2px solid #ccc;
height: 12px;
background-color: #DFE6E8;
position: absolute;
z-index: 2;
left: 50%;
top: 20px;
}
.steps li:after {
content: "";
width: 100%;
height: 1px;
background: #ccc;
position: absolute;
left: -50%;
top: 26px
}
li.active {
background: #D3DBDC;
}
.steps li:first-child:after {
content: none;
}
.steps li.active:before {
background: #3C464A;
width: 12px;
height: 12px;
border: none;
}
li.completed {
color: #27AE60 !important;
}
.steps li.completed:before {
border: 2px solid #27AE60;
}
.steps li:not(.active) {
color: rgba(51, 51, 51, 0.4);
}
.steps-container {
background: #f6f6f6;
margin: 0 auto;
padding: 20px 50px;
}
.steps-container p {
font-size: 14px;;
}
.steps-container .alert {
background: rgb(250, 246, 233);
border-left: 3px solid rgb(250, 190, 77);
padding: 20px;
}
hr {
border:none;
border-bottom: 1px solid rgb(217, 225, 228);
}
.footer{
border-top: 1px solid rgb(215, 224, 227);
background: rgb(229, 235, 237);
padding: 20px 50px;
margin: 0 -50px;
}
.footer button{
background: rgb(16, 118, 189);
color: white;
font-size: 17px;
padding: 7px 60px;
border: none;
}
.footer button:hover {
cursor: pointer;
background: rgb(8, 92, 150);
}
</style>
<script type="text/javascript" src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
</head>
{% load i18n %}
<body>
<div class="steps-bk">
<div id="steps-wrapper">
<ul class="steps">
<li class="photoid completed">Take ID Photo </li>
<li class="roomscan completed">Record Room Scan</li>
<li class="photo completed">Take User Photo</li>
<li class="end active" >Enter Exam</li>
</ul>
</div>
</div>
<div class="steps-container">
<div class="body-container">
<h3>{% blocktrans %} Your Proctoring Session Is Ready {% endblocktrans %}</h3>
<p>{% blocktrans %} Your proctoring session has started. From this point in time, you must adhere to the online proctoring rules to pass the proctoring review for your exam. Return to the courseware window now and start your exam. {% endblocktrans %}</p>
<div class="alert">
{% blocktrans %} Do not close this window. Leave it open in the background as you take your exam. {% endblocktrans %}
</div>
<h5> {% blocktrans %} Remember to abide by the guidelines and rules of your proctored exam, including: {% endblocktrans %}</h5>
<p> <p>
{% blocktrans %} {% blocktrans %}
Your proctoring session has started. Do not close this window. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor.
Return to the browser window where your course is open to take your exam. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim.
{% endblocktrans %} {% endblocktrans %}
</p> </p>
<hr>
<p>
{% blocktrans %}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor.
Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim.
{% endblocktrans %}
</p>
<hr>
<p>
{% blocktrans %}
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor.
Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.
Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim.
{% endblocktrans %}
</p>
</div>
<div class="footer">
<button>
{% blocktrans %} Go to my exam {% endblocktrans %}
</button>
</div>
</div>
<script type="text/javascript">
var _poll_interval = null;
$(document).ready(function() {
_poll_interval = setInterval(
poll_exam_status,
5000
);
});
function poll_exam_status() {
var url = '{{exam_attempt_status_url}}';
$.ajax(url).success(function(data){
// has the end user completed the exam in the LMS?!?
if (data.status === 'completed' || data.status === 'submitted' || data.status === 'verified') {
// Signal that the desktop software should terminate
// NOTE: This is per the API documentation from SoftwareSecure
window.external.quitApplication();
}
});
}
</script>
</body>
</html> </html>
edx_proctoring/tests/test_views.py
...@@ -935,6 +935,16 @@ class TestStudentProctoredExamAttempt(LoggedInTestCase): ...@@ -935,6 +935,16 @@ class TestStudentProctoredExamAttempt(LoggedInTestCase):
attempt = get_exam_attempt_by_id(attempt_id) attempt = get_exam_attempt_by_id(attempt_id)
self.assertEqual(attempt['status'], 'ready_to_start') self.assertEqual(attempt['status'], 'ready_to_start')
# test the polling callback point
response = self.client.get(
reverse(
'edx_proctoring.anonymous.proctoring_poll_status',
args=[attempt_code]
)
)
self.assertEqual(response.status_code, 200)
self.assertEqual(response.data['status'], 'ready_to_start')
def test_bad_exam_code_callback(self): def test_bad_exam_code_callback(self):
""" """
Assert that we get a 404 when doing a callback on an exam code that does not exist Assert that we get a 404 when doing a callback on an exam code that does not exist
...@@ -947,6 +957,15 @@ class TestStudentProctoredExamAttempt(LoggedInTestCase): ...@@ -947,6 +957,15 @@ class TestStudentProctoredExamAttempt(LoggedInTestCase):
) )
self.assertEqual(response.status_code, 404) self.assertEqual(response.status_code, 404)
# test the polling callback point as well
response = self.client.get(
reverse(
'edx_proctoring.anonymous.proctoring_poll_status',
args=['foo']
)
)
self.assertEqual(response.status_code, 404)
def test_review_callback(self): def test_review_callback(self):
""" """
Simulates a callback from the proctoring service with the Simulates a callback from the proctoring service with the
......
edx_proctoring/urls.py
...@@ -66,6 +66,10 @@ urlpatterns = patterns( # pylint: disable=invalid-name ...@@ -66,6 +66,10 @@ urlpatterns = patterns( # pylint: disable=invalid-name
views.ActiveExamsForUserView.as_view(), views.ActiveExamsForUserView.as_view(),
name='edx_proctoring.proctored_exam.active_exams_for_user' name='edx_proctoring.proctored_exam.active_exams_for_user'
), ),
#
# Unauthenticated callbacks from SoftwareSecure. Note we use other
# security token measures to protect data
#
url( url(
r'edx_proctoring/proctoring_launch_callback/start_exam/(?P<attempt_code>[-\w]+)$', r'edx_proctoring/proctoring_launch_callback/start_exam/(?P<attempt_code>[-\w]+)$',
callbacks.start_exam_callback, callbacks.start_exam_callback,
...@@ -76,5 +80,10 @@ urlpatterns = patterns( # pylint: disable=invalid-name ...@@ -76,5 +80,10 @@ urlpatterns = patterns( # pylint: disable=invalid-name
callbacks.ExamReviewCallback.as_view(), callbacks.ExamReviewCallback.as_view(),
name='edx_proctoring.anonymous.proctoring_review_callback' name='edx_proctoring.anonymous.proctoring_review_callback'
), ),
url(
r'edx_proctoring/proctoring_poll_status/(?P<attempt_code>[-\w]+)$',
callbacks.AttemptStatus.as_view(),
name='edx_proctoring.anonymous.proctoring_poll_status'
),
url(r'^', include('rest_framework.urls', namespace='rest_framework')) url(r'^', include('rest_framework.urls', namespace='rest_framework'))
) )
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