fill in task stuff

Author: clhuang

README.md

@@ -13,7 +13,7 @@ client = scale.ScaleClient('YOUR_API_KEY_HERE', callback_key='OPTIONAL_CALLBACK_
 
 ### Tasks
 
-Most of these methods will return a `Scale::Resources::Task` object, which will contain information
+Most of these methods will return a `scale.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
@@ -147,6 +147,5 @@ The api initialization accepts the following options:
 | Name | Description | Default |
 | ---- | ----------- | ------- |
 | `endpoint` | Endpoint used in the http requests. | `'https://api.scaleapi.com/v1/'` |
-| `api_key` | API key used in the http requests. | `nil` |
-| `callback_key` | API key used to validate callback POST requests. | `nil` |
+| `api_key` | API key used in the http requests. | required |
 

scale/__init__.py

@@ -2,7 +2,7 @@
 
 from .tasks import Task
 
-DEFAULT_FIELDS = {'callback_url', 'instruction', 'urgency'}
+DEFAULT_FIELDS = {'callback_url', 'instruction', 'urgency', 'metadata'}
 ALLOWED_FIELDS = {'categorization': {'attachment', 'attachment_type', 'categories',
                                      'category_ids', 'allow_multiple'},
                   'transcription': {'attachment', 'attachment_type',
@@ -14,24 +14,28 @@
                   'annotation': {'attachment', 'attachment_type', 'instruction',
                                  'objects_to_annotate', 'with_labels'}}
 
+
 def validate_payload(task_type, kwargs):
     allowed_fields = DEFAULT_FIELDS + ALLOWED_FIELDS[task_type]
     for k in kwargs:
         if k not in allowed_fields:
-            raise ScaleException('Illegal parameter %s for task_type %s'
-                                 % (k, task_type))
+            raise ScaleInvalidRequest('Illegal parameter %s for task_type %s'
+                                      % (k, task_type), None)
+
 
 class ScaleException(Exception):
-    pass
+    def __init__(self, message, errcode):
+        super(ScaleException, self).__init__(message)
+        self.code = errcode
 
-class ScaleInvalidRequest(ScaleException):
+
+class ScaleInvalidRequest(ScaleException, ValueError):
     pass
 
+
 class ScaleClient(object):
-    def __init__(self, api_key, callback_key=None,
-                 endpoint='https://api.scaleapi.com/v1/'):
+    def __init__(self, api_key, endpoint='https://api.scaleapi.com/v1/'):
         self.api_key = api_key
-        self.callback_key = callback_key
         self.endpoint = endpoint
 
     def _getrequest(self, endpoint):
@@ -47,7 +51,7 @@ def _getrequest(self, endpoint):
 
         if r.status_code == 200:
             return r.json()
-        raise ScaleException(r.json()['error'])
+        raise ScaleException(r.json()['error'], r.status_code)
 
     def _postrequest(self, endpoint, payload=None):
         """Makes a post request to an endpoint.
@@ -63,51 +67,50 @@ def _postrequest(self, endpoint, payload=None):
 
         if r.status_code == 200:
             return r.json()
-        if r.status_code == 401:
-            raise ScaleException(r.json()['error'])
         if r.status_code == 400:
-            raise ScaleInvalidRequest(r.json()['error'])
-        raise ScaleException(r.json()['error'])
+            raise ScaleInvalidRequest(r.json()['error'], r.status_code)
+        raise ScaleException(r.json()['error'], r.status_code)
 
     def fetch_task(self, task_id):
         """Fetches a task.
 
         Returns the associated task.
         """
-        return Task(self._getrequest('task/%s' % task_id))
+        return Task(self._getrequest('task/%s' % task_id), self)
 
     def cancel_task(self, task_id):
         """Cancels a task.
 
         Returns the associated task.
+        Raises a ScaleException if it has already been canceled.
         """
-        return Task(self._postrequest('task/%s/cancel' % 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) for json in self._getrequest('tasks')]
+        return [Task(json, self) for json in self._getrequest('tasks')]
 
     def create_categorization_task(self, **kwargs):
         validate_payload('categorization', kwargs)
         taskdata = self._postrequest('task/categorize', payload=kwargs)
-        return Task(taskdata)
+        return Task(taskdata, self)
 
     def create_transcription_task(self, **kwargs):
         validate_payload('transcription', kwargs)
         taskdata = self._postrequest('task/transcription', payload=kwargs)
-        return Task(taskdata)
+        return Task(taskdata, self)
 
     def create_phonecall_task(self, **kwargs):
         validate_payload('phonecall', kwargs)
         taskdata = self._postrequest('task/phonecall', payload=kwargs)
-        return Task(taskdata)
+        return Task(taskdata, self)
 
     def create_comparison_task(self, **kwargs):
         validate_payload('comparison', kwargs)
         taskdata = self._postrequest('task/comparison', payload=kwargs)
-        return Task(taskdata)
+        return Task(taskdata, self)
 
     def create_annotation_task(self, **kwargs):
         validate_payload('annotation', kwargs)
         taskdata = self._postrequest('task/annotation', payload=kwargs)
-        return Task(taskdata)
+        return Task(taskdata, self)

scale/tasks.py

@@ -1,4 +1,15 @@
 class Task(object):
-    def __init__(self, param_dict):
-        # TODO(calvin)
-        pass
+    """Task class, containing task information."""
+    def __init__(self, param_dict, client):
+        self.client = client
+        self.param_dict = param_dict
+        self.id = param_dict['task_id']
+
+    def __getattr__(self, name):
+        if name in self.param_dict:
+            return self.param_dict[name]
+        raise AttributeError("'%s' object has no attribute %s"
+                             % (type(self).__name__, name))
+
+    def cancel(self):
+        self.client.cancel_task(self.id)