vgs-api-client 0.0.1.dev202305161416__py3-none-any.whl → 0.0.1.dev202404232319__py3-none-any.whl

vgs/__init__.py

@@ -1,7 +1,7 @@
-__version__ = "0.0.1-dev202305161416"
+__version__ = "0.0.1.dev202404232319"
 
 # import Aliases
 from vgs.aliases_api import Aliases
-from vgs.functions_api import Functions
-from vgs.configuration import config, Configuration
+from vgs.configuration import VGSConfiguration, config
 from vgs.exceptions import *
+from vgs.functions_api import Functions

vgs/aliases_api.py

@@ -1,13 +1,13 @@
-import vgs.exceptions
+import logging
+
 import vgs_api_client
-from vgs.configuration import Configuration
 from vgs_api_client import Configuration
 from vgs_api_client.api import aliases_api
 from vgs_api_client.exceptions import (
     ApiException,
+    ForbiddenException,
     NotFoundException,
     UnauthorizedException,
-    ForbiddenException,
 )
 from vgs_api_client.model.alias_format import AliasFormat
 from vgs_api_client.model.create_aliases_request import CreateAliasesRequest
@@ -15,6 +15,9 @@ from vgs_api_client.model.create_aliases_request_new import CreateAliasesRequest
 from vgs_api_client.model.update_alias_request import UpdateAliasRequest
 from vgs_api_client.model.update_alias_request_data import UpdateAliasRequestData
 
+import vgs.exceptions
+from vgs.configuration import VGSConfiguration
+
 
 def _map_exception(message, e):
     error_message = message
@@ -36,7 +39,7 @@ class Aliases:
 
         self._api = aliases_api.AliasesApi(
             vgs_api_client.ApiClient(
-                Configuration(username=config.username, password=config.password, host=config.host)
+                VGSConfiguration(username=config.username, password=config.password, host=config.host)
             )
         )
 
@@ -58,30 +61,36 @@ class Aliases:
             api_response = self._api.create_aliases(create_aliases_request=create_aliases_request)
             return api_response["data"]
         except Exception as e:
-            raise _map_exception(f"Failed to redact data ${data}", e)
+            logging.exception(e)
+            ex = _map_exception(f"Failed to redact data ${data}", e)
+            raise ex
 
     def reveal(self, aliases):
         # TODO: validate data and raise meaningful exception on validation error
         try:
             query = ",".join(aliases) if isinstance(aliases, list) else aliases
-            api_response = self._api.reveal_multiple_aliases(q=query)
+            api_response = self._api.reveal_multiple_aliases(aliases=query)
             return api_response["data"]
         except Exception as e:
-            raise _map_exception(f"Failed to reveal aliases ${aliases}", e)
+            logging.exception(e)
+            ex = _map_exception(f"Failed to reveal aliases ${aliases}", e)
+            raise ex
 
     def delete(self, alias):
         try:
             self._api.delete_alias(alias=alias)
         except Exception as e:
-            raise _map_exception(f"Failed to reveal delete ${alias}", e)
+            logging.exception(e)
+            ex = _map_exception(f"Failed to reveal delete ${alias}", e)
+            raise ex
 
     def update(self, alias, data):
         try:
             self._api.update_alias(
                 alias=alias,
-                update_alias_request=UpdateAliasRequest(
-                    UpdateAliasRequestData(data["classifiers"])
-                ),
+                update_alias_request=UpdateAliasRequest(UpdateAliasRequestData(data["classifiers"])),
             )
         except Exception as e:
-            raise _map_exception(f"Failed to update alias ${alias}.", e)
+            logging.exception(e)
+            ex = _map_exception(f"Failed to update alias ${alias}.", e)
+            raise ex

vgs/base_api.py

@@ -33,9 +33,7 @@ class BaseApi(object):
                     self.refresh_token = response.body.get(self.REFRESH_TOKEN_KEY)
             else:
                 if not auth_api.validate_access_token(self.auth_token):
