spaceforge 0.0.12__py3-none-any.whl → 0.0.14__py3-none-any.whl

spaceforge/_version_scm.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.12'
-__version_tuple__ = version_tuple = (0, 0, 12)
+__version__ = version = '0.0.14'
+__version_tuple__ = version_tuple = (0, 0, 14)
 
 __commit_id__ = commit_id = None

spaceforge/cls.py

@@ -145,7 +145,7 @@ class Webhook:
 
     name_prefix: str
     endpoint: str
-    secretFromParameter: str
+    secretFromParameter: Optional[str] = optional_field
     labels: Optional[List[str]] = optional_field
 
 
@@ -202,4 +202,7 @@ if __name__ == "__main__":
 
     from pydantic import TypeAdapter
 
-    print(json.dumps(TypeAdapter(PluginManifest).json_schema(), indent=2))
+    schema = TypeAdapter(PluginManifest).json_schema()
+    schema["$schema"] = "http://json-schema.org/draft-07/schema#"
+
+    print(json.dumps(schema, indent=2))

spaceforge/plugin.py

@@ -43,6 +43,7 @@ class SpaceforgePlugin(ABC):
         self._api_enabled = bool(self._api_token and self.spacelift_domain)
         self._workspace_root = os.getcwd()
         self._spacelift_markdown_endpoint = None
+        self._markdown_endpoint_token = os.environ.get("SPACELIFT_API_TOKEN") or False
 
         # This should be the last thing we do in the constructor
         # because we set api_enabled to false if the domain is set up incorrectly.
@@ -109,6 +110,58 @@ class SpaceforgePlugin(ABC):
 
         return logger
 
