fiftyone-ipintelligence-cloud 0.0.1__py3-none-any.whl

fiftyone_ipintelligence_cloud/ipintelligence_cloud.py

@@ -0,0 +1,91 @@
+# *********************************************************************
+# 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 __future__ import absolute_import
+from fiftyone_pipeline_cloudrequestengine.cloudengine import CloudEngine
+from fiftyone_pipeline_core.aspectproperty_value import AspectPropertyValue
+
+# The cloud sends weighted values with a raw 16-bit weighting ("rawweighting",
+# 0-65535, the same field ip-intelligence-dotnet reads into IWeightedValue.
+# RawWeighting). The rest of this SDK - and the on-premise engine's getWeight()
+# - expresses weighting as a 0.0-1.0 proportion, so normalise by the maximum.
+_RAW_WEIGHTING_MAX = 65535
+
+
+class IpIntelligenceCloud(CloudEngine):
+    """!
+    The IP Intelligence cloud engine requires the 51Degrees
+    cloudRequestEngine to be placed in a pipeline before it.
+    It takes that raw JSON response and parses it to extract the
+    IP intelligence part. It also uses this data to generate a list
+    of properties. Weighted properties (e.g. Mcc) are returned as
+    lists of {"value": ..., "weighting": ...} dictionaries, where the
+    cloud's raw 0-65535 weighting is normalised to a 0.0-1.0 proportion
+    so it matches the on-premise engine.
+    """
+    def __init__(self):
+
+        super(IpIntelligenceCloud, self).__init__()
+
+        self.datakey = "ip"
+
+    def process_internal(self, flowdata):
+
+        """!
+        Parse the cloud response via the base engine, then normalise the
+        weighted values so their shape matches the on-premise engine
+        ({"value", "weighting"} with weighting as a 0.0-1.0 proportion).
+        """
+
+        super(IpIntelligenceCloud, self).process_internal(flowdata)
+
+        element_data = flowdata.get(self.datakey)
+
+        weighted_keys = {
+            name.lower()
+            for name, meta in self.properties.items()
+            if "weighted" in str(meta.get("type", "")).lower()
+        }
+
+        for key in weighted_keys:
+            value = element_data.contents.get(key)
+            if value is None or not value.has_value():
+                continue
+            items = value.value()
+            if not isinstance(items, list):
+                continue
+            element_data.contents[key] = AspectPropertyValue(
+                value=[self._normalise_weighting(item) for item in items])
+
+    @staticmethod
+    def _normalise_weighting(item):
+
+        """Convert a single cloud weighted entry, turning the raw 0-65535
+        "rawweighting" field into a 0.0-1.0 "weighting". Entries that already
+        use "weighting" (or are not dictionaries) are left untouched."""
+
+        if not isinstance(item, dict) or "rawweighting" not in item:
+            return item
+        normalised = dict(item)
+        normalised["weighting"] = (
+            normalised.pop("rawweighting") / float(_RAW_WEIGHTING_MAX))
+        return normalised

fiftyone_ipintelligence_cloud/ipintelligence_cloud_pipelinebuilder.py

@@ -0,0 +1,87 @@
+# *********************************************************************
+# 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 __future__ import absolute_import
+from fiftyone_pipeline_core.pipelinebuilder import PipelineBuilder
+from fiftyone_pipeline_cloudrequestengine.cloudrequestengine import CloudRequestEngine
+from .ipintelligence_cloud import IpIntelligenceCloud
+from fiftyone_ipintelligence_shared.utils import merge_two_dicts
+
+class IpIntelligenceCloudPipelineBuilder(PipelineBuilder):
+    """!
+    The IP Intelligence Cloud Pipeline Builder allows you to easily
+    construct a pipeline containing the IP intelligence cloud engine.
+    """
+    def __init__(self, settings = None, **kwargs):
+
+        """!
+
+        Constructor for the IP Intelligence Cloud Pipeline Builder
+
+        General pipeline settings:
+
+        @type javascript_builder_settings: dict
+        @param javascript_builder_settings: parameters for the pipeline's JavaScript builder to populate additional evidence from the clientside.
+            - obj_name: the name of the client side object
+            with the JavaScript properties in it ('fod' by default)
+            - protocol: The protocol ("http" or "https") used by
+            the client side callback url. This can be overridden
+            with header.protocol evidence
+            - host The host of the client side callback url.
+            This can be overridden with header.host evidence.
+            - endpoint The endpoint of the client side callback url
+            * enable_cookies - whether cookies should be enabled
+            * minify: Whether to minify the JavaScript
+        @type cache: Cache
+        @param cache: An instance of the fiftyone.pipeline.engines.cache
+        class
+
+        Cloud Engine Settings:
+
+        @type resource_key: string
+        @param resource_key: the 51Degrees cloud resource key
+        @type cloud_endpoint: string
+        @param cloud_endpoint: the 51Degrees cloud service endpoint to use. Defaults to https://cloud.51degrees.com/api/v4/
+        @type cloud_request_origin: string
+        @param cloud_request_origin: The value to set the Origin header to when making requests to the cloud service
+
+        """
+        if settings is None:
+            settings = {}
+
+        settings = merge_two_dicts(dict(**kwargs), locals())
+
+        settings = merge_two_dicts(settings, settings["settings"])
+
+        del settings["self"]
+
+        super(IpIntelligenceCloudPipelineBuilder, self).__init__(settings)
+
+        # Add specific engines
+
+        self.add(CloudRequestEngine(settings))
+        ip_engine = IpIntelligenceCloud()
+
+        if "cache" in settings:
+            ip_engine.set_cache(settings["cache"])
+
+        self.add(ip_engine)

