examples

Author: easyCZ

components/public-api/go/README.md

@@ -7,31 +7,34 @@ go get -u github.com/gitpod-io/gitpod/components/public-api/go
 ```
 
 ```golang
-
 import (
-    "github.com/bufbuild/connect-go"
+    "context"
+    "fmt"
+    "os"
+    "time"
 
-    gitpod_experimental_v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
-    gitpod_experimental_v1connect "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1/v1connect"
+    "github.com/bufbuild/connect-go"
+    "github.com/gitpod-io/gitpod/components/public-api/go/client"
+    v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
 )
 
-// Define an interceptor to attach credentials onto outgoing requests
-interceptor := connect.UnaryInterceptorFunc(func(next connect.UnaryFunc) connect.UnaryFunc {
-    return connect.UnaryFunc(func(ctx context.Context, req connect.AnyRequest) (connect.AnyResponse, error) {
-      if req.Spec().IsClient {
-        // Send a token with client requests.
-        req.Header().Set("Authorization", "Bearer your-access-token")
-      }
-
-      return next(ctx, req)
-    })
-  })
-
-// Construct a new client to interact with Gitpod
-client := gitpod_experimental_v1connect.NewTeamsServiceClient(http.DefaultClient, "https://api.gitpod.io", connect.WithInterceptors(
-    inteceptor,
-))
-
-// Use the client to retreive teams
-response, err := client.ListTeams(context.Background(), gitpod_experimental_v1connect.NewRequest(&gitpod_experimental_v1.ListTeamsRequest{}))
+func ExampleListTeams() {
+    token := "gitpod_pat_example.personal-access-token"
+
+    gitpod, err := client.New(client.WithCredentials(token))
+    if err != nil {
+        fmt.Fprintf(os.Stderr, "Failed to construct gitpod client %v", err)
+        return
+    }
+
+    response, err := gitpod.Teams.ListTeams(context.Background(), connect.NewRequest(&v1.ListTeamsRequest{}))
+    if err != nil {
+        fmt.Fprintf(os.Stderr, "Failed to list teams %v", err)
+        return
+    }
+
+    fmt.Fprintf(os.Stdout, "Retrieved teams %v", response.Msg.GetTeams())
+}
 ```
+
+For more examples, see [examples](./examples) directory.

components/public-api/go/examples/client_example.go

@@ -0,0 +1,26 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License.AGPL.txt in the project root for license information.
+
+package examples
+
+import (
+	"context"
+	"fmt"
+	"github.com/bufbuild/connect-go"
+	"github.com/gitpod-io/gitpod/components/public-api/go/client"
+	v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
+	"os"
+)
+
+func ExampleClient() {
+	token := "gitpod_pat_example.personal-access-token"
+	gitpod, err := client.New(client.WithCredentials(token))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Failed to construct gitpod client %v", err)
+		return
+	}
+
+	// use the gitpod client to access resources
+	gitpod.Teams.ListTeams(context.Background(), connect.NewRequest(&v1.ListTeamsRequest{}))
+}

components/public-api/go/examples/teams_example.go

@@ -0,0 +1,36 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the GNU Affero General Public License (AGPL).
+// See License.AGPL.txt in the project root for license information.
+
+package examples
+
+import (
+	"context"
+	"fmt"
+	"github.com/bufbuild/connect-go"
+	"github.com/gitpod-io/gitpod/components/public-api/go/client"
+	v1 "github.com/gitpod-io/gitpod/components/public-api/go/experimental/v1"
+	"os"
+	"time"
+)
+
+func ExampleListTeams() {
+	token := "gitpod_pat_example.personal-access-token"
+
+	gitpod, err := client.New(client.WithCredentials(token))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Failed to construct gitpod client %v", err)
+		return
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), 3*time.Second)
+	defer cancel()
+
+	response, err := gitpod.Teams.ListTeams(ctx, connect.NewRequest(&v1.ListTeamsRequest{}))
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "Failed to list teams %v", err)
+		return
+	}
+
+	fmt.Fprintf(os.Stdout, "Retrieved teams %v", response.Msg.GetTeams())
+}

components/public-api/go/go.mod

@@ -5,6 +5,7 @@ go 1.19
 require (
 	github.com/bufbuild/connect-go v1.0.0
 	github.com/gitpod-io/gitpod/common-go v0.0.0-00010101000000-000000000000
+	github.com/stretchr/testify v1.7.0
 	google.golang.org/grpc v1.49.0
 	google.golang.org/protobuf v1.28.1
 )
@@ -27,7 +28,6 @@ require (
 	github.com/prometheus/procfs v0.8.0 // indirect
 	github.com/sirupsen/logrus v1.8.1 // indirect
 	github.com/slok/go-http-metrics v0.10.0 // indirect
-	github.com/stretchr/testify v1.7.0 // indirect
 	golang.org/x/net v0.0.0-20220225172249-27dd8689420f // indirect
 	golang.org/x/sync v0.0.0-20220601150217-0de741cfad7f // indirect
 	golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a // indirect