ibm-cloud-sdk-core 3.20.3__tar.gz → 3.20.5__tar.gz

ibm_cloud_sdk_core-3.20.5/MANIFEST.in

@@ -0,0 +1 @@
+include LICENSE

{ibm-cloud-sdk-core-3.20.3/ibm_cloud_sdk_core.egg-info → ibm_cloud_sdk_core-3.20.5}/PKG-INFO

@@ -1,27 +1,47 @@
 Metadata-Version: 2.1
 Name: ibm-cloud-sdk-core
-Version: 3.20.3
+Version: 3.20.5
 Summary: Core library used by SDKs for IBM Cloud Services
-Home-page: https://github.com/IBM/python-sdk-core
-Author: IBM
-Author-email: devxsdk@us.ibm.com
-License: Apache 2.0
+Author-email: IBM <devxsdk@us.ibm.com>
+Project-URL: Repository, https://github.com/IBM/python-sdk-core
+Project-URL: Documentation, https://github.com/IBM/python-sdk-core/blob/main/README.md
+Project-URL: Issues, https://github.com/IBM/python-sdk-core/issues
+Project-URL: Changelog, https://github.com/IBM/python-sdk-core/blob/main/CHANGELOG.md
+Project-URL: Contributing, https://github.com/IBM/python-sdk-core/blob/main/CONTRIBUTING.md
+Project-URL: License, https://github.com/IBM/python-sdk-core/blob/main/LICENSE
 Keywords: ibm,cloud,ibm cloud services
