skyflow-flowvault-python 1.0.0__py3-none-any.whl

common/utils/constants.py

@@ -0,0 +1,291 @@
+OPTIONAL_TOKEN='token'
+PROTOCOL='https'
+SKY_META_DATA_HEADER='sky-metadata'
+CTX_KEY_REGEX=r'^[a-zA-Z0-9_]+$'
+
+class SKYFLOW:
+    SKYFLOW_ID = 'skyflowId'
+    X_SKYFLOW_AUTHORIZATION = 'x-skyflow-authorization'
+
+
+class HttpHeader:
+    CONTENT_TYPE = 'Content-Type'
+    CONTENT_TYPE_LOWERCASE = 'content-type'
+    X_REQUEST_ID = 'x-request-id'
+    ERROR_FROM_CLIENT = 'error-from-client'
+    AUTHORIZATION = 'Authorization'
+    X_SKYFLOW_AUTHORIZATION_HEADER = 'X-Skyflow-Authorization'
+
+
+class HttpStatusCode:
+    OK = 200
+    BAD_REQUEST = 400
+    UNAUTHORIZED = 401
+    INTERNAL_SERVER_ERROR = 500
+
+
+class ContentType:
+    APPLICATION_JSON = 'application/json'
+    APPLICATION_X_WWW_FORM_URLENCODED = 'application/x-www-form-urlencoded'
+    TEXT_PLAIN = 'text/plain'
+
+
+class DetectStatus:
+    IN_PROGRESS = 'IN_PROGRESS'
+    SUCCESS = 'SUCCESS'
+    FAILED = 'FAILED'
+    UNKNOWN = 'UNKNOWN'
+
+class Detect:
+    WAIT_TIME = 64
+
+class FileExtension:
+    JSON = 'json'
+    MP3 = 'mp3'
+    WAV = 'wav'
+    PDF = 'pdf'
+    TXT = 'txt'
+    DOC = 'doc'
+    DOCX = 'docx'
+    JPG = 'jpg'
+    JPEG = 'jpeg'
+    PNG = 'png'
+    BMP = 'bmp'
+    TIF = 'tif'
+    TIFF = 'tiff'
+    PPT = 'ppt'
+    PPTX = 'pptx'
+    CSV = 'csv'
+    XLS = 'xls'
+    XLSX = 'xlsx'
+    XML = 'xml'
+
+
+class FileProcessing:
+    PROCESSED_PREFIX = 'processed-'
+    DEIDENTIFIED_PREFIX = 'deidentified.'
+    ENTITIES = 'entities'
+
+
+class EncodingType:
+    UTF8 = 'utf8'
+    UTF_8 = 'utf-8'
+    BASE64 = 'base64'
+    BINARY = 'binary'
+
+
+class JWT:
+    ALGORITHM_RS256 = 'RS256'
+    GRANT_TYPE_JWT_BEARER = 'urn:ietf:params:oauth:grant-type:jwt-bearer'
+    ISSUER_SDK = 'sdk'
+    SIGNED_TOKEN_PREFIX = 'signed_token_'
+    ROLE_PREFIX = 'role:'
+
+
+class ApiKey:
+    SKY_PREFIX = 'sky-'
+    LENGTH = 42
+
+
+class UrlProtocol:
+    HTTPS = 'https'
+    HTTP = 'http'
+
+
+class BooleanString:
+    TRUE = 'true'
+    FALSE = 'false'
+
+
+class ResponseField:
+    STATUS = 'Status'
+    BODY = 'Body'
+    RECORDS = 'records'
+    TOKENS = 'tokens'
+    ERROR = 'error'
+    SKYFLOW_ID = 'skyflow_id'
+    REQUEST_INDEX = 'request_index'
+    REQUEST_ID = 'request_id'
+    HTTP_CODE = 'http_code'
+    HTTP_STATUS = 'http_status'
+    GRPC_CODE = 'grpc_code'
+    DETAILS = 'details'
+    MESSAGE = 'message'
+    ERROR_FROM_CLIENT = 'error_from_client'
+    TOKEN = 'token'
+    VALUE = 'value'
+    TYPE = 'type'
+    TOKENIZED_DATA = 'tokenized_data'
+    SIGNED_TOKEN = 'signed_token'
+    RESPONSES = 'responses'
+
+
+class CredentialField:
+    PRIVATE_KEY = 'privateKey'
+    CLIENT_ID = 'clientID'
+    KEY_ID = 'keyID'
+    TOKEN_URI = 'tokenURI'
+    TOKEN_URI_OPTION = 'token_uri'
+    CLIENT_NAME = 'clientName'
+    CREDENTIALS_STRING = 'credentials_string'
+    API_KEY = 'api_key'
+    TOKEN = 'token'
+    PATH = 'path'
+    CONTEXT = 'context'
+    ROLES = 'roles'
+
+
+class JwtField:
+    ISS = 'iss'
+    KEY = 'key'
+    AUD = 'aud'
+    SUB = 'sub'
+    EXP = 'exp'
+    CTX = 'ctx'
+    TOK = 'tok'
+    IAT = 'iat'
+
+
+class OptionField:
+    ROLE_IDS = 'role_ids'
+    DATA_TOKENS = 'data_tokens'
+    TIME_TO_LIVE = 'time_to_live'
+    ROLES = 'roles'
+    CTX = 'ctx'
+    VAULT_ID = 'vault_id'
+    CONNECTION_ID = 'connection_id'
+    CONNECTION_URL = 'connection_url'
+    VAULT_CLIENT = 'vault_client'
+    VAULT_CONTROLLER = 'vault_controller'
+    DETECT_CONTROLLER = 'detect_controller'
+    CONTROLLER = 'controller'
+    VERIFY_SIGNATURE = 'verify_signature'
+    VERIFY_AUD = 'verify_aud'
+
+
+class ConfigField:
+    CREDENTIALS = 'credentials'
+    CLUSTER_ID = 'cluster_id'
+    ENV = 'env'
+    VAULT_ID = 'vault_id'
+
+
+class RequestParameter:
+    VALUE = 'value'
+    COLUMN_GROUP = 'column_group'
+    REDACTION = 'redaction'
+    REDACTION_TYPE = 'redaction_type'
+
+
+class FileUploadField:
+    TABLE = 'table'
+    SKYFLOW_ID = 'skyflow_id'
+    COLUMN_NAME = 'column_name'
+    FILE_PATH = 'file_path'
+    BASE64 = 'base64'
+    FILE_OBJECT = 'file_object'
+    FILE_NAME = 'file_name'
+    FILE = 'file'
+    NAME = 'name'
+
+
+class DeidentifyFileRequestField:
+    ENTITIES = 'entities'
+    ALLOW_REGEX_LIST = 'allow_regex_list'
+    RESTRICT_REGEX_LIST = 'restrict_regex_list'
+    OUTPUT_PROCESSED_IMAGE = 'output_processed_image'
+    OUTPUT_OCR_TEXT = 'output_ocr_text'
+    MASKING_METHOD = 'masking_method'
+    PIXEL_DENSITY = 'pixel_density'
+    DENSITY = 'density'
+    MAX_RESOLUTION = 'max_resolution'
+    OUTPUT_PROCESSED_AUDIO = 'output_processed_audio'
+    OUTPUT_TRANSCRIPTION = 'output_transcription'
+    BLEEP = 'bleep'
+    OUTPUT_DIRECTORY = 'output_directory'
+    WAIT_TIME = 'wait_time'
+
+
+class DeidentifyField:
+    TEXT = 'text'
+    ENTITY_TYPES = 'entity_types'
+    TOKEN_TYPE = 'token_type'
+    ALLOW_REGEX = 'allow_regex'
+    RESTRICT_REGEX = 'restrict_regex'
+    TRANSFORMATIONS = 'transformations'
+    FORMAT = 'format'
+    OUTPUT = 'output'
+    STATUS = 'status'
+    RUN_ID = 'run_id'
+    WORD_CHARACTER_COUNT = 'word_character_count'
+    WORD_COUNT = 'word_count'
+    CHARACTER_COUNT = 'character_count'
+    SIZE = 'size'
+    DURATION = 'duration'
+    PAGES = 'pages'
+    SLIDES = 'slides'
+    PROCESSED_FILE = 'processed_file'
+    PROCESSED_FILE_TYPE = 'processed_file_type'
+    PROCESSED_FILE_EXTENSION = 'processed_file_extension'
+    REDACTED_FILE = 'redacted_file'
+    SHIFT_DATES = 'shift_dates'
+    DEFAULT = 'default'
+    ENTITY_UNQ_COUNTER = 'entity_unq_counter'
+    ENTITY_UNIQUE_COUNTER = 'entity_unique_counter'
+    ENTITY_ONLY = 'entity_only'
+    VAULT_TOKEN = 'vault_token'
+    ENTITIES = 'entities'
+    MAX_DAYS = 'max_days'
+    MIN_DAYS = 'min_days'
+    MAX = 'max'
+    MIN = 'min'
+    FILE = 'file'
+    TYPE = 'type'
+    EXTENSION = 'extension'
+    IN_PROGRESS = 'IN_PROGRESS'
+    REQUEST_OPTIONS = 'request_options'
+    BLEEP_GAIN = 'bleep_gain'
+    BLEEP_FREQUENCY = 'bleep_frequency'
+    BLEEP_START_PADDING = 'bleep_start_padding'
+    BLEEP_STOP_PADDING = 'bleep_stop_padding'
+    DENSITY = 'density'
+    TOKEN_FORMAT = 'token_format'
+    PROCESSED_FILE_RESPONSE_KEY = 'processedFile'
+    PROCESSED_FILE_TYPE_RESPONSE_KEY = 'processedFileType'
+    PROCESSED_FILE_EXTENSION_RESPONSE_KEY = 'processedFileExtension'
+
+
+class RequestOperation:
+    INSERT = 'INSERT'
+    DELETE = 'DELETE'
+    GET = 'GET'
+    UPDATE = 'UPDATE'
+    QUERY = 'QUERY'
+    TOKENIZE = 'TOKENIZE'
+    DETOKENIZE = 'DETOKENIZE'
+    FILE_UPLOAD = 'FILE_UPLOAD'
+
+
+class ConfigType:
+    VAULT = 'vault'
+    CONNECTION = 'connection'
+
+
+class SqlCommand:
+    SELECT = 'SELECT'
+
+
+class SdkPrefix:
+    SKYFLOW_PYTHON = 'skyflow-python@'
+    PYTHON_RUNTIME = 'Python '
+
+
+class SdkMetricsKey:
+    SDK_NAME_VERSION = 'sdk_name_version'
+    SDK_CLIENT_DEVICE_MODEL = 'sdk_client_device_model'
+    SDK_CLIENT_OS_DETAILS = 'sdk_client_os_details'
+    SDK_RUNTIME_DETAILS = 'sdk_runtime_details'
+
+
+class ErrorDefaults:
+    UNKNOWN_REQUEST_ID = 'unknown-request-id'

