Files
OpenBB/openbb_terminal/session/user.py
montezdesousa 825b8955df Set guest by default and put authentication behind environment variable (#4197)
* small bug

* small bug on routines list

* guest as default

* limit logout to users2

* simpler this way

* add logout

* move logout to account & add env var

* put authentication under env var

* fix tests

* remove login

* remove openbb vars on login

* ruff

* revert .toml

* Delete Icon

* Update .env

* fix sdk guest not loading keys

* ruff

* remove press enter & --login

* ruff

* move env load

* load env

* move dot env loading to terminal.py

* fix user sdk login mixing .env with user

* now it works

* fix reset

* fix tests

* ruff

* Login on the SDK using the OpenBB Personal Access Token (#4206)

* openbb key on keys menu

* adding sdk endpoints

* adding login via token to the sdk

* base url

* rename to personal access token

* added docstrings and examples

* openbb is special

* removing extra break line

* making keys working with the personal access token

* resolve conflicting tests

* Revert "resolve conflicting tests"

This reverts commit 2fca2c0ec3.

* using custom requests

* tests

* tests

* tests

* using process_session_response instead

* rewriting some tests

* Fix sdk guest not loading keys (#4207)

* fix sdk guest not loading keys

* ruff

* remove comment

* tests

---------

Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com>
Co-authored-by: Diogo Sousa <montezdesousa@gmail.com>
Co-authored-by: James Maslek <jmaslek11@gmail.com>

* test record mode vcr none

* remove yes from tests yml

* specify modules to reload

* try disable check api

* UPdate spec file

* Small stocks bug

* avoid reloading in test mode

* will this work?

* skip session tests

* try with env var as well

* mock sdk reload

* pylint

* bump poetry on python 3.8

* adapt to python 3.8

* adapt to python 3.8 remaining tests

* Tests : update cassettes

* Fix linting

* Makes login conditions simpler

* Tests : txt

---------

Co-authored-by: James Maslek <jmaslek11@gmail.com>
Co-authored-by: Chavithra <chavithra@gmail.com>
Co-authored-by: Henrique Joaquim <h.joaquim@campus.fct.unl.pt>
2023-02-14 09:56:03 +00:00

99 lines
2.6 KiB
Python

import openbb_terminal.feature_flags as obbff
from openbb_terminal.rich_config import console
from openbb_terminal.session.hub_model import REGISTER_URL
class User:
_token_type: str = ""
_token: str = ""
_uuid: str = ""
_email: str = ""
@classmethod
def load_user_info(cls, session: dict, email: str):
"""Load user info from login info.
Parameters
----------
session : dict
The login info.
"""
cls._token_type = session.get("token_type", "")
cls._token = session.get("access_token", "")
cls._uuid = session.get("uuid", "")
cls._email = email
@classmethod
def get_session(cls):
"""Get session info."""
return {
"token_type": cls._token_type,
"access_token": cls._token,
"uuid": cls._uuid,
}
@staticmethod
def update_flair(flair: str):
"""Update flair if user has not changed it."""
if flair is None:
MAX_FLAIR_LEN = 20
username = User._email[: User._email.find("@")]
username = "[" + username[:MAX_FLAIR_LEN] + "]"
setattr(obbff, "USE_FLAIR", username + " 🦋")
@classmethod
def get_uuid(cls):
"""Get uuid."""
return cls._uuid
@classmethod
def whoami(cls):
"""Display user info."""
if not User.is_guest():
console.print(f"[info]email:[/info] {cls._email}")
console.print(f"[info]uuid:[/info] {cls._uuid}")
if obbff.SYNC_ENABLED is True:
sync = "ON"
else:
sync = "OFF"
console.print(f"[info]sync:[/info] {sync}")
else:
User.print_guest_message()
@classmethod
def clear(cls):
"""Clear user info."""
cls._token_type = ""
cls._token = ""
cls._email = ""
cls._uuid = ""
obbff.USE_FLAIR = ":openbb"
@classmethod
def is_guest(cls):
"""Check if user is guest."""
return not bool(cls._token)
@classmethod
def is_sync_enabled(cls):
"""Check if sync is enabled."""
return obbff.SYNC_ENABLED
@classmethod
def get_auth_header(cls):
"""Get token."""
return f"{cls._token_type.title()} {cls._token}"
@classmethod
def get_token(cls):
"""Get token."""
return cls._token
@classmethod
def print_guest_message(cls):
"""Print guest message."""
console.print(
"[info]You are currently logged as a guest.\n"
f"[info]Register: [/info][cmds]{REGISTER_URL}\n[/cmds]"
)