Hub service tests and file restructure.

openbb_sdk/sdk/core/openbb_core/app/service/hub_service.py

@@ -1,3 +1,4 @@
+"""Hub manager class."""
 from typing import Optional
 
 import requests
@@ -11,11 +12,11 @@ from openbb_core.app.model.user_settings import UserSettings
 
 
 class OpenBBError(Exception):
-    pass
+    """OpenBB error."""
 
 
 class HubService:
-    """Hub manager class"""
+    """Manage Hub service class."""
 
     BASE_URL = "https://payments.openbb.dev"
     TIMEOUT = 10

openbb_sdk/sdk/core/openbb_core/app/service/journal_service.py

@@ -1,3 +1,4 @@
+"""Journal service."""
 from typing import Optional
 
 from openbb_core.app.repository.abstract.journal_entry_repository import (
@@ -92,12 +93,15 @@ class JournalService:
 
     @property
     def mongodb_client(self) -> Optional[MongoClient]:
+        """Return mongodb client."""
         return self._mongodb_client
 
     @property
     def journal_entry_repository(self) -> AbstractJournalEntryRepository:
+        """Return journal entry repository."""
         return self._journal_entry_repository
 
     @property
     def journal_repository(self) -> AbstractJournalRepository:
+        """Return journal repository."""
         return self._journal_repository

openbb_sdk/sdk/core/tests/app/service/test_hub_service.py

@@ -0,0 +1,164 @@
+"""Test the hub_service.py module."""
+
+
+from unittest.mock import MagicMock, patch
+
+import pytest
+from openbb_core.app.service.hub_service import (
+    Credentials,
+    HubService,
+    HubSession,
+    HubUserSettings,
+    OpenBBError,
+)
+
+
+@pytest.fixture
+def mocker():
+    """Fixture for mocker."""
+    with patch("openbb_core.app.service.hub_service.HubService") as mock:
+        yield mock
+
+
+def test_connect_with_email_password():
+    """Test connect with email and password."""
+    mock_hub_session = MagicMock(spec=HubSession)
+    with patch(
+        "requests.post", return_value=MagicMock(status_code=200, json=lambda: {})
+    ):
+        with patch.object(
+            HubService, "get_session_from_email_password", return_value=mock_hub_session
+        ):
+            hub_service = HubService()
+            result = hub_service.connect(email="test@example.com", password="password")
+
+            assert result == mock_hub_session
+            assert hub_service.session == mock_hub_session
+
+
+def test_connect_with_sdk_token():
+    """Test connect with SDK personal access token."""
+    mock_hub_session = MagicMock(spec=HubSession)
+    with patch(
+        "requests.post", return_value=MagicMock(status_code=200, json=lambda: {})
+    ):
+        with patch.object(
+            HubService, "get_session_from_sdk_token", return_value=mock_hub_session
+        ):
+            hub_service = HubService()
+            result = hub_service.connect(sdk_token="sdk_token")
+
+            assert result == mock_hub_session
+            assert hub_service.session == mock_hub_session
+
+
+def test_connect_without_credentials():
+    """Test connect without credentials."""
+    hub_service = HubService()
+    with pytest.raises(
+        OpenBBError, match="Please provide 'email' and 'password' or 'sdk_token'"
+    ):
+        hub_service.connect()
+
+
+@patch("requests.post")
+def test_get_session_from_email_password(mock_post):
+    """Test get session from email and password."""
+    mock_post.return_value = MagicMock(
+        status_code=200,
+        json=lambda: {
+            "access_token": "token",
+            "token_type": "Bearer",
+            "uuid": "uuid",
+            "email": "email",
+            "username": "username",
+            "primary_usage": "primary_usage",
+        },
+    )
+    result = HubService.get_session_from_email_password("email", "password")
+    assert isinstance(result, HubSession)
+
+
+@patch("requests.post")
+def test_get_session_from_sdk_token(mock_post):
+    """Test get session from SDK personal access token."""
+    mock_post.return_value = MagicMock(
+        status_code=200,
+        json=lambda: {
+            "access_token": "token",
+            "token_type": "Bearer",
+            "uuid": "uuid",
+            "username": "username",
+            "email": "email",
+            "primary_usage": "primary_usage",
+        },
+    )
+    result = HubService.get_session_from_sdk_token("token")
+    assert isinstance(result, HubSession)
+
+
+@patch("requests.get")
+def test_disconnect(mock_get):
+    """Test disconnect."""
+    mock_get.return_value = MagicMock(status_code=200, json=lambda: {"success": True})
+    mock_hub_session = MagicMock(
+        spec=HubSession, access_token="token", token_type="Bearer"
+    )
+    hub_service = HubService(session=mock_hub_session)
+
+    assert hub_service.disconnect() is True
+    assert hub_service.session is None
+
+
+@patch("requests.get")
+def test_get_user_settings(mock_get):
+    """Test get user settings."""
+    mock_get.return_value = MagicMock(status_code=200, json=lambda: {})
+    mock_hub_session = MagicMock(
+        spec=HubSession, access_token="token", token_type="Bearer"
+    )
+
+    user_settings = HubService.get_user_settings(mock_hub_session)
+    assert isinstance(user_settings, HubUserSettings)
+
+
+@patch("requests.put")
+def test_put_user_settings(mock_put):
+    """Test put user settings."""
+    mock_put.return_value = MagicMock(status_code=200)
+    mock_hub_session = MagicMock(
+        spec=HubSession, access_token="token", token_type="Bearer"
+    )
+    mock_user_settings = MagicMock(spec=HubUserSettings)
+
+    assert HubService.put_user_settings(mock_hub_session, mock_user_settings) is True
+
+
+def test_hub2sdk():
+    """Test hub2sdk."""
+    mock_user_settings = MagicMock(spec=HubUserSettings)
+    mock_user_settings.features_keys = MagicMock(
+        API_KEY_FINANCIALMODELINGPREP="fmp",
+        API_POLYGON_KEY="polygon",
+        API_FRED_KEY="fred",
+    )
+
+    credentials = HubService.hub2sdk(mock_user_settings)
+    assert isinstance(credentials, Credentials)
+    assert credentials.fmp_api_key == "fmp"
+    assert credentials.polygon_api_key == "polygon"
+    assert credentials.fred_api_key == "fred"
+
+
+def test_sdk2hub():
+    """Test sdk2hub."""
+    mock_credentials = MagicMock(spec=Credentials)
+    mock_credentials.fmp_api_key = "fmp"
+    mock_credentials.polygon_api_key = "polygon"
+    mock_credentials.fred_api_key = "fred"
+
+    user_settings = HubService.sdk2hub(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"
+    assert user_settings.features_keys.API_FRED_KEY == "fred"

openbb_sdk/sdk/core/tests/app/service/test_journal_service.py

@@ -1,4 +1,4 @@
-"""Test the ../openbb_core/app/service/journal_service.py module."""
+"""Test the journal_service.py module."""
 # pylint: disable=redefined-outer-name
 
 from unittest.mock import MagicMock

openbb_sdk/sdk/core/tests/app/service/test_system_service.py

@@ -1,4 +1,4 @@
-"""Test the ../openbb_core/app/service/system_service.py module."""
+"""Test the system_service.py module."""
 # pylint: disable=redefined-outer-name
 
 import pytest

openbb_sdk/sdk/core/tests/app/service/test_user_service.py

@@ -1,4 +1,4 @@
-"""Test the ../app/service/user_service.py module."""
+"""Test the user_service.py module."""
 
 from pathlib import Path
 from unittest.mock import MagicMock

openbb_sdk/sdk/core/tests/app/static/test_container.py

@@ -1,4 +1,4 @@
-"""Test the app/static/container.py file."""
+"""Test the container.py file."""
 
 from openbb_core.app.static.container import Container
 

openbb_sdk/sdk/core/tests/app/static/test_coverage.py

@@ -1,4 +1,4 @@
-"""Test the app/static/coverage.py file."""
+"""Test the coverage.py file."""
 # pylint: disable=redefined-outer-name
 
 import pytest

openbb_sdk/sdk/core/tests/app/static/test_filters.py

@@ -1,4 +1,4 @@
-"""Test the app/static/filters.py file."""
+"""Test the filters.py file."""
 
 import pytest
 from openbb_core.app.model.command_output import CommandOutput

openbb_sdk/sdk/core/tests/app/static/test_package_builder.py

@@ -1,4 +1,4 @@
-"""Test the app/static/package_builder.py file."""
+"""Test the package_builder.py file."""
 # pylint: disable=redefined-outer-name
 
 from dataclasses import dataclass