Merge pull request #6 from cloudblue/cumulative_fixes

Cumulative fixes

Author: marcserrat

cnct/__init__.py

@@ -3,7 +3,7 @@
 # This file is part of the Ingram Micro Cloud Blue Connect connect-fluent-client.
 # Copyright (c) 2019-2020 Ingram Micro. All Rights Reserved.
 
-from cnct.client.exceptions import APIError, HttpError, NotFoundError  # noqa
+from cnct.client.exceptions import ClientError, NotFoundError  # noqa
 from cnct.client.fluent import ConnectClient  # noqa
 from cnct.client.version import get_version  # noqa
 from cnct.rql import R  # noqa

cnct/client/exceptions.py

@@ -1,23 +1,30 @@
-from requests.exceptions import HTTPError as RequestHttpError
+from http import HTTPStatus
 
 
 class NotFoundError(AttributeError):
     pass
 
 
-class APIError(Exception):
-    def __init__(self, status_code, error_code, errors):
+class ClientError(Exception):
+    def __init__(self, message=None, status_code=None, error_code=None, errors=None):
+        self.message = message
         self.status_code = status_code
         self.error_code = error_code
         self.errors = errors
 
     def __repr__(self):
-        return f'<APIError {self.status_code}: {self.error_code}>'
+        return f'<ClientError {self.status_code}: {self.error_code}>'
 
     def __str__(self):
-        errors = ','.join(self.errors)
-        return f'{self.error_code}: {errors}'
-
-
-class HttpError(RequestHttpError):
-    pass
+        message = self.message or self._get_status_description() or 'Unexpected error'
+        if self.error_code and self.errors:
+            errors = ','.join(self.errors)
+            return f'{message}: {self.error_code} - {errors}'
+        return message
+
+    def _get_status_description(self):
+        if not self.status_code:
+            return
+        status = HTTPStatus(self.status_code)
+        description = status.name.replace('_', ' ').title()
+        return f'{self.status_code} {description}'

cnct/client/fluent.py

@@ -2,9 +2,10 @@
 from keyword import iskeyword
 
 import requests
+from requests.exceptions import RequestException
 
 from cnct.client.constants import CONNECT_ENDPOINT_URL, CONNECT_SPECS_URL
-from cnct.client.exceptions import APIError, HttpError, NotFoundError
+from cnct.client.exceptions import ClientError, NotFoundError
 from cnct.client.models import Collection, NS
 from cnct.client.utils import get_headers
 from cnct.help import DefaultFormatter
@@ -143,28 +144,28 @@ def collection(self, name):
         raise NotFoundError(f'The collection {name} does not exist.')
 
     def get(self, url, **kwargs):
-        return self.execute('get', url, 200, **kwargs)
+        return self.execute('get', url, **kwargs)
 
     def create(self, url, payload=None, **kwargs):
         kwargs = kwargs or {}
 
         if payload:
             kwargs['json'] = payload
 
-        return self.execute('post', url, 201, **kwargs)
+        return self.execute('post', url, **kwargs)
 
     def update(self, url, payload=None, **kwargs):
         kwargs = kwargs or {}
 
         if payload:
             kwargs['json'] = payload
 
-        return self.execute('put', url, 200, **kwargs)
+        return self.execute('put', url, **kwargs)
 
     def delete(self, url, **kwargs):
-        return self.execute('delete', url, 204, **kwargs)
+        return self.execute('delete', url, **kwargs)
 
-    def execute(self, method, url, expected_status, **kwargs):
+    def execute(self, method, url, **kwargs):
         kwargs = kwargs or {}
         if 'headers' in kwargs:
             kwargs['headers'].update(get_headers(self.api_key))
@@ -174,48 +175,36 @@ def execute(self, method, url, expected_status, **kwargs):
         if self.default_headers:
             kwargs['headers'].update(self.default_headers)
 
