feat(authenticator): Refactor autethnticators

Author: ehdsouza

ibm_cloud_sdk_core/authenticators/__init__.py

@@ -16,7 +16,7 @@
 
 from .authenticator import Authenticator
 from .basic_authenticator import BasicAuthenticator
-from .bearer_authenticator import BearerAuthenticator
-from .cp4d_authenticator import CP4DAuthenticator
-from .iam_authenticator import IAMAuthenticator
-from .no_auth_authenticator import NoAuthAuthenticator
+from .bearer_token_authenticator import BearerTokenAuthenticator
+from .cp4d_authenticator import CloudPakForDataAuthenticator
+from .iam_authenticator import IamAuthenticator
+from .no_auth_authenticator import NoauthAuthenticator

ibm_cloud_sdk_core/authenticators/authenticator.py

@@ -18,9 +18,9 @@
 
 class Authenticator(ABC):
     @abstractmethod
-    def authenticate(self):
+    def authenticate(self, req):
         """
-        Returns the (username, password) or bearer <token>
+        Adds the Authorization header, if applicable
         """
         pass
 
@@ -30,17 +30,3 @@ def validate(self):
         Checks if all the inputs needed are present
         """
         pass
-
-    @abstractmethod
-    def _is_basic_authentication(self):
-        """
-        Return true if basic authentication
-        """
-        pass
-
-    @abstractmethod
-    def _is_bearer_authentication(self):
-        """
-        Return true if bearer authentication
-        """
-        pass

ibm_cloud_sdk_core/authenticators/basic_authenticator.py

@@ -16,6 +16,7 @@
 
 from .authenticator import Authenticator
 from ..utils import has_bad_first_or_last_char
+import base64
 
 
 class BasicAuthenticator(Authenticator):
@@ -43,36 +44,12 @@ def validate(self):
                 'The username and password shouldn\'t start or end with curly brackets or quotes. '
                 'Please remove any surrounding {, }, or \" characters.')
 
-    def authenticate(self):
+    def authenticate(self, req):
         """
-        Returns the username and password tuple
+        Adds the Authorization header, if applicable
         """
-        return (self.username, self.password)
+        authstring = "{0}:{1}".format(self.username, self.password)
+        base64_authorization = base64.b64encode(authstring.encode('utf-8')).decode('utf-8')
 
-    def set_username(self, username):
-        """
-        Sets the username
-        """
-        self.username = username
-        self.validate()
-
-    def set_password(self, password):
-        """
-        Sets the password
-        """
-        self.password = password
-        self.validate()
-
-    def set_username_and_password(self, username, password):
-        """
-        Sets the username and password
-        """
-        self.username = username
-        self.password = password
-        self.validate()
-
-    def _is_basic_authentication(self):
-        return True
-
-    def _is_bearer_authentication(self):
-        return False
+        headers = req.get('headers')
+        headers['Authorization'] = 'Basic {0}'.format(base64_authorization)

ibm_cloud_sdk_core/authenticators/bearer_authenticator.py renamed to ibm_cloud_sdk_core/authenticators/bearer_token_authenticator.py

@@ -18,7 +18,7 @@
 from ..utils import has_bad_first_or_last_char
 
 
-class BearerAuthenticator(Authenticator):
+class BearerTokenAuthenticator(Authenticator):
     authentication_type = 'bearerToken'
 
     def __init__(self, bearer_token):
@@ -35,25 +35,15 @@ def validate(self):
         if self.bearer_token is None:
             raise ValueError('The bearer token shouldn\'t be None.')
 
-        if has_bad_first_or_last_char(self.bearer_token):
-            raise ValueError(
-                'The bearer token shouldn\'t start or end with curly brackets or quotes. '
-                'Please remove any surrounding {, }, or \" characters.')
-
-    def authenticate(self):
+    def authenticate(self, req):
         """
