Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

feat: adding google calendar toolkit (#2051)

JINO ROHIT13854caac4d8
diff --git a/.github/workflows/build_package.yml b/.github/workflows/build_package.yml
index 0f41a32e6..2e35708a7 100644
--- a/.github/workflows/build_package.yml
+++ b/.github/workflows/build_package.yml
@@ -101,6 +101,8 @@ jobs:
OPENROUTER_API_KEY: "${{ secrets.OPENROUTER_API_KEY }}"
MODELSCOPE_SDK_TOKEN: "${{ secrets.MODELSCOPE_SDK_TOKEN }}"
NOTION_TOKEN: "${{ secrets.NOTION_TOKEN }}"
+ GOOGLE_CLIENT_ID: "${{ secrets.GOOGLE_CLIENT_ID }}"
+ GOOGLE_CLIENT_SECRET: "${{ secrets.GOOGLE_CLIENT_SECRET }}"
run: |
source test_venv/bin/activate
pytest --fast-test-mode ./test
diff --git a/.github/workflows/pytest_package.yml b/.github/workflows/pytest_package.yml
index 79bc6509c..82605035f 100644
--- a/.github/workflows/pytest_package.yml
+++ b/.github/workflows/pytest_package.yml
@@ -66,6 +66,8 @@ jobs:
OPENROUTER_API_KEY: "${{ secrets.OPENROUTER_API_KEY }}"
MODELSCOPE_SDK_TOKEN: "${{ secrets.MODELSCOPE_SDK_TOKEN }}"
NOTION_TOKEN: "${{ secrets.NOTION_TOKEN }}"
+ GOOGLE_CLIENT_ID: "${{ secrets.GOOGLE_CLIENT_ID }}"
+ GOOGLE_CLIENT_SECRET: "${{ secrets.GOOGLE_CLIENT_SECRET }}"
run: |
source .venv/bin/activate
uv pip install -e ".[all, dev, docs]"
@@ -124,6 +126,8 @@ jobs:
OPENROUTER_API_KEY: "${{ secrets.OPENROUTER_API_KEY }}"
MODELSCOPE_SDK_TOKEN: "${{ secrets.MODELSCOPE_SDK_TOKEN }}"
NOTION_TOKEN: "${{ secrets.NOTION_TOKEN }}"
+ GOOGLE_CLIENT_ID: "${{ secrets.GOOGLE_CLIENT_ID }}"
+ GOOGLE_CLIENT_SECRET: "${{ secrets.GOOGLE_CLIENT_SECRET }}"
run: |
source .venv/bin/activate
uv pip install -e ".[all, dev, docs]"
@@ -180,6 +184,8 @@ jobs:
OPENROUTER_API_KEY: "${{ secrets.OPENROUTER_API_KEY }}"
MODELSCOPE_SDK_TOKEN: "${{ secrets.MODELSCOPE_SDK_TOKEN }}"
NOTION_TOKEN: "${{ secrets.NOTION_TOKEN }}"
+ GOOGLE_CLIENT_ID: "${{ secrets.GOOGLE_CLIENT_ID }}"
+ GOOGLE_CLIENT_SECRET: "${{ secrets.GOOGLE_CLIENT_SECRET }}"
run: |
source .venv/bin/activate
uv pip install -e ".[all, dev, docs]"
diff --git a/camel/toolkits/__init__.py b/camel/toolkits/__init__.py
index c548373eb..a5ac62ac4 100644
--- a/camel/toolkits/__init__.py
+++ b/camel/toolkits/__init__.py
@@ -35,6 +35,7 @@ from .google_maps_toolkit import GoogleMapsToolkit
from .code_execution import CodeExecutionToolkit
from .github_toolkit import GithubToolkit
from .google_scholar_toolkit import GoogleScholarToolkit
+from .google_calendar_toolkit import GoogleCalendarToolkit
from .arxiv_toolkit import ArxivToolkit
from .slack_toolkit import SlackToolkit
from .whatsapp_toolkit import WhatsAppToolkit
@@ -91,6 +92,7 @@ __all__ = [
'AskNewsToolkit',
'AsyncAskNewsToolkit',
'GoogleScholarToolkit',
+ 'GoogleCalendarToolkit',
'NotionToolkit',
'ArxivToolkit',
'HumanToolkit',
diff --git a/camel/toolkits/google_calendar_toolkit.py b/camel/toolkits/google_calendar_toolkit.py
new file mode 100644
index 000000000..626ace89f
--- /dev/null
+++ b/camel/toolkits/google_calendar_toolkit.py
@@ -0,0 +1,431 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Setup guide - https://developers.google.com/calendar/api/quickstart/python
+
+import datetime
+import os
+from typing import Any, Dict, List, Optional, Union
+
+from camel.logger import get_logger
+from camel.toolkits import FunctionTool
+from camel.toolkits.base import BaseToolkit
+from camel.utils.commons import api_keys_required
+
+logger = get_logger(__name__)
+
+SCOPES = ['https://www.googleapis.com/auth/calendar']
+
+
+class GoogleCalendarToolkit(BaseToolkit):
+ r"""A class representing a toolkit for Google Calendar operations.
+
+ This class provides methods for creating events, retrieving events,
+ updating events, and deleting events from a Google Calendar.
+ """
+
+ def __init__(
+ self,
+ timeout: Optional[float] = None,
+ ):
+ r"""Initializes a new instance of the GoogleCalendarToolkit class.
+
+ Args:
+ timeout (Optional[float]): The timeout value for API requests
+ in seconds. If None, no timeout is applied.
+ (default: :obj:`None`)
+ """
+ super().__init__(timeout=timeout)
+ self.service = self._get_calendar_service()
+
+ def create_event(
+ self,
+ event_title: str,
+ start_time: str,
+ end_time: str,
+ description: str = "",
+ location: str = "",
+ attendees_email: Optional[List[str]] = None,
+ timezone: str = "UTC",
+ ) -> Dict[str, Any]:
+ r"""Creates an event in the user's primary Google Calendar.
+
+ Args:
+ event_title (str): Title of the event.
+ start_time (str): Start time in ISO format (YYYY-MM-DDTHH:MM:SS).
+ end_time (str): End time in ISO format (YYYY-MM-DDTHH:MM:SS).
+ description (str, optional): Description of the event.
+ location (str, optional): Location of the event.
+ attendees_email (List[str], optional): List of email addresses.
+ (default: :obj:`None`)
+ timezone (str, optional): Timezone for the event.
+ (default: :obj:`UTC`)
+
+ Returns:
+ dict: A dictionary containing details of the created event.
+
+ Raises:
+ ValueError: If the event creation fails.
+ """
+ try:
+ # Handle ISO format with or without timezone info
+ if 'Z' in start_time or '+' in start_time:
+ datetime.datetime.fromisoformat(
+ start_time.replace('Z', '+00:00')
+ )
+ else:
+ datetime.datetime.strptime(start_time, "%Y-%m-%dT%H:%M:%S")
+
+ if 'Z' in end_time or '+' in end_time:
+ datetime.datetime.fromisoformat(
+ end_time.replace('Z', '+00:00')
+ )
+ else:
+ datetime.datetime.strptime(end_time, "%Y-%m-%dT%H:%M:%S")
+ except ValueError as e:
+ error_msg = f"Time format error: {e!s}. Expected ISO "
+ "format: YYYY-MM-DDTHH:MM:SS"
+ logger.error(error_msg)
+ return {"error": error_msg}
+
+ if attendees_email is None:
+ attendees_email = []
+
+ # Verify email addresses with improved validation
+ valid_emails = []
+ import re
+
+ email_pattern = re.compile(
+ r'^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$'
+ )
+
+ for email in attendees_email:
+ if email_pattern.match(email):
+ valid_emails.append(email)
+ else:
+ logger.error(f"Invalid email address: {email}")
+ return {"error": f"Invalid email address: {email}"}
+
+ event: Dict[str, Any] = {
+ 'summary': event_title,
+ 'location': location,
+ 'description': description,
+ 'start': {
+ 'dateTime': start_time,
+ 'timeZone': timezone,
+ },
+ 'end': {
+ 'dateTime': end_time,
+ 'timeZone': timezone,
+ },
+ }
+
+ if valid_emails:
+ event['attendees'] = [{'email': email} for email in valid_emails]
+
+ try:
+ created_event = (
+ self.service.events()
+ .insert(calendarId='primary', body=event)
+ .execute()
+ )
+ return {
+ 'Event ID': created_event.get('id'),
+ 'EventTitle': created_event.get('summary'),
+ 'Start Time': created_event.get('start', {}).get('dateTime'),
+ 'End Time': created_event.get('end', {}).get('dateTime'),
+ 'Link': created_event.get('htmlLink'),
+ }
+ except Exception as e:
+ error_msg = f"Failed to create event: {e!s}"
+ logger.error(error_msg)
+ return {"error": error_msg}
+
+ def get_events(
+ self, max_results: int = 10, time_min: Optional[str] = None
+ ) -> Union[List[Dict[str, Any]], Dict[str, Any]]:
+ r"""Retrieves upcoming events from the user's primary Google Calendar.
+
+ Args:
+ max_results (int, optional): Maximum number of events to retrieve.
+ (default: :obj:`10`)
+ time_min (str, optional): The minimum time to fetch events from.
+ If not provided, defaults to the current time.
+ (default: :obj:`None`)
+
+ Returns:
+ Union[List[Dict[str, Any]], Dict[str, Any]]: A list of
+ dictionaries, each containing details of an event, or a
+ dictionary with an error message.
+
+ Raises:
+ ValueError: If the event retrieval fails.
+ """
+ if time_min is None:
+ time_min = (
+ datetime.datetime.now(datetime.timezone.utc).isoformat() + 'Z'
+ )
+ else:
+ if not (time_min.endswith('Z')):
+ time_min = time_min + 'Z'
+
+ try:
+ events_result = (
+ self.service.events()
+ .list(
+ calendarId='primary',
+ timeMin=time_min,
+ maxResults=max_results,
+ singleEvents=True,
+ orderBy='startTime',
+ )
+ .execute()
+ )
+
+ events = events_result.get('items', [])
+
+ result = []
+ for event in events:
+ start = event['start'].get(
+ 'dateTime', event['start'].get('date')
+ )
+ result.append(
+ {
+ 'Event ID': event['id'],
+ 'Summary': event.get('summary', 'No Title'),
+ 'Start Time': start,
+ 'Link': event.get('htmlLink'),
+ }
+ )
+
+ return result
+ except Exception as e:
+ logger.error(f"Failed to retrieve events: {e!s}")
+ return {"error": f"Failed to retrieve events: {e!s}"}
+
+ def update_event(
+ self,
+ event_id: str,
+ event_title: Optional[str] = None,
+ start_time: Optional[str] = None,
+ end_time: Optional[str] = None,
+ description: Optional[str] = None,
+ location: Optional[str] = None,
+ attendees_email: Optional[List[str]] = None,
+ ) -> Dict[str, Any]:
+ r"""Updates an existing event in the user's primary Google Calendar.
+
+ Args:
+ event_id (str): The ID of the event to update.
+ event_title (Optional[str]): New title of the event.
+ (default: :obj:`None`)
+ start_time (Optional[str]): New start time in ISO format
+ (YYYY-MM-DDTHH:MM:SSZ).
+ (default: :obj:`None`)
+ end_time (Optional[str]): New end time in ISO format
+ (YYYY-MM-DDTHH:MM:SSZ).
+ (default: :obj:`None`)
+ description (Optional[str]): New description of the event.
+ (default: :obj:`None`)
+ location (Optional[str]): New location of the event.
+ (default: :obj:`None`)
+ attendees_email (Optional[List[str]]): List of email addresses.
+ (default: :obj:`None`)
+
+ Returns:
+ Dict[str, Any]: A dictionary containing details of the updated
+ event.
+
+ Raises:
+ ValueError: If the event update fails.
+ """
+ try:
+ event = (
+ self.service.events()
+ .get(calendarId='primary', eventId=event_id)
+ .execute()
+ )
+
+ # Update fields that are provided
+ if event_title:
+ event['summary'] = event_title
+ if description:
+ event['description'] = description
+ if location:
+ event['location'] = location
+ if start_time:
+ event['start']['dateTime'] = start_time
+ if end_time:
+ event['end']['dateTime'] = end_time
+ if attendees_email:
+ event['attendees'] = [
+ {'email': email} for email in attendees_email
+ ]
+
+ updated_event = (
+ self.service.events()
+ .update(calendarId='primary', eventId=event_id, body=event)
+ .execute()
+ )
+
+ return {
+ 'Event ID': updated_event.get('id'),
+ 'Summary': updated_event.get('summary'),
+ 'Start Time': updated_event.get('start', {}).get('dateTime'),
+ 'End Time': updated_event.get('end', {}).get('dateTime'),
+ 'Link': updated_event.get('htmlLink'),
+ 'Attendees': [
+ attendee.get('email')
+ for attendee in updated_event.get('attendees', [])
+ ],
+ }
+ except Exception:
+ raise ValueError("Failed to update event")
+
+ def delete_event(self, event_id: str) -> str:
+ r"""Deletes an event from the user's primary Google Calendar.
+
+ Args:
+ event_id (str): The ID of the event to delete.
+
+ Returns:
+ str: A message indicating the result of the deletion.
+
+ Raises:
+ ValueError: If the event deletion fails.
+ """
+ try:
+ self.service.events().delete(
+ calendarId='primary', eventId=event_id
+ ).execute()
+ return f"Event deleted successfully. Event ID: {event_id}"
+ except Exception:
+ raise ValueError("Failed to delete event")
+
+ def get_calendar_details(self) -> Dict[str, Any]:
+ r"""Retrieves details about the user's primary Google Calendar.
+
+ Returns:
+ dict: A dictionary containing details about the calendar.
+
+ Raises:
+ ValueError: If the calendar details retrieval fails.
+ """
+ try:
+ calendar = (
+ self.service.calendars().get(calendarId='primary').execute()
+ )
+ return {
+ 'Calendar ID': calendar.get('id'),
+ 'Summary': calendar.get('summary'),
+ 'Description': calendar.get('description', 'No description'),
+ 'Time Zone': calendar.get('timeZone'),
+ 'Access Role': calendar.get('accessRole'),
+ }
+ except Exception:
+ raise ValueError("Failed to retrieve calendar details")
+
+ def _get_calendar_service(self):
+ r"""Authenticates and creates a Google Calendar service object.
+
+ Returns:
+ Resource: A Google Calendar API service object.
+
+ Raises:
+ ValueError: If authentication fails.
+ """
+ from google.auth.transport.requests import Request
+ from googleapiclient.discovery import build
+
+ # Get credentials through authentication
+ try:
+ creds = self._authenticate()
+
+ # Refresh token if expired
+ if creds and creds.expired and creds.refresh_token:
+ creds.refresh(Request())
+
+ service = build('calendar', 'v3', credentials=creds)
+ return service
+ except Exception as e:
+ raise ValueError(f"Failed to build service: {e!s}")
+
+ @api_keys_required(
+ [
+ (None, "GOOGLE_CLIENT_ID"),
+ (None, "GOOGLE_CLIENT_SECRET"),
+ ]
+ )
+ def _authenticate(self):
+ r"""Gets Google OAuth2 credentials from environment variables.
+
+ Environment variables needed:
+ - GOOGLE_CLIENT_ID: The OAuth client ID
+ - GOOGLE_CLIENT_SECRET: The OAuth client secret
+ - GOOGLE_REFRESH_TOKEN: (Optional) Refresh token for reauthorization
+
+ Returns:
+ Credentials: A Google OAuth2 credentials object.
+ """
+ client_id = os.environ.get('GOOGLE_CLIENT_ID')
+ client_secret = os.environ.get('GOOGLE_CLIENT_SECRET')
+ refresh_token = os.environ.get('GOOGLE_REFRESH_TOKEN')
+ token_uri = os.environ.get(
+ 'GOOGLE_TOKEN_URI', 'https://oauth2.googleapis.com/token'
+ )
+
+ from google.oauth2.credentials import Credentials
+ from google_auth_oauthlib.flow import InstalledAppFlow
+
+ # For first-time authentication
+ if not refresh_token:
+ client_config = {
+ "installed": {
+ "client_id": client_id,
+ "client_secret": client_secret,
+ "auth_uri": "https://accounts.google.com/o/oauth2/auth",
+ "token_uri": token_uri,
+ "redirect_uris": ["http://localhost"],
+ }
+ }
+
+ flow = InstalledAppFlow.from_client_config(client_config, SCOPES)
+ creds = flow.run_local_server(port=0)
+
+ return creds
+ else:
+ # If we have a refresh token, use it to get credentials
+ return Credentials(
+ None,
+ refresh_token=refresh_token,
+ token_uri=token_uri,
+ client_id=client_id,
+ client_secret=client_secret,
+ scopes=SCOPES,
+ )
+
+ def get_tools(self) -> List[FunctionTool]:
+ r"""Returns a list of FunctionTool objects representing the
+ functions in the toolkit.
+
+ Returns:
+ List[FunctionTool]: A list of FunctionTool objects
+ representing the functions in the toolkit.
+ """
+ return [
+ FunctionTool(self.create_event),
+ FunctionTool(self.get_events),
+ FunctionTool(self.update_event),
+ FunctionTool(self.delete_event),
+ FunctionTool(self.get_calendar_details),
+ ]
diff --git a/docs/key_modules/tools.md b/docs/key_modules/tools.md
index cf403c625..bb41b8a24 100644
--- a/docs/key_modules/tools.md
+++ b/docs/key_modules/tools.md
@@ -161,6 +161,7 @@ CAMEL provides a variety of built-in toolkits that you can use right away. Here'
| FunctionTool | A base toolkit for creating function-based tools that OpenAI chat models can call, with support for schema parsing and synthesis. |
| FileWriteTool | A toolkit for creating, writing, and modifying text in files. |
| GitHubToolkit | A toolkit for interacting with GitHub repositories, including retrieving issues and creating pull requests. |
+| GoogleCalendarToolkit | A toolkit for creating events, retrieving events, updating events, and deleting events from a Google Calendar |
| GoogleMapsToolkit | A toolkit for accessing Google Maps services, including address validation, elevation data, and timezone information. |
| GoogleScholarToolkit | A toolkit for retrieving information about authors and their publications from Google Scholar. |
| HumanToolkit | A toolkit for facilitating human-in-the-loop interactions and feedback in AI systems. |
diff --git a/examples/toolkits/google_calendar_toolkit.py b/examples/toolkits/google_calendar_toolkit.py
new file mode 100644
index 000000000..52eb43233
--- /dev/null
+++ b/examples/toolkits/google_calendar_toolkit.py
@@ -0,0 +1,43 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+
+from camel.agents import ChatAgent
+from camel.configs import BaseConfig
+from camel.models import ModelFactory
+from camel.toolkits import GoogleCalendarToolkit
+from camel.types import ModelPlatformType, ModelType
+
+model = ModelFactory.create(
+ model_platform=ModelPlatformType.OPENAI,
+ model_type=ModelType.GPT_4O_MINI,
+ model_config_dict=BaseConfig().as_dict(),
+)
+
+calendar_toolkit = GoogleCalendarToolkit()
+calendar_tool = calendar_toolkit.get_tools()
+
+agent = ChatAgent(model=model, tools=calendar_tool)
+
+response = agent.step("What events from 3/30/2025 to the 4/5/2025")
+print(str(response.info['tool_calls'])[:1000])
+'''
+===============================================================================
+[ToolCallingRecord(tool_name='get_events', args={'max_results': 10, 'time_min'
+:'2025-03-30T00:00:00Z'},
+result=[{'Event ID': 'xxx_20250401T143000Z',
+'Summary': 'Weekly catchup',
+'Start Time': '2025-04-01T20:00:00+05:30',
+'Link': 'https://www.google.com/calendar/event?eid=xxx'}]
+===============================================================================
+'''
diff --git a/pyproject.toml b/pyproject.toml
index d44b9a2bd..63be9dbdf 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -91,6 +91,9 @@ web_tools = [
"pyowm>=3.3.0,<4",
"googlemaps>=4.10.0,<5",
"requests_oauthlib>=1.3.1,<2",
+ "google-api-python-client==2.166.0",
+ "google-auth-httplib2==0.2.0",
+ "google-auth-oauthlib==1.2.1",
"sympy>=1.13.3,<2",
"fastapi>=0.115.11",
"playwright>=1.50.0",
@@ -257,6 +260,9 @@ all = [
"sympy>=1.13.3,<2",
"pyowm>=3.3.0,<4",
"googlemaps>=4.10.0,<5",
+ "google-api-python-client==2.166.0",
+ "google-auth-httplib2==0.2.0",
+ "google-auth-oauthlib==1.2.1",
"requests_oauthlib>=1.3.1,<2",
"fastapi>=0.115.11",
"prance>=23.6.21.0,<24",
@@ -463,6 +469,7 @@ module = [
"sentence_transformers.*",
"pymilvus",
"pytidb",
+ "pytidb.schema",
"pillow",
"slack-sdk",
"slack-bolt",
@@ -475,6 +482,8 @@ module = [
"docker.*",
"google.*",
"google_generativeai",
+ "google_auth_oauthlib.flow",
+ "googleapiclient.discovery",
"mistralai",
"cohere",
"fish-audio-sdk",
diff --git a/test/toolkits/test_google_calendar_toolkit.py b/test/toolkits/test_google_calendar_toolkit.py
new file mode 100644
index 000000000..4a9022fa6
--- /dev/null
+++ b/test/toolkits/test_google_calendar_toolkit.py
@@ -0,0 +1,392 @@
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+from camel.toolkits import FunctionTool, GoogleCalendarToolkit
+
+
+def mock_calendar_service():
+ with patch('googleapiclient.discovery.build') as mock_build:
+ mock_service = MagicMock()
+ mock_build.return_value = mock_service
+
+ mock_events = MagicMock()
+ mock_service.events.return_value = mock_events
+
+ mock_calendars = MagicMock()
+ mock_service.calendars.return_value = mock_calendars
+
+ yield mock_service
+
+
+def calendar_toolkit(mock_calendar_service):
+ with (
+ patch('os.path.exists', return_value=True),
+ patch('pickle.load'),
+ patch('builtins.open'),
+ patch.dict(
+ 'os.environ',
+ {
+ 'GOOGLE_CLIENT_ID': 'mock_client_id',
+ 'GOOGLE_CLIENT_SECRET': 'mock_client_secret',
+ 'GOOGLE_REFRESH_TOKEN': 'mock_refresh_token',
+ },
+ ),
+ patch.object(
+ GoogleCalendarToolkit,
+ '_get_calendar_service',
+ return_value=mock_calendar_service,
+ ),
+ ):
+ toolkit = GoogleCalendarToolkit()
+ toolkit.service = (
+ mock_calendar_service # Ensure the service is set to our mock
+ )
+ yield toolkit
+
+
+def test_create_event(calendar_toolkit, mock_calendar_service):
+ event_mock = MagicMock()
+ mock_calendar_service.events().insert.return_value = event_mock
+ event_mock.execute.return_value = {
+ 'id': 'event123',
+ 'summary': 'Test Event',
+ 'start': {'dateTime': '2024-03-30T10:00:00'},
+ 'end': {'dateTime': '2024-03-30T11:00:00'},
+ 'htmlLink': 'https://calendar.google.com/event?id=event123',
+ }
+
+ result = calendar_toolkit.create_event(
+ event_title='Test Event',
+ start_time='2024-03-30T10:00:00',
+ end_time='2024-03-30T11:00:00',
+ description='Test Description',
+ location='Test Location',
+ attendees_email=['[email protected]'],
+ timezone='UTC',
+ )
+
+ assert result['Event ID'] == 'event123'
+ assert result['EventTitle'] == 'Test Event' # Updated field name
+ assert result['Start Time'] == '2024-03-30T10:00:00'
+ assert result['End Time'] == '2024-03-30T11:00:00'
+ assert result['Link'] == 'https://calendar.google.com/event?id=event123'
+
+ mock_calendar_service.events().insert.assert_called_once()
+ args, kwargs = mock_calendar_service.events().insert.call_args
+ assert kwargs['calendarId'] == 'primary'
+ event_body = kwargs['body']
+ assert event_body['summary'] == 'Test Event'
+ assert event_body['description'] == 'Test Description'
+ assert event_body['location'] == 'Test Location'
+ assert event_body['start']['dateTime'] == '2024-03-30T10:00:00'
+ assert event_body['end']['dateTime'] == '2024-03-30T11:00:00'
+ assert event_body['attendees'][0]['email'] == '[email protected]'
+
+
+def test_create_event_invalid_time_format(calendar_toolkit):
+ result = calendar_toolkit.create_event(
+ event_title='Test Event',
+ start_time='2024/03/30 10:00', # Invalid format
+ end_time='2024-03-30T11:00:00',
+ )
+
+ assert "error" in result
+ assert "Time format error" in result["error"]
+
+
+def test_create_event_invalid_email(calendar_toolkit):
+ result = calendar_toolkit.create_event(
+ event_title='Test Event',
+ start_time='2024-03-30T10:00:00',
+ end_time='2024-03-30T11:00:00',
+ attendees_email=['invalid-email'],
+ )
+
+ assert "error" in result
+ assert "Invalid email address" in result["error"]
+
+
+def test_create_event_failure(calendar_toolkit, mock_calendar_service):
+ event_mock = MagicMock()
+ mock_calendar_service.events().insert.return_value = event_mock
+ event_mock.execute.side_effect = Exception("API Error")
+
+ result = calendar_toolkit.create_event(
+ event_title='Test Event',
+ start_time='2024-03-30T10:00:00',
+ end_time='2024-03-30T11:00:00',
+ )
+
+ assert "error" in result
+ assert "Failed to create event" in result["error"]
+
+
+def test_get_events(calendar_toolkit, mock_calendar_service):
+ events_mock = MagicMock()
+ mock_calendar_service.events().list.return_value = events_mock
+ events_mock.execute.return_value = {
+ 'items': [
+ {
+ 'id': 'event123',
+ 'summary': 'Test Event 1',
+ 'start': {'dateTime': '2024-03-30T10:00:00Z'},
+ 'htmlLink': 'https://calendar.google.com/event?id=event123',
+ },
+ {
+ 'id': 'event456',
+ 'summary': 'Test Event 2',
+ 'start': {'dateTime': '2024-03-30T13:00:00Z'},
+ 'htmlLink': 'https://calendar.google.com/event?id=event456',
+ },
+ ]
+ }
+
+ result = calendar_toolkit.get_events(
+ max_results=10, time_min='2024-03-30T00:00:00Z'
+ )
+
+ assert len(result) == 2
+ assert result[0]['Event ID'] == 'event123'
+ assert result[0]['Summary'] == 'Test Event 1'
+ assert result[0]['Start Time'] == '2024-03-30T10:00:00Z'
+ assert result[1]['Event ID'] == 'event456'
+ assert result[1]['Summary'] == 'Test Event 2'
+
+ mock_calendar_service.events().list.assert_called_once()
+ args, kwargs = mock_calendar_service.events().list.call_args
+ assert kwargs['calendarId'] == 'primary'
+ assert kwargs['timeMin'] == '2024-03-30T00:00:00Z'
+ assert kwargs['maxResults'] == 10
+ assert kwargs['singleEvents'] is True
+ assert kwargs['orderBy'] == 'startTime'
+
+
+def test_get_events_with_default_time(calendar_toolkit, mock_calendar_service):
+ events_mock = MagicMock()
+ mock_calendar_service.events().list.return_value = events_mock
+ events_mock.execute.return_value = {'items': []}
+
+ calendar_toolkit.get_events(max_results=5)
+
+ args, kwargs = mock_calendar_service.events().list.call_args
+ assert kwargs['timeMin'].endswith('Z')
+ assert kwargs['maxResults'] == 5
+
+
+def test_get_events_empty_result(calendar_toolkit, mock_calendar_service):
+ events_mock = MagicMock()
+ mock_calendar_service.events().list.return_value = events_mock
+ events_mock.execute.return_value = {'items': []}
+
+ result = calendar_toolkit.get_events()
+
+ assert result == []
+
+
+def test_get_events_failure(calendar_toolkit, mock_calendar_service):
+ events_mock = MagicMock()
+ mock_calendar_service.events().list.return_value = events_mock
+ events_mock.execute.side_effect = Exception("API Error")
+
+ result = calendar_toolkit.get_events()
+
+ assert "error" in result
+ assert "Failed to retrieve events" in result["error"]
+
+
+def test_update_event(calendar_toolkit, mock_calendar_service):
+ get_mock = MagicMock()
+ update_mock = MagicMock()
+ mock_calendar_service.events().get.return_value = get_mock
+ mock_calendar_service.events().update.return_value = update_mock
+
+ get_mock.execute.return_value = {
+ 'id': 'event123',
+ 'summary': 'Old Title',
+ 'description': 'Old Description',
+ 'location': 'Old Location',
+ 'start': {'dateTime': '2024-03-30T10:00:00Z'},
+ 'end': {'dateTime': '2024-03-30T11:00:00Z'},
+ }
+
+ update_mock.execute.return_value = {
+ 'id': 'event123',
+ 'summary': 'New Title',
+ 'description': 'New Description',
+ 'location': 'New Location',
+ 'start': {'dateTime': '2024-03-30T12:00:00Z'},
+ 'end': {'dateTime': '2024-03-30T13:00:00Z'},
+ 'htmlLink': 'https://calendar.google.com/event?id=event123',
+ }
+
+ result = calendar_toolkit.update_event(
+ event_id='event123',
+ event_title='New Title',
+ description='New Description',
+ location='New Location',
+ start_time='2024-03-30T12:00:00Z',
+ end_time='2024-03-30T13:00:00Z',
+ )
+
+ assert result['Event ID'] == 'event123'
+ assert result['Summary'] == 'New Title'
+ assert result['Start Time'] == '2024-03-30T12:00:00Z'
+ assert result['End Time'] == '2024-03-30T13:00:00Z'
+
+ mock_calendar_service.events().get.assert_called_once_with(
+ calendarId='primary', eventId='event123'
+ )
+
+ args, kwargs = mock_calendar_service.events().update.call_args
+ assert kwargs['calendarId'] == 'primary'
+ assert kwargs['eventId'] == 'event123'
+ event_body = kwargs['body']
+ assert event_body['summary'] == 'New Title'
+ assert event_body['description'] == 'New Description'
+ assert event_body['location'] == 'New Location'
+ assert event_body['start']['dateTime'] == '2024-03-30T12:00:00Z'
+ assert event_body['end']['dateTime'] == '2024-03-30T13:00:00Z'
+
+
+def test_update_event_partial(calendar_toolkit, mock_calendar_service):
+ get_mock = MagicMock()
+ update_mock = MagicMock()
+ mock_calendar_service.events().get.return_value = get_mock
+ mock_calendar_service.events().update.return_value = update_mock
+
+ get_mock.execute.return_value = {
+ 'id': 'event123',
+ 'summary': 'Old Title',
+ 'description': 'Description',
+ 'location': 'Location',
+ 'start': {'dateTime': '2024-03-30T10:00:00Z'},
+ 'end': {'dateTime': '2024-03-30T11:00:00Z'},
+ }
+
+ update_mock.execute.return_value = {
+ 'id': 'event123',
+ 'summary': 'New Title',
+ 'description': 'Description',
+ 'location': 'Location',
+ 'start': {'dateTime': '2024-03-30T10:00:00Z'},
+ 'end': {'dateTime': '2024-03-30T11:00:00Z'},
+ 'htmlLink': 'https://calendar.google.com/event?id=event123',
+ }
+
+ _ = calendar_toolkit.update_event(
+ event_id='event123', event_title='New Title'
+ )
+
+ # Verify only summary was updated
+ args, kwargs = mock_calendar_service.events().update.call_args
+ event_body = kwargs['body']
+ assert event_body['summary'] == 'New Title'
+ assert event_body['description'] == 'Description' # Unchanged
+ assert event_body['location'] == 'Location' # Unchanged
+ assert (
+ event_body['start']['dateTime'] == '2024-03-30T10:00:00Z'
+ ) # Unchanged
+
+
+def test_update_event_failure(calendar_toolkit, mock_calendar_service):
+ get_mock = MagicMock()
+ mock_calendar_service.events().get.return_value = get_mock
+ get_mock.execute.side_effect = Exception("API Error")
+
+ with pytest.raises(ValueError) as excinfo:
+ calendar_toolkit.update_event(
+ event_id='event123', event_title='New Title'
+ )
+
+ assert "Failed to update event" in str(excinfo.value)
+
+
+def test_delete_event(calendar_toolkit, mock_calendar_service):
+ delete_mock = MagicMock()
+ mock_calendar_service.events().delete.return_value = delete_mock
+ delete_mock.execute.return_value = {}
+
+ result = calendar_toolkit.delete_event(event_id='event123')
+
+ assert "Event deleted successfully" in result
+ assert "event123" in result
+
+ mock_calendar_service.events().delete.assert_called_once_with(
+ calendarId='primary', eventId='event123'
+ )
+
+
+def test_delete_event_failure(calendar_toolkit, mock_calendar_service):
+ delete_mock = MagicMock()
+ mock_calendar_service.events().delete.return_value = delete_mock
+ delete_mock.execute.side_effect = Exception("API Error")
+
+ with pytest.raises(ValueError) as excinfo:
+ calendar_toolkit.delete_event(event_id='event123')
+
+ assert "Failed to delete event" in str(excinfo.value)
+
+
+def test_get_calendar_details(calendar_toolkit, mock_calendar_service):
+ get_mock = MagicMock()
+ mock_calendar_service.calendars().get.return_value = get_mock
+
+ get_mock.execute.return_value = {
+ 'id': 'primary',
+ 'summary': 'My Calendar',
+ 'description': 'Personal Calendar',
+ 'timeZone': 'America/New_York',
+ 'accessRole': 'owner',
+ }
+
+ result = calendar_toolkit.get_calendar_details()
+
+ assert result['Calendar ID'] == 'primary'
+ assert result['Summary'] == 'My Calendar'
+ assert result['Description'] == 'Personal Calendar'
+ assert result['Time Zone'] == 'America/New_York'
+ assert result['Access Role'] == 'owner'
+
+ mock_calendar_service.calendars().get.assert_called_once_with(
+ calendarId='primary'
+ )
+
+
+def test_get_calendar_details_failure(calendar_toolkit, mock_calendar_service):
+ get_mock = MagicMock()
+ mock_calendar_service.calendars().get.return_value = get_mock
+ get_mock.execute.side_effect = Exception("API Error")
+
+ with pytest.raises(ValueError) as excinfo:
+ calendar_toolkit.get_calendar_details()
+
+ assert "Failed to retrieve calendar details" in str(excinfo.value)
+
+
+def test_get_tools(calendar_toolkit):
+ tools = calendar_toolkit.get_tools()
+
+ assert len(tools) == 5
+ assert all(isinstance(tool, FunctionTool) for tool in tools)
+
+ assert tools[0].func == calendar_toolkit.create_event
+ assert tools[1].func == calendar_toolkit.get_events
+ assert tools[2].func == calendar_toolkit.update_event
+ assert tools[3].func == calendar_toolkit.delete_event
+ assert tools[4].func == calendar_toolkit.get_calendar_details
diff --git a/uv.lock b/uv.lock
index a54bf0da6..5edeb6a64 100644
--- a/uv.lock
+++ b/uv.lock
@@ -572,6 +572,9 @@ all = [
{ name = "firecrawl-py" },
{ name = "fish-audio-sdk" },
{ name = "fpdf" },
+ { name = "google-api-python-client" },
+ { name = "google-auth-httplib2" },
+ { name = "google-auth-oauthlib" },
{ name = "google-cloud-storage" },
{ name = "googlemaps" },
{ name = "gradio" },
@@ -838,6 +841,9 @@ web-tools = [
{ name = "exa-py" },
{ name = "fastapi" },
{ name = "firecrawl-py" },
+ { name = "google-api-python-client" },
+ { name = "google-auth-httplib2" },
+ { name = "google-auth-oauthlib" },
{ name = "googlemaps" },
{ name = "html2text" },
{ name = "linkup-sdk" },
@@ -928,6 +934,12 @@ requires-dist = [
{ name = "fpdf", marker = "extra == 'all'", specifier = ">=1.7.2" },
{ name = "fpdf", marker = "extra == 'document-tools'", specifier = ">=1.7.2" },
{ name = "fpdf", marker = "extra == 'owl'", specifier = ">=1.7.2" },
+ { name = "google-api-python-client", marker = "extra == 'all'", specifier = "==2.166.0" },
+ { name = "google-api-python-client", marker = "extra == 'web-tools'", specifier = "==2.166.0" },
+ { name = "google-auth-httplib2", marker = "extra == 'all'", specifier = "==0.2.0" },
+ { name = "google-auth-httplib2", marker = "extra == 'web-tools'", specifier = "==0.2.0" },
+ { name = "google-auth-oauthlib", marker = "extra == 'all'", specifier = "==1.2.1" },
+ { name = "google-auth-oauthlib", marker = "extra == 'web-tools'", specifier = "==1.2.1" },
{ name = "google-cloud-storage", marker = "extra == 'all'", specifier = ">=2.18.0,<3" },
{ name = "google-cloud-storage", marker = "extra == 'storage'", specifier = ">=2.18.0,<3" },
{ name = "googlemaps", marker = "extra == 'all'", specifier = ">=4.10.0,<5" },
@@ -2254,6 +2266,22 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/46/95/f472d85adab6e538da2025dfca9e976a0d125cc0af2301f190e77b76e51c/google_api_core-2.24.2-py3-none-any.whl", hash = "sha256:810a63ac95f3c441b7c0e43d344e372887f62ce9071ba972eacf32672e072de9", size = 160061 },
]
+[[package]]
+name = "google-api-python-client"
+version = "2.166.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+ { name = "google-api-core" },
+ { name = "google-auth" },
+ { name = "google-auth-httplib2" },
+ { name = "httplib2" },
+ { name = "uritemplate" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/c4/c9/eac7b4e843039f0a54a563c2328d43de6f02e426a11b6a7e378996f667db/google_api_python_client-2.166.0.tar.gz", hash = "sha256:b8cf843bd9d736c134aef76cf1dc7a47c9283a2ef24267b97207b9dd43b30ef7", size = 12680525 }
+wheels = [
+ { url = "https://files.pythonhosted.org/packages/b4/44/ae1528a6ca296d89704c8febb72b3e263c28b4e50ab29b9202df7a0f273d/google_api_python_client-2.166.0-py2.py3-none-any.whl", hash = "sha256:dd8cc74d9fc18538ab05cbd2e93cb4f82382f910c5f6945db06c91f1deae6e45", size = 13190078 },
+]
+
[[package]]
name = "google-auth"
version = "2.38.0"
@@ -2268,6 +2296,32 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/9d/47/603554949a37bca5b7f894d51896a9c534b9eab808e2520a748e081669d0/google_auth-2.38.0-py2.py3-none-any.whl", hash = "sha256:e7dae6694313f434a2727bf2906f27ad259bae090d7aa896590d86feec3d9d4a", size = 210770 },
]
+[[package]]
+name = "google-auth-httplib2"
+version = "0.2.0"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+ { name = "google-auth" },
+ { name = "httplib2" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/56/be/217a598a818567b28e859ff087f347475c807a5649296fb5a817c58dacef/google-auth-httplib2-0.2.0.tar.gz", hash = "sha256:38aa7badf48f974f1eb9861794e9c0cb2a0511a4ec0679b1f886d108f5640e05", size = 10842 }
+wheels = [
+ { url = "https://files.pythonhosted.org/packages/be/8a/fe34d2f3f9470a27b01c9e76226965863f153d5fbe276f83608562e49c04/google_auth_httplib2-0.2.0-py2.py3-none-any.whl", hash = "sha256:b65a0a2123300dd71281a7bf6e64d65a0759287df52729bdd1ae2e47dc311a3d", size = 9253 },
+]
+
+[[package]]
+name = "google-auth-oauthlib"
+version = "1.2.1"
+source = { registry = "https://pypi.org/simple" }
+dependencies = [
+ { name = "google-auth" },
+ { name = "requests-oauthlib" },
+]
+sdist = { url = "https://files.pythonhosted.org/packages/cc/0f/1772edb8d75ecf6280f1c7f51cbcebe274e8b17878b382f63738fd96cee5/google_auth_oauthlib-1.2.1.tar.gz", hash = "sha256:afd0cad092a2eaa53cd8e8298557d6de1034c6cb4a740500b5357b648af97263", size = 24970 }
+wheels = [
+ { url = "https://files.pythonhosted.org/packages/1a/8e/22a28dfbd218033e4eeaf3a0533b2b54852b6530da0c0fe934f0cc494b29/google_auth_oauthlib-1.2.1-py2.py3-none-any.whl", hash = "sha256:2d58a27262d55aa1b87678c3ba7142a080098cbc2024f903c62355deb235d91f", size = 24930 },
+]
+
[[package]]
name = "google-cloud-core"
version = "2.4.3"
@@ -7180,6 +7234,15 @@ wheels = [
{ url = "https://files.pythonhosted.org/packages/0c/ba/8dd7fa5f0b1c6a8ac62f8f57f7e794160c1f86f31c6d0fb00f582372a3e4/update_checker-0.18.0-py3-none-any.whl", hash = "sha256:cbba64760a36fe2640d80d85306e8fe82b6816659190993b7bdabadee4d4bbfd", size = 7008 },
]
+[[package]]
+name = "uritemplate"
+version = "4.1.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/d2/5a/4742fdba39cd02a56226815abfa72fe0aa81c33bed16ed045647d6000eba/uritemplate-4.1.1.tar.gz", hash = "sha256:4346edfc5c3b79f694bccd6d6099a322bbeb628dbf2cd86eea55a456ce5124f0", size = 273898 }
+wheels = [
+ { url = "https://files.pythonhosted.org/packages/81/c0/7461b49cd25aeece13766f02ee576d1db528f1c37ce69aee300e075b485b/uritemplate-4.1.1-py2.py3-none-any.whl", hash = "sha256:830c08b8d99bdd312ea4ead05994a38e8936266f84b9a7878232db50b044e02e", size = 10356 },
+]
+
[[package]]
name = "urllib3"
version = "2.3.0"