added additional API helper methods

Author: bsatrom

API.md

@@ -21,8 +21,8 @@
 | `card.time`            | card.time          |
 | `card.usage.get`       | NOT IMPLEMENTED                 |
 | `card.usage.test`      | NOT IMPLEMENTED                 |
-| `card.version`         | NOT IMPLEMENTED                 |
-| `card.voltage`         | NOT IMPLEMENTED                 |
+| `card.version`         | card.version                 |
+| `card.voltage`         | card.voltage                 |
 | `card.wireless`        | card.wireless      |
 
 ## Note Commands
@@ -32,23 +32,23 @@
 | Notecard API           | Python Library API |
 | -----------------------| -------------------|
 | `note.add`             | note.add           |
-| `note.changes`         | NOT IMPLEMENTED                 |
-| `note.delete`          | NOT IMPLEMENTED                 |
+| `note.changes`         | note.changes       |
+| `note.delete`          | note.delete        |
 | `note.get`             | note.get           |
-| `note.update`          | NOT IMPLEMENTED                 |
+| `note.update`          | note.update        |
 
 ## Hub Commands
 
 `from notecard import hub`
 
 | Notecard API           | Python Library API |
 | -----------------------| -------------------|
-| `hub.get`          | hub.get        |
-| `hub.log`          | hub.log        |
-| `hub.set`          | hub.set        |
-| `hub.status`       | hub.status     |
-| `hub.sync`         | hub.sync       |
-| `hub.sync.status`  | hub.syncStatus |
+| `hub.get`              | hub.get            |
+| `hub.log`              | hub.log            |
+| `hub.set`              | hub.set            |
+| `hub.status`           | hub.status         |
+| `hub.sync`             | hub.sync           |
+| `hub.sync.status`      | hub.syncStatus     |
 
 ## DFU Commands
 
@@ -59,22 +59,25 @@
 
 ## Env Commands
 
+`from notecard import env`
+
 | Notecard API           | Python Library API |
 | -----------------------| -------------------|
-| `get`                  | NOT IMPLEMENTED                 |
+| `get`                  | env.get            |
 
 ## File Commands
 
 | Notecard API           | Python Library API |
 | -----------------------| -------------------|
-| `file.changes`         | NOT IMPLEMENTED                 |
-| `file.delete`          | NOT IMPLEMENTED                 |
-| `file.stats`           | NOT IMPLEMENTED                 |
+| `file.changes`         | file.changes       |
+| `file.delete`          | file.delete        |
+| `file.stats`           | file.stats         |
+| `file.changes.pending` | file.pendingChanges|
 
 ## Web Commands
 
 | Notecard API           | Python Library API |
 | -----------------------| -------------------|
-| `web.get`              | NOT IMPLEMENTED                 |
-| `web.post`             | NOT IMPLEMENTED                 |
-| `web.put`              | NOT IMPLEMENTED                 |
+| `web.get`              | NOT IMPLEMENTED    |
+| `web.post`             | NOT IMPLEMENTED    |
+| `web.put`              | NOT IMPLEMENTED    |

notecard/card.py

@@ -39,6 +39,30 @@ def temp(card):
     return card.Transaction(req)
 
 
+def version(card):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "card.version"}
+    return card.Transaction(req)
+
+
+def voltage(card, hours=None, offset=None, vmax=None, vmin=None):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "card.voltage"}
+    if hours:
+        req["hours"] = hours
+    if offset:
+        req["offset"] = offset
+    if vmax:
+        req["vmax"] = vmax
+    if vmin:
+        req["vmin"] = vmin
+    return card.Transaction(req)
+
+
 def wireless(card, mode=None):
     if not isinstance(card, notecard.Notecard):
         raise Exception("Notecard object required")

notecard/env.py

@@ -0,0 +1,11 @@
+import notecard
+
+
+def get(card, name=None):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "env.get"}
+    if name:
+        req["name"] = name
+    return card.Transaction(req)

notecard/file.py

@@ -0,0 +1,41 @@
+import notecard
+
+
+def changes(card, tracker=None, files=None):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "file.changes"}
+    if tracker:
+        req["tracker"] = tracker
+    if files:
+        req["files"] = files
+    return card.Transaction(req)
+
+
+def delete(card, files=None):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "file.delete"}
+    if files:
+        req["files"] = files
+    return card.Transaction(req)
+
+
+def stats(card):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "file.stats"}
+
+    return card.Transaction(req)
+
+
+def pendingChanges(card):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "file.changes.pending"}
+
+    return card.Transaction(req)

notecard/note.py

@@ -1,6 +1,29 @@
 import notecard
 
 
+def changes(card, file=None, tracker=None, max=None,
+            start=None, stop=None, deleted=None, delete=None):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "note.changes"}
+    if file:
+        req["file"] = file
+    if tracker:
+        req["tracker"] = tracker
+    if max:
+        req["max"] = max
+    if start:
+        req["start"] = start
+    if stop:
+        req["stop"] = stop
+    if deleted:
+        req["deleted"] = deleted
+    if delete:
+        req["delete"] = delete
+    return card.Transaction(req)
+
+
 def get(card, file="data.qi", note_id=None, delete=None, deleted=None):
     if not isinstance(card, notecard.Notecard):
         raise Exception("Notecard object required")
@@ -14,3 +37,31 @@ def get(card, file="data.qi", note_id=None, delete=None, deleted=None):
     if deleted:
         req["deleted"] = deleted
     return card.Transaction(req)
+
+
+def delete(card, file=None, note_id=None):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "note.delete"}
+    if file:
+        req["file"] = file
+    if note_id:
+        req["note"] = note_id
+    return card.Transaction(req)
+
+
+def update(card, file=None, note_id=None, body=None, payload=None):
+    if not isinstance(card, notecard.Notecard):
+        raise Exception("Notecard object required")
+
+    req = {"req": "note.get"}
+    if file:
+        req["file"] = file
+    if note_id:
+        req["note"] = note_id
+    if body:
+        req["body"] = body
+    if payload:
+        req["payload"] = payload
+    return card.Transaction(req)