fiftyone-devicedetection-cloud 4.5.80__tar.gz → 4.5.82__tar.gz

{fiftyone_devicedetection_cloud-4.5.80 → fiftyone_devicedetection_cloud-4.5.82}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fiftyone_devicedetection_cloud
-Version: 4.5.80
+Version: 4.5.82
 Summary: 51Degrees Device Detection parses HTTP headers to return detailed hardware, operating system, browser, and crawler information for the devices used to access your website or service. This package retrieves device detection results by consuming the 51Degrees cloud service.
 Home-page: https://51degrees.com/?utm_source=pypi&utm_medium=package&utm_campaign=device-detection-python&utm_content=fiftyone_devicedetection_cloud-setup.py&utm_term=url
 Author: 51Degrees Engineering

fiftyone_devicedetection_cloud-4.5.82/src/fiftyone_devicedetection_cloud/hardwareprofile_cloud.py

@@ -0,0 +1,117 @@
+# *********************************************************************
+# 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_engines.aspectdata_dictionary import AspectDataDictionary
+from fiftyone_pipeline_core.aspectproperty_value import AspectPropertyValue
+
+import json
+
+# The suffix the cloud service adds to a property name to carry the reason
+# that property has no value, for example "hardwarevendornullreason".
+NULL_REASON_SUFFIX = "nullreason"
+
+
+def _build_aspect_values(hardware):
+    """!
+    Build the aspect level property values from the "hardware" section of a
+    cloud response, pairing each null value with the reason the service gave
+    for it.
+
+    @type hardware: dict
+    @param hardware: the "hardware" section of the cloud response
+
+    @rtype dict
+    @return property name to AspectPropertyValue
+    """
+
+    values = {}
+
+    for key, value in hardware.items():
+        if key == "profiles" or key.endswith(NULL_REASON_SUFFIX):
+            continue
+
+        if value is None:
+            reason = hardware.get(key + NULL_REASON_SUFFIX)
+            values[key] = AspectPropertyValue(
+                no_value_message=reason if isinstance(reason, str) else None)
+        else:
+            values[key] = AspectPropertyValue(value=value)
+
+    return values
+
+
+class HardwareProfileCloud(CloudEngine):
+    """!
+    The hardware profile cloud engine
+    """
+    def __init__(self):
+
+        super(HardwareProfileCloud, self).__init__()
+
+        self.datakey = "hardware"
+
+    def process_internal(self, flowdata):
+
+        cloud_data = flowdata.get("cloud").get("cloud")
+
+        cloud_data = json.loads(cloud_data)
+
+        hardware = cloud_data.get("hardware") or {}
+
+        if not isinstance(hardware, dict):
+            hardware = {}
+
+        # Properties the resource key is not entitled to are returned by the
+        # cloud service at the aspect level rather than inside each profile,
+        # with a companion "<name>nullreason" saying why there is no value.
+        # Collect those so the reason can travel with every profile instead
+        # of being thrown away.
+        aspect_values = _build_aspect_values(hardware)
+
+        devices = []
+
+        for profile in hardware.get("profiles") or []:
+            device = {}
+            for property_key, property_value in profile.items():
+                device[property_key] = AspectPropertyValue(value=property_value)
+
+            # Add the properties the service could not supply, carrying the
+            # reason it gave, so a caller reading a profile gets an
+            # explanation rather than nothing at all.
+            for property_key, aspect_value in aspect_values.items():
+                if property_key not in device:
+                    device[property_key] = aspect_value
+
+            devices.append(device)
+
+        # The aspect level values are exposed alongside the profiles so a
+        # caller with no matching profiles can still read the reason.
+        contents = dict(aspect_values)
+        contents["profiles"] = devices
+
+        data = AspectDataDictionary(self, contents)
+
+        flowdata.set_element_data(data)
+        

{fiftyone_devicedetection_cloud-4.5.80 → fiftyone_devicedetection_cloud-4.5.82}/src/fiftyone_devicedetection_cloud.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fiftyone_devicedetection_cloud
-Version: 4.5.80
+Version: 4.5.82
 Summary: 51Degrees Device Detection parses HTTP headers to return detailed hardware, operating system, browser, and crawler information for the devices used to access your website or service. This package retrieves device detection results by consuming the 51Degrees cloud service.
 Home-page: https://51degrees.com/?utm_source=pypi&utm_medium=package&utm_campaign=device-detection-python&utm_content=fiftyone_devicedetection_cloud-setup.py&utm_term=url
 Author: 51Degrees Engineering

{fiftyone_devicedetection_cloud-4.5.80 → fiftyone_devicedetection_cloud-4.5.82}/src/fiftyone_devicedetection_cloud.egg-info/SOURCES.txt