common/utils/enums/__init__.py

@@ -0,0 +1,12 @@
+from .env import Env, EnvUrls
+from .log_level import LogLevel
+from .content_types import ContentType
+from .detect_entities import DetectEntities
+from .token_mode import TokenMode
+from .token_type import TokenType
+from .request_method import RequestMethod
+from .redaction_type import RedactionType
+from .detect_entities import DetectEntities
+from .detect_output_transcriptions import DetectOutputTranscriptions
+from .masking_method import MaskingMethod
+from .token_type import TokenType

common/utils/enums/content_types.py

@@ -0,0 +1,9 @@
+from enum import Enum
+
+class ContentType(Enum):
+    JSON = 'application/json'
+    PLAINTEXT = 'text/plain'
+    XML = 'text/xml'
+    URLENCODED = 'application/x-www-form-urlencoded'
+    FORMDATA = 'multipart/form-data'
+    HTML = 'text/html'

common/utils/enums/detect_entities.py

@@ -0,0 +1,73 @@
+from enum import Enum
+
+class DetectEntities(Enum):
+    ACCOUNT_NUMBER = "account_number"
+    AGE = "age"
+    ALL = "all"
+    BANK_ACCOUNT = "bank_account"
+    BLOOD_TYPE = "blood_type"
+    CONDITION = "condition"
+    CORPORATE_ACTION = "corporate_action"
+    CREDIT_CARD = "credit_card"
+    CREDIT_CARD_EXPIRATION = "credit_card_expiration"
+    CVV = "cvv"
+    DATE = "date"
+    DAY = "day"
+    DATE_INTERVAL = "date_interval"
+    DOB = "dob"
+    DOSE = "dose"
+    DRIVER_LICENSE = "driver_license"
+    DRUG = "drug"
+    DURATION = "duration"
+    EFFECT = "effect"
+    EMAIL_ADDRESS = "email_address"
+    EVENT = "event"
+    FILENAME = "filename"
+    FINANCIAL_METRIC = "financial_metric"
+    GENDER = "gender"
+    HEALTHCARE_NUMBER = "healthcare_number"
+    INJURY = "injury"
+    IP_ADDRESS = "ip_address"
+    LANGUAGE = "language"
+    LOCATION = "location"
+    LOCATION_ADDRESS = "location_address"
+    LOCATION_ADDRESS_STREET = "location_address_street"
+    LOCATION_CITY = "location_city"
+    LOCATION_COORDINATE = "location_coordinate"
+    LOCATION_COUNTRY = "location_country"
+    LOCATION_STATE = "location_state"
+    LOCATION_ZIP = "location_zip"
+    MARITAL_STATUS = "marital_status"
+    MEDICAL_CODE = "medical_code"
+    MEDICAL_PROCESS = "medical_process"
+    MONEY = "money"
+    MONTH = "month"
+    NAME = "name"
+    NAME_FAMILY = "name_family"
+    NAME_GIVEN = "name_given"
+    NAME_MEDICAL_PROFESSIONAL = "name_medical_professional"
+    NUMERICAL_PII = "numerical_pii"
+    OCCUPATION = "occupation"
+    ORGANIZATION = "organization"
+    ORGANIZATION_ID = "organization_id"
+    ORGANIZATION_MEDICAL_FACILITY = "organization_medical_facility"
+    ORIGIN = "origin"
+    PASSPORT_NUMBER = "passport_number"
+    PASSWORD = "password"
+    PHONE_NUMBER = "phone_number"
+    PROJECT = "project"
+    PHYSICAL_ATTRIBUTE = "physical_attribute"
+    POLITICAL_AFFILIATION = "political_affiliation"
+    PRODUCT = "product"
+    RELIGION = "religion"
+    ROUTING_NUMBER = "routing_number"
+    SEXUALITY = "sexuality"
+    SSN = "ssn"
+    STATISTICS = "statistics"
+    TIME = "time"
+    TREND = "trend"
+    URL = "url"
+    USERNAME = "username"
+    VEHICLE_ID = "vehicle_id"
+    YEAR = "year"
+    ZODIAC_SIGN = "zodiac_sign"

