Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update hub<>platform credentials map #5749

Merged
merged 3 commits into from
Nov 17, 2023
Merged

Update hub<>platform credentials map #5749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d9547be
update hub<>platform credentials map
montezdesousa Nov 17, 2023
3ab428b
typo
montezdesousa Nov 17, 2023
60ee52b
Merge branch 'develop' into hotfix/update_hub_plat
montezdesousa Nov 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions openbb_platform/platform/core/openbb_core/app/model/credentials.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,13 +96,15 @@ def __repr__(self) -> str:
return (
self.__class__.__name__
+ "\n\n"
+ "\n".join([f"{k}: {v}" for k, v in self.__dict__.items()])
+ "\n".join([f"{k}: {v}" for k, v in sorted(self.__dict__.items())])
)

def show(self):
"""Unmask credentials and print them"""
print( # noqa: T201
self.__class__.__name__
+ "\n\n"
+ "\n".join([f"{k}: {v}" for k, v in self.model_dump(mode="json").items()])
+ "\n".join(
[f"{k}: {v}" for k, v in sorted(self.model_dump(mode="json").items())]
)
)
48 changes: 24 additions & 24 deletions openbb_platform/platform/core/openbb_core/app/model/hub/features_keys.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,39 +4,39 @@


class FeaturesKeys(BaseModel):
API_ULTIMA_KEY: Optional[str] = Field(default=None)
API_DATABENTO_KEY: Optional[str] = Field(default=None)
API_KEY_ALPHAVANTAGE: Optional[str] = Field(default=None)
API_KEY_FINANCIALMODELINGPREP: Optional[str] = Field(default=None)
API_KEY_QUANDL: Optional[str] = Field(default=None)
API_POLYGON_KEY: Optional[str] = Field(default=None)
API_FRED_KEY: Optional[str] = Field(default=None)
API_NEWS_TOKEN: Optional[str] = Field(default=None)
API_BITQUERY_KEY: Optional[str] = Field(default=None)
API_BIZTOC_TOKEN: Optional[str] = Field(default=None)
API_CMC_KEY: Optional[str] = Field(default=None)
API_FINNHUB_KEY: Optional[str] = Field(default=None)
API_WHALE_ALERT_KEY: Optional[str] = Field(default=None)
API_GLASSNODE_KEY: Optional[str] = Field(default=None)
API_COINGLASS_KEY: Optional[str] = Field(default=None)
API_ETHPLORER_KEY: Optional[str] = Field(default=None)
API_CRYPTO_PANIC_KEY: Optional[str] = Field(default=None)
API_BITQUERY_KEY: Optional[str] = Field(default=None)
API_SMARTSTAKE_KEY: Optional[str] = Field(default=None)
API_SMARTSTAKE_TOKEN: Optional[str] = Field(default=None)
API_MESSARI_KEY: Optional[str] = Field(default=None)
API_SHROOM_KEY: Optional[str] = Field(default=None)
API_SANTIMENT_KEY: Optional[str] = Field(default=None)
API_DAPPRADAR_KEY: Optional[str] = Field(default=None)
API_DATABENTO_KEY: Optional[str] = Field(default=None)
API_EODHD_KEY: Optional[str] = Field(default=None)
API_TOKEN_TERMINAL_KEY: Optional[str] = Field(default=None)
API_STOCKSERA_KEY: Optional[str] = Field(default=None)
API_INTRINIO_KEY: Optional[str] = Field(default=None)
API_ETHPLORER_KEY: Optional[str] = Field(default=None)
API_FINNHUB_KEY: Optional[str] = Field(default=None)
API_FRED_KEY: Optional[str] = Field(default=None)
API_GITHUB_KEY: Optional[str] = Field(default=None)
API_GLASSNODE_KEY: Optional[str] = Field(default=None)
API_INTRINIO_KEY: Optional[str] = Field(default=None)
API_KEY_ALPHAVANTAGE: Optional[str] = Field(default=None)
API_KEY_FINANCIALMODELINGPREP: Optional[str] = Field(default=None)
API_KEY_QUANDL: Optional[str] = Field(default=None)
API_MESSARI_KEY: Optional[str] = Field(default=None)
API_NEWS_TOKEN: Optional[str] = Field(default=None)
API_POLYGON_KEY: Optional[str] = Field(default=None)
API_REDDIT_CLIENT_ID: Optional[str] = Field(default=None)
API_REDDIT_CLIENT_SECRET: Optional[str] = Field(default=None)
API_REDDIT_PASSWORD: Optional[str] = Field(default=None)
API_REDDIT_USERNAME: Optional[str] = Field(default=None)
API_REDDIT_USER_AGENT: Optional[str] = Field(default=None)
API_REDDIT_PASSWORD: Optional[str] = Field(default=None)
API_SANTIMENT_KEY: Optional[str] = Field(default=None)
API_SHROOM_KEY: Optional[str] = Field(default=None)
API_SMARTSTAKE_KEY: Optional[str] = Field(default=None)
API_SMARTSTAKE_TOKEN: Optional[str] = Field(default=None)
API_STOCKSERA_KEY: Optional[str] = Field(default=None)
API_TOKEN_TERMINAL_KEY: Optional[str] = Field(default=None)
API_TWITTER_BEARER_TOKEN: Optional[str] = Field(default=None)
API_TWITTER_KEY: Optional[str] = Field(default=None)
API_TWITTER_SECRET_KEY: Optional[str] = Field(default=None)
API_TWITTER_BEARER_TOKEN: Optional[str] = Field(default=None)
API_DAPPRADAR_KEY: Optional[str] = Field(default=None)
API_ULTIMA_KEY: Optional[str] = Field(default=None)
API_WHALE_ALERT_KEY: Optional[str] = Field(default=None)
23 changes: 15 additions & 8 deletions openbb_platform/platform/core/openbb_core/app/service/hub_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ def push(self, user_settings: UserSettings) -> bool:
"""Push user settings to Hub."""
if self._session:
if user_settings.credentials:
hub_user_settings = self.sdk2hub(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(
Expand All @@ -84,7 +84,7 @@ def pull(self) -> UserSettings:
profile = Profile(
hub_session=self._session,
)
credentials = self.hub2sdk(hub_user_settings)
credentials = self.hub2platform(hub_user_settings)
return UserSettings(profile=profile, credentials=credentials)
raise OpenBBError(
"No session found. Login or provide a 'HubSession' on initialization."
Expand Down Expand Up @@ -215,33 +215,40 @@ def _put_user_settings(
raise HTTPException(status_code, detail)

@classmethod
def hub2sdk(cls, settings: HubUserSettings) -> Credentials:
def hub2platform(cls, settings: HubUserSettings) -> Credentials:
"""Convert Hub user settings to Platform models."""
# TODO: Hub is getting credentials from `all_api_keys.json`, which uses
# the terminal names conventions. We need to update it to use a file that
# lives here in the platform and maps the credential names between the two.
credentials = Credentials(
alpha_vantage_api_key=settings.features_keys.API_KEY_ALPHAVANTAGE,
biztoc_api_key=settings.features_keys.API_BIZTOC_TOKEN,
fred_api_key=settings.features_keys.API_FRED_KEY,
fmp_api_key=settings.features_keys.API_KEY_FINANCIALMODELINGPREP,
intrinio_api_key=settings.features_keys.API_INTRINIO_KEY,
polygon_api_key=settings.features_keys.API_POLYGON_KEY,
quandl_api_key=settings.features_keys.API_KEY_QUANDL,
nasdaq_api_key=settings.features_keys.API_KEY_QUANDL,
ultima_api_key=settings.features_keys.API_ULTIMA_KEY,
)
return credentials

@classmethod
def sdk2hub(cls, credentials: Credentials) -> HubUserSettings:
def platform2hub(cls, credentials: Credentials) -> HubUserSettings:
"""Convert Platform models to Hub user settings."""

def get_cred(cred: str) -> Optional[str]:
secret_str: Optional[SecretStr] = getattr(credentials, cred, None)
return secret_str.get_secret_value() if secret_str else None

features_keys = FeaturesKeys(
API_KEY_ALPHAVANTAGE=get_cred("alpha_vantage_api_key"),
API_BIZTOC_TOKEN=get_cred("biztoc_api_key"),
API_FRED_KEY=get_cred("fred_api_key"),
API_KEY_FINANCIALMODELINGPREP=get_cred("fmp_api_key"),
API_INTRINIO_KEY=get_cred("intrinio_api_key"),
API_KEY_ALPHAVANTAGE=get_cred("alpha_vantage_api_key"),
API_KEY_FINANCIALMODELINGPREP=get_cred("fmp_api_key"),
API_POLYGON_KEY=get_cred("polygon_api_key"),
API_KEY_QUANDL=get_cred("quandl_api_key"),
API_KEY_QUANDL=get_cred("nasdaq_api_key"),
API_ULTIMA_KEY=get_cred("ultima_api_key"),
)
hub_user_settings = HubUserSettings(features_keys=features_keys)
return hub_user_settings
Expand Down
12 changes: 6 additions & 6 deletions openbb_platform/platform/core/tests/app/service/test_hub_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,30 +172,30 @@ def test_put_user_settings():
)


def test_hub2sdk():
"""Test hub2sdk."""
def test_hub2platform():
"""Test hub2platform."""
mock_user_settings = MagicMock(spec=HubUserSettings)
mock_user_settings.features_keys = FeaturesKeys(
API_KEY_FINANCIALMODELINGPREP="fmp",
API_POLYGON_KEY="polygon",
API_FRED_KEY="fred",
)

credentials = HubService.hub2sdk(mock_user_settings)
credentials = HubService.hub2platform(mock_user_settings)
assert isinstance(credentials, Credentials)
assert credentials.fmp_api_key.get_secret_value() == "fmp"
assert credentials.polygon_api_key.get_secret_value() == "polygon"
assert credentials.fred_api_key.get_secret_value() == "fred"


def test_sdk2hub():
"""Test sdk2hub."""
def test_platform2hub():
"""Test platform2hub."""
mock_credentials = MagicMock(spec=Credentials)
mock_credentials.fmp_api_key = SecretStr("fmp")
mock_credentials.polygon_api_key = SecretStr("polygon")
mock_credentials.fred_api_key = SecretStr("fred")

user_settings = HubService.sdk2hub(mock_credentials)
user_settings = HubService.platform2hub(mock_credentials)
assert isinstance(user_settings, HubUserSettings)
assert user_settings.features_keys.API_KEY_FINANCIALMODELINGPREP == "fmp"
assert user_settings.features_keys.API_POLYGON_KEY == "polygon"
Expand Down
Loading