P3) (Optoro) Allow variable to be secret in the UI, but gettable in functions, and prevent secret variables from being made non-secret (#42)

* secret -> secrecy - updated python client

* comment fixed

Author: RichardDzurus

polyapi/typedefs.py

@@ -40,11 +40,15 @@ class SpecificationDto(TypedDict):
     language: str
 
 
+# Enum for variable secrecy levels
+Secrecy = Literal['SECRET', 'OBSCURED', 'NONE']
+
+
 class VariableSpecification(TypedDict):
     environmentId: str
     value: Any
     valueType: PropertyType
-    secret: bool
+    secrecy: Secrecy
 
 
 class VariableSpecDto(TypedDict):

polyapi/variables.py

@@ -2,11 +2,11 @@
 from typing import List
 
 from polyapi.schema import map_primitive_types
-from polyapi.typedefs import PropertyType, VariableSpecDto
+from polyapi.typedefs import PropertyType, VariableSpecDto, Secrecy
 from polyapi.utils import add_import_to_init, init_the_init
 
 
-# GET is only included if the variable is not a secret
+# GET is only included if the variable is not SECRET
 GET_TEMPLATE = """
     @staticmethod
     def get() -> {variable_type}:
@@ -76,9 +76,10 @@ def generate_variables(variables: List[VariableSpecDto]):
 
 def render_variable(variable: VariableSpecDto):
     variable_type = _get_variable_type(variable["variable"]["valueType"])
+    # Only include get() method if secrecy is not SECRET
     get_method = (
         ""
-        if variable["variable"]["secret"]
+        if variable["variable"]["secrecy"] == "SECRET"
         else GET_TEMPLATE.format(
             variable_id=variable["id"], variable_type=variable_type
         )

pyproject.toml

@@ -3,7 +3,7 @@ requires = ["setuptools>=61.2", "wheel"]
 
 [project]
 name = "polyapi-python"
-version = "0.3.5.dev1"
+version = "0.3.6.dev0"
 description = "The Python Client for PolyAPI, the IPaaS by Developers for Developers"
 authors = [{ name = "Dan Fellin", email = "dan@polyapi.io" }]
 dependencies = [

tests/test_variables.py

@@ -12,7 +12,7 @@
         },
         "variable": {
             "environmentId": "123818231",
-            "secret": False,
+            "secrecy": "NONE",
             "valueType": {
                 "kind": "primitive",
                 "type": "string"