-Platform: UNKNOWN
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python_dateutil<3.0.0,>=2.8.2
+Requires-Dist: PyJWT<3.0.0,>=2.8.0
+Provides-Extra: dev
+Requires-Dist: coverage<8.0.0,>=7.3.2; extra == "dev"
+Requires-Dist: pylint<4.0.0,>=3.0.0; extra == "dev"
+Requires-Dist: pytest<8.0.0,>=7.4.2; extra == "dev"
+Requires-Dist: pytest-cov<5.0.0,>=4.1.0; extra == "dev"
+Requires-Dist: responses<1.0.0,>=0.23.3; extra == "dev"
+Requires-Dist: black<25.0.0,>=24.0.0; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
 
 [![Build Status](https://app.travis-ci.com/IBM/python-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/python-sdk-core)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ibm-cloud-sdk-core)](https://pypi.org/project/ibm-cloud-sdk-core/)
@@ -29,7 +49,7 @@ License-File: LICENSE
 [![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-# IBM Python SDK Core Version 3.20.3
+# IBM Python SDK Core Version 3.20.5
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 
@@ -102,5 +122,3 @@ available in [LICENSE](LICENSE).
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).
-
-

{ibm-cloud-sdk-core-3.20.3 → ibm_cloud_sdk_core-3.20.5}/README.md

@@ -4,7 +4,7 @@
 [![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-# IBM Python SDK Core Version 3.20.3
+# IBM Python SDK Core Version 3.20.5
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 

{ibm-cloud-sdk-core-3.20.3 → ibm_cloud_sdk_core-3.20.5}/ibm_cloud_sdk_core/base_service.py

@@ -94,7 +94,7 @@ class BaseService:
         service_url: str = None,
         authenticator: Authenticator = None,
         disable_ssl_verification: bool = False,
-        enable_gzip_compression: bool = False
+        enable_gzip_compression: bool = False,
     ) -> None:
         self.set_service_url(service_url)
         self.http_client = requests.Session()
@@ -364,7 +364,7 @@ class BaseService:
         params: Optional[dict] = None,
         data: Optional[Union[str, dict]] = None,
         files: Optional[Union[Dict[str, Tuple[str]], List[Tuple[str, Tuple[str, ...]]]]] = None,
-        **kwargs
+        **kwargs,
     ) -> dict:
         """Build a dict that represents an HTTP service request.
 

{ibm-cloud-sdk-core-3.20.3 → ibm_cloud_sdk_core-3.20.5}/ibm_cloud_sdk_core/detailed_response.py

@@ -40,7 +40,7 @@ class DetailedResponse:
         *,
         response: Optional[Union[dict, requests.Response]] = None,
         headers: Optional[Dict[str, str]] = None,
-        status_code: Optional[int] = None
+        status_code: Optional[int] = None,
     ) -> None:
         self.result = response
         self.headers = headers

ibm_cloud_sdk_core-3.20.5/ibm_cloud_sdk_core/version.py

@@ -0,0 +1 @@
+__version__ = '3.20.5'

{ibm-cloud-sdk-core-3.20.3 → ibm_cloud_sdk_core-3.20.5/ibm_cloud_sdk_core.egg-info}/PKG-INFO

@@ -1,27 +1,47 @@
 Metadata-Version: 2.1
 Name: ibm-cloud-sdk-core
-Version: 3.20.3
+Version: 3.20.5
 Summary: Core library used by SDKs for IBM Cloud Services
-Home-page: https://github.com/IBM/python-sdk-core
-Author: IBM
-Author-email: devxsdk@us.ibm.com
-License: Apache 2.0
+Author-email: IBM <devxsdk@us.ibm.com>
+Project-URL: Repository, https://github.com/IBM/python-sdk-core
+Project-URL: Documentation, https://github.com/IBM/python-sdk-core/blob/main/README.md
+Project-URL: Issues, https://github.com/IBM/python-sdk-core/issues
+Project-URL: Changelog, https://github.com/IBM/python-sdk-core/blob/main/CHANGELOG.md
+Project-URL: Contributing, https://github.com/IBM/python-sdk-core/blob/main/CONTRIBUTING.md
+Project-URL: License, https://github.com/IBM/python-sdk-core/blob/main/LICENSE
 Keywords: ibm,cloud,ibm cloud services
-Platform: UNKNOWN
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: requests<3.0.0,>=2.31.0
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python_dateutil<3.0.0,>=2.8.2
+Requires-Dist: PyJWT<3.0.0,>=2.8.0
+Provides-Extra: dev
+Requires-Dist: coverage<8.0.0,>=7.3.2; extra == "dev"
+Requires-Dist: pylint<4.0.0,>=3.0.0; extra == "dev"
+Requires-Dist: pytest<8.0.0,>=7.4.2; extra == "dev"
+Requires-Dist: pytest-cov<5.0.0,>=4.1.0; extra == "dev"
+Requires-Dist: responses<1.0.0,>=0.23.3; extra == "dev"
+Requires-Dist: black<25.0.0,>=24.0.0; extra == "dev"
+Provides-Extra: publish
+Requires-Dist: build; extra == "publish"
+Requires-Dist: twine; extra == "publish"
 
 [![Build Status](https://app.travis-ci.com/IBM/python-sdk-core.svg?branch=main)](https://app.travis-ci.com/IBM/python-sdk-core)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ibm-cloud-sdk-core)](https://pypi.org/project/ibm-cloud-sdk-core/)
@@ -29,7 +49,7 @@ License-File: LICENSE
 [![CLA assistant](https://cla-assistant.io/readme/badge/ibm/python-sdk-core)](https://cla-assistant.io/ibm/python-sdk-core)
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
-# IBM Python SDK Core Version 3.20.3
+# IBM Python SDK Core Version 3.20.5
 This project contains core functionality required by Python code generated by the IBM Cloud OpenAPI SDK Generator
 (openapi-sdkgen).
 
@@ -102,5 +122,3 @@ available in [LICENSE](LICENSE).
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md).
-
-

ibm_cloud_sdk_core-3.20.5/ibm_cloud_sdk_core.egg-info/SOURCES.txt

@@ -0,0 +1,39 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+ibm_cloud_sdk_core/__init__.py
+ibm_cloud_sdk_core/api_exception.py
+ibm_cloud_sdk_core/base_service.py
+ibm_cloud_sdk_core/detailed_response.py
+ibm_cloud_sdk_core/get_authenticator.py
+ibm_cloud_sdk_core/http_adapter.py
+ibm_cloud_sdk_core/private_helpers.py
+ibm_cloud_sdk_core/utils.py
+ibm_cloud_sdk_core/version.py
+ibm_cloud_sdk_core.egg-info/PKG-INFO
+ibm_cloud_sdk_core.egg-info/SOURCES.txt
+ibm_cloud_sdk_core.egg-info/dependency_links.txt
+ibm_cloud_sdk_core.egg-info/requires.txt
+ibm_cloud_sdk_core.egg-info/top_level.txt
+test/test_api_exception.py
+test/test_authenticator.py
+test/test_base_service.py
+test/test_basic_authenticator.py
+test/test_bearer_authenticator.py
+test/test_container_authenticator.py
+test/test_container_token_manager.py
+test/test_cp4d_authenticator.py
+test/test_cp4d_token_manager.py
+test/test_detailed_response.py
+test/test_http_adapter.py
+test/test_iam_authenticator.py
+test/test_iam_token_manager.py
+test/test_jwt_token_manager.py
+test/test_mcsp_authenticator.py
+test/test_mcsp_token_manager.py
+test/test_no_auth_authenticator.py
+test/test_token_manager.py
+test/test_utils.py
+test/test_vpc_instance_authenticator.py
+test/test_vpc_instance_token_manager.py

ibm_cloud_sdk_core-3.20.5/ibm_cloud_sdk_core.egg-info/requires.txt

@@ -0,0 +1,16 @@
+requests<3.0.0,>=2.31.0
+urllib3<3.0.0,>=2.1.0
+python_dateutil<3.0.0,>=2.8.2
+PyJWT<3.0.0,>=2.8.0
+
+[dev]
+coverage<8.0.0,>=7.3.2
+pylint<4.0.0,>=3.0.0
+pytest<8.0.0,>=7.4.2
+pytest-cov<5.0.0,>=4.1.0
+responses<1.0.0,>=0.23.3
+black<25.0.0,>=24.0.0
+
+[publish]
+build
+twine

ibm_cloud_sdk_core-3.20.5/ibm_cloud_sdk_core.egg-info/top_level.txt

@@ -0,0 +1 @@
+ibm_cloud_sdk_core

ibm_cloud_sdk_core-3.20.5/pyproject.toml

@@ -0,0 +1,66 @@
+[project]
+name = "ibm-cloud-sdk-core"
+version = "3.20.5"
+authors = [
+    { name="IBM", email="devxsdk@us.ibm.com" }
+]
+description = "Core library used by SDKs for IBM Cloud Services"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+]
+keywords=["ibm", "cloud", "ibm cloud services"]
+dependencies = [
+    "requests>=2.31.0,<3.0.0",
+    "urllib3>=2.1.0,<3.0.0",
+    "python_dateutil>=2.8.2,<3.0.0",
+    "PyJWT>=2.8.0,<3.0.0",
+]
+
+[project.urls]
+Repository = "https://github.com/IBM/python-sdk-core"
+Documentation = "https://github.com/IBM/python-sdk-core/blob/main/README.md"
+Issues = "https://github.com/IBM/python-sdk-core/issues"
+Changelog = "https://github.com/IBM/python-sdk-core/blob/main/CHANGELOG.md"
+Contributing = "https://github.com/IBM/python-sdk-core/blob/main/CONTRIBUTING.md"
+License = "https://github.com/IBM/python-sdk-core/blob/main/LICENSE"
+
+[project.optional-dependencies]
+dev = [
+    "coverage>=7.3.2,<8.0.0",
+    "pylint>=3.0.0,<4.0.0",
+    "pytest>=7.4.2,<8.0.0",
+    "pytest-cov>=4.1.0,<5.0.0",
+    "responses>=0.23.3,<1.0.0",
+    "black>=24.0.0,<25.0.0",
+]
+publish = [
+    "build",
+    "twine"
+]
+
+[build-system]
+requires = ["setuptools>=67.7.2"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["ibm_cloud_sdk_core"]
+
+[tool.black]
+line-length = 120
+skip-string-normalization = true

{ibm-cloud-sdk-core-3.20.3 → ibm_cloud_sdk_core-3.20.5}/test/test_http_adapter.py

@@ -8,7 +8,7 @@ from typing import Callable
 
 import pytest
 import urllib3
-from requests.exceptions import SSLError
+from requests import exceptions
 
 from ibm_cloud_sdk_core.base_service import BaseService
 from ibm_cloud_sdk_core.authenticators import NoAuthAuthenticator
@@ -71,7 +71,7 @@ def test_tls_v1_1():
     with pytest.raises(Exception) as exception:
         service.send(prepped, verify=cert)
     # Errors can be differ based on the Python version.
-    assert exception.type is SSLError or exception.type is ConnectionError
+    assert exception.type is exceptions.SSLError or exception.type is exceptions.ConnectionError
 
 
 @_local_server(PROTOCOL_TLSv1_2, 3334)
@@ -82,7 +82,7 @@ def test_tls_v1_2():
     # It should fail due to the self-signed SSL cert.
     assert service.disable_ssl_verification is False
     prepped = service.prepare_request('GET', url='/')
-    with pytest.raises(SSLError, match='certificate verify failed: self-signed certificate'):
+    with pytest.raises(exceptions.SSLError, match='certificate verify failed: self-signed certificate'):
         res = service.send(prepped)
 
     # Next configure it to validate by using our local certificate. Should raise no exception.

ibm-cloud-sdk-core-3.20.3/MANIFEST.in

@@ -1,3 +0,0 @@
-include requirements.txt
-include requirements-dev.txt
-include LICENSE

ibm-cloud-sdk-core-3.20.3/ibm_cloud_sdk_core/authenticators/__init__.py

@@ -1,44 +0,0 @@
-# coding: utf-8
-
-# Copyright 2019 IBM All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-"""The ibm_cloud_sdk_core project supports the following types of authentication:
-
-  Basic Authentication
-  Bearer Token
-  Identity and Access Management (IAM)
-  Cloud Pak for Data
-  No Authentication
-
-  The authentication types that are appropriate for a particular service may vary from service to service.
-  Each authentication type is implemented as an Authenticator for consumption by a service.
-
-classes:
-  Authenticator: Abstract Base Class. Implement this interface to provide custom authentication schemes to services.
-  BasicAuthenticator: Authenticator for passing supplied basic authentication information to service endpoint.
-  BearerTokenAuthenticator: Authenticator for passing supplied bearer token to service endpoint.
-  CloudPakForDataAuthenticator: Authenticator for passing CP4D authentication information to service endpoint.
-  IAMAuthenticator: Authenticator for passing IAM authentication information to service endpoint.
-  NoAuthAuthenticator: Performs no authentication. Useful for testing purposes.
-"""
-
-from .authenticator import Authenticator
-from .basic_authenticator import BasicAuthenticator
-from .bearer_token_authenticator import BearerTokenAuthenticator
-from .container_authenticator import ContainerAuthenticator
-from .cp4d_authenticator import CloudPakForDataAuthenticator
-from .iam_authenticator import IAMAuthenticator
-from .vpc_instance_authenticator import VPCInstanceAuthenticator
-from .no_auth_authenticator import NoAuthAuthenticator
-from .mcsp_authenticator import MCSPAuthenticator

ibm-cloud-sdk-core-3.20.3/ibm_cloud_sdk_core/authenticators/authenticator.py

@@ -1,58 +0,0 @@
-# coding: utf-8
-
-# Copyright 2019, 2023 IBM All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from abc import ABC, abstractmethod
-
-
-class Authenticator(ABC):
-    """This interface defines the common methods and constants associated with an Authenticator implementation."""
-
-    # Constants representing the various authenticator types.
-    AUTHTYPE_BASIC = 'basic'
-    AUTHTYPE_BEARERTOKEN = 'bearerToken'
-    AUTHTYPE_IAM = 'iam'
-    AUTHTYPE_CONTAINER = 'container'
-    AUTHTYPE_CP4D = 'cp4d'
-    AUTHTYPE_VPC = 'vpc'
-    AUTHTYPE_NOAUTH = 'noAuth'
-    AUTHTYPE_MCSP = 'mcsp'
-    AUTHTYPE_UNKNOWN = 'unknown'
-
-    @abstractmethod
-    def authenticate(self, req: dict) -> None:
-        """Perform the necessary authentication steps for the specified request.
-
-        Attributes:
-            req (dict): Will be modified to contain the appropriate authentication information.
-
-        To be implemented by subclasses.
-        """
-        pass
-
-    @abstractmethod
-    def validate(self) -> None:
-        """Validates the current set of configuration information in the Authenticator.
-
-        Raises:
-            ValueError: The configuration information is not valid for service operations.
-
-        To be implemented by subclasses.
-        """
-        pass
-
-    def authentication_type(self) -> str:
-        """Returns the authenticator's type.  This method should be overridden by each authenticator implementation."""
-        return self.AUTHTYPE_UNKNOWN

ibm-cloud-sdk-core-3.20.3/ibm_cloud_sdk_core/authenticators/basic_authenticator.py

@@ -1,83 +0,0 @@
-# coding: utf-8
-
-# Copyright 2019 IBM All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import base64
-from requests import Request
-
-from .authenticator import Authenticator
-from ..utils import has_bad_first_or_last_char
-
-
-class BasicAuthenticator(Authenticator):
-    """The BasicAuthenticator is used to add basic authentication information to requests.
-
-    Basic Authorization will be sent as an Authorization header in the form:
-
-        Authorization: Basic <encoded username and password>
-
-    Args:
-        username: User-supplied username for basic auth.
-        password: User-supplied password for basic auth.
-
-    Raises:
-        ValueError: The username or password is not specified or contains invalid characters.
-    """
-
-    def __init__(self, username: str, password: str) -> None:
-        self.username = username
-        self.password = password
-        self.validate()
-        self.authorization_header = self.__construct_basic_auth_header()
-
-    def authentication_type(self) -> str:
-        """Returns this authenticator's type ('basic')."""
-        return Authenticator.AUTHTYPE_BASIC
-
-    def validate(self) -> None:
-        """Validate username and password.
-
-        Ensure the username and password are valid for service operations.
-
-        Raises:
-            ValueError: The username and/or password is not valid for service operations.
-        """
-        if self.username is None or self.password is None:
-            raise ValueError('The username and password shouldn\'t be None.')
-
-        if has_bad_first_or_last_char(self.username) or has_bad_first_or_last_char(self.password):
-            raise ValueError(
-                'The username and password shouldn\'t start or end with curly brackets or quotes. '
-                'Please remove any surrounding {, }, or \" characters.'
-            )
-
-    def __construct_basic_auth_header(self) -> str:
-        authstring = "{0}:{1}".format(self.username, self.password)
-        base64_authorization = base64.b64encode(authstring.encode('utf-8')).decode('utf-8')
-        return 'Basic {0}'.format(base64_authorization)
-
-    def authenticate(self, req: Request) -> None:
-        """Add basic authentication information to a request.
-
-        Basic Authorization will be added to the request's headers in the form:
-
-            Authorization: Basic <encoded username and password>
-
-        Args:
-            req: The request to add basic auth information to. Must contain a key to a dictionary
-            called headers.
-        """
-        headers = req.get('headers')
-        headers['Authorization'] = self.authorization_header

ibm-cloud-sdk-core-3.20.3/ibm_cloud_sdk_core/authenticators/bearer_token_authenticator.py

@@ -1,80 +0,0 @@
-# coding: utf-8
-
-# Copyright 2019 IBM All Rights Reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-from requests import Request
-
-from .authenticator import Authenticator
-
-
-class BearerTokenAuthenticator(Authenticator):
-    """The BearerTokenAuthenticator will add a user-supplied bearer token
-    to requests.
-
-    The bearer token will be sent as an Authorization header in the form:
-
-         Authorization: Bearer <bearer-token>
-
-    Args:
-        bearer_token: The user supplied bearer token.
-
-    Raises:
-        ValueError: Bearer token is none.
-    """
-
-    def __init__(self, bearer_token: str) -> None:
-        self.bearer_token = bearer_token
-        self.validate()
-
-    def authentication_type(self) -> str:
-        """Returns this authenticator's type ('bearertoken')."""
-        return Authenticator.AUTHTYPE_BEARERTOKEN
-
-    def validate(self) -> None:
-        """Validate the bearer token.
-
-        Ensures the bearer token is valid for service operations.
-
-        Raises:
-            ValueError: The bearer token is not valid for service operations.
-        """
-        if self.bearer_token is None:
-            raise ValueError('The bearer token shouldn\'t be None.')
-
-    def authenticate(self, req: Request) -> None:
-        """Adds bearer authentication information to the request.
-
-        The bearer token will be added to the request's headers in the form:
-
-            Authorization: Bearer <bearer-token>
-
-        Args:
-            req: The request to add bearer authentication information to. Must contain a key to a dictionary
-            called headers.
-        """
-        headers = req.get('headers')
-        headers['Authorization'] = 'Bearer {0}'.format(self.bearer_token)
-
-    def set_bearer_token(self, bearer_token: str) -> None:
-        """Set a new bearer token to be sent in subsequent service operations.
-
-        Args:
-            bearer_token: The bearer token that will be sent in service requests.
-
-        Raises:
-            ValueError: The bearer token is not valid for service operations.
-        """
-        self.bearer_token = bearer_token
-        self.validate()