Merge pull request #2 from lighthouse-web3/v0.0.7

V0.0.7

Author: ravish1729

README.md

@@ -27,7 +27,7 @@ lh = Lighthouse(token="your_token")
 ```python
 from lighthouseweb3 import Lighthouse
 lh = Lighthouse()
-response = lh.deploy("path/to/file")
+response = lh.upload("path/to/file")
 print(response) # prints a dict containing the cid of the file
 ```
 
@@ -36,7 +36,7 @@ print(response) # prints a dict containing the cid of the file
 ```python
 from lighthouseweb3 import Lighthouse
 lh = Lighthouse("my-lightouse-token")
-response = lh.deploy("path/to/directory")
+response = lh.upload("path/to/directory")
 print(response) # prints a dict containing the root cid of the directory
 ```
 
@@ -45,11 +45,11 @@ print(response) # prints a dict containing the root cid of the directory
 The tests are written with inheritance from the unittest module. To run the tests, run the following command:
 
 ```
-pip install requirements.txt && python -m unittest discover
+pip install -r requirements.txt && python -m unittest discover
 ```
 
 or using nose2
 
 ```
-pip install requirements.txt && python -m nose2
+pip install -r requirements.txt && python -m nose2
 ```

setup.py

@@ -4,11 +4,11 @@
 
 setup(
     name="lighthouseweb3",
-    version="0.0.6",
+    version="0.0.7",
     license="GNU GENERAL PUBLIC LICENSE",
     description="Lighthouse Python SDK",
-    author="Perfection Loveday",
-    author_email="perfection@lighthouse.storage",
+    author="Ayobami Oki| Ravish Sharma | Perfection Loveday",
+    author_email="ravish@lighthouse.storage",
     url="https://github.com/lighthouse-web3/lighthouse-python-sdk",
     packages=find_packages("src"),
     package_dir={"": "src"},

src/lighthouseweb3/__init__.py

@@ -1,8 +1,9 @@
 #!/usr/bin/env python3
 
 import os
-from .functions import deploy as d
-from .functions import types as t
+import io
+from typing import List
+from .functions import upload as d, types as t, deal_status, get_uploads as getUploads
 
 
 class Lighthouse:
@@ -13,12 +14,55 @@ def __init__(self, token: str = ""):
                 "No token provided: Please provide a token or set the LIGHTHOUSE_TOKEN environment variable"
             )
 
-    def deploy(self, source: str) -> t.Deploy:
+    def upload(self, source: str) -> t.Upload:
         """
-        Deploy a file or directory to the lighthouse network
-        @params {source}: str, path to file or directory
+        Upload a file or directory to the Lighthouse.
+
+        :param source: str, path to file or directory
+        :return: t.Upload, the upload result
+        """
+        try:
+            return d.upload(source, self.token)
+        except Exception as e:
+            raise e
+
+    def uploadBlob(self, source: io.BufferedReader, filename: str) -> t.Upload:
+        """
+        Upload Blob a file or directory to the Lighthouse.
+
+        :param source: str, path to file or directory
+        :return: t.Upload, the upload result
+        """
+        if not (hasattr(source, 'read') and hasattr(source, 'close')):
+            raise TypeError("source must have 'read' and 'close' methods")
+        try:
+            return d.uploadBlob(source, filename, self.token)
+        except Exception as e:
+            raise e
+
+    @staticmethod
+    def getDealStatus(cid: str) -> List[t.DealData]:
+        """
+        Get deal status from the Lighthouse.
+
+        :param cid: str, content identifier
+        :return: List[t.DealData], list of deal data
+        """
+        try:
+            return deal_status.get_deal_status(cid)
+        except Exception as e:
+            raise e
+
+    @staticmethod
+    def getUploads(publicKey: str, pageNo: int = 1) -> List[t.DealData]:
+        """
+        Get uploads from the Lighthouse.
+
+        :param publicKey: str, public key
+        :param pageNo: int, page number (default: 1)
+        :return: List[t.DealData], list of deal data
         """
         try:
-            return d.deploy(source, self.token)
+            return getUploads.get_uploads(publicKey, pageNo)
         except Exception as e:
             raise e

src/lighthouseweb3/functions/axios.py

