sapiopycommons 2024.8.28a315__py3-none-any.whl → 2024.8.29a317__py3-none-any.whl

sapiopycommons/webhook/webservice_handlers.py

@@ -1,67 +0,0 @@
-import sys
-import traceback
-from abc import abstractmethod
-from typing import Any
-
-from flask import request
-from sapiopylib.rest.User import SapioUser
-from sapiopylib.rest.WebhookService import AbstractWebhookHandler
-from sapiopylib.rest.pojo.webhook.WebhookResult import SapioWebhookResult
-
-
-class AbstractWebserviceHandler(AbstractWebhookHandler):
-    """
-    A base class for constructing "webservice" endpoints on your webhook server. These are endpoints that can be
-    communicated with by external sources without needing to format the payload JSON in the webhook context format that
-    webhook handlers expect.
-
-    The entire payload JSON is sent to the run method of this class. It is up to the run method to determine how
-    this JSON should be parsed. In order to communicate with a Sapio system, a SapioUser object must be able to be
-    defined using the payload. Functions have been provided for constructing users with various authentication methods.
-
-    Since this extends AbstractWebhookHandler, you can still register endpoints from this class in the same way you
-    would normal webhook endpoints.
-    """
-    def post(self) -> dict[str, Any]:
-        """
-        Internal method to be executed to translate incoming requests.
-        """
-        # noinspection PyBroadException
-        try:
-            return self.run(request.json).to_json()
-        except Exception:
-            print('Error occurred while running webservice custom logic. See traceback.', file=sys.stderr)
-            traceback.print_exc()
-            return SapioWebhookResult(False, display_text="Error occurred during webservice execution.").to_json()
-
-    @abstractmethod
-    def run(self, payload: dict[str, Any]) -> SapioWebhookResult:
-        pass
-
-    def basic_auth(self, url: str, username: str, password: str) -> SapioUser:
-        """
-        :param url: The URL of the Sapio system that requests from this user will be sent to.
-            Must end in /webservice/api
-        :param username: The username to authenticate requests with.
-        :param password: The password to authenticate requests with.
-        :return: A SapioUser that will authenticate requests using basic auth.
-        """
-        return SapioUser(url, self.verify_sapio_cert, self.client_timeout_seconds, username=username, password=password)
-
-    def api_token_auth(self, url: str, api_token: str) -> SapioUser:
-        """
-        :param url: The URL of the Sapio system that requests from this user will be sent to.
-            Must end in /webservice/api
-        :param api_token: The API token to authenticate requests with.
-        :return: A SapioUser that will authenticate requests using an API token.
-        """
-        return SapioUser(url, self.verify_sapio_cert, self.client_timeout_seconds, api_token=api_token)
-
-    def bearer_token_auth(self, url: str, bearer_token: str) -> SapioUser:
-        """
-        :param url: The URL of the Sapio system that requests from this user will be sent to.
-            Must end in /webservice/api
-        :param bearer_token: The bearer token to authenticate requests with.
-        :return: A SapioUser that will authenticate requests using a bearer token.
-        """
-        return SapioUser(url, self.verify_sapio_cert, self.client_timeout_seconds, bearer_token=bearer_token)

sapiopycommons-2024.8.28a315.dist-info/RECORD

