Version 2.1.0 - Adds since and data parameters

- Supports since as a Simperium cursor, not a date string
- Keeps track of cursor in `self.current`
- Allows data=False for just getting keys and versions. Defaults to True
  and adds a dummy/empty note data object if using data=False
- Adds in another call to __add_simplenote_api_fields that was missed
  last time
- Add a test to check data=False doesn't blow up
- Fix a million instances of success being spelt wrong

Author: atomicules

Diff for: HISTORY.rst

@@ -1,6 +1,12 @@
 History
 ========
 
+2.1.0 (2018-11-04)
+------------------
+
+* Adds since paramter back in (as Simperium cursor, not date)
+* 
+
 2.0.3 (2018-10-19)
 ------------------
 

Diff for: README.rst

@@ -45,18 +45,22 @@ simplenote.py can be imported into any python module::
 
 The object then provides the following API methods::
 
-    sn.get_note_list(tags=[])       # Supports optional `tags` parameter that takes a list of tags
-                                    # to return only notes that contain at least one of these tags.
-
-    sn.get_note(note_id)            # note id is value of key `key` in note dict as returned
-                                    # by get_note_list. Supports optional version integer as
-                                    # argument to return previous versions
-
-    sn.add_note(note)               # A ``note`` object is a dictionary with at least a
-                                    # ``content`` property, containing the note text.
-
-    sn.update_note(note)            # The ``update_note`` method needs a note object which
-                                    # also has a ``key`` property.
+    sn.get_note_list(data=True, since=cursor, tags=[])  # Supports optional `tags` parameter that takes a list of tags
+                                                        # to return only notes that contain at least one of these tags.
+                                                        # Also supports a `since` parameter, but as per the Simperium
+                                                        # API this is no longer a date, rather a cursor.
+                                                        # Lastly, also supports a  `data` parameter (defaults to True)
+                                                        # to only return keys/ids and versions
+
+    sn.get_note(note_id)                                # note id is value of key `key` in note dict as returned
+                                                        # by get_note_list. Supports optional version integer as
+                                                        # argument to return previous versions
+
+    sn.add_note(note)                                   # A ``note`` object is a dictionary with at least a
+                                                        # ``content`` property, containing the note text.
+
+    sn.update_note(note)                                # The ``update_note`` method needs a note object which
+                                                        # also has a ``key`` property.
     sn.trash_note(note_id)
 
     simplenote.delete_note(note_id)

Diff for: simplenote/__init__.py

@@ -3,5 +3,5 @@
 from .simplenote import Simplenote, SimplenoteLoginFailed
 
 __author__ = "Daniel Schauenberg"
-__version__ = "2.0.3"
+__version__ = "2.1.0"
 __license__ = "MIT"

Diff for: simplenote/simplenote.py

@@ -58,7 +58,7 @@ def __init__(self, username, password):
         self.password = password
         self.header = 'X-Simperium-Token'
         self.token = None
-        self.mark = "mark"
+        self.current = ""
 
     def authenticate(self, user, password):
         """ Method to get simplenote auth token
@@ -115,7 +115,7 @@ def get_note(self, noteid, version=None):
             A tuple `(note, status)`
 
             - note (dict): note object
-            - status (int): 0 on sucesss and -1 otherwise
+            - status (int): 0 on success and -1 otherwise
 
         """
         # request note
@@ -151,7 +151,7 @@ def update_note(self, note):
         Returns:
             A tuple `(note, status)`
             - note (dict): note object
-            - status (int): 0 on sucesss and -1 otherwise
+            - status (int): 0 on success and -1 otherwise
 
         """
         # determine whether to create a new note or update an existing one
@@ -202,7 +202,7 @@ def add_note(self, note):
             A tuple `(note, status)`
 
             - note (dict): the newly created note
-            - status (int): 0 on sucesss and -1 otherwise
+            - status (int): 0 on success and -1 otherwise
 
         """
 
@@ -213,23 +213,30 @@ def add_note(self, note):
         else:
             return "No string or valid note.", -1
 
