fec26089ed
- Added JWT authentication support with configurable secret and expiration. - Introduced optional API key validation for endpoints. - Implemented tracking of publication downloads by researchers, storing records in a new PublicationDownload model. - Updated export endpoints to conditionally register downloads based on user authentication. - Enhanced researcher search response to indicate if publications were downloaded by the current user. - Updated environment configuration to include new JWT settings.
144 lines
5.2 KiB
Python
144 lines
5.2 KiB
Python
import os
|
|
import urllib.parse
|
|
from typing import Any, Optional
|
|
|
|
import httpx
|
|
|
|
TOKEN_URL_SANDBOX = "https://sandbox.orcid.org/oauth/token"
|
|
AUTHORIZATION_URL_SANDBOX = "https://sandbox.orcid.org/oauth/authorize"
|
|
BASE_URL_SANDBOX = "https://pub.sandbox.orcid.org/v3.0"
|
|
|
|
# Si en algún momento pasas a producción, cambiarías a:
|
|
# TOKEN_URL_PROD = "https://orcid.org/oauth/token"
|
|
# BASE_URL_PROD = "https://pub.orcid.org/v3.0"
|
|
|
|
|
|
class ORCIDClient:
|
|
def __init__(self):
|
|
self.client_id = os.getenv("ORCID_CLIENT_ID")
|
|
self.client_secret = os.getenv("ORCID_CLIENT_SECRET")
|
|
self._token_cache: Optional[str] = None
|
|
self.token_url = TOKEN_URL_SANDBOX
|
|
self.authorization_url = AUTHORIZATION_URL_SANDBOX
|
|
self.base_url = BASE_URL_SANDBOX
|
|
|
|
# ---------------------------------------------------------
|
|
# 1. Obtener token público
|
|
# ---------------------------------------------------------
|
|
def get_public_token(self) -> str:
|
|
if self._token_cache:
|
|
return self._token_cache
|
|
|
|
data = {
|
|
"client_id": self.client_id,
|
|
"client_secret": self.client_secret,
|
|
"grant_type": "client_credentials",
|
|
"scope": "/read-public",
|
|
}
|
|
|
|
with httpx.Client(timeout=20.0) as client:
|
|
response = client.post(self.token_url, data=data)
|
|
response.raise_for_status()
|
|
token = response.json()["access_token"]
|
|
self._token_cache = token
|
|
return token
|
|
|
|
# ---------------------------------------------------------
|
|
# Headers comunes
|
|
# ---------------------------------------------------------
|
|
def _headers(self) -> dict:
|
|
token = self.get_public_token()
|
|
return {
|
|
"Accept": "application/json",
|
|
"Authorization": f"Bearer {token}",
|
|
}
|
|
|
|
# ---------------------------------------------------------
|
|
# 2. Consultar /record
|
|
# ---------------------------------------------------------
|
|
def fetch_record(self, orcid_id: str) -> dict:
|
|
url = f"{self.base_url}/{orcid_id}/record"
|
|
with httpx.Client(timeout=20.0) as client:
|
|
response = client.get(url, headers=self._headers())
|
|
response.raise_for_status()
|
|
return response.json()
|
|
|
|
# ---------------------------------------------------------
|
|
# 3. Consultar /works (summary)
|
|
# ---------------------------------------------------------
|
|
def fetch_works(self, orcid_id: str) -> dict:
|
|
url = f"{self.base_url}/{orcid_id}/works"
|
|
with httpx.Client(timeout=20.0) as client:
|
|
response = client.get(url, headers=self._headers())
|
|
response.raise_for_status()
|
|
return response.json()
|
|
|
|
# ---------------------------------------------------------
|
|
# 4. Consultar /work/{put_code} (detalle)
|
|
# ---------------------------------------------------------
|
|
def fetch_work_detail(self, orcid_id: str, put_code: int) -> dict | None:
|
|
url = f"{self.base_url}/{orcid_id}/work/{put_code}"
|
|
with httpx.Client(timeout=20.0) as client:
|
|
response = client.get(url, headers=self._headers())
|
|
if response.status_code != 200:
|
|
return None
|
|
return response.json()
|
|
|
|
# ---------------------------------------------------------
|
|
# OAuth 3-legged (authorization code)
|
|
# ---------------------------------------------------------
|
|
def build_authorize_url(
|
|
self,
|
|
*,
|
|
redirect_uri: str,
|
|
scope: str = "/authenticate",
|
|
state: str | None = None,
|
|
) -> str:
|
|
"""
|
|
Creates the ORCID authorization URL (user signs in at ORCID and returns an auth code).
|
|
"""
|
|
params: dict[str, Any] = {
|
|
"client_id": self.client_id,
|
|
"response_type": "code",
|
|
# Scope(s) are space-separated in the authorize URL.
|
|
"scope": scope,
|
|
"redirect_uri": redirect_uri,
|
|
}
|
|
if state:
|
|
params["state"] = state
|
|
return f"{self.authorization_url}?{urllib.parse.urlencode(params)}"
|
|
|
|
def exchange_authorization_code(
|
|
self,
|
|
*,
|
|
code: str,
|
|
redirect_uri: str,
|
|
) -> dict:
|
|
"""
|
|
Server-side code exchange. Response includes at least `orcid` and usually `name`.
|
|
"""
|
|
data = {
|
|
"client_id": self.client_id,
|
|
"client_secret": self.client_secret,
|
|
"grant_type": "authorization_code",
|
|
"code": code,
|
|
"redirect_uri": redirect_uri,
|
|
}
|
|
with httpx.Client(timeout=20.0) as client:
|
|
response = client.post(self.token_url, data=data, headers={"Accept": "application/json"})
|
|
response.raise_for_status()
|
|
return response.json()
|
|
|
|
|
|
# -------------------------------------------------------------------
|
|
# Funciones de módulo usadas en researchers.py
|
|
# -------------------------------------------------------------------
|
|
def get_works_summary(orcid_id: str) -> dict:
|
|
client = ORCIDClient()
|
|
return client.fetch_works(orcid_id)
|
|
|
|
|
|
def get_work_detail(orcid_id: str, put_code: int) -> dict | None:
|
|
client = ORCIDClient()
|
|
return client.fetch_work_detail(orcid_id, put_code)
|