MagicFeedback 0.0.4__tar.gz → 0.0.7__tar.gz

{magicfeedback-0.0.4 → magicfeedback-0.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: MagicFeedback
-Version: 0.0.4
+Version: 0.0.7
 Summary: SDK for MagicFeedback API
 Author-email: Francisco Arias <farias@magicfedback.io>
 Project-URL: Homepage, https://github.com/MagicFeedback/magicfeedback_python_sdk
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENCE
+Dynamic: license-file
 
 # MagicFeedback SDK
 

{magicfeedback-0.0.4 → magicfeedback-0.0.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "MagicFeedback"
-version = "0.0.4"
+version = "0.0.7"
 authors = [
   { name="Francisco Arias", email="farias@magicfedback.io" },
 ]

{magicfeedback-0.0.4 → magicfeedback-0.0.7}/src/MagicFeedback.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: MagicFeedback
-Version: 0.0.4
+Version: 0.0.7
 Summary: SDK for MagicFeedback API
 Author-email: Francisco Arias <farias@magicfedback.io>
 Project-URL: Homepage, https://github.com/MagicFeedback/magicfeedback_python_sdk
@@ -11,6 +11,7 @@ Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENCE
+Dynamic: license-file
 
 # MagicFeedback SDK
 

{magicfeedback-0.0.4 → magicfeedback-0.0.7}/src/MagicFeedback.egg-info/SOURCES.txt

@@ -10,4 +10,5 @@ src/MagicFeedback.egg-info/top_level.txt
 tests/test_apikey.py
 tests/test_campaign.py
 tests/test_contact.py
+tests/test_feedback_answers_array.py
 tests/test_feedback_create.py

{magicfeedback-0.0.4 → magicfeedback-0.0.7}/src/magicfeedback.py

@@ -1,4 +1,5 @@
 import json
+import logging
 from typing import Any, Dict
 
 import requests
@@ -9,13 +10,33 @@ class MagicFeedbackClient:
 
     def __init__(self, user: str, password: str, base_url: str = "https://api.magicfeedback.io", ip_key: str = 'AIzaSyAKcR895VURSQZSN2T_RD6jX_9y5HRmH80'):
 
+        self.logger = logging.getLogger("magicfeedback_sdk")
+        self.logger.addHandler(logging.NullHandler())
+
         self.base_url = base_url
         self.ip_key = ip_key
 
         self.api_key = self.get_api_key(user, password)
-        print("API Key: ", self.api_key)
+        self.logger.info("API Key: %s", self.api_key)
         self.headers = {"Authorization": f"Bearer {self.api_key}"}
 
+    def logging(self, level: int):
+        """Sets the logging level for the SDK.
+
+        Args:
+            level (int): The logging level to set (e.g., logging.DEBUG, logging.INFO).
+        """
+        self.logger.setLevel(level)
+
+        # Evita agregar múltiples handlers si ya se configuró
+        if not any(isinstance(h, logging.StreamHandler) for h in self.logger.handlers):
+            handler = logging.StreamHandler()
+            handler.setLevel(level)
+            formatter = logging.Formatter(
+                "%(asctime)s - %(levelname)s - %(message)s")
+            handler.setFormatter(formatter)
+            self.logger.addHandler(handler)
+
     def get_api_key(self, user, password):
         """Obtains the API key using user and password authentication."""
         # TODO: Implement control to check if the token is still valid - Only for 1 hour
@@ -33,9 +54,8 @@ class MagicFeedbackClient:
             str: The obtained ID token.
         """
         # TODO: Control in case the call is not good
-        print("Logging in with user and password...")
-        print("User: ", user)
-        print("Password: ", password)
+        self.logger.info("Logging in with user and password...")
+        self.logger.info("User: %s", user)
 
         options = {
             "method": "POST",
@@ -64,12 +84,12 @@ class MagicFeedbackClient:
             method, url, headers=self.headers, json=json)
         response.raise_for_status()  # Raise exception for non-2xx status codes
         # TODO: Control the status of the call
-        print("Status code: ", response.status_code)
+        self.logger.debug("Status code: %s", response.status_code)
         # Control if exist response that can be converted in json
         if response.text:
-            print("Response: ", response.json())
+            self.logger.debug("Response: %s", response.json())
             return response.json()
-        
+
         return {}
 
     ####################################################################################
@@ -97,6 +117,13 @@ class MagicFeedbackClient:
             if field not in feedback:
                 raise ValueError(f"Missing required field: {field}")
 
+       # Ensure answers.values are wrapped in a list if not already
+        if "answers" in feedback and isinstance(feedback["answers"], list):
+            for answer in feedback["answers"]:
+                if "value" in answer and not isinstance(answer["value"], list):
+                    # Wrap the value in a list if it is not already
+                    answer["value"] = [answer["value"]]
+
         return self._make_request("POST", url, json=feedback)
 
     def get_feedback(self, feedback_id: str) -> Dict[str, Any]:
@@ -173,7 +200,7 @@ class MagicFeedbackClient:
             url = f"{url}?filter={json.dumps(filter)}"
 
         return self._make_request("GET", url)
-    
+
     def update_contact(self, contact_id: str, contact: Dict[str, Any]) -> Dict[str, Any]:
         """Updates a specific contact item.
 
@@ -186,7 +213,7 @@ class MagicFeedbackClient:
         """
         url = f"{self.base_url}/crm/contacts/{contact_id}"
         return self._make_request("PATCH", url, json=contact)
-    
+
     def delete_contact(self, contact_id: str) -> None:
         """Deletes a specific contact item.
 
@@ -220,7 +247,7 @@ class MagicFeedbackClient:
                 raise ValueError(f"Missing required field: {field}")
 
         return self._make_request("POST", url, json=campaign)
-    
+
     def get_campaigns(self, filter) -> Dict[str, Any]:
         """Retrieves a specific campaign item.
 
@@ -236,7 +263,7 @@ class MagicFeedbackClient:
             url = f"{url}?filter={json.dumps(filter)}"
 
         return self._make_request("GET", url)
-    
+
     def create_campaign_session(self, campaign_id: str, session: Dict[str, Any]) -> Dict[str, Any]:
         """Creates a new campaign session item.
 
@@ -256,12 +283,12 @@ class MagicFeedbackClient:
         for field in required_fields:
             if field not in session:
                 raise ValueError(f"Missing required field: {field}")
-            
+
         if len(session.get("crmContactId")) == 0:
             raise ValueError("Contact ID cannot be empty.")
 
         return self._make_request("POST", url, json=session)
-    
+
     def get_campaign_sessions(self, campaign_id: str, filter) -> Dict[str, Any]:
         """Retrieves a specific campaign session item.
 
@@ -272,8 +299,25 @@ class MagicFeedbackClient:
         Returns:
             Dict[str, Any]: The retrieved campaign session item.
         """
-        url = f"{self.base_url}/campaigns/{campaign_id}/sessions"
+        url = f"{self.base_url}/campaigns/{campaign_id}/session"
         if filter:
             url = f"{url}?filter={json.dumps(filter)}"
 
-        return self._make_request("GET", url)
+        return self._make_request("GET", url)
+
+    ####################################################################################
+    # Metrics API Methods                                                             #
+    ####################################################################################
+
+    def get_metrics(self, filter) -> Dict[str, Any]:
+        """Retrieves metrics data.
+        Args:
+            filter (Dict[str, Any]): The filter to apply to the metrics.
+        Returns:
+            Dict[str, Any]: The retrieved metrics data.
+        """
+        url = f"{self.base_url}/metrics"
+        if filter:
+            url = f"{url}?filter={json.dumps(filter)}"
+
+        return self._make_request("GET", url)

magicfeedback-0.0.7/tests/test_feedback_answers_array.py

@@ -0,0 +1,49 @@
+import pytest
+from src.magicfeedback import MagicFeedbackClient
+
+def test_create_feedback_with_answer_wrapping(client):
+    """Tests creating a new feedback item and ensures answers.value is wrapped in a list if not already."""
+
+    feedback_data = {
+        "name": "Test SDK Feedback",
+        "type": "APP",
+        "identity": "MAGICFORM",
+        "answers": [
+            {"key": "name", "value": "John Doe"},  # Single value (should be wrapped)
+            {"key": "comment", "value": ["This is a test comment."]}  # Already a list
+        ],
+        "questions": [
+            {
+                "title": "Name",
+                "ref": "name",
+                "position": 1,
+                "type": "TEXT"
+            },
+            {
+                "title": "Comment",
+                "ref": "comment",
+                "position": 2,
+                "type": "LONGTEXT"
+            },
+        ],
+        "integrationId": "0eb9d270-6dd7-11ef-9987-21e04f383573",
+        "companyId": "MAGICFEEDBACK_DEV_SDK",
+        "productId": "MAGICFEEDBACK_DEV_SDK_GENERAL",
+    }
+
+    response = client.create_feedback(feedback_data)
+
+    assert "id" in response
+    # Check if the created feedback has the correct name
+    assert response["name"] == "Test SDK Feedback"
+
+    # Validate answers are properly wrapped
+    for answer in feedback_data["answers"]:
+        assert isinstance(answer["value"], list), f"Answer value for key '{answer['key']}' is not a list."
+
+@pytest.fixture
+def client():
+    """Provides a MagicFeedbackClient instance for testing."""
+
+    client = MagicFeedbackClient('sdk_tester@magicfeedback.io', 'caracter')
+    return client