crypticorn 2.0.0__py3-none-any.whl → 2.0.1__py3-none-any.whl

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/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/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.dist-info → crypticorn-2.0.1.dist-info}/METADATA

@@ -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.dist-info → crypticorn-2.0.1.dist-info}/RECORD

@@ -50,10 +50,10 @@ crypticorn/auth/client/models/verify_wallet_request.py,sha256=b0DAocvhKzPXPjM62D
 crypticorn/auth/client/models/wallet_verified200_response.py,sha256=QILnTLsCKdI-WdV_fsLBy1UH4ZZU-U-wWJ9ot8v08tI,2465
 crypticorn/auth/client/models/whoami200_response.py,sha256=uehdq5epgeOphhrIR3tbrseflxcLAzGyKF-VW-o5cY8,2974
 crypticorn/common/__init__.py,sha256=lY87VMTkIEqto6kcEjC1YWsUvT03QuPmXwxCaeWE854,196
-crypticorn/common/auth.py,sha256=pqmn5wG9CWql7wwAOs3p8zWlR2XyOzcoA17xgC6KsjA,1213
-crypticorn/common/auth_client.py,sha256=PlMBSQ_SyWGvZQsc97DlokoWLprwlo0r9-oftD89Rps,5564
+crypticorn/common/auth.py,sha256=SncaDgteLLyypwiRGd1fEF_yvy2mxPy0YNkLgv30ARQ,1204
+crypticorn/common/auth_client.py,sha256=uqf4IL0UfnxO8TxZHEhaZb9CzI4vUOKpU2wZXBud-30,6122
 crypticorn/common/errors.py,sha256=jGAS7TONKhdaRfft7w-0wrJ3BBTzqS6u03susiqAF0w,12723
-crypticorn/common/scopes.py,sha256=60dLff6zADjkKLwsOrwfpgFoCQjh3fqBS5Mpe5PonaU,991
+crypticorn/common/scopes.py,sha256=PkInTfPGelXW3jXJlMiOOZsO5uPW-FDjKDediZh9xqQ,1144
 crypticorn/common/urls.py,sha256=_NMhvhZXOsZpDBbgucqu0yboRFox6JVMlOoQq_Y5SGA,432
 crypticorn/hive/__init__.py,sha256=hRfTlEzEql4msytdUC_04vfaHzVKG5CGZle1M-9QFgY,81
 crypticorn/hive/main.py,sha256=RmCYSR0jwmfYWTK89dt79DuGPjEaip9XQs_LWNWr_tc,1036
@@ -220,7 +220,7 @@ crypticorn/trade/client/models/trading_action_type.py,sha256=jW0OsNz_ZNXlITxAfh9
 crypticorn/trade/client/models/update_notification.py,sha256=B9QUuVRNpk1e5G8o0WFgIg3inm-OX7KJAJcjVnRzYx8,3046
 crypticorn/trade/client/models/validation_error.py,sha256=uTkvsKrOAt-21UC0YPqCdRl_OMsuu7uhPtWuwRSYvv0,3228
 crypticorn/trade/client/models/validation_error_loc_inner.py,sha256=22ql-H829xTBgfxNQZsqd8fS3zQt9tLW1pj0iobo0jY,5131
-crypticorn-2.0.0.dist-info/METADATA,sha256=WEAVy4EuJjyFyULElXpwnA3eyiqt5yeX7eGrwk_HVI4,2804
-crypticorn-2.0.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
-crypticorn-2.0.0.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
-crypticorn-2.0.0.dist-info/RECORD,,
+crypticorn-2.0.1.dist-info/METADATA,sha256=CCwYU2zydLX-poZzGLMXdQ1QIy6s2Oom8n2GP-O1i4k,3066
+crypticorn-2.0.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+crypticorn-2.0.1.dist-info/top_level.txt,sha256=EP3NY216qIBYfmvGl0L2Zc9ItP0DjGSkiYqd9xJwGcM,11
+crypticorn-2.0.1.dist-info/RECORD,,