fiftyone-ipintelligence-shared 4.5.0__py3-none-any.whl

fiftyone_ipintelligence_shared/constants.py

@@ -0,0 +1,52 @@
+# *********************************************************************
+# This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+# Copyright 2026 51 Degrees Mobile Experts Limited, Davidson House,
+# Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+#
+# This Original Work is licensed under the European Union Public Licence
+# (EUPL) v.1.2 and is subject to its terms as set out below.
+#
+# If a copy of the EUPL was not distributed with this file, You can obtain
+# one at https://opensource.org/licenses/EUPL-1.2.
+#
+# The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+# amended by the European Commission) shall be deemed incompatible for
+# the purposes of the Work and the provisions of the compatibility
+# clause in Article 5 of the EUPL shall not apply.
+#
+# If using the Work as, or as part of, a network application, by
+# including the attribution notice(s) required under Article 5 of the EUPL
+# in the end user terms of the application under an appropriate heading,
+# such notice(s) shall fulfill the requirements of that article.
+# *********************************************************************
+
+from fiftyone_pipeline_cloudrequestengine.constants import Constants as CoreConstants
+
+# Class containing values for commonly used evidence keys
+class Constants:
+
+    # The suffix that is used to identify a client IP address in evidence.
+    EVIDENCE_CLIENT_IP_SUFFIX = "client-ip"
+
+    # The complete key for supplying a client IP address as query evidence.
+    EVIDENCE_QUERY_CLIENT_IP_KEY = (
+        CoreConstants.EVIDENCE_QUERY_PREFIX +
+        CoreConstants.EVIDENCE_SEPERATOR +
+        EVIDENCE_CLIENT_IP_SUFFIX)
+
+    # The complete key for supplying a client IP address as server evidence.
+    EVIDENCE_SERVER_CLIENT_IP_KEY = (
+        "server" +
+        CoreConstants.EVIDENCE_SEPERATOR +
+        EVIDENCE_CLIENT_IP_SUFFIX)
+
+    # The suffix that is used to supply a client IP address to the
+    # 51Degrees cloud service in evidence.
+    EVIDENCE_CLIENT_IP_51D_SUFFIX = "client-ip-51d"
+
+    # The complete key for supplying a client IP address as query
+    # evidence to the 51Degrees cloud service.
+    EVIDENCE_QUERY_CLIENT_IP_51D_KEY = (
+        CoreConstants.EVIDENCE_QUERY_PREFIX +
+        CoreConstants.EVIDENCE_SEPERATOR +
+        EVIDENCE_CLIENT_IP_51D_SUFFIX)

fiftyone_ipintelligence_shared/example_constants.py

@@ -0,0 +1,49 @@
+# *********************************************************************
+# This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+# Copyright 2026 51 Degrees Mobile Experts Limited, Davidson House,
+# Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+#
+# This Original Work is licensed under the European Union Public Licence
+# (EUPL) v.1.2 and is subject to its terms as set out below.
+#
+# If a copy of the EUPL was not distributed with this file, You can obtain
+# one at https://opensource.org/licenses/EUPL-1.2.
+#
+# The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+# amended by the European Commission) shall be deemed incompatible for
+# the purposes of the Work and the provisions of the compatibility
+# clause in Article 5 of the EUPL shall not apply.
+#
+# If using the Work as, or as part of, a network application, by
+# including the attribution notice(s) required under Article 5 of the EUPL
+# in the end user terms of the application under an appropriate heading,
+# such notice(s) shall fulfill the requirements of that article.
+# *********************************************************************
+
+# Example IP addresses to use as evidence. The cloud engine expects the
+# address under "query.client-ip-51d", the on-premise engine accepts
+# "query.client-ip" or "server.client-ip" (and other parseable evidence).
+# These values mirror the .NET examples' ExampleUtils.EvidenceValues.
+EVIDENCE_VALUES = [
+        # An IPv4 address.
+        { "query.client-ip": "116.154.188.222" },
+        # An IPv4 address.
+        { "query.client-ip": "1.3.32.31" },
+        # An IPv4 address.
+        { "query.client-ip": "45.236.48.61" },
+        # An IPv6 address.
+        { "query.client-ip": "2001:0db8:085a:0000:0000:8a2e:0370:7334" },
+    ]
+
+# Note: the .NET examples' Constants.cs still uses the legacy name
+# "51Degrees-EnterpriseIpiV41.ipi", but the published enterprise/ASN data
+# files use the "IPIV4" infix (cf. 51Degrees-IPIV4AsnIpiV41.ipi in the
+# ip-intelligence-data repo), so the current name is used here.
+ENTERPRISE_DATAFILE_NAME = '51Degrees-IPIV4EnterpriseIpiV41.ipi'
+LITE_DATAFILE_NAME = '51Degrees-LiteIpiV41.ipi'
+# The ASN data file is the freely available data file committed
+# to the ip-intelligence-data submodule. It only contains the network
+# (ASN) properties, but is useful for testing the on-premise engine against
+# the current data format without an enterprise data file.
+ASN_DATAFILE_NAME = '51Degrees-IPIV4AsnIpiV41.ipi'
+EVIDENCE_FILE_NAME = 'evidence.yml'