@@ -59,3 +59,28 @@ def post_files(
         except Exception as e:
             utils.close_files_after_upload(files)
             raise e
+
+    def post_blob(
+        self, file: BufferedReader, filename: str, headers: Dict[str, str] = None, **kwargs
+    ) -> dict | Exception:
+        try:
+            self.parse_url_query(kwargs.get("query", None))
+            files = [(
+                "file",
+                (
+                    utils.extract_file_name(filename),
+                    file.read(),
+                    "application/octet-stream",
+                ),
+            ),]
+            r = req.post(self.url, headers=headers, files=files)
+            r.raise_for_status()
+            file.close()
+            try:
+                return r.json()
+            except Exception:
+                temp = r.text.split("\n")
+                return json.loads(temp[len(temp) - 2])
+        except Exception as e:
+            file.close()
+            raise e

src/lighthouseweb3/functions/config.py

@@ -4,6 +4,7 @@
 class Config:
     """Config class for lighthouse"""
 
-    lighthouse_api = "http://13.234.35.183:5050"  # "https://api.lighthouse.storage"
+    # lighthouse_api = "http://13.234.35.183:5050"  # "https://api.lighthouse.storage"
+    lighthouse_api = 'https://api.lighthouse.storage'
     lighthouse_node = "https://node.lighthouse.storage"
     lighthouse_bls_node = "https://encryption.lighthouse.storage"

src/lighthouseweb3/functions/deal_status.py

@@ -0,0 +1,14 @@
+import requests
+from typing import List
+from .config import Config
+from . import types as t
+
+
+def get_deal_status(cid: str) -> List[t.DealData]:
+    try:
+        url = f"{Config.lighthouse_api}/api/lighthouse/deal_status?cid={cid}"
+        response = requests.get(url)
+        response.raise_for_status()
+        return response.json()
+    except requests.HTTPError as error:
+        raise Exception(error.response.text)

src/lighthouseweb3/functions/deploy.py

@@ -0,0 +1,22 @@
+import requests
+from .config import Config
+from . import types as t
+
+
+def bytes_to_size(bytes_size):
+    units = ['B', 'KB', 'MB', 'GB', 'TB']
+    index = 0
+    while bytes_size >= 1024 and index < len(units) - 1:
+        bytes_size /= 1024
+        index += 1
+    return f"{round(bytes_size, 2)} {units[index]}"
+
+
+def get_uploads(publicKey: str, pageNo: int = 1) -> t.UploadsResponseType:
+    try:
+        url = f"{Config.lighthouse_api}/api/user/files_uploaded?publicKey={publicKey}&pageNo={pageNo}"
+        response = requests.get(url)
+        response.raise_for_status()
+        return response.json()
+    except requests.HTTPError as error:
+        raise Exception(error.response.text)

src/lighthouseweb3/functions/get_uploads.py

@@ -1,12 +1,12 @@
 #!/usr/bin/env python3
 
+from typing import List, Dict, Tuple, NewType, TypedDict
 from dataclasses import dataclass
-from typing import Dict, NewType, List, Tuple, TypedDict
 
 
 @dataclass
-class Deploy(TypedDict):
-    """typings for deploy function"""
+class Upload(TypedDict):
+    """typings for upload function"""
 
     data: dict | str
 
@@ -17,3 +17,39 @@ class FileDict(TypedDict):
     files: List[str]
     is_dir: bool
     path: str
+
+
+class DealData(TypedDict):
+    """typings for deal Status"""
+    chainDealID: str
+    endEpoch: str
+    publishCID: str
+    storageProvider: str
+    dealStatus: str
+    bundleId: str
+    dealUUID: str
+    startEpoch: str
+    providerCollateral: str
+    lastUpdate: int
+    dealId: int
+    miner: str
+    content: int
+
+
+class FileObject(TypedDict):
+    publicKey: str
+    fileName: str
+    mimeType: str
+    txHash: str
+    status: str
+    createdAt: int
+    fileSizeInBytes: str
+    cid: str
+    id: str
+    lastUpdate: int
+    encryption: bool
+
+
+class UploadsResponseType(TypedDict):
+    fileList: List[FileObject]
+    totalFiles: int

src/lighthouseweb3/functions/types.py

@@ -0,0 +1,71 @@
+#!/usr/bin/env python3
+
+from io import BufferedReader
+from typing import Dict, List, Tuple
+from .axios import Axios
+from .utils import is_dir, walk_dir_tree, extract_file_name, NamedBufferedReader
+from .config import Config
+from . import types as t
+
+
+def upload(source: str | BufferedReader | NamedBufferedReader, token: str) -> t.Upload:
+    """
+    Deploy a file or directory to the lighthouse network
+    @params {source}: str, path to file or directory
+    @params {token}: str, lighthouse api token
+    """
+    # create headers
+    headers = {
+        "Authorization": f"Bearer {token}",
+        # "Content-Type": "multipart/form-data",
+        "Encryption": "false",
+        "Mime-Type": "application/octet-stream",
+    }
+    try:
+        # create http object
+        axios = Axios(Config.lighthouse_node + "/api/v0/add")
+        # create list of files to upload
+
+        if (isinstance(source, str)):
+            file_dict: t.FileDict = {}
+
+            # check if source is a directory
+            if is_dir(source):
+                # walk directory tree and add files to list
+                file_dict["files"], root = walk_dir_tree(source)
+                file_dict["is_dir"] = True
+                file_dict["path"] = root
+            else:
+                # add file to list
+                file_dict["files"] = [source]
+                file_dict["is_dir"] = False
+                file_dict["path"] = source
+            return {"data": axios.post_files(file_dict, headers)}
+        else:
+            return {"data": axios.post_blob(source, source.name, headers)}
+    except Exception as e:
+        print(e)
+        raise e
+
+
+def uploadBlob(source:  BufferedReader, filename: str, token: str) -> t.Upload:
+    """
+    Upload a Buffer or readable Object
+    @params {source}: str, path to file or directory
+    @params {token}: str, lighthouse api token
+    """
+    # create headers
+    headers = {
+        "Authorization": f"Bearer {token}",
+        # "Content-Type": "multipart/form-data",
+        "Encryption": "false",
+        "Mime-Type": "application/octet-stream",
+    }
+    try:
+        # create http object
+        axios = Axios(Config.lighthouse_node + "/api/v0/add")
+        # create list of files to upload
+        return {"data": axios.post_blob(source, filename, headers)}
+    except Exception as e:
+        print(e)
+        raise e