cleanup, update doc, add time range tests

Author: clhuang

README.md

@@ -8,12 +8,12 @@ pip install scaleapi
 ## Usage
 ```python
 import scale
-client = scale.ScaleClient('YOUR_API_KEY_HERE', callback_key='OPTIONAL_CALLBACK_KEY_HERE')
+client = scale.ScaleClient('YOUR_API_KEY_HERE')
 ```
 
 ### Tasks
 
-Most of these methods will return a `scale.Task` object, which will contain information
+Most of these methods will return a `scaleapi.Task` object, which will contain information
 about the json response (task_id, status...).
 
 Any parameter available in the [documentation](https://docs.scaleapi.com) can be passed as an argument
@@ -121,10 +121,15 @@ task = client.cancel_task('asdfasdfasdfasdfasdfasdf')
 
 Check [this](https://docs.scaleapi.com/#list-all-tasks) for further information.
 
-Retrieve a list of all tasks.
+Retrieve a list of tasks, with optional filter by date/type. Paginated with limit/offset.
 
 ```python
-tasks = client.tasks()
+tasks = client.tasks(
+    start_time='2015-10-13T22:38:42Z',
+    end_time='2016-10-13T22:38:42Z',
+    type='categorization',
+    limit=100,
+    offset=200)
 ```
 
 ## Error handling

tests/test_client.py

@@ -1,5 +1,7 @@
 import pytest
 import scaleapi
+import time
+from datetime import datetime
 import os
 
 try:
@@ -9,6 +11,18 @@
     raise Exception("Please set the environment variable SCALE_TEST_API_KEY to run tests.")
 
 
+def make_a_task():
+    return client.create_comparison_task(
+        callback_url='http://www.example.com/callback',
+        instruction='Do the objects in these images have the same pattern?',
+        attachment_type='image',
+        attachments=[
+            'http://i.ebayimg.com/00/$T2eC16dHJGwFFZKjy5ZjBRfNyMC4Ig~~_32.JPG',
+            'http://images.wisegeek.com/checkered-tablecloth.jpg'
+        ],
+        choices=['yes', 'no'])
+
+
 def test_categorize_ok():
     task = client.create_categorization_task(
         callback_url='http://www.example.com/callback',
@@ -105,43 +119,37 @@ def test_annotation_fail():
 
 
 def test_cancel():
-    task = client.create_annotation_task(
-        callback_url='http://www.example.com/callback',
-        instruction='Draw a box around each **baby cow** and **big cow**',
-        attachment_type='image',
-        attachment='http://i.imgur.com/v4cBreD.jpg',
-        objects_to_annotate=['baby cow', 'big cow'],
-        with_labels=True)
-
+    task = make_a_task()
     # raises a scaleexception, because test tasks complete instantly
     with pytest.raises(scaleapi.ScaleException):
         task.cancel()
 
 
 def test_task_retrieval():
-    task = client.create_annotation_task(
-        callback_url='http://www.example.com/callback',
-        instruction='Draw a box around each **baby cow** and **big cow**',
-        attachment_type='image',
-        attachment='http://i.imgur.com/v4cBreD.jpg',
-        objects_to_annotate=['baby cow', 'big cow'],
-        with_labels=True)
-
+    task = make_a_task()
     task2 = client.fetch_task(task.id)
     assert task.status == 'pending'
     assert task2.status == 'completed'
     assert task2.id == task.id
     assert task2.callback_url == task.callback_url
     assert task2.instruction == task.instruction
     assert task2.attachment_type == task.attachment_type
-    assert task2.attachment == task.attachment
-    assert task2.objects_to_annotate == task.objects_to_annotate
-    assert task2.with_labels == task.with_labels
+    assert task2.attachments == task.attachments
+    assert task2.choices == task.choices
     assert task2.metadata == task.metadata
     assert task2.type == task.type
     assert task2.created_at == task.created_at
 
 
+def test_task_retrieval_time():
+    task = make_a_task()
+    start_time = datetime.utcnow().isoformat()
+    time.sleep(1)
+    end_time = datetime.utcnow().isoformat()
+    tasks = client.tasks(start_time=start_time, end_time=end_time)
+    assert tasks == []
+
+
 def test_task_retrieval_fail():
     with pytest.raises(scaleapi.ScaleException):
         client.fetch_task('fake_id_qwertyuiop')
@@ -150,13 +158,7 @@ def test_task_retrieval_fail():
 def test_tasks():
     tasks = []
     for i in range(3):
-        tasks.append(client.create_annotation_task(
-            callback_url='http://www.example.com/callback',
-            instruction='Draw a box around each **baby cow** and **big cow**',
-            attachment_type='image',
-            attachment='http://i.imgur.com/v4cBreD.jpg',
-            objects_to_annotate=['baby cow', 'big cow'],
-            with_labels=True))
+        tasks.append(make_a_task())
     task_ids = {task.id for task in tasks}
     for task in client.tasks(limit=3):
         assert task.id in task_ids