common/utils/enums/detect_output_transcriptions.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+class DetectOutputTranscriptions(Enum):
+    DIARIZED_TRANSCRIPTION = "diarized_transcription"
+    MEDICAL_DIARIZED_TRANSCRIPTION = "medical_diarized_transcription"
+    MEDICAL_TRANSCRIPTION = "medical_transcription"
+    TRANSCRIPTION = "transcription"
+    PLAINTEXT_TRANSCRIPTION = "plaintext_transcription"

common/utils/enums/env.py

@@ -0,0 +1,13 @@
+from enum import Enum
+
+class Env(Enum):
+    DEV = 'DEV'
+    SANDBOX = 'SANDBOX'
+    PROD = 'PROD'
+    STAGE = 'STAGE'
+
+class EnvUrls(Enum):
+    PROD = "vault.skyflowapis.com"
+    SANDBOX = "vault.skyflowapis-preview.com"
+    DEV = "vault.skyflowapis.dev"
+    STAGE = "vault.skyflowapis.tech"

common/utils/enums/log_level.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+class LogLevel(Enum):
+    DEBUG = 1
+    INFO = 2
+    WARN = 3
+    ERROR = 4
+    OFF = 5

common/utils/enums/masking_method.py

@@ -0,0 +1,5 @@
+from enum import Enum
+
+class MaskingMethod(Enum):
+    BLACKBOX= "blackbox"
+    BLUR= "blur"

