kameleoon-client-python 3.5.0__tar.gz → 3.6.1__tar.gz

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kameleoon-client-python
-Version: 3.5.0
+Version: 3.6.1
 Summary: Kameleoon Client Python Software Development Kit.
 Home-page: https://developers.kameleoon.com/python-sdk.html
 Author: Kameleoon

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/data/manager/page_view_visit.py

@@ -1,4 +1,5 @@
 """Page view visit"""
+
 import time
 from typing import Optional
 from kameleoon.data import DataType
@@ -8,6 +9,7 @@ from kameleoon.data.page_view import PageView
 
 class PageViewVisit(BaseData):
     """Page view visit"""
+
     def __init__(self, page_view: PageView, count=1, last_timestamp: Optional[int] = None) -> None:
         super().__init__()
         self.page_view = page_view
@@ -18,6 +20,7 @@ class PageViewVisit(BaseData):
         """Overwrites the current PageView with a new PageView and increments the visit count."""
         self.page_view = new_page_view
         self.count += 1
+        self.last_timestamp = int(time.time() * 1000)
 
     def merge(self, page_view_visit) -> None:
         """Merges the visit data from another PageViewVisit instance into this one."""
@@ -33,8 +36,12 @@ class PageViewVisit(BaseData):
         return DataType.PAGE_VIEW_VISIT
 
     def __eq__(self, other: object) -> bool:
-        return isinstance(other, PageViewVisit) and (other.page_view == self.page_view) and (
-            other.count == self.count) and (other.last_timestamp == self.last_timestamp)
+        return (
+            isinstance(other, PageViewVisit)
+            and (other.page_view == self.page_view)
+            and (other.count == self.count)
+            and (other.last_timestamp == self.last_timestamp)
+        )
 
     def __str__(self):
         return (

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/data/manager/visitor.py

@@ -174,7 +174,12 @@ class Visitor:
     @mapping_identifier.setter
     def mapping_identifier(self, value: str):
         """Sets the mapping identifier for this Visitor."""
-        self._data.mapping_identifier = value
+        if self._data.mapping_identifier:
+            return
+        with self._data.lock:
+            if self._data.mapping_identifier:
+                return
+            self._data.mapping_identifier = value
         KameleoonLogger.debug("CALL/RETURN: Visitor.mapping_identifier <- (mapping_identifier: %s)", value)
 
     @property

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/helpers/domain.py

@@ -9,6 +9,7 @@ REGEX_DOMAIN = (
     r"^(\.?(([a-zA-Z\d][a-zA-Z\d-]*[a-zA-Z\d])|[a-zA-Z\d]))"
     r"(\.(([a-zA-Z\d][a-zA-Z\d-]*[a-zA-Z\d])|[a-zA-Z\d])){1,126}$"
 )
+LOCALHOST = "localhost"
 
 
 def validate_top_level_domain(top_level_domain: str) -> str:
@@ -35,8 +36,10 @@ def validate_top_level_domain(top_level_domain: str) -> str:
                 protocol, top_level_domain)
             break
 
-    if not re.match(REGEX_DOMAIN, top_level_domain):
-        KameleoonLogger.error(f"The top-level domain '{top_level_domain}' is invalid.")
-        return ""
+    if not re.match(REGEX_DOMAIN, top_level_domain) and top_level_domain != LOCALHOST:
+        KameleoonLogger.error(
+            f"The top-level domain '{top_level_domain}' is invalid. The value has been set as provided, but it does "
+            f"not meet the required format for proper SDK functionality. Please check the domain for correctness.")
+        return top_level_domain
 
     return top_level_domain

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/managers/remote_data/remote_data_manager.py

@@ -1,8 +1,6 @@
 """Remote data"""
 from typing import Optional, Any, List
-from kameleoon.configuration.custom_data_info import CustomDataInfo
 from kameleoon.data import Data
-from kameleoon.data.data import BaseData
 from kameleoon.data.manager.visitor_manager import VisitorManager
 from kameleoon.logging.kameleoon_logger import KameleoonLogger
 from kameleoon.managers.data.data_manager import DataManager
@@ -53,33 +51,35 @@ class RemoteDataManager:
             data_filter = RemoteVisitorDataFilter()
         service: DataService = self._network_manager.get_service(DataService)
         response = await service.get_remote_visitor_data(visitor_code, data_filter, is_unique_identifier, timeout)
