Merge pull request #4 from OpenMatchmaking/hotfix-field-names

Updated field names according to the protocol definition

Author: Relrin

sage_utils/wrappers.py

@@ -8,6 +8,9 @@ class Response(object):
     ERROR_FIELD_NAME = 'error'
     EVENT_FIELD_NAME = 'event-name'
 
+    ERROR_TYPE_FIELD_NAME = 'type'
+    ERROR_DETAILS_FIELD_NAME = 'details'
+
     def __init__(self, data=None, *args, **kwargs):
         super(Response, self).__init__()
         self.data = data
@@ -19,8 +22,8 @@ def from_error(cls, error_type, message, event_name=None):
 
         response = {
             cls.ERROR_FIELD_NAME: {
-                "type": error_type,
-                "message": message
+                cls.ERROR_TYPE_FIELD_NAME: error_type,
+                cls.ERROR_DETAILS_FIELD_NAME: message
             },
             cls.EVENT_FIELD_NAME: event_name
         }

tests/amqp/test_rpc_client.py

@@ -59,11 +59,11 @@ async def test_rpc_amqp_client_returns_an_error(event_loop):
     response = await client.send(payload={})
 
     assert Response.ERROR_FIELD_NAME in response.keys()
-    assert 'message' in response[Response.ERROR_FIELD_NAME].keys()
-    assert response[Response.ERROR_FIELD_NAME]['message'] == VALIDATION_ERROR_DECR
+    assert Response.ERROR_TYPE_FIELD_NAME in response[Response.ERROR_FIELD_NAME].keys()
+    assert response[Response.ERROR_FIELD_NAME][Response.ERROR_TYPE_FIELD_NAME] == VALIDATION_ERROR  # NOQA
 
-    assert 'type' in response[Response.ERROR_FIELD_NAME].keys()
-    assert response[Response.ERROR_FIELD_NAME]['type'] == VALIDATION_ERROR
+    assert Response.ERROR_DETAILS_FIELD_NAME in response[Response.ERROR_FIELD_NAME].keys()
+    assert response[Response.ERROR_FIELD_NAME][Response.ERROR_DETAILS_FIELD_NAME] == VALIDATION_ERROR_DECR  # NOQA
 
     assert Response.EVENT_FIELD_NAME in response.keys()
     assert response[Response.EVENT_FIELD_NAME] is None

tests/test_wrappers.py

@@ -20,11 +20,11 @@ def test_from_error_class_method(error_type, message, event_name):
     assert response.data[Response.EVENT_FIELD_NAME] == event_name
 
     assert Response.ERROR_FIELD_NAME in response.data.keys()
-    assert 'type' in response.data[Response.ERROR_FIELD_NAME].keys()
-    assert response.data[Response.ERROR_FIELD_NAME]['type'] == error_type
+    assert Response.ERROR_TYPE_FIELD_NAME in response.data[Response.ERROR_FIELD_NAME].keys()
+    assert response.data[Response.ERROR_FIELD_NAME][Response.ERROR_TYPE_FIELD_NAME] == error_type
 
-    assert 'message' in response.data[Response.ERROR_FIELD_NAME].keys()
-    assert response.data[Response.ERROR_FIELD_NAME]['message'] == message
+    assert Response.ERROR_DETAILS_FIELD_NAME in response.data[Response.ERROR_FIELD_NAME].keys()
+    assert response.data[Response.ERROR_FIELD_NAME][Response.ERROR_DETAILS_FIELD_NAME] == message
 
 
 @pytest.mark.parametrize("error_type, message, event_name", [
@@ -40,12 +40,12 @@ def test_from_error_with_a_message_without_the_period_in_the_end(error_type, mes
     assert response.data[Response.EVENT_FIELD_NAME] == event_name
 
     assert Response.ERROR_FIELD_NAME in response.data.keys()
-    assert 'type' in response.data[Response.ERROR_FIELD_NAME].keys()
-    assert response.data[Response.ERROR_FIELD_NAME]['type'] == error_type
+    assert Response.ERROR_TYPE_FIELD_NAME in response.data[Response.ERROR_FIELD_NAME].keys()
+    assert response.data[Response.ERROR_FIELD_NAME][Response.ERROR_TYPE_FIELD_NAME] == error_type
 
-    assert 'message' in response.data[Response.ERROR_FIELD_NAME].keys()
-    assert response.data[Response.ERROR_FIELD_NAME]['message'].endswith('.')
-    assert response.data[Response.ERROR_FIELD_NAME]['message'] == "{}.".format(message)
+    assert Response.ERROR_DETAILS_FIELD_NAME in response.data[Response.ERROR_FIELD_NAME].keys()
+    assert response.data[Response.ERROR_FIELD_NAME][Response.ERROR_DETAILS_FIELD_NAME].endswith('.')  # NOQA
+    assert response.data[Response.ERROR_FIELD_NAME][Response.ERROR_DETAILS_FIELD_NAME] == "{}.".format(message)  # NOQA
 
 
 @pytest.mark.parametrize("data, event_name", [