Merge pull request #39 from Mastercard/feature/sign-prepared-request

OAuthSigner.sign_request can sign Request and PreparedRequest objects

Author: ech0s7r

README.md

@@ -95,7 +95,7 @@ Usage briefly described below, but you can also refer to the test project for ex
 
 #### Requests: HTTP for Humans™ <a name="requests"></a>
 
-You can sign [request](https://2.python-requests.org/en/v1.0.0/user/quickstart/#make-a-request) objects using the `OAuthSigner` class. 
+You can sign [request](https://docs.python-requests.org/en/latest/user/quickstart#make-a-request) objects using the `OAuthSigner` class. 
 
 Usage:
 ```python

oauth1/signer.py

@@ -25,6 +25,8 @@
 # IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 # SUCH DAMAGE.
 #
+from requests import PreparedRequest
+
 from oauth1.oauth import OAuth
 
 
@@ -35,8 +37,9 @@ def __init__(self, consumer_key, signing_key):
         self.signing_key = signing_key
 
     def sign_request(self, uri, request):
+        body = request.body if isinstance(request, PreparedRequest) else request.data
         #  Generates the OAuth header for the request, adds the header to the request and returns the request object
-        oauth_key = OAuth.get_authorization_header(uri, request.method, request.data, self.consumer_key,
+        oauth_key = OAuth.get_authorization_header(uri, request.method, body, self.consumer_key,
                                                    self.signing_key)
         request.headers["Authorization"] = oauth_key
         return request

tests/test_signer.py

@@ -27,28 +27,52 @@
 # SUCH DAMAGE.
 #
 import unittest
-from requests import Request
-from oauth1.signer import OAuthSigner
+from unittest.mock import patch
+
+import requests
+from requests import Request, Session
+from requests.auth import AuthBase
+
 import oauth1.authenticationutils as authenticationutils
+from oauth1.signer import OAuthSigner
 
 
 class SignerTest(unittest.TestCase):
+    signing_key = authenticationutils.load_signing_key('./test_key_container.p12', "Password1")
+    consumer_key = 'dummy'
+    uri = "https://sandbox.api.mastercard.com/fraud/merchant/v1/termination-inquiry?Format=XML&PageOffset=0"
 
     def test_sign_request(self):
-        signing_key = authenticationutils.load_signing_key('./test_key_container.p12', "Password1")
-        consumer_key = 'dummy'
-        uri = "https://sandbox.api.mastercard.com/fraud/merchant/v1/termination-inquiry?Format=XML&PageOffset=0"
-
         request = Request()
         request.method = "POST"
         request.data = ""
 
-        signer = OAuthSigner(consumer_key, signing_key)
-        request = signer.sign_request(uri, request)
+        signer = OAuthSigner(SignerTest.consumer_key, SignerTest.signing_key)
+        request = signer.sign_request(SignerTest.uri, request)
         auth_header = request.headers['Authorization']
         self.assertTrue("OAuth" in auth_header)
         self.assertTrue("dummy" in auth_header)
 
+    @patch.object(Session, 'send')
+    def test_sign_prepared_request(self, mock_send):
+        class MCSigner(AuthBase):
+            def __init__(self, consumer_key, signing_key):
+                self.signer = OAuthSigner(consumer_key, signing_key)
+
+            def __call__(self, request):
+                self.signer.sign_request(request.url, request)
+                return request
+
+        signer = MCSigner(SignerTest.consumer_key, SignerTest.signing_key)
+        requests.get(SignerTest.uri, auth=signer)
+
+        auth_header = (
+            mock_send.call_args[0][0].headers if isinstance(mock_send.call_args, tuple) else mock_send.call_args.args
+            [0].headers)['Authorization']
+
+        self.assertTrue("OAuth" in auth_header)
+        self.assertTrue("oauth_consumer_key=\"dummy\"" in auth_header)
+
 
 if __name__ == '__main__':
     unittest.main()