-        Returns the bearer token
+        Adds the Authorization header, if applicable
         """
-        return 'Bearer {0}'.format(self.bearer_token)
+        headers = req.get('headers')
+        headers['Authorization'] = 'Bearer {0}'.format(self.bearer_token)
 
     def set_bearer_token(self, bearer_token):
         """
         Sets the bearer token
         """
         self.bearer_token = bearer_token
-
-    def _is_basic_authentication(self):
-        return False
-
-    def _is_bearer_authentication(self):
-        return True

ibm_cloud_sdk_core/authenticators/cp4d_authenticator.py

@@ -19,7 +19,7 @@
 from ..utils import has_bad_first_or_last_char
 
 
-class CP4DAuthenticator(Authenticator):
+class CloudPakForDataAuthenticator(Authenticator):
     authentication_type = 'cp4d'
 
     def __init__(self,
@@ -48,6 +48,9 @@ def validate(self):
         if self.token_manager.username is None or self.token_manager.password is None:
             raise ValueError('The username and password shouldn\'t be None.')
 
+        if self.token_manager.url is None:
+            raise ValueError('The url shouldn\'t be None.')
+
         if has_bad_first_or_last_char(
                 self.token_manager.username) or has_bad_first_or_last_char(self.token_manager.password):
             raise ValueError(
@@ -59,39 +62,13 @@ def validate(self):
                 'The url shouldn\'t start or end with curly brackets or quotes. '
                 'Please remove any surrounding {, }, or \" characters.')
 
-    def authenticate(self):
+    def authenticate(self, req):
         """
-        Returns the bearer token
+        Adds the Authorization header, if applicable
         """
+        headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
-        return 'Bearer {0}'.format(bearer_token)
-
-    def _is_basic_authentication(self):
-        return False
-
-    def _is_bearer_authentication(self):
-        return True
-
-    def set_username(self, username):
-        """
-        Sets the username
-        """
-        self.token_manager.set_username(username)
-        self.validate()
-
-    def set_password(self, password):
-        """
-        Sets the password
-        """
-        self.token_manager.set_password(password)
-        self.validate()
-
-    def set_url(self, url):
-        """
-        Sets the url
-        """
-        self.token_manager.set_url(url)
-        self.validate()
+        headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
 
     def set_disable_ssl_verification(self, status=False):
         """

ibm_cloud_sdk_core/authenticators/iam_authenticator.py

@@ -19,7 +19,7 @@
 from ..utils import has_bad_first_or_last_char
 
 
