dimo-python-sdk 1.1.1__tar.gz → 1.3.0__tar.gz

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimo-python-sdk
-Version: 1.1.1
+Version: 1.3.0
 Summary: DIMO SDK in Python
 Author-email: Barrett Kowalsky <barrettkowalsky@gmail.com>
 Project-URL: Homepage, https://github.com/DIMO-Network/dimo-python-sdk
@@ -144,15 +144,38 @@ For the end users of your application, they will need to share their vehicle per
 
 Typically, any endpoints that uses a NFT `tokenId` in path parameters will require JWTs. You can use this flow to obtain a privilege token.
 
+There are now two methods of invoking the token exchange to obtain a Vehicle JWT: a streamlined method and a more verbose method:
+
+##### Streamlined Method (Recommended): 
+This method uses your client_id to check the privileges for a specified token_id via a query to the Identity API. This strips away the need to provide a privileges list:
+
+```python
+# Start by obtaining a Developer JWT 
+auth_header = dimo.auth.get_token(
+    client_id = '<client_id>',
+    domain = '<domain>',
+    private_key = '<private_key>'
+)
+
+dev_jwt = auth_header["access_token"]
+
+# Then use the simplified method for getting a Vehicle JWT
+
+get_vehicle_jwt = dimo.token_exchange.exchange(
+    developer_jwt = dev_jwt
+    token_id ="<token_id>"
+)
+vehicle_jwt = get_vehicle_jwt['token']
+
+```
+##### Verbose Method: 
+This method requires you to explicity provide the list of privileges that this token_id has granted to your developer license. For more information, review the [Permissions Contract (SACD) Documentation](https://docs.dimo.org/developer-platform/developer-guide/permissions-contract-sacd).
 ```python
 
 get_vehicle_jwt = dimo.token_exchange.exchange(
     developer_jwt = dev_jwt, 
-    # The Developer JWT you received using either the three step function calls, or the .get_token() shortcut 
     privileges=[1, 3, 4, 5],
-    # The privileges you've set for this vehicle, in list format (e.g. [1, 3, 4, 5])
     token_id="<token_id>" 
-    # The Vehicle NFT Token ID that you are requesting permission to
     )
 vehicle_jwt = get_vehicle_jwt['token']
 ```

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/README.md

@@ -126,15 +126,38 @@ For the end users of your application, they will need to share their vehicle per
 
 Typically, any endpoints that uses a NFT `tokenId` in path parameters will require JWTs. You can use this flow to obtain a privilege token.
 
+There are now two methods of invoking the token exchange to obtain a Vehicle JWT: a streamlined method and a more verbose method:
+
+##### Streamlined Method (Recommended): 
+This method uses your client_id to check the privileges for a specified token_id via a query to the Identity API. This strips away the need to provide a privileges list:
+
+```python
+# Start by obtaining a Developer JWT 
+auth_header = dimo.auth.get_token(
+    client_id = '<client_id>',
+    domain = '<domain>',
+    private_key = '<private_key>'
+)
+
+dev_jwt = auth_header["access_token"]
+
+# Then use the simplified method for getting a Vehicle JWT
+
+get_vehicle_jwt = dimo.token_exchange.exchange(
+    developer_jwt = dev_jwt
+    token_id ="<token_id>"
+)
+vehicle_jwt = get_vehicle_jwt['token']
+
+```
+##### Verbose Method: 
+This method requires you to explicity provide the list of privileges that this token_id has granted to your developer license. For more information, review the [Permissions Contract (SACD) Documentation](https://docs.dimo.org/developer-platform/developer-guide/permissions-contract-sacd).
 ```python
 
 get_vehicle_jwt = dimo.token_exchange.exchange(
     developer_jwt = dev_jwt, 
-    # The Developer JWT you received using either the three step function calls, or the .get_token() shortcut 
     privileges=[1, 3, 4, 5],
-    # The privileges you've set for this vehicle, in list format (e.g. [1, 3, 4, 5])
     token_id="<token_id>" 
-    # The Vehicle NFT Token ID that you are requesting permission to
     )
 vehicle_jwt = get_vehicle_jwt['token']
 ```

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/dimo/api/auth.py

@@ -6,10 +6,11 @@ from typing import Dict, Optional
 
 class Auth:
 
-    def __init__(self, request_method, get_auth_headers, env):
+    def __init__(self, request_method, get_auth_headers, env, dimo_instance):
         self._request = request_method
         self._get_auth_headers = get_auth_headers
         self.env = env
+        self._dimo = dimo_instance
 
     def generate_challenge(
         self,
@@ -86,7 +87,7 @@ class Auth:
         )
 
     # Requires client_id, domain, and private_key. Address defaults to client_id.
-    def get_token(
+    def get_dev_jwt(
         self,
         client_id: str,
         domain: str,
@@ -95,11 +96,14 @@ class Auth:
         scope="openid email",
         response_type="code",
     ) -> Dict:
+
         check_type("client_id", client_id, str)
         check_type("domain", domain, str)
         check_type("private_key", private_key, str)
         check_optional_type("address", address, str)
 
+        self._dimo._client_id = client_id
+
         if address is None:
             address = client_id
 

dimo_python_sdk-1.3.0/dimo/api/token_exchange.py

@@ -0,0 +1,85 @@
+from dimo.constants import dimo_constants
+from dimo.errors import check_type, check_optional_type
+from dimo.permission_decoder import PermissionDecoder
+
+
+class TokenExchange:
+
+    def __init__(
+        self, request_method, get_auth_headers, identity_instance, dimo_instance
+    ):
+        self._request = request_method
+        self._get_auth_headers = get_auth_headers
+        self._identity = identity_instance
+        self._dimo = dimo_instance
+        self._permission_decoder = PermissionDecoder()
+
+    def _decode_vehicle_permissions(self, token_id: int, client_id: str) -> dict:
+        response = self._identity.check_vehicle_privileges(token_id)
+        try:
+            nodes = (
+                response.get("data", {})
+                .get("vehicle", {})
+                .get("sacds", {})
+                .get("nodes", [])
+            )
+            if not nodes or not isinstance(nodes, list):
+                raise ValueError("Invalid response from server")
+            filtered_sacd = next(
+                (
+                    node
+                    for node in nodes
+                    if node.get("grantee").lower() == client_id.lower()
+                ),
+                None,
+            )
+
+            if not filtered_sacd:
+                raise ValueError(
+                    f"No permissions found for developer license: {client_id}. "
+                    "Has this vehicle been shared?"
+                )
+
+            return self._permission_decoder.decode_permission_bits(
+                filtered_sacd["permissions"]
+            )
+
+        except Exception as e:
+            raise ValueError(f"Failed to decode permissions: {str(e)}")
+
+    def exchange(
+        self,
+        developer_jwt: str,
+        token_id: int,
+        client_id: str = None,
+        env: str = "Production",
+        privileges: list = None,
+    ) -> dict:
+
+        if client_id is None:
+            client_id = self._dimo._client_id
+            if not client_id:
+                raise ValueError(
+                    "No client_id found. Please make sure you've obtained a Developer JWT before calling token exchange."
+                )
+        check_type("developer_jwt", developer_jwt, str)
+        check_optional_type("privileges", privileges, list)
+        check_type("token_id", token_id, int)
+        check_type("client_id", client_id, str)
+
+        if privileges is None:
+            privileges = self._decode_vehicle_permissions(token_id, client_id)
+
+        body = {
+            "nftContractAddress": dimo_constants[env]["NFT_address"],
+            "privileges": privileges,
+            "tokenId": token_id,
+        }
+        response = self._request(
+            "POST",
+            "TokenExchange",
+            "/v1/tokens/exchange",
+            headers=self._get_auth_headers(developer_jwt),
+            data=body,
+        )
+        return response

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/dimo/dimo.py

@@ -18,15 +18,18 @@ class DIMO:
     def __init__(self, env="Production"):
         self.env = env
         self.urls = dimo_environment[env]
+        self._client_id = None
         self.attestation = Attestation(self.request, self._get_auth_headers)
-        self.auth = Auth(self.request, self._get_auth_headers, self.env)
+        self.auth = Auth(self.request, self._get_auth_headers, self.env, self)
         self.device_definitions = DeviceDefinitions(
             self.request, self._get_auth_headers
         )
-        self.token_exchange = TokenExchange(self.request, self._get_auth_headers)
+        self.identity = Identity(self)
+        self.token_exchange = TokenExchange(
+            self.request, self._get_auth_headers, self.identity, self
+        )
         self.trips = Trips(self.request, self._get_auth_headers)
         self.valuations = Valuations(self.request, self._get_auth_headers)
-        self.identity = Identity(self)
         self.telemetry = Telemetry(self)
         self._session = Request.session
 

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/dimo/graphql/identity.py

@@ -204,3 +204,21 @@ class Identity:
         variables = {"owner": address, "first": limit}
 
         return self.dimo.query("Identity", query, variables=variables)
+
+    # # Sample query - check the privileges granted to your app by token_id
+    def check_vehicle_privileges(self, token_id: int) -> dict:
+        query = """
+      query CheckPrivileges($tokenId: Int!) {
+        vehicle(tokenId: $tokenId) {
+					sacds(first:100) {
+						nodes {
+							permissions
+							grantee
+						}
+					}
+				}
+      }
+      """
+        variables = {"tokenId": token_id}
+
+        return self.dimo.query("Identity", query, variables=variables)

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/dimo/graphql/telemetry.py

@@ -5,6 +5,18 @@ class Telemetry:
     # Primary query method
     def query(self, query, vehicle_jwt):
         return self.dimo.query("Telemetry", query, token=vehicle_jwt)
+    
+    def available_signals(self, vehicle_jwt: str, token_id: int) -> dict:
+        query = """
+        query getAvailableSignals($tokenId: Int!) {
+            availableSignals (tokenId: $tokenId)
+        }
+        """
+        variables = {"tokenId": token_id}
+        
+        return self.dimo.query(
+            "Telemetry", query, token=vehicle_jwt, variables=variables
+        )
 
     # Sample query - get signals latest
     def get_signals_latest(self, vehicle_jwt: str, token_id: int) -> dict:
@@ -133,7 +145,10 @@ class Telemetry:
             attestation_response = self.dimo.attestation.create_vin_vc(
                 vehicle_jwt=vehicle_jwt, token_id=token_id
             )
-            if attestation_response["message"] == 'VC generated successfully. Retrieve using the provided GQL URL and query parameter.':
+            if (
+                attestation_response["message"]
+                == "VC generated successfully. Retrieve using the provided GQL URL and query parameter."
+            ):
                 query = """
                 query GetLatestVinVC($tokenId: Int!) {
                     vinVCLatest(tokenId: $tokenId) {
@@ -144,9 +159,9 @@ class Telemetry:
                 variables = {"tokenId": token_id}
 
                 return self.dimo.query(
-                "Telemetry", query, token=vehicle_jwt, variables=variables
-            )
-            else: 
+                    "Telemetry", query, token=vehicle_jwt, variables=variables
+                )
+            else:
                 return "There was an error generating a VIN VC. Please check your credentials and try again."
 
         except Exception as error:

dimo_python_sdk-1.3.0/dimo/permission_decoder.py

@@ -0,0 +1,13 @@
+class PermissionDecoder:
+    @staticmethod
+    def decode_permission_bits(permission_hex: str) -> list:
+        clean_hex = permission_hex.lower().replace("0x", "")
+        permission_bits = int(clean_hex, 16)
+
+        granted_permissions = []
+
+        for i in range(128):
+            bit_pair = (permission_bits >> i * 2) & 0b11
+            if bit_pair == 0b11:
+                granted_permissions.append(i)
+        return granted_permissions

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/dimo_python_sdk.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dimo-python-sdk
-Version: 1.1.1
+Version: 1.3.0
 Summary: DIMO SDK in Python
 Author-email: Barrett Kowalsky <barrettkowalsky@gmail.com>
 Project-URL: Homepage, https://github.com/DIMO-Network/dimo-python-sdk
@@ -144,15 +144,38 @@ For the end users of your application, they will need to share their vehicle per
 
 Typically, any endpoints that uses a NFT `tokenId` in path parameters will require JWTs. You can use this flow to obtain a privilege token.
 
+There are now two methods of invoking the token exchange to obtain a Vehicle JWT: a streamlined method and a more verbose method:
+
+##### Streamlined Method (Recommended): 
+This method uses your client_id to check the privileges for a specified token_id via a query to the Identity API. This strips away the need to provide a privileges list:
+
+```python
+# Start by obtaining a Developer JWT 
+auth_header = dimo.auth.get_token(
+    client_id = '<client_id>',
+    domain = '<domain>',
+    private_key = '<private_key>'
+)
+
+dev_jwt = auth_header["access_token"]
+
+# Then use the simplified method for getting a Vehicle JWT
+
+get_vehicle_jwt = dimo.token_exchange.exchange(
+    developer_jwt = dev_jwt
+    token_id ="<token_id>"
+)
+vehicle_jwt = get_vehicle_jwt['token']
+
+```
+##### Verbose Method: 
+This method requires you to explicity provide the list of privileges that this token_id has granted to your developer license. For more information, review the [Permissions Contract (SACD) Documentation](https://docs.dimo.org/developer-platform/developer-guide/permissions-contract-sacd).
 ```python
 
 get_vehicle_jwt = dimo.token_exchange.exchange(
     developer_jwt = dev_jwt, 
-    # The Developer JWT you received using either the three step function calls, or the .get_token() shortcut 
     privileges=[1, 3, 4, 5],
-    # The privileges you've set for this vehicle, in list format (e.g. [1, 3, 4, 5])
     token_id="<token_id>" 
-    # The Vehicle NFT Token ID that you are requesting permission to
     )
 vehicle_jwt = get_vehicle_jwt['token']
 ```

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/dimo_python_sdk.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ dimo/dimo.py
 dimo/environments.py
 dimo/errors.py
 dimo/eth_signer.py
+dimo/permission_decoder.py
 dimo/request.py
 dimo/api/__init__.py
 dimo/api/attestation.py

{dimo_python_sdk-1.1.1 → dimo_python_sdk-1.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dimo-python-sdk"
-version = "1.1.1"
+version = "1.3.0"
 authors = [
   { name="Barrett Kowalsky", email="barrettkowalsky@gmail.com" },
 ]

dimo_python_sdk-1.1.1/dimo/api/token_exchange.py

@@ -1,33 +0,0 @@
-from dimo.constants import dimo_constants
-from dimo.errors import check_type
-
-
-class TokenExchange:
-
-    def __init__(self, request_method, get_auth_headers):
-        self._request = request_method
-        self._get_auth_headers = get_auth_headers
-
-    def exchange(
-        self,
-        developer_jwt: str,
-        privileges: list,
-        token_id: int,
-        env: str = "Production",
-    ) -> dict:
-        check_type("developer_jwt", developer_jwt, str)
-        check_type("privileges", privileges, list)
-        check_type("token_id", token_id, int)
-        body = {
-            "nftContractAddress": dimo_constants[env]["NFT_address"],
-            "privileges": privileges,
-            "tokenId": token_id,
-        }
-        response = self._request(
-            "POST",
-            "TokenExchange",
-            "/v1/tokens/exchange",
-            headers=self._get_auth_headers(developer_jwt),
-            data=body,
-        )
-        return response