Merge pull request #15 from messagemedia/feature/MAPI-81-support-12275-investigate-python

Fixed the issue where in the value of the request header x-Content-MD5 is not the MD5 of the body.

Author: shravan-g

.gitignore

@@ -1,2 +1,6 @@
 *.pyc
-index.py
+index.py
+build
+dist
+.idea
+*egg-info

message_media_messages/configuration.py

@@ -6,11 +6,8 @@
     This file was automatically generated for MessageMedia by APIMATIC v2.0 ( https://apimatic.io ).
 """
 
-from message_media_messages.api_helper import APIHelper
-
 
 class Configuration(object):
-
     """A class used for configuring the SDK by a user.
 
     This class need not be instantiated and all properties and methods
@@ -35,8 +32,9 @@ class Configuration(object):
 
     # The username to use with HMAC authentication
     # TODO: Set an appropriate value
-    hmac_auth_user_name = None
+    hmac_auth_user_name = 'TODO: Replace'
 
     # The password to use with HMAC authentication
     # TODO: Set an appropriate value
-    hmac_auth_password = None
+    hmac_auth_password = 'TODO: Replace'
+

message_media_messages/controllers/.DS_Store

@@ -72,7 +72,7 @@ def get_message_status(self,
 
         # Prepare query URL
         _url_path = '/v1/messages/{messageId}'
-        _url_path = APIHelper.append_url_with_template_parameters(_url_path, { 
+        _url_path = APIHelper.append_url_with_template_parameters(_url_path, {
             'messageId': message_id
         })
         _query_builder = Configuration.base_uri
@@ -299,7 +299,7 @@ def cancel_scheduled_message(self,
 
         # Prepare query URL
         _url_path = '/v1/messages/{messageId}'
-        _url_path = APIHelper.append_url_with_template_parameters(_url_path, { 
+        _url_path = APIHelper.append_url_with_template_parameters(_url_path, {
             'messageId': message_id
         })
         _query_builder = Configuration.base_uri

message_media_messages/controllers/messages_controller.py

@@ -78,6 +78,7 @@ def apply_hmac_auth(http_request, url, body=None):
         if body is not None:
             request_type = "POST"
             m = hashlib.md5()
+            m.update(bytes(body, 'utf-8'))
             content_hash = m.hexdigest()
             content_signature = "x-Content-MD5: {}\n".format(content_hash)
             content_header = "x-Content-MD5 "

message_media_messages/http/auth/auth_manager.py

@@ -1,4 +1,7 @@
-requests==2.20.0
-jsonpickle==0.7.1
-cachecontrol==0.11.7
-python-dateutil==2.5.3
+requests==2.28.2
+jsonpickle==3.0.1
+cachecontrol==0.12.11
+python-dateutil==2.8.2
+responses~=0.22.0
+urllib3~=1.26.14
+setuptools==67.2.0

requirements.txt

@@ -8,7 +8,7 @@
 
 setup(
     name='messagemedia-messages-sdk',
-    version='2.1.0',
+    version='2.1.1',
     description='The MessageMedia Messages API provides a number of endpoints for building powerful two-way messaging applications.',
     long_description_content_type="text/markdown",
     long_description=long_description,
@@ -17,9 +17,12 @@
     url='https://developers.messagemedia.com',
     packages=find_packages(),
     install_requires=[
-        'requests>=2.9.1, <3.0',
-        'jsonpickle>=0.7.1, <1.0',
-        'cachecontrol>=0.11.7, <1.0',
-        'python-dateutil>=2.5.3, <3.0'
+        'requests>=2.28.2, <3.0',
+        'jsonpickle>=3.0.1, <4.0',
+        'cachecontrol>=0.12.11, <1.0',
+        'python-dateutil>=2.8.2, <3.0',
+        'responses>=0.22.0, <1.0',
+        'urllib3>=1.26.14, <2.0',
+        'setuptools>=67.2.0, <68'
     ]
 )

setup.py

@@ -1 +1,2 @@
-nose==1.3.7
+nose==1.3.7
+freezegun==1.2.2

test-requirements.txt

@@ -0,0 +1,4 @@
+__all__ = [
+    'auth_manager_test',
+    'test_util'
+]

tests/__init__.py

@@ -0,0 +1,103 @@
+# -*- coding: utf-8 -*-
+
+import hashlib
+import unittest
+
+from freezegun import freeze_time
+
+from message_media_messages.api_helper import APIHelper
+from message_media_messages.configuration import Configuration
+from message_media_messages.http.auth.auth_manager import AuthManager
+from message_media_messages.http.requests_client import RequestsClient
+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_util import TestUtil
+
+
+class AuthManagerTest(unittest.TestCase):
+
+    def __init__(self, method_name: str = ...):
+        super().__init__(method_name)
+        self.content_hash = None
+        self.query_url = None
+        self.send_message_request = None
+
+    def setUp(self):
+        self.send_message_request = self.get_send_message_request()
+        self.query_url = APIHelper.clean_url(Configuration.base_uri + '/v1/messages')
+        self.content_hash = self.get_content_hash(self.send_message_request)
+        self.content_md5_header = "x-Content-MD5: {}\n".format(self.content_hash)
+        self.date_header = 'Wed, 08 Feb 2023 03:00:00 GMT'
+        self.expected_algorithm = ' algorithm="hmac-sha1"'
+        Configuration.hmac_auth_user_name = "some_user_name"
+        self.expected_username = "hmac username=\"" + Configuration.hmac_auth_user_name + "\""
+
+    @freeze_time("2023-02-08 14:00:00")
+    def test_post_request_hmac_authorization_header_values_are_appropriate(self):
+        body = APIHelper.json_serialize(self.send_message_request)
+
+        request = RequestsClient().post(
+            query_url=self.query_url,
+            parameters=body,
+            headers={}
+        )
+
+        AuthManager.apply_hmac_auth(request, self.query_url, body)
+
+        expected_headers_property = ' headers="date x-Content-MD5 request-line"'
+        expected_signature = TestUtil.create_signature(self.date_header, self.content_md5_header,
+                                                       self.query_url, 'POST', True)
+        self.assert_auth_header(request, expected_headers_property, expected_signature)
+
+    def test_post_request_content_md5_is_md5_of_request_body(self):
+        body = APIHelper.json_serialize(self.send_message_request)
+
+        request = RequestsClient().post(
+            query_url=self.query_url,
+            parameters=body,
+            headers={}
+        )
+
+        AuthManager.apply_hmac_auth(request, self.query_url, body)
+        request_md5 = request.headers['x-Content-MD5']
+        assert self.content_hash == request_md5
+
+    @freeze_time("2023-02-08 14:00:00")
+    def test_get_request_hmac_authorization_header_values_are_appropriate(self):
+        request = RequestsClient().get(
+            query_url=self.query_url,
+            headers={}
+        )
+
+        AuthManager.apply_hmac_auth(request, self.query_url)
+
+        expected_headers_property = ' headers="date request-line"'
+        expected_signature = TestUtil.create_signature(self.date_header, "",
+                                                       self.query_url, 'GET', True)
+        self.assert_auth_header(request, expected_headers_property, expected_signature)
+
+    def assert_auth_header(self, request, expected_headers_property, expected_signature):
+        username, algorithm, headers, signature = request.headers['Authorization'].split(',')
+        with self.subTest():
+            self.assertEqual(self.expected_username, username)
+            self.assertEqual(expected_headers_property, headers)
+            self.assertEqual(self.expected_algorithm, algorithm)
+            self.assertEqual(expected_signature, signature)
+
+    @staticmethod
+    def get_send_message_request():
+        send_message_request = SendMessagesRequest()
+        send_message_request.messages = []
+        send_message_request.messages.append(Message())
+        send_message_request.messages[0].content = 'My tests message'
+        send_message_request.messages[0].destination_number = '+61491570006'
+        send_message_request.messages[0].format = FormatEnum.SMS
+        return send_message_request
+
+    @staticmethod
+    def get_content_hash(request):
+        m = hashlib.md5()
+        m.update(bytes(APIHelper.json_serialize(request), 'utf-8'))
+        content_hash = m.hexdigest()
+        return content_hash