Merge pull request #27 from glassflow/space-management

add space list and create operation

Author: ashish-bagri

setup.py

@@ -8,7 +8,7 @@
 
 setuptools.setup(
     name="glassflow",
-    version="2.0.1rc",
+    version="2.0.2rc",
     author="glassflow",
     description="GlassFlow Python Client SDK",
     url="https://learn.glassflow.dev/docs",

src/glassflow/client.py

@@ -6,6 +6,7 @@
 from .models import errors, operations
 from .models.api import PipelineState
 from .pipeline import Pipeline
+from .space import Space
 
 
 class GlassFlowClient(APIClient):
@@ -21,9 +22,9 @@ class GlassFlowClient(APIClient):
 
     """
 
-    def __init__(
-        self, personal_access_token: str = None, organization_id: str = None
-    ) -> None:
+    def __init__(self,
+                 personal_access_token: str = None,
+                 organization_id: str = None) -> None:
         """Create a new GlassFlowClient object
 
         Args:
@@ -50,9 +51,8 @@ def get_pipeline(self, pipeline_id: str) -> Pipeline:
                 requested operation
             ClientError: GlassFlow Client Error
         """
-        return Pipeline(
-            personal_access_token=self.personal_access_token, id=pipeline_id
-        ).fetch()
+        return Pipeline(personal_access_token=self.personal_access_token,
+                        id=pipeline_id).fetch()
 
     def create_pipeline(
         self,
@@ -112,11 +112,13 @@ def create_pipeline(
             env_vars=env_vars,
             state=state,
             metadata=metadata,
+            organization_id=self.organization_id,
             personal_access_token=self.personal_access_token,
         ).create()
 
     def list_pipelines(
-        self, space_ids: list[str] | None = None
+        self,
+        space_ids: list[str] | None = None
     ) -> operations.ListPipelinesResponse:
         """
         Lists all pipelines in the GlassFlow API
@@ -156,3 +158,49 @@ def list_pipelines(
             total_amount=res_json["total_amount"],
             pipelines=res_json["pipelines"],
         )
+
+    def list_spaces(self) -> operations.ListSpacesResponse:
+        request = operations.ListSpacesRequest(
+            organization_id=self.organization_id,
+            personal_access_token=self.personal_access_token,
+        )
+        try:
+            res = self._request(
+                method="GET",
+                endpoint="/spaces",
+                request=request,
+            )
+            res_json = res.raw_response.json()
+        except errors.ClientError as e:
+            if e.status_code == 401:
+                raise errors.UnauthorizedError(e.raw_response) from e
+            else:
+                raise e
+
+        return operations.ListSpacesResponse(
+            content_type=res.content_type,
+            status_code=res.status_code,
+            raw_response=res.raw_response,
+            total_amount=res_json["total_amount"],
+            spaces=res_json["spaces"],
+        )
+
+    def create_space(
+        self,
+        name: str,
+    ) -> operations.CreateSpaceResponse:
+        """Creates a new Space
+
+        Args:
+            name: Name of the Space
+
+        Returns:
+            Space: New space
+
+        Raises:
+            UnauthorizedError: User does not have permission to perform
+                the requested operation
+        """
+        return Space(name=name,
+                     personal_access_token=self.personal_access_token,
+                     organization_id=self.organization_id).create()

src/glassflow/models/api/__init__.py

@@ -1,21 +1,10 @@
-from .api import (
-    CreatePipeline,
-    FunctionEnvironments,
-    GetDetailedSpacePipeline,
-    PipelineState,
-    SinkConnector,
-    SourceConnector,
-    SpacePipeline,
-    UpdatePipeline,
-)
+from .api import (CreatePipeline, FunctionEnvironments,
+                  GetDetailedSpacePipeline, PipelineState, SinkConnector,
+                  SourceConnector, SpacePipeline, UpdatePipeline, SpaceScope,
+                  CreateSpace)
 
 __all__ = [
-    "CreatePipeline",
-    "FunctionEnvironments",
-    "GetDetailedSpacePipeline",
-    "PipelineState",
-    "SinkConnector",
-    "SourceConnector",
-    "SpacePipeline",
-    "UpdatePipeline",
+    "CreatePipeline", "FunctionEnvironments", "GetDetailedSpacePipeline",
+    "PipelineState", "SinkConnector", "SourceConnector", "SpacePipeline",
+    "UpdatePipeline", "SpaceScope", "CreateSpace"
 ]

src/glassflow/models/operations/__init__.py

@@ -29,6 +29,8 @@
     PublishEventResponse,
     PublishEventResponseBody,
 )
+from .space_crud import (ListSpacesResponse, ListSpacesRequest,
+                         CreateSpaceRequest, CreateSpaceResponse)
 from .status_access_token import StatusAccessTokenRequest
 
 __all__ = [
@@ -54,4 +56,8 @@
     "PublishEventResponse",
     "PublishEventResponseBody",
     "StatusAccessTokenRequest",
+    "ListSpacesResponse",
+    "ListSpacesRequest",
+    "CreateSpaceRequest",
+    "CreateSpaceResponse",
 ]

src/glassflow/models/operations/pipeline_crud.py

@@ -3,7 +3,7 @@
 import dataclasses
 from enum import Enum
 
-from ..api import CreatePipeline, GetDetailedSpacePipeline, PipelineState, SpacePipeline
+from ..api import CreatePipeline, GetDetailedSpacePipeline, PipelineState, SpacePipeline, SpaceScope
 from .base import BaseManagementRequest, BasePipelineManagementRequest, BaseResponse
 
 