fiftyone_ipintelligence_shared/key_utils.py

@@ -0,0 +1,31 @@
+# *********************************************************************
+# This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+# Copyright 2026 51 Degrees Mobile Experts Limited, Davidson House,
+# Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+#
+# This Original Work is licensed under the European Union Public Licence
+# (EUPL) v.1.2 and is subject to its terms as set out below.
+#
+# If a copy of the EUPL was not distributed with this file, You can obtain
+# one at https://opensource.org/licenses/EUPL-1.2.
+#
+# The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+# amended by the European Commission) shall be deemed incompatible for
+# the purposes of the Work and the provisions of the compatibility
+# clause in Article 5 of the EUPL shall not apply.
+#
+# If using the Work as, or as part of, a network application, by
+# including the attribution notice(s) required under Article 5 of the EUPL
+# in the end user terms of the application under an appropriate heading,
+# such notice(s) shall fulfill the requirements of that article.
+# *********************************************************************
+
+import os
+
+
+class KeyUtils:
+	# Obtain a key either from environment variable or from a property.
+	# Try resource key as env var, then as upper case env var, the system property
+	@staticmethod
+	def get_named_key(key_name):
+		return os.environ.get(key_name) or os.environ.get(key_name.upper())

fiftyone_ipintelligence_shared/utils.py

@@ -0,0 +1,51 @@
+# *********************************************************************
+# This Original Work is copyright of 51 Degrees Mobile Experts Limited.
+# Copyright 2026 51 Degrees Mobile Experts Limited, Davidson House,
+# Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
+#
+# This Original Work is licensed under the European Union Public Licence
+# (EUPL) v.1.2 and is subject to its terms as set out below.
+#
+# If a copy of the EUPL was not distributed with this file, You can obtain
+# one at https://opensource.org/licenses/EUPL-1.2.
+#
+# The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
+# amended by the European Commission) shall be deemed incompatible for
+# the purposes of the Work and the provisions of the compatibility
+# clause in Article 5 of the EUPL shall not apply.
+#
+# If using the Work as, or as part of, a network application, by
+# including the attribution notice(s) required under Article 5 of the EUPL
+# in the end user terms of the application under an appropriate heading,
+# such notice(s) shall fulfill the requirements of that article.
+# *********************************************************************
+def merge_two_dicts(x, y):
+    z = x.copy()
+    z.update(y)
+    return z
+
+
+def get_value_type(value):
+    if type(value) is bool:
+        value_type = "Boolean"
+    elif type(value) is int:
+        value_type = "Int32"
+    elif type(value) is str:
+        value_type = "String"
+    elif type(value) is float:
+        value_type = "Double"
+    elif type(value) is list:
+        value_type = "Array"
+    elif isinstance(type(value), list):
+        value_type = "String[]"
+    else:
+        value_type = ""
+    return value_type
+
+def is_same_type(value, expected_type):
+    valueType = get_value_type(value)
+    valid = (valueType == expected_type)
+
+    if not valid:
+        valid = True if valueType == "String" and expected_type == "JavaScript" else False
+    return valid

