ratio1 3.4.45__py3-none-any.whl → 3.4.47__py3-none-any.whl

ratio1/_ver.py

@@ -1,4 +1,4 @@
-__VER__ = "3.4.45"
+__VER__ = "3.4.47"
 
 if __name__ == "__main__":
   with open("pyproject.toml", "rt") as fd:

ratio1/base/webapp_pipeline.py

@@ -23,7 +23,7 @@ class WebappPipeline(Pipeline):
   ) -> None:
     """
     This is a special type of pipeline that is used to deploy webapps.
-    It will override the deploy method to return the ngrok URL as well as the on_data method to extract the ngrok URL.
+    It will override the deploy method to return the app URL as well as the on_data method to extract the app URL.
     """
     self.app_url = None
     self.__extra_debug = extra_debug
@@ -47,7 +47,7 @@ class WebappPipeline(Pipeline):
   
   def __check_payloads(self, session, plugin_signature, plugin_instance, data):
     """
-    Check if the payload if from ngrok and extract the ngrok URL.
+    Check if the payload is from webapp and extract the app URL.
     
     Parameters
     ----------
@@ -127,13 +127,13 @@ class WebappPipeline(Pipeline):
         The URL of the webapp.
     """
     res = super().deploy(verbose=verbose, timeout=timeout, **kwargs)
-    # now we wait for the ngrok url to be available
+    # now we wait for the app url to be available
     start = time.time()
     while self.app_url is None:
       elapsed = time.time() - start
       if elapsed > timeout:
-        msg = "Timeout waiting for ngrok url"
+        msg = "Timeout waiting for app url"
         self.P(msg, color="red")
         raise Exception(msg)
-    # return the ngrok url
+    # return the app url
     return self.app_url

ratio1/ipfs/r1fs.py

@@ -300,6 +300,7 @@ class R1FSEngine:
       return
 
     def _hash_secret(self, secret: str) -> bytes:
+      secret = str(secret) # to be sure that the passed secret is of string type.
       # Convert text to bytes, then hash with SHA-256 => 32-byte key
       return hashlib.sha256(secret.encode("utf-8")).digest()
 
@@ -510,6 +511,25 @@ class R1FSEngine:
       )
       return result
 
