get request params, testing

Author: clhuang

scaleapi/__init__.py

@@ -38,7 +38,7 @@ def __init__(self, api_key, endpoint='https://api.scaleapi.com/v1/'):
         self.api_key = api_key
         self.endpoint = endpoint
 
-    def _getrequest(self, endpoint):
+    def _getrequest(self, endpoint, params={}):
         """Makes a get request to an endpoint.
 
         If an error occurs, assumes that endpoint returns JSON as:
@@ -47,7 +47,7 @@ def _getrequest(self, endpoint):
         """
         r = requests.get(self.endpoint + endpoint,
                          headers={"Content-Type": "application/json"},
-                         auth=(self.api_key, ''))
+                         auth=(self.api_key, ''), params=params)
 
         if r.status_code == 200:
             return r.json()
@@ -102,7 +102,7 @@ def tasks(self, **kwargs):
                 raise ScaleInvalidRequest('Illegal parameter %s for ScaleClient.tasks()'
                                           % key, None)
         return [Task(json, self) for json in
-                self._getrequest('tasks', payload=kwargs)['docs']]
+                self._getrequest('tasks', params=kwargs)['docs']]
 
     def create_categorization_task(self, **kwargs):
         validate_payload('categorization', kwargs)

scaleapi/tasks.py

@@ -8,9 +8,14 @@ def __init__(self, param_dict, client):
     def __getattr__(self, name):
         if name in self.param_dict:
             return self.param_dict[name]
+        if name in self.params:
+            return self.params[name]
         raise AttributeError("'%s' object has no attribute %s"
                              % (type(self).__name__, name))
 
+    def __hash__(self):
+        return hash(self.id)
+
     def __str__(self):
         return 'Task(id=%s)' % self.id
 

tests/test_client.py

@@ -116,3 +116,52 @@ def test_cancel():
     # 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)
+
+    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.metadata == task.metadata
+    assert task2.type == task.type
+    assert task2.created_at == task.created_at
+
+
+def test_task_retrieval_fail():
+    with pytest.raises(scaleapi.ScaleException):
+        client.fetch_task('fake_id_qwertyuiop')
+
+
+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))
+    task_ids = {task.id for task in tasks}
+    for task in client.tasks(limit=3):
+        assert task.id in task_ids
+
+
+def test_tasks_invalid():
+    with pytest.raises(scaleapi.ScaleException):
+        client.tasks(bogus=0)