Merge branch 'main' into feature_get_api_key

Author: unniznd

src/lighthouseweb3/__init__.py

@@ -7,7 +7,8 @@
     deal_status, 
     get_uploads as getUploads, 
     download as _download,
-    get_api_key as getApiKey
+    get_file_info as getFileInfo,
+    get_balance as getBalance
 )
 
 
@@ -44,6 +45,17 @@ def uploadBlob(self, source: io.BufferedReader, filename: str, tag: str = ''):
             return d.uploadBlob(source, filename, self.token, tag)
         except Exception as e:
             raise e
+    
+    def getBalance(self):
+        """
+        Retrieve the balance information of a user from the Lighthouse.
+        :param publicKey: str, The public key of the user.
+        :return: dict[str, any], A dictionary containing the data usage and data limit details.
+        """
+        try:
+            return getBalance.get_balance(self.token)
+        except Exception as e:
+            raise e
 
     @staticmethod
     def downloadBlob(dist: io.BufferedWriter, cid: str, chunk_size=1024*1024*10):
@@ -74,18 +86,16 @@ def getDealStatus(cid: str):
             return deal_status.get_deal_status(cid)
         except Exception as e:
             raise e
-
-    @staticmethod
-    def getUploads(publicKey: str, pageNo: int = 1):
+    
+    def getUploads(self, lastKey: str = None):
         """
         Get uploads from the Lighthouse.
 
-        :param publicKey: str, public key
-        :param pageNo: int, page number (default: 1)
+        :param lastKey: To navigate to different pages of results
         :return: List[t.DealData], list of deal data
         """
         try:
-            return getUploads.get_uploads(publicKey, pageNo)
+            return getUploads.get_uploads(self.token, lastKey)
         except Exception as e:
             raise e
 
@@ -104,18 +114,15 @@ def download(cid: str):
             raise e
 
     @staticmethod
-    def getApiKey(publicKey: str, signedMessage: str):
+    def getFileInfo(cid: str):
         """
-        Generates and returns an API key for the given public key and signed message.
-
-        :param publicKey: str, The public key associated with the user.
-        :param signedMessage: str, The message signed by the user's private key.
-        :return: dict, A dict with generated API key.
+        Retrieves information about a file using its CID (Content Identifier).
+        :param cid: str, Content Identifier for the data to be downloaded
+        returns: dict, A dictionary containing file information.
         """
 
-
         try:
-            return getApiKey.get_api_key(publicKey, signedMessage)
+            return getFileInfo.get_file_info(cid)
         except Exception as e:
             raise e
 

src/lighthouseweb3/functions/get_balance.py

@@ -0,0 +1,14 @@
+from .config import Config
+import requests as req
+
+def get_balance(token:str):
+  headers = {
+        "Authorization": f"Bearer {token}",
+    }
+  url = f"{Config.lighthouse_api}/api/user/user_data_usage"
+  try:
+    response = req.get(url, headers=headers)
+  except Exception as e:
+    raise Exception("Failed to get account balance")
+
+  return response.json()

src/lighthouseweb3/functions/get_file_info.py

@@ -0,0 +1,11 @@
+from .config import Config
+import requests as req
+
+def get_file_info(cid: str):
+  url = f"{Config.lighthouse_api}/api/lighthouse/file_info?cid={cid}"
+  try:
+    response = req.get(url)
+  except Exception as e:
+    raise Exception("Failed to get file metadata")
+
+  return response.json()

src/lighthouseweb3/functions/get_uploads.py

@@ -11,10 +11,14 @@ def bytes_to_size(bytes_size):
     return f"{round(bytes_size, 2)} {units[index]}"
 
 
-def get_uploads(publicKey: str, pageNo: int = 1) :
+def get_uploads(token: str, lastKey: str = None) :
+    headers = {
+        "Authorization": f"Bearer {token}",
+    }
+
     try:
-        url = f"{Config.lighthouse_api}/api/user/files_uploaded?publicKey={publicKey}&pageNo={pageNo}"
-        response = requests.get(url)
+        url = f"{Config.lighthouse_api}/api/user/files_uploaded?lastKey={lastKey}"
+        response = requests.get(url, headers=headers)
         response.raise_for_status()
         return response.json()
     except requests.HTTPError as error:

tests/test_deal_status.py

@@ -15,7 +15,7 @@ def test_deal_status(self):
             "QmT9shXpKcn4HRbJhXJ1ZywzwjEo2QWbxAx4SVgW4eYKjG")
         self.assertIsInstance(res, list, "data is a list")
         self.assertIsInstance(res[0].get(
-            "dealId"), int, "dealId is Int")
+            "DealID"), int, "DealID is Int")
 
     def test_deal_status_init(self):
         """test deal_status function"""
