rename response.* to result.*

pyotrs/lib.py

@@ -678,12 +678,12 @@ class Client(object):
         self.attachment_list = []
         self.dynamic_field_list = []
 
-        self.list_ticket_search_result = []
-        self.list_ticket_get_results = []
+        self.result_list_ticket_get = []
+        self.result_list_ticket_search = []
 
-        self.response_json = None
-        self.response_status_code = None
-        self.response_content = None
+        self.result_json = None
+        self.result_content = None
+        self.result_status_code = None
 
     """
     GenericInterface::Operation::Session::SessionCreate
@@ -746,7 +746,7 @@ class Client(object):
         if not self._parse_and_validate_response(response):
             return False
 
-        self.session_id_store.value = self.response_json['SessionID']
+        self.session_id_store.value = self.result_json['SessionID']
         return True
 
     def session_restore_or_set_up_new(self):
@@ -780,7 +780,7 @@ class Client(object):
             raise SessionCreateError("Failed to create a Session ID!")
 
         # safe new created session_id to file
-        if not self.session_id_store.write(self.response_json['SessionID']):
+        if not self.session_id_store.write(self.result_json['SessionID']):
             raise SessionIDFileError("Failed to save Session ID to file!")
         else:
             print("Saved new Session ID to file: {0}".format(self.session_id_store.file_path))
@@ -1191,7 +1191,7 @@ class Client(object):
         # TODO 2016-04-17 (RH): is this "extra net" needed?!
         if "Article" in payload.keys():
             try:
-                article_id = self.response_json.get('ArticleID', None)
+                article_id = self.result_json.get('ArticleID', None)
                 if not article_id:
                     raise UpdateAddArticleError("No new Article was created?!")
 
@@ -1266,16 +1266,16 @@ class Client(object):
             raise ValueError("requests.Response object expected!")
 
         # clear data from Client
-        self.list_ticket_get_results = []
-        self.list_ticket_search_result = []
-        self.response_error = False
+        self.result_list_ticket_get = []
+        self.result_list_ticket_search = []
+        self.result_error = False
 
         # get and set new data
-        self.response_json = response.json()
+        self.result_json = response.json()
         # TODO 2016-04-24 (RH) can this deep copy go?
-        self.response_json_original = copy.deepcopy(self.response_json)
-        self.response_status_code = response.status_code
-        self.response_content = response.content
+        self._result_json_original = copy.deepcopy(self.result_json)
+        self.result_status_code = response.status_code
+        self.result_content = response.content
 
         if self.operation == "SessionCreate":
             self.response_type = "SessionID"
@@ -1292,33 +1292,33 @@ class Client(object):
 
         # handle TicketSearch operation first. special: empty search result has no "TicketID"
         if self.operation == "TicketSearch":
-            if not self.response_json:
+            if not self.result_json:
                 return True
-            if self.response_json.get(self.response_type, None):
-                self.list_ticket_search_result = self.response_json['TicketID']
+            if self.result_json.get(self.response_type, None):
+                self.result_list_ticket_search = self.result_json['TicketID']
                 return True
 
         # now handle other operations
-        if self.response_json.get(self.response_type, None):
-            self.response_error = False
-        elif self.response_json.get("Error", None):
-            self.response_error = True
+        if self.result_json.get(self.response_type, None):
+            self.result_error = False
+        elif self.result_json.get("Error", None):
+            self.result_error = True
         else:
-            self.response_error = True
+            self.result_error = True
             # critical error: Unknown response from OTRS API - FAIL NOW!
             raise ResponseJSONParseError("Unknown key in response JSON DICT!")
 
         # report error
-        if self.response_error:
+        if self.result_error:
             raise OTRSAPIError("Failed to access OTRS API. Check Username and Password! "
                                "Session ID expired?! Does Ticket exist?\n"
                                "OTRS Error Code: {0}\nOTRS Error Message: {1}"
-                               "".format(self.response_json["Error"]["ErrorCode"],
-                                         self.response_json["Error"]["ErrorMessage"]))
+                               "".format(self.result_json["Error"]["ErrorCode"],
+                                         self.result_json["Error"]["ErrorMessage"]))
 
         # for operation TicketGet: parse result list into Ticket object list
         if self.operation == "TicketGet":
-            self.list_ticket_get_results = [Ticket(item) for item in self.response_json['Ticket']]
+            self.result_list_ticket_get = [Ticket(item) for item in self.result_json['Ticket']]
 
         return True
 

tests/test_client.py

@@ -233,7 +233,7 @@ class ClientTests(unittest.TestCase):
         """Tests session_restore_or_set_up_new no file; create successful; write (wr) not ok"""
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
         obj.session_id_store.value = "foobar"
-        obj.response_json = {'SessionID': "the_other_sid1"}
+        obj.result_json = {'SessionID': "the_other_sid1"}
 
         mock_read_s_id.return_value = None
         mock_s_create.return_value = True
@@ -254,7 +254,7 @@ class ClientTests(unittest.TestCase):
         """Tests session_restore_or_set_up_new no file; create successful; write (wr) ok"""
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
         obj.session_id_store.value = "foobar"
-        obj.response_json = {'SessionID': "the_other_sid2"}
+        obj.result_json = {'SessionID': "the_other_sid2"}
 
         mock_read_s_id.return_value = None
         mock_s_create.return_value = True
@@ -281,13 +281,13 @@ class ClientTests(unittest.TestCase):
     def test_ticket_get_by_id_ok(self, mock_ticket_get_json):
         """Tests ticket_get_by_id ok"""
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
-        obj.response_json = {'Ticket': [{'Some': 'Ticket'}]}
+        obj.result_json = {'Ticket': [{'Some': 'Ticket'}]}
         mock_ticket_get_json.return_value = True
         result = obj.ticket_get_by_id(1)
 
         self.assertEqual(mock_ticket_get_json.call_count, 1)
         self.assertTrue(result)
-        self.assertDictEqual(obj.response_json['Ticket'][0], {'Some': 'Ticket'})
+        self.assertDictEqual(obj.result_json['Ticket'][0], {'Some': 'Ticket'})
 
     @mock.patch('pyotrs.Client._ticket_get_json', autospec=True)
     def test_ticket_get_by_ids_fail(self, mock_ticket_get_json):
@@ -295,7 +295,7 @@ class ClientTests(unittest.TestCase):
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
 
         mock_ticket_get_json.return_value = False
-        result = obj.ticket_get_by_ids([1])
+        result = obj.ticket_get_by_list([1])
 
         self.assertEqual(mock_ticket_get_json.call_count, 1)
         self.assertFalse(result)
@@ -306,7 +306,7 @@ class ClientTests(unittest.TestCase):
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
 
         mock_ticket_get_json.return_value = True
-        result = obj.ticket_get_by_ids([1])
+        result = obj.ticket_get_by_list([1])
 
         self.assertEqual(mock_ticket_get_json.call_count, 1)
         self.assertTrue(result)
@@ -335,14 +335,14 @@ class ClientTests(unittest.TestCase):
         """Tests ticket_get_by_number provided as int -> ok; 1 result"""
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
 
-        obj.response_json = {'Ticket': [{'SomeOne': 'TicketOne'}]}
+        obj.result_json = {'Ticket': [{'SomeOne': 'TicketOne'}]}
         mock_t_get.return_value = True
         mock_t_search.return_value = [1]
 
         result = obj.ticket_get_by_number("SomeOtherNumber1")
 
         self.assertTrue(result)
-        self.assertDictEqual(obj.response_json['Ticket'][0], {'SomeOne': 'TicketOne'})
+        self.assertDictEqual(obj.result_json['Ticket'][0], {'SomeOne': 'TicketOne'})
         self.assertEqual(mock_t_search.call_count, 1)
 
     @mock.patch('pyotrs.Client.ticket_search', autospec=True)
@@ -457,7 +457,7 @@ class ClientTests(unittest.TestCase):
     def test_ticket_search_ticket_id(self, mock_ticket_search_json):
         """Tests ticket_search ticket id"""
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
-        obj.list_ticket_search_result = [1]
+        obj.result_list_ticket_search = [1]
         mock_ticket_search_json.return_value = True
 
         obj.ticket_search(TicketID="1")
@@ -468,7 +468,7 @@ class ClientTests(unittest.TestCase):
     def test_ticket_search_datetime(self, mock_ticket_search_json):
         """Tests ticket_search datetime"""
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
-        obj.list_ticket_search_result = [1]
+        obj.result_list_ticket_search = [1]
         mock_ticket_search_json.return_value = True
 
         obj.ticket_search(TicketCreateTimeOlderDate=datetime.datetime.utcnow())
@@ -479,7 +479,7 @@ class ClientTests(unittest.TestCase):
     def test_ticket_search_full_text(self, mock_ticket_search):
         """Tests ticket_search full text"""
         obj = Client(baseurl="http://fqdn", webservicename="GenericTicketConnectorREST")
-        obj.list_ticket_search_result = [1]
+        obj.result_list_ticket_search = [1]
 
         mock_ticket_search.return_value = True
 
@@ -766,7 +766,7 @@ class ClientTests(unittest.TestCase):
         client._parse_and_validate_response(mocked_response)
 
         self.assertEqual(client.response_type, 'Ticket')
-        self.assertDictEqual(client.response_json, tkt)
+        self.assertDictEqual(client.result_json, tkt)
 
     def test__validate_response_operation_ticket_create(self):
         """Test _validate_response with TicketCreate"""
@@ -782,8 +782,8 @@ class ClientTests(unittest.TestCase):
         client._parse_and_validate_response(mocked_response)
 
         self.assertEqual(client.response_type, 'TicketID')
-        self.assertDictEqual(client.response_json, {u'ArticleID': u'26',
-                                                    u'TicketID': u'9',
+        self.assertDictEqual(client.result_json, {u'ArticleID'     : u'26',
+                                                    u'TicketID'    : u'9',
                                                     u'TicketNumber': u'000008'})
 
     def test__validate_response_operation_ticket_update(self):
@@ -797,7 +797,7 @@ class ClientTests(unittest.TestCase):
 
         client._parse_and_validate_response(mocked_response)
         self.assertEqual(client.response_type, 'TicketID')
-        self.assertDictEqual(client.response_json, {u'TicketID': u'9',
+        self.assertDictEqual(client.result_json, {u'TicketID'      : u'9',
                                                     u'TicketNumber': u'000008'})
 
     def test__validate_response_operation_ticket_search(self):
@@ -811,7 +811,7 @@ class ClientTests(unittest.TestCase):
 
         client._parse_and_validate_response(mocked_response)
         self.assertEqual(client.response_type, 'TicketID')
-        self.assertDictEqual(client.response_json, {u'TicketID': [u'9']})
+        self.assertDictEqual(client.result_json, {u'TicketID': [u'9']})
 
     def test__validate_response_operation_ticket_search_empty(self):
         """Test _validate_response with TicketSearch with empty result"""
@@ -824,7 +824,7 @@ class ClientTests(unittest.TestCase):
 
         client._parse_and_validate_response(mocked_response)
         self.assertEqual(client.response_type, 'TicketID')
-        self.assertDictEqual(client.response_json, {})
+        self.assertDictEqual(client.result_json, {})
 
     def test__validate_response_operation_ticket_search_nonsense(self):
         """Test _validate_response with TicketSearch with a nonsence response"""
@@ -839,8 +839,8 @@ class ClientTests(unittest.TestCase):
                           client._parse_and_validate_response,
                           mocked_response)
         self.assertEqual(client.response_type, 'TicketID')
-        self.assertTrue(client.response_error)
-        self.assertDictEqual(client.response_json, {u'FooBar': [u'1', u'3']})
+        self.assertTrue(client.result_error)
+        self.assertDictEqual(client.result_json, {u'FooBar': [u'1', u'3']})
 
     def test__validate_response_operation_ticket_get_error(self):
         """Test _validate_response with TicketGet when an error is received"""

tests/test_pyotrs_responses.py

@@ -23,9 +23,9 @@ class PyOTRSResponsesTests(unittest.TestCase):
         obj = Client(baseurl="http://fqdn",
                      webservicename="GenericTicketConnectorREST")
 
-        self.assertIsNone(obj.response_json)
-        self.assertIsNone(obj.response_status_code)
-        self.assertIsNone(obj.response_content)
+        self.assertIsNone(obj.result_json)
+        self.assertIsNone(obj.result_status_code)
+        self.assertIsNone(obj.result_content)
         self.assertIsNone(obj.session_id_store.value)
 
         with responses.RequestsMock(assert_all_requests_are_fired=True) as rsps:
@@ -39,10 +39,10 @@ class PyOTRSResponsesTests(unittest.TestCase):
             result = obj.session_create()
 
         self.assertEqual(result, True)
-        self.assertFalse(obj.response_error)
+        self.assertFalse(obj.result_error)
         self.assertEqual(obj.operation, 'SessionCreate')
-        self.assertEqual(obj.response_status_code, 200)
-        self.assertDictEqual(obj.response_json,
+        self.assertEqual(obj.result_status_code, 200)
+        self.assertDictEqual(obj.result_json,
                              {u'SessionID': u'tMtTFDg1PxCX51dWnjue4W5oQtNsFd0k'})
         self.assertEqual(obj.session_id_store.value, 'tMtTFDg1PxCX51dWnjue4W5oQtNsFd0k')
 
@@ -51,9 +51,9 @@ class PyOTRSResponsesTests(unittest.TestCase):
         obj = Client(baseurl="http://fqdn",
                      webservicename="GenericTicketConnectorREST")
 
-        self.assertIsNone(obj.response_json)
-        self.assertIsNone(obj.response_status_code)
-        self.assertIsNone(obj.response_content)
+        self.assertIsNone(obj.result_json)
+        self.assertIsNone(obj.result_status_code)
+        self.assertIsNone(obj.result_content)
         self.assertIsNone(obj.session_id_store.value)
 
         with responses.RequestsMock(assert_all_requests_are_fired=True) as rsps:
@@ -69,10 +69,10 @@ class PyOTRSResponsesTests(unittest.TestCase):
                                    'Failed to access OTRS API. Check Username and Password.*',
                                    obj.session_create)
 
-        self.assertTrue(obj.response_error)
+        self.assertTrue(obj.result_error)
         self.assertEqual(obj.operation, 'SessionCreate')
-        self.assertEqual(obj.response_status_code, 200)
-        self.assertDictEqual(obj.response_json,
+        self.assertEqual(obj.result_status_code, 200)
+        self.assertDictEqual(obj.result_json,
                              {"Error": {"ErrorCode": "SessionCreate.AuthFail",
                                         "ErrorMessage": "SessionCreate: Authorization failing!"}})
         self.assertIsNone(obj.session_id_store.value)
@@ -83,9 +83,9 @@ class PyOTRSResponsesTests(unittest.TestCase):
         obj = Client(baseurl="http://fqdn",
                      webservicename="GenericTicketConnectorREST")
 
-        self.assertIsNone(obj.response_json)
-        self.assertIsNone(obj.response_status_code)
-        self.assertIsNone(obj.response_content)
+        self.assertIsNone(obj.result_json)
+        self.assertIsNone(obj.result_status_code)
+        self.assertIsNone(obj.result_content)
         self.assertIsNone(obj.session_id_store.value)
 
         mock_validate_resp.return_value = False