-        visitor_data = self.__handle_remote_visitor_data_response(response, visitor_code, add_data)
+        visitor_data = self.__handle_remote_visitor_data_response(response, visitor_code, add_data, data_filter)
         KameleoonLogger.debug(
             "CALL: RemoteDataManager.get_visitor_data(visitor_code: %s, add_data: %s, data_filter: %s, timeout: %s) "
             "-> (visitor_data: %s)", visitor_code, add_data, data_filter, timeout, visitor_data)
         return visitor_data
 
     def __handle_remote_visitor_data_response(
-        self, response: Response, visitor_code: str, add_data: bool
+        self, response: Response, visitor_code: str, add_data: bool, data_filter: RemoteVisitorDataFilter
     ) -> List[Data]:
         if response.content is None:
             return []
         custom_data_info = self._data_manager.data_file.custom_data_info
-        data_to_add, data_to_return = RemoteDataManager.__parse_remote_visitor_data(custom_data_info, response.content)
+        remote_visitor_data = RemoteDataManager.__parse_remote_visitor_data(response.content)
+        remote_visitor_data.mark_data_as_sent(custom_data_info)
+        data_to_add = remote_visitor_data.collect_data_to_add()
         if add_data and data_to_add:
             # Cannot use `VisitorManager.add_data` because it could use remote visitor data for mapping.
             visitor = self._visitor_manager.get_or_create_visitor(visitor_code)
             visitor.add_data(*data_to_add, overwrite=False)
-        return data_to_return
+        if data_filter.visitor_code and remote_visitor_data.visitor_code:
+            # We apply visitor code from the latest visit fetched from Data API
+            visitor = self._visitor_manager.get_or_create_visitor(visitor_code)
+            visitor.mapping_identifier = remote_visitor_data.visitor_code
+        return remote_visitor_data.collect_data_to_return()
 
     @staticmethod
-    def __parse_remote_visitor_data(
-            custom_data_info: CustomDataInfo, raw: Any
-    ) -> tuple[List[BaseData], List[Data]]:
+    def __parse_remote_visitor_data(raw: Any) -> RemoteVisitorData:
         try:
-            remote_visitor_data = RemoteVisitorData(raw)
-            remote_visitor_data.mark_data_as_sent(custom_data_info)
-            return remote_visitor_data.collect_data_to_add(), remote_visitor_data.collect_data_to_return()
+            return RemoteVisitorData(raw)
         except Exception as ex:  # pylint: disable=W0703
             KameleoonLogger.error("Parsing of remote visitor data failed: %s", ex)
-            return [], []
+            return RemoteVisitorData({})

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/managers/remote_data/remote_visitor_data.py

@@ -38,6 +38,7 @@ class RemoteVisitorData:
         self.__experiments: Optional[Dict[int, AssignedVariation]] = None
         self.__conversions: Optional[List[Conversion]] = None
         self.__previous_visitor_visits: Optional[VisitorVisits] = None
+        self.__visitor_code: Optional[str] = None
         current_visit = json.get("currentVisit")
         if current_visit is not None:
             self.__parse_visit(current_visit)
@@ -100,7 +101,14 @@ class RemoteVisitorData:
             for conversion in self.__conversions:
                 conversion.mark_as_sent()
 
+    @property
+    def visitor_code(self) -> Optional[str]:
+        """Returns the `visitorCode` from the most recent visit"""
+        return self.__visitor_code
+
     def __parse_visit(self, json_visit: Dict[str, Any]) -> None:
+        if (self.__visitor_code is None) and isinstance(visitor_code := json_visit.get("visitorCode"), str):
+            self.__visitor_code = visitor_code
         custom_data_events = json_visit.get("customDataEvents")
         if custom_data_events:
             self.__parse_custom_data(custom_data_events)

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/sdk_version.py

@@ -4,7 +4,7 @@ from typing import Optional, Tuple
 
 from kameleoon.logging.kameleoon_logger import KameleoonLogger
 
-version_info = (3, 5, 0)
+version_info = (3, 6, 1)
 __version__ = ".".join(str(v) for v in version_info)  # uses in scripts
 
 

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/targeting/conditions/page_title_condition.py

@@ -1,4 +1,5 @@
 """ condition"""
+
 from typing import Any, Union, Dict
 from kameleoon.data.manager.page_view_visit import PageViewVisit
 from kameleoon.targeting.conditions.string_value_condition import StringValueCondition
@@ -14,8 +15,5 @@ class PageTitleCondition(StringValueCondition):
         return isinstance(data, dict) and self.__check(data)
 
     def __check(self, page_view_visits: Dict[str, PageViewVisit]) -> bool:
