add new features to response

Author: robswc

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = quickbase-json-api-client
-version = 0.0.9
+version = 0.0.10
 author = Robert Carroll
 author_email = rob@shenandoah.capital
 description = Python wrapper for quickbase JSON API.

src/quickbase_json/client.py

@@ -2,11 +2,13 @@
 
 import requests
 
+from quickbase_json.helpers import FileUpload
+from quickbase_json.qb_insert_update_response import QBInsertResponse
 from quickbase_json.qb_response import QBResponse
 
 
 class QuickbaseJSONClient:
-    def __init__(self, realm, auth, **kwargs):
+    def __init__(self, realm, auth, debug=False, **kwargs):
         """
         Creates a client object.
         :param realm: quickbase realm
@@ -20,7 +22,7 @@ def __init__(self, realm, auth, **kwargs):
             'User-Agent': '{User-Agent}',
             'Authorization': f'QB-USER-TOKEN {auth}'
         }
-        self.debug = True if kwargs.get('debug') else False
+        self.debug = debug
 
     """
     Records API
@@ -44,13 +46,21 @@ def query_records(self, table: str, select: list, where: str, **kwargs):
 
         # add optional args
         body.update(kwargs)
-        r = requests.post('https://api.quickbase.com/v1/records/query', headers=self.headers, json=body).json()
+        r = requests.post('https://api.quickbase.com/v1/records/query', headers=self.headers, json=body)
+
+        if self.debug:
+            print(f'QJAC : query_records : response ---> {r}')
+            print(f'QJAC : query_records : response.json() ---> \n{r.json()}')
 
         # create response object
         res = QBResponse('records')
 
         # update response object with JSON data from request
-        res.update(r)
+        res.update(r.json())
+
+        if self.debug:
+            print(f'QJAC : query_records : QBResponse ---> \n{res}')
+
         return res
 
     def insert_update_records(self, table: str, data: list):
@@ -63,7 +73,17 @@ def insert_update_records(self, table: str, data: list):
         """
 
         body = {'to': table, 'data': data}
-        return requests.post('https://api.quickbase.com/v1/records', headers=self.headers, json=body).json()
+
+        if self.debug:
+            print(f'QJAC : insert_update : body ---> \n{body}')
+
+        r = requests.post('https://api.quickbase.com/v1/records', headers=self.headers, json=body)
+
+        res = QBInsertResponse()
+
+
+
+        return
 
     def delete_records(self, table: str, where: str):
         """
@@ -76,8 +96,39 @@ def delete_records(self, table: str, where: str):
 
         headers = self.headers
         body = {'to': table, 'where': where}
+
+        if self.debug:
+            print(f'QJAC : delete_records : body ---> \n{body}')
+
         return requests.delete('https://api.quickbase.com/v1/records', headers=headers, json=body).json()
 
+    """
+    Easy Upload
+    """
+
+    def easy_upload(self, table: str, rid: int, fid: str, file_path: str):
+        """
+        Allows for easy upload of files to quickbase
+        :param table: id of table to upload to
+        :param rid: record id to update
+        :param fid: fid (where to put the file)
+        :param file_path: path to local file to upload
+        :return: request response
+        """
+        file = FileUpload(file_path)
+        data = [
+            {
+                3: rid,
+                fid: file
+            }
+        ]
+
+        if self.debug:
+            print(f'QJAC : easy_upload : file ---> \n{file}')
+            print(f'QJAC : easy_upload : data ---> \n{data}')
+
+        return self.insert_update_records(table, data=data)
+
     """
     Table API
     """
@@ -95,6 +146,10 @@ def create_table(self, app_id: str, name: str, **kwargs):
         headers = self.headers
         params = {'appId': f'{app_id}'}
         body = {'name': name}.update(kwargs)
+
+        if self.debug:
+            print(f'QJAC : create_table : body ---> \n{body}')
+
         return requests.post('https://api.quickbase.com/v1/tables', params=params, headers=headers, json=body).json()
 
     def get_tables(self, app_id: str):
@@ -108,6 +163,10 @@ def get_tables(self, app_id: str):
         headers = self.headers
         params = {'appId': f'{app_id}'}
         body = None
+
+        if self.debug:
+            print(f'QJAC : get_tables : params ---> \n{params}')
+
         return requests.post('https://api.quickbase.com/v1/tables', params=params, headers=headers, json=body).json()
 
     """
@@ -130,5 +189,11 @@ def get_fields(self, table_id: str, **kwargs):
     """
     Misc.
     """
+
     def __str__(self):
-        return f'Quickbase Client: {self.realm}'
+        """
+        Shows a string representation of a QuickbaseJSONClient.
+        :return: client's realm and last 5 of auth
+        """
+        auth_str = ''.join(['*' for _ in range(len(list(self.auth)))] + list(self.auth)[-5:])
+        return f'Quickbase Client\t--->\t{self.realm} : {auth_str} (DEBUG: {self.debug})'

src/quickbase_json/qb_insert_update_response.py

@@ -0,0 +1,51 @@
+import datetime
+from functools import wraps
+
+
+class Bcolors:
+    HEADER = '\033[95m'
+    OKBLUE = '\033[94m'
+    OKCYAN = '\033[96m'
+    OKGREEN = '\033[92m'
+    WARNING = '\033[93m'
+    FAIL = '\033[91m'
+    ENDC = '\033[0m'
+    BOLD = '\033[1m'
+    UNDERLINE = '\033[4m'
+
+
+def operation(method):
+    @wraps(method)
+    def wrapper(self, *args, **kwargs):
+        self.operations.append(method.__name__)
+        return method(self, *args, **kwargs)
+
+    return wrapper
+
+
+class QBInsertResponse(dict):
+
+    def __init__(self, **kwargs):
+        self.ok = False
+        self.status = None
+        self.processed = 0
+        self.created_rids = []
+        self.updated_rids = []
+        super().__init__()
+
+    def info(self):
+        """
+        Prints information about the response.
+        :prt: Set to False to only grab the return as a string.
+        """
+        print(f'Response:\nOK:\t--->\t{self.ok}\nChanged:\t--->\t{len(self.updated_rids)}\nInserted:\t--->\t{len(self.created_rids)}')
+
+    def from_response(self, response):
+        self.ok = response.ok
+        self.status = response.status
+
+        if self.ok:
+            self.update(response.json())
+            self.created_rids = self.get('metadata').get('createdRecordIds')
+            self.updated_rids = self.get('metadata').get('updatedRecordIds')
+            self.processed = self.get('metadata').get('totalNumberOfRecordsProcessed')