@@ -13,4 +13,5 @@ src/fiftyone_devicedetection_cloud.egg-info/dependency_links.txt
 src/fiftyone_devicedetection_cloud.egg-info/requires.txt
 src/fiftyone_devicedetection_cloud.egg-info/top_level.txt
 tests/test_cloud.py
+tests/test_hardwareprofile_cloud.py
 tests/test_properties.py

{fiftyone_devicedetection_cloud-4.5.80 → fiftyone_devicedetection_cloud-4.5.82}/tests/test_cloud.py

@@ -29,8 +29,29 @@ from fiftyone_devicedetection_cloud.devicedetection_cloud_pipelinebuilder import
 
 from fiftyone_devicedetection_cloud.devicedetection_cloud import DeviceDetectionCloud
 
-if not "resource_key" in os.environ:
-    print("To run the cloud tests, please set a valid 51Degrees cloud resource key as the resource_key environment variable. e.g `export resource_key=MYresource_key` on the command line")
+# Resource key environment variables follow the 51Degrees convention, which
+# is that every one of them starts with "_51DEGREES_RESOURCE_KEY". The name
+# used before the convention was adopted is still read, so an existing setup
+# keeps working.
+RESOURCE_KEY_ENV_VAR = "_51DEGREES_RESOURCE_KEY"
+LEGACY_RESOURCE_KEY_ENV_VAR = "resource_key"
+
+MISSING_KEY_MESSAGE = (
+    "No resource key found, so the tests that call the cloud service "
+    f"cannot run. Set the environment variable '{RESOURCE_KEY_ENV_VAR}' "
+    f"(the older name '{LEGACY_RESOURCE_KEY_ENV_VAR}' is still read). "
+    "Create a resource key for free at "
+    "https://configure.51degrees.com?utm_source=code&utm_medium=example&utm_campaign=device-detection-python&utm_content=fiftyone_devicedetection_cloud-tests-test_cloud.py&utm_term=resource-key-required")
+
+
+def get_resource_key():
+    """!
+    The resource key from the environment, or None when neither the aligned
+    nor the older variable is set.
+    """
+
+    return (os.environ.get(RESOURCE_KEY_ENV_VAR)
+            or os.environ.get(LEGACY_RESOURCE_KEY_ENV_VAR))
 
 mobile_ua = "Mozilla/5.0 (iPhone; CPU iPhone OS 11_2 like Mac OS X) AppleWebKit/604.4.7 (KHTML, like Gecko) Mobile/15C114"
 
@@ -38,15 +59,19 @@ cloud_request_origin_test_params = [('', True), ('test.com', True), ('51Degrees.
 
 class DeviceDetectionTests(unittest.TestCase):
 
+    def setUp(self):
+        self.resource_key = get_resource_key()
+
+        if not self.resource_key:
+            self.skipTest(MISSING_KEY_MESSAGE)
+
+
     def test_pipeline_builder_cloud_engine_init(self):
         """!
         Tests whether the device detection pipeline builder adds the correct engines when initialised with a resource key
         """
 
-        if not "resource_key" in os.environ:
-            return
-
-        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = os.environ['resource_key']).build()
+        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = self.resource_key).build()
 
         self.assertTrue(pipeline.flow_elements[0].datakey == "cloud")
         self.assertTrue(pipeline.flow_elements[1].datakey == "device")
@@ -56,10 +81,7 @@ class DeviceDetectionTests(unittest.TestCase):
         Tests whether a properties list is created on the cloud engine
         """
         
-        if not "resource_key" in os.environ:
-            return
-
-        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = os.environ['resource_key']).build()
+        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = self.resource_key).build()
 
         properties = pipeline.flow_elements[1].get_properties()
 
@@ -70,10 +92,7 @@ class DeviceDetectionTests(unittest.TestCase):
         Check property lookup works
         """
 
-        if not "resource_key" in os.environ:
-            return
-
-        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = os.environ['resource_key']).build()
+        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = self.resource_key).build()
 
         fd = pipeline.create_flowdata()
 
@@ -89,7 +108,7 @@ class DeviceDetectionTests(unittest.TestCase):
         not available in any datafile
         """
 
-        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = os.environ['resource_key']).build()
+        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = self.resource_key).build()
 
         fd = pipeline.create_flowdata()
 
@@ -118,7 +137,7 @@ class DeviceDetectionTests(unittest.TestCase):
 
         start = time.time()
 
-        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = os.environ['resource_key']).build()
+        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = self.resource_key).build()
 
         fd = pipeline.create_flowdata()
 
@@ -144,7 +163,7 @@ class DeviceDetectionTests(unittest.TestCase):
         not available in cloud
         """
 
