splitio-commons 1.0.0__tar.gz

splitio_commons-1.0.0/LICENSE.txt

@@ -0,0 +1,169 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+   1. Definitions.
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+   END OF TERMS AND CONDITIONS
+   APPENDIX: How to apply the Apache License to your work.
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+   Copyright 2026 Harness Inc 
+   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.

splitio_commons-1.0.0/NOTICE.txt

@@ -0,0 +1,5 @@
+Harness Feature Management Python Commons Copyright 2024-2026 Harness Inc.
+
+This product includes software developed at Harness Inc. (https://harness.io/).
+
+This product includes software originally developed by Split Software, Inc. (https://www.split.io/). Copyright 2015-2024 Split Software, Inc.

splitio_commons-1.0.0/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.1
+Name: splitio_commons
+Version: 1.0.0
+Summary: Splitio Python Commons
+Home-page: https://github.com/splitio/python-commons
+Download-URL: https://github.com/splitio/python-commons/tarball/1.0.0
+Author: Bilal Al-Shahwany
+Author-email: bilal.al-shahwany@harness.io
+License: Apache License 2.0
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 2
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries
+Description-Content-Type: text/markdown
+Provides-Extra: test
+Provides-Extra: redis
+Provides-Extra: uwsgi
+Provides-Extra: cpphash
+Provides-Extra: asyncio
+Provides-Extra: kerberos
+License-File: LICENSE.txt
+License-File: NOTICE.txt
+
+# Python Commons
+
+## Overview
+This Library is designed to work with Harness FME Python SDK, the platform for controlled rollouts, which serves features to your users via a Split definition to manage your complete customer experience.
+
+## Compatibility
+This Library is compatible with **Python 3.7 and higher**.
+
+## Getting started
+
+## Submitting issues
+
+## Contributing
+
+## License
+Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).

splitio_commons-1.0.0/README.md

@@ -0,0 +1,16 @@
+# Python Commons
+
+## Overview
+This Library is designed to work with Harness FME Python SDK, the platform for controlled rollouts, which serves features to your users via a Split definition to manage your complete customer experience.
+
+## Compatibility
+This Library is compatible with **Python 3.7 and higher**.
+
+## Getting started
+
+## Submitting issues
+
+## Contributing
+
+## License
+Licensed under the Apache License, Version 2.0. See: [Apache License](http://www.apache.org/licenses/).

splitio_commons-1.0.0/setup.cfg

@@ -0,0 +1,32 @@
+[wheel]
+universal = 1
+
+[metadata]
+name = splitio_commons
+description = This SDK is designed to work with Split, the platform for controlled rollouts, which serves features to your users via a Split definition to manage your complete customer experience.
+long_description = file: README.md
+long_description_content_type = text/markdown
+
+[flake8]
+max-line-length = 100
+exclude = tests/*
+
+[aliases]
+test = pytest
+
+[tool:pytest]
+addopts = --verbose --cov=splitio_commons --cov-report xml
+python_classes = *Tests
+
+[build_sphinx]
+source-dir = doc/source
+build-dir = doc/build
+all_files = 1
+
+[upload_sphinx]
+upload-dir = doc/build/html
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

splitio_commons-1.0.0/setup.py

@@ -0,0 +1,66 @@
+"""Setup module."""
+# !/usr/bin/env python
+
+from os import path
+from setuptools import setup, find_packages
+import subprocess
+import sys
+
+TESTS_REQUIRES = [
+    'flake8',
+    'pytest==7.0.1',
+    'pytest-mock==3.11.1',
+    'coverage==7.0.0',
+    'pytest-cov==4.1.0',
+    'importlib-metadata==6.7',
+    'tomli==1.2.3',
+    'iniconfig==1.1.1',
+    'attrs==22.1.0',
+    'pytest-asyncio==0.21.0',
+    'aiohttp>=3.8.4',
+    'aiofiles>=23.1.0',
+    'requests-kerberos>=0.15.0',
+    'urllib3==2.0.7'
+]
+
+INSTALL_REQUIRES = [
+    'requests',
+    'pyyaml',
+    'docopt>=0.6.2',
+    'enum34;python_version<"3.4"',
+    'bloom-filter2>=2.0.0'
+]
+
+with open(path.join(path.abspath(path.dirname(__file__)), 'splitio_commons', 'version.py')) as f:
+    exec(f.read())  # pylint: disable=exec-used
+
+setup(
+    name='splitio_commons',
+    version=__version__,  # pylint: disable=undefined-variable
+    description='Splitio Python Commons',
+    author='Bilal Al-Shahwany',
+    author_email='bilal.al-shahwany@harness.io',
+    url='https://github.com/splitio/python-commons',
+    download_url=('https://github.com/splitio/python-commons/tarball/' + __version__),  # pylint: disable=undefined-variable
+    license='Apache License 2.0',
+    install_requires=INSTALL_REQUIRES,
+    tests_require=TESTS_REQUIRES,
+    extras_require={
+        'test': TESTS_REQUIRES,
+        'redis': ['redis>=2.10.5,<7.0.0'],
+        'uwsgi': ['uwsgi>=2.0.0'],
+        'cpphash': ['mmh3cffi==0.2.1'],
+        'asyncio': ['aiohttp>=3.8.4', 'aiofiles>=23.1.0'],
+        'kerberos': ['requests-kerberos>=0.15.0']
+    },
+    setup_requires=['pytest-runner', 'pluggy==1.0.0;python_version<"3.8"'],
+    classifiers=[
+        'Environment :: Console',
+        'Intended Audience :: Developers',
+        'Programming Language :: Python',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 3',
+        'Topic :: Software Development :: Libraries'
+    ],
+    packages=find_packages(exclude=('tests', 'tests.*'))
+)

splitio_commons-1.0.0/splitio_commons/api/__init__.py

@@ -0,0 +1,46 @@
+"""Split API module."""
+
+
+class APIException(Exception):
+    """Exception to raise when an API call fails."""
+
+    def __init__(self, custom_message, status_code=None):
+        """Constructor."""
+        Exception.__init__(self, custom_message)
+        self._status_code = status_code if status_code else -1
+
+    @property
+    def status_code(self):
+        """Return HTTP status code."""
+        return self._status_code
+
+class APIUriException(APIException):
+    """Exception to raise when an API call fails due to 414  http error."""
+
+    def __init__(self, custom_message, status_code=None):
+        """Constructor."""
+        APIException.__init__(self, custom_message, status_code)
+
+def headers_from_metadata(sdk_metadata, client_key=None):
+    """
+    Generate a dict with headers required by data-recording API endpoints.
+    :param sdk_metadata: SDK Metadata object, generated at sdk initialization time.
+    :type sdk_metadata: splitio_commons.client.util.SdkMetadata
+    :param client_key: client key.
+    :type client_key: str
+    :return: A dictionary with headers.
+    :rtype: dict
+    """
+
+    metadata = {
+        'SplitSDKVersion': sdk_metadata.sdk_version,
+        'SplitSDKMachineIP': sdk_metadata.instance_ip,
+        'SplitSDKMachineName': sdk_metadata.instance_name
+    } if sdk_metadata.instance_ip != 'NA' and sdk_metadata.instance_ip != 'unknown' else {
+        'SplitSDKVersion': sdk_metadata.sdk_version,
+    }
+
+    if client_key is not None:
+        metadata['SplitSDKClientKey'] = client_key
+
+    return metadata

splitio_commons-1.0.0/splitio_commons/api/auth.py

@@ -0,0 +1,111 @@
+"""Auth API module."""
+
+import logging
+import json
+
+from splitio_commons.api import APIException, headers_from_metadata
+from splitio_commons.api.commons import headers_from_metadata, record_telemetry
+from splitio_commons.util.time import get_current_epoch_time_ms
+from splitio_commons.api.client import HttpClientException
+from splitio_commons.models.token import from_raw
+from splitio_commons.models.telemetry import HTTPExceptionsAndLatencies
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class AuthAPI(object):  # pylint: disable=too-few-public-methods
+    """Class that uses an httpClient to communicate with the SDK Auth Service API."""
+
+    def __init__(self, client, sdk_key, sdk_metadata, telemetry_runtime_producer, spec_version):
+        """
+        Class constructor.
+
+        :param client: HTTP Client responsble for issuing calls to the backend.
+        :type client: HttpClient
+        :param sdk_key: User sdk key.
+        :type sdk_key: string
+        :param sdk_metadata: SDK version & machine name & IP.
+        :type sdk_metadata: splitio_commons.client.util.SdkMetadata
+        """
+        self._client = client
+        self._sdk_key = sdk_key
+        self._metadata = headers_from_metadata(sdk_metadata)
+        self._telemetry_runtime_producer = telemetry_runtime_producer
+        self._client.set_telemetry_data(HTTPExceptionsAndLatencies.TOKEN, self._telemetry_runtime_producer)
+        self._spec_version = spec_version
+
+    def authenticate(self):
+        """
+        Perform authentication.
+
+        :return: Json representation of an authentication.
+        :rtype: splitio_commons.models.token.Token
+        """
+        try:
+            response = self._client.get(
+                'auth',
+                'v2/auth?s=' + self._spec_version if self._spec_version != None else 'v2/auth',
+                self._sdk_key,
+                extra_headers=self._metadata,
+            )
+            if 200 <= response.status_code < 300:
+                payload = json.loads(response.body)
+                return from_raw(payload)
+
+            else:
+                if (response.status_code >= 400 and response.status_code < 500):
+                    self._telemetry_runtime_producer.record_auth_rejections()
+                raise APIException(response.body, response.status_code)
+        except HttpClientException as exc:
+            _LOGGER.error('Exception raised while authenticating')
+            _LOGGER.debug('Exception information: ', exc_info=True)
+            raise APIException('Could not perform authentication.') from exc
+
+class AuthAPIAsync(object):  # pylint: disable=too-few-public-methods
+    """Async Class that uses an httpClient to communicate with the SDK Auth Service API."""
+
+    def __init__(self, client, sdk_key, sdk_metadata, telemetry_runtime_producer, spec_version):
+        """
+        Class constructor.
+
+        :param client: HTTP Client responsble for issuing calls to the backend.
+        :type client: HttpClient
+        :param sdk_key: User sdk key.
+        :type sdk_key: string
+        :param sdk_metadata: SDK version & machine name & IP.
+        :type sdk_metadata: splitio_commons.client.util.SdkMetadata
+        """
+        self._client = client
+        self._sdk_key = sdk_key
+        self._metadata = headers_from_metadata(sdk_metadata)
+        self._telemetry_runtime_producer = telemetry_runtime_producer
+        self._client.set_telemetry_data(HTTPExceptionsAndLatencies.TOKEN, self._telemetry_runtime_producer)
+        self._spec_version = spec_version
+
+    async def authenticate(self):
+        """
+        Perform authentication.
+
+        :return: Json representation of an authentication.
+        :rtype: splitio_commons.models.token.Token
+        """
+        try:
+            response = await self._client.get(
+                'auth',
+                'v2/auth?s=' + self._spec_version if self._spec_version != None else 'v2/auth',
+                self._sdk_key,
+                extra_headers=self._metadata,
+            )
+            if 200 <= response.status_code < 300:
+                payload = json.loads(response.body)
+                _LOGGER.debug(payload)
+                return from_raw(payload)
+
+            else:
+                if (response.status_code >= 400 and response.status_code < 500):
+                    await self._telemetry_runtime_producer.record_auth_rejections()
+                raise APIException(response.body, response.status_code)
+        except HttpClientException as exc:
+            _LOGGER.error('Exception raised while authenticating')
+            _LOGGER.debug('Exception information: ', exc_info=True)
+            raise APIException('Could not perform authentication.') from exc