From aa9ce272dcfa1380b2f05bc3a90ef8ca1b0a7f62 Mon Sep 17 00:00:00 2001
From: Tobi Smethurst <31960611+tsmethurst@users.noreply.github.com>
Date: Mon, 22 Mar 2021 22:26:54 +0100
Subject: Oauth/token (#7)

* add host and protocol options

* some fiddling

* tidying up and comments

* tick off /oauth/token

* tidying a bit

* tidying

* go mod tidy

* allow attaching middleware to server

* add middleware

* more user friendly

* add comments

* comments

* store account + app

* tidying

* lots of restructuring

* lint + tidy
---
 internal/db/db.go | 47 ++++++++++++++++++++++++++++++++---------------
 1 file changed, 32 insertions(+), 15 deletions(-)

(limited to 'internal/db/db.go')

diff --git a/internal/db/db.go b/internal/db/db.go
index 4ea4e1af6..9952e5e97 100644
--- a/internal/db/db.go
+++ b/internal/db/db.go
@@ -30,30 +30,47 @@ import (
 
 const dbTypePostgres string = "POSTGRES"
 
-// DB provides methods for interacting with an underlying database (for now, just postgres).
-// The function mapping lines up with the DB interface described in go-fed.
-// See here: https://github.com/go-fed/activity/blob/master/pub/database.go
+// DB provides methods for interacting with an underlying database or other storage mechanism (for now, just postgres).
 type DB interface {
-	/*
-		GO-FED DATABASE FUNCTIONS
-	*/
-	pub.Database
+	// Federation returns an interface that's compatible with go-fed, for performing federation storage/retrieval functions.
+	// See: https://pkg.go.dev/github.com/go-fed/activity@v1.0.0/pub?utm_source=gopls#Database
+	Federation() pub.Database
 
-	/*
-		ANY ADDITIONAL DESIRED FUNCTIONS
-	*/
+	// CreateTable creates a table for the given interface
+	CreateTable(i interface{}) error
 
-	// CreateSchema should populate the database with the required tables
-	CreateSchema(context.Context) error
+	// DropTable drops the table for the given interface
+	DropTable(i interface{}) error
 
 	// Stop should stop and close the database connection cleanly, returning an error if this is not possible
-	Stop(context.Context) error
+	Stop(ctx context.Context) error
 
 	// IsHealthy should return nil if the database connection is healthy, or an error if not
-	IsHealthy(context.Context) error
+	IsHealthy(ctx context.Context) error
+
+	// GetByID gets one entry by its id.
+	GetByID(id string, i interface{}) error
+
+	// GetWhere gets one entry where key = value
+	GetWhere(key string, value interface{}, i interface{}) error
+
+	// GetAll gets all entries of interface type i
+	GetAll(i interface{}) error
+
+	// Put stores i
+	Put(i interface{}) error
+
+	// Update by id updates i with id id
+	UpdateByID(id string, i interface{}) error
+
+	// Delete by id removes i with id id
+	DeleteByID(id string, i interface{}) error
+
+	// Delete where deletes i where key = value
+	DeleteWhere(key string, value interface{}, i interface{}) error
 }
 
-// New returns a new database service that satisfies the Service interface and, by extension,
+// New returns a new database service that satisfies the DB interface and, by extension,
 // the go-fed database interface described here: https://github.com/go-fed/activity/blob/master/pub/database.go
 func New(ctx context.Context, c *config.Config, log *logrus.Logger) (DB, error) {
 	switch strings.ToUpper(c.DBConfig.Type) {
-- 
cgit v1.2.3