common/utils/enums/redaction_type.py

@@ -0,0 +1,7 @@
+from enum import Enum
+
+class RedactionType(Enum):
+    PLAIN_TEXT = 'PLAIN_TEXT'
+    MASKED = 'MASKED'
+    DEFAULT = 'DEFAULT'
+    REDACTED = 'REDACTED'

common/utils/enums/request_method.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+class RequestMethod(Enum):
+    GET = "GET"
+    POST = "POST"
+    PUT = "PUT"
+    DELETE = "DELETE"
+    NONE = "NONE"

common/utils/enums/token_mode.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+class TokenMode(Enum):
+    DISABLE = "DISABLE"
+    ENABLE = "ENABLE"
+    ENABLE_STRICT = "ENABLE_STRICT"

common/utils/enums/token_type.py

@@ -0,0 +1,6 @@
+from enum import Enum
+
+class TokenType(Enum):
+    VAULT_TOKEN = "vault_token"
+    ENTITY_UNIQUE_COUNTER = "entity_unq_counter"
+    ENTITY_ONLY = "entity_only"

common/utils/logger/__init__.py

@@ -0,0 +1,2 @@
+from ._logger import Logger
+from ._log_helpers import log_error, log_info, log_warn, log_error_log, set_active_log_level

common/utils/logger/_log_helpers.py