+    # PUBLIC COMMAND
+    def get_ipfs_id_data(self) -> dict:
+      """
+      Get the IPFS peer ID via 'ipfs id' (JSON output).
+      Returns the ipfs ID object.
+      """
+      data = {}
+      output = self.__run_command(["ipfs", "id"])  # this will raise an exception if the command fails
+      try:
+        data = json.loads(output)
+      except json.JSONDecodeError:
+        raise Exception("Failed to parse JSON from 'ipfs id' output.")
+      except Exception as e:
+        msg = f"Error getting IPFS ID: {e}. `ipfs id`:\n{data}"
+        self.P(msg, color='r')
+        raise Exception(f"Error getting IPFS ID: {e}") from e
+      return data
+
+    # END PUBLIC COMMANS
 
     def __run_command(
       self, 
@@ -575,24 +595,15 @@ class R1FSEngine:
       Get the IPFS peer ID via 'ipfs id' (JSON output).
       Returns the 'ID' field as a string.
       """
-      self.__ipfs_address = None
-      output = self.__run_command(["ipfs", "id"]) # this will raise an exception if the command fails
-      try:
-        data = json.loads(output)
-        self.__ipfs_id_result = data
-        self.__ipfs_id = data.get("ID", ERROR_TAG)
-        self.__ipfs_agent = data.get("AgentVersion", ERROR_TAG)
-        addrs = data.get("Addresses", [])
-        if not addrs:
-          self.__ipfs_address = None
-        else:
-          self.__ipfs_address = addrs[1] if len(addrs) > 1 else addrs[0] if len(addrs) else ERROR_TAG
-      except json.JSONDecodeError:
-        raise Exception("Failed to parse JSON from 'ipfs id' output.")
-      except Exception as e:
-        msg = f"Error getting IPFS ID: {e}. `ipfs id`:\n{data}"
-        self.P(msg, color='r')
-        raise Exception(f"Error getting IPFS ID: {e}") from e
+      data = self.get_ipfs_id_data()
+      self.__ipfs_id_result = data
+      self.__ipfs_id = data.get("ID", ERROR_TAG)
+      self.__ipfs_agent = data.get("AgentVersion", ERROR_TAG)
+      addrs = data.get("Addresses", [])
+      if not addrs:
+        self.__ipfs_address = None
+      else:
+        self.__ipfs_address = addrs[1] if len(addrs) > 1 else addrs[0] if len(addrs) else ERROR_TAG
       return self.__ipfs_id
     
 
@@ -657,7 +668,7 @@ class R1FSEngine:
       tempfile=False, 
       show_logs=True,
       raise_on_error=False,
-    ) -> bool:
+    ) -> str:
       """
       Add a YAML object to IPFS.
       """
@@ -884,7 +895,8 @@ class R1FSEngine:
       timeout: int = None,
       pin: bool = True,
       raise_on_error: bool = False,
-      show_logs: bool = True
+      show_logs: bool = True,
+      return_absolute_path: bool = True,
     ) -> str:
       """
       Retrieve an encrypted file from R1FS by CID, decrypt with AES-GCM in streaming mode.
@@ -916,6 +928,9 @@ class R1FSEngine:
       show_logs : bool, optional
         If True, logs steps via self.P / self.Pd. Default True.
 
+      return_absolute_path : bool, optional
+        If True, return the absolute path to the restored plaintext file.
+
       Returns
       -------
       str
@@ -1041,6 +1056,8 @@ class R1FSEngine:
           fin.seek(data_start, os.SEEK_SET)
 
           out_path = os.path.join(local_folder, original_filename)
+          if return_absolute_path:
+            out_path = os.path.abspath(out_path)
           chunk_size = 1024 * 1024
 
           with open(out_path, "wb") as fout:

{ratio1-3.4.45.dist-info → ratio1-3.4.47.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ratio1
-Version: 3.4.45
+Version: 3.4.47
 Summary: `ratio1` or Ration1 SDK is the Python SDK required for client app development for the Ratio1 ecosystem
 Project-URL: Homepage, https://github.com/Ratio1/ratio1_sdk
 Project-URL: Bug Tracker, https://github.com/Ratio1/ratio1_sdk/issues

{ratio1-3.4.45.dist-info → ratio1-3.4.47.dist-info}/RECORD

@@ -1,5 +1,5 @@
 ratio1/__init__.py,sha256=YimqgDbjLuywsf8zCWE0EaUXH4MBUrqLxt0TDV558hQ,632
-ratio1/_ver.py,sha256=DyYAVKy3hLVQtMWbQSTyJLGNsx7pQ8Majk60ovEC-iU,331
+ratio1/_ver.py,sha256=HoUSVwQY9A6o3Hp0Q1yUiWkM4nWr5iqZdpQu0pv2f-o,331
 ratio1/base_decentra_object.py,sha256=iXvAAf6wPnGWzeeiRfwLojVoan-m1e_VsyPzjUQuENo,4492
 ratio1/plugins_manager_mixin.py,sha256=X1JdGLDz0gN1rPnTN_5mJXR8JmqoBFQISJXmPR9yvCo,11106
 ratio1/base/__init__.py,sha256=hACh83_cIv7-PwYMM3bQm2IBmNqiHw-3PAfDfAEKz9A,259
@@ -10,7 +10,7 @@ ratio1/base/pipeline.py,sha256=szoHrk1qBdY6NKPUk3tUTsJx3XzYp5C2GTOlzRiQi48,62489
 ratio1/base/plugin_template.py,sha256=Gs438cSkhvxPujE4CRH_32pcuZaVwI9kia8E4VDRpSU,138794
 ratio1/base/responses.py,sha256=ZKBZmRhYDv8M8mQ5C_ahGsQvtWH4b9ImRcuerQdZmNw,6937
 ratio1/base/transaction.py,sha256=l2JCzTgH3-irFwCEBGrS3z8VOisA8GdC3zEfqgJOTG4,5138
-ratio1/base/webapp_pipeline.py,sha256=cH31-kuAIryUedObeW7qgxfU0ebK6qJKRxuHbbUHYVA,3706
+ratio1/base/webapp_pipeline.py,sha256=H83EjkmyljetdHZ18V5R8OU3wXoWi_EpV0AAhQ4AM64,3695
 ratio1/base/payload/__init__.py,sha256=y8fBI8tG2ObNfaXFWjyWZXwu878FRYj_I8GIbHT4GKE,29
 ratio1/base/payload/payload.py,sha256=MoCeL6iZzl1an-4eqRpLW0iz6Yk3OvlBrymcmhWeecM,2689
 ratio1/bc/__init__.py,sha256=BI5pcqHdhwnMdbWTYDLW1cVP_844VtLra-lz7xprgsk,171
@@ -68,7 +68,7 @@ ratio1/io_formatter/default/aixp1.py,sha256=MX0TeUR4APA-qN3vUC6uzcz8Pssz5lgrQWo7
 ratio1/io_formatter/default/default.py,sha256=gEy78cP2D5s0y8vQh4aHuxqz7D10gGfuiKF311QhrpE,494
 ratio1/ipfs/__init__.py,sha256=vXEDLUNUO6lOTMGa8iQ9Zf7ajIQq9GZuvYraAHt3meE,38
 ratio1/ipfs/ifps_keygen,sha256=PcoYuo4c89_C9FWrKq9K_28ruhKqnxNn1s3nLHiF1tc,879
-ratio1/ipfs/r1fs.py,sha256=7Cs7IW1ksG7PnLoiEbf1R1zS6WiUCr7ajFqpmCCzabA,48781
+ratio1/ipfs/r1fs.py,sha256=vpX2b_FdgWgC_ArY8JgW-D_9TbhIPIsNN2YFLB39mJs,49327
 ratio1/ipfs/ipfs_setup/ipfs.service,sha256=isTJQsktPy4i1yaDA9AC1OKdlTYvsCCRRAVX-EmGqAs,248
 ratio1/ipfs/ipfs_setup/launch_service.sh,sha256=GWhZyNqtohLxJg8Q_c8YnNZduu1ddXDU-IFRRMaEyiY,141
 ratio1/ipfs/ipfs_setup/restart.sh,sha256=9xHMgkUoAMI25jeaoDVFbCa_LjojYm3ubljW58RatKE,22
@@ -103,8 +103,8 @@ ratio1/utils/comm_utils.py,sha256=4cS9llRr_pK_3rNgDcRMCQwYPO0kcNU7AdWy_LtMyCY,10
 ratio1/utils/config.py,sha256=IMXAN9bpHePKEuTFGRRqFJXz_vBa-wi7s9gLhFEheRY,9953
 ratio1/utils/dotenv.py,sha256=_AgSo35n7EnQv5yDyu7C7i0kHragLJoCGydHjvOkrYY,2008
 ratio1/utils/oracle_sync/oracle_tester.py,sha256=aJOPcZhtbw1XPqsFG4qYpfv2Taj5-qRXbwJzrPyeXDE,27465
-ratio1-3.4.45.dist-info/METADATA,sha256=LHCIYIkIvXNehd-sURLHvre207r1Gb2pbi6rhROFlQQ,12248
-ratio1-3.4.45.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ratio1-3.4.45.dist-info/entry_points.txt,sha256=DR_olREzU1egwmgek3s4GfQslBi-KR7lXsd4ap0TFxE,46
-ratio1-3.4.45.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
-ratio1-3.4.45.dist-info/RECORD,,
+ratio1-3.4.47.dist-info/METADATA,sha256=w88qtWACI2j8i-bAED7CopvILogVkE_aHJeMeWa5i6A,12248
+ratio1-3.4.47.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ratio1-3.4.47.dist-info/entry_points.txt,sha256=DR_olREzU1egwmgek3s4GfQslBi-KR7lXsd4ap0TFxE,46
+ratio1-3.4.47.dist-info/licenses/LICENSE,sha256=cvOsJVslde4oIaTCadabXnPqZmzcBO2f2zwXZRmJEbE,11311
+ratio1-3.4.47.dist-info/RECORD,,