-        self.response = requests.request(
-            method,
-            url,
-            **kwargs,
-        )
-
-        if self.response.status_code != expected_status:
-            try:
-                error = self.response.json()
-                if 'error_code' in error and 'errors' in error:
-                    raise APIError(
-                        self.response.status_code,
-                        error['error_code'],
-                        error['errors'],
-                    )
-            except JSONDecodeError:
-                pass
-
-            self._raise_exception()
+        self.response = None
 
-        if self.response.status_code == 204:
-            return
+        try:
+            self._execute_http_call(method, url, kwargs)
+            if self.response.status_code == 204:
+                return None
+            if self.response.headers['Content-Type'] == 'application/json':
+                return self.response.json()
+            else:
+                return self.response.content
 
-        return self.response.json()
+        except RequestException as re:
+            api_error = self._get_api_error_details() or {}
+            status_code = self.response.status_code if self.response is not None else None
+            raise ClientError(status_code=status_code, **api_error) from re
 
     def help(self):
         self._help_formatter.print_help(self.specs)
         return self
 
-    def _raise_exception(self):
-        message = ''
-        if isinstance(self.response.reason, bytes):
-            try:
-                reason = self.response.reason.decode('utf-8')
-            except UnicodeDecodeError:
-                reason = self.response.reason.decode('iso-8859-1')
-        else:
-            reason = self.response.reason
+    def _execute_http_call(self, method, url, kwargs):
+        self.response = requests.request(method, url, **kwargs)
+        if self.response.status_code >= 400:
+            self.response.raise_for_status()
 
-        if 400 <= self.response.status_code < 500:
-            message = f'{self.response.status_code} Client Error: {reason}'
-        elif 500 <= self.response.status_code < 600:
-            message = f'{self.response.status_code} Server Error: {reason}'
-
-        raise HttpError(message, response=self.response)
+    def _get_api_error_details(self):
+        if self.response is not None:
+            try:
+                error = self.response.json()
+                if 'error_code' in error and 'errors' in error:
+                    return error
+            except JSONDecodeError:
+                pass

cnct/client/models/resourceset.py

@@ -22,13 +22,17 @@ def __iter__(self):
             try:
                 results, cr = self._execute_request()
             except StopIteration:
-                return
+                pass
 
-            if not (results and cr):
+            if not results:
                 return
 
             for item in results:
                 yield self.get_item(item)
+
+            if not cr:
+                # endpoint doesn't support pagination
+                return
             self._config['params']['offset'] += self._config['params']['limit']
 
     def _execute_request(self):

docs/reference.rst

@@ -53,10 +53,7 @@ RQL utility
 Exceptions
 ----------
 
-.. autoclass:: cnct.client.exceptions.APIError
-   :members:
-
-.. autoclass:: cnct.client.exceptions.HttpError
+.. autoclass:: cnct.client.exceptions.ClientError
    :members:
 
 .. autoclass:: cnct.client.exceptions.NotFoundError

poetry.lock

@@ -13,12 +13,12 @@ python = "^3.6"
 connect-markdown-renderer = "^1.0.0"
 PyYAML = "^5.3.1"
 requests = "^2.24.0"
+responses = "^0.12.0"
 
 [tool.poetry.dev-dependencies]
 pytest = "^6.1.2"
 pytest-cov = "^2.10.1"
 pytest-mock = "^3.3.1"
-requests-mock = "^1.8.0"
 coverage = {extras = ["toml"], version = "^5.3"}
 flakehell = "^0.7.0"
 Sphinx = "^3.2.1"

pyproject.toml

@@ -1,8 +1,8 @@
-from cnct.client.exceptions import APIError
+from cnct.client.exceptions import ClientError
 
 
 def test_connect_error():
-    c = APIError(400, 'error_code', ['msg1', 'msg2'])
+    c = ClientError(status_code=400, error_code='error_code', errors=['msg1', 'msg2'])
 
-    assert repr(c) == '<APIError 400: error_code>'
-    assert str(c) == 'error_code: msg1,msg2'
+    assert repr(c) == '<ClientError 400: error_code>'
+    assert str(c) == '400 Bad Request: error_code - msg1,msg2'