Merge branch 'main' into feature_ipns_apis

Author: unniznd

requirements-dev.txt

@@ -4,3 +4,5 @@ charset-normalizer==3.1.0
 idna==3.4
 requests==2.31.0
 urllib3==2.0.2
+web3
+eth-accounts

src/lighthouseweb3/__init__.py

@@ -7,10 +7,9 @@
     deal_status, 
     get_uploads as getUploads, 
     download as _download,
-    ipns_generate_key as ipnsGenerateKey,
-    ipns_publish_record as ipnsPublishRecord,
-    get_ipns_record as getIpnsRecord,
-    remove_ipns_record as removeIpnsRecord,
+    get_file_info as getFileInfo,
+    get_balance as getBalance,
+    get_api_key as getApiKey
 )
 
 
@@ -48,51 +47,14 @@ def uploadBlob(self, source: io.BufferedReader, filename: str, tag: str = ''):
         except Exception as e:
             raise e
 
-    def generateKey(self):
+    def getBalance(self):
         """
-        Generate a new IPNS key for the authenticated user.
-        :return: dict, The generated IPNS key information.
+        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 ipnsGenerateKey.ipns_generate_key(self.token)
-        except Exception as e:
-            raise e
-    
-    def publishRecord(self, cid: str, keyName: str):
-        """
-        Publish an IPNS record for a given CID and key name.
-
-        :param cid: str, Content Identifier to publish
-        :param keyName: str, Name of the IPNS key to use
-        :return: dict, The published IPNS record information
-        """
-        try:
-            return ipnsPublishRecord.ipns_publish_record(self.token, cid, keyName)
-        except Exception as e:
-            raise e
-    
-    def getAllKeys(self):
-        """
-        Retrieves all IPNS records associated with the current token.
-
-        return: list A list of IPNS records retrieved using the provided token.
-        """
-
-        try:
-            return getIpnsRecord.get_ipns_records(self.token)
-        except Exception as e:
-            raise e
-    
-    def removeKey(self, keyName: str):
-        """
-        Remove IPNS record of the given keyName
-
-        :param keyName: str, Name of the IPNS key to use
-        :return: dict, A dict of removed IPNS record.
-        """
-
-        try:
-            return removeIpnsRecord.remove_ipns_record(self.token, keyName)
+            return getBalance.get_balance(self.token)
         except Exception as e:
             raise e
 
@@ -125,18 +87,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
 
@@ -153,6 +113,34 @@ def download(cid: str):
             return _download.get_file(cid)
         except Exception as e:
             raise e
+    
+    @staticmethod
+    def getFileInfo(cid: str):
+        """
+        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 getFileInfo.get_file_info(cid)
+        except Exception as e:
+            raise e
+    
+    @staticmethod
+    def getApiKey(publicKey: str, signedMessage: 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.
+        """
+
+
+        try:
+            return getApiKey.get_api_key(publicKey, signedMessage)
+        except Exception as e:
+            raise e
 
     def getTagged(self, tag: str):
         """

src/lighthouseweb3/functions/get_api_key.py

@@ -0,0 +1,28 @@
+from .config import Config
+import requests as req
+
+def get_api_key(publicKey: str, signedMessage: str):
+  url = f"{Config.lighthouse_api}/api/auth/create_api_key"
+
+  data = {
+    "publicKey": publicKey,
+    "signedMessage": signedMessage
+  }
+
+  try:
+    response = req.post(url, data=data)
+  except Exception as e:
+    raise Exception("Failed to create api key")
+
+  if response.status_code != 200:
+    return response.json()
+
+  apiKey = response.json()
+
+  result = {
+    "data": {
+      "apiKey" : apiKey
+    }
+  }
+
+  return result

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_api_key.py

@@ -0,0 +1,86 @@
+#!/usr/bin/env python3
+import os
+import unittest
+from src.lighthouseweb3 import Lighthouse
+from .setup import parse_env
+import requests as req
+from src.lighthouseweb3.functions.config import Config
+from web3 import Web3
+from eth_account.messages import encode_defunct
+
+
+class TestGetApiKey(unittest.TestCase):
+
+    def test_get_api_key(self):
+        """test getApiKey using valid signed message and public key"""
+        parse_env()
+        publicKey = os.environ.get("PUBLIC_KEY")
+        response = req.get(
+          f"{Config.lighthouse_api}/api/auth/get_auth_message?publicKey={publicKey}"
+        )
+
+        if(response.status_code != 200):
+            raise Exception("Failed to get authentication message")
+        
+        verificationMessage = response.json()
+
+        self.assertIn("Please prove you are the owner", verificationMessage, "Owner response should come")
+
+        encodedMessage = encode_defunct(text=verificationMessage)
+
+      
+        signedMessage = Web3().eth.account.sign_message(
+            encodedMessage, 
+            private_key=os.environ.get("PRIVATE_KEY")
+        ).signature.hex()
+
+        res = Lighthouse.getApiKey(publicKey, f"0x{signedMessage}")
+
+        self.assertIsInstance(res, dict, "res is a dict")
+        self.assertIsInstance(res.get("data"), dict, "data is a dict")
+        self.assertIsInstance(res.get('data').get('apiKey'), str, "apiKey is a string")
+    
+    def test_get_api_key_with_invalid_message(self):
+        """test getApiKey using signed invalid message and public key"""
+        parse_env()
+        publicKey = os.environ.get("PUBLIC_KEY")
+        encodedMessage = encode_defunct(text='random_message')
+
+      
+        signedMessage = Web3().eth.account.sign_message(
+            encodedMessage, 
+            private_key=os.environ.get("PRIVATE_KEY")
+        ).signature.hex()
+
+        res = Lighthouse.getApiKey(publicKey, f"0x{signedMessage}")
+        self.assertIsInstance(res, dict, "res is a dict")
+        self.assertIsInstance(res.get("error"), dict, "data is a dict")
+    
+    def test_get_api_key_with_random_private_key(self):
+        """test getApiKey using signed message with invalid private key and public key"""
+
+        parse_env()
+        publicKey = os.environ.get("PUBLIC_KEY")
+        response = req.get(
+          f"{Config.lighthouse_api}/api/auth/get_auth_message?publicKey={publicKey}"
+        )
+
+        if(response.status_code != 200):
+            raise Exception("Failed to get authentication message")
+        
+        verificationMessage = response.json()
+
+        self.assertIn("Please prove you are the owner", verificationMessage, "Owner response should come")
+
+        encodedMessage = encode_defunct(text=verificationMessage)
+
+      
+        signedMessage = Web3().eth.account.sign_message(
+            encodedMessage, 
+            private_key='0x8218aa5dbf4dbec243142286b93e26af521b3e91219583595a06a7765abc9c8b'
+        ).signature.hex()
+
+        res = Lighthouse.getApiKey(publicKey, f"0x{signedMessage}")
+
+        self.assertIsInstance(res, dict, "res is a dict")
+        self.assertIsInstance(res.get("error"), dict, "data is a dict")

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')