MagicFeedback 0.0.1__tar.gz

magicfeedback-0.0.1/LICENCE

@@ -0,0 +1,19 @@
+Copyright (c) 2024 MagicFeedback OÜ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.   

magicfeedback-0.0.1/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: MagicFeedback
+Version: 0.0.1
+Summary: SDK for MagicFeedback API
+Author-email: Francisco Arias <farias@magicfedback.io>
+Project-URL: Homepage, https://github.com/MagicFeedback/magicfeedback_python_sdk
+Project-URL: Issues, https://github.com/MagicFeedback/magicfeedback_python_sdk/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+
+# MagicFeedback SDK
+
+**A Python SDK for interacting with the MagicFeedback API**
+
+**Installation**
+
+Bash
+
+```
+pip install MagicFeeedback
+
+```
+
+Use code [with caution.](/faq#coding)
+
+**Usage**
+
+Python
+
+```
+from magicfeedback import MagicFeedbackClient
+
+# Create a MagicFeedbackClient instance
+client = MagicFeedbackClient('email', 'password')
+
+# Create a new feedback item
+feedback_data = {
+    "name": "Test Feedback",
+    "type": "DOCUMENT",
+    # ... other required fields
+}
+response = client.create_feedback(feedback_data)
+
+# Print the response
+print(response)
+
+```
+
+**API Reference**
+
+- **`create_feedback(feedback)`:** Creates a new feedback item.
+- **`get_feedback(feedback_id)`:** Retrieves a specific feedback item.
+- **`update_feedback(feedback_id, feedback)`:** Updates a specific feedback item.
+- **`delete_feedback(feedback_id)`:** Deletes a specific feedback item.
+
+**Additional Information**
+
+- **Authentication:** The SDK requires an user / password for authentication. You can obtain from the MagicFeedback platform.
+- **Error Handling:** The SDK handles common API errors and raises appropriate exceptions.
+- **Customizations:** You can customize the SDK to fit your specific needs by extending the `MagicFeedbackClient` class or creating additional helper functions.
+
+**License**
+
+This project is licensed under the MIT License.
+
+**Contact**
+
+For any questions or support, please contact farias@magicfeedback.io.

magicfeedback-0.0.1/README.md

@@ -0,0 +1,58 @@
+# MagicFeedback SDK
+
+**A Python SDK for interacting with the MagicFeedback API**
+
+**Installation**
+
+Bash
+
+```
+pip install MagicFeeedback
+
+```
+
+Use code [with caution.](/faq#coding)
+
+**Usage**
+
+Python
+
+```
+from magicfeedback import MagicFeedbackClient
+
+# Create a MagicFeedbackClient instance
+client = MagicFeedbackClient('email', 'password')
+
+# Create a new feedback item
+feedback_data = {
+    "name": "Test Feedback",
+    "type": "DOCUMENT",
+    # ... other required fields
+}
+response = client.create_feedback(feedback_data)
+
+# Print the response
+print(response)
+
+```
+
+**API Reference**
+
+- **`create_feedback(feedback)`:** Creates a new feedback item.
+- **`get_feedback(feedback_id)`:** Retrieves a specific feedback item.
+- **`update_feedback(feedback_id, feedback)`:** Updates a specific feedback item.
+- **`delete_feedback(feedback_id)`:** Deletes a specific feedback item.
+
+**Additional Information**
+
+- **Authentication:** The SDK requires an user / password for authentication. You can obtain from the MagicFeedback platform.
+- **Error Handling:** The SDK handles common API errors and raises appropriate exceptions.
+- **Customizations:** You can customize the SDK to fit your specific needs by extending the `MagicFeedbackClient` class or creating additional helper functions.
+
+**License**
+
+This project is licensed under the MIT License.
+
+**Contact**
+
+For any questions or support, please contact farias@magicfeedback.io.

magicfeedback-0.0.1/pyproject.toml

@@ -0,0 +1,18 @@
+[project]
+name = "MagicFeedback"
+version = "0.0.1"
+authors = [
+  { name="Francisco Arias", email="farias@magicfedback.io" },
+]
+description = "SDK for MagicFeedback API"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+Homepage = "https://github.com/MagicFeedback/magicfeedback_python_sdk"
+Issues = "https://github.com/MagicFeedback/magicfeedback_python_sdk/issues"

magicfeedback-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

magicfeedback-0.0.1/src/MagicFeedback.egg-info/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.1
+Name: MagicFeedback
+Version: 0.0.1
+Summary: SDK for MagicFeedback API
+Author-email: Francisco Arias <farias@magicfedback.io>
+Project-URL: Homepage, https://github.com/MagicFeedback/magicfeedback_python_sdk
+Project-URL: Issues, https://github.com/MagicFeedback/magicfeedback_python_sdk/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENCE
+
+# MagicFeedback SDK
+
+**A Python SDK for interacting with the MagicFeedback API**
+
+**Installation**
+
+Bash
+
+```
+pip install MagicFeeedback
+
+```
+
+Use code [with caution.](/faq#coding)
+
+**Usage**
+
+Python
+
+```
+from magicfeedback import MagicFeedbackClient
+
+# Create a MagicFeedbackClient instance
+client = MagicFeedbackClient('email', 'password')
+
+# Create a new feedback item
+feedback_data = {
+    "name": "Test Feedback",
+    "type": "DOCUMENT",
+    # ... other required fields
+}
+response = client.create_feedback(feedback_data)
+
+# Print the response
+print(response)
+
+```
+
+**API Reference**
+
+- **`create_feedback(feedback)`:** Creates a new feedback item.
+- **`get_feedback(feedback_id)`:** Retrieves a specific feedback item.
+- **`update_feedback(feedback_id, feedback)`:** Updates a specific feedback item.
+- **`delete_feedback(feedback_id)`:** Deletes a specific feedback item.
+
+**Additional Information**
+
+- **Authentication:** The SDK requires an user / password for authentication. You can obtain from the MagicFeedback platform.
+- **Error Handling:** The SDK handles common API errors and raises appropriate exceptions.
+- **Customizations:** You can customize the SDK to fit your specific needs by extending the `MagicFeedbackClient` class or creating additional helper functions.
+
+**License**
+
+This project is licensed under the MIT License.
+
+**Contact**
+
+For any questions or support, please contact farias@magicfeedback.io.

magicfeedback-0.0.1/src/MagicFeedback.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENCE
+README.md
+pyproject.toml
+src/__init__.py
+src/magicfeedback.py
+src/MagicFeedback.egg-info/PKG-INFO
+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_feedback_create.py

magicfeedback-0.0.1/src/MagicFeedback.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

magicfeedback-0.0.1/src/MagicFeedback.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+__init__
+magicfeedback

magicfeedback-0.0.1/src/magicfeedback.py

@@ -0,0 +1,132 @@
+import json
+from typing import Any, Dict, Optional
+
+import requests
+from google.auth.transport.requests import Request
+
+
+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)

magicfeedback-0.0.1/tests/test_apikey.py

@@ -0,0 +1,15 @@
+import pytest
+
+from src.magicfeedback import MagicFeedbackClient
+
+def test_api_key_set(client):
+    """Tests if the API key is set correctly."""
+    assert client.api_key is not None
+
+@pytest.fixture
+def client():
+    """Provides a MagicFeedbackClient instance for testing."""
+
+    client = MagicFeedbackClient('sdk_tester@magicfeedback.io', 'caracter')
+
+    return client

magicfeedback-0.0.1/tests/test_feedback_create.py

@@ -0,0 +1,45 @@
+import pytest
+from src.magicfeedback import MagicFeedbackClient
+
+def test_create_feedback(client):
+    """Tests creating a new feedback item."""
+
+    feedback_data = {
+        "name": "Test SDK Feedback",
+        "type": "APP",
+        "identity": "MAGICFORM",
+        "answers": [
+            {"key": "name", "value": "John Doe"},
+            {"key": "comment", "value": "This is a test comment."}
+        ],
+        "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"
+    
+@pytest.fixture
+def client():
+    """Provides a MagicFeedbackClient instance for testing."""
+
+    client = MagicFeedbackClient('sdk_tester@magicfeedback.io', 'caracter')
+    return client