-                    response = auth_api.refresh_token(
-                        self.auth_api, refresh_token=self.refresh_token
-                    )
+                    response = auth_api.refresh_token(self.auth_api, refresh_token=self.refresh_token)
                     self.auth_token = response.body.get(self.REFRESH_TOKEN_KEY)
         except Exception as e:
             raise AuthenticationError(e)

vgs/configuration.py

@@ -1,4 +1,7 @@
-class Configuration:
+from vgs_api_client import Configuration
+
+
+class VGSConfiguration(Configuration):
     def __init__(
         self,
         vault_id=None,
@@ -8,15 +11,14 @@ class Configuration:
         environment="sandbox",
         service_account_name=None,
         service_account_password=None,
+        **kwargs,
     ):
+        super(VGSConfiguration, self).__init__(username=username, password=password, host=host, **kwargs)
         self.vault_id = vault_id
-        self.username = username
-        self.password = password
-        self.host = host
         self.environment = environment
         self.service_account_name = service_account_name
         self.service_account_password = service_account_password
 
 
 def config(*args, **kwargs):
-    return Configuration(*args, **kwargs)
+    return VGSConfiguration(*args, **kwargs)

vgs/control_plane/__init__.py

@@ -0,0 +1 @@
+from . import apis, clients

vgs/control_plane/apis/__init__.py

@@ -0,0 +1 @@
+from . import account_management, vault_management

vgs/control_plane/clients/__init__.py

@@ -0,0 +1 @@
+from . import organizations, vaults

vgs/control_plane/clients/organizations.py

@@ -0,0 +1,2 @@
+class Organization(object):
+    pass

vgs/control_plane/clients/vaults.py

@@ -0,0 +1,6 @@
+class Preference(object):
+    pass
+
+
+class Vault(object):
+    pass

vgs/functions_api.py

@@ -16,7 +16,7 @@ from vgs import certs
 from vgs.base_api import BaseApi
 from vgs.configuration import Configuration
 
-USER_AGENT = "vgs-sdk/0.0.1-dev202305161416/python"
+USER_AGENT = "vgs-sdk/0.0.1.dev202404232319/python"
 
 ECHO_SECURE_HOST_CONFIG = "echo\\.secure\\.verygood\\.systems"
 FUNCTION_CONDITION_EXPRESSION = (
@@ -178,9 +178,7 @@ class Functions(BaseApi):
 
     @staticmethod
     def _extract_larky(route_config):
-        script = route_config["attributes"]["entries"][0]["operations"][0][0]["parameters"][
-            "script"
-        ]
+        script = route_config["attributes"]["entries"][0]["operations"][0][0]["parameters"]["script"]
         return script
 
     @staticmethod
@@ -189,10 +187,7 @@ class Functions(BaseApi):
             try:
                 host_endpoint = route["attributes"]["host_endpoint"]
                 filter_config = str(route["attributes"]["entries"][0]["config"])
-                if (
-                    host_endpoint == ECHO_SECURE_HOST_CONFIG
-                    and FUNCTION_CONDITION_EXPRESSION in filter_config
-                ):
+                if host_endpoint == ECHO_SECURE_HOST_CONFIG and FUNCTION_CONDITION_EXPRESSION in filter_config:
                     function_name = route["attributes"]["tags"]["name"]
                     yield function_name
             except Exception as e:
@@ -206,9 +201,7 @@ class Functions(BaseApi):
 
     @staticmethod
     def _function_id(name):
-        return uuid.uuid5(
-            uuid.NAMESPACE_URL, f"https://echo.secure.verygood.systems/post?function_name={name}"
-        )
+        return uuid.uuid5(uuid.NAMESPACE_URL, f"https://echo.secure.verygood.systems/post?function_name={name}")
 
     @staticmethod
     def _get_proxy_host(environment):
@@ -261,9 +254,7 @@ class Functions(BaseApi):
         return routes_api.routes.delete(route_id)
 
     def _create_routes_api(self):
-        api = vgs.sdk.vaults_api.create_api(
-            None, self.config.vault_id, self.auth_environment, self.auth_token
-        )
+        api = vgs.sdk.vaults_api.create_api(None, self.config.vault_id, self.auth_environment, self.auth_token)
         api.headers["User-Agent"] = USER_AGENT
         return api
 
@@ -275,8 +266,7 @@ class Functions(BaseApi):
             )
         if not self.config.vault_id:
             raise vgs.exceptions.FunctionsApiException(
-                "Functions API configuration is not complete. "
-                "Please set 'vault_id' to use functions invocation API."
+                "Functions API configuration is not complete. " "Please set 'vault_id' to use functions invocation API."
             )
         username = self.config.username
         password = self.config.password
