MAPI-81 ready for review

Author: Ofego Edafe

message_media_messages/configuration.py

@@ -11,7 +11,6 @@
 
 
 class Configuration(object):
-
     """A class used for configuring the SDK by a user.
 
     This class need not be instantiated and all properties and methods
@@ -36,8 +35,10 @@ class Configuration(object):
 
     # The username to use with HMAC authentication
     # TODO: Set an appropriate value
-    hmac_auth_user_name = os.environ.get('AUTHUSERNAME')
+    hmac_auth_user_name = 'FxJMSlsivOoHAjDbWcO7'
+        #os.environ.get('AUTH_USERNAME')
 
     # The password to use with HMAC authentication
     # TODO: Set an appropriate value
-    hmac_auth_password = os.environ.get('AUTHPASSWORD')
+    hmac_auth_password = 'HbR3jfA1b0J3AHVmPajTWuGGaDIsk4'
+        #os.environ.get('PASSWORD')

tests/auth_manager_test.py

@@ -11,6 +11,8 @@
 from datetime import datetime
 from time import mktime
 from wsgiref.handlers import format_date_time
+
+from tests.test_configuration import TestConfiguration
 from tests.test_util import TestUtility
 from message_media_messages.http.auth.auth_manager import AuthManager
 from message_media_messages.configuration import Configuration
@@ -27,7 +29,7 @@ class AuthManagerTests(unittest.TestCase):
     body.messages = []
     body.messages.append(Message())
     body.messages[0].content = 'My tests message'
-    body.messages[0].destination_number = '{}'
+    body.messages[0].destination_number = '{}'.format(TestConfiguration.request_dest_number)
     body.messages[0].format = FormatEnum.SMS
 
     _url_path = '/v1/messages'
@@ -51,7 +53,7 @@ class AuthManagerTests(unittest.TestCase):
     content_signature = "x-Content-MD5: {}\n".format(content_hash)
     get_content_signature = ""
 
-    def test_post_request_authorization_header_values_are_appropriate(self):
+    def test_post_request_hmac_authorization_header_values_are_appropriate(self):
         date_header, expected_algorithm, expected_username, http, query_url, request_header = self.header_setup()
         body = APIHelper.json_serialize(self.body)
         content_signature = self.content_signature
@@ -71,7 +73,7 @@ def test_post_request_authorization_header_values_are_appropriate(self):
         self.assert_cases(algorithm, expected_algorithm, expected_header, expected_signature, expected_username,
                           header, signature, username)
 
-    def test_md5_content_hash_equivalent_to_body(self):
+    def test_post_request_content_md5_is_equivalent_to_md5_hash_of_request_body(self):
         http = urllib3.PoolManager()
         body = APIHelper.json_serialize(self.body)
         md5 = self.content_hash
@@ -89,7 +91,7 @@ def test_md5_content_hash_equivalent_to_body(self):
         requestMD5 = _request.getheader('x-Content-MD5')
         assert md5 == requestMD5
 
-    def test_get_request_authorization_header_values_are_appropriate(self):
+    def test_get_request_hmac_authorization_header_values_are_appropriate(self):
         date_header, expected_algorithm, expected_username, http, query_url, request_header = self.header_setup()
         content_signature = ""
         expected_header = ' headers="date request-line"'
@@ -112,7 +114,7 @@ def header_setup(self):
         date_header = self.date_header
         request_header = self._headers
         query_url = self._query_url
-        expected_username = 'hmac username="{}"'
+        expected_username = 'hmac username="{}"'.format(Configuration.hmac_auth_user_name)
         expected_algorithm = ' algorithm="hmac-sha1"'
         return date_header, expected_algorithm, expected_username, http, query_url, request_header
 

tests/messages_controller_test.py

@@ -7,15 +7,17 @@
 """
 
 import unittest
+
 from message_media_messages.exceptions.api_exception import APIException
+from tests.test_configuration import TestConfiguration
 from tests.test_util import TestUtility
 from message_media_messages.message_media_messages_client import MessageMediaMessagesClient
 
 
-class MessagesControllerTest(unittest.TestCase):
+class MessageControllerTest(unittest.TestCase):
 
-    # Testing successful message to MM endpoint
-    def test_successful_message_to_endpoint(self):
+    # Testing successful post request to endpoint
+    def test_successful_post_request_with_hmac_auth_to_endpoint(self):
         use_hmac_authentication = True
         body = TestUtility.create_body()
 
@@ -26,28 +28,28 @@ def test_successful_message_to_endpoint(self):
         self.assertIsNotNone(result)
 
     # Testing unsupported request raises exception
-    def test_unsuccessful_request_raises_exception(self):
-        auth_user_name = '{}'
-        auth_password = '{}'
+    def test_unsuccessful_request_with_hmac_auth_raises_exception(self):
+        hmac_auth_user_name = 'wrong'
+        hmac_auth_password = 'value'
         use_hmac_authentication = True
         body = TestUtility.create_body()
 
-        client = MessageMediaMessagesClient(auth_user_name, auth_password, use_hmac_authentication)
+        client = MessageMediaMessagesClient(hmac_auth_user_name, hmac_auth_password, use_hmac_authentication)
         messages_controller = client.messages
 
         with self.assertRaises(APIException) as context_manager:
             messages_controller.send_messages(body)
         raised_exception = context_manager.exception
         self.assertIsNotNone(raised_exception)
 
-    # Testing get message endpoint
-    def test_successful_get_message_to_endpoint(self):
-        actual_id = '{}'
+    # Testing successful get request endpoint
+    def test_successful_get_request_with_hmac_auth_to_endpoint(self):
+        expected_id = '{}'.format(TestConfiguration.request_message_id)
         use_hmac_authentication = True
 
         client = MessageMediaMessagesClient(use_hmac_authentication)
         messages_controller = client.messages
 
-        result = messages_controller.get_message_status(actual_id)
-        expected_id = result.message_id
-        assert expected_id == actual_id
+        result = messages_controller.get_message_status(expected_id)
+        actual_id = result.message_id
+        assert actual_id == expected_id

tests/test_configuration.py

@@ -0,0 +1,23 @@
+# -*- coding: utf-8 -*-
+
+"""
+    message_media_messages
+
+    This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
+"""
+import os
+
+
+class TestConfiguration(object):
+    """A class used for configuring the SDK Test cases by a user.
+
+    This class need not be instantiated and all properties and methods
+    are accessible without instance creation.
+
+    """
+
+    # Set the id for a request
+    request_message_id = os.environ.get('message_id')
+
+    # The base Uri for API calls
+    request_dest_number = os.environ.get('dest_number')

tests/test_util.py

@@ -13,6 +13,7 @@
 from message_media_messages.models.format_enum import FormatEnum
 from message_media_messages.models.message import Message
 from message_media_messages.models.send_messages_request import SendMessagesRequest
+from tests.test_configuration import TestConfiguration
 
 
 class TestUtility(object):
@@ -37,7 +38,7 @@ def create_body():
         body.messages = []
         body.messages.append(Message())
         body.messages[0].content = 'My tests message'
-        body.messages[0].destination_number = '{}'
+        body.messages[0].destination_number = '{}'.format(TestConfiguration.request_dest_number)
         body.messages[0].format = FormatEnum.SMS
 
         return body