Feature/bunq/sdk python#59 add response id to request error #64

OGKevin · 2017-12-26T15:05:25Z

Closes #59

Tested

…sses. (#59)

OGKevin

No plurals allowed 🙅🏾‍♂️

OGKevin · 2017-12-30T07:26:25Z

bunq/sdk/client.py

@@ -215,7 +224,8 @@ def _assert_response_success(self, response):
        if response.status_code != self._STATUS_CODE_OK:
            raise ExceptionFactory.create_exception_for_response(
                response.status_code,
-                self._fetch_error_messages(response)
+                self._fetch_error_messages(response),


OGKevin · 2017-12-30T07:26:25Z

bunq/sdk/exception_factory.py

-    _GLUE_ERROR_MESSAGES = '\n'
+    _FORMAT_RESPONSE_ID_LINE = 'The response id to help bunq debug: {}'
+    _FORMAT_ERROR_MESSAGE_LINE = 'Error message: {}'
+    _GLUE_ERROR_MESSAGES_NEW_LINE = '\n'


OGKevin · 2017-12-30T07:26:25Z

bunq/sdk/exception_factory.py

+    _FORMAT_RESPONSE_ID_LINE = 'The response id to help bunq debug: {}'
+    _FORMAT_ERROR_MESSAGE_LINE = 'Error message: {}'
+    _GLUE_ERROR_MESSAGES_NEW_LINE = '\n'
+    _GLUE_ERROR_MESSAGES_STRING_EMPTY = ''


OGKevin · 2017-12-30T07:26:25Z

bunq/sdk/exception_factory.py


-        return cls._glue_messages([line_response_code] + messages)
+        return cls._glue_messages(


OGKevin · 2018-01-02T09:26:56Z

@epels all yours please 👀

epels

Few minor comments

epels · 2018-01-02T09:35:19Z

bunq/sdk/client.py

@@ -39,6 +46,8 @@ class ApiClient(object):
    HEADER_GEOLOCATION = 'X-Bunq-Geolocation'
    HEADER_SIGNATURE = 'X-Bunq-Client-Signature'
    HEADER_AUTHENTICATION = 'X-Bunq-Client-Authentication'
+    HEADER_RESPONSE_ID_UPPER_CASED = 'X-Bunq-Client-Response-Id'
+    HEADER_RESPONSE_ID_LOWER_CASED = 'x-bunq-client-response-id'

    # Default header values
    _USER_AGENT_BUNQ = 'bunq-sdk-python/0.12.4'


Don't forget bumping version

This happens during release 🙃

epels · 2018-01-02T09:45:06Z

bunq/sdk/exception_factory.py


    @classmethod
-    def create_exception_for_response(cls, response_code, messages):
+    def create_exception_for_response(


Arg list not formatted according to PEP 8: https://www.python.org/dev/peps/pep-0008/#indentation

correct, this is how we do it. The pep8 one is weird and ugly.

Agreed 😝

epels · 2018-01-02T09:47:54Z

bunq/sdk/exception_factory.py

+            response_code,
+            messages,
+            response_id
+        )

        if response_code == cls._HTTP_RESPONSE_CODE_BAD_REQUEST:


Consider creating a mapping (response_code => exception type) for all these cases

This code has not been modified in this pr, please create a follow up issue for this.

If so, this must also be refactored in the other SDK's

epels · 2018-01-02T09:49:01Z

bunq/sdk/exception_factory.py

        """
+        :type response_id: str


Not ordered properly

epels · 2018-01-02T09:49:11Z

bunq/sdk/exception_factory.py

        """
+        :type response_id: str


Not ordered properly

epels · 2018-01-02T09:53:00Z

bunq/sdk/exception_factory.py

@@ -63,15 +109,21 @@ def _generate_message_error(cls, response_code, messages):

        line_response_code = cls._FORMAT_RESPONSE_CODE_LINE \
            .format(response_code)
+        line_response_id = cls._FORMAT_RESPONSE_ID_LINE.format(response_id)
+        line_error_message = cls._FORMAT_ERROR_MESSAGE_LINE.format(
+            cls._GLUE_ERROR_MESSAGE_STRING_EMPTY.join(messages)


Consider whether _GLUE_ERROR_MESSAGE would be sufficient as a name here. Having the name imply it's an empty string is redundant information and not relevant for the consumer IMHO

epels · 2018-01-02T09:54:10Z

bunq/sdk/exception_factory.py


-        return cls._glue_messages([line_response_code] + messages)
+        return cls._glue_all_error_message(
+            [line_response_code, line_response_id, line_error_message]


No trailing comma?

only in multi line

epels · 2018-01-02T09:57:43Z

tests/http/test_bad_request_with_response_id.py

+
+class TestPagination(BunqSdkTestCase):
+    """
+    Tests if the response id from a failed request can be retrieved


Docstring should start on the same line as the opening """

This is also how we do it 😁 we ignore pep8 's suggestion to begin doctoring right behind """

epels · 2018-01-02T10:00:33Z

tests/http/test_bad_request_with_response_id.py

+        """
+        """
+
+        caught_exception = None


Use assertRaises: https://docs.python.org/2/library/unittest.html#unittest.TestCase.assertRaises

epels · 2018-01-02T12:36:23Z

tests/http/test_bad_request_with_response_id.py


        self.assertIsNotNone(caught_exception)
-        self.assertIsNotNone(caught_exception.response_id)
+        self.assertIsNotNone(caught_exception.exception)


This assertion seems redundant after using assertRaises?

epels

LGTM

OGKevin added this to the 0.12.5 milestone Dec 26, 2017

OGKevin self-assigned this Dec 26, 2017

bunq deleted a comment Dec 26, 2017

OGKevin added 8 commits December 29, 2017 23:11

Moved http related tests to the http test folder. (#59)

e036aef

Added error constant in case response id header retrieval fails. (#59)

7568934

Added method to retrieve response header from failed request. (#59)

e63aeb2

Added response id parameter to exception base class. (#59)

c2d288a

Include response id in error message format. (#59)

4817075

Pass response id to exceptions in exception factory. (#59)

a727616

Added test to ensure that response id retrieval at request failure pa…

ef780ad

…sses. (#59)

Added missing docstrings. (#59)

a3ef206

OGKevin force-pushed the feature/bunq/sdk_python#59-add_response_id_to_request_error branch from 284cc29 to a3ef206 Compare December 29, 2017 22:12

Added missing argument for UnknownApiErrorException. (#59)

1041e0a

bunq deleted a comment Dec 29, 2017

OGKevin commented Dec 30, 2017

View reviewed changes

Removed plural methods and constatns. (#59)

979b853

OGKevin requested a review from epels January 2, 2018 09:27

OGKevin assigned epels Jan 2, 2018

epels previously approved these changes Jan 2, 2018

View reviewed changes

OGKevin added 2 commits January 2, 2018 11:44

Reoredered docstring parameters. (#59)

f3324e3

Use assertRaises to make code cleaner. (#59)

d5d92c6

OGKevin dismissed epels’s stale review via d5d92c6 January 2, 2018 10:45

bunq deleted a comment Jan 2, 2018

epels reviewed Jan 2, 2018

View reviewed changes

Removed redundant assertions. (#59)

177f605

epels approved these changes Jan 2, 2018

View reviewed changes

OGKevin requested a review from andrederoos January 2, 2018 14:29

OGKevin assigned andrederoos and unassigned epels Jan 2, 2018

OGKevin added the Can be merged label Jan 2, 2018

Merge branch 'develop' into feature/#59-add_response_id_to_request_error

aede581

andrederoos approved these changes Jan 2, 2018

View reviewed changes

andrederoos added the Reviewed by André label Jan 2, 2018

andrederoos merged commit cb3ead1 into develop Jan 2, 2018

andrederoos deleted the feature/bunq/sdk_python#59-add_response_id_to_request_error branch January 2, 2018 20:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/bunq/sdk python#59 add response id to request error #64

Feature/bunq/sdk python#59 add response id to request error #64

OGKevin commented Dec 26, 2017

OGKevin left a comment

OGKevin Dec 30, 2017

OGKevin Dec 30, 2017

OGKevin Dec 30, 2017

OGKevin Dec 30, 2017

OGKevin commented Jan 2, 2018

epels left a comment

epels Jan 2, 2018

OGKevin Jan 2, 2018

epels Jan 2, 2018

OGKevin Jan 2, 2018

epels Jan 2, 2018

epels Jan 2, 2018

OGKevin Jan 2, 2018

epels Jan 2, 2018

epels Jan 2, 2018

epels Jan 2, 2018

epels Jan 2, 2018

OGKevin Jan 2, 2018

epels Jan 2, 2018

OGKevin Jan 2, 2018

epels Jan 2, 2018

epels Jan 2, 2018

OGKevin Jan 2, 2018

epels left a comment


		return cls._glue_messages([line_response_code] + messages)
		return cls._glue_messages(

Feature/bunq/sdk python#59 add response id to request error #64

Feature/bunq/sdk python#59 add response id to request error #64

Conversation

OGKevin commented Dec 26, 2017

OGKevin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OGKevin commented Jan 2, 2018

epels left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

epels left a comment

Choose a reason for hiding this comment