@@ -298,9 +288,7 @@ class Functions(BaseApi):
                 verify=ca_file.name,
             )
         if response.status_code != 200:
-            raise vgs.FunctionsApiException(
-                f"Failed to invoke function '{name}'. Reason: {response.content}"
-            )
+            raise vgs.FunctionsApiException(f"Failed to invoke function '{name}'. Reason: {response.content}")
         if response.headers.get("X-VGS-Function") != "True":
             raise vgs.FunctionsApiException(f"Function '{name}' doesn't exist.")
         return response.content

vgs/sdk/account_mgmt.py

@@ -10,7 +10,7 @@ class AccountMgmtAPI(API):
                 "Accept": "application/vnd.api+json",
                 "Authorization": f"Bearer {access_token}",
                 "Content-Type": "application/vnd.api+json",
-                "User-Agent": f"VGS SDK 0.0.1-dev202305161416",
+                "User-Agent": f"VGS SDK 0.0.1.dev202404232319",
             },
             json_encode_body=True,
         )

vgs/sdk/accounts_api.py

@@ -33,7 +33,7 @@ def create_api(token, environment):
         headers={
             "Content-Type": "application/vnd.api+json",
             "Accept": "application/vnd.api+json",
-            "User-Agent": "VGS SDK {}".format("0.0.1-dev202305161416"),
+            "User-Agent": "VGS SDK {}".format("0.0.1.dev202404232319"),
             "Authorization": "Bearer {}".format(token),
         },
         timeout=50,  # default timeout in seconds

vgs/sdk/auth_api.py

@@ -21,7 +21,7 @@ def create_api(environment):
     api = API(
         api_root_url=env_url[environment],
         params={},  # default params
-        headers={"User-Agent": f"VGS SDK 0.0.1-dev202305161416"},  # default headers
+        headers={"User-Agent": f"VGS SDK 0.0.1.dev202404232319"},  # default headers
         timeout=50,  # default timeout in seconds
         append_slash=False,  # append slash to final url
     )
