Fix error types, rename InvalidUsage -> BadRequest

Author: vshlapakov

scrapinghub/__init__.py

@@ -1,6 +1,6 @@
 __all__ = ["APIError", "Connection", "HubstorageClient",
            "ScrapinghubClient", "ScrapinghubAPIError",
-           "DuplicateJobError", "InvalidUsage", "NotFound",
+           "DuplicateJobError", "BadRequest", "NotFound",
            "Unauthorized", "ValueTooLarge"]
 
 import pkgutil
@@ -15,7 +15,7 @@
 from .client.exceptions import (
     ScrapinghubAPIError,
     DuplicateJobError,
-    InvalidUsage,
+    BadRequest,
     NotFound,
     Unauthorized,
     ValueTooLarge,

scrapinghub/client/exceptions.py

@@ -32,7 +32,7 @@ def __init__(self, message=None, http_error=None):
         super(ScrapinghubAPIError, self).__init__(message)
 
 
-class InvalidUsage(ScrapinghubAPIError):
+class BadRequest(ScrapinghubAPIError):
     pass
 
 
@@ -60,7 +60,7 @@ def wrapped(*args, **kwargs):
         except HTTPError as exc:
             status_code = exc.response.status_code
             if status_code == 400:
-                raise InvalidUsage(http_error=exc)
+                raise BadRequest(http_error=exc)
             elif status_code == 401:
                 raise Unauthorized(http_error=exc)
             elif status_code == 404:
@@ -76,8 +76,8 @@ def wrapped(*args, **kwargs):
                 raise NotFound(msg)
             elif exc._type == APIError.ERR_VALUE_ERROR:
                 raise ValueError(msg)
-            elif exc._type == APIError.ERR_INVALID_USAGE:
-                raise InvalidUsage(msg)
+            elif exc._type == APIError.ERR_BAD_REQUEST:
+                raise BadRequest(msg)
             elif exc._type == APIError.ERR_AUTH_ERROR:
                 raise Unauthorized(http_error=exc)
             raise ScrapinghubAPIError(msg)

scrapinghub/client/jobs.py

@@ -11,7 +11,7 @@
 from .logs import Logs
 from .requests import Requests
 from .samples import Samples
-from .exceptions import NotFound, InvalidUsage, DuplicateJobError
+from .exceptions import NotFound, BadRequest, DuplicateJobError
 from .utils import _MappingProxy, get_tags_for_update, parse_job_key
 
 
@@ -149,7 +149,7 @@ def schedule(self, spidername=None, **params):
         try:
             response = self._client._connection._post(
                 'schedule', 'json', params)
-        except InvalidUsage as exc:
+        except BadRequest as exc:
             if 'already scheduled' in str(exc):
                 raise DuplicateJobError(exc)
             raise

scrapinghub/client/projects.py

@@ -8,7 +8,6 @@
 
 from .activity import Activity
 from .collections import Collections
-from .exceptions import InvalidUsage
 from .frontiers import _HSFrontier, Frontiers
 from .jobs import Jobs
 from .spiders import Spiders
@@ -172,5 +171,5 @@ class Settings(_MappingProxy):
     def set(self, key, value):
         # FIXME drop the method when post-by-key is implemented on server side
         if not isinstance(key, six.string_types):
-            raise InvalidUsage("key should be a string")
+            raise TypeError("key should be a string")
         self.update({key: value})

scrapinghub/client/utils.py

@@ -12,7 +12,7 @@
 from ..hubstorage.resourcetype import ItemsResourceType
 from ..hubstorage.collectionsrt import Collections
 
-from .exceptions import wrap_value_too_large, InvalidUsage
+from .exceptions import wrap_value_too_large
 
 
 class LogLevel(object):
@@ -135,7 +135,7 @@ def set(self, key, value):
 
     def update(self, values):
         if not isinstance(values, dict):
-            raise InvalidUsage("values should be a dict")
+            raise TypeError("values should be a dict")
         data = next(self._origin.apiget())
         data.update(values)
         self._origin.apipost(jl={k: v for k, v in six.iteritems(data)

scrapinghub/legacy.py

@@ -152,7 +152,7 @@ def _decode_response(self, response, format, raw):
                                    _type=APIError.ERR_AUTH_ERROR)
                 elif data['status'] in ('error', 'badrequest'):
                     raise APIError(data['message'],
-                                   _type=APIError.ERR_INVALID_USAGE)
+                                   _type=APIError.ERR_BAD_REQUEST)
                 else:
                     raise APIError("Unknown response status: {0[status]}".format(data))
             except KeyError:
@@ -405,7 +405,7 @@ class APIError(Exception):
     ERR_DEFAULT = 0
     ERR_NOT_FOUND = 1
     ERR_VALUE_ERROR = 2
-    ERR_INVALID_USAGE = 3
+    ERR_BAD_REQUEST = 3
     ERR_AUTH_ERROR = 4
 
     def __init__(self, message, _type=None):

tests/client/test_collections.py

@@ -3,7 +3,7 @@
 import pytest
 from six.moves import range
 
-from scrapinghub.client.exceptions import InvalidUsage
+from scrapinghub.client.exceptions import BadRequest
 from scrapinghub.client.exceptions import NotFound
 from scrapinghub.client.exceptions import ValueTooLarge
 
@@ -115,7 +115,7 @@ def test_errors_bad_key(collection):
         {'_key': []},
 ])
 def test_errors(collection, testarg):
-    with pytest.raises(InvalidUsage):
+    with pytest.raises(BadRequest):
         collection.set(testarg)
 
 

tests/client/test_spiders.py

@@ -6,7 +6,7 @@
 from six.moves import range
 
 from scrapinghub.client.exceptions import DuplicateJobError
-from scrapinghub.client.exceptions import InvalidUsage
+from scrapinghub.client.exceptions import BadRequest
 from scrapinghub.client.exceptions import NotFound
 from scrapinghub.client.jobs import Jobs, Job
 from scrapinghub.client.spiders import Spider
@@ -42,7 +42,7 @@ def test_spider_base(project, spider):
 
 def test_spider_list_update_tags(project, spider):
     # FIXME empty update should fail
-    with pytest.raises(InvalidUsage):
+    with pytest.raises(BadRequest):
         spider.update_tags()
 
     spider.update_tags(add=['new1', 'new2'])