Add tests.

notesapi/v1/models.py

+import json
 from django.db import models
+from django.core.exceptions import ValidationError
 
 
 class Note(models.Model):
@@ -17,24 +19,32 @@ class Note(models.Model):
 
     def clean(self, json_body):
         """
-        Cleans the note object or raises a ValidationError.
+        Clean the note object or raises a ValidationError.
         """
         if json_body is None:
             raise ValidationError('Note must have a body.')
 
-        self.text = strip_tags(body.get('text', ''))
-        self.quote = strip_tags(body.get('quote', ''))
+        try:
+            body = json.loads(json_body)
+        except (ValueError, TypeError) as error:
+            raise ValidationError('Note must have a valid json.')
+
+        if not type(body) is dict:
+            raise ValidationError('Note body must be a dictionary.')
+
+        self.text = body.get('text', '')
+        self.quote = body.get('quote', '')
 
         try:
             self.course_id = body['course_id']
             self.usage_id = body['usage_id']
-            self.user_id = body['user_id']
+            self.user_id = body['user']
         except KeyError as error:
             raise ValidationError('Note must have a course_id and usage_id and user_id.')
 
-        body = json.loads(json_body)
-        if not type(body) is dict:
-            raise ValidationError('Note body must be a dictionary.')
+        ranges = body.get('ranges')
+        if ranges is None or len(ranges) != 1:
+            raise ValidationError('Note must contain exactly one range.')
 
         self.range_start = ranges[0]['start']
         self.range_start_offset = ranges[0]['startOffset']
@@ -47,7 +57,7 @@ class Note(models.Model):
         """
         return {
             'id': self.pk,
-            'user': self.user,
+            'user': self.user_id,
             'course_id': self.course_id,
             'usage_id': self.usage_id,
             'text': self.text,
@@ -58,6 +68,6 @@ class Note(models.Model):
                 'end': self.range_end,
                 'endOffset': self.range_end_offset
             }],
-            'created': str(self.created),
-            'updated': str(self.updated)
+            'created': self.created,
+            'updated': self.updated
         }

notesapi/v1/tests/test_models.py

+import json
+from unittest import TestCase
+from notesapi.v1.models import Note
+from django.core.exceptions import ValidationError
+
+class NoteTest(TestCase):
+    def setUp(self):
+        self.course_id = "test_course_id"
+        self.user_id = "test_user_id"
+        #self.usage = BlockUsageLocator.from_string("i4x://org/course/category/name")
+        self.usage = "test_usage_id"
+
+        self.note = {
+            "user": u"test_user_id",
+            "usage_id": u"test-usage-id",
+            "course_id": u"test-course-id",
+            "text": u"test note text",
+            "quote": u"test note quote",
+            "ranges": [
+                {
+                    "start": u"/p[1]",
+                    "end": u"/p[1]",
+                    "startOffset": 0,
+                    "endOffset": 10,
+                }
+            ],
+        }
+
+    def test_clean_valid_note(self):
+        note = Note()
+        note.clean(json.dumps(self.note))
+
+        self.note.update({
+            'id': None,
+            'created': None,
+            'updated': None,
+        })
+        self.assertEqual(note.as_dict(), self.note)
+
+    def test_clean_invalid_note(self):
+        note = Note()
+        for empty_type in (None, '', 0, []):
+            with self.assertRaises(ValidationError):
+                note.clean(empty_type)
+
+    def test_must_have_fields(self):
+        note = Note()
+        for field in ['user', 'usage_id', 'course_id']:
+            payload = self.note.copy()
+            payload.pop(field)
+
+            with self.assertRaises(ValidationError):
+                note.clean(json.dumps(payload))
+
+    def test_clean_many_ranges(self):
+        note = Note()
+
+        with self.assertRaises(ValidationError):
+            note.clean(json.dumps({
+                'text': 'foo',
+                'quote': 'bar',
+                'ranges': [{} for i in range(10)]  # too many ranges
+            }))
+
+    def test_save(self):
+        note = Note()
+        note.clean(json.dumps(self.note))
+        note.save()