Merge pull request #4 from vgarvardt/feature/client-store

Renamed Store to TokenStore as ClientStore is coming next

Author: vgarvardt

README.md

@@ -39,10 +39,14 @@ func main() {
 	manager := manage.NewDefaultManager()
 
 	// use PostgreSQL token store with pgx.Connection adapter
-	store, _ := pg.NewStore(pgxAdapter.NewConn(pgxConn), pg.WithGCInterval(time.Minute))
+	adapter := pgxAdapter.NewConn(pgxConn)
+	tokenStore, _ := pg.NewTokenStore(adapter, pg.WithTokenStoreGCInterval(time.Minute))
 	defer store.Close()
+	
+	clientStore, _ := pg.NewClientStore(adapter)
 
-	manager.MapTokenStorage(store)
+	manager.MapTokenStorage(tokenStore)
+	manager.MapClientStorage(clientStore)
 	// ...
 }
 ```

client_store.go

@@ -0,0 +1,100 @@
+package pg
+
+import (
+	"fmt"
+	"log"
+	"os"
+
+	"github.com/json-iterator/go"
+	"gopkg.in/oauth2.v3"
+	"gopkg.in/oauth2.v3/models"
+)
+
+// ClientStore PostgreSQL client store
+type ClientStore struct {
+	adapter   Adapter
+	tableName string
+	logger    Logger
+
+	initTableDisabled bool
+}
+
+// ClientStoreItem data item
+type ClientStoreItem struct {
+	ID     string `db:"id"`
+	Secret string `db:"secret"`
+	Domain string `db:"domain"`
+	Data   []byte `db:"data"`
+}
+
+// NewClientStore creates PostgreSQL store instance
+func NewClientStore(adapter Adapter, options ...ClientStoreOption) (*ClientStore, error) {
+	store := &ClientStore{
+		adapter:   adapter,
+		tableName: "oauth2_clients",
+		logger:    log.New(os.Stderr, "[OAUTH2-PG-ERROR]", log.LstdFlags),
+	}
+
+	for _, o := range options {
+		o(store)
+	}
+
+	var err error
+	if !store.initTableDisabled {
+		err = store.initTable()
+	}
+
+	if err != nil {
+		return store, err
+	}
+
+	return store, err
+}
+
+func (s *ClientStore) initTable() error {
+	return s.adapter.Exec(fmt.Sprintf(`
+CREATE TABLE IF NOT EXISTS %[1]s (
+  id     TEXT  NOT NULL,
+  secret TEXT  NOT NULL,
+  domain TEXT  NOT NULL,
+  data   JSONB NOT NULL,
+  CONSTRAINT %[1]s_pkey PRIMARY KEY (id)
+);
+`, s.tableName))
+}
+
+func (s *ClientStore) toClientInfo(data []byte) (oauth2.ClientInfo, error) {
+	var cm models.Client
+	err := jsoniter.Unmarshal(data, &cm)
+	return &cm, err
+}
+
+// GetByID retrieves and returns client information by id
+func (s *ClientStore) GetByID(id string) (oauth2.ClientInfo, error) {
+	if id == "" {
+		return nil, nil
+	}
+
+	var item ClientStoreItem
+	if err := s.adapter.SelectOne(&item, fmt.Sprintf("SELECT * FROM %s WHERE id = $1", s.tableName), id); err != nil {
+		return nil, err
+	}
+
+	return s.toClientInfo(item.Data)
+}
+
+// Create creates and stores the new client information
+func (s *ClientStore) Create(info oauth2.ClientInfo) error {
+	data, err := jsoniter.Marshal(info)
+	if err != nil {
+		return err
+	}
+
+	return s.adapter.Exec(
+		fmt.Sprintf("INSERT INTO %s (id, secret, domain, data) VALUES ($1, $2, $3, $4)", s.tableName),
+		info.GetID(),
+		info.GetSecret(),
+		info.GetDomain(),
+		data,
+	)
+}

client_store_options.go

@@ -0,0 +1,25 @@
+package pg
+
+// ClientStoreOption is the configuration options type for client store
+type ClientStoreOption func(s *ClientStore)
+
+// WithClientStoreTableName returns option that sets client store table name
+func WithClientStoreTableName(tableName string) ClientStoreOption {
+	return func(s *ClientStore) {
+		s.tableName = tableName
+	}
+}
+
+// WithClientStoreLogger returns option that sets client store logger implementation
+func WithClientStoreLogger(logger Logger) ClientStoreOption {
+	return func(s *ClientStore) {
+		s.logger = logger
+	}
+}
+
+// WithClientStoreInitTableDisabled returns option that disables table creation on client store instantiation
+func WithClientStoreInitTableDisabled() ClientStoreOption {
+	return func(s *ClientStore) {
+		s.initTableDisabled = true
+	}
+}

client_store_options_test.go

@@ -0,0 +1,49 @@
+package pg
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestWithClientStoreInitTableDisabled(t *testing.T) {
+	store, err := NewClientStore(nil, WithClientStoreInitTableDisabled())
+	require.NoError(t, err)
+	assert.True(t, store.initTableDisabled)
+}
+
+func TestWithClientStoreTableName(t *testing.T) {
+	randomName := time.Now().String()
+
+	store, err := NewClientStore(nil, WithClientStoreTableName(randomName), WithClientStoreInitTableDisabled())
+	require.NoError(t, err)
+	assert.Equal(t, randomName, store.tableName)
+}
+
+func TestWithClientStoreLogger(t *testing.T) {
+	l := new(memoryLogger)
+
+	store, err := NewClientStore(nil, WithClientStoreLogger(l), WithClientStoreInitTableDisabled())
+	require.NoError(t, err)
+
+	store.logger.Printf("log1", 1, "2", "333")
+	store.logger.Printf("log2", 12, "22")
+
+	require.Equal(t, 2, len(l.formats))
+	require.Equal(t, 2, len(l.args))
+
+	assert.Equal(t, "log1", l.formats[0])
+	assert.Equal(t, "log2", l.formats[1])
+
+	require.Equal(t, 3, len(l.args[0]))
+	require.Equal(t, 2, len(l.args[1]))
+
+	assert.Equal(t, 1, l.args[0][0])
+	assert.Equal(t, "2", l.args[0][1])
+	assert.Equal(t, "333", l.args[0][2])
+
+	assert.Equal(t, 12, l.args[1][0])
+	assert.Equal(t, "22", l.args[1][1])
+}

client_store_test.go

@@ -0,0 +1,22 @@
+package pg
+
+import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+)
+
+func TestClientStore_initTable(t *testing.T) {
+	adapter := new(mockAdapter)
+
+	_, err := NewClientStore(adapter)
+	require.NoError(t, err)
+
+	assert.Equal(t, 1, len(adapter.execCalls))
+	assert.Equal(t, 0, len(adapter.selectOneCalls))
+
+	// new line character is the character at position 0
+	assert.Equal(t, 1, strings.Index(adapter.execCalls[0].query, "CREATE TABLE IF NOT EXISTS"))
+}