-        return any(
-            isinstance(visit, PageViewVisit) and visit.page_view.title is not None and self._check(
-                visit.page_view.title)
-            for visit in page_view_visits.values()
-        )
+        latest = max(page_view_visits.values(), key=lambda visit: visit.last_timestamp, default=None)
+        return latest is not None and latest.page_view.title is not None and self._check(latest.page_view.title)

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/targeting/conditions/page_url_condition.py

@@ -1,7 +1,7 @@
 """ condition"""
+
 from typing import Any, Union, Dict
 from kameleoon.data.manager.page_view_visit import PageViewVisit
-from kameleoon.targeting.conditions.constants import TargetingOperator
 from kameleoon.targeting.conditions.string_value_condition import StringValueCondition
 
 
@@ -15,9 +15,5 @@ class PageUrlCondition(StringValueCondition):
         return isinstance(data, dict) and self.__check(data)
 
     def __check(self, page_view_visits: Dict[str, PageViewVisit]) -> bool:
-        if self._operator == TargetingOperator.EXACT:
-            return self._condition_value in page_view_visits
-        return any(
-            isinstance(visit, PageViewVisit) and self._check(visit.page_view.url)
-            for visit in page_view_visits.values()
-        )
+        latest = max(page_view_visits.values(), key=lambda visit: visit.last_timestamp, default=None)
+        return latest is not None and self._check(latest.page_view.url)

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon/types/remote_visitor_data_filter.py

@@ -18,6 +18,7 @@ class RemoteVisitorDataFilter:
         conversions=False,
         experiments=False,
         kcs=False,
+        visitor_code=True,
     ) -> None:
         self._previous_visit_amount = previous_visit_amount
         self._current_visit = current_visit
@@ -30,6 +31,7 @@ class RemoteVisitorDataFilter:
         self._conversions = conversions
         self._experiments = experiments
         self._kcs = kcs
+        self._visitor_code = visitor_code
 
     @property
     def previous_visit_amount(self) -> int:
@@ -86,10 +88,15 @@ class RemoteVisitorDataFilter:
         """True if KCS heat data will be retrieved"""
         return self._kcs
 
+    @property
+    def visitor_code(self) -> bool:
+        """True if the `visitorCode` from the most recent visit will be retrieved and used for the current visit"""
+        return self._visitor_code
+
     def __str__(self):
         return (f"RemoteVisitorDataFilter{{previous_visit_amount:{self._previous_visit_amount},"
                 f"current_visit:{self._current_visit},custom_data:{self._custom_data},"
                 f"page_views:{self._page_views}, geolocation:{self._geolocation},"
                 f"device:{self._device},browser:{self._browser},"
                 f"operating_system:{self._operating_system},conversions:{self._conversions},"
-                f"experiments:{self._experiments},kcs:{self._kcs}}}")
+                f"experiments:{self._experiments},kcs:{self._kcs},visitor_code:{self._visitor_code}}}")

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon_client_python.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: kameleoon-client-python
-Version: 3.5.0
+Version: 3.6.1
 Summary: Kameleoon Client Python Software Development Kit.
 Home-page: https://developers.kameleoon.com/python-sdk.html
 Author: Kameleoon

{kameleoon-client-python-3.5.0 → kameleoon-client-python-3.6.1}/kameleoon_client_python.egg-info/requires.txt

@@ -4,24 +4,24 @@ sseclient-py<1.9.0,>=1.7.0
 aiohttp<4.0.0,>=3.8.0
 
 [test]
-freezegun==1.1.0
-pytest-ordering==0.6
-pytest-django==4.4.0
-requests<3.0.0,>=2.25
 Django==3.2.4
-pylint==2.12.*
-Werkzeug==2.0.1
-mypy==0.991
-flake8==4.0.1
+types-PyYAML==5.4.3
+wheel==0.36.2
 pyyaml<6.1.0,>=5.4.0
+freezegun==1.1.0
 pytest-cov==2.12.1
-wheel==0.36.2
-types-PyYAML==5.4.3
 aiohttp<4.0.0,>=3.8.0
-pytest-asyncio==0.21.*
-pytest-pythonpath==0.7.3
-types-python-dateutil==2.8.2
+aioresponses==0.7.*
 twine==3.4.1
+flake8==4.0.1
+pytest-ordering==0.6
 sseclient-py<1.9.0,>=1.7.0
-aioresponses==0.7.*
+pytest-asyncio==0.21.*
+types-python-dateutil==2.8.2
+pytest-pythonpath==0.7.3
+requests<3.0.0,>=2.25
+pytest-django==4.4.0
+pylint==2.12.*
+Werkzeug==2.0.1
 types-requests==2.25.0
+mypy==0.991