fiftyone_ipintelligence_shared-4.5.0.dist-info/METADATA

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: fiftyone_ipintelligence_shared
+Version: 4.5.0
+Summary: Shared code used by the cloud and on-premise variants of the 51Degrees IP Intelligence engines for the 51Degrees Pipeline API.
+Home-page: https://51degrees.com/?utm_source=pypi&utm_medium=package&utm_campaign=51degrees-python&utm_content=fiftyone_ipintelligence_shared-setup.py&utm_term=url
+Author: 51Degrees Engineering
+Author-email: engineering@51degrees.com
+License: EUPL-1.2
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: License :: OSI Approved :: European Union Public Licence 1.2 (EUPL 1.2)
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: fiftyone_pipeline_core
+Requires-Dist: fiftyone_pipeline_engines
+Requires-Dist: fiftyone_pipeline_cloudrequestengine
+Requires-Dist: fiftyone_pipeline_engines_fiftyone
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 51Degrees IP Intelligence Engines - Shared
+
+![51Degrees](https://51degrees.com/img/logo.png?utm_source=github&utm_medium=readme&utm_campaign=51degrees-python&utm_content=fiftyone_ipintelligence_shared-readme.md&utm_term=51degrees-ip-intelligence-engines-shared "Data rewards the curious") **Python IP Intelligence**
+
+[Developer Documentation](https://51degrees.com/ip-intelligence-python/index.html?utm_source=github&utm_medium=readme&utm_campaign=51degrees-python&utm_content=fiftyone_ipintelligence_shared-readme.md&utm_term=51degrees-ip-intelligence-engines-shared "developer documentation")
+
+## Introduction
+
+This package contains shared code used by both the cloud and on-premise
+variants of the 51Degrees IP intelligence engines for the
+[51Degrees Pipeline API](https://51degrees.com/documentation/index.html?utm_source=github&utm_medium=readme&utm_campaign=51degrees-python&utm_content=fiftyone_ipintelligence_shared-readme.md&utm_term=introduction).
+
+It is not intended to be used directly. See
+[fiftyone_ipintelligence](https://pypi.org/project/fiftyone-ipintelligence/)
+instead.
+
+## Folders
+
+- `fiftyone_ipintelligence_shared` - contains evidence key constants, example
+  constants and utility functions shared by the IP intelligence packages.
+- `tests` - unit tests.
+
+## Requirements
+
+* Python 3.8+
+* The `fiftyone_pipeline_core`, `fiftyone_pipeline_engines`,
+  `fiftyone_pipeline_cloudrequestengine` and
+  `fiftyone_pipeline_engines_fiftyone` packages

fiftyone_ipintelligence_shared-4.5.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+fiftyone_ipintelligence_shared/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fiftyone_ipintelligence_shared/constants.py,sha256=u4o8CmtuC0UB3nQrW5gb5GnLzEZamX0ctUWnAJvrZNA,2336
+fiftyone_ipintelligence_shared/example_constants.py,sha256=HFC8iMfiZFhZozKBoUqRCU66wC6VElVUQpymW4D6Zsw,2537
+fiftyone_ipintelligence_shared/key_utils.py,sha256=AH2-Vp2Pgrc5oHqnCsySuG-2g-HCoAlSOTN1vT4UAfo,1449
+fiftyone_ipintelligence_shared/utils.py,sha256=-gRgrU9zXOlSZ88wrWcCx7G4p80ZpTiwYgO0Fz20c5U,1929
+fiftyone_ipintelligence_shared-4.5.0.dist-info/METADATA,sha256=FX4jKGxENv4bFPe4yD4lcik6DFqk2ksELKWjQaTOzhQ,3002
+fiftyone_ipintelligence_shared-4.5.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+fiftyone_ipintelligence_shared-4.5.0.dist-info/top_level.txt,sha256=AAD-7d6OKL79p_YM0El2hu25QS8whv-pvPs0XuG7cAE,31
+fiftyone_ipintelligence_shared-4.5.0.dist-info/RECORD,,

fiftyone_ipintelligence_shared-4.5.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fiftyone_ipintelligence_shared-4.5.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+fiftyone_ipintelligence_shared