✨ feat: endpoint & sql support

Author: Jon-Becker

tests/test_endpoints.py

@@ -0,0 +1,130 @@
+from datetime import datetime
+from transpose import Transpose, api_key
+from transpose.src.base import TransposeBadRequest
+
+def test_basic():
+    try:
+        api = Transpose(api_key)
+        
+        parameters = {
+            'start_date': datetime.now().isoformat().split("T")[0],
+            'time_interval': '1 day',
+            'token_address': '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+        }
+
+        response = api.endpoint.query('ohlc', parameters)
+        
+        assert response['stats']['count'] >= 1
+        assert len(response['results']) >= 1
+        
+    except Exception:
+        assert False
+        
+def test_normalize_1():
+    try:
+        api = Transpose(api_key)
+        
+        parameters = {
+            'start_date': datetime.now().isoformat().split("T")[0],
+            'time_interval': '1 day',
+            'token_address': '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+        }
+
+        response = api.endpoint.query('https://api.transpose.io/endpoint/ohlc', parameters)
+        
+        assert response['stats']['count'] >= 1
+        assert len(response['results']) >= 1
+        
+    except Exception:
+        assert False
+        
+def test_normalize_2():
+    try:
+        api = Transpose(api_key)
+        
+        parameters = {
+            'start_date': datetime.now().isoformat().split("T")[0],
+            'time_interval': '1 day',
+            'token_address': '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+        }
+
+        response = api.endpoint.query('https://api.transpose.io/ohlc', parameters)
+        
+        assert response['stats']['count'] >= 1
+        assert len(response['results']) >= 1
+        
+    except Exception:
+        assert False
+
+def test_normalize_3():
+    try:
+        api = Transpose(api_key)
+        
+        parameters = {
+            'start_date': datetime.now().isoformat().split("T")[0],
+            'time_interval': '1 day',
+            'token_address': '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+        }
+
+        response = api.endpoint.query('https://api.transpose.io/ohlc/', parameters)
+        
+        assert response['stats']['count'] >= 1
+        assert len(response['results']) >= 1
+        
+    except Exception:
+        assert False
+        
+def test_normalize_4():
+    try:
+        api = Transpose(api_key)
+        
+        parameters = {
+            'start_date': datetime.now().isoformat().split("T")[0],
+            'time_interval': '1 day',
+            'token_address': '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+        }
+
+        response = api.endpoint.query('https://api.transpose.io/endpoint/ohlc/', parameters)
+        
+        assert response['stats']['count'] >= 1
+        assert len(response['results']) >= 1
+        
+    except Exception:
+        assert False
+        
+def test_normalize_5():
+    try:
+        api = Transpose(api_key)
+        
+        parameters = {
+            'start_date': datetime.now().isoformat().split("T")[0],
+            'time_interval': '1 day',
+            'token_address': '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+        }
+
+        response = api.endpoint.query('https://api.transpose.io/endpoint/ohlc/1', parameters)
+        
+        assert response['stats']['count'] >= 1
+        assert len(response['results']) >= 1
+        
+    except Exception:
+        assert False
+        
+def test_normalize_6():
+    try:
+        api = Transpose(api_key)
+        
+        parameters = {
+            'start_date': datetime.now().isoformat().split("T")[0],
+            'time_interval': '1 day',
+            'token_address': '0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2'
+        }
+
+        response = api.endpoint.query('https://api.transpose.io/endpoint/ohlc/1/', parameters)
+        
+        assert response['stats']['count'] >= 1
+        assert len(response['results']) >= 1
+        
+    except Exception:
+        assert False
+        

tests/test_raw_sql.py

@@ -0,0 +1,43 @@
+from transpose import Transpose, api_key
+from transpose.src.base import TransposeBadRequest
+
+def test_basic():
+    try:
+        api = Transpose(api_key)
+
+        response = api.sql.query("SELECT * FROM ethereum.logs LIMIT 1;")
+        
+        assert response['stats']['count'] == 1
+        assert len(response['results']) == 1
+        
+    except Exception:
+        assert False
+        
+        
+def test_batch():
+    try:
+        api = Transpose(api_key)
+
+        response = api.sql.query("SELECT * FROM ethereum.logs LIMIT 100;")
+        
+        assert response['stats']['count'] == 100
+        assert len(response['results']) == 100
+        
+    except Exception:
+        assert False
+        
+        
+def test_invalid_query():
+    try:
+        api = Transpose(api_key)
+
+        response = api.sql.query("SELECT * FROM ethereum.lgos LIMIT 1;")
+        
+        # assert throws
+        assert False
+        
+    except TransposeBadRequest:
+        assert True
+        
+    except Exception:
+        assert False

transpose/src/api/endpoint/__init__.py

@@ -0,0 +1,39 @@
+import urllib.parse
+
+class Endpoint():
+    def __init__(self, base_class) -> None:
+        self.super  = base_class
+    
+    # Performs the given custom endpoint query
+    # https://docs.transpose.io/custom-endpoints/integrate/
+    def query(self,
+              endpoint: str,
+              parameters: dict={}) -> dict:
+        
+        # save json preference
+        temp = self.super.json
+        self.super.json = True
+        
+        # normalize the endpoint
+        endpoint = endpoint.replace("https://api.transpose.io/endpoint/", "").replace("https://api.transpose.io/", "").split("?")[0]
+            
+        # remove the / if it ends the string
+        endpoint = endpoint[:-1] if endpoint.endswith("/") else endpoint
+        
+        # convert parameters to URI
+        uri_params = urllib.parse.urlencode(parameters)
+            
+        # build final endpoint
+        endpoint = "https://api.transpose.io/endpoint/{}{}{}".format(
+            endpoint,
+            "?" if len(parameters) >= 1 else "",
+            uri_params
+        )
+        
+        # make request
+        response = self.super.perform_authorized_request(None, endpoint)
+        
+        # update pref
+        self.super.json = temp
+        
+        return response

transpose/src/api/endpoint/base.py

@@ -0,0 +1,43 @@
+import json
+import requests
+
+from ....src.util.errors import raise_custom_error
+
+
+class SQL():
+    def __init__(self, base_class) -> None:
+        self.super  = base_class
+    
+    # Performs the given SQL query
+    # https://docs.transpose.io/sql/parameters/
+    def query(self,
+              sql_query: str,
+              parameters: dict={}) -> dict:
+        
+        # build headers
+        request_headers = {
+            'x-api-key': self.super.api_key,
+            'Accept': 'application/json',
+        }
+        
+        # buold body
+        body = {
+            'sql': sql_query,
+            'parameters': parameters
+        }
+
+        # if in verbose mode, log the endpoint
+        print("\n{}\n  {}\n".format("https://api.transpose.io/sql", json.dumps(body, indent=4))) if self.super.verbose else None
+        request = requests.post(
+            "https://api.transpose.io/sql",
+            headers=request_headers,
+            json=body
+        )
+        
+        # check for a successful response
+        if request.status_code == 200:
+            
+            response = request.json()
+            return response
+        else:
+            raise_custom_error(request.status_code, request.json()['message'])

transpose/src/api/sql/__init__.py

@@ -8,7 +8,8 @@
 from ..src.api.nft.base import NFT
 from ..src.api.block.base import Block
 from ..src.api.token.base import Token
-
+from ..src.api.sql.base import SQL
+from ..src.api.endpoint.base import Endpoint
 
 # base class for the Transpose python SDK
 class Transpose:
@@ -46,6 +47,8 @@ def __init__(
         self.nft   = NFT(self)
         self.block = Block(self)
         self.token = Token(self)
+        self.sql   = SQL(self)
+        self.endpoint = Endpoint(self)
 
         # deprecated in favor of the new API
         self.ENS = self.ens
@@ -116,6 +119,46 @@ def perform_authorized_request(self, model: type, endpoint: str, api_key: str=No
             if self.json:
                 return response
 
+            return list(model(dict(each)) for each in response['results'])
+        else:
+            raise_custom_error(request.status_code, request.json()['message'])
+    
+    # the base function for performing authorized requests to the Transpose API suite
+    def perform_authorized_request(self, model: type, endpoint: str, api_key: str=None):
+        if endpoint is None: 
+            return None
+        
+        # build the request
+        request_headers = {
+            'x-api-key': api_key if api_key else self.api_key,
+            'Accept': 'application/json',
+        }
+        
+        # add chain_id to the request
+        endpoint += f'&chain_id={self.chain_id}'
+        
+        # if in verbose mode, log the endpoint
+        print("\n{}\n  {}\n".format(endpoint.replace("https://api.transpose.io", self.host).split("?")[0], "\n  ".join(endpoint.split("?")[1].split("&")))) if self.verbose else None
+        request = requests.get(endpoint.replace("https://api.transpose.io", self.host), headers=request_headers)
+        
+        # check for a successful response
+        if request.status_code == 200:
+            
+            response = request.json()
+            
+            # If the response contains a paginator, set the paginator's next endpoint
+            if 'next' in response:
+                if response['next'] is None:
+                    self._next = None
+                    self._next_class_name = None
+                else: 
+                    self._next = response['next']
+                    self._next_class_name = model
+            
+            # if we are in json mode, return the raw json
+            if self.json:
+                return response
+
             return list(model(dict(each)) for each in response['results'])
         else:
             raise_custom_error(request.status_code, request.json()['message'])