@@ -25,4 +25,4 @@ def test_deal_status_init(self):
             "QmT9shXpKcn4HRbJhXJ1ZywzwjEo2QWbxAx4SVgW4eYKjG")
         self.assertIsInstance(res, list, "data is a list")
         self.assertIsInstance(res[0].get(
-            "dealId"), int, "dealId is Int")
+            "DealID"), int, "DealID is Int")

tests/test_get_balance.py

@@ -0,0 +1,26 @@
+#!/usr/bin/env python3
+import os
+import unittest
+from src.lighthouseweb3 import Lighthouse
+from .setup import parse_env
+
+
+class TestGetBalance(unittest.TestCase):
+
+    def test_get_balance(self):
+        """test get_balance function"""
+        parse_env()
+        l = Lighthouse(os.environ.get("LIGHTHOUSE_TOKEN"))
+        res = l.getBalance()
+        self.assertIsInstance(res, dict, "data is a dict")
+        self.assertIsInstance(res.get("dataLimit"), int, "data limit is a integer")
+        self.assertIsInstance(res.get("dataUsed"), int, "data used is a integer")
+    
+    def test_get_balance_invalid_token(self):
+        """test get_balance function with invalid token"""
+        parse_env()
+        l = Lighthouse('invalid_token')
+        res = l.getBalance()
+        self.assertIsInstance(res, dict, "res is a dict")
+        self.assertIn("authentication failed", str(res).lower())
+

tests/test_get_file_info.py

@@ -0,0 +1,31 @@
+#!/usr/bin/env python3
+import os
+import unittest
+from src.lighthouseweb3 import Lighthouse
+from .setup import parse_env
+
+
+class TestGetFileInfo(unittest.TestCase):
+
+    def test_get_file_info(self):
+        """test get_file_info function"""
+        parse_env()
+        l = Lighthouse(os.environ.get("LIGHTHOUSE_TOKEN"))
+        res = l.getFileInfo("Qmd5MBBScDUV3Ly8qahXtZFqyRRfYSmUwEcxpYcV4hzKfW")
+        self.assertIsInstance(res, dict, "data is a dict")
+        self.assertEqual(res.get("cid"),"Qmd5MBBScDUV3Ly8qahXtZFqyRRfYSmUwEcxpYcV4hzKfW", "cid is matching")
+    
+    def test_get_file_info_invalid_token(self):
+        """test get_upload with invalid token"""
+        with self.assertRaises(Exception) as context:
+            l = Lighthouse("invalid_token")
+            l.getFileInfo("Qmd5MBBScDUV3Ly8qahXtZFqyRRfYSmUwEcxpYcV4hzKfW")
+            self.assertIn("authentication failed", str(context.exception).lower())
+    
+    def test_get_file_info_invalid_cid(self):
+        parse_env()
+        l = Lighthouse(os.environ.get("LIGHTHOUSE_TOKEN"))
+        res = l.getFileInfo("invalid_cid")
+        self.assertIsInstance(res, dict, "res is dict")
+        self.assertIsInstance(res.get('error'), dict, "error is dict")
+        self.assertEqual(res.get("error").get('message'), 'Not Found', 'cid not found')

tests/test_get_uploads.py

@@ -7,18 +7,28 @@
 from .setup import parse_env
 
 
-class TestDealStatus(unittest.TestCase):
+class TestGetUploads(unittest.TestCase):
 
     def test_get_upload(self):
-        """test static test_get_upload function"""
-        res = Lighthouse.getUploads(
-            "0xB23809427cFc9B3346AEC5Bb70E7e574696cAF80")
-        self.assertIsInstance(res.get("fileList"), list, "data is a list")
-
-    def test_get_upload_init(self):
         """test get_upload function"""
         parse_env()
         l = Lighthouse(os.environ.get("LIGHTHOUSE_TOKEN"))
-        res = Lighthouse.getUploads(
-            "0xB23809427cFc9B3346AEC5Bb70E7e574696cAF80")
+        res = l.getUploads()
+        self.assertIsInstance(res.get("fileList"), list, "data is a list")
+        self.assertIsInstance(res.get('totalFiles'), int, "totalFiles is an int")
+    
+    def test_get_upload_with_last_key(self):
+        """test get_upload function with lastKey"""
+        parse_env()
+        l = Lighthouse(os.environ.get("LIGHTHOUSE_TOKEN"))
+        res = l.getUploads('b5f60ba0-b708-41a3-b0f2-5c808ce63b48')
         self.assertIsInstance(res.get("fileList"), list, "data is a list")
+        self.assertIsInstance(res.get('totalFiles'), int, "totalFiles is an int")
+    
+    def test_get_upload_with_invalid_token(self):
+        """test get_upload function with invalid token"""
+        parse_env()
+        l = Lighthouse("invalid_token")
+        with self.assertRaises(Exception) as context:
+            l.getUploads()
+            self.assertIn("authentication failed", str(context.exception).lower())