@@ -0,0 +1,47 @@
+from ..enums import LogLevel
+from . import Logger
+from ..constants import ResponseField
+
+_active_log_level = LogLevel.ERROR
+
+
+def set_active_log_level(level):
+    global _active_log_level
+    _active_log_level = level
+
+
+def log_info(message, logger = None):
+    if not logger:
+        logger = Logger(LogLevel.INFO)
+
+    logger.info(message)
+
+def log_warn(message, logger=None):
+    if not logger:
+        logger = Logger(_active_log_level)
+    logger.warn(message)
+
+def log_error_log(message, logger=None):
+    if not logger:
+        logger = Logger(LogLevel.ERROR)
+    logger.error(message)
+
+def log_error(message, http_code, request_id=None, grpc_code=None, http_status=None, details=None, logger=None):
+    if not logger:
+        logger = Logger(LogLevel.ERROR)
+
+    log_data = {
+        ResponseField.HTTP_CODE: http_code,
+        ResponseField.MESSAGE: message
+    }
+
+    if grpc_code is not None:
+        log_data[ResponseField.GRPC_CODE] = grpc_code
+    if http_status is not None:
+        log_data[ResponseField.HTTP_STATUS] = http_status
+    if request_id is not None:
+        log_data[ResponseField.REQUEST_ID] = request_id
+    if details is not None:
+        log_data[ResponseField.DETAILS] = details
+
+    logger.error(log_data)

common/utils/logger/_logger.py

@@ -0,0 +1,50 @@
+import logging
+from ..enums.log_level import LogLevel
+
+
+class Logger:
+    def __init__(self, level=LogLevel.ERROR):
+        self.current_level = level
+        self.logger = logging.getLogger('skyflow-python')
+        self.logger.propagate = False  # Prevent logs from being handled by parent loggers
+
+        # Remove any existing handlers to avoid duplicates or inherited handlers
+        if self.logger.hasHandlers():
+            self.logger.handlers.clear()
+
+        self.set_log_level(level)
+
+        handler = logging.StreamHandler()
+
+        # Create a formatter that only includes the message without any prefixes
+        formatter = logging.Formatter('%(message)s')
+        handler.setFormatter(formatter)
+
+        self.logger.addHandler(handler)
+
+    def set_log_level(self, level):
+        self.current_level = level
+        log_level_mapping = {
+            LogLevel.DEBUG: logging.DEBUG,
+            LogLevel.INFO: logging.INFO,
+            LogLevel.WARN: logging.WARNING,
+            LogLevel.ERROR: logging.ERROR,
+            LogLevel.OFF: logging.CRITICAL + 1
+        }
+        self.logger.setLevel(log_level_mapping[level])
+
+    def debug(self, message):
+        if self.current_level.value <= LogLevel.DEBUG.value:
+            self.logger.debug(message)
+
+    def info(self, message):
+        if self.current_level.value <= LogLevel.INFO.value:
+            self.logger.info(message)
+
+    def warn(self, message):
+        if self.current_level.value <= LogLevel.WARN.value:
+            self.logger.warning(message)
+
+    def error(self, message):
+        if self.current_level.value <= LogLevel.ERROR.value:
+            self.logger.error(message)

common/utils/validations/__init__.py

@@ -0,0 +1,11 @@
+from ._validations import (
+    validate_required_field,
+    validate_api_key,
+    validate_credentials,
+    validate_token_options,
+    validate_log_level,
+    validate_keys,
+    validate_non_empty_string_list,
+    validate_vault_config,
+    validate_update_vault_config,
+)