tests

Author: clhuang

scaleapi/__init__.py

@@ -86,9 +86,23 @@ def cancel_task(self, task_id):
         """
         return Task(self._postrequest('task/%s/cancel' % task_id), self)
 
-    def tasks(self):
-        """Returns a list of all your tasks."""
-        return [Task(json, self) for json in self._getrequest('tasks')['docs']]
+    def tasks(self, **kwargs):
+        """Returns a list of your tasks.
+        Returns up to 100 at a time, to get more use the offset param.
+
+        start/end_time are ISO8601 dates, the time range of tasks to fetch.
+        status can be 'completed', 'pending', or 'canceled'.
+        type is the task type.
+        limit is the max number of results to display per page,
+        offset is the number of results to skip (for showing more pages).
+        """
+        allowed_kwargs = {'start_time', 'end_time', 'status', 'type', 'limit', 'offset'}
+        for key in kwargs:
+            if key not in allowed_kwargs:
+                raise ScaleInvalidRequest('Illegal parameter %s for ScaleClient.tasks()'
+                                          % key, None)
+        return [Task(json, self) for json in
+                self._getrequest('tasks', payload=kwargs)['docs']]
 
     def create_categorization_task(self, **kwargs):
         validate_payload('categorization', kwargs)

tests/test_client.py

@@ -0,0 +1,118 @@
+import pytest
+import scaleapi
+import os
+
+try:
+    test_api_key = os.environ['SCALE_TEST_API_KEY']
+    client = scaleapi.ScaleClient(test_api_key)
+except KeyError:
+    raise Exception("Please set the environment variable SCALE_TEST_API_KEY to run tests.")
+
+
+def test_categorize_ok():
+    task = client.create_categorization_task(
+        callback_url='http://www.example.com/callback',
+        instruction='Is this company public or private?',
+        attachment_type='website',
+        attachment='http://www.google.com/',
+        categories=['public', 'private'])
+
+
+def test_categorize_fail():
+    with pytest.raises(scaleapi.ScaleInvalidRequest):
+        client.create_categorization_task(
+            callback_url='http://www.example.com/callback',
+            categories=['public', 'private'])
+
+
+def test_transcrption_ok():
+    task = client.create_transcription_task(
+        callback_url='http://www.example.com/callback',
+        instruction='Transcribe the given fields. Then for each news item on the page, transcribe the information for the row.',
+        attachment_type='website',
+        attachment='http://www.google.com/',
+        fields={
+            'title': 'Title of Webpage',
+            'top_result': 'Title of the top result'
+        },
+        row_fields={
+            'username': 'Username of submitter',
+            'comment_count': 'Number of comments'
+        })
+
+
+def test_transcription_fail():
+    with pytest.raises(scaleapi.ScaleInvalidRequest):
+        client.create_transcription_task(
+            callback_url='http://www.example.com/callback',
+            attachment_type='website')
+
+
+def test_phonecall_ok():
+    task = client.create_phonecall_task(
+        callback_url='http://www.example.com/callback',
+        instruction='Call this person and follow the script provided, recording responses',
+        phone_number='5055006865',
+        entity_name='Alexandr Wang',
+        script='Hello ! Are you happy today? (pause) One more thing - what is your email address?',
+        fields={'email': 'Email Address'},
+        choices=['He is happy', 'He is not happy'])
+
+
+def test_phonecall_fail():
+    with pytest.raises(scaleapi.ScaleInvalidRequest):
+        client.create_phonecall_task(
+            callback_url='http://www.example.com/callback',
+            instruction='Call this person and follow the script provided, recording responses')
+
+
+def test_comparison_ok():
+    task = 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_comparison_fail():
+    with pytest.raises(scaleapi.ScaleInvalidRequest):
+        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')
+
+
+def test_annotation_ok():
+    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)
+
+
+def test_annotation_fail():
+    with pytest.raises(scaleapi.ScaleInvalidRequest):
+        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')
+
+
+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)
+
+    # raises a scaleexception, because test tasks complete instantly
+    with pytest.raises(scaleapi.ScaleException):
+        task.cancel()

tox.ini

@@ -0,0 +1,9 @@
+[tox]
+envlist = py27,py35
+[testenv]
+passenv=SCALE_TEST_API_KEY
+deps=
+  requests
+  enum34
+  pytest
+commands=py.test