+    def use_user_token(self, id: str, token: str) -> None:
+        headers = {
+            "Content-Type": "application/json",
+            "Authorization": f"Bearer {self._api_token}",
+        }
+
+        query = """
+        mutation requestApiKey($id: ID!, $secret: String!){
+          apiKeyUser(id: $id, secret: $secret){
+            jwt
+          }
+        }
+        """
+
+        data: Dict[str, Any] = {
+            "query": query,
+            "variables": {"id": id, "secret": token},
+        }
+
+        req = urllib.request.Request(
+            self.spacelift_domain,  # type: ignore[arg-type]
+            json.dumps(data).encode("utf-8"),
+            headers,
+        )
+
+        self.logger.debug(f"Sending request to url: {self.spacelift_domain}")
+        try:
+            with urllib.request.urlopen(req) as response:
+                resp: Dict[str, Any] = json.loads(response.read().decode("utf-8"))
+        except urllib.error.HTTPError as e:
+            if hasattr(e, "read"):
+                resp = json.loads(e.read().decode("utf-8"))
+            else:
+                # We should not get here, but if we do re-raise the exception
+                self.logger.error(f"HTTP error occurred: ({e.code}) {e.reason} {e.msg}")
+                raise e
+
+        if "errors" in resp:
+            self.logger.error(f"Error: {resp['errors']}")
+            return
+
+        if (
+            "data" in resp
+            and "apiKeyUser" in resp["data"]
+            and "jwt" in resp["data"]["apiKeyUser"]
+        ):
+            self._api_token = resp["data"]["apiKeyUser"]["jwt"]
+            self._api_enabled = True
+            self.logger.debug("Successfully set user token for API calls.")
+        else:
+            self.logger.error(f"API call returned no data: {resp}")
+
     def get_available_hooks(self) -> List[str]:
         """
         Get list of hook methods available in this plugin.
@@ -256,13 +309,16 @@ class SpaceforgePlugin(ABC):
             self.logger.info(markdown)
             return True
 
-        if self._spacelift_markdown_endpoint is None:
+        if (
+            self._spacelift_markdown_endpoint is None
+            or not self._markdown_endpoint_token
+        ):
             self.logger.error(
                 'API is not enabled, please export "SPACELIFT_API_TOKEN" and "TF_VAR_spacelift_graphql_endpoint".'
             )
             return False
 
-        headers = {"Authorization": f"Bearer {self._api_token}"}
+        headers = {"Authorization": f"Bearer {self._markdown_endpoint_token}"}
         body = {
             "plugin_name": self.__plugin_name__,
         }

spaceforge/schema.json

@@ -260,8 +260,15 @@
           "type": "string"
         },
         "secretFromParameter": {
-          "title": "Secretfromparameter",
-          "type": "string"
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "title": "Secretfromparameter"
         },
         "labels": {
           "anyOf": [
@@ -280,8 +287,7 @@
       },
       "required": [
         "name_prefix",
-        "endpoint",
-        "secretFromParameter"
+        "endpoint"
       ],
       "title": "Webhook",
       "type": "object"
@@ -383,5 +389,6 @@
     "author"
   ],
   "title": "PluginManifest",
-  "type": "object"
+  "type": "object",
+  "$schema": "http://json-schema.org/draft-07/schema#"
 }

{spaceforge-0.0.12.dist-info → spaceforge-0.0.14.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: spaceforge
-Version: 0.0.12
+Version: 0.0.14
 Summary: A Python framework for building Spacelift plugins
 Home-page: https://github.com/spacelift-io/plugins
 Author: Spacelift

{spaceforge-0.0.12.dist-info → spaceforge-0.0.14.dist-info}/RECORD

@@ -2,13 +2,13 @@ spaceforge/README.md,sha256=8o1Nuyasb4OxX3E7ZycyducOrR4J19bZcHrLvFeoFNg,7730
 spaceforge/__init__.py,sha256=TU-vvm15dK1ucixNW0V42eTT72x3_hmKSyxP4MC1Occ,589
 spaceforge/__main__.py,sha256=c3nAw4WBnHXIcfMlRV6Ja7r87pEhSeK-SAqiSYIasIY,643
 spaceforge/_version.py,sha256=RP_LfUd4ODnrfwn9nam8wB6bR3lM4VwmoRxK08Tkiiw,2155
-spaceforge/_version_scm.py,sha256=AZGfWDETy7COMkzrSothvXJ8vYrPI7kp7_Tcfcp9hUQ,706
-spaceforge/cls.py,sha256=lCGtlMv-rFFVnvfFaq36-GRqLiINswLD78amZigZo7I,6068
+spaceforge/_version_scm.py,sha256=YDX9ERYoOeE60PulkdUCy2JxmS89Xb_igX2wwbidLMQ,706
+spaceforge/cls.py,sha256=8jZ0noS-kIBQWHp7pWHOX6yzs5N30gIEm6-slWgBaKI,6182
 spaceforge/conftest.py,sha256=U-xCavCsgRAQXqflIIOMeq9pcGbeqRviUNkEXgZol8g,2141
 spaceforge/generator.py,sha256=7tt0zpqrD2pZsoVxQa0BfzBH1ZtGr6o3r_LmpBjrOJk,16739
-spaceforge/plugin.py,sha256=ZURpbGEVReNHw79cHGBeIAfLq0ewrMjhFdB0L8wh0y0,14109
+spaceforge/plugin.py,sha256=fuATKzkkev2hNKWpQYMwJs1ZHgYKxEXGdlqHQ_wmpZ4,16057
 spaceforge/runner.py,sha256=aBQQLG8MFVrqCzM0X8HgERYbhLKbmlOHUPKjV7-xvpA,3163
-spaceforge/schema.json,sha256=scQyV71IlbB5kipAhc880n-PG-FH8BeVk9FWFoA3Wtw,10483
+spaceforge/schema.json,sha256=F0STokM3YYT0xzcNdtnELZJJgpyi49mwk9Oj8ueD39s,10631
 spaceforge/test_cls.py,sha256=nXAgbnFnGdFxrtA7vNXiePjNUASuoYW-lEuQGx9WMGs,468
 spaceforge/test_generator.py,sha256=Nst3YVu_iZbFopH6ajjxCfqYrZvybteGbwMfZzjBFnI,32615
 spaceforge/test_generator_binaries.py,sha256=X_7pPLGE45eQt-Kv9_ku__LsyLgOvViHc_BvVpSCMp0,7263
@@ -25,9 +25,9 @@ spaceforge/test_runner_core.py,sha256=eNR9YOwJwv7LsMtNQ4WXXMPIW6RE_A7hUp4bCpzz1R
 spaceforge/test_runner_execution.py,sha256=BRlOApCmlpjE9YYvqHc8creSRu2vyPubzOCVXv-on0w,5335
 spaceforge/templates/binary_install.sh.j2,sha256=UjP_kAdvkkATKds2nqk4ouqLhuIfCgM_x0WQIl1hbIo,477
 spaceforge/templates/ensure_spaceforge_and_run.sh.j2,sha256=g5BldIEve0IkZ-mCzTXfB_rFvyWqUJqymRRaaMrpp0s,550
-spaceforge-0.0.12.dist-info/licenses/LICENSE,sha256=wyljRrfnWY2ggQKkSCg3Nw2hxwPMmupopaKs9Kpgys8,1065
-spaceforge-0.0.12.dist-info/METADATA,sha256=oLaAZN0ePJGD4OT6Hl78OAkc7fNb_58InpdqOQJg5to,16804
-spaceforge-0.0.12.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-spaceforge-0.0.12.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
-spaceforge-0.0.12.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
-spaceforge-0.0.12.dist-info/RECORD,,
+spaceforge-0.0.14.dist-info/licenses/LICENSE,sha256=wyljRrfnWY2ggQKkSCg3Nw2hxwPMmupopaKs9Kpgys8,1065
+spaceforge-0.0.14.dist-info/METADATA,sha256=zT9cFLQOwMjkHyrXeUDN4a0Pm_elJI2dpMhrvWetjZc,16804
+spaceforge-0.0.14.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+spaceforge-0.0.14.dist-info/entry_points.txt,sha256=qawuuKBSNTGg-njnQnhxxFldFvXYAPej6bF_f3iyQ48,56
+spaceforge-0.0.14.dist-info/top_level.txt,sha256=eVw-Lw4Th0oHM8Gx1Y8YetyNgbNbMBU00yWs-kwGeSs,11
+spaceforge-0.0.14.dist-info/RECORD,,