chore(go-client): rename package name

Author: h4rikris

clients/go/README.md

@@ -1,63 +1,36 @@
-<!-- Code generated by gomarkdoc. DO NOT EDIT -->
-
-# stencilclient
+# stencil
 
 ```go
 import "github.com/odpf/stencil/clients/go"
 ```
 
+Package stencil helps to download and refresh protobuf descriptors from remote server and provides helper functions to get protobuf schema descriptors and can parse the messages dynamically\.
+
 ## Index
 
 - [Variables](<#variables>)
+- [type Client](<#type-client>)
+  - [func NewClient(url string, options Options) (Client, error)](<#func-newclient>)
+  - [func NewMultiURLClient(urls []string, options Options) (Client, error)](<#func-newmultiurlclient>)
 - [type HTTPOptions](<#type-httpoptions>)
 - [type Options](<#type-options>)
-- [type StencilClient](<#type-stencilclient>)
-  - [func NewClient(url string, options Options) (StencilClient, error)](<#func-newclient>)
-  - [func NewMultiURLClient(urls []string, options Options) (StencilClient, error)](<#func-newmultiurlclient>)
 
 
 ## Variables
 
 ```go
 var (
+    //ErrNotFound default sentinel error if proto not found
     ErrNotFound = errors.New("not found")
 )
 ```
 
-## type [HTTPOptions](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L31-L36>)
-
-HTTPOptions options for http client
-
-```go
-type HTTPOptions struct {
-    // Timeout specifies a time limit for requests made by this client
-    Timeout time.Duration
-    // Headers provide extra headers to be added in requests made by this client
-    Headers map[string]string
-}
-```
-
-## type [Options](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L39-L46>)
+## type [Client](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L24-L32>)
 
-Options options for stencil client
+Client provides utility functions to parse protobuf messages at runtime\. protobuf messages can be identified by specifying fully qualified generated proto java class name\.
 
 ```go
-type Options struct {
-    // AutoRefresh boolean to enable or disable autorefresh. Default to false
-    AutoRefresh bool
-    // RefreshInterval refresh interval to fetch descriptor file from server.
-    RefreshInterval time.Duration
-    // HTTPOptions options for http client
-    HTTPOptions
-}
-```
-
-## type [StencilClient](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L20-L28>)
-
-StencilClient provides utility functions to parse protobuf messages at runtime\. protobuf messages can be identified by specifying fully qualified generated proto java class name\.
-
-```go
-type StencilClient interface {
+type Client interface {
     // Parse parses protobuf message from wire format to protoreflect.Message given fully qualified name of proto message.
     // Returns ErrNotFound error if given class name is not found
     Parse(string, []byte) (protoreflect.ProtoMessage, error)
@@ -68,19 +41,46 @@ type StencilClient interface {
 }
 ```
 
-### func [NewClient](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L95>)
+### func [NewClient](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L99>)
 
 ```go
-func NewClient(url string, options Options) (StencilClient, error)
+func NewClient(url string, options Options) (Client, error)
 ```
 
 NewClient creates stencil client
 
-### func [NewMultiURLClient](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L102>)
+### func [NewMultiURLClient](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L106>)
 
 ```go
-func NewMultiURLClient(urls []string, options Options) (StencilClient, error)
+func NewMultiURLClient(urls []string, options Options) (Client, error)
 ```
 
 NewMultiURLClient creates stencil client with multiple urls
 
+## type [HTTPOptions](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L35-L40>)
+
+HTTPOptions options for http client
+
+```go
+type HTTPOptions struct {
+    // Timeout specifies a time limit for requests made by this client.
+    Timeout time.Duration
+    // Headers provide extra headers to be added in requests made by this client
+    Headers map[string]string
+}
+```
+
+## type [Options](<https://github.com/odpf/stencil/blob/master/clients/go/client.go#L43-L50>)
+
+Options options for stencil client
+
+```go
+type Options struct {
+    // AutoRefresh boolean to enable or disable autorefresh. Default to false
+    AutoRefresh bool
+    // RefreshInterval refresh interval to fetch descriptor file from server.
+    RefreshInterval time.Duration
+    // HTTPOptions options for http client
+    HTTPOptions
+}
+```

clients/go/client.go

@@ -1,4 +1,7 @@
-package stencilclient
+// Package stencil helps to download and refresh protobuf descriptors from remote server
+// and provides helper functions to get protobuf schema descriptors and can parse the messages
+// dynamically.
+package stencil
 
 import (
 	"errors"
@@ -12,12 +15,13 @@ import (
 )
 
 var (
+	//ErrNotFound default sentinel error if proto not found
 	ErrNotFound = errors.New("not found")
 )
 
-// StencilClient provides utility functions to parse protobuf messages at runtime.
+// Client provides utility functions to parse protobuf messages at runtime.
 // protobuf messages can be identified by specifying fully qualified generated proto java class name.
-type StencilClient interface {
+type Client interface {
 	// Parse parses protobuf message from wire format to protoreflect.Message given fully qualified name of proto message.
 	// Returns ErrNotFound error if given class name is not found
 	Parse(string, []byte) (protoreflect.ProtoMessage, error)
@@ -29,7 +33,7 @@ type StencilClient interface {
 
 // HTTPOptions options for http client
 type HTTPOptions struct {
-	// Timeout specifies a time limit for requests made by this client
+	// Timeout specifies a time limit for requests made by this client.
 	Timeout time.Duration
 	// Headers provide extra headers to be added in requests made by this client
 	Headers map[string]string
@@ -45,13 +49,13 @@ type Options struct {
 	HTTPOptions
 }
 
-type stencilclient struct {
+type stencilClient struct {
 	timer io.Closer
 	urls  []string
 	store *descriptorStore
 }
 
-func (s *stencilclient) Parse(className string, data []byte) (protoreflect.ProtoMessage, error) {
+func (s *stencilClient) Parse(className string, data []byte) (protoreflect.ProtoMessage, error) {
 	desc, ok := s.store.get(className)
 	if !ok {
 		return nil, ErrNotFound
@@ -61,29 +65,29 @@ func (s *stencilclient) Parse(className string, data []byte) (protoreflect.Proto
 	return m, err
 }
 
-func (s *stencilclient) GetDescriptor(className string) (protoreflect.MessageDescriptor, error) {
+func (s *stencilClient) GetDescriptor(className string) (protoreflect.MessageDescriptor, error) {
 	desc, ok := s.store.get(className)
 	if !ok {
 		return nil, ErrNotFound
 	}
 	return desc, nil
 }
 
-func (s *stencilclient) Close() {
+func (s *stencilClient) Close() {
 	if s.timer != nil {
 		s.timer.Close()
 	}
 }
 
-func (s *stencilclient) refresh(opts Options) error {
+func (s *stencilClient) refresh(opts Options) error {
 	var err error
 	for _, url := range s.urls {
 		err = multierr.Combine(err, s.store.loadFromURI(url, opts))
 	}
 	return err
 }
 
-func (s *stencilclient) load(opts Options) error {
+func (s *stencilClient) load(opts Options) error {
 	if opts.AutoRefresh {
 		s.timer = setInterval(opts.RefreshInterval, func() { s.refresh(opts) })
 	}
@@ -92,15 +96,15 @@ func (s *stencilclient) load(opts Options) error {
 }
 
 // NewClient creates stencil client
-func NewClient(url string, options Options) (StencilClient, error) {
-	s := &stencilclient{store: newStore(), urls: []string{url}}
+func NewClient(url string, options Options) (Client, error) {
+	s := &stencilClient{store: newStore(), urls: []string{url}}
 	err := s.load(options)
 	return s, err
 }
 
 // NewMultiURLClient creates stencil client with multiple urls
-func NewMultiURLClient(urls []string, options Options) (StencilClient, error) {
-	s := &stencilclient{store: newStore(), urls: urls}
+func NewMultiURLClient(urls []string, options Options) (Client, error) {
+	s := &stencilClient{store: newStore(), urls: urls}
 	err := s.load(options)
 	return s, err
 }

clients/go/client_test.go

@@ -1,4 +1,4 @@
-package stencilclient_test
+package stencil_test
 
 import (
 	"bytes"
@@ -11,7 +11,7 @@ import (
 	"testing"
 	"time"
 
-	stencilclient "github.com/odpf/stencil/clients/go"
+	stencil "github.com/odpf/stencil/clients/go"
 	"github.com/stretchr/testify/assert"
 	"google.golang.org/protobuf/proto"
 	"google.golang.org/protobuf/reflect/protoreflect"
@@ -70,13 +70,13 @@ func getDescriptorData(t *testing.T, includeImports bool) ([]byte, error) {
 func TestNewClient(t *testing.T) {
 	t.Run("should return error if url is not valid", func(t *testing.T) {
 		url := "h_ttp://invalidurl"
-		_, err := stencilclient.NewClient(url, stencilclient.Options{})
+		_, err := stencil.NewClient(url, stencil.Options{})
 		assert.Contains(t, err.Error(), "invalid request")
 	})
 
 	t.Run("should return error if request fails", func(t *testing.T) {
 		url := "ithttp://localhost"
-		_, err := stencilclient.NewClient(url, stencilclient.Options{})
+		_, err := stencil.NewClient(url, stencil.Options{})
 		assert.Contains(t, err.Error(), "request failed")
 	})
 
@@ -86,7 +86,7 @@ func TestNewClient(t *testing.T) {
 		}))
 		defer ts.Close()
 		url := ts.URL
-		_, err := stencilclient.NewClient(url, stencilclient.Options{})
+		_, err := stencil.NewClient(url, stencil.Options{})
 		assert.Contains(t, err.Error(), "request failed.")
 	})
 
@@ -97,7 +97,7 @@ func TestNewClient(t *testing.T) {
 		}))
 		defer ts.Close()
 		url := ts.URL
-		_, err := stencilclient.NewClient(url, stencilclient.Options{})
+		_, err := stencil.NewClient(url, stencil.Options{})
 		assert.Contains(t, err.Error(), "invalid file descriptorset file.")
 	})
 
@@ -109,7 +109,7 @@ func TestNewClient(t *testing.T) {
 		}))
 		defer ts.Close()
 		url := ts.URL
-		_, err = stencilclient.NewClient(url, stencilclient.Options{})
+		_, err = stencil.NewClient(url, stencil.Options{})
 		if assert.NotNil(t, err) {
 			assert.Contains(t, err.Error(), "file is not fully contained descriptor file.")
 		}
@@ -123,7 +123,7 @@ func TestNewClient(t *testing.T) {
 		}))
 		defer ts.Close()
 		url := ts.URL
-		client, err := stencilclient.NewClient(url, stencilclient.Options{})
+		client, err := stencil.NewClient(url, stencil.Options{})
 		assert.Nil(t, err)
 		assert.NotNil(t, client)
 	})
@@ -139,7 +139,7 @@ func TestNewClient(t *testing.T) {
 			}
 			w.Write(data)
 		}))
-		client, err := stencilclient.NewClient(ts.URL, stencilclient.Options{HTTPOptions: stencilclient.HTTPOptions{Headers: headers}})
+		client, err := stencil.NewClient(ts.URL, stencil.Options{HTTPOptions: stencil.HTTPOptions{Headers: headers}})
 		assert.Nil(t, err)
 		assert.NotNil(t, client)
 	})
@@ -151,7 +151,7 @@ func TestNewClient(t *testing.T) {
 			callCount++
 			w.Write(data)
 		}))
-		client, _ := stencilclient.NewClient(ts.URL, stencilclient.Options{AutoRefresh: true, RefreshInterval: 5 * time.Millisecond})
+		client, _ := stencil.NewClient(ts.URL, stencil.Options{AutoRefresh: true, RefreshInterval: 5 * time.Millisecond})
 		time.Sleep(6 * time.Millisecond)
 		client.Close()
 		assert.Equal(t, 2, callCount)
@@ -171,7 +171,7 @@ func TestNewMultiURLClient(t *testing.T) {
 	}))
 	defer ts2.Close()
 	url2 := ts2.URL
-	_, err = stencilclient.NewMultiURLClient([]string{url, url2}, stencilclient.Options{})
+	_, err = stencil.NewMultiURLClient([]string{url, url2}, stencil.Options{})
 	assert.NotNil(t, err)
 	assert.Contains(t, err.Error(), "request failed.")
 }
@@ -185,14 +185,14 @@ func TestClient(t *testing.T) {
 		}))
 		defer ts.Close()
 		url := ts.URL
-		client, err := stencilclient.NewClient(url, stencilclient.Options{})
+		client, err := stencil.NewClient(url, stencil.Options{})
 		assert.Nil(t, err)
 		assert.NotNil(t, client)
 		t.Run("should return notFoundErr if not found", func(t *testing.T) {
 			msg, err := client.GetDescriptor("test.stencil.Two.Unknown")
 			assert.Nil(t, msg)
 			assert.NotNil(t, err)
-			assert.Equal(t, stencilclient.ErrNotFound, err)
+			assert.Equal(t, stencil.ErrNotFound, err)
 		})
 		t.Run("should get nested message descriptor from fully qualified java classname", func(t *testing.T) {
 			msg, err := client.GetDescriptor("test.stencil.Two.Four")
@@ -215,14 +215,14 @@ func TestClient(t *testing.T) {
 		}))
 		defer ts.Close()
 		url := ts.URL
-		client, err := stencilclient.NewClient(url, stencilclient.Options{})
+		client, err := stencil.NewClient(url, stencil.Options{})
 		assert.Nil(t, err)
 		assert.NotNil(t, client)
 		t.Run("should return notFoundErr if not found", func(t *testing.T) {
 			msg, err := client.Parse("test.stencil.Two.Unknown", []byte(""))
 			assert.Nil(t, msg)
 			assert.NotNil(t, err)
-			assert.Equal(t, stencilclient.ErrNotFound, err)
+			assert.Equal(t, stencil.ErrNotFound, err)
 		})
 
 		t.Run("should parse wire format data given className", func(t *testing.T) {

clients/go/downloader.go

@@ -1,4 +1,4 @@
-package stencilclient
+package stencil
 
 import (
 	"fmt"

clients/go/go.mod

@@ -3,7 +3,7 @@ module github.com/odpf/stencil/clients/go
 go 1.16
 
 require (
-	github.com/stretchr/testify v1.7.0 // indirect
+	github.com/stretchr/testify v1.7.0
 	go.uber.org/multierr v1.6.0
 	google.golang.org/protobuf v1.26.0
 )

clients/go/go.sum

@@ -6,7 +6,6 @@ github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
 github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
-github.com/stretchr/objx v0.1.0 h1:4G4v2dO3VZwixGIRoQ5Lfboy6nUhCyYzaqnIAPPhYs4=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
@@ -20,6 +19,7 @@ golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8T
 google.golang.org/protobuf v1.26.0-rc.1/go.mod h1:jlhhOSvTdKEhbULTjvd4ARK9grFBp09yW+WbY/TyQbw=
 google.golang.org/protobuf v1.26.0 h1:bxAC2xTBsZGibn2RTntX0oH50xLsqy1OxA9tTL3p/lk=
 google.golang.org/protobuf v1.26.0/go.mod h1:9q0QmTI4eRPtz6boOQmLYwt+qCgq0jsYwAQnmE0givc=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
 gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

clients/go/protoutils.go

@@ -1,4 +1,4 @@
-package stencilclient
+package stencil
 
 import (
 	"strings"

clients/go/resolver.go

@@ -1,4 +1,4 @@
-package stencilclient
+package stencil
 
 import (
 	"google.golang.org/protobuf/reflect/protoreflect"