src/glassflow/models/operations/space_crud.py

@@ -0,0 +1,37 @@
+from __future__ import annotations
+
+import dataclasses
+from enum import Enum
+
+from ..api import SpaceScope, CreateSpace
+from .base import BaseResponse, BaseManagementRequest
+
+
+@dataclasses.dataclass
+class ListSpacesResponse(BaseResponse):
+    total_amount: int
+    spaces: list[SpaceScope]
+
+
+class Order(str, Enum):
+    asc = "asc"
+    desc = "desc"
+
+
+@dataclasses.dataclass
+class ListSpacesRequest(BaseManagementRequest):
+    page_size: int = 50
+    page: int = 1
+    order_by: Order = Order.asc
+
+
+@dataclasses.dataclass
+class CreateSpaceRequest(BaseManagementRequest, CreateSpace):
+    pass
+
+
+@dataclasses.dataclass
+class CreateSpaceResponse(BaseResponse):
+    name: str
+    id: str
+    created_at: str

src/glassflow/pipeline.py

@@ -6,6 +6,7 @@
 
 
 class Pipeline(APIClient):
+
     def __init__(
         self,
         personal_access_token: str,
@@ -93,7 +94,8 @@ def __init__(
         elif self.source_kind is None and self.source_config is None:
             self.source_connector = None
         else:
-            raise ValueError("Both source_kind and source_config must be provided")
+            raise ValueError(
+                "Both source_kind and source_config must be provided")
 
         if self.sink_kind is not None and self.sink_config is not None:
             self.sink_connector = api.SinkConnector(
@@ -121,8 +123,7 @@ def fetch(self) -> Pipeline:
         """
         if self.id is None:
             raise ValueError(
-                "Pipeline id must be provided in order to fetch it's details"
-            )
+                "Pipeline id must be provided in order to fetch it's details")
 
         request = operations.GetPipelineRequest(
             pipeline_id=self.id,
@@ -178,11 +179,11 @@ def create(self) -> Pipeline:
             metadata=self.metadata,
         )
         if self.name is None:
-            raise ValueError("Name must be provided in order to create the pipeline")
+            raise ValueError(
+                "Name must be provided in order to create the pipeline")
         if self.space_id is None:
             raise ValueError(
-                "Space_id must be provided in order to create the pipeline"
-            )
+                "Space_id must be provided in order to create the pipeline")
         if self.transformation_code is None and self.transformation_file is None:
             raise ValueError(
                 "Either transformation_code or transformation_file must be provided"
@@ -194,7 +195,9 @@ def create(self) -> Pipeline:
             **create_pipeline.__dict__,
         )
 
-        base_res = self._request(method="POST", endpoint="/pipelines", request=request)
+        base_res = self._request(method="POST",
+                                 endpoint="/pipelines",
+                                 request=request)
         res = operations.CreatePipelineResponse(
             status_code=base_res.status_code,
             content_type=base_res.content_type,
@@ -204,7 +207,10 @@ def create(self) -> Pipeline:
 
         self.id = res.id
         self.created_at = res.created_at
-        self.access_tokens.append({"name": "default", "token": res.access_token})
+        self.access_tokens.append({
+            "name": "default",
+            "token": res.access_token
+        })
         return self
 
     def delete(self) -> None:
@@ -250,7 +256,8 @@ def get_access_tokens(self) -> Pipeline:
         return self
 
     def get_source(
-        self, pipeline_access_token_name: str | None = None
+            self,
+            pipeline_access_token_name: str | None = None
     ) -> PipelineDataSource:
         """
         Get source client to publish data to the pipeline
@@ -269,8 +276,8 @@ def get_source(
         return self._get_data_client("source", pipeline_access_token_name)
 
     def get_sink(
-        self, pipeline_access_token_name: str | None = None
-    ) -> PipelineDataSink:
+            self,
+            pipeline_access_token_name: str | None = None) -> PipelineDataSink:
         """
         Get sink client to consume data from the pipeline
 
@@ -288,7 +295,9 @@ def get_sink(
         return self._get_data_client("sink", pipeline_access_token_name)
 
     def _get_data_client(
-        self, client_type: str, pipeline_access_token_name: str | None = None
+        self,
+        client_type: str,
+        pipeline_access_token_name: str | None = None
     ) -> PipelineDataSource | PipelineDataSink:
         if self.id is None:
             raise ValueError("Pipeline id must be provided in the constructor")
@@ -302,8 +311,8 @@ def _get_data_client(
                     break
             else:
                 raise ValueError(
-                    f"Token with name {pipeline_access_token_name} " f"was not found"
-                )
+                    f"Token with name {pipeline_access_token_name} "
+                    f"was not found")
         else:
             token = self.access_tokens[0]["token"]
         if client_type == "source":
@@ -321,7 +330,8 @@ def _get_data_client(
         return client
 
     def _request(
-        self, method: str, endpoint: str, request: operations.BaseManagementRequest
+            self, method: str, endpoint: str,
+            request: operations.BaseManagementRequest
     ) -> operations.BaseResponse:
         try:
             return super()._request(
@@ -331,7 +341,8 @@ def _request(
             )
         except errors.ClientError as e:
             if e.status_code == 404:
-                raise errors.PipelineNotFoundError(self.id, e.raw_response) from e
+                raise errors.PipelineNotFoundError(self.id,
+                                                   e.raw_response) from e
             elif e.status_code == 401:
                 raise errors.UnauthorizedError(e.raw_response) from e
             else: