Adds backwards compat for old style auth objects

sudorandom · sudorandom · commit e115be7233cf · 2014-09-18T18:18:03.000-05:00
diff --git a/SoftLayer/API.py b/SoftLayer/API.py
@@ -6,6 +6,7 @@
     :license: MIT, see LICENSE for more details.
 """
 import time
+import warnings
 
 from SoftLayer import auth as slauth
 from SoftLayer import config
@@ -183,7 +184,14 @@ def call(self, service, method, *args, **kwargs):
         }
 
         if self.auth:
-            options = self.auth.get_options(options)
+            if getattr(self.auth, "get_headers", None):
+                warnings.warn("auth.get_headers() is deprecation and will be "
+                              "removed in the next major version",
+                              DeprecationWarning)
+                headers.update(self.auth.get_headers())
+
+            if getattr(self.auth, "get_options", None):
+                options = self.auth.get_options(options)
 
         return transports.make_xml_rpc_api_call(uri, method, args,
                                                 **options)
diff --git a/SoftLayer/auth.py b/SoftLayer/auth.py
@@ -10,9 +10,22 @@
 
 class AuthenticationBase(object):
     """A base authentication class intended to be overridden."""
+
     def get_options(self, options):
-        """Receives request options and returns request options."""
-        raise NotImplementedError
+        """Receives request options and returns request options.
+
+            :param options dict: dictionary of request options
+
+        """
+        return options
+
+    def get_headers(self):
+        """Return a dictionary of headers to be inserted for authentication.
+
+        .. deprecated:: 3.3.0
+           Use :func:`get_options` instead.
+        """
+        return {}
 
 
 class TokenAuthentication(AuthenticationBase):
diff --git a/SoftLayer/tests/auth_tests.py b/SoftLayer/tests/auth_tests.py
@@ -11,7 +11,8 @@
 class TestAuthenticationBase(testing.TestCase):
     def test_get_options(self):
         auth_base = auth.AuthenticationBase()
-        self.assertRaises(NotImplementedError, auth_base.get_options, {})
+        self.assertEqual(auth_base.get_options({}), {})
+        self.assertEqual(auth_base.get_headers(), {})
 
 
 class TestBasicAuthentication(testing.TestCase):
diff --git a/SoftLayer/tests/deprecated_tests.py b/SoftLayer/tests/deprecated_tests.py
@@ -0,0 +1,33 @@
+"""
+    SoftLayer.tests.depecated_tests
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+    :license: MIT, see LICENSE for more details.
+"""
+import mock
+
+import SoftLayer
+import SoftLayer.API
+from SoftLayer import testing
+
+
+class DeprecatedAuth(SoftLayer.AuthenticationBase):
+    """Auth that only implements get_headers()."""
+
+    def get_headers(self):
+        return {'deprecated': 'header'}
+
+
+class APIClient(testing.TestCase):
+    def set_up(self):
+        self.client = SoftLayer.Client(auth=DeprecatedAuth())
+
+    @mock.patch('SoftLayer.transports.make_xml_rpc_api_call')
+    def test_simple_call(self, make_xml_rpc_api_call):
+        self.client['SERVICE'].METHOD()
+        make_xml_rpc_api_call.assert_called_with(
+            mock.ANY, mock.ANY, mock.ANY,
+            headers={'deprecated': 'header'},
+            proxy=mock.ANY,
+            timeout=mock.ANY,
+            http_headers=mock.ANY)
