Spaces:
Sleeping
Sleeping
File size: 21,266 Bytes
4b9d59b | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 | """
Airtable Integration Adapter
Provides OAuth-based integration with Airtable for database and spreadsheet operations.
"""
import logging
import os
import httpx
from typing import Dict, Any, List, Optional
from datetime import datetime, timedelta
from urllib.parse import urlencode
logger = logging.getLogger(__name__)
class AirtableAdapter:
"""
Adapter for Airtable OAuth integration.
Supports:
- OAuth 2.0 authentication (personal access tokens)
- Table and record management
- Base and schema operations
- Field and view access
"""
def __init__(self, db, workspace_id: str):
self.db = db
self.workspace_id = workspace_id
self.service_name = "airtable"
self.base_url = "https://api.airtable.com/v0"
# OAuth credentials from environment
self.client_id = os.getenv("AIRTABLE_CLIENT_ID")
self.client_secret = os.getenv("AIRTABLE_CLIENT_SECRET")
self.redirect_uri = os.getenv("AIRTABLE_REDIRECT_URI")
self.personal_access_token = os.getenv("AIRTABLE_PAT")
self._access_token: Optional[str] = None
self._refresh_token: Optional[str] = None
self._token_expires_at: Optional[datetime] = None
async def _load_token(self):
"""Load OAuth tokens from database for the current workspace"""
if not self.db:
return
from core.models import IntegrationToken
token = self.db.query(IntegrationToken).filter(
IntegrationToken.workspace_id == self.workspace_id,
IntegrationToken.provider == self.service_name
).first()
if token:
self._access_token = token.access_token
self._refresh_token = token.refresh_token
self._token_expires_at = token.expires_at
async def refresh_token(self) -> bool:
"""Refresh Airtable access token using refresh token"""
if not self._refresh_token:
return False
token_url = "https://airtable.com/oauth2/v1/token"
import base64
auth_header = base64.b64encode(f"{self.client_id}:{self.client_secret}".encode()).decode()
data = {
"grant_type": "refresh_token",
"refresh_token": self._refresh_token,
}
headers = {
"Authorization": f"Basic {auth_header}",
"Content-Type": "application/x-www-form-urlencoded"
}
try:
async with httpx.AsyncClient() as client:
response = await client.post(token_url, data=data, headers=headers)
response.raise_for_status()
token_data = response.json()
self._access_token = token_data.get("access_token")
self._refresh_token = token_data.get("refresh_token") # Airtable might issue new refresh token
expires_in = token_data.get("expires_in", 3600)
self._token_expires_at = datetime.now() + timedelta(seconds=expires_in)
# Update DB
if self.db:
from core.models import IntegrationToken
token = self.db.query(IntegrationToken).filter(
IntegrationToken.workspace_id == self.workspace_id,
IntegrationToken.provider == self.service_name
).first()
if token:
token.access_token = self._access_token
token.refresh_token = self._refresh_token
token.expires_at = self._token_expires_at
self.db.commit()
return True
except Exception as e:
logger.error(f"Airtable token refresh failed: {e}")
return False
async def ensure_token(self):
"""Ensure we have a valid access token"""
if not self._access_token:
await self._load_token()
if not self._access_token or (self._token_expires_at and self._token_expires_at < datetime.now()):
if self._refresh_token:
await self.refresh_token()
elif self.personal_access_token:
# Fallback to PAT if configured and OAuth fails
self._access_token = self.personal_access_token
async def get_oauth_url(self) -> str:
"""
Generate Airtable OAuth authorization URL.
Returns:
Authorization URL to redirect user to Airtable OAuth consent screen
"""
if not self.client_id:
raise ValueError("AIRTABLE_CLIENT_ID not configured")
# Airtable OAuth endpoint
auth_url = "https://airtable.com/oauth2/v1/authorize"
# Build authorization URL
params = {
"client_id": self.client_id,
"redirect_uri": self.redirect_uri,
"response_type": "code",
"scope": "data.records:read data.records:write schema.bases:read",
"state": self.workspace_id, # Use workspace_id as state
}
auth_url_with_params = f"{auth_url}?{urlencode(params)}"
logger.info(f"Generated Airtable OAuth URL for workspace {self.workspace_id}")
return auth_url_with_params
async def exchange_code_for_token(self, code: str) -> Dict[str, Any]:
"""
Exchange OAuth authorization code for access token.
Args:
code: Authorization code from OAuth callback
Returns:
Token response with access_token, refresh_token, expires_in, etc.
"""
if not self.client_id or not self.client_secret:
raise ValueError("Airtable OAuth credentials not configured")
token_url = "https://airtable.com/oauth2/v1/token"
data = {
"grant_type": "authorization_code",
"code": code,
"redirect_uri": self.redirect_uri,
"client_id": self.client_id,
"client_secret": self.client_secret,
}
try:
async with httpx.AsyncClient() as client:
response = await client.post(token_url, data=data)
response.raise_for_status()
token_data = response.json()
# Store tokens
self._access_token = token_data.get("access_token")
_refresh_token = token_data.get("refresh_token")
# Calculate token expiration
if "expires_in" in token_data:
self._token_expires_at = datetime.now() + timedelta(
seconds=token_data["expires_in"]
)
logger.info(f"Successfully obtained Airtable access token for workspace {self.workspace_id}")
return token_data
except httpx.HTTPStatusError as e:
logger.error(f"Airtable token exchange failed: {e}")
raise
async def test_connection(self) -> bool:
"""
Test the Airtable API connection.
Returns:
True if connection successful, False otherwise
"""
if not self._access_token and not self.personal_access_token:
return False
token = self._access_token or self.personal_access_token
try:
async with httpx.AsyncClient() as client:
# Test by getting user info
response = await client.get(
f"{self.base_url}/v0/meta/whoami",
headers={
"Authorization": f"Bearer {token}"
}
)
response.raise_for_status()
logger.info(f"Airtable connection test successful for workspace {self.workspace_id}")
return True
except Exception as e:
logger.error(f"Airtable connection test failed: {e}")
return False
async def list_bases(self) -> List[Dict[str, Any]]:
"""
Retrieve all Airtable bases accessible to the user.
Returns:
List of base objects
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
async with httpx.AsyncClient() as client:
response = await client.get(
"https://api.airtable.com/v0/meta/bases",
headers={
"Authorization": f"Bearer {token}"
}
)
response.raise_for_status()
data = response.json()
bases = data.get("bases", [])
logger.info(f"Retrieved {len(bases)} Airtable bases for workspace {self.workspace_id}")
return bases
except Exception as e:
logger.error(f"Failed to retrieve Airtable bases: {e}")
raise
async def list_tables(self, base_id: str) -> List[Dict[str, Any]]:
"""
Retrieve all tables in an Airtable base.
Args:
base_id: Base ID
Returns:
List of table objects with schema
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
async with httpx.AsyncClient() as client:
response = await client.get(
f"https://api.airtable.com/v0/meta/bases/{base_id}/tables",
headers={
"Authorization": f"Bearer {token}"
}
)
response.raise_for_status()
data = response.json()
tables = data.get("tables", [])
logger.info(f"Retrieved {len(tables)} Airtable tables for base {base_id}")
return tables
except Exception as e:
logger.error(f"Failed to retrieve Airtable tables for base {base_id}: {e}")
raise
async def get_records(self, base_id: str, table_name: str,
filter_by_formula: str = None, sort: List[Dict] = None,
max_records: int = 100) -> List[Dict[str, Any]]:
"""
Retrieve records from an Airtable table.
Args:
base_id: Base ID
table_name: Table name or ID
filter_by_formula: Airtable formula to filter records
sort: List of sort objects [{"field": "Name", "direction": "asc"}]
max_records: Maximum number of records to return
Returns:
List of record objects
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
params = {"max_records": max_records}
if filter_by_formula:
params["filter_by_formula"] = filter_by_formula
if sort:
params["sort[]"] = [f"{s['field']}:{s.get('direction', 'asc')}" for s in sort]
async with httpx.AsyncClient() as client:
response = await client.get(
f"{self.base_url}/{base_id}/{table_name}",
headers={
"Authorization": f"Bearer {token}"
},
params=params
)
response.raise_for_status()
data = response.json()
records = data.get("records", [])
logger.info(f"Retrieved {len(records)} Airtable records for workspace {self.workspace_id}")
return records
except Exception as e:
logger.error(f"Failed to retrieve Airtable records: {e}")
raise
async def get_record(self, base_id: str, table_name: str, record_id: str) -> Dict[str, Any]:
"""
Retrieve a specific Airtable record by ID.
Args:
base_id: Base ID
table_name: Table name or ID
record_id: Record ID
Returns:
Record details with all fields
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
async with httpx.AsyncClient() as client:
response = await client.get(
f"{self.base_url}/{base_id}/{table_name}/{record_id}",
headers={
"Authorization": f"Bearer {token}"
}
)
response.raise_for_status()
record = response.json()
logger.info(f"Retrieved Airtable record {record_id} for workspace {self.workspace_id}")
return record
except Exception as e:
logger.error(f"Failed to retrieve Airtable record {record_id}: {e}")
raise
async def create_record(self, base_id: str, table_name: str,
fields: Dict[str, Any]) -> Dict[str, Any]:
"""
Create a new Airtable record.
Args:
base_id: Base ID
table_name: Table name or ID
fields: Record field values
Returns:
Created record object with ID
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
async with httpx.AsyncClient() as client:
response = await client.post(
f"{self.base_url}/{base_id}/{table_name}",
headers={
"Authorization": f"Bearer {token}",
"Content-Type": "application/json"
},
json={
"records": [
{
"fields": fields
}
]
}
)
response.raise_for_status()
data = response.json()
record = data.get("records", [{}])[0]
logger.info(f"Created Airtable record {record.get('id')} for workspace {self.workspace_id}")
return record
except Exception as e:
logger.error(f"Failed to create Airtable record: {e}")
raise
async def update_record(self, base_id: str, table_name: str, record_id: str,
fields: Dict[str, Any]) -> Dict[str, Any]:
"""
Update an Airtable record.
Args:
base_id: Base ID
table_name: Table name or ID
record_id: Record ID to update
fields: Field values to update
Returns:
Updated record object
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
async with httpx.AsyncClient() as client:
response = await client.patch(
f"{self.base_url}/{base_id}/{table_name}/{record_id}",
headers={
"Authorization": f"Bearer {token}",
"Content-Type": "application/json"
},
json={
"fields": fields
}
)
response.raise_for_status()
record = response.json()
logger.info(f"Updated Airtable record {record_id} in workspace {self.workspace_id}")
return record
except Exception as e:
logger.error(f"Failed to update Airtable record {record_id}: {e}")
raise
async def delete_record(self, base_id: str, table_name: str, record_id: str) -> bool:
"""
Delete an Airtable record.
Args:
base_id: Base ID
table_name: Table name or ID
record_id: Record ID to delete
Returns:
True if successful
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
async with httpx.AsyncClient() as client:
response = await client.delete(
f"{self.base_url}/{base_id}/{table_name}/{record_id}",
headers={
"Authorization": f"Bearer {token}"
}
)
response.raise_for_status()
logger.info(f"Deleted Airtable record {record_id} in workspace {self.workspace_id}")
return True
except Exception as e:
logger.error(f"Failed to delete Airtable record {record_id}: {e}")
return False
async def search_records(self, base_id: str, table_name: str,
field_name: str, search_value: str,
max_records: int = 20) -> List[Dict[str, Any]]:
"""
Search Airtable records by field value.
Args:
base_id: Base ID
table_name: Table name or ID
field_name: Field to search in
search_value: Value to search for
max_records: Maximum number of results
Returns:
List of matching record objects
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
# Build filter formula
formula = f"FIND('{search_value}', LOWER({{{field_name}}})) > 0"
except Exception as e:
logger.error(f"Failed to search Airtable records: {e}")
raise
async def get_available_schemas(self) -> List[Dict[str, Any]]:
"""
Retrieve all available table schemas across all accessible Airtable bases.
Traverses Bases -> Tables.
Returns:
List of schema objects, where each object represents a table in a base.
"""
try:
bases = await self.list_bases()
all_schemas = []
for base in bases:
base_id = base.get("id")
base_name = base.get("name")
try:
tables = await self.list_tables(base_id)
for table in tables:
# Enrich table schema with base identity
table["base_id"] = base_id
table["base_name"] = base_name
all_schemas.append(table)
except Exception as e:
logger.warning(f"Failed to fetch tables for Airtable base {base_id} ({base_name}): {e}")
logger.info(f"Discovered {len(all_schemas)} tables across {len(bases)} Airtable bases")
return all_schemas
except Exception as e:
logger.error(f"Failed to discover Airtable schemas: {e}")
return []
async def fetch_records(self, entity_type: str, limit: int = 100, after: Optional[str] = None) -> Dict[str, Any]:
"""
Unified method to fetch records from an Airtable table.
Args:
entity_type: Composite ID in format 'base_id:table_name' or 'base_id:table_id'
limit: Maximum records to fetch.
after: Offset for pagination.
Returns:
Dictionary with 'results' (list) and 'paging' (dict).
"""
token = self._access_token or self.personal_access_token
if not token:
raise ValueError("Airtable access token not configured")
try:
if ":" not in entity_type:
logger.error(f"Invalid Airtable entity_type format: {entity_type}. Expected 'base_id:table_name'")
return {"results": [], "paging": {}}
base_id, table_name = entity_type.split(":", 1)
params = {"maxRecords": limit}
if after:
params["offset"] = after
async with httpx.AsyncClient() as client:
response = await client.get(
f"{self.base_url}/{base_id}/{table_name}",
headers={"Authorization": f"Bearer {token}"},
params=params
)
response.raise_for_status()
data = response.json()
return {
"results": data.get("records", []),
"paging": {"after": data.get("offset")} if data.get("offset") else {}
}
except Exception as e:
logger.error(f"Failed to fetch records from Airtable {entity_type}: {e}")
return {"results": [], "paging": {}}
|