Merge pull request #15 from jzelinskie/multiclients

reorganize package to support multiple clients

.github/workflows/build.yaml

@@ -16,26 +16,19 @@ jobs:
     - uses: "actions/setup-go@v2"
       with:
         go-version: ^1.16
-    - name: "go fmt"
+    - name: "go imports"
       run: |
-        GOFMT_OUTPUT="$(gofmt -l `find ./ -name '*.go' | grep -v vendor` 2>&1)"
-
-        if [ -n "$GOFMT_OUTPUT" ]; then
+        go install mvdan.cc/gofumpt/gofumports@latest
+        GOFUMPT_OUTPUT="$(gofumports -d `find . -name '*.go' | grep -v ./proto/`)"
+        if [ -n "$GOFUMPT_OUTPUT" ]; then
           echo "All the following files are not correctly formatted"
-          echo "${GOFMT_OUTPUT}"
+          echo "${GOFUMPT_OUTPUT}"
           exit 1
         fi
-    - name: "go imports"
+    - name: "go lint"
       run: |
-        exec 5>&1
-        GOIMPORTS_OUTPUT="$(goimports -l -w `find ./ -name '*.go' | grep -v vendor` | tee /dev/fd/5)"
-
-        if [ -n "$GOIMPORTS_OUTPUT" ]; then
-          echo "All following has imports not properly ordered"
-          echo "${GOIMPORTS_OUTPUT}"
-
-          exit 1
-        fi
+        go install github.com/mgechev/revive@latest
+        revive ./...
     - name: "go mod tidy"
       run: |
         GO_MOD_OUPUT="$(go mod tidy -v 2>&1)"
@@ -44,7 +37,6 @@ jobs:
           echo "${GO_MOD_OUPUT}"
           exit 1
         fi
-    - uses: golangci/golangci-lint-action@v2
 
   test:
     name: "Test"

README.md

@@ -1,16 +1,17 @@
 # authzed-go
 
 The official Go client library for Authzed.
+This repository is a collection of Go packages specialized for each versions of the Authzed API.
 
-## Example
+## Example (v0 API)
 
 This example demonstrates initializing a client and making a [Check request] to an existing [Namespace].
 
-A more full example can be found in the [examples directory].
+A more full example can be found in [v0/examples].
 
 [Check request]:https://docs.authzed.com/concept/check
 [Namespace]: https://docs.authzed.com/concept/namespaces
-[examples directory]: examples
+[v0/examples]: /v0/examples
 
 ```go
 package main
@@ -19,7 +20,7 @@ import (
 	"context"
 	"log"
 
-	"github.com/authzed/authzed-go"
+	"github.com/authzed/authzed-go/v0"
 	"github.com/authzed/authzed-go/proto/authzed/api/v0"
 )
 

go.mod

@@ -3,11 +3,10 @@ module github.com/authzed/authzed-go
 go 1.16
 
 require (
+	github.com/authzed/grpcutil v0.0.0-20210702215403-5fe6e00b4101
 	github.com/envoyproxy/protoc-gen-validate v0.6.1
-	github.com/golang/protobuf v1.5.2
 	github.com/jzelinskie/stringz v0.0.0-20210414224931-d6a8ce844a70
-	github.com/processout/grpc-go-pool v1.2.1
 	golang.org/x/sync v0.0.0-20190911185100-cd5d95a43a6e
-	google.golang.org/grpc v1.35.0
+	google.golang.org/grpc v1.39.0
 	google.golang.org/protobuf v1.26.0
 )

examples/example.go → v0/examples/example.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"log"
 
-	"github.com/authzed/authzed-go"
 	v0 "github.com/authzed/authzed-go/proto/authzed/api/v0"
+	"github.com/authzed/authzed-go/v0"
 )
 
 const (
@@ -36,7 +36,8 @@ func main() {
 			createTuple(tuple(aDoc("owner"), anOwner)),
 			createTuple(tuple(aDoc("contributor"), anEditor)),
 			createTuple(tuple(aDoc("viewer"), aViewer)),
-		}})
+		},
+	})
 	if err != nil {
 		log.Fatalf("unable to write tuples: %s", err)
 	}

examples_test.go → v0/examples_test.go

@@ -4,8 +4,8 @@ import (
 	"context"
 	"log"
 
-	"github.com/authzed/authzed-go"
 	v0 "github.com/authzed/authzed-go/proto/authzed/api/v0"
+	"github.com/authzed/authzed-go/v0"
 )
 
 func ExampleNewClient() {

filter.go → v0/filter.go

@@ -6,7 +6,7 @@ import (
 	"reflect"
 
 	v0 "github.com/authzed/authzed-go/proto/authzed/api/v0"
-	"github.com/authzed/authzed-go/x/parallel"
+	"github.com/authzed/authzed-go/v0/x/parallel"
 )
 
 const (

integration_test.go → v0/integration_test.go

@@ -10,7 +10,7 @@ import (
 	"google.golang.org/grpc"
 
 	v0 "github.com/authzed/authzed-go/proto/authzed/api/v0"
-	"github.com/authzed/authzed-go/x/nsbuilder"
+	"github.com/authzed/authzed-go/v0/x/nsbuilder"
 )
 
 var setupOnce sync.Once
@@ -23,15 +23,13 @@ var (
 	)
 )
 
-var (
-	fred = &v0.User{UserOneof: &v0.User_Userset{
-		Userset: &v0.ObjectAndRelation{
-			Namespace: "test/user",
-			ObjectId:  "fred",
-			Relation:  "...",
-		},
-	}}
-)
+var fred = &v0.User{UserOneof: &v0.User_Userset{
+	Userset: &v0.ObjectAndRelation{
+		Namespace: "test/user",
+		ObjectId:  "fred",
+		Relation:  "...",
+	},
+}}
 
 func setupTenant(t *testing.T) *Client {
 	client, err := NewClient("localhost:50051", grpc.WithInsecure())

v1alpha1/client.go

@@ -0,0 +1,30 @@
+package authzed
+
+import (
+	"github.com/jzelinskie/stringz"
+	"google.golang.org/grpc"
+
+	v1alpha1 "github.com/authzed/authzed-go/proto/authzed/api/v1alpha1"
+)
+
+// Client represents an open connection to Authzed.
+//
+// Clients are backed by a gRPC client and as such are thread-safe.
+type Client struct {
+	v1alpha1.SchemaServiceClient
+}
+
+// NewClient initializes a brand new client for interacting with Authzed.
+func NewClient(endpoint string, opts ...grpc.DialOption) (*Client, error) {
+	conn, err := grpc.Dial(
+		stringz.DefaultEmpty(endpoint, "grpc.authzed.com:443"),
+		opts...,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	return &Client{
+		v1alpha1.NewSchemaServiceClient(conn),
+	}, nil
+}

v1alpha1/client_test.go

@@ -0,0 +1,23 @@
+package authzed_test
+
+import (
+	"fmt"
+	"log"
+	"testing"
+
+	"github.com/authzed/grpcutil"
+
+	authzed "github.com/authzed/authzed-go/v1alpha1"
+)
+
+func ExampleNewClient(_ *testing.T) {
+	client, err := authzed.NewClient(
+		"grpc.authzed.com:443",
+		grpcutil.WithBearerToken("tc_my_token_deadbeefdeadbeefdeadbeef"),
+		grpcutil.WithSystemCerts(false),
+	)
+	if err != nil {
+		log.Fatalf("failed to connect to authzed: %s", err)
+	}
+	fmt.Println(client)
+}