fiftyone_ipintelligence_cloud-0.0.1.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: fiftyone_ipintelligence_cloud
+Version: 0.0.1
+Summary: 51Degrees IP Intelligence resolves an IP address to detailed location, network and registration information. This package retrieves IP intelligence results by consuming the 51Degrees cloud service.
+Home-page: https://51degrees.com/
+Author: 51Degrees Engineering
+Author-email: engineering@51degrees.com
+License: EUPL-1.2
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+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.8
+Description-Content-Type: text/markdown
+Requires-Dist: fiftyone_ipintelligence_shared
+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 - Cloud
+
+![51Degrees](https://51degrees.com/img/logo.png?utm_source=github&utm_medium=repository&utm_content=readme_main&utm_campaign=python-open-source "Data rewards the curious") **Python IP Intelligence**
+
+[Developer Documentation](https://51degrees.com/ip-intelligence-python/index.html?utm_source=github&utm_medium=repository&utm_content=documentation&utm_campaign=python-open-source "developer documentation")
+
+## Introduction
+
+This package uses the 51Degrees cloud service to resolve IP addresses to
+location, network and registration information using the
+[51Degrees Pipeline API](https://51degrees.com/documentation/index.html).
+
+To use the cloud service you will need a resource key. You can obtain one
+from the [51Degrees Configurator](https://configure.51degrees.com/).
+
+## Usage
+
+```python
+from fiftyone_ipintelligence_cloud.ipintelligence_cloud_pipelinebuilder import IpIntelligenceCloudPipelineBuilder
+
+pipeline = IpIntelligenceCloudPipelineBuilder(resource_key="YOUR_RESOURCE_KEY").build()
+
+flowdata = pipeline.create_flowdata()
+flowdata.evidence.add("query.client-ip-51d", "185.28.167.78")
+flowdata.process()
+
+print(flowdata.ip.registeredname.value())
+```
+
+## Folders
+
+- `fiftyone_ipintelligence_cloud` - the IP intelligence cloud engine and
+  pipeline builder.
+- `tests` - unit tests. These mock the cloud service so no resource key is
+  required; set the `resource_key` environment variable to also run the live
+  cloud integration test.

fiftyone_ipintelligence_cloud-0.0.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+fiftyone_ipintelligence_cloud/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fiftyone_ipintelligence_cloud/ipintelligence_cloud.py,sha256=ItQiK5i3Z7yVaPkuLmxiX1KBPG7QKKgHfqBDVIf1ytw,3884
+fiftyone_ipintelligence_cloud/ipintelligence_cloud_pipelinebuilder.py,sha256=AJ-OfWiBwvrdM3NI5xxh8C_cYdY8_09dJjVD4S1NqXY,3762
+fiftyone_ipintelligence_cloud-0.0.1.dist-info/METADATA,sha256=XNNRQ0whXB4KIo6PimEB6aJ7YqxBDjmaRjIuA8_c8qw,2522
+fiftyone_ipintelligence_cloud-0.0.1.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+fiftyone_ipintelligence_cloud-0.0.1.dist-info/top_level.txt,sha256=suslTymgtuK22xc4T5Yl9nUUOQzXCnKGx9-hiwS4q9o,30
+fiftyone_ipintelligence_cloud-0.0.1.dist-info/RECORD,,

fiftyone_ipintelligence_cloud-0.0.1.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_cloud-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+fiftyone_ipintelligence_cloud