contentgrid-application-client 0.2.6__tar.gz → 0.2.7__tar.gz

{contentgrid_application_client-0.2.6/src/contentgrid_application_client.egg-info → contentgrid_application_client-0.2.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: contentgrid-application-client
-Version: 0.2.6
+Version: 0.2.7
 Summary: Python Client for interacting with ContentGrid Applications
 Author-email: Ranec Belpaire <ranec.belpaire@xenit.eu>
 License: Copyright 2024 Xenit Solutions
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: contentgrid-hal-client==0.2.6
+Requires-Dist: contentgrid-hal-client==0.2.7
 Dynamic: license-file
 Dynamic: requires-dist
 

{contentgrid_application_client-0.2.6 → contentgrid_application_client-0.2.7}/src/contentgrid_application_client/application.py

@@ -1,3 +1,4 @@
+from abc import ABC, abstractmethod
 from enum import Enum
 from typing import Any, Generator, List, Optional, Self, Sequence, Union, cast
 from contentgrid_hal_client.hal_forms import HALFormsPropertyType, HALFormsTemplate
@@ -58,6 +59,7 @@ class InteractiveApplicationResponse(InteractiveHALResponse):
 class SearchType(Enum):
     EXACT_MATCH = "exact-match"
     PREFIX_MATCH = "prefix-match"
+    FULL_TEXT_MATCH = "full-text"
     LESS_THAN = "less-than"
     LESS_THAN_OR_EQUAL = "less-than-or-equal"
     GREATER_THAN = "greater-than"
@@ -478,6 +480,7 @@ class AttributeProfile(InteractiveApplicationResponse):
         # Initialize private attributes for search options
         self.__prefix_search_option: Optional[SearchOption] = None
         self.__exact_search_option: Optional[SearchOption] = None
+        self.__full_text_search_option: Optional[SearchOption] = None
         self.__less_than_search_option: Optional[SearchOption] = None
         self.__less_than_or_equal_search_option: Optional[SearchOption] = None
         self.__greater_than_search_option: Optional[SearchOption] = None
@@ -554,6 +557,12 @@ class AttributeProfile(InteractiveApplicationResponse):
         if self.__prefix_search_option is None:
             self.__prefix_search_option = self.get_search_option(search_type=SearchType.PREFIX_MATCH)
         return self.__prefix_search_option
+    
+    @property
+    def _full_text_search_option(self) -> Optional[SearchOption]:
+        if self.__full_text_search_option is None:
+            self.__full_text_search_option = self.get_search_option(search_type=SearchType.FULL_TEXT_MATCH)
+        return self.__full_text_search_option
 
     @property
     def _exact_search_option(self) -> Optional[SearchOption]:
@@ -699,32 +708,94 @@ class PageInfo:
 _search_form_relation_delimiter = "."
 
 
-class AttributeMatchSearch:
-    def __init__(self, attribute_name: str, value: Union[float | int | date | datetime | bool | str], prefer_prefix: bool = True, ignore_errors: bool = False) -> None:
+class AttributeSearch(ABC):
+    """Abstract base class for attribute search implementations."""
+    
+    def __init__(self, attribute_name: str, ignore_errors: bool = False) -> None:
         self.attribute_name: str = attribute_name
-        self.value: Union[float | int | date | datetime | bool | str] = value
-        self.prefer_prefix: bool = prefer_prefix
         self.ignore_errors: bool = ignore_errors
+    
+    @abstractmethod
+    def get_search_params(self, attribute_profile: AttributeProfile) -> List[SearchParam]:
+        """Convert this search specification into search parameters.
+        
+        Args:
+            attribute_profile: The attribute profile to validate against and extract search options from.
+            
+        Returns:
+            List of SearchParam objects representing the search criteria.
+        """
+        pass
+
+
+class AttributeMatchSearch(AttributeSearch):
+    def __init__(
+        self, 
+        attribute_name: str, 
+        value: Union[float | int | date | datetime | bool | str], 
+        use_prefix: bool = False, 
+        use_full_text: bool = False, 
+        use_exact: bool = False,
+        ignore_errors: bool = False
+    ) -> None:
+        super().__init__(attribute_name, ignore_errors)
+        self.value: Union[float | int | date | datetime | bool | str] = value
+        self.use_prefix: bool = use_prefix
+        self.use_full_text: bool = use_full_text
+        self.use_exact: bool = use_exact
 
     def get_search_params(self, attribute_profile: AttributeProfile) -> List[SearchParam]:
         search_params = []
         if self.value is not None:
             if not self.ignore_errors:
-                if not attribute_profile.has_search_capability():
+                if (
+                    not attribute_profile.has_search_capability()
+                    or (not attribute_profile._exact_search_option
+                    and not attribute_profile._prefix_search_option
+                    and not attribute_profile._full_text_search_option)
+                ):                    
                     raise BadRequest(f"Attribute {self.attribute_name} does not support search. Available options: {attribute_profile.search_options}")
-                if not attribute_profile._exact_search_option and not attribute_profile._prefix_search_option:
-                    raise BadRequest(f"Attribute {self.attribute_name} does not support exact search. Available options: {attribute_profile.search_options}")
 
-            # Exact or prefix match if possible
-            if attribute_profile._prefix_search_option and (self.prefer_prefix or not attribute_profile._exact_search_option):
-                search_params.append(SearchParam(value=self.value, option=attribute_profile._prefix_search_option))
-            elif attribute_profile._exact_search_option:
-                search_params.append(SearchParam(value=self.value, option=attribute_profile._exact_search_option))
+            # Extract available search options
+            full_text_option = attribute_profile._full_text_search_option
+            prefix_option = attribute_profile._prefix_search_option
+            exact_option = attribute_profile._exact_search_option
+
+            selected_option = None
+            
+            # Check if any specific search type is explicitly requested
+            any_use_flag_set = self.use_prefix or self.use_full_text or self.use_exact
+            
+            if any_use_flag_set:
+                # Use explicitly requested search types (in priority order)
+                if self.use_full_text and full_text_option:
+                    selected_option = full_text_option
+                elif self.use_prefix and prefix_option:
+                    selected_option = prefix_option
+                elif self.use_exact and exact_option:
+                    selected_option = exact_option
+            else:
+                # No specific type requested, use default priority:
+                # 1. Full-text match (if available)
+                # 2. Prefix match (if available)
+                # 3. Exact match (if available)
+                # 4. Any available option
+                if full_text_option:
+                    selected_option = full_text_option
+                elif prefix_option:
+                    selected_option = prefix_option
+                elif exact_option:
+                    selected_option = exact_option
+                elif attribute_profile.has_search_capability():
+                    selected_option = attribute_profile.search_options[0]
+            
+            if selected_option:
+                search_params.append(SearchParam(value=self.value, option=selected_option))
 
         return search_params
 
 
-class AttributeRangeSearch:
+class AttributeRangeSearch(AttributeSearch):
     def __init__(
         self,
         attribute_name: str,
@@ -733,7 +804,7 @@ class AttributeRangeSearch:
         include_boundaries: bool = True,
         ignore_errors: bool = False,
     ) -> None:
-        self.attribute_name: str = attribute_name
+        super().__init__(attribute_name, ignore_errors)
 
         self.min_value: Optional[Union[float | int | str]]
         if isinstance(min_value, datetime):
@@ -752,7 +823,6 @@ class AttributeRangeSearch:
             self.max_value = max_value
 
         self.include_boundaries: bool = include_boundaries
-        self.ignore_errors: bool = ignore_errors
 
     def get_search_params(self, attribute_profile: AttributeProfile) -> List[SearchParam]:
         search_params = []
@@ -925,7 +995,7 @@ class ContentGridApplicationClient(HALFormsClient):
         return self.follow_link(profile_link, infer_type=EntityProfile, params=params)
 
     def fetch_openapi_yaml(self) -> tuple[str, bytes]:
-        res = self.get("/openapi.yml")
+        res = self.get("/openapi.yml", headers={"Accept": "application/yaml"})
         self._validate_non_json_response(res)
         return ("openapi.yml", res.content)
 

{contentgrid_application_client-0.2.6 → contentgrid_application_client-0.2.7/src/contentgrid_application_client.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: contentgrid-application-client
-Version: 0.2.6
+Version: 0.2.7
 Summary: Python Client for interacting with ContentGrid Applications
 Author-email: Ranec Belpaire <ranec.belpaire@xenit.eu>
 License: Copyright 2024 Xenit Solutions
@@ -22,7 +22,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.5
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: contentgrid-hal-client==0.2.6
+Requires-Dist: contentgrid-hal-client==0.2.7
 Dynamic: license-file
 Dynamic: requires-dist
 

contentgrid_application_client-0.2.7/src/contentgrid_application_client.egg-info/requires.txt

@@ -0,0 +1 @@
+contentgrid-hal-client==0.2.7

{contentgrid_application_client-0.2.6 → contentgrid_application_client-0.2.7}/tests/test_openapi.py

@@ -1,7 +1,6 @@
 from contentgrid_application_client import ContentGridApplicationClient
-from fixtures import auth_manager, cg_client # noqa: F401
 import os
-
+from fixtures import auth_manager, cg_client # noqa: F401
 
 def test_fetch_openapi_spec(cg_client: ContentGridApplicationClient):
     filename, file = cg_client.fetch_openapi_yaml()
@@ -9,4 +8,4 @@ def test_fetch_openapi_spec(cg_client: ContentGridApplicationClient):
     output_path = os.path.join("output", filename)
     with open(output_path, 'wb') as f:
         f.write(file)
-    assert os.path.exists(output_path)
+    assert os.path.exists(output_path)

{contentgrid_application_client-0.2.6 → contentgrid_application_client-0.2.7}/tests/test_search.py

@@ -258,4 +258,88 @@ def test_conversion_of_datetime():
     date_range = AttributeRangeSearch("datetime", min_value=datetime(2025,4,24), max_value=datetime(2026, 4, 24))
     assert isinstance(date_range.min_value, str)
     assert isinstance(date_range.max_value, str)
-    assert is_valid_datetime_format(date_range.min_value)
+    assert is_valid_datetime_format(date_range.min_value)
+
+
+def test_full_text_preference_over_prefix(cg_client):
+    """Test that full-text search is used when explicitly requested."""
+    entity_name = "skill"
+    
+    # Create a search with full-text explicitly requested
+    match_search = AttributeMatchSearch(
+        attribute_name="name", 
+        value="machine", 
+        use_full_text=True
+    )
+    
+    entity_search = EntitySearch(
+        entity_name=entity_name,
+        attribute_searches=[match_search]
+    )
+    
+    # Get the entity profile to verify the search option selected
+    entity_profile = cg_client.get_entity_profile(entity_name)
+    attribute_profile = entity_profile.get_attribute_profile("name")
+    
+    # Get the search params to verify full-text option is used
+    search_params = match_search.get_search_params(attribute_profile)
+    
+    assert len(search_params) > 0
+    # If full-text is available, it should be selected
+    if attribute_profile._full_text_search_option:
+        assert search_params[0].option.type.value == "full-text"
+    
+    results = cg_client.execute_entity_search(entity_search=entity_search, nb_results=3)
+    assert results is not None
+
+
+def test_full_text_search_default_behavior(cg_client):
+    """Test default behavior which prioritizes full-text, then prefix, then exact match."""
+    entity_name = "skill"
+    
+    # Default behavior (no explicit use_* flags) uses priority: full-text > prefix > exact
+    match_search = AttributeMatchSearch(
+        attribute_name="name", 
+        value="learning"
+    )
+    
+    entity_search = EntitySearch(
+        entity_name=entity_name,
+        attribute_searches=[match_search]
+    )
+    
+    results = cg_client.execute_entity_search(entity_search=entity_search, nb_results=5)
+    assert results is not None
+    assert len(results) >= 0
+
+
+def test_exact_match_fallback_when_preferences_disabled(cg_client):
+    """Test that exact match is used when explicitly requested."""
+    entity_name = "skill"
+    
+    # Create a search with exact match explicitly requested
+    match_search = AttributeMatchSearch(
+        attribute_name="name", 
+        value="Python", 
+        use_exact=True
+    )
+    
+    entity_search = EntitySearch(
+        entity_name=entity_name,
+        attribute_searches=[match_search]
+    )
+    
+    # Get the entity profile to verify the search option selected
+    entity_profile = cg_client.get_entity_profile(entity_name)
+    attribute_profile = entity_profile.get_attribute_profile("name")
+    
+    # Get the search params to verify exact match option is used when explicitly requested
+    search_params = match_search.get_search_params(attribute_profile)
+    
+    assert len(search_params) > 0
+    # Should use exact match (or case-insensitive match) as explicitly requested
+    if attribute_profile._exact_search_option:
+        assert search_params[0].option.type.value in ["exact-match", "case-insensitive-match"]
+    
+    results = cg_client.execute_entity_search(entity_search=entity_search, nb_results=3)
+    assert results is not None

contentgrid_application_client-0.2.6/src/contentgrid_application_client.egg-info/requires.txt

@@ -1 +0,0 @@
-contentgrid-hal-client==0.2.6