Version 1.0.24: wait_for_completion raises an exception on errors

* wait_for_completion was just checking for completion
  now if the job goes in ERROR this raises an exception
  so we don't wait forever
* add support for the job cancellation endpoint (while a job is in the
  ENQUEUED state)

Author: Dario Varotto

ravenpackapi/core.py

@@ -14,7 +14,7 @@
 from ravenpackapi.utils.constants import JSON_AVAILABLE_FIELDS, ENTITY_TYPES
 
 _VALID_METHODS = ('get', 'post', 'put', 'delete')
-VERSION = '1.0.23'
+VERSION = '1.0.24'
 
 logger = logging.getLogger("ravenpack.core")
 

ravenpackapi/exceptions.py

@@ -18,6 +18,13 @@ class DataFileTimeout(Exception):
     pass
 
 
+class JobNotProcessing(Exception):
+    def __init__(self, *args, **kwargs):
+        status = kwargs.pop('status', None)
+        super(JobNotProcessing, self).__init__(*args)
+        self.status = status
+
+
 def api_method(func):
     @wraps(func)
     def decorated_func(instance, *args, **kwargs):

ravenpackapi/models/job.py

@@ -1,11 +1,13 @@
-import csv
 import datetime
 import logging
 from time import sleep
 
 import requests
 
-from ravenpackapi.exceptions import api_method, APIException, DataFileTimeout
+from ravenpackapi.exceptions import (api_method,
+                                     APIException,
+                                     DataFileTimeout,
+                                     JobNotProcessing)
 from ravenpackapi.util import to_curl, parse_csv_line
 
 logger = logging.getLogger(__name__)
@@ -55,7 +57,20 @@ def get_status(self):
                 "token": token,
             },
         )
-        self._data.update(response.json())
+        json = response.json()
+        self._data.update(json)
+        return json.get('status')
+
+    @api_method
+    def cancel(self):
+        token = self.token
+        response = self.api.request(
+            endpoint="/jobs/%s" % token,
+            method='delete'
+        )
+        response.json()
+        self._data.update({"status": 'cancelled'})
+        return self.status
 
     @api_method
     def wait_for_completion(self, timeout_seconds=None):
@@ -70,6 +85,9 @@ def wait_for_completion(self, timeout_seconds=None):
         while True:
             if self.is_ready:
                 break
+            if not self.is_processing:
+                raise JobNotProcessing("The job went in an error state: %s" % self.status,
+                                       status=self.status)
             sleep(self._FILE_AVAILABILIY_SECONDS_DELAY)
             try:
                 self.get_status()

ravenpackapi/tests/test_encoding.py

@@ -3,6 +3,7 @@
 
 class TestEncoding(object):
     api = RPApi()
+    ds = None
 
     @classmethod
     def setup_class(cls):

ravenpackapi/tests/test_job_cancellation.py

@@ -0,0 +1,52 @@
+import logging
+
+import pytest
+
+from ravenpackapi import RPApi, Dataset
+from ravenpackapi.exceptions import JobNotProcessing, APIException
+
+logger = logging.getLogger(__name__)
+
+
+class TestJobCancellation(object):
+    api = RPApi()
+    ds = None
+
+    @classmethod
+    def setup_class(cls):
+        cls.ds = cls.api.create_dataset(
+            Dataset(
+                name='test_job_cancel',
+                filters={
+                    "rp_entity_id": 'D8442A'
+                },
+            )
+        )
+
+    def test_job_cancel(self):
+        params = dict(
+            start_date='2018-05-10 21:51',  # we have an event here
+            end_date='2018-05-10 21:52',
+        )
+        job = self.ds.request_datafile(
+            **params
+        )
+        status = job.get_status()
+
+        try:
+            job.cancel()
+        except APIException as exception:
+            # cancel raised an exception, means that we were already processing it
+            assert status == 'processing'
+            assert exception.response.status_code == 400
+        else:
+            assert status == 'enqueued'
+            assert job.get_status() == 'cancelled'
+
+            assert job.is_processing is False
+            with pytest.raises(JobNotProcessing):
+                job.wait_for_completion()
+
+    @classmethod
+    def teardown_class(cls):
+        cls.ds.delete()

setup.py

@@ -1,6 +1,6 @@
 from setuptools import setup, find_packages
 
-VERSION = '1.0.23'
+VERSION = '1.0.24'
 
 with open('README.rst') as readme_file:
     readme = readme_file.read()