-    def get_note_list(self, tags=[]):
+    def get_note_list(self, data=True, since=None, tags=[]):
         """ Method to get the note list
 
-        The method can be passed optional arguments to limit the
-        the list to notes containing a certain tag. If omitted a list
-        of all notes is returned.
+        The method can be passed optional arguments to limit the list to
+        notes containing a certain tag, or only updated since a certain
+        Simperium cursor. If omitted a list of all notes is returned.
+
+        By default data objects are returned. If data is set to false only
+        keys/ids and versions are returned. An empty data object is inserted
+        for compatibility.
 
         Arguments:
             - tags=[] list of tags as string: return notes that have
               at least one of these tags
+            - since=cursor Simperium cursor as string: return only changes
+              since this cursor
+            - data=True If false only return keys/ids and versions
 
         Returns:
             A tuple `(notes, status)`
 
             - notes (list): A list of note objects with all properties set except
             `content`.
-            - status (int): 0 on sucesss and -1 otherwise
+            - status (int): 0 on success and -1 otherwise
 
         """
         # initialize data
@@ -239,8 +246,13 @@ def get_note_list(self, tags=[]):
         notes = { "index" : [] }
 
         # get the note index
-        # TODO: Using data=false is actually fine with simplenote.vim - sadly no faster though
-        params = '/index?limit=%s&data=true' % (str(NOTE_FETCH_LENGTH))
+        params = '/index?limit=%s' % (str(NOTE_FETCH_LENGTH))
+
+        if since is not None:
+            params += '&since=%s' % (since)
+        # Fetching data is the default
+        if data:
+            params += '&data=true'
 
         # perform initial HTTP request
         request = Request(DATA_URL+params)
@@ -251,6 +263,9 @@ def get_note_list(self, tags=[]):
             # re-write for v1 consistency
             note_objects = []
             for n in response_notes["index"]:
+                # If data=False then can't do this bit... or not all of it, just have id and version. Add empty data object.
+                if not data:
+                    n['d'] = {}
                 note_object = self.__add_simplenote_api_fields(n['d'], n['id'], n['v'])
                 note_objects.append(note_object)
             notes["index"].extend(note_objects)
@@ -270,14 +285,16 @@ def get_note_list(self, tags=[]):
                 # re-write for v1 consistency
                 note_objects = []
                 for n in response_notes["index"]:
+                    if not data:
+                        n['d'] = {}
                     note_object = n['d']
-                    note_object['version'] = n['v']
-                    note_object['key'] = n['id']
+                    note_object = self.__add_simplenote_api_fields(n['d'], n['id'], n['v'])
                     note_objects.append(note_object)
                 notes["index"].extend(note_objects)
             except IOError:
                 status = -1
         note_list = notes["index"]
+        self.current = response_notes["current"]
         # Can only filter for tags at end, once all notes have been retrieved.
         if (len(tags) > 0):
             note_list = [n for n in note_list if (len(set(n["tags"]).intersection(tags)) > 0)]
@@ -293,7 +310,7 @@ def trash_note(self, note_id):
             A tuple `(note, status)`
 
             - note (dict): the newly created note or an error message
-            - status (int): 0 on sucesss and -1 otherwise
+            - status (int): 0 on success and -1 otherwise
 
         """
         # get note
@@ -321,7 +338,7 @@ def delete_note(self, note_id):
             A tuple `(note, status)`
 
             - note (dict): an empty dict or an error message
-            - status (int): 0 on sucesss and -1 otherwise
+            - status (int): 0 on success and -1 otherwise
 
         """
         # notes have to be trashed before deletion
@@ -344,9 +361,13 @@ def __add_simplenote_api_fields(self, note, noteid, version):
         # Compatibility with original Simplenote API v2.1.5
         note[u'key'] = noteid
         note[u'version'] = version
-        note[u'modifydate'] = note["modificationDate"]
-        note[u'createdate'] = note["creationDate"]
-        note[u'systemtags'] = note["systemTags"]
+        try:
+            note[u'modifydate'] = note["modificationDate"]
+            note[u'createdate'] = note["creationDate"]
+            note[u'systemtags'] = note["systemTags"]
+        except KeyError:
+            # For when data=False
+            pass
         return note
 
     def __remove_simplenote_api_fields(self, note):

Diff for: tests/test_simplenote.py

@@ -73,6 +73,17 @@ def test_simplenote_get_list_with_tags(self):
         else:
             self.assertEqual(0, len(res))
 
+    # TODO: I can't think of a good way to test this yet since test period is
+    # relatively quick
+    # def test_simplenote_get_list_with_since(self)
+
+    def test_simplenote_get_list_without_data(self):
+        res, status = self.simplenote_instance.get_note_list(data=False)
+        if status == 0:
+            self.assertEqual(self.initial_note_count, len(res))
+        else:
+            self.assertEqual(0, len(res))
+
     def test_simplenote_first_note(self):
         if self.first_note != False:
             note, status = self.simplenote_instance.get_note(self.first_note)