crypticorn 2.0.0__tar.gz → 2.0.1__tar.gz

{crypticorn-2.0.0 → crypticorn-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.0.0
+Version: 2.0.1
 Summary: Maximise Your Crypto Trading Profits with AI Predictions
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+Requires-Dist: fastapi
 Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: python_dateutil>=2.8.2
 Requires-Dist: aiohttp>=3.8.4
@@ -33,10 +34,7 @@ Requires-Dist: pyflakes; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest>=7.2.1; extra == "test"
 Requires-Dist: pytest-cov>=2.8.1; extra == "test"
-Requires-Dist: tox>=3.9.0; extra == "test"
-Requires-Dist: flake8>=4.0.0; extra == "test"
-Requires-Dist: types-python-dateutil>=2.8.19.14; extra == "test"
-Requires-Dist: mypy>=1.5; extra == "test"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "test"
 
 # What is Crypticorn?
 
@@ -50,9 +48,28 @@ Crypticorn offers AI-based solutions for both active and passive investors, incl
 Use this API Client to contribute to the so-called Hive AI, a community driven AI Meta Model for predicting the
 cryptocurrency market.
 
+## Installation
+
+You can install the latest stable version from PyPi:
+```bash
+pip install crypticorn
+```
+
+If you want a specific version, run:
+```bash
+pip install crypticorn==2.0.0
+```
+
+If you want the latest version, which could be a pre release, run:
+```bash
+pip install --pre crypticorn
+```
+
 ## Usage
 
-Within an asynchronous context the session is closed automatically.
+As of know the library is available in async mode only. There are two was of using it.
+
+## With Async Context Protocol
 ```python
 async with ApiClient(base_url="http://localhost", jwt=jwt) as client:
         # json response
@@ -66,6 +83,7 @@ async with ApiClient(base_url="http://localhost", jwt=jwt) as client:
         print(response)
 ```
 
+## Without Async Context Protocol
 Without the context you need to close the session manually.
 ```python
 client = ApiClient(base_url="http://localhost", jwt=jwt)

{crypticorn-2.0.0 → crypticorn-2.0.1}/README.md

@@ -10,9 +10,28 @@ Crypticorn offers AI-based solutions for both active and passive investors, incl
 Use this API Client to contribute to the so-called Hive AI, a community driven AI Meta Model for predicting the
 cryptocurrency market.
 
+## Installation
+
+You can install the latest stable version from PyPi:
+```bash
+pip install crypticorn
+```
+
+If you want a specific version, run:
+```bash
+pip install crypticorn==2.0.0
+```
+
+If you want the latest version, which could be a pre release, run:
+```bash
+pip install --pre crypticorn
+```
+
 ## Usage
 
-Within an asynchronous context the session is closed automatically.
+As of know the library is available in async mode only. There are two was of using it.
+
+## With Async Context Protocol
 ```python
 async with ApiClient(base_url="http://localhost", jwt=jwt) as client:
         # json response
@@ -26,6 +45,7 @@ async with ApiClient(base_url="http://localhost", jwt=jwt) as client:
         print(response)
 ```
 
+## Without Async Context Protocol
 Without the context you need to close the session manually.
 ```python
 client = ApiClient(base_url="http://localhost", jwt=jwt)

{crypticorn-2.0.0 → crypticorn-2.0.1}/crypticorn/common/auth.py

@@ -5,7 +5,7 @@ from enum import Enum
 from fastapi import params
 from fastapi.security import APIKeyHeader, HTTPBearer
 
-from crypticorn.common import ApiScope
+from crypticorn.common import Scope
 
 
 http_bearer = HTTPBearer(
@@ -26,7 +26,7 @@ def Security(  # noqa: N802
         Optional[Callable[..., Any]], Doc("A dependable callable (like a function).")
     ] = None,
     scopes: Annotated[
-        Optional[list[ApiScope]],  # Optional[Sequence[Union[str, APIScope]]],
+        Optional[list[Scope]],  # Optional[Sequence[Union[str, Scope]]],
         Doc("OAuth2 scopes required for the *path operation*."),
     ] = None,
     use_cache: Annotated[

{crypticorn-2.0.0 → crypticorn-2.0.1}/crypticorn/common/auth_client.py

@@ -1,12 +1,13 @@
 from fastapi import Depends, HTTPException, status
 from fastapi.security import HTTPAuthorizationCredentials
 from typing_extensions import Annotated, Doc
+import json
 
 from crypticorn.auth import AuthClient, Verify200Response
-from crypticorn.auth.client.exceptions import UnauthorizedException
+from crypticorn.auth.client.exceptions import ApiException
 from crypticorn.common import (
     ApiError,
-    ApiScope,
+    Scope,
     ApiVersion,
     BaseURL,
     Domain,
@@ -41,29 +42,17 @@ class AuthHandler:
         self.whitelist = whitelist
         self.auth_client = AuthClient(base_url=base_url, api_version=api_version)
 
-        self.invalid_scopes_exception = HTTPException(
-            status_code=status.HTTP_403_FORBIDDEN,
-            detail=ApiError.INSUFFICIENT_SCOPES.identifier,
-        )
         self.no_credentials_exception = HTTPException(
             status_code=status.HTTP_401_UNAUTHORIZED,
             detail=ApiError.NO_CREDENTIALS.identifier,
         )
-        self.invalid_api_key_exception = HTTPException(
-            status_code=status.HTTP_401_UNAUTHORIZED,
-            detail=ApiError.INVALID_API_KEY.identifier,
-        )
-        self.invalid_bearer_exception = HTTPException(
-            status_code=status.HTTP_401_UNAUTHORIZED,
-            detail=ApiError.INVALID_BEARER.identifier,
-        )
 
     async def _verify_api_key(self, api_key: str) -> None:
         """
         Verifies the API key.
         """
         # TODO: Implement in auth service
-        return NotImplementedError()
+        raise NotImplementedError("API key verification not implemented")
 
     async def _verify_bearer(
         self, bearer: HTTPAuthorizationCredentials
@@ -74,32 +63,66 @@ class AuthHandler:
         self.auth_client.config.access_token = bearer.credentials
         return await self.auth_client.login.verify()
 
-    async def _check_scopes(
-        self, api_scopes: list[ApiScope], user_scopes: list[ApiScope]
+    async def _validate_scopes(
+        self, api_scopes: list[Scope], user_scopes: list[Scope]
     ) -> bool:
         """
         Checks if the user scopes are a subset of the API scopes.
         """
-        return set(api_scopes).issubset(user_scopes)
+        if not set(api_scopes).issubset(user_scopes):
+            raise HTTPException(
+                status_code=status.HTTP_403_FORBIDDEN,
+                detail=ApiError.INSUFFICIENT_SCOPES.identifier,
+            )
 
+    async def _extract_message(self, e: ApiException) -> str:
+        '''
+        Tries to extract the message from the body of the exception.
+        '''
+        try:
+            load = json.loads(e.body)
+        except (json.JSONDecodeError, TypeError):
+            return e.body
+        else:
+            common_keys = ["message"]
+            for key in common_keys:
+                if key in load:
+                    return load[key]
+            return load
+
+    async def _handle_exception(self, e: Exception) -> HTTPException:
+        '''
+        Handles exceptions and returns a HTTPException with the appropriate status code and detail.
+        '''
+        if isinstance(e, ApiException):
+            return HTTPException(
+                status_code=e.status,
+                detail=await self._extract_message(e),
+            )
+        elif isinstance(e, HTTPException):
+            return e
+        else:
+            return HTTPException(
+                status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+            )
+    
     async def api_key_auth(
         self,
         api_key: Annotated[str | None, Depends(apikey_header)] = None,
-        scopes: list[ApiScope] = [],
+        scopes: list[Scope] = [],
     ) -> Verify200Response:
         """
         Verifies the API key and checks if the user scopes are a subset of the API scopes.
         """
-        if not api_key:
-            raise self.no_credentials_exception
         try:
+            if not api_key:
+                raise self.no_credentials_exception
+            
             res = await self._verify_api_key(api_key)
-        except UnauthorizedException as e:
-            raise self.invalid_api_key_exception
-        valid_scopes = await self._check_scopes(scopes, res.scopes)
-        if not valid_scopes:
-            raise self.invalid_scopes_exception
-        return res
+            await self._validate_scopes(scopes, [Scope.from_str(scope) for scope in res.scopes])
+            return res
+        except Exception as e:
+            raise await self._handle_exception(e)
 
     async def bearer_auth(
         self,
@@ -107,7 +130,7 @@ class AuthHandler:
             HTTPAuthorizationCredentials | None,
             Depends(http_bearer),
         ] = None,
-        scopes: list[ApiScope] = [],
+        scopes: list[Scope] = [],
     ) -> Verify200Response:
         """
         Verifies the bearer token and checks if the user scopes are a subset of the API scopes.
@@ -117,12 +140,11 @@ class AuthHandler:
 
         try:
             res = await self._verify_bearer(bearer)
-        except UnauthorizedException as e:
-            raise self.invalid_bearer_exception
-        valid_scopes = await self._check_scopes(scopes, res.scopes)
-        if not valid_scopes:
-            raise self.invalid_scopes_exception
-        return res
+            await self._validate_scopes(scopes, [Scope.from_str(scope) for scope in res.scopes])
+            return res
+        except Exception as e:
+            raise await self._handle_exception(e)
+
 
     async def combined_auth(
         self,
@@ -130,7 +152,7 @@ class AuthHandler:
             HTTPAuthorizationCredentials | None, Depends(http_bearer)
         ] = None,
         api_key: Annotated[str | None, Depends(apikey_header)] = None,
-        scopes: list[ApiScope] = [],
+        scopes: list[Scope] = [],
     ) -> Verify200Response:
         """
         Verifies the bearer token and API key and checks if the user scopes are a subset of the API scopes.
@@ -151,13 +173,11 @@ class AuthHandler:
                 if res is None:
                     continue
                 if scopes:
-                    valid_scopes = await self._check_scopes(scopes, res.scopes)
-                    if not valid_scopes:
-                        raise self.invalid_scopes_exception
+                    await self._validate_scopes(scopes, [Scope.from_str(scope) for scope in res.scopes])
                 return res
 
-            except UnauthorizedException as e:
-                last_error = e
+            except Exception as e:
+                last_error = await self._handle_exception(e)
                 continue
 
         raise last_error or self.no_credentials_exception

{crypticorn-2.0.0 → crypticorn-2.0.1}/crypticorn/common/scopes.py

@@ -1,11 +1,15 @@
 from enum import Enum
 
 
-class ApiScope(str, Enum):
+class Scope(str, Enum):
     """
     The permission scopes for the API.
     """
 
+    @classmethod
+    def from_str(cls, value: str) -> "Scope":
+        return cls(value)
+
     # Hive scopes
     HIVE_MODEL_READ = "hive:model:read"
     HIVE_DATA_READ = "hive:data:read"
@@ -27,3 +31,6 @@ class ApiScope(str, Enum):
     TRADE_NOTIFICATIONS_WRITE = "trade:notifications:write"
     TRADE_STRATEGIES_READ = "trade:strategies:read"
     TRADE_STRATEGIES_WRITE = "trade:strategies:write"
+
+    # Read projections
+    READ_PREDICTIONS = "read:predictions"

{crypticorn-2.0.0 → crypticorn-2.0.1}/crypticorn.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: crypticorn
-Version: 2.0.0
+Version: 2.0.1
 Summary: Maximise Your Crypto Trading Profits with AI Predictions
 Author-email: Crypticorn <timon@crypticorn.com>
 Project-URL: Homepage, https://crypticorn.com
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
+Requires-Dist: fastapi
 Requires-Dist: urllib3<3.0.0,>=1.25.3
 Requires-Dist: python_dateutil>=2.8.2
 Requires-Dist: aiohttp>=3.8.4
@@ -33,10 +34,7 @@ Requires-Dist: pyflakes; extra == "dev"
 Provides-Extra: test
 Requires-Dist: pytest>=7.2.1; extra == "test"
 Requires-Dist: pytest-cov>=2.8.1; extra == "test"
-Requires-Dist: tox>=3.9.0; extra == "test"
-Requires-Dist: flake8>=4.0.0; extra == "test"
-Requires-Dist: types-python-dateutil>=2.8.19.14; extra == "test"
-Requires-Dist: mypy>=1.5; extra == "test"
+Requires-Dist: pytest-asyncio>=0.21.0; extra == "test"
 
 # What is Crypticorn?
 
@@ -50,9 +48,28 @@ Crypticorn offers AI-based solutions for both active and passive investors, incl
 Use this API Client to contribute to the so-called Hive AI, a community driven AI Meta Model for predicting the
 cryptocurrency market.
 
+## Installation
+
+You can install the latest stable version from PyPi:
+```bash
+pip install crypticorn
+```
+
+If you want a specific version, run:
+```bash
+pip install crypticorn==2.0.0
+```
+
+If you want the latest version, which could be a pre release, run:
+```bash
+pip install --pre crypticorn
+```
+
 ## Usage
 
-Within an asynchronous context the session is closed automatically.
+As of know the library is available in async mode only. There are two was of using it.
+
+## With Async Context Protocol
 ```python
 async with ApiClient(base_url="http://localhost", jwt=jwt) as client:
         # json response
@@ -66,6 +83,7 @@ async with ApiClient(base_url="http://localhost", jwt=jwt) as client:
         print(response)
 ```
 
+## Without Async Context Protocol
 Without the context you need to close the session manually.
 ```python
 client = ApiClient(base_url="http://localhost", jwt=jwt)

{crypticorn-2.0.0 → crypticorn-2.0.1}/crypticorn.egg-info/SOURCES.txt

@@ -229,4 +229,5 @@ crypticorn/trade/client/models/validation_error.py
 crypticorn/trade/client/models/validation_error_loc_inner.py
 requirements/dev.txt
 requirements/main.txt
-requirements/test.txt
+requirements/test.txt
+tests/test_auth_client.py

{crypticorn-2.0.0 → crypticorn-2.0.1}/crypticorn.egg-info/requires.txt

@@ -1,3 +1,4 @@
+fastapi
 urllib3<3.0.0,>=1.25.3
 python_dateutil>=2.8.2
 aiohttp>=3.8.4
@@ -20,7 +21,4 @@ pyflakes
 [test]
 pytest>=7.2.1
 pytest-cov>=2.8.1
-tox>=3.9.0
-flake8>=4.0.0
-types-python-dateutil>=2.8.19.14
-mypy>=1.5
+pytest-asyncio>=0.21.0

{crypticorn-2.0.0 → crypticorn-2.0.1}/pyproject.toml

@@ -4,7 +4,7 @@ description = "Maximise Your Crypto Trading Profits with AI Predictions"
 readme = "README.md"
 requires-python = ">=3.10"
 authors = [{name = "Crypticorn", email = "timon@crypticorn.com"}]
-version = "2.0.0"
+version = "2.0.1"
 keywords = ["machine learning", "data science", "crypto", "modelling"]
 dynamic = ["dependencies", "optional-dependencies"]
 
@@ -32,7 +32,7 @@ build_command = "pip install build && python -m build"
 
 # https://python-semantic-release.readthedocs.io/en/latest/multibranch_releases.html#multibranch-releases
 [tool.semantic_release.branches.main]
-match = "(main|dev)" # TODO: change this later to only main and uncomment the block below
+match = "(dev)" # TODO: change this later to only main and uncomment the block below
 prerelease = false
 
 #[tool.semantic_release.branches.dev]

{crypticorn-2.0.0 → crypticorn-2.0.1}/requirements/main.txt

@@ -1,3 +1,6 @@
+# crypticorn/common
+fastapi
+
 # crypticorn/trade/requirements.txt
 urllib3 >= 1.25.3, < 3.0.0
 python_dateutil >= 2.8.2

crypticorn-2.0.1/requirements/test.txt

@@ -0,0 +1,3 @@
+pytest >= 7.2.1
+pytest-cov >= 2.8.1
+pytest-asyncio >= 0.21.0

crypticorn-2.0.1/tests/test_auth_client.py

@@ -0,0 +1,102 @@
+from crypticorn.common import BaseURL, AuthHandler, Scope, http_bearer
+import asyncio
+from fastapi import HTTPException
+import pytest_asyncio
+import pytest
+from fastapi.security import HTTPAuthorizationCredentials
+
+VALID_JWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJuYlowNUVqS2ZqWGpXdDBTMDdvOSIsImF1ZCI6ImFwcC5jcnlwdGljb3JuLmNvbSIsImlzcyI6ImFjY291bnRzLmNyeXB0aWNvcm4uY29tIiwianRpIjoiTXY3ZTBpMkt0TlliYmN0TVp2aGYiLCJpYXQiOjE3NDM5NzI4NjgsImV4cCI6MTc0Mzk3NjQ2OCwic2NvcGVzIjpbInJlYWQ6cHJlZGljdGlvbnMiXX0.NkQ6FlmViPFZDqT9SLV0u8bnm2pegLQ0TknxYgutoGk"
+EXPIRED_JWT = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJuYlowNUVqS2ZqWGpXdDBTMDdvOSIsImF1ZCI6ImFwcC5jcnlwdGljb3JuLmNvbSIsImlzcyI6ImFjY291bnRzLmNyeXB0aWNvcm4uY29tIiwianRpIjoiM3FlU0h5S082VVNvMkZBU1VxMmkiLCJpYXQiOjE3NDM5Njc2MzAsImV4cCI6MTc0Mzk3MTIzMCwic2NvcGVzIjpbInJlYWQ6cHJlZGljdGlvbnMiXX0.d3yfsTGIZaygORyrRQvPPZTZLK0oM2rYz4ijUtpl3xk"
+
+
+@pytest_asyncio.fixture
+async def auth_handler() -> AuthHandler:
+    return AuthHandler(BaseURL.DEV)
+
+@pytest.mark.asyncio
+async def test_combined_auth_without_credentials(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        await auth_handler.combined_auth(bearer=None, api_key=None)
+    assert e.value.status_code == 401
+    assert e.value.detail == auth_handler.no_credentials_exception.detail
+
+@pytest.mark.asyncio
+async def test_combined_auth_with_invalid_bearer_token(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        await auth_handler.combined_auth(
+            bearer=HTTPAuthorizationCredentials(scheme="Bearer", credentials="123"),
+            api_key=None
+        )
+    assert e.value.status_code == 401
+
+@pytest.mark.asyncio
+async def test_combined_auth_with_expired_bearer_token(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        await auth_handler.combined_auth(
+            bearer=HTTPAuthorizationCredentials(scheme="Bearer", credentials=EXPIRED_JWT),
+            api_key=None
+        )
+    assert e.value.status_code == 401
+    assert e.value.detail == "jwt expired"
+
+@pytest.mark.asyncio
+async def test_combined_auth_with_invalid_api_key(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        return await auth_handler.combined_auth(bearer=None, api_key="123")
+    assert e.value.status_code == 500 # Not implemented
+
+@pytest.mark.asyncio
+async def test_combined_auth_with_valid_bearer_token(auth_handler: AuthHandler):
+    res = await auth_handler.combined_auth(bearer=HTTPAuthorizationCredentials(scheme="Bearer", credentials=VALID_JWT), api_key=None)
+    assert res.scopes == [Scope.READ_PREDICTIONS]
+
+@pytest.mark.asyncio
+async def test_combined_auth_with_valid_api_key(auth_handler: AuthHandler):
+    # res = await auth_handler.combined_auth(bearer=None, api_key="123")
+    # assert res.scopes == [Scope.READ_PREDICTIONS]
+    assert True # not implemented
+
+@pytest.mark.asyncio
+async def test_api_key_auth_without_api_key(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        return await auth_handler.api_key_auth(api_key=None)
+    assert e.value.status_code == 401
+
+@pytest.mark.asyncio
+async def test_api_key_auth_with_invalid_api_key(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        return await auth_handler.api_key_auth(api_key="123")
+    assert e.value.status_code == 500 # Not implemented
+
+@pytest.mark.asyncio
+async def test_api_key_auth_with_valid_api_key(auth_handler: AuthHandler):  
+    # res = await auth_handler.api_key_auth(api_key="123")
+    # assert res.scopes == [Scope.READ_PREDICTIONS]
+    assert True # not implemented
+
+@pytest.mark.asyncio
+async def test_bearer_auth_without_bearer(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        return await auth_handler.bearer_auth(bearer=None)
+    assert e.value.status_code == 401
+
+@pytest.mark.asyncio
+async def test_bearer_auth_with_invalid_bearer(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        return await auth_handler.bearer_auth(bearer=HTTPAuthorizationCredentials(scheme="Bearer", credentials="123"))
+    assert e.value.status_code == 401
+
+@pytest.mark.asyncio
+async def test_bearer_auth_with_valid_bearer(auth_handler: AuthHandler):
+    res = await auth_handler.bearer_auth(bearer=HTTPAuthorizationCredentials(scheme="Bearer", credentials=VALID_JWT))
+    assert res.scopes == [Scope.READ_PREDICTIONS]
+
+@pytest.mark.asyncio
+async def test_bearer_auth_with_expired_bearer(auth_handler: AuthHandler):
+    with pytest.raises(HTTPException) as e:
+        return await auth_handler.bearer_auth(bearer=HTTPAuthorizationCredentials(scheme="Bearer", credentials=EXPIRED_JWT))
+    assert e.value.status_code == 401
+    assert e.value.detail == "jwt expired"
+    
+    
+    

crypticorn-2.0.0/requirements/test.txt

@@ -1,6 +0,0 @@
-pytest >= 7.2.1
-pytest-cov >= 2.8.1
-tox >= 3.9.0
-flake8 >= 4.0.0
-types-python-dateutil >= 2.8.19.14
-mypy >= 1.5