-class IAMAuthenticator(Authenticator):
+class IamAuthenticator(Authenticator):
     authentication_type = 'iam'
 
     def __init__(self,
@@ -63,33 +63,15 @@ def validate(self):
             raise ValueError(
                 'Both client id and client secret should be initialized.')
 
-    def authenticate(self):
+    def authenticate(self, req):
         """
-        Returns the bearer token
+        Adds the Authorization header, if applicable
         """
+        headers = req.get('headers')
         bearer_token = self.token_manager.get_token()
-        return 'Bearer {0}'.format(bearer_token)
+        headers['Authorization'] = 'Bearer {0}'.format(bearer_token)
 
-    def _is_basic_authentication(self):
-        return False
-
-    def _is_bearer_authentication(self):
-        return True
-
-    def set_apikey(self, apikey):
-        """
-        Set the IAM api key
-        """
-        self.token_manager.set_apikey(apikey)
-        self.validate()
-
-    def set_url(self, url):
-        """
-        Set the IAM url
-        """
-        self.token_manager.set_url(url)
-
-    def set_authorization_info(self, client_id, client_secret):
+    def set_client_id_and_secret(self, client_id, client_secret):
         """
         Set the IAM authorization information.
         This consists of the client_id and secret.
@@ -98,7 +80,7 @@ def set_authorization_info(self, client_id, client_secret):
         If these values are not supplied, then a default Authorization header
         is used.
         """
-        self.token_manager.set_authorization_info(client_id, client_secret)
+        self.token_manager.set_client_id_and_secret(client_id, client_secret)
         self.validate()
 
     def set_disable_ssl_verification(self, status=False):

ibm_cloud_sdk_core/authenticators/no_auth_authenticator.py

@@ -16,17 +16,11 @@
 
 from .authenticator import Authenticator
 
-class NoAuthAuthenticator(Authenticator):
+class NoauthAuthenticator(Authenticator):
     authentication_type = 'noauth'
 
     def validate(self):
         pass
 
-    def _is_basic_authentication(self):
-        return False
-
-    def _is_bearer_authentication(self):
-        return False
-
-    def authenticate(self):
+    def authenticate(self, req):
         pass

ibm_cloud_sdk_core/cp4d_token_manager.py

@@ -37,7 +37,7 @@ def __init__(self,
         """
         self.username = username
         self.password = password
-        url = url + '/v1/preauth/validateAuth'
+        url = url + '/v1/preauth/validateAuth' if url else None
         self.headers = headers
         self.proxies = proxies
         super(CP4DTokenManager, self).__init__(url, disable_ssl_verification,
@@ -57,24 +57,6 @@ def request_token(self):
             proxies=self.proxies)
         return response
 
-    def set_username(self, username):
-        """
-        Sets the username
-        """
-        self.username = username
-
-    def set_password(self, password):
-        """
-        Sets the password
-        """
-        self.password = password
-
-    def set_url(self, url):
-        """
-        Sets the url
-        """
-        self.url = url
-
     def set_headers(self, headers):
         """
         Sets user-defined headers

ibm_cloud_sdk_core/iam_token_manager.py

@@ -83,19 +83,7 @@ def request_token(self):
             proxies=self.proxies)
         return response
 
-    def set_apikey(self, apikey):
-        """
-        Set the apikey
-        """
-        self.apikey = apikey
-
-    def set_url(self, url):
-        """
-        Set the IAM url
-        """
-        self.url = url
-
-    def set_authorization_info(self, client_id, client_secret):
+    def set_client_id_and_secret(self, client_id, client_secret):
         """
         Set the IAM authorization information.
         This consists of the client_id and secret.

test/test_basic_authenticator.py

@@ -7,19 +7,9 @@ def test_basic_authenticator():
     assert authenticator.username == 'my_username'
     assert authenticator.password == 'my_password'
 
-    authenticator.set_username('bogus')
-    authenticator.set_password('bogus')
-
-    (username, password) = authenticator.authenticate()
-    assert username == 'bogus'
-    assert password == 'bogus'
-
-    authenticator.set_username_and_password('wonder', 'woman')
-    assert authenticator.username == 'wonder'
-    assert authenticator.password == 'woman'
-
-    assert authenticator._is_basic_authentication() is True
-    assert authenticator._is_bearer_authentication() is False
+    request = {'headers': {}}
+    authenticator.authenticate(request)
+    assert request['headers']['Authorization'] == 'Basic bXlfdXNlcm5hbWU6bXlfcGFzc3dvcmQ='
 
 def test_basic_authenticator_validate_failed():
     with pytest.raises(ValueError) as err:

test/test_bearer_authenticator.py

@@ -3,26 +3,21 @@
 import time
 import jwt
 import json
-from ibm_cloud_sdk_core.authenticators import BearerAuthenticator
+from ibm_cloud_sdk_core.authenticators import BearerTokenAuthenticator
 
 def test_bearer_authenticator():
-    authenticator = BearerAuthenticator('my_bearer_token')
+    authenticator = BearerTokenAuthenticator('my_bearer_token')
     assert authenticator is not None
     assert authenticator.bearer_token == 'my_bearer_token'
 
     authenticator.set_bearer_token('james bond')
     assert authenticator.bearer_token == 'james bond'
 
-    assert authenticator._is_basic_authentication() is False
-    assert authenticator._is_bearer_authentication() is True
-
-    assert authenticator.authenticate() == 'Bearer james bond'
+    request = {'headers': {}}
+    authenticator.authenticate(request)
+    assert request['headers']['Authorization'] == 'Bearer james bond'
 
 def test_bearer_validate_failed():
     with pytest.raises(ValueError) as err:
-        BearerAuthenticator(None)
+        BearerTokenAuthenticator(None)
     assert str(err.value) == 'The bearer token shouldn\'t be None.'
-
-    with pytest.raises(ValueError) as err:
-        BearerAuthenticator('{my_bearer_token}')
-    assert str(err.value) == 'The bearer token shouldn\'t start or end with curly brackets or quotes. Please remove any surrounding {, }, or \" characters.'