MagicFeedback 0.0.2__tar.gz → 0.0.3__tar.gz

{magicfeedback-0.0.2 → magicfeedback-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MagicFeedback
-Version: 0.0.2
+Version: 0.0.3
 Summary: SDK for MagicFeedback API
 Author-email: Francisco Arias <farias@magicfedback.io>
 Project-URL: Homepage, https://github.com/MagicFeedback/magicfeedback_python_sdk

{magicfeedback-0.0.2 → magicfeedback-0.0.3}/pyproject.toml

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

{magicfeedback-0.0.2 → magicfeedback-0.0.3}/src/MagicFeedback.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: MagicFeedback
-Version: 0.0.2
+Version: 0.0.3
 Summary: SDK for MagicFeedback API
 Author-email: Francisco Arias <farias@magicfedback.io>
 Project-URL: Homepage, https://github.com/MagicFeedback/magicfeedback_python_sdk

{magicfeedback-0.0.2 → magicfeedback-0.0.3}/src/MagicFeedback.egg-info/SOURCES.txt

@@ -8,4 +8,6 @@ src/MagicFeedback.egg-info/SOURCES.txt
 src/MagicFeedback.egg-info/dependency_links.txt
 src/MagicFeedback.egg-info/top_level.txt
 tests/test_apikey.py
+tests/test_campaign.py
+tests/test_contact.py
 tests/test_feedback_create.py

magicfeedback-0.0.3/src/magicfeedback.py

@@ -0,0 +1,276 @@
+import json
+from typing import Any, Dict
+
+import requests
+
+
+class MagicFeedbackClient:
+    """A Python SDK for interacting with the MagicFeedback API."""
+
+    def __init__(self, user: str, password: str, base_url: str = "https://api.magicfeedback.io", ip_key: str = 'AIzaSyAKcR895VURSQZSN2T_RD6jX_9y5HRmH80'):
+
+        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.headers = {"Authorization": f"Bearer {self.api_key}"}
+
+    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
+        # Call your existing function
+        id_token = self.identity_login(user, password)
+        return id_token
+
+    def identity_login(self, user, password):
+        """
+        (Replace this function with your existing `identity_login` function)
+
+        Performs user and password-based login using the identity toolkit API.
+
+        Returns:
+            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)
+
+        options = {
+            "method": "POST",
+            "url": "https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=" + self.ip_key,
+            "headers": {
+                "Content-Type": "application/javascript",
+            },
+            "data": json.dumps({
+                "email": user,
+                "password": password,
+                "returnSecureToken": True
+            })
+        }
+
+        response = requests.post(
+            options["url"], headers=options["headers"], data=options["data"])
+        data = json.loads(response.text)
+        return data["idToken"]
+
+    def _make_request(
+        self, method: str, url: str, json: Dict[str, Any] = None
+    ) -> Dict[str, Any]:
+        """Makes a request to the MagicFeedback API."""
+        # TODO: Control token expiration
+        response = requests.request(
+            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)
+        print("Response: ", response.json())
+
+        return response.json()
+
+    ####################################################################################
+    # Feedback API Methods                                                             #
+    ####################################################################################
+
+    def create_feedback(self, feedback: Dict[str, Any]) -> Dict[str, Any]:
+        """Creates a new feedback item.
+
+        Args:
+            feedback (Dict[str, Any]): The feedback data to create.
+
+        Returns:
+            Dict[str, Any]: The created feedback item.
+        """
+        url = f"{self.base_url}/feedbacks"
+
+        # Ensure required fields are present
+        required_fields = [
+            "name", "type", "identity",
+            "integrationId", "companyId",
+            "productId"
+        ]
+        for field in required_fields:
+            if field not in feedback:
+                raise ValueError(f"Missing required field: {field}")
+
+        return self._make_request("POST", url, json=feedback)
+
+    def get_feedback(self, feedback_id: str) -> Dict[str, Any]:
+        """Retrieves a specific feedback item.
+
+        Args:
+            feedback_id (str): The ID of the feedback item.
+
+        Returns:
+            Dict[str, Any]: The retrieved feedback item.
+        """
+        url = f"{self.base_url}/feedbacks/{feedback_id}"
+        return self._make_request("GET", url)
+
+    def update_feedback(self, feedback_id: str, feedback: Dict[str, Any]) -> Dict[str, Any]:
+        """Updates a specific feedback item.
+
+        Args:
+            feedback_id (str): The ID of the feedback item.
+            feedback (Dict[str, Any]): The updated feedback data.
+
+        Returns:
+            Dict[str, Any]: The updated feedback item.
+        """
+        url = f"{self.base_url}/feedbacks/{feedback_id}"
+        return self._make_request("PUT", url, json=feedback)
+
+    def delete_feedback(self, feedback_id: str) -> None:
+        """Deletes a specific feedback item.
+
+        Args:
+            feedback_id (str): The ID of the feedback item.
+        """
+        url = f"{self.base_url}/feedbacks/{feedback_id}"
+        self._make_request("DELETE", url)
+
+    ####################################################################################
+    # Contacts API Methods                                                             #
+    ####################################################################################
+
+    def create_contact(self, contact: Dict[str, Any]) -> Dict[str, Any]:
+        """Creates a new contact item.
+
+        Args:
+            contact (Dict[str, Any]): The contact data to create.
+
+        Returns:
+            Dict[str, Any]: The created contact item.
+        """
+        url = f"{self.base_url}/crm/contacts"
+
+        # Ensure required fields are present
+        required_fields = [
+            "name", "lastname", "email", "companyId"
+        ]
+        for field in required_fields:
+            if field not in contact:
+                raise ValueError(f"Missing required field: {field}")
+
+        return self._make_request("POST", url, json=contact)
+
+    def get_contacts(self, filter) -> Dict[str, Any]:
+        """Retrieves a specific contact item.
+
+        Args:
+            contact_id (str): The ID of the contact item.
+            filter (Dict[str, Any]): The filter to apply to the contacts.
+
+        Returns:
+            Dict[str, Any]: The retrieved contact item.
+        """
+        url = f"{self.base_url}/crm/contacts"
+        if filter:
+            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.
+
+        Args:
+            contact_id (str): The ID of the contact item.
+            contact (Dict[str, Any]): The updated contact data.
+
+        Returns:
+            Dict[str, Any]: The updated contact item.
+        """
+        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.
+
+        Args:
+            contact_id (str): The ID of the contact item.
+        """
+        url = f"{self.base_url}/crm/contacts/{contact_id}"
+        self._make_request("DELETE", url)
+
+    ####################################################################################
+    # Campaigns API Methods                                                             #
+    ####################################################################################
+
+    def create_campaign(self, campaign: Dict[str, Any]) -> Dict[str, Any]:
+        """Creates a new campaign item.
+
+        Args:
+            campaign (Dict[str, Any]): The campaign data to create.
+
+        Returns:
+            Dict[str, Any]: The created campaign item.
+        """
+        url = f"{self.base_url}/campaigns"
+
+        # Ensure required fields are present
+        required_fields = [
+            "name", "companyId"
+        ]
+        for field in required_fields:
+            if field not in campaign:
+                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.
+
+        Args:
+            campaign_id (str): The ID of the campaign item.
+            filter (Dict[str, Any]): The filter to apply to the campaigns.
+
+        Returns:
+            Dict[str, Any]: The retrieved campaign item.
+        """
+        url = f"{self.base_url}/campaigns"
+        if filter:
+            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.
+
+        Args:
+            campaign_id (str): The ID of the campaign.
+            session (Dict[str, Any]): The session data to create.
+
+        Returns:
+            Dict[str, Any]: The created campaign session item.
+        """
+        url = f"{self.base_url}/campaigns/{campaign_id}/session"
+
+        # Ensure required fields are present
+        required_fields = [
+            "crmContactId"
+        ]
+        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.
+
+        Args:
+            campaign_id (str): The ID of the campaign.
+            filter (Dict[str, Any]): The filter to apply to the campaign sessions.
+
+        Returns:
+            Dict[str, Any]: The retrieved campaign session item.
+        """
+        url = f"{self.base_url}/campaigns/{campaign_id}/sessions"
+        if filter:
+            url = f"{url}?filter={json.dumps(filter)}"
+
+        return self._make_request("GET", url)

magicfeedback-0.0.3/tests/test_campaign.py

@@ -0,0 +1,87 @@
+import random
+import string
+
+import pytest
+
+from src.magicfeedback import MagicFeedbackClient
+
+'''
+def test_create_campaign(client):
+    """Tests creating a new campaign item."""
+
+    campaign_name = generate_random_string(10)
+
+    #
+    campaign_data = {
+        "name": campaign_name,
+        "companyId": "MAGICFEEDBACK_DEV_SDK"
+    }
+
+    response = client.create_campaign(campaign_data)
+
+    assert "id" in response
+    # Check if the created contact has the correct name
+    assert response["name"] == campaign_name
+
+def test_list_campaign(client):
+    """Tests listing campaign items."""
+
+    filter = {
+        "where": {
+            "companyId": "MAGICFEEDBACK_DEV_SDK"
+        }
+    }
+
+    response = client.get_campaigns(filter)
+    assert len(response) > 0
+'''
+
+def test_create_campaign_session(client):
+    """Tests creating a new campaign session item."""
+
+    # Create a new campaign
+    campaign_name = generate_random_string(10)
+
+    campaign_data = {
+        "name": campaign_name,
+        "companyId": "MAGICFEEDBACK_DEV_SDK"
+    }
+
+    campaign = client.create_campaign(campaign_data)
+    assert "id" in campaign
+
+    # List only 2 contacts from the company
+    filter = {
+        "where": {
+            "companyId": "MAGICFEEDBACK_DEV_SDK",
+            "status": "ACTIVE"
+        },
+        "limit": 2
+    }
+
+    contacts = client.get_contacts(filter)
+    assert len(contacts) > 0
+
+    # Asign the contacts to the campaign
+    session_data = {
+        "crmContactId": []
+    }
+    for contact in contacts:
+        session_data.get("crmContactId").append(contact["id"])
+
+    response = client.create_campaign_session(campaign["id"], session_data)
+
+@pytest.fixture
+def client():
+    """Provides a MagicFeedbackClient instance for testing."""
+
+    client = MagicFeedbackClient('sdk_tester@magicfeedback.io', 'caracter')
+    return client
+
+# Generate random name, last name and email
+
+
+def generate_random_string(length):
+    """Generates a random string of given length."""
+    letters = string.ascii_letters
+    return ''.join(random.choice(letters) for _ in range(length))

magicfeedback-0.0.3/tests/test_contact.py

@@ -0,0 +1,57 @@
+import random
+import string
+
+import pytest
+
+from src.magicfeedback import MagicFeedbackClient
+
+
+def test_create_contact(client):
+    """Tests creating a new contact item."""
+
+    name = generate_random_string(5)
+    last_name = generate_random_string(7)
+    email = f"{name}.{last_name}@test.com"
+
+    #
+    contact_data = {
+        "name": name,
+        "lastname": last_name,
+        "email": email,
+        "companyId": "MAGICFEEDBACK_DEV_SDK"
+    }
+
+    response = client.create_contact(contact_data)
+
+    assert "id" in response
+    # Check if the created contact has the correct name
+    assert response["name"] == name
+    assert response["lastname"] == last_name
+    assert response["email"] == email
+
+def test_list_contact(client):
+    """Tests listing contact items."""
+
+    filter = {
+        "where": {
+            "companyId": "MAGICFEEDBACK_DEV_SDK"
+        }
+    }
+
+    response = client.get_contacts(filter)
+    assert len(response) > 0
+
+@pytest.fixture
+def client():
+    """Provides a MagicFeedbackClient instance for testing."""
+
+    client = MagicFeedbackClient('sdk_tester@magicfeedback.io', 'caracter')
+    return client
+
+# Generate random name, last name and email
+
+
+def generate_random_string(length):
+    """Generates a random string of given length."""
+    letters = string.ascii_letters
+    return ''.join(random.choice(letters) for _ in range(length))

{magicfeedback-0.0.2 → magicfeedback-0.0.3}/tests/test_feedback_create.py

@@ -1,6 +1,8 @@
 import pytest
+
 from src.magicfeedback import MagicFeedbackClient
 
+
 def test_create_feedback(client):
     """Tests creating a new feedback item."""
 

magicfeedback-0.0.2/src/magicfeedback.py

@@ -1,131 +0,0 @@
-import json
-from typing import Any, Dict
-
-import requests
-
-
-class MagicFeedbackClient:
-    """A Python SDK for interacting with the MagicFeedback API."""
-
-    def __init__(self, user: str, password: str, base_url: str = "https://api.magicfeedback.io", ip_key: str = 'AIzaSyAKcR895VURSQZSN2T_RD6jX_9y5HRmH80'):
-
-        self.base_url = base_url
-        self.ip_key = ip_key
-
-        self.api_key = self.get_api_key(user, password)
-        self.headers = {"Authorization": f"Bearer {self.api_key}"}
-
-    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
-        # Call your existing function
-        id_token = self.identity_login(user, password)
-        return id_token
-
-    def identity_login(self, user, password):
-        """
-        (Replace this function with your existing `identity_login` function)
-
-        Performs user and password-based login using the identity toolkit API.
-
-        Returns:
-            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)
-
-        options = {
-            "method": "POST",
-            "url": "https://identitytoolkit.googleapis.com/v1/accounts:signInWithPassword?key=" + self.ip_key,
-            "headers": {
-                "Content-Type": "application/javascript",
-            },
-            "data": json.dumps({
-                "email": user,
-                "password": password,
-                "returnSecureToken": True
-            })
-        }
-
-        response = requests.post(
-            options["url"], headers=options["headers"], data=options["data"])
-        data = json.loads(response.text)
-        return data["idToken"]
-
-    def _make_request(
-        self, method: str, url: str, json: Dict[str, Any] = None
-    ) -> Dict[str, Any]:
-        """Makes a request to the MagicFeedback API."""
-        # TODO: Control token expiration
-        response = requests.request(
-            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)
-        print("Response: ", response.json())
-
-        return response.json()
-
-    ####################################################################################
-    # Feedback API Methods                                                             #
-    ####################################################################################
-
-    def create_feedback(self, feedback: Dict[str, Any]) -> Dict[str, Any]:
-        """Creates a new feedback item.
-
-        Args:
-            feedback (Dict[str, Any]): The feedback data to create.
-
-        Returns:
-            Dict[str, Any]: The created feedback item.
-        """
-        url = f"{self.base_url}/feedbacks"
-
-        # Ensure required fields are present
-        required_fields = [
-            "name", "type", "identity",
-            "integrationId", "companyId",
-            "productId"
-        ]
-        for field in required_fields:
-            if field not in feedback:
-                raise ValueError(f"Missing required field: {field}")
-
-        return self._make_request("POST", url, json=feedback)
-
-    # Add other API methods as needed
-    def get_feedback(self, feedback_id: str) -> Dict[str, Any]:
-        """Retrieves a specific feedback item.
-
-        Args:
-            feedback_id (str): The ID of the feedback item.
-
-        Returns:
-            Dict[str, Any]: The retrieved feedback item.
-        """
-        url = f"{self.base_url}/feedbacks/{feedback_id}"
-        return self._make_request("GET", url)
-
-    def update_feedback(self, feedback_id: str, feedback: Dict[str, Any]) -> Dict[str, Any]:
-        """Updates a specific feedback item.
-
-        Args:
-            feedback_id (str): The ID of the feedback item.
-            feedback (Dict[str, Any]): The updated feedback data.
-
-        Returns:
-            Dict[str, Any]: The updated feedback item.
-        """
-        url = f"{self.base_url}/feedbacks/{feedback_id}"
-        return self._make_request("PUT", url, json=feedback)
-
-    def delete_feedback(self, feedback_id: str) -> None:
-        """Deletes a specific feedback item.
-
-        Args:
-            feedback_id (str): The ID of the feedback item.
-        """
-        url = f"{self.base_url}/feedbacks/{feedback_id}"
-        self._make_request("DELETE", url)