Merge pull request #1 from vgarvardt/feature/initial-implementation

Initial implementation

Author: vgarvardt

.gitignore

@@ -10,3 +10,5 @@
 
 # Output of the go coverage tool, specifically when used with LiteIDE
 *.out
+
+vendor/

.travis.yml

@@ -0,0 +1,28 @@
+language: go
+sudo: false
+
+go:
+  - "1.10"
+  - "1.11"
+  - "stable"
+
+services:
+  - postgresql
+
+addons:
+  postgresql: "9.6"
+
+env:
+  global:
+    - PG_URI=postgres://postgres@localhost:5432/oauth2_test?sslmode=disable
+
+before_install:
+  - psql -c 'create database oauth2_test;' -U postgres
+  - go get -u github.com/golang/dep/cmd/dep
+  - dep ensure -v -vendor-only
+
+script:
+  - go test -coverprofile=coverage.txt -covermode=atomic ./...
+
+after_success:
+  - bash <(curl -s https://codecov.io/bash)

Gopkg.lock

@@ -0,0 +1,54 @@
+# Gopkg.toml example
+#
+# Refer to https://golang.github.io/dep/docs/Gopkg.toml.html
+# for detailed Gopkg.toml documentation.
+#
+# required = ["github.com/user/thing/cmd/thing"]
+# ignored = ["github.com/user/project/pkgX", "bitbucket.org/user/project/pkgA/pkgY"]
+#
+# [[constraint]]
+#   name = "github.com/user/project"
+#   version = "1.0.0"
+#
+# [[constraint]]
+#   name = "github.com/user/project2"
+#   branch = "dev"
+#   source = "github.com/myfork/project2"
+#
+# [[override]]
+#   name = "github.com/x/y"
+#   version = "2.4.0"
+#
+# [prune]
+#   non-go = false
+#   go-tests = true
+#   unused-packages = true
+
+
+[[constraint]]
+  name = "github.com/json-iterator/go"
+  version = "1.1.5"
+
+[[constraint]]
+  name = "gopkg.in/oauth2.v3"
+  version = "3.9.5"
+
+[prune]
+  go-tests = true
+  unused-packages = true
+
+[[constraint]]
+  name = "github.com/jackc/pgx"
+  version = "3.3.0"
+
+[[constraint]]
+  name = "github.com/jmoiron/sqlx"
+  version = "1.2.0"
+
+[[constraint]]
+  name = "github.com/vgarvardt/pgx-helpers"
+  version = "0.1.0"
+
+[[constraint]]
+  name = "github.com/stretchr/testify"
+  version = "1.3.0"

Gopkg.toml

@@ -1,2 +1,60 @@
-# go-oauth2-pg
-PostgreSQL storage for OAuth 2.0
+# PostgreSQL Storage for [OAuth 2.0](https://github.com/go-oauth2/oauth2)
+
+## Install
+
+```bash
+$ go get -u -v github.com/vgarvardt/go-oauth2-pg
+```
+
+## PostgreSQL drivers
+
+The store accepts an adapter interface that interacts with the DB. The package is bundled with the following adapter implementations
+
+- `database/sql` (e.g. [`github.com/lib/pq`](https://github.com/lib/pq)) - `github.com/vgarvardt/go-oauth2-pg/adapter/sql.NewSQL()`
+- [`github.com/jmoiron/sqlx.DB`](https://github.com/jmoiron/sqlx) - `github.com/vgarvardt/go-oauth2-pg/adapter/sqlx.NewSQLx()`
+- [`github.com/jackc/pgx.Conn`](https://github.com/jackc/pgx) - `github.com/vgarvardt/go-oauth2-pg/adapter/pgx.NewConnAdapter()`
+- [`github.com/jackc/pgx.ConnPool`](https://github.com/jackc/pgx) - `github.com/vgarvardt/go-oauth2-pg/adapter/pgx.NewConnPoolAdapter()`
+
+## Usage example
+
+```go
+package main
+
+import (
+	"os"
+	"time"
+
+	"github.com/jackc/pgx"
+	pg "github.com/vgarvardt/go-oauth2-pg"
+	pgxAdapter "github.com/vgarvardt/go-oauth2-pg/adapter/pgx"
+	"gopkg.in/oauth2.v3/manage"
+)
+
+func main() {
+	pgxConnConfig, _ := pgx.ParseURI(os.Getenv("DB_URI"))
+	pgxConn, _ := pgx.Connect(pgxConnConfig)
+
+	manager := manage.NewDefaultManager()
+
+	// use PostgreSQL token store with pgx.Connection adapter
+	store, _ := pg.NewStore(pgxAdapter.NewConnAdapter(pgxConn), pg.WithGCInterval(time.Minute))
+	defer store.Close()
+
+	manager.MapTokenStorage(store)
+	// ...
+}
+```
+
+## How to run tests
+
+You will need running PostgreSQL instance. E.g. the one running in docker and exposing a port to a host system
+
+```bash
+docker run --rm -p 5432:5432 -it -e POSTGRES_PASSWORD=oauth2 -e POSTGRES_USER=oauth2 -e POSTGRES_DB=oauth2 postgres:10
+```
+
+Now you can run tests using the running PostgreSQL instance using `PG_URI` environment variable
+
+```bash
+PG_URI=postgres://oauth2:oauth2@localhost:5432/oauth2?sslmode=disable go test -cover ./...
+```

README.md

@@ -0,0 +1,65 @@
+package pgx
+
+import (
+	"github.com/jackc/pgx"
+	"github.com/vgarvardt/go-oauth2-pg"
+	pgxHelpers "github.com/vgarvardt/pgx-helpers"
+)
+
+// ConnPoolAdapter is the adapter type for PGx connection pool connection type
+type ConnPoolAdapter struct {
+	conn *pgx.ConnPool
+}
+
+// NewConnPoolAdapter instantiates PGx connection pool adapter
+func NewConnPoolAdapter(conn *pgx.ConnPool) *ConnPoolAdapter {
+	return &ConnPoolAdapter{conn}
+}
+
+// ConnPoolAdapter is the adapter type for PGx connection connection type
+type ConnAdapter struct {
+	conn *pgx.Conn
+}
+
+// NewConnAdapter instantiates PGx connection adapter
+func NewConnAdapter(conn *pgx.Conn) *ConnAdapter {
+	return &ConnAdapter{conn}
+}
+
+// Exec runs a query and returns an error if any
+func (a *ConnPoolAdapter) Exec(query string, args ...interface{}) error {
+	_, err := a.conn.Exec(query, args...)
+	return err
+}
+
+// SelectOne runs a select query and scans the object into a struct or returns an error
+func (a *ConnPoolAdapter) SelectOne(dst interface{}, query string, args ...interface{}) error {
+	row := a.conn.QueryRow(query, args...)
+	if err := pgxHelpers.ScanStruct(row, dst); err != nil {
+		if err == pgx.ErrNoRows {
+			return pg.ErrNoRows
+		}
+		return err
+	}
+
+	return nil
+}
+
+// Exec runs a query and returns an error if any
+func (a *ConnAdapter) Exec(query string, args ...interface{}) error {
+	_, err := a.conn.Exec(query, args...)
+	return err
+}
+
+// SelectOne runs a select query and scans the object into a struct or returns an error
+func (a *ConnAdapter) SelectOne(dst interface{}, query string, args ...interface{}) error {
+	row := a.conn.QueryRow(query, args...)
+	if err := pgxHelpers.ScanStruct(row, dst); err != nil {
+		if err == pgx.ErrNoRows {
+			return pg.ErrNoRows
+		}
+		return err
+	}
+
+	return nil
+}