@@ -45,7 +45,7 @@ def logout(api, client_id, access_token, refresh_token):
         headers={
             "Authorization": access_token,
             "Content-Type": "application/x-www-form-urlencoded",
-            "User-Agent": f"VGS SDK 0.0.1-dev202305161416",
+            "User-Agent": f"VGS SDK 0.0.1.dev202404232319",
         },
         body="client_id={client_id}&refresh_token={refresh_token}".format(
             client_id=client_id, refresh_token=refresh_token

vgs/sdk/errors.py

@@ -32,11 +32,7 @@ class AuthenticationRequiredError(VgsSDKError):
 
 class AuthenticationError(VgsSDKError):
     def __init__(self, ctx=None, details=None):
-        self.message = (
-            "Authentication error occurred"
-            if ctx and ctx.obj.debug
-            else "Authentication error occurred."
-        )
+        self.message = "Authentication error occurred" if ctx and ctx.obj.debug else "Authentication error occurred."
 
         if details:
             self.message = "{message} {details}".format(message=self.message, details=details)
@@ -88,9 +84,7 @@ class RouteNotValidError(VgsSDKError):
     def __init__(self, error_message: str, ctx=None):
         error_message = f"Route cannot be applied due to errors:\n{error_message}"
         self.message = (
-            error_message
-            if ctx and ctx.obj.debug
-            else f"{error_message} (Run with --debug for a traceback.)"
+            error_message if ctx and ctx.obj.debug else f"{error_message} (Run with --debug for a traceback.)"
         )
         self.ctx = ctx
 
@@ -156,9 +150,7 @@ def status_code_error(**kwargs):
     def init(self, e, ctx=None):
         error_handler = kwargs.get(f"e{e.response.status_code}")
         if error_handler:
-            self.message = (
-                error_handler(e) if isinstance(error_handler, types.FunctionType) else error_handler
-            )
+            self.message = error_handler(e) if isinstance(error_handler, types.FunctionType) else error_handler
             self.ctx = ctx
         else:
             ApiError.__init__(self, e, ctx=ctx)

vgs/sdk/routes.py

@@ -42,4 +42,13 @@ def normalize(results):
         for filter_item in result["attributes"]["entries"]:
             if isinstance(filter_item["operations"], str):
                 filter_item["operations"] = Literal(filter_item["operations"])
+
+            # this will apply the Literal representation to the script of the operation so it preserves whitespace
+            if isinstance(filter_item["operations"], list):
+                for operation in filter_item["operations"]:
+                    if "parameters" in operation:
+                        for field in ("script", "processorSource"):
+                            if field in operation["parameters"]:
+                                operation["parameters"][field] = Literal(operation["parameters"][field])
+
     return results

vgs/sdk/vault_mgmt.py

@@ -10,7 +10,7 @@ class VaultMgmtAPI(API):
                 "Accept": "application/vnd.api+json",
                 "Authorization": f"Bearer {access_token}",
                 "Content-Type": "application/vnd.api+json",
-                "User-Agent": f"VGS SDK 0.0.1-dev202305161416",
+                "User-Agent": f"VGS SDK 0.0.1.dev202404232319",
             },
             json_encode_body=True,
         )

vgs/sdk/vaults_api.py

@@ -21,7 +21,7 @@ def create_api(ctx, vault_id, environment, token):
             "VGS-Tenant": vault_id,
             "Content-Type": "application/vnd.api+json",
             "Accept": "application/vnd.api+json",
-            "User-Agent": "VGS SDK {}".format("0.0.1-dev202305161416"),
+            "User-Agent": "VGS SDK {}".format("0.0.1.dev202404232319"),
             "Authorization": "Bearer {}".format(token),
         },  # default headers
         timeout=50,  # default timeout in seconds

vgs_api_client/__init__.py

