Use create.

notesapi/v1/models.py

@@ -18,36 +18,30 @@ class Note(models.Model):
     usage_id = models.CharField(max_length=255, help_text="ID of XBlock where the text comes from")
     quote = models.TextField(default="")
     text = models.TextField(default="", help_text="Student's thoughts on the quote")
-    ranges = models.TextField(default="", help_text="JSON, describes position of quote in the source text")
+    ranges = models.TextField(help_text="JSON, describes position of quote in the source text")
     created = models.DateTimeField(auto_now_add=True)
     updated = models.DateTimeField(auto_now=True)
 
-    def clean(self, note):
+    @classmethod
+    def create(cls, note_dict):
         """
-        Clean the note object or raises a ValidationError.
+        Create the note object.
         """
-        if not isinstance(note, dict):
+        if not isinstance(note_dict, dict):
             raise ValidationError('Note must be a dictionary.')
 
-        if len(note) == 0:
+        if len(note_dict) == 0:
             raise ValidationError('Note must have a body.')
 
-        self.text = note.get('text', '')
-        self.quote = note.get('quote', '')
-
-        try:
-            self.course_id = note['course_id']
-            self.usage_id = note['usage_id']
-            if not self.user_id:
-                self.user_id = note['user']
-        except KeyError as error:
-            raise ValidationError('Note must have a course_id and usage_id and user_id.')
+        ranges = note_dict.get('ranges', list())
 
-        ranges = note.get('ranges')
-        if not ranges:
+        if len(ranges) < 1:
             raise ValidationError('Note must contain at least one range.')
 
-        self.ranges = json.dumps(ranges)
+        note_dict['ranges'] = json.dumps(ranges)
+        note_dict['user_id'] = note_dict.pop('user', None)
+
+        return cls(**note_dict)
 
     def as_dict(self):
         """

notesapi/v1/tests/test_models.py

@@ -6,7 +6,7 @@ from django.core.exceptions import ValidationError
 class NoteTest(TestCase):
     def setUp(self):
 
-        self.note = {
+        self.note_dict = {
             "user": u"test_user_id",
             "usage_id": u"i4x://org/course/html/52aa9816425a4ce98a07625b8cb70811",
             "course_id": u"org/course/run",
@@ -22,40 +22,34 @@ class NoteTest(TestCase):
             ],
         }
 
-    def test_clean_valid_note(self):
-        note = Note()
-        note.clean(self.note)
+    def test_create_valid_note(self):
+        note = Note.create(self.note_dict.copy())
+        note.save()
 
-        self.note.update({
-            'id': None,
-            'created': None,
-            'updated': None,
-        })
-        self.assertEqual(note.as_dict(), self.note)
+        result_note = note.as_dict()
+        del result_note['id']
+        del result_note['created']
+        del result_note['updated']
 
-    def test_clean_invalid_note(self):
+        self.assertEqual(result_note, self.note_dict)
+
+    def test_create_invalid_note(self):
         note = Note()
-        for empty_type in (None, '', 0, []):
+        for empty_type in (None, '', []):
             with self.assertRaises(ValidationError):
-                note.clean(empty_type)
+                note.create(empty_type)
 
-    def test_must_have_fields(self):
-        note = Note()
+    def test_must_have_fields_create(self):
         for field in ['user', 'usage_id', 'course_id', 'ranges']:
-            payload = self.note.copy()
+            payload = self.note_dict.copy()
             payload.pop(field)
 
             with self.assertRaises(ValidationError):
-                note.clean(payload)
-
-    def test_save(self):
-        note = Note()
-        note.clean(self.note)
-        note.save()
+                note = Note.create(payload)
+                note.full_clean()
 
     def test_extract_document(self):
-        note = Note()
-        note.clean(self.note)
+        note = Note.create(self.note_dict.copy())
         note.save()
         self.assertEqual(NoteMappingType.extract_document(note.id), note.as_dict())
 

notesapi/v1/tests/test_views.py

@@ -166,7 +166,7 @@ class AnnotationViewTests(BaseAnnotationViewTests):
         """
         Test if annotation 'created' field is not used by API.
         """
-        self.payload['created'] = 'abc'
+        self.payload['created'] = '2015-01-05T11:46:58.837059+00:00'
         response = self.client.post(reverse('api:v1:annotations'), self.payload, format='json')
         self.assertEqual(response.status_code, status.HTTP_201_CREATED)
 
@@ -177,7 +177,7 @@ class AnnotationViewTests(BaseAnnotationViewTests):
         """
         Test if annotation 'updated' field is not used by API.
         """
-        self.payload['updated'] = 'abc'
+        self.payload['updated'] = '2015-01-05T11:46:58.837059+00:00'
         response = self.client.post(reverse('api:v1:annotations'), self.payload, format='json')
         self.assertEqual(response.status_code, status.HTTP_201_CREATED)
 
@@ -458,7 +458,7 @@ class AnnotationViewTests(BaseAnnotationViewTests):
         """
         for i in xrange(5):
             kwargs = {'text': 'Foo_{}'.format(i)}
-            self._create_annotation(refresh=False, **kwargs)
+            self._create_annotation(**kwargs)
 
         url = reverse('api:v1:annotations')
         response = self.client.get(url, self.headers)

notesapi/v1/views.py

@@ -72,12 +72,11 @@ class AnnotationListView(APIView):
         if 'id' in self.request.DATA:
             return Response(status=status.HTTP_400_BAD_REQUEST)
 
-        note = Note()
-
         try:
-            note.clean(self.request.DATA)
+            note = Note.create(self.request.DATA)
+            note.full_clean()
         except ValidationError as error:
-            log.debug(error)
+            log.debug(error, exc_info=True)
             return Response(status=status.HTTP_400_BAD_REQUEST)
 
         note.save()
@@ -118,9 +117,10 @@ class AnnotationDetailView(APIView):
             return Response('Annotation not found! No update performed.', status=status.HTTP_404_NOT_FOUND)
 
         try:
-            note.clean(self.request.DATA)
-        except ValidationError as e:
-            log.debug(e)
+            note.text = self.request.data['text']
+            note.full_clean()
+        except KeyError as error:
+            log.debug(error, exc_info=True)
             return Response(status=status.HTTP_400_BAD_REQUEST)
 
         note.save()