-        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = os.environ['resource_key']).build()
+        pipeline = DeviceDetectionCloudPipelineBuilder(resource_key = self.resource_key).build()
 
         fd = pipeline.create_flowdata()
 

fiftyone_devicedetection_cloud-4.5.82/tests/test_hardwareprofile_cloud.py

@@ -0,0 +1,176 @@
+# *********************************************************************
+# 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.
+# *********************************************************************
+
+"""!
+These tests run against fixed cloud responses, so they need no network
+connection and no resource key. They cover the case that used to stop the
+TAC and native model examples with an AttributeError, which is a resource
+key that returns the hardware profiles but is not entitled to the hardware
+properties themselves.
+"""
+
+import json
+import unittest
+
+from fiftyone_devicedetection_cloud.hardwareprofile_cloud import HardwareProfileCloud
+
+# A response of the shape the cloud service returns for a TAC lookup when
+# the resource key has the hardware aspect but is not entitled to the
+# hardware properties. The values are null at the aspect level and each one
+# is paired with a reason. The profiles carry only the properties the key is
+# entitled to.
+NOT_ENTITLED_RESPONSE = json.dumps({
+    "hardware": {
+        "profiles": [
+            {"devicetype": "SmartPhone", "ismobile": True}
+        ],
+        "hardwarevendor": None,
+        "hardwarevendornullreason":
+            "HardwareVendor is a paid feature. You need a licence key to "
+            "retrieve data.",
+        "hardwarename": None,
+        "hardwarenamenullreason":
+            "HardwareName is a paid feature. You need a licence key to "
+            "retrieve data.",
+        "hardwaremodel": None,
+        "hardwaremodelnullreason":
+            "HardwareModel is a paid feature. You need a licence key to "
+            "retrieve data."
+    }
+})
+
+# A response from a fully entitled resource key.
+ENTITLED_RESPONSE = json.dumps({
+    "hardware": {
+        "profiles": [
+            {
+                "hardwarevendor": "Apple",
+                "hardwarename": ["iPhone 6"],
+                "hardwaremodel": "A1586"
+            }
+        ]
+    }
+})
+
+# A response where the hardware aspect is absent altogether, which is what a
+# resource key without the hardware aspect returns.
+NO_HARDWARE_RESPONSE = json.dumps({"device": {"ismobile": True}})
+
+
+class _FakeCloudElementData:
+    """!
+    Stands in for the element data the cloud request engine publishes.
+    """
+
+    def __init__(self, response):
+        self._response = response
+
+    def get(self, key):
+        return self._response
+
+
+class _FakeFlowData:
+    """!
+    Stands in for a FlowData carrying a fixed cloud response, so the engine
+    can be tested with no network connection and no resource key.
+    """
+
+    def __init__(self, response):
+        self._response = response
+        self.element_data = None
+
+    def get(self, key):
+        return _FakeCloudElementData(self._response)
+
+    def set_element_data(self, data):
+        self.element_data = data
+
+
+def _process(response):
+    """!
+    Run a fixed cloud response through the hardware profile engine and
+    return the resulting element data.
+    """
+
+    engine = HardwareProfileCloud()
+    flowdata = _FakeFlowData(response)
+
+    engine.process_internal(flowdata)
+
+    return flowdata.element_data
+
+
+class HardwareProfileCloudTests(unittest.TestCase):
+
+    def test_null_reason_is_carried_into_each_profile(self):
+        hardware = _process(NOT_ENTITLED_RESPONSE)
+        profiles = hardware.get("profiles")
+
+        self.assertEqual(1, len(profiles))
+
+        profile = profiles[0]
+
+        for name in ["hardwarevendor", "hardwarename", "hardwaremodel"]:
+            self.assertIn(
+                name, profile,
+                f"'{name}' should be present on the profile so the reason "
+                "it has no value can be reported")
+            self.assertFalse(profile[name].has_value())
+            self.assertIn("paid feature", profile[name].no_value_message())
+
+    def test_null_reason_is_reported_by_the_example_helper(self):
+        # The example helper lives in the examples package, which is not a
+        # dependency of this one, so the same formatting is asserted here
+        # against the values the engine produced.
+        hardware = _process(NOT_ENTITLED_RESPONSE)
+        profile = hardware.get("profiles")[0]
+        value = profile["hardwarevendor"]
+
+        self.assertEqual(
+            "HardwareVendor is a paid feature. You need a licence key to "
+            "retrieve data.",
+            value.no_value_message())
+
+    def test_entitled_values_are_reported_as_values(self):
+        hardware = _process(ENTITLED_RESPONSE)
+        profile = hardware.get("profiles")[0]
+
+        self.assertTrue(profile["hardwarevendor"].has_value())
+        self.assertEqual("Apple", profile["hardwarevendor"].value())
+        self.assertEqual(["iPhone 6"], profile["hardwarename"].value())
+        self.assertEqual("A1586", profile["hardwaremodel"].value())
+
+    def test_absent_hardware_aspect_gives_no_profiles_rather_than_an_error(self):
+        hardware = _process(NO_HARDWARE_RESPONSE)
+
+        self.assertEqual([], hardware.get("profiles"))
+
+    def test_aspect_level_values_are_exposed_alongside_the_profiles(self):
+        # A caller with no matching profiles can still read the reason.
+        hardware = _process(NOT_ENTITLED_RESPONSE)
+
+        self.assertIn("paid feature",
+                      hardware.get("hardwarevendor").no_value_message())
+
+
+if __name__ == "__main__":
+    unittest.main()