@@ -3,7 +3,7 @@
 """
     Vault HTTP API
 
-    The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ### Authentication  This API uses `Basic` authentication and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam)  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ```   # noqa: E501
+    The VGS Vault HTTP API is used for storing, retrieving, and managing sensitive data (aka Tokenization) within a VGS Vault.  The VGS API is organized around REST. Our API is built with a predictable resource-oriented structure, uses JSON-encoded requests and responses, follows standard HTTP verbs/responses, and uses industry standard authentication.  ## What is VGS  Storing sensitive data on your company’s infrastructure often comes with a heavy compliance burden. For instance, storing payments data yourself greatly increases the amount of work needed to become PCI compliant. It also increases your security risk in general. To combat this, companies will minimize the amount of sensitive information they have to handle or store.  VGS provides multiple methods for minimizing the sensitive information that needs to be stored which allows customers to secure any type of data for any use-case.  **Tokenization** is a method that focuses on securing the storage of data. This is the quickest way to get started and is free. [Get started with Tokenization](https://www.verygoodsecurity.com/docs/tokenization/getting-started).  **Zero Data** is a unique method invented by VGS in 2016 that securely stores data like Tokenization, however it also removes the customer’s environment from PCI scope completely providing maximum security, and minimum compliance scope. [Get started with Zero Data](https://www.verygoodsecurity.com/docs/getting-started/before-you-start).  Additionally, for scenarios where neither technology is a complete solution, for instance with legacy systems, VGS provides a compliance product which guarantees customers are able to meet their compliance needs no matter what may happen. [Get started with Control](https://www.verygoodsecurity.com/docs/control).  ## Learn about Tokenization  - [Create an Account for Free Tokenization](https://dashboard.verygoodsecurity.com/tokenization) - [Try a Tokenization Demo](https://www.verygoodsecurity.com/docs/tokenization/getting-started) - [Install a Tokenization SDK](https://www.verygoodsecurity.com/docs/tokenization/client-libraries)  ## Introduction  ### Alias-Formats | Format                          | Description                                                                               | |---------------------------------|-------------------------------------------------------------------------------------------| | UUID                            | Generic - VGS Alias (Default) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx                     | | NUM_LENGTH_PRESERVING           | Generic - Numeric Length Preserving - xxxxxxxxxxxxxxxx                                    | | FPE_SIX_T_FOUR                  | Payment Card - Format Preserving, Luhn Valid (6T4) - <first_six>xxxxxx<last_four>         | | FPE_T_FOUR                      | Payment Card - Format Preserving, Luhn Valid (T4) - xxxxxxxxxxxx<last_four>               | | PFPT                            | Payment Card - Prefixed, Luhn Valid, 19 Digits Fixed Length - xxxxxxxxxxxxxxxxxxx         | | NON_LUHN_FPE_ALPHANUMERIC       | Payment Card - Format Preserving - Non Luhn Valid - xxxxxxxxxxxxxxxx                      | | FPE_SSN_T_FOUR                  | SSN - Format Preserving (A4) - xxx-xx-<last_four>                                         | | FPE_ACC_NUM_T_FOUR              | Account Number - Numeric Length Preserving (A4) - xxxxxxxxxxxx<last_four>                 | | FPE_ALPHANUMERIC_ACC_NUM_T_FOUR | Account Number - Alphanumeric Length Preserving (A4) - xxxxxxxxxxxx<last_four>            | | GENERIC_T_FOUR                  | Generic - VGS Alias Last Four (T4) - tok_sandbox_xxxxxxxxxxxxxxxxxxxxxxxxx_<last_four>    | | RAW_UUID                        | Generic - UUID - xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx                                     | | ALPHANUMERIC_SIX_T_FOUR         | Numeric - Include Alphanumeric, 19 symbols length (6T4) - <first_six>xxxxxxxxx<last_four> | | VGS_FIXED_LEN_GENERIC           | Generic - VGS Alphanumeric Fixed Length, 29 characters - vgsxxxxxxxxxxxxxxxxxxxxxxxxxx    |   ## Authentication  This API uses `Basic` authentication and is implemented using industry best practices to ensure the security of the connection. Read more about [Identity and Access Management at VGS](https://www.verygoodsecurity.com/docs/vault/the-platform/iam)  Credentials to access the API can be generated on the [dashboard](https://dashboard.verygoodsecurity.com) by going to the Settings section of the vault of your choosing.  [Docs » Guides » Access credentials](https://www.verygoodsecurity.com/docs/settings/access-credentials)  ## Resource Limits  ### Data Limits  This API allows storing data up to 32MB in size.  ### Rate Limiting  The API allows up to 3,000 requests per minute. Requests are associated with the vault, regardless of the access credentials used to authenticate the request.  Your current rate limit is included as HTTP headers in every API response:  | Header Name             | Description                                              | |-------------------------|----------------------------------------------------------| | `x-ratelimit-remaining` | The number of requests remaining in the 1-minute window. |  If you exceed the rate limit, the API will reject the request with HTTP [429 Too Many Requests](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429).  ### Errors  The API uses standard HTTP status codes to indicate whether the request succeeded or not.  In case of failure, the response body will be JSON in a predefined format. For example, trying to create too many aliases at once results in the following response:  ```json {     \"errors\": [         {             \"status\": 400,             \"title\": \"Bad request\",             \"detail\": \"Too many values (limit: 20)\",             \"href\": \"https://api.sandbox.verygoodvault.com/aliases\"         }     ] } ```   # noqa: E501
 
     The version of the OpenAPI document: 1.0.0
     Contact: support@verygoodsecurity.com
@@ -11,7 +11,7 @@
 """
 
 
-__version__ = "0.0.1-dev202305161416"
+__version__ = "0.0.1.dev202404232319"
 
 # import ApiClient
 from vgs_api_client.api_client import ApiClient