File size: 19,204 Bytes
824bf31 |
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 |
"""
Module: tools.transparency_api
Description: Client for Portal da Transparência API
Author: Anderson H. Silva
Date: 2025-01-24
License: Proprietary - All rights reserved
"""
import asyncio
from datetime import datetime, timedelta
from typing import Any, Dict, List, Optional, Union
from urllib.parse import urljoin
import httpx
from pydantic import BaseModel, Field as PydanticField, validator
from src.core import get_logger, settings
from src.core.exceptions import (
DataNotFoundError,
DataSourceError,
TransparencyAPIError,
)
class APIRateLimit:
"""Rate limiter for API requests."""
def __init__(self, max_requests_per_minute: int = 90):
self.max_requests = max_requests_per_minute
self.requests = []
self.logger = get_logger(__name__)
async def wait_if_needed(self) -> None:
"""Wait if rate limit would be exceeded."""
now = datetime.now()
# Remove requests older than 1 minute
self.requests = [req_time for req_time in self.requests
if now - req_time < timedelta(minutes=1)]
if len(self.requests) >= self.max_requests:
# Calculate wait time
oldest_request = min(self.requests)
wait_time = 60 - (now - oldest_request).total_seconds()
if wait_time > 0:
self.logger.warning(
"rate_limit_reached",
wait_time=wait_time,
requests_count=len(self.requests),
)
await asyncio.sleep(wait_time)
# Clean up old requests again after waiting
now = datetime.now()
self.requests = [req_time for req_time in self.requests
if now - req_time < timedelta(minutes=1)]
# Record this request
self.requests.append(now)
class TransparencyAPIFilter(BaseModel):
"""Filter parameters for API requests."""
ano: Optional[int] = PydanticField(default=None, description="Year")
mes: Optional[int] = PydanticField(default=None, ge=1, le=12, description="Month")
data_inicio: Optional[str] = PydanticField(default=None, description="Start date (DD/MM/YYYY)")
data_fim: Optional[str] = PydanticField(default=None, description="End date (DD/MM/YYYY)")
valor_inicial: Optional[float] = PydanticField(default=None, description="Minimum value")
valor_final: Optional[float] = PydanticField(default=None, description="Maximum value")
codigo_orgao: Optional[str] = PydanticField(default=None, description="Organization code (required for contratos/licitacoes)")
orgao: Optional[str] = PydanticField(default=None, description="Organization code (legacy)")
cnpj_contratado: Optional[str] = PydanticField(default=None, description="Contracted CNPJ")
modalidade: Optional[int] = PydanticField(default=None, description="Bidding modality")
pagina: int = PydanticField(default=1, ge=1, description="Page number")
tamanho_pagina: int = PydanticField(default=20, ge=1, le=500, description="Page size")
@validator('data_inicio', 'data_fim')
def validate_date_format(cls, v):
"""Validate date format."""
if v is not None:
try:
datetime.strptime(v, '%d/%m/%Y')
except ValueError:
raise ValueError('Date must be in DD/MM/YYYY format')
return v
def to_params(self) -> Dict[str, Any]:
"""Convert to query parameters."""
params = {}
for field, value in self.dict(exclude_none=True).items():
if value is not None:
# Convert snake_case to camelCase for API
if field == "data_inicio":
params["dataInicio"] = value
elif field == "data_fim":
params["dataFim"] = value
elif field == "valor_inicial":
params["valorInicial"] = value
elif field == "valor_final":
params["valorFinal"] = value
elif field == "cnpj_contratado":
params["cnpjContratado"] = value
elif field == "tamanho_pagina":
params["tamanhoPagina"] = value
elif field == "codigo_orgao":
params["codigoOrgao"] = value
elif field == "orgao":
# Legacy support - convert to codigoOrgao
params["codigoOrgao"] = value
else:
params[field] = value
return params
class TransparencyAPIResponse(BaseModel):
"""Response from Transparency API."""
data: List[Dict[str, Any]] = PydanticField(default_factory=list)
links: Optional[Dict[str, str]] = PydanticField(default=None)
meta: Optional[Dict[str, Any]] = PydanticField(default=None)
total_records: int = PydanticField(default=0)
current_page: int = PydanticField(default=1)
total_pages: int = PydanticField(default=1)
class TransparencyAPIClient:
"""
Client for Portal da Transparência API.
Handles authentication, rate limiting, caching, and error handling.
"""
def __init__(
self,
api_key: Optional[str] = None,
base_url: Optional[str] = None,
timeout: int = 30,
max_retries: int = 3,
rate_limit_per_minute: int = 90,
):
"""
Initialize the API client.
Args:
api_key: API key for authentication
base_url: Base URL for the API
timeout: Request timeout in seconds
max_retries: Maximum number of retries
rate_limit_per_minute: Maximum requests per minute
"""
self.api_key = api_key or settings.transparency_api_key.get_secret_value()
self.base_url = base_url or settings.transparency_api_base_url
self.timeout = timeout
self.max_retries = max_retries
self.header_key = settings.transparency_api_header_key
self.rate_limiter = APIRateLimit(rate_limit_per_minute)
self.logger = get_logger(__name__)
# HTTP client configuration
self.client = httpx.AsyncClient(
timeout=httpx.Timeout(timeout),
limits=httpx.Limits(max_keepalive_connections=10, max_connections=20),
)
self.logger.info(
"transparency_api_client_initialized",
base_url=self.base_url,
rate_limit=rate_limit_per_minute,
)
async def __aenter__(self):
"""Async context manager entry."""
return self
async def __aexit__(self, exc_type, exc_val, exc_tb):
"""Async context manager exit."""
await self.close()
async def close(self) -> None:
"""Close HTTP client."""
await self.client.aclose()
def _get_headers(self) -> Dict[str, str]:
"""Get request headers with authentication."""
return {
self.header_key: self.api_key,
"Content-Type": "application/json",
"User-Agent": "CidadaoAI/1.0.0",
}
async def _make_request(
self,
endpoint: str,
params: Optional[Dict[str, Any]] = None,
) -> Dict[str, Any]:
"""
Make an API request with retry logic.
Args:
endpoint: API endpoint
params: Query parameters
Returns:
API response data
Raises:
TransparencyAPIError: If request fails
"""
url = urljoin(self.base_url, endpoint)
headers = self._get_headers()
# Wait for rate limit if needed
await self.rate_limiter.wait_if_needed()
for attempt in range(self.max_retries + 1):
try:
self.logger.info(
"api_request_started",
url=url,
params=params,
attempt=attempt + 1,
)
response = await self.client.get(
url,
params=params,
headers=headers,
)
if response.status_code == 200:
data = response.json()
self.logger.info(
"api_request_success",
url=url,
status_code=response.status_code,
response_size=len(str(data)),
)
return data
elif response.status_code == 429:
# Rate limit exceeded
retry_after = int(response.headers.get("Retry-After", 60))
self.logger.warning(
"api_rate_limit_exceeded",
retry_after=retry_after,
attempt=attempt + 1,
)
if attempt < self.max_retries:
await asyncio.sleep(retry_after)
continue
raise TransparencyAPIError(
"Rate limit exceeded",
error_code="RATE_LIMIT_EXCEEDED",
details={"retry_after": retry_after}
)
elif response.status_code == 404:
raise DataNotFoundError(
f"Data not found for endpoint: {endpoint}",
details={"endpoint": endpoint, "params": params}
)
else:
# Other HTTP errors
error_msg = f"API request failed with status {response.status_code}"
try:
error_data = response.json()
error_msg += f": {error_data}"
except:
error_msg += f": {response.text}"
self.logger.error(
"api_request_failed",
url=url,
status_code=response.status_code,
error=error_msg,
attempt=attempt + 1,
)
if attempt < self.max_retries:
# Exponential backoff
await asyncio.sleep(2 ** attempt)
continue
raise TransparencyAPIError(
error_msg,
error_code=f"HTTP_{response.status_code}",
details={"status_code": response.status_code}
)
except httpx.TimeoutException:
self.logger.error(
"api_request_timeout",
url=url,
timeout=self.timeout,
attempt=attempt + 1,
)
if attempt < self.max_retries:
await asyncio.sleep(2 ** attempt)
continue
raise TransparencyAPIError(
f"Request timeout after {self.timeout} seconds",
error_code="TIMEOUT",
details={"timeout": self.timeout}
)
except Exception as e:
self.logger.error(
"api_request_error",
url=url,
error=str(e),
attempt=attempt + 1,
)
if attempt < self.max_retries:
await asyncio.sleep(2 ** attempt)
continue
raise TransparencyAPIError(
f"Unexpected error: {str(e)}",
error_code="UNEXPECTED_ERROR",
details={"original_error": str(e)}
)
raise TransparencyAPIError(
f"Failed after {self.max_retries + 1} attempts",
error_code="MAX_RETRIES_EXCEEDED"
)
def _parse_response(self, data: Dict[str, Any]) -> TransparencyAPIResponse:
"""Parse API response into structured format."""
# Handle different response formats
if isinstance(data, list):
# Simple list response
return TransparencyAPIResponse(
data=data,
total_records=len(data),
current_page=1,
total_pages=1,
)
elif isinstance(data, dict):
# Paginated response
response_data = data.get("data", data.get("items", []))
links = data.get("links", {})
meta = data.get("meta", {})
return TransparencyAPIResponse(
data=response_data,
links=links,
meta=meta,
total_records=meta.get("total", len(response_data)),
current_page=meta.get("current_page", 1),
total_pages=meta.get("last_page", 1),
)
else:
# Unexpected format
return TransparencyAPIResponse(
data=[],
total_records=0,
)
# Specific endpoint methods
async def get_contracts(
self,
filters: Optional[TransparencyAPIFilter] = None,
) -> TransparencyAPIResponse:
"""
Get government contracts.
Args:
filters: Filter parameters
Returns:
Contracts data
"""
params = filters.to_params() if filters else {}
data = await self._make_request("/api-de-dados/contratos", params)
return self._parse_response(data)
async def get_expenses(
self,
filters: Optional[TransparencyAPIFilter] = None,
) -> TransparencyAPIResponse:
"""
Get government expenses.
Args:
filters: Filter parameters
Returns:
Expenses data
"""
params = filters.to_params() if filters else {}
data = await self._make_request("/api-de-dados/despesas", params)
return self._parse_response(data)
async def get_agreements(
self,
filters: Optional[TransparencyAPIFilter] = None,
) -> TransparencyAPIResponse:
"""
Get government agreements (convênios).
Args:
filters: Filter parameters
Returns:
Agreements data
"""
params = filters.to_params() if filters else {}
data = await self._make_request("/api-de-dados/convenios", params)
return self._parse_response(data)
async def get_biddings(
self,
filters: Optional[TransparencyAPIFilter] = None,
) -> TransparencyAPIResponse:
"""
Get government biddings (licitações).
Args:
filters: Filter parameters
Returns:
Biddings data
"""
params = filters.to_params() if filters else {}
data = await self._make_request("/api-de-dados/licitacoes", params)
return self._parse_response(data)
async def get_servants(
self,
filters: Optional[TransparencyAPIFilter] = None,
) -> TransparencyAPIResponse:
"""
Get government servants.
Args:
filters: Filter parameters
Returns:
Servants data
"""
params = filters.to_params() if filters else {}
data = await self._make_request("/api-de-dados/servidores", params)
return self._parse_response(data)
async def search_data(
self,
endpoint: str,
filters: Optional[TransparencyAPIFilter] = None,
custom_params: Optional[Dict[str, Any]] = None,
) -> TransparencyAPIResponse:
"""
Generic search method for any endpoint.
Args:
endpoint: API endpoint
filters: Standard filter parameters
custom_params: Additional custom parameters
Returns:
Search results
"""
params = {}
if filters:
params.update(filters.to_params())
if custom_params:
params.update(custom_params)
data = await self._make_request(endpoint, params)
return self._parse_response(data)
async def get_all_pages(
self,
endpoint: str,
filters: Optional[TransparencyAPIFilter] = None,
max_pages: int = 10,
) -> List[Dict[str, Any]]:
"""
Get all pages of data from an endpoint.
Args:
endpoint: API endpoint
filters: Filter parameters
max_pages: Maximum number of pages to fetch
Returns:
All data from all pages
"""
all_data = []
current_filters = filters or TransparencyAPIFilter()
for page in range(1, max_pages + 1):
current_filters.pagina = page
try:
response = await self.search_data(endpoint, current_filters)
if not response.data:
break
all_data.extend(response.data)
self.logger.info(
"page_fetched",
endpoint=endpoint,
page=page,
records=len(response.data),
total_so_far=len(all_data),
)
# Check if this is the last page
if page >= response.total_pages:
break
except DataNotFoundError:
break
except Exception as e:
self.logger.error(
"page_fetch_failed",
endpoint=endpoint,
page=page,
error=str(e),
)
break
self.logger.info(
"all_pages_fetched",
endpoint=endpoint,
total_records=len(all_data),
pages_fetched=page,
)
return all_data
# Factory function for easy client creation
def create_transparency_client(**kwargs) -> TransparencyAPIClient:
"""
Create a Transparency API client with default settings.
Args:
**kwargs: Override default settings
Returns:
Configured API client
"""
return TransparencyAPIClient(**kwargs) |