{fiftyone_devicedetection_cloud-4.5.80 → fiftyone_devicedetection_cloud-4.5.82}/tests/test_properties.py

@@ -43,11 +43,41 @@ chrome_ua = ("Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36
 # TODO remove setheader properties from this list once UACH datafile is released.
 exclude_properties = ["setheaderbrowseraccept-ch", "setheaderplatformaccept-ch", "setheaderhardwareaccept-ch"]
 
-if "resource_key" in os.environ:
-    resource_key = os.environ["resource_key"]
-else:
-    raise Exception("To run the cloud tests, please set a valid 51Degrees "
-                    "cloud resource key as the resource_key environment variable.")
+# Resource key environment variables follow the 51Degrees convention, which
+# is that every one of them starts with "_51DEGREES_RESOURCE_KEY". The name
+# used before the convention was adopted is still read, so an existing setup
+# keeps working.
+RESOURCE_KEY_ENV_VAR = "_51DEGREES_RESOURCE_KEY"
+LEGACY_RESOURCE_KEY_ENV_VAR = "resource_key"
+
+resource_key = (os.environ.get(RESOURCE_KEY_ENV_VAR)
+                or os.environ.get(LEGACY_RESOURCE_KEY_ENV_VAR))
+
+if not resource_key:
+    # Skipping rather than raising, so a run without a key shows as skipped
+    # and names the variable, instead of turning into a collection error.
+    import pytest
+
+    pytest.skip(
+        "No resource key found, so the tests that call the cloud service "
+        f"cannot run. Set the environment variable '{RESOURCE_KEY_ENV_VAR}' "
+        f"(the older name '{LEGACY_RESOURCE_KEY_ENV_VAR}' is still read). "
+        "Create a resource key for free at "
+        "https://configure.51degrees.com?utm_source=code&utm_medium=example&utm_campaign=device-detection-python&utm_content=fiftyone_devicedetection_cloud-tests-test_properties.py&utm_term=resource-key-required",
+        allow_module_level=True)
+
+if not os.path.isfile(header_file_path):
+    # The property list comes from an asset the build fetches with a licence
+    # key. Without it these tests cannot run, so skip rather than turn a
+    # missing asset into a failure.
+    import pytest
+
+    pytest.skip(
+        f"The property list file '{header_file_path}' is not present, so "
+        "the property coverage tests cannot run. It is fetched by "
+        "ci/fetch-assets.ps1 when a device detection licence key is "
+        "available.",
+        allow_module_level=True)
 
 # Get Properties list
 properties_list = get_properties_from_header_file(header_file_path)

fiftyone_devicedetection_cloud-4.5.82/version.txt

@@ -0,0 +1 @@
+4.5.82

fiftyone_devicedetection_cloud-4.5.80/src/fiftyone_devicedetection_cloud/hardwareprofile_cloud.py

@@ -1,61 +0,0 @@
-# *********************************************************************
-# 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_engines.aspectdata_dictionary import AspectDataDictionary
-from fiftyone_pipeline_core.aspectproperty_value import AspectPropertyValue
-
-import json
-
-class HardwareProfileCloud(CloudEngine):
-    """!
-    The hardware profile cloud engine
-    """
-    def __init__(self):
-
-        super(HardwareProfileCloud, self).__init__()
-
-        self.datakey = "hardware"
-
-    def process_internal(self, flowdata):
-
-        cloud_data = flowdata.get("cloud").get("cloud")
-
-        cloud_data = json.loads(cloud_data)
-
-        # Loop over cloud_data.devices properties to check if they have a value
-
-        devices = []
-
-        for profile in cloud_data["hardware"]["profiles"]:
-            device = {}
-            for property_key, property_value in profile.items():
-                device[property_key] = AspectPropertyValue(value=property_value)
-
-            devices.append(device)
-
-        data = AspectDataDictionary(self, {"profiles": devices})
-
-        flowdata.set_element_data(data)
-        

fiftyone_devicedetection_cloud-4.5.80/version.txt

@@ -1 +0,0 @@
-4.5.80