@@ -1,50 +0,0 @@
-sapiopycommons/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/callbacks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/callbacks/callback_util.py,sha256=UmjRehMkg44LZB-qgOefQogJEcho2xKtHlICegCHe4I,63454
-sapiopycommons/chem/IndigoMolecules.py,sha256=QqFDi9CKERj6sn_ZwVcS2xZq4imlkaTeCrpq1iNcEJA,1992
-sapiopycommons/chem/Molecules.py,sha256=t80IsQBPJ9mwE8ZxnWomAGrZDhdsOuPvLaTPb_N6jGU,8639
-sapiopycommons/chem/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/customreport/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/customreport/column_builder.py,sha256=sS_wZYOR72rs3syTNjwCVP4h8M8N0b0burkTxFQItVU,3019
-sapiopycommons/customreport/custom_report_builder.py,sha256=o2O89OrWPm0OYS8Ux6EKZTg6hcUzfz3ZxAgnzJg1wEw,6601
-sapiopycommons/customreport/term_builder.py,sha256=oVsr7iFPnug2TrZUCcAMhyps-b62kDodPcBxyQeneUY,16763
-sapiopycommons/datatype/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/datatype/attachment_util.py,sha256=_l2swuP8noIGAl4bwzBUEhr6YlN_OVZl3-gi1XqFHYA,3364
-sapiopycommons/eln/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/eln/experiment_handler.py,sha256=NoHBthxuXqxdmIj57KEYNqC_t2mArbOkIbcemJkw08U,66683
-sapiopycommons/eln/experiment_report_util.py,sha256=B55hXbTGndCEI19LiqhjvO46_chujZUK0qDTWHjzfcU,6398
-sapiopycommons/eln/plate_designer.py,sha256=FYJfhhNq8hdfuXgDYOYHy6g0m2zNwQXZWF_MTPzElDg,7184
-sapiopycommons/files/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/files/complex_data_loader.py,sha256=T39veNhvYl6j_uZjIIJ8Mk5Aa7otR5RB-g8XlAdkksA,1421
-sapiopycommons/files/file_bridge.py,sha256=WwCVegk0OGA8eqho8chsOsLlqg1nXctO75zfh-rHF-g,5950
-sapiopycommons/files/file_bridge_handler.py,sha256=bt2IfIsxJ4lcJYo_NHvCQ17ZV6C4fSAEa8Zcgixh7B4,14263
-sapiopycommons/files/file_data_handler.py,sha256=SCsjODMJIPEBSsahzXUeOM7CfSCmYwPPoGAM6aOfelo,36743
-sapiopycommons/files/file_util.py,sha256=ZrgoGwHHfPdL5KHkGwlrEHJqGpttmZzRkGQCXdLjra8,28284
-sapiopycommons/files/file_validator.py,sha256=4OvY98ueJWPJdpndwnKv2nqVvLP9S2W7Il_dM0Y0ojo,28709
-sapiopycommons/files/file_writer.py,sha256=96Xl8TTT46Krxe_J8rmmlEMtel4nzZB961f5Yqtl1-I,17616
-sapiopycommons/general/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/general/accession_service.py,sha256=HYgyOsH_UaoRnoury-c2yTW8SeG4OtjLemdpCzoV4R8,13484
-sapiopycommons/general/aliases.py,sha256=SEC7g218fWkYEcydneAtISgVpP_22YhlI88cM8calWY,10307
-sapiopycommons/general/audit_log.py,sha256=tJi4uU4qRY2WWcK4ItkjRvoCHCwwiU9LwCNv4lP5-QQ,8713
-sapiopycommons/general/custom_report_util.py,sha256=6Vr3itz5Bav9yBIlblnWMMSc0Mc-HPeVfnpymdLf6fU,15629
-sapiopycommons/general/exceptions.py,sha256=DOlLKnpCatxQF-lVCToa8ryJgusWLvip6N_1ALN00QE,1679
-sapiopycommons/general/popup_util.py,sha256=vqLSiCry4YClSKIdnk56CIKioBOtawGVmPi2iS1LOIc,31763
-sapiopycommons/general/sapio_links.py,sha256=o9Z-8y2rz6AI0Cy6tq58ElPge9RBnisGc9NyccbaJxs,2610
-sapiopycommons/general/storage_util.py,sha256=ovmK_jN7v09BoX07XxwShpBUC5WYQOM7dbKV_VeLXJU,8892
-sapiopycommons/general/time_util.py,sha256=sXThADCRAQDWYDD9C5CdhcKYIt3qOaVNyZfGBR7HW9A,8701
-sapiopycommons/multimodal/multimodal.py,sha256=A1QsC8QTPmgZyPr7KtMbPRedn2Ie4WIErodUvQ9otgU,6724
-sapiopycommons/multimodal/multimodal_data.py,sha256=p_caXW0vrURkzDHHspUptEI7lVFpZUrmyF7foz2fAvA,14983
-sapiopycommons/processtracking/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/processtracking/endpoints.py,sha256=w5bziI2xC7450M95rCF8JpRwkoni1kEDibyAux9B12Q,10848
-sapiopycommons/recordmodel/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/recordmodel/record_handler.py,sha256=Uxjrq6f_cWFbqi7KRLySdOvmQGtbIBrCNyStRewqzx8,64751
-sapiopycommons/rules/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/rules/eln_rule_handler.py,sha256=JYzDA_14D2nLnlqwbpIxVOrfKWzbOS27AYf4TQfGr4Q,10469
-sapiopycommons/rules/on_save_rule_handler.py,sha256=Rkqvph20RbNq6m-RF4fbvCP-YfD2CZYBM2iTr3nl0eY,10236
-sapiopycommons/webhook/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-sapiopycommons/webhook/webhook_handlers.py,sha256=jwc4xu-wwl8haS5k1dENZ1UIYK9GQk74TAo3CGxMW9U,16583
-sapiopycommons/webhook/webservice_handlers.py,sha256=1J56zFI0pWl5MHoNTznvcZumITXgAHJMluj8-2BqYEw,3315
-sapiopycommons-2024.8.28a315.dist-info/METADATA,sha256=FzieTZqla4lnLJIvcJMMZrVxxLAmlY8PwMTXxJ0sCkc,3176
-sapiopycommons-2024.8.28a315.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-sapiopycommons-2024.8.28a315.dist-info/licenses/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
-sapiopycommons-2024.8.28a315.dist-info/RECORD,,