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
|
"""Hub manager class."""
from typing import Optional
from warnings import warn
from fastapi import HTTPException
from jwt import ExpiredSignatureError, PyJWTError, decode, get_unverified_header
from openbb_core.app.model.abstract.error import OpenBBError
from openbb_core.app.model.credentials import Credentials
from openbb_core.app.model.hub.hub_session import HubSession
from openbb_core.app.model.hub.hub_user_settings import HubUserSettings
from openbb_core.app.model.profile import Profile
from openbb_core.app.model.user_settings import UserSettings
from openbb_core.env import Env
from requests import get, post, put
class HubService:
"""Hub service class."""
TIMEOUT = 10
# Mapping of V3 keys to V4 keys for backward compatibility
V3TOV4 = {
"API_KEY_ALPHAVANTAGE": "alpha_vantage_api_key",
"API_BIZTOC_TOKEN": "biztoc_api_key",
"API_FRED_KEY": "fred_api_key",
"API_KEY_FINANCIALMODELINGPREP": "fmp_api_key",
"API_INTRINIO_KEY": "intrinio_api_key",
"API_POLYGON_KEY": "polygon_api_key",
"API_KEY_QUANDL": "nasdaq_api_key",
"API_TRADIER_TOKEN": "tradier_api_key",
}
V4TOV3 = {v: k for k, v in V3TOV4.items()}
def __init__(
self,
session: Optional[HubSession] = None,
base_url: Optional[str] = None,
):
"""Initialize Hub service."""
self._base_url = base_url or Env().HUB_BACKEND
self._session = session
self._hub_user_settings: Optional[HubUserSettings] = None
@property
def base_url(self) -> str:
"""Get base url."""
return self._base_url
@property
def session(self) -> Optional[HubSession]:
"""Get session."""
return self._session
def connect(
self,
email: Optional[str] = None,
password: Optional[str] = None,
pat: Optional[str] = None,
) -> HubSession:
"""Connect to Hub."""
if email and password:
self._session = self._get_session_from_email_password(email, password)
return self._session
if pat:
self._session = self._get_session_from_platform_token(pat)
return self._session
raise OpenBBError("Please provide 'email' and 'password' or 'pat'")
def disconnect(self) -> bool:
"""Disconnect from Hub."""
if self._session:
result = self._post_logout(self._session)
self._session = None
return result
raise OpenBBError(
"No session found. Login or provide a 'HubSession' on initialization."
)
def push(self, user_settings: UserSettings) -> bool:
"""Push user settings to Hub."""
if self._session:
if user_settings.credentials:
hub_user_settings = self.platform2hub(user_settings.credentials)
return self._put_user_settings(self._session, hub_user_settings)
return False
raise OpenBBError(
"No session found. Login or provide a 'HubSession' on initialization."
)
def pull(self) -> UserSettings:
"""Pull user settings from Hub."""
if self._session:
self._hub_user_settings = self._get_user_settings(self._session)
profile = Profile(hub_session=self._session)
credentials = self.hub2platform(self._hub_user_settings)
return UserSettings(profile=profile, credentials=credentials)
raise OpenBBError(
"No session found. Login or provide a 'HubSession' on initialization."
)
def _get_session_from_email_password(self, email: str, password: str) -> HubSession:
"""Get session from email and password."""
if not email:
raise OpenBBError("Email not found.")
if not password:
raise OpenBBError("Password not found.")
response = post(
url=self._base_url + "/login",
json={
"email": email,
"password": password,
"remember": True,
},
timeout=self.TIMEOUT,
)
if response.status_code == 200:
session = response.json()
hub_session = HubSession(
access_token=session.get("access_token"),
token_type=session.get("token_type"),
user_uuid=session.get("uuid"),
email=session.get("email"),
username=session.get("username"),
primary_usage=session.get("primary_usage"),
)
return hub_session
status_code = response.status_code
detail = response.json().get("detail", None)
raise HTTPException(status_code, detail)
def _get_session_from_platform_token(self, token: str) -> HubSession:
"""Get session from Platform personal access token."""
if not token:
raise OpenBBError("Platform personal access token not found.")
self._check_token_expiration(token)
response = post(
url=self._base_url + "/sdk/login",
json={
"token": token,
},
timeout=self.TIMEOUT,
)
if response.status_code == 200:
session = response.json()
hub_session = HubSession(
access_token=session.get("access_token"),
token_type=session.get("token_type"),
user_uuid=session.get("uuid"),
username=session.get("username"),
email=session.get("email"),
primary_usage=session.get("primary_usage"),
)
return hub_session
status_code = response.status_code
detail = response.json().get("detail", None)
raise HTTPException(status_code, detail)
def _post_logout(self, session: HubSession) -> bool:
"""Post logout."""
access_token = session.access_token.get_secret_value()
token_type = session.token_type
authorization = f"{token_type.title()} {access_token}"
response = get(
url=self._base_url + "/logout",
headers={"Authorization": authorization},
json={"token": access_token},
timeout=self.TIMEOUT,
)
if response.status_code == 200:
result = response.json()
return result.get("success", False)
status_code = response.status_code
result = response.json()
detail = result.get("detail", None)
raise HTTPException(status_code, detail)
def _get_user_settings(self, session: HubSession) -> HubUserSettings:
"""Get user settings."""
access_token = session.access_token.get_secret_value()
token_type = session.token_type
authorization = f"{token_type.title()} {access_token}"
response = get(
url=self._base_url + "/terminal/user",
headers={"Authorization": authorization},
timeout=self.TIMEOUT,
)
if response.status_code == 200:
user_settings = response.json()
filtered = {k: v for k, v in user_settings.items() if v is not None}
return HubUserSettings.model_validate(filtered)
status_code = response.status_code
detail = response.json().get("detail", None)
raise HTTPException(status_code, detail)
def _put_user_settings(
self, session: HubSession, settings: HubUserSettings
) -> bool:
"""Put user settings."""
access_token = session.access_token.get_secret_value()
token_type = session.token_type
authorization = f"{token_type.title()} {access_token}"
response = put(
url=self._base_url + "/user",
headers={"Authorization": authorization},
json=settings.model_dump(),
timeout=self.TIMEOUT,
)
if response.statu
|
