Merge pull request #7 from jspayd/editable-message

Make message editable

README.markdown

@@ -9,6 +9,7 @@ Instructors define the following paramters in Studio:
 - survey id
 - university
 - link text
+- message
 - parameter name for userid
 
 Students click on a link within the unit and this takes them to the survey.

package.json

@@ -2,7 +2,7 @@
   "name": "xblock_qualtrics_survey",
   "title": "Qualtrics Survey",
   "description": "Xblock for creating a Qualtrics survey.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "homepage": "https://github.com/Stanford-Online/xblock-qualtrics-survey",
   "author": {
     "name": "David Adams",

qualtricssurvey/private/view.html

@@ -1,4 +1,4 @@
 <div class="qualtricssurvey_block">
-    <p>The survey will open in a new browser tab or window.</p>
-    <p><a href="https://{your_university}.qualtrics.com/jfe/form/{survey_id}{user_id_string}" target="_blank">{link_text}</a></p>
+    <p>{message}</p>
+    <p><a class="button primary-button qualtrics-button" href="https://{your_university}.qualtrics.com/jfe/form/{survey_id}{user_id_string}" target="_blank">{link_text}</a></p>
 </div>

qualtricssurvey/public/view.html

@@ -1,4 +1 @@
-<div class="qualtricssurvey_block">
-    <p>The survey will open in a new browser tab or window.</p>
-    <p><a class="button primary-button qualtrics-button" href="https://{your_university}.qualtrics.com/jfe/form/{survey_id}{user_id_string}" target="_blank">{link_text}</a></p>
-</div>
+<div class="qualtricssurvey_block"><p>{message}</p><p><a class="button primary-button qualtrics-button" href="https://{your_university}.qualtrics.com/jfe/form/{survey_id}{user_id_string}" target="_blank">{link_text}</a></p></div>

qualtricssurvey/qualtricssurvey.py

@@ -49,6 +49,12 @@ class QualtricsSurvey(StudioEditableXBlockMixin, XBlock):
         scope=Scope.settings,
         help=_('This is the text that will link to your survey.'),
     )
+    message = String(
+        display_name=_('Message:'),
+        default=_('The survey will open in a new browser tab or window.'),
+        scope=Scope.settings,
+        help=_('This is the text that will be displayed above the link to your survey.'),
+    )
     param_name = String(
         display_name=_('Param Name:'),
         default=_('a'),
@@ -64,6 +70,7 @@ class QualtricsSurvey(StudioEditableXBlockMixin, XBlock):
         'your_university',
         'link_text',
         'param_name',
+        'message',
     )
 
     # Decorate the view in order to support multiple devices e.g. mobile
@@ -80,6 +87,7 @@ def student_view(self, context=None):
         your_university = self.your_university
         link_text = self.link_text
         param_name = self.param_name
+        message = self.message
 
         anon_user_id = self.xmodule_runtime.anonymous_student_id
 
@@ -100,6 +108,7 @@ def student_view(self, context=None):
             your_university=your_university,
             link_text=link_text,
             user_id_string=user_id_string,
+            message=message,
         )
 
         fragment = self.build_fragment(

qualtricssurvey/tests.py

@@ -36,6 +36,8 @@ def test_student_view(self):
         self.assertIn(url_frag, fragment.content)
         url_frag = '>" target="_blank">Begin Survey'
         self.assertIn(url_frag, fragment.content)
+        messageHTML = '<p>' + xblock.message + '</p>'
+        self.assertIn(messageHTML, fragment.content)
 
     def test_student_view_no_param_name(self):
         """
@@ -51,3 +53,16 @@ def test_student_view_no_param_name(self):
             'here." target="_blank">Begin Survey'
         )
         self.assertIn(url, fragment.content)
+
+    def test_student_view_custom_message(self):
+        """
+        Checks the student view with a custom message.
+        """
+
+        message = "test message"
+        xblock = self.make_an_xblock()
+        xblock.message = message
+        fragment = xblock.student_view()
+
+        messageHTML = '<p>' + message + '</p>'
+        self.assertIn(messageHTML, fragment.content)

setup.py

@@ -7,7 +7,7 @@
 
 setuptools.setup(
     name=package_json.get('name', 'xblock-test'),
-    version=package_json.get('version', '0.1.0'),
+    version=package_json.get('version', '0.1.1'),
     description=package_json.get('description'),
     long_description=package_json.get('description'),
     author=package_json.get('author', {}).get('name'),