some stuff

Author: clhuang

scale/__init__.py

@@ -1,8 +1,31 @@
 import requests
 
-from . import tasks
+from .tasks import Task
 
 DEFAULT_FIELDS = {'callback_url', 'instruction', 'urgency'}
+ALLOWED_FIELDS = {'categorization': {'attachment', 'attachment_type', 'categories',
+                                     'category_ids', 'allow_multiple'},
+                  'transcription': {'attachment', 'attachment_type',
+                                    'fields', 'row_fields'},
+                  'phonecall': {'attachment', 'attachment_type', 'phone_number',
+                                'script', 'entity_name', 'fields', 'choices'},
+                  'comparison': {'attachments', 'attachment_type',
+                                 'fields', 'choices'},
+                  '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))
+
+class ScaleException(Exception):
+    pass
+
+class ScaleInvalidRequest(ScaleException):
+    pass
 
 class ScaleClient(object):
     def __init__(self, api_key, callback_key=None,
@@ -11,26 +34,80 @@ def __init__(self, api_key, callback_key=None,
         self.callback_key = callback_key
         self.endpoint = endpoint
 
-    def create_comparison_task(**kwargs):
-        payload = generic_payload(kwargs)
-        allowed_fields = DEFAULT_FIELDS + \
-            {'attachment', 'attachment_type', 'categories', 'category_ids', 'allow_multiple'}
-            if field in kwargs:
-                payload[field] = kwargs[field]
-        payload = {
-            'callback_url': callback_url,
-            'instruction': instruction,
-        }
-        return self._dotask(tasks.ComparisonTask(*args, **kwargs))
-
-    def create_transcription_task(*args, **kwargs):
-        return self._dotask(tasks.TranscriptionTask(*args, **kwargs))
-
-    def create_phonecall_task(*args, **kwargs):
-        return self._dotask(tasks.PhonecallTask(*args, **kwargs))
-
-    def create_comparison_task(*args, **kwargs):
-        return self._dotask(tasks.TranscriptionTask(*args, **kwargs))
-
-    def create_annotation_task(*args, **kwargs):
-        return self._dotask(tasks.AnnotationTask(*args, **kwargs))
+    def _getrequest(self, endpoint):
+        """Makes a get request to an endpoint.
+
+        If an error occurs, assumes that endpoint returns JSON as:
+            { 'status_code': XXX,
+              'error': 'I failed' }
+        """
+        r = requests.get(self.endpoint + endpoint,
+                         headers={"Content-Type": "application/json"},
+                         auth=(self.api_key, ''))
+
+        if r.status_code == 200:
+            return r.json()
+        raise ScaleException(r.json()['error'])
+
+    def _postrequest(self, endpoint, payload=None):
+        """Makes a post request to an endpoint.
+
+        If an error occurs, assumes that endpoint returns JSON as:
+            { 'status_code': XXX,
+              'error': 'I failed' }
+        """
+        payload = payload or {}
+        r = requests.post(self.endpoint + endpoint, json=payload,
+                          headers={"Content-Type": "application/json"},
+                          auth=(self.api_key, ''))
+
+        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'])
+
+    def fetch_task(self, task_id):
+        """Fetches a task.
+
+        Returns the associated task.
+        """
+        return Task(self._getrequest('task/%s' % task_id))
+
+    def cancel_task(self, task_id):
+        """Cancels a task.
+
+        Returns the associated task.
+        """
+        return Task(self._postrequest('task/%s/cancel' % task_id))
+
+    def tasks(self):
+        """Returns a list of all your tasks."""
+        return [Task(json) 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)
+
+    def create_transcription_task(self, **kwargs):
+        validate_payload('transcription', kwargs)
+        taskdata = self._postrequest('task/transcription', payload=kwargs)
+        return Task(taskdata)
+
+    def create_phonecall_task(self, **kwargs):
+        validate_payload('phonecall', kwargs)
+        taskdata = self._postrequest('task/phonecall', payload=kwargs)
+        return Task(taskdata)
+
+    def create_comparison_task(self, **kwargs):
+        validate_payload('comparison', kwargs)
+        taskdata = self._postrequest('task/comparison', payload=kwargs)
+        return Task(taskdata)
+
+    def create_annotation_task(self, **kwargs):
+        validate_payload('annotation', kwargs)
+        taskdata = self._postrequest('task/annotation', payload=kwargs)
+        return Task(taskdata)

scale/tasks.py

@@ -0,0 +1,4 @@
+class Task(object):
+    def __init__(self, param_dict):
+        # TODO(calvin)
+        pass

setup.py

@@ -1,13 +1,14 @@
 from distutils.core import setup
 setup(
-  name = 'scaleapi',
-  packages = ['scaleapi'],
-  version = '0.1',
-  description = 'A client library for interacting with the Scale API',
-  author = 'Calvin Huang',
-  author_email = 'c@lvin.me',
-  url = 'https://github.com/scaleapi/scale-api-python-client',
-  download_url = 'https://github.com/scaleapi/scale-api-python-client/tarball/0.1',
-  keywords = ['scale', 'scaleapi'],
-  classifiers = [],
+    name = 'scaleapi',
+    packages = ['scaleapi'],
+    version = '0.1',
+    description = 'A client library for interacting with the Scale API',
+    author = 'Calvin Huang',
+    author_email = 'c@lvin.me',
+    url = 'https://github.com/scaleapi/scale-api-python-client',
+    download_url = 'https://github.com/scaleapi/scale-api-python-client/tarball/0.1',
+    keywords = ['scale', 'scaleapi'],
+    install_requires = ['requests', 'enum34'],
+    classifiers = [],
 )