swarmauri_tool_zapierhook 0.6.0.dev154__tar.gz

swarmauri_tool_zapierhook-0.6.0.dev154/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.3
+Name: swarmauri_tool_zapierhook
+Version: 0.6.0.dev154
+Summary: Zapier Hook Tool
+License: Apache-2.0
+Author: Jacob Stewart
+Author-email: jacob@swarmauri.com
+Requires-Python: >=3.10,<3.13
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: swarmauri_base (>=0.6.0.dev154,<0.7.0)
+Requires-Dist: swarmauri_core (>=0.6.0.dev154,<0.7.0)
+Project-URL: Repository, http://github.com/swarmauri/swarmauri-sdk
+Description-Content-Type: text/markdown
+
+# Swarmauri Example Community Package

swarmauri_tool_zapierhook-0.6.0.dev154/README.md

@@ -0,0 +1 @@
+# Swarmauri Example Community Package

swarmauri_tool_zapierhook-0.6.0.dev154/pyproject.toml

@@ -0,0 +1,53 @@
+[tool.poetry]
+name = "swarmauri_tool_zapierhook"
+version = "0.6.0.dev154"
+description = "Zapier Hook Tool"
+authors = ["Jacob Stewart <jacob@swarmauri.com>"]
+license = "Apache-2.0"
+readme = "README.md"
+repository = "http://github.com/swarmauri/swarmauri-sdk"
+classifiers = [
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12"
+]
+
+[tool.poetry.dependencies]
+python = ">=3.10,<3.13"
+
+# Swarmauri
+swarmauri_core = {version = "^0.6.0.dev154"}
+swarmauri_base = {version = "^0.6.0.dev154"}
+
+[tool.poetry.group.dev.dependencies]
+flake8 = "^7.0"
+pytest = "^8.0"
+pytest-asyncio = ">=0.24.0"
+pytest-xdist = "^3.6.1"
+pytest-json-report = "^1.5.0"
+python-dotenv = "*"
+requests = "^2.32.3"
+
+[build-system]
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+norecursedirs = ["combined", "scripts"]
+
+markers = [
+    "test: standard test",
+    "unit: Unit tests",
+    "integration: Integration tests",
+    "acceptance: Acceptance tests",
+    "experimental: Experimental tests"
+]
+log_cli = true
+log_cli_level = "INFO"
+log_cli_format = "%(asctime)s [%(levelname)s] %(message)s"
+log_cli_date_format = "%Y-%m-%d %H:%M:%S"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.poetry.plugins."swarmauri.tools"]
+ZapierHookTool = "swarmauri_tool_zapierhook.ZapierHookTool:ZapierHookTool"

swarmauri_tool_zapierhook-0.6.0.dev154/swarmauri_tool_zapierhook/ZapierHookTool.py

@@ -0,0 +1,84 @@
+import json
+import requests
+from typing import Dict, List, Literal
+from swarmauri_core.ComponentBase import ComponentBase
+from swarmauri_base.tools.ToolBase import ToolBase
+from swarmauri_standard.tools.Parameter import Parameter
+from pydantic import Field
+
+
+"""
+- Zapier's webhooks do not require authentication for basic usage,
+    as they are designed to be secure via their unique URLs.
+- The webhook URL (https://hooks.zapier.com/hooks/catch/{zap_id}/) includes
+    a randomly generated identifier that is private to you,
+    ensuring that only those with the specific URL can trigger the Zap.
+
+Reference
+---------------
+- https://www.switchlabs.dev/resources/locating-your-webhook-url-in-zapier
+- https://zapier.com/apps/webhook/integrations
+- https://zapier.com/engineering/webhook-design/
+
+"""
+
+@ComponentBase.register_type(ToolBase, "ZapierHookTool")
+class ZapierHookTool(ToolBase):
+    version: str = "1.0.0"
+    parameters: List[Parameter] = Field(
+        default_factory=lambda: [
+            Parameter(
+                name="payload",
+                type="string",
+                description="A Payload to send when triggering the Zapier webhook",
+                required=True,
+            )
+        ]
+    )
+
+    name: str = "ZapierTool"
+    description: str = "Tool to authenticate with Zapier and execute zaps."
+    type: Literal["ZapierHookTool"] = "ZapierHookTool"
+
+    content_type: str = "application/json"
+    zap_url: str
+
+    def execute_zap(self, payload: str) -> str:
+        """Execute a zap with given payload.
+
+        Args:
+            payload (str): The data payload to send to the Zap.
+
+        Returns:
+            str: The response from Zapier API.
+        """
+        headers = {"Content-Type": self.content_type}
+
+        response = requests.post(
+            self.zap_url,
+            json={"data": payload},
+            headers=headers,
+        )
+        # Checking the HTTP response status for success or failure
+        if response.status_code == 200:
+            return json.dumps(response.json())
+        else:
+            response.raise_for_status()  # This will raise an error for non-200 responses
+
+    def __call__(self, payload: str) -> Dict[str, str]:
+        """
+        Enable the tool to be called directly with the given payload and return the zap response.
+
+        Parameters:
+        payload (str): The input string to be processed by the tool.
+
+        Returns:
+        Dict[str, str]: A dictionary with a single key "zap_response", containing the result of executing the zap.
+
+        Example:
+        >>> tool = YourToolClass()
+        >>> result = tool("some payload")
+        >>> print(result)
+        {'zap_response': 'processed result'}
+        """
+        return {"zap_response": self.execute_zap(payload)}

swarmauri_tool_zapierhook-0.6.0.dev154/swarmauri_tool_zapierhook/__init__.py

@@ -0,0 +1,12 @@
+from .ZapierHookTool import ZapierHookTool
+
+__version__ = "0.6.0.dev26"
+__long_desc__ = """
+
+# Swarmauri ZapierHook Tool Plugin
+
+Visit us at: https://swarmauri.com
+Follow us at: https://github.com/swarmauri
+Star us at: https://github.com